coercive 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ce029330ac405fde945a05e6f81c62361027ebe5d03659fd82b067554087e7
-  data.tar.gz: 89cfe35313fde4e0b0cea25d6050b008e75c8457ca440b71cf1c2acca26d13d1
+  metadata.gz: af1258f102aed9654f229199a6999f7dc817550b51fd009d9e8057de26c8cb11
+  data.tar.gz: 297d85ff20739bf100f7434d657a842adbaa783a17b10c459325724391d84196
 SHA512:
-  metadata.gz: d5260061302b501653bf64ce29988622f5ea06739a32058778a64106ad25ddd28567773048ac48addf510adc5f08357f0f6258c2877b67b8e2c0a3e3352baf48
-  data.tar.gz: 25e42dec9a930a6cea139f581114abf59d166a95210a5884edb0276a29bbbee7cb365959d51c6caddc4c76c827d0dfecf5bdb71386e262d2e8fccd3b20decacc
+  metadata.gz: e9e1e6a9d98a32bc3819ef6ea4765f21a45ed103000186d71d394d10ac657178eb6498d55bebd2b7a54182cb6565593efc8f377f1ba8bf4074dbed030a81704f
+  data.tar.gz: 9cde425ae7847267b73118f741304a2a1b1b04cd7585d52c5d1bb0a5f51b664dd530c00a5e50c3bdecf9f0c0e3e3c1cc4a8a567a472e0d6745d28e26f84b76cb

data/README.md

@@ -217,19 +217,44 @@ end
 CoerceFoo.call("foo" => "bar")
 # => Coercive::Error: {"foo"=>"not_valid"}
 
-CoerceFoo.call("foo" => "0.5")
-# => Coercive::Error: {"foo"=>"too_low"}
+CoerceFoo.call("foo_bounds" => "0.5")
+# => Coercive::Error: {"foo_bounds"=>"too_low"}
 
-CoerceFoo.call("foo" => 6.5)
-# => Coercive::Error: {"foo"=>"too_high"}
+CoerceFoo.call("foo_bounds" => 6.5)
+# => Coercive::Error: {"foo_bounds"=>"too_high"}
 
 CoerceFoo.call("foo" => "0.1")
 # => {"foo"=>0.1}
-  
+
 CoerceFoo.call("foo" => "0.1e5")
 # => {"foo"=>10000.0}
 ```
 
+### `boolean(true_if:, false_if:)
+
+`boolean` will coerce input into `true` or `false`. You can also specifiy additional values to coerce into `true` or `false` with the `true_if` and `false_if` options.
+
+```ruby
+module CoerceFoo
+  extend Coercive
+
+  attribute :foo,    boolean,                               optional
+  attribute :foo_if, boolean(true_if: member(["1", "on"])), optional
+end
+
+CoerceFoo.call("foo" => true)
+# => {"foo"=>true}
+
+CoerceFoo.call("foo" => "true")
+# => {"foo"=>true}
+
+CoerceFoo.call("foo" => nil)
+# => Coercive::Error: {"foo"=>"not_valid"}
+
+CoerceFoo.call("foo_if" => "on")
+# => {"foo_if"=>true}
+```
+
 ### `array`
 
 The `array` coercion is interesting because it's where `Coercive` starts to shine, by letting you compose coercion functions together. Let's see:

data/coercive.gemspec

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

@@ -186,6 +186,33 @@ module Coercive
     end
   end
 
+  # Public DSL: Return a coerce function to coerce input to true or false.
+  # Used when declaring an attribute. See documentation for attr_coerce_fns.
+  #
+  # true_if  - coerce function to override which values will coerce to true.
+  # false_if - coerce function to override which values will coerce to false.
+  def boolean(true_if: member([true, "true"]), false_if: member([false, "false"]))
+    ->(input) do
+      test_success = ->(coerce_fn) do
+        begin
+          coerce_fn.call(input)
+        rescue Coercive::Error
+          return false
+        end
+
+        true
+      end
+
+      if test_success.(true_if)
+        true
+      elsif test_success.(false_if)
+        false
+      else
+        fail Coercive::Error.new("not_valid")
+      end
+    end
+  end
+
   # Public DSL: Return a coerce function to coerce input to a String.
   # Used when declaring an attribute. See documentation for attr_coerce_fns.
   #

data/test/coercive.rb

@@ -137,7 +137,7 @@ describe "Coercive" 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) }
@@ -182,13 +182,71 @@ describe "Coercive" do
       expected_errors = { "bar" => "too_low" }
 
       assert_coercion_error(expected_errors) { @coercion.call("bar" => 0.5) }
-      
+
       expected_errors = { "bar" => "too_high" }
 
       assert_coercion_error(expected_errors) { @coercion.call("bar" => 6.0) }
     end
   end
 
+  describe "boolean" do
+    before do
+      @coercion = Module.new do
+        extend Coercive
+
+        attribute :foo,       boolean,                                 optional
+        attribute :foo_true,  boolean(true_if:  member(["on", 1])),    optional
+        attribute :foo_false, boolean(false_if: member(["off", "0"])), optional
+      end
+    end
+
+    it "supports true or false as String by default" do
+      [true, "true"].each do |value|
+        attributes = { "foo" => value }
+
+        expected = { "foo" => true }
+
+        assert_equal expected, @coercion.call(attributes)
+      end
+
+      [false, "false"].each do |value|
+        attributes = { "foo" => value }
+
+        expected = { "foo" => false }
+
+        assert_equal expected, @coercion.call(attributes)
+      end
+    end
+
+    it "supports customizing values to coerce into true or false" do
+      ["on", 1].each do |value|
+        attributes = { "foo_true" => value }
+
+        expected = { "foo_true" => true }
+
+        assert_equal expected, @coercion.call(attributes)
+      end
+
+      ["off", "0"].each do |value|
+        attributes = { "foo_false" => value }
+
+        expected = { "foo_false" => false }
+
+        assert_equal expected, @coercion.call(attributes)
+      end
+    end
+
+    it "fails on unknown values" do
+      ["nope", nil].each do |value|
+        attributes = { "foo" => value }
+
+        expected_errors = { "foo" => "not_valid" }
+        
+        assert_coercion_error(expected_errors) { @coercion.call(attributes) }
+      end
+    end
+  end
+
   describe "string" 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.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Joe McIlvain
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies: []
 description: Coercive is a library to validate and coerce user input
 email: