Makie extension (#12)

Author: rossviljoen

Project.toml

@@ -1,12 +1,23 @@
 name = "UnixTimes"
 uuid = "ab1a18e7-b408-4913-896c-624bb82ed7f4"
 authors = ["Christian Rorvik <[email protected]>"]
-version = "1.5.0"
+version = "1.6.0"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 
+[weakdeps]
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+Observables = "510215fc-4207-5dde-b226-833fc4488ee2"
+TimeZones = "f269a46b-ccf7-5d73-abea-4c690281aa53"
+
+[extensions]
+UnixTimesMakieExt = ["Makie", "Observables"]
+UnixTimesTimeZonesExt = "TimeZones"
+
 [compat]
+Makie = "0.22"
+Observables = "0.5"
 TimeZones = "1"
 julia = "1.9"
 
@@ -16,9 +27,3 @@ TimeZones = "f269a46b-ccf7-5d73-abea-4c690281aa53"
 
 [targets]
 test = ["Test", "TimeZones"]
-
-[weakdeps]
-TimeZones = "f269a46b-ccf7-5d73-abea-4c690281aa53"
-
-[extensions]
-UnixTimesTimeZonesExt = "TimeZones"

ext/UnixTimesMakieExt.jl

@@ -0,0 +1,50 @@
+module UnixTimesMakieExt
+
+using UnixTimes
+using Makie
+using Observables
+using Dates
+
+struct UnixTimeConversion <: Makie.AbstractDimConversion
+    custom_epoch::Observable{Union{Nothing, UnixTime}}
+    function UnixTimeConversion(custom_epoch = nothing)
+        new(Observable{Union{Nothing, UnixTime}}(custom_epoch; ignore_equal_values=true))
+    end
+end
+
+function number_to_unixtime(conversion::UnixTimeConversion, i)
+    Nanosecond(round(Int64, Float64(i))) + something(conversion.custom_epoch[], UNIX_EPOCH)
+end
+
+Makie.needs_tick_update_observable(conversion::UnixTimeConversion) = nothing
+
+Makie.MakieCore.should_dim_convert(::Type{UnixTime}) = true
+
+Makie.create_dim_conversion(::Type{UnixTime}) = UnixTimeConversion()
+
+function Makie.convert_dim_value(conversion::UnixTimeConversion, value::UnixTime)
+    Dates.value(value - something(conversion.custom_epoch[], UNIX_EPOCH))
+end
+function Makie.convert_dim_value(conversion::UnixTimeConversion, values::AbstractArray{UnixTime})
+    Dates.value.(values .- something(conversion.custom_epoch[], UNIX_EPOCH))
+end
+
+function Makie.convert_dim_observable(conversion::UnixTimeConversion, values::Observable, deregister)
+    if conversion.custom_epoch[] === nothing
+        conversion.custom_epoch[] = last(values[])
+    end
+
+    result = map(values, conversion.custom_epoch) do vs, ep
+        Dates.value.(vs .- something(ep, UNIX_EPOCH))
+    end
+    append!(deregister, result.inputs)
+    result
+end
+
+function Makie.get_ticks(conversion::UnixTimeConversion, ticks, scale, formatter, vmin, vmax)
+    tickvalues = Makie.get_tickvalues(formatter, scale, vmin, vmax)
+    dates = number_to_unixtime.(Ref(conversion), tickvalues)
+    tickvalues, string.(dates)
+end
+
+end

src/UnixTimes.jl

@@ -54,10 +54,7 @@ Dates.Time(x::UnixTime) = Time(Nanosecond(Dates.value(x)))
 
 Base.convert(::Type{DateTime}, x::UnixTime) = DateTime(x)
 
-function UnixTime(x::DateTime)
-    instant_ns = (Dates.value(x) - Dates.UNIXEPOCH) * 1_000_000
-    UnixTime(Dates.UTInstant(Nanosecond(instant_ns)))
-end
+UnixTime(x::Dates.TimeType) = convert(UnixTime, x)
 
 UnixTime(x::Date) = UnixTime(DateTime(x))
 UnixTime(x::Date, y::Time) =
@@ -76,7 +73,10 @@ function UnixTime(s::AbstractString)
     end
 end
 
-Base.convert(::Type{UnixTime}, x::DateTime) = UnixTime(x)
+function Base.convert(::Type{UnixTime}, x::DateTime)
+    instant_ns = (Dates.value(x) - Dates.UNIXEPOCH) * 1_000_000
+    UnixTime(Dates.UTInstant(Nanosecond(instant_ns)))
+end
 
 function Base.show(io::IO, x::UnixTime)
     xdt = convert(DateTime, x)
@@ -94,7 +94,7 @@ function Base.floor(x::UnixTime, p::Union{DatePeriod, TimePeriod})
     convert(UnixTime, floor(convert(DateTime, x), p))
 end
 
-Dates.guess(a::UnixTime, b::UnixTime, c) = Dates.guess(DateTime(a), DateTime(b), c)
+Dates.guess(a::UnixTime, b::UnixTime, c) = (Dates.value(b) - Dates.value(a)) ÷ Dates.tons(c)
 
 Dates.default_format(::Type{UnixTime}) = nothing
 Dates.format(x::UnixTime, fmt::Nothing) = string(x)