coercive 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f107658df43970b3e3cef00a20ed705a11a0f3b9e44ec50c3e391e827c161fb
-  data.tar.gz: df087c93a23d4764f77a816427bbdc7a9c2fc0f75a9137a34a82fc0004bd50c4
+  metadata.gz: f5ece0274ec3187ab9ae2407837048143d6c1c516bd4ddcfc953a208e5bee6ed
+  data.tar.gz: 6b9ffb6fa9c18a0d9049193c7e352201f559b86a98cd4258d49b756ca8bf4df9
 SHA512:
-  metadata.gz: e53a1643a5e2f09fc78286cbcf991d535e876d816ca01f59807ada41315e9effd5093206e624f15941eb80d121b291e3c0c5a63e0c0def2b5403aaa1d09daae7
-  data.tar.gz: 5b6668f6bd4241bb7eb1a56a623564be8f63e5538cd9b7cec726e69bf907e11734f4b7f5bc8f4795737847a322ff04b6a3bac0da9ee2ce3c3286b2ec26ef8777
+  metadata.gz: d036ba5c9a7b0526903330fe17aff3e34f47f0c0a338769fb0762fed5da8ca7d0210143b0f87533dba2010637feed320cbf454d78d629ffd5d3ebb13a8ab18fb
+  data.tar.gz: c5eb1b8af3fb355081d15108bf037fd4f5ec9b85be892f875500b419a343a8d4136c26ce0ff3ca0c8fca8bf3bb91f7ac4acf8439369009fbec14dfaf98e5e043

data/README.md

@@ -171,15 +171,16 @@ CoerceFoo.call("foo" => 4)
 # => Coercive::Error: {"foo"=>"not_valid"}
 ```
 
-### `integer`
+### `integer(min:, max:)`
 
-`integer` expects an integer value.
+`integer` expects an integer value. It supports optional `min` and `max` options to check if the user input is within certain bounds.
 
 ```ruby
 module CoerceFoo
   extend Coercive
 
-  attribute :foo, integer, optional
+  attribute :foo,        integer,                  optional
+  attribute :foo_bounds, integer(min: 1, max: 10), optional
 end
 
 CoerceFoo.call("foo" => "1")
@@ -193,6 +194,12 @@ CoerceFoo.call("foo" => "1.5")
 
 CoerceFoo.call("foo" => 1.5)
 # => Coercive::Error: {"foo"=>"float_not_permitted"}
+
+CoerceFoo.call("foo_bounds" => 0)
+# => Coercive::Error: {"foo_bounds"=>"too_low"}
+
+CoerceFoo.call("foo_bounds" => 11)
+# => Coercive::Error: {"foo_bounds"=>"too_high"}
 ```
 
 ### `float`

data/coercive.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "coercive"
-  s.version = "1.3.0"
+  s.version = "1.4.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

@@ -152,15 +152,20 @@ module Coercive
 
   # Public DSL: Return a coerce function to coerce input to an Integer.
   # Used when declaring an attribute. See documentation for attr_coerce_fns.
-  def integer
+  def integer(min: nil, max: nil)
     ->(input) do
       fail Coercive::Error.new("float_not_permitted") if input.is_a?(Float)
 
-      begin
-        Integer(input)
-      rescue TypeError, ArgumentError
-        fail Coercive::Error.new("not_numeric")
-      end
+      input = begin
+                Integer(input)
+              rescue TypeError, ArgumentError
+                fail Coercive::Error.new("not_numeric")
+              end
+
+      fail Coercive::Error.new("too_low")  if min && input < min
+      fail Coercive::Error.new("too_high") if max && input > max
+
+      input
     end
   end
 

data/test/coercive.rb

@@ -105,8 +105,9 @@ describe "Coercive" do
       @coercion = Module.new do
         extend Coercive
 
-        attribute :foo, integer, required
+        attribute :foo, integer, optional
         attribute :bar, integer, optional
+        attribute :baz, integer(min: 1, max: 10), optional
       end
     end
 
@@ -131,6 +132,16 @@ describe "Coercive" do
         assert_coercion_error(expected_errors) { @coercion.call("foo" => value) }
       end
     end
+
+    it "errors if the input is out of bounds" do
+      expected_errors = { "baz" => "too_low" }
+
+      assert_coercion_error(expected_errors) { @coercion.call("baz" => 0) }
+      
+      expected_errors = { "baz" => "too_high" }
+
+      assert_coercion_error(expected_errors) { @coercion.call("baz" => 11) }
+    end
   end
 
   describe "float" do

metadata

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