coercive 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eee84a8970b92e6b5d1b0e01e51a40c66cc0c7298b0fe37a6ea44aecd7b9064
-  data.tar.gz: 9504d35e8ce6376fd821110a15d079783f723af1ae78606fa7fd2e565c053487
+  metadata.gz: 7ffc4474a94a2f1e246925e54549fdbf360fdc272ebdb670a99152b7ec6418b9
+  data.tar.gz: 92bdc78e8286dce0ce88464b843777f3c7b60bbb864a4c3daca3e3b80a9d6c8c
 SHA512:
-  metadata.gz: 41fef05cb7a8c6a1d2f9b7f0f3737d76c5756a36903d6e2c45d028fb539d4de50f9ac0720b07e4262b97df2ff187638e0cf6d5fef4692d470ddc9484e00a9b57
-  data.tar.gz: 94c3e1e38e740c7089d8913977fbd1feea04d1df592d918c76b46be18c53787c95d36fed451a39191781db63718a941f31d53b4ac56d960384e1e854ed4d6066
+  metadata.gz: 7a41ea8301735ce0b45d4c6d2e96a9e8c0bb06399c8b4f47be1f115d8996c640714a36e7211d4abc73e5ca40944f9be387b31eed0e9c8b22f7e859f10bd59480
+  data.tar.gz: e9f73c7c476d50e49bfbc7433d3b9da14541999a92582462e5ca1042ef80743a748ce83af2eb418ffb54ec393d4196cba1a49f5f5008aa4c20907918af915e7d

data/README.md

@@ -128,6 +128,30 @@ CoerceFoo.call("foo" => "DEADBEEF")
 # => {"foo"=>"DEADBEEF"}
 ```
 
+### `date` and `datetime`
+
+The `date` and `datetime` coercion functions will receive a `String` and give you `Date` and `DateTime` objects, respectively.
+
+By default they expect an ISO 8601 string, but they provide a `format` option in case you need to parse something different, following the `strftime` format.
+
+```ruby
+module CoerceFoo
+  extend Coercive
+
+  attribute :date_foo,      date,                     optional
+  attribute :american_date, date(format: "%m-%d-%Y"), optional
+  attribute :datetime_foo,  datetime,                 optional
+end
+
+CoerceFoo.call("date_foo" => "1988-05-18", "datetime_foo" => "1988-05-18T21:00:00Z", "american_date" => "05-18-1988")
+# => {"date_foo"=>#<Date: 1988-05-18 ((2447300j,0s,0n),+0s,2299161j)>,
+#  "american_date"=>#<Date: 1988-05-18 ((2447300j,0s,0n),+0s,2299161j)>,
+#  "datetime_foo"=>#<DateTime: 1988-05-18T21:00:00+00:00 ((2447300j,75600s,0n),+0s,2299161j)>}
+
+CoerceFoo.call("date_foo" => "18th May 1988")
+# => Coercive::Error: {"date_foo"=>"not_valid"}
+```
+
 ### `any`
 
 The `any` coercion function lets anything pass through. It's commonly used with the `optional` fetch function when an attribute may or many not be a part of the input.

data/coercive.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "coercive"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
   s.summary = "Coercive is a library to validate and coerce user input"
   s.description = s.summary
   s.authors = ["Joe McIlvain", "Lucas Tolchinsky"]

data/lib/coercive.rb

@@ -1,3 +1,4 @@
+require "date"
 require_relative "coercive/uri"
 
 # Public: The Coercive module implements a succinct DSL for declaring callable
@@ -192,6 +193,48 @@ module Coercive
     end
   end
 
+  # Public DSL: Return a coercion function to coerce input into a Date.
+  # Used when declaring an attribute. See documentation for attr_coerce_fns.
+  #
+  # format - String following Ruby's `strftime` format to change the parsing behavior. When empty
+  #          it will expect the String to be ISO 8601 compatible.
+  def date(format: nil)
+    ->(input) do
+      input = begin
+                if format
+                  Date.strptime(input, format)
+                else
+                  Date.iso8601(input)
+                end
+              rescue ArgumentError
+                fail Coercive::Error.new("not_valid")
+              end
+
+      input
+    end
+  end
+
+  # Public DSL: Return a coercion function to coerce input into a DateTime.
+  # Used when declaring an attribute. See documentation for attr_coerce_fns.
+  #
+  # format - String following Ruby's `strftime` format to change the parsing behavior. When empty
+  #          it will expect the String to be ISO 8601 compatible.
+  def datetime(format: nil)
+    ->(input) do
+      input = begin
+                if format
+                  DateTime.strptime(input, format)
+                else
+                  DateTime.iso8601(input)
+                end
+              rescue ArgumentError
+                fail Coercive::Error.new("not_valid")
+              end
+
+      input
+    end
+  end
+
   # Public DSL: Return a coercion function to coerce input to an Array.
   # Used when declaring an attribute. See documentation for attr_coerce_fns.
   #

data/test/coercive.rb

@@ -199,6 +199,84 @@ describe "Coercive" do
     end
   end
 
+  describe "date" do
+    before do
+      @coercion = Module.new do
+        extend Coercive
+
+        attribute :date,          date,                     optional
+        attribute :american_date, date(format: "%m-%d-%Y"), optional
+      end
+    end
+
+    it "coerces a string into a Date object with ISO 8601 format by default" do
+      attributes = { "date" => "1988-05-18" }
+
+      expected = { "date" => Date.new(1988, 5, 18) }
+
+      assert_equal expected, @coercion.call(attributes)
+    end
+
+    it "supports a custom date format" do
+      attributes = { "american_date" => "05-18-1988" }
+
+      expected = { "american_date" => Date.new(1988, 5, 18) }
+
+      assert_equal expected, @coercion.call(attributes)
+    end
+
+    it "errors if the input doesn't parse" do
+      attributes = { "date" => "12-31-1990" }
+
+      expected_errors = { "date" => "not_valid" }
+
+      assert_coercion_error(expected_errors) { @coercion.call(attributes) }
+    end
+  end
+
+  describe "datetime" do
+    before do
+      @coercion = Module.new do
+        extend Coercive
+
+        attribute :datetime,      datetime,                                 optional
+        attribute :american_date, datetime(format: "%m-%d-%Y %I:%M:%S %p"), optional
+      end
+    end
+
+    it "coerces a string into a DateTime object with ISO 8601 format by default" do
+      attributes = { "datetime" => "1988-05-18T21:00:00Z" }
+
+      expected = { "datetime" => DateTime.new(1988, 5, 18, 21, 00, 00) }
+
+      assert_equal expected, @coercion.call(attributes)
+    end
+
+    it "honors the timezone" do
+      attributes = { "datetime" => "1988-05-18T21:00:00-0300" }
+
+      expected = { "datetime" => DateTime.new(1988, 5, 18, 21, 00, 00, "-03:00") }
+
+      assert_equal expected, @coercion.call(attributes)
+    end
+
+    it "supports a custom date format" do
+      attributes = { "american_date" => "05-18-1988 09:00:00 PM" }
+
+      expected = { "american_date" => DateTime.new(1988, 5, 18, 21, 00, 00) }
+
+      assert_equal expected, @coercion.call(attributes)
+    end
+
+    it "errors if the input doesn't parse" do
+      attributes = { "datetime" => "12-31-1990T21:00:00Z" }
+
+      expected_errors = { "datetime" => "not_valid" }
+
+      assert_coercion_error(expected_errors) { @coercion.call(attributes) }
+    end
+  end
+
   describe "array" do
     before do
       @coercion = Module.new do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coercive
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Joe McIlvain
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-13 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies: []
 description: Coercive is a library to validate and coerce user input
 email: