Add ∞ support for TimeTypes (JuliaDatabases#185)

* Add ∞ support for TimeTypes

* Properly parse InfExtendedTime. Add Tests

* Clean up tests

* Deprecate infinite conversion for Dates.TimeType

* Apply suggestions

* Change timetype inf function name and message

* Fix missing `end`

* Update docs Manifest

Author: fchorney

Project.toml

@@ -10,6 +10,7 @@ Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Decimals = "abce61dc-4473-55a0-ba07-351d65e31d42"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 FileWatching = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
+Infinity = "a303e19e-6eb4-11e9-3b09-cd9505f79100"
 Intervals = "d8418881-c3e1-53bb-8760-2df7ec849ed5"
 IterTools = "c8e1da08-722c-5040-9ed9-7db0dc04731e"
 LayerDicts = "6f188dcb-512c-564b-bc01-e0f76e72f166"
@@ -25,6 +26,7 @@ CEnum = "0.2"
 DataFrames = "0.14, 0.15, 0.16, 0.17, 0.18, 0.19, 0.20"
 Decimals = "0.4.1"
 DocStringExtensions = "0.8.0"
+Infinity = "0.2"
 Intervals = "1.3"
 IterTools = "1"
 LayerDicts = "1"

docs/Manifest.toml

@@ -1,3 +1,5 @@
+# This file is machine-generated - editing it directly is not advised
+
 [[ArnoldiMethod]]
 deps = ["DelimitedFiles", "LinearAlgebra", "Random", "SparseArrays", "StaticArrays", "Test"]
 git-tree-sha1 = "2b6845cea546604fb4dca4e31414a6a59d39ddcd"
@@ -66,7 +68,7 @@ deps = ["Mmap"]
 uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab"
 
 [[Distributed]]
-deps = ["LinearAlgebra", "Random", "Serialization", "Sockets"]
+deps = ["Random", "Serialization", "Sockets"]
 uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 
 [[DocStringExtensions]]
@@ -99,13 +101,19 @@ uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
 deps = ["Random"]
 uuid = "9fa8497b-333b-5362-9e8d-4d0656e87820"
 
+[[Infinity]]
+deps = ["Dates", "Random", "Requires"]
+git-tree-sha1 = "b03a4e0ef454c3a8a309dfe0fbd8bd66ca33bd0c"
+uuid = "a303e19e-6eb4-11e9-3b09-cd9505f79100"
+version = "0.2.1"
+
 [[Inflate]]
 git-tree-sha1 = "f5fc07d4e706b84f72d54eedcc1c13d92fb0871c"
 uuid = "d25df0c9-e2be-5dd7-82c8-3ad0b3e990b9"
 version = "0.1.2"
 
 [[InteractiveUtils]]
-deps = ["LinearAlgebra", "Markdown"]
+deps = ["Markdown"]
 uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 
 [[Intervals]]
@@ -144,10 +152,10 @@ version = "1.0.0"
 uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
 
 [[LibPQ]]
-deps = ["BinaryProvider", "CEnum", "Dates", "Decimals", "DocStringExtensions", "FileWatching", "Intervals", "IterTools", "LayerDicts", "Libdl", "Memento", "OffsetArrays", "Tables", "TimeZones"]
+deps = ["BinaryProvider", "CEnum", "Dates", "Decimals", "DocStringExtensions", "FileWatching", "Infinity", "Intervals", "IterTools", "LayerDicts", "Libdl", "Memento", "OffsetArrays", "Tables", "TimeZones"]
 path = ".."
 uuid = "194296ae-ab2e-5f79-8cd4-7183a0a5a0d1"
-version = "1.2.0"
+version = "1.3.0"
 
 [[Libdl]]
 uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
@@ -207,7 +215,7 @@ uuid = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 version = "1.2.0"
 
 [[Pkg]]
-deps = ["Dates", "LibGit2", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
+deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Test", "UUIDs"]
 uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 
 [[PooledArrays]]
@@ -239,6 +247,12 @@ git-tree-sha1 = "7b1d07f411bc8ddb7977ec7f377b97b158514fe0"
 uuid = "189a3867-3050-52da-a836-e630ba90ab69"
 version = "0.2.0"
 
+[[Requires]]
+deps = ["UUIDs"]
+git-tree-sha1 = "d37400976e98018ee840e0ca4f9d20baa231dc6b"
+uuid = "ae029012-a4dd-5104-9daa-d747884805df"
+version = "1.0.1"
+
 [[SHA]]
 uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
 
@@ -325,7 +339,7 @@ uuid = "f269a46b-ccf7-5d73-abea-4c690281aa53"
 version = "1.2.0"
 
 [[UUIDs]]
-deps = ["Random"]
+deps = ["Random", "SHA"]
 uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 
 [[Unicode]]

src/LibPQ.jl

@@ -13,6 +13,7 @@ using DocStringExtensions
 using Decimals
 using FileWatching
 using Tables
+using Infinity: InfExtendedTime, isposinf, ∞
 using Intervals
 using IterTools: imap
 using LayerDicts
@@ -89,4 +90,6 @@ include("tables.jl")
 
 include("asyncresults.jl")
 
+include("deprecated.jl")
+
 end

src/deprecated.jl

@@ -0,0 +1,10 @@
+using Base: depwarn
+
+const INF_WARN = Ref(false)
+
+function depwarn_timetype_inf()
+    if !INF_WARN[]
+        depwarn("`infinity` support for $(Dates.TimeType) is deprecated. Use `$InfExtendedTime` instead", :depwarn_timetype_inf)
+        INF_WARN[] = true
+    end
+end

src/parsing.jl

@@ -214,8 +214,10 @@ _DEFAULT_TYPE_MAP[:timestamp] = DateTime
 const TIMESTAMP_FORMAT = dateformat"y-m-d HH:MM:SS.s"  # .s is optional here
 function pqparse(::Type{DateTime}, str::AbstractString)
     if str == "infinity"
+        depwarn_timetype_inf()
         return typemax(DateTime)
     elseif str == "-infinity"
+        depwarn_timetype_inf()
         return typemin(DateTime)
     end
 
@@ -235,8 +237,10 @@ const TIMESTAMPTZ_FORMATS = (
 )
 function pqparse(::Type{ZonedDateTime}, str::AbstractString)
     if str == "infinity"
+        depwarn_timetype_inf()
         return ZonedDateTime(typemax(DateTime), tz"UTC")
     elseif str == "-infinity"
+        depwarn_timetype_inf()
         return ZonedDateTime(typemin(DateTime), tz"UTC")
     end
 
@@ -251,8 +255,10 @@ end
 _DEFAULT_TYPE_MAP[:date] = Date
 function pqparse(::Type{Date}, str::AbstractString)
     if str == "infinity"
+        depwarn_timetype_inf()
         return typemax(Date)
     elseif str == "-infinity"
+        depwarn_timetype_inf()
         return typemin(Date)
     end
 
@@ -272,6 +278,17 @@ function pqparse(::Type{Time}, str::AbstractString)
     return parse(Time, _trunc_seconds(str))
 end
 
+# InfExtendedTime support for Dates.TimeType
+function pqparse(::Type{InfExtendedTime{T}}, str::AbstractString) where {T<:Dates.TimeType}
+    if str == "infinity"
+        return InfExtendedTime{T}(∞)
+    elseif str == "-infinity"
+        return InfExtendedTime{T}(-∞)
+    end
+
+    return InfExtendedTime{T}(pqparse(T, str))
+end
+
 # UNIX timestamps
 function Base.parse(::Type{DateTime}, pqv::PQValue{PQ_SYSTEM_TYPES[:int8]})
     unix2datetime(parse(Int64, pqv))

src/results.jl

@@ -371,6 +371,14 @@ function string_parameter(interval::AbstractInterval)
     return String(take!(io))
 end
 
+function string_parameter(parameter::InfExtendedTime{T}) where {T<:Dates.TimeType}
+    if isinf(parameter)
+        return isposinf(parameter) ? "infinity" : "-infinity"
+    else
+        return string_parameter(parameter.finitevalue)
+    end
+end
+
 """
     parameter_pointers(parameters::AbstractVector{<:Parameter}) -> Vector{Ptr{UInt8}}
 

test/runtests.jl

@@ -4,6 +4,7 @@ using Dates
 using DataFrames
 using DataFrames: eachrow
 using Decimals
+using Infinity
 using Intervals
 using IterTools: imap
 using Memento
@@ -990,6 +991,23 @@ end
         end
 
         @testset "Type Conversions" begin
+            @testset "Deprecations" begin
+                conn = LibPQ.Connection("dbname=postgres user=$DATABASE_USER"; throw_error=true)
+
+                result = execute(conn, "SELECT 'infinity'::timestamp;")
+
+                try
+                    oid = LibPQ.column_oids(result)[1]
+                    func = result.column_funcs[1]
+
+                    # Parsing this will show a depwarn
+                    @test (@test_deprecated func(LibPQ.PQValue{oid}(result, 1, 1))) == typemax(DateTime)
+                finally
+                    close(result)
+                end
+                close(conn)
+            end
+
             @testset "Automatic" begin
                 conn = LibPQ.Connection("dbname=postgres user=$DATABASE_USER"; throw_error=true)
 
@@ -1212,7 +1230,13 @@ end
                         ("'foobar'", Symbol, :foobar),
                         ("0::int8", DateTime, DateTime(1970, 1, 1, 0)),
                         ("0::int8", ZonedDateTime, ZonedDateTime(1970, 1, 1, 0, tz"UTC")),
-                        ("'{{{1,2,3},{4,5,6}}}'::int2[]", AbstractArray{Int16}, reshape(Int16[1 2 3; 4 5 6], 1, 2, 3))
+                        ("'{{{1,2,3},{4,5,6}}}'::int2[]", AbstractArray{Int16}, reshape(Int16[1 2 3; 4 5 6], 1, 2, 3)),
+                        ("'infinity'::timestamp", InfExtendedTime{Date}, InfExtendedTime{Date}(∞)),
+                        ("'-infinity'::timestamp", InfExtendedTime{Date}, InfExtendedTime{Date}(-∞)),
+                        ("'infinity'::timestamptz", InfExtendedTime{ZonedDateTime}, InfExtendedTime{ZonedDateTime}(∞)),
+                        ("'-infinity'::timestamptz", InfExtendedTime{ZonedDateTime}, InfExtendedTime{ZonedDateTime}(-∞)),
+                        ("'[2004-10-19 10:23:54-02, infinity)'::tstzrange", Interval{InfExtendedTime{ZonedDateTime}}, Interval{Closed, Open}(ZonedDateTime(2004, 10, 19, 12, 23, 54, tz"UTC"), ∞)),
+                        ("'(-infinity, infinity)'::tstzrange", Interval{InfExtendedTime{ZonedDateTime}}, Interval{InfExtendedTime{ZonedDateTime}, Open, Open}(-∞, ∞)),
                     ]
 
                     for (test_str, typ, data) in test_data
@@ -1331,6 +1355,41 @@ end
                 end
             end
 
+            @testset "InfExtendedTime" begin
+                tests = (
+                    ("'infinity'::date", InfExtendedTime{Date}(∞)),
+                    ("'-infinity'::date", InfExtendedTime{Date}(-∞)),
+                    ("'infinity'::timestamp", InfExtendedTime{DateTime}(∞)),
+                    ("'-infinity'::timestamp", InfExtendedTime{DateTime}(-∞)),
+                    ("'infinity'::timestamptz", InfExtendedTime{ZonedDateTime}(∞)),
+                    ("'-infinity'::timestamptz", InfExtendedTime{ZonedDateTime}(-∞)),
+                    ("'(-infinity, 2012-01-01]'::daterange", Interval{Open, Closed}(-∞, Date(2012, 1, 1))),
+                    ("'(2012-01-01, infinity]'::daterange", Interval{Open, Closed}(Date(2012, 1, 1), ∞)),
+                    ("'(-infinity, infinity)'::tstzrange", Interval{InfExtendedTime{ZonedDateTime}, Open, Open}(-∞, ∞))
+                )
+
+                @testset for (pg_str, obj) in tests
+                    result = execute(conn, "SELECT $pg_str = \$1", [obj])
+                    @test first(first(result))
+                    close(result)
+                end
+            end
+
+            @testset "TimeType" begin
+                tests = (
+                    ("'2012-01-01'::date", Date(2012, 1, 1)),
+                    ("'01:01:01.01'::time", Time(1, 1, 1, 10)),
+                    ("'2012-01-01 01:01:01.01'::timestamp", DateTime(2012, 1, 1, 1, 1, 1, 10)),
+                    ("'2012-01-01 01:01:01.01 UTC'::timestamptz", ZonedDateTime(2012, 1, 1, 1, 1, 1, 10, tz"UTC")),
+                )
+
+                @testset for (pg_str, obj) in tests
+                    result = execute(conn, "SELECT $pg_str = \$1", [obj])
+                    @test first(first(result))
+                    close(result)
+                end
+            end
+
             close(conn)
         end