organ 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f58028758f74b7ad8fdb144b5be194a4b3f3eba6
-  data.tar.gz: 7391d92ec6d6165e58edb13b61b8290607577aba
+  metadata.gz: e29921771214a10a8ed0f1e36243dc60acf78091
+  data.tar.gz: ab43375fcb894100bea0ac235efee79e842f6386
 SHA512:
-  metadata.gz: 657be4d73f04bd1c6a5aded0f539b2c37c39466b7f5c9879333680734137a7e7448e439c4bc9e93706b8216aab14cbc2997aca5ce50e1b219b6471f52ae7d3f6
-  data.tar.gz: e87cd083c328bf9b62cc7ad65304ef35b2a4bbb3b5c183092fbe7b78cf60822e1cf05951648f8e059317d44c0128fdb46fd54b2f3552c1ba51f6cc2a715627fa
+  metadata.gz: 3c591d8ca4797ab2b229daa7198d3a95a3155bca235a993637e1f97b4cc2f68eda3bd4bc0098e60cde034ed621d750df658d47ceb83953a1fe86f2492d8a67cf
+  data.tar.gz: 88c0dfe1e6472348d5b8025c2f8d17d1fe40c8851f32c2fffe28a241d39743e141a1621439ff308a3d6e5dad36104eec2908ef61013e3966191516154cae67ce

data/README.md

@@ -176,6 +176,22 @@ appends a `:greater_than` error to the attribute. Example:
 validate_range(:age, :min => 18)
 ```
 
+### validation_block
+
+This is a helper method that only calls the given block if the form doesn't have
+any errors. This is particularly useful when some of the validations are costly
+to make and unnecessary if the form already has errors.
+
+```ruby
+validate_length(:username, :min => 7)
+
+validation_block do # Will only get called if previous validation passed
+  validate_uniqueness(:username) do |username|
+    User.where(:username => username).empty?
+  end
+end
+```
+
 Extensions
 ----------
 

data/lib/organ.rb

@@ -2,6 +2,6 @@ require_relative "organ/form"
 
 module Organ
 
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 
 end

data/lib/organ/coercer.rb

@@ -24,11 +24,15 @@ module Organ
     # Corce the value into true or false.
     #
     # @param value [Object]
+    # @option options [Regexp] :pattern (nil)
+    #   Try to match regexp pattern with passed value
+    #   and cast to Boolean this match.
     #
     # @return [Boolean]
     #
     # @api semipublic
     def coerce_boolean(value, options = {})
+      value = value =~ options[:pattern] if options.has_key?(:pattern)
       !!value
     end
 
@@ -120,6 +124,9 @@ module Organ
     #
     # @param value [Object]
     #   The value to be coerced.
+    # @option options [String] :format ("%Y-%m-%d")
+    #   Allow send format to parse date.
+    #   See http://ruby-doc.org/stdlib-2.1.1/libdoc/date/rdoc/Date.html#method-i-strftime
     #
     # @return [Date, nil]
     #   A Date if the value can be coerced or nil otherwise.
@@ -128,7 +135,7 @@ module Organ
     def coerce_date(value, options = {})
       value = coerce_string(value)
       begin
-        Date.strptime(value, "%Y-%m-%d")
+        Date.strptime(value, options.fetch(:format, "%Y-%m-%d"))
       rescue ArgumentError
         nil
       end

data/lib/organ/validations.rb

@@ -39,6 +39,15 @@ module Organ
       errors[attribute_name] << error
     end
 
+    # Call the given block if there are no errors.
+    #
+    # @param block [Proc]
+    #
+    # @api public
+    def validation_block(&block)
+      block.call if errors.empty?
+    end
+
     # Validate the presence of the attribute value. If the value is nil or
     # false append a :blank error to the attribute.
     #
@@ -47,14 +56,14 @@ module Organ
     # @api public
     def validate_presence(attribute_name)
       value = send(attribute_name)
-      if !value || value.to_s.empty?
+      unless present?(value)
         append_error(attribute_name, :blank)
       end
     end
 
-    # Validate the uniqueness of the attribute value. The uniqueness is
-    # determined by the block given. If the value is not unique, append the
-    # :taken error to the attribute.
+    # Validate the uniqueness of the attribute value (if present). The
+    # uniqueness is determined by the block given. If the value is not unique,
+    # append the :taken error to the attribute.
     #
     # @param attribute_name [Symbol]
     # @param block [Proc]
@@ -64,13 +73,13 @@ module Organ
     # @api public
     def validate_uniqueness(attribute_name, &block)
       value = send(attribute_name)
-      unless block.call(value)
+      if present?(value) && !block.call(value)
         append_error(attribute_name, :taken)
       end
     end
 
-    # Validate the email format. If the value does not match the email format,
-    # append the :invalid error to the attribute.
+    # Validate the email format (if present). If the value does not match the
+    # email format, append the :invalid error to the attribute.
     #
     # @param attribute_name [Symbol]
     #
@@ -79,8 +88,8 @@ module Organ
       validate_format(attribute_name, EMAIL_FORMAT)
     end
 
-    # Validate the format of the attribute value. If the value does not match
-    # the regexp given, append :invalid error to the attribute.
+    # Validate the format of the attribute value (if present). If the value does
+    # not match the regexp given, append :invalid error to the attribute.
     #
     # @param attribute_name [Symbol]
     # @param format [Regexp]
@@ -88,15 +97,15 @@ module Organ
     # @api public
     def validate_format(attribute_name, format)
       value = send(attribute_name)
-      if value && !(format =~ value)
+      if present?(value) && !(format =~ value)
         append_error(attribute_name, :invalid)
       end
     end
 
     # Validate the length of a String, Array or any other form attribute which
-    # responds to #size. If the value is too short, append the :too_short
-    # error to the attribute. If the value is too long append the :too_long
-    # error to the attribute.
+    # responds to #size (if present). If the value is too short, append the
+    # :too_short error to the attribute. If the value is too long append the
+    # :too_long error to the attribute.
     #
     # @param attribute_name [Symbol]
     # @option options [Integer, nil] :min (nil)
@@ -108,7 +117,7 @@ module Organ
       max = options.fetch(:max, nil)
       value = send(attribute_name)
 
-      if value
+      if present?(value)
         length = value.size
         if min && length < min
           append_error(attribute_name, :too_short)
@@ -119,9 +128,9 @@ module Organ
       end
     end
 
-    # Validate the value of the given attribute is included in the list. If
-    # the value is not included in the list, append the :not_included error to
-    # the attribute.
+    # Validate the value of the given attribute is included in the list (if
+    # present). If the value is not included in the list, append the
+    # :not_included error to the attribute.
     #
     # @param attribute_name [Symbol]
     # @param attribute_name [Symbol]
@@ -130,14 +139,14 @@ module Organ
     # @api public
     def validate_inclusion(attribute_name, list)
       value = send(attribute_name)
-      if value && !list.include?(value)
+      if present?(value) && !list.include?(value)
         append_error(attribute_name, :not_included)
       end
     end
 
-    # Validate the range in which the attribute can be. If the value is less
-    # than the min a :less_than_min error will be appended. If the value is
-    # greater than the max a :greater_than_max error will be appended.
+    # Validate the range in which the attribute can be (if present). If the
+    # value is less than the min a :less_than_min error will be appended. If the
+    # value is greater than the max a :greater_than_max error will be appended.
     #
     # @param attribute_name [Symbol]
     # @option options [Integer] :min (nil)
@@ -149,7 +158,7 @@ module Organ
     def validate_range(attribute_name, options = {})
       value = send(attribute_name)
 
-      return unless value
+      return unless present?(value)
 
       min = options.fetch(:min, nil)
       max = options.fetch(:max, nil)
@@ -157,5 +166,16 @@ module Organ
       append_error(attribute_name, :greater_than) if max && value > max
     end
 
+    # Determine if the value is present (not nil, false or an empty string).
+    #
+    # @param value [Object]
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def present?(value)
+      value && !value.to_s.empty?
+    end
+
   end
 end

data/organ.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "organ"
-  s.version = "0.0.3"
+  s.version = "0.1.0"
   s.summary = "Forms with integrated validations and attribute coercing."
   s.description = "A small library for manipulating form-based data with validations and attributes coercion."
   s.authors = ["Sebastian Borrazas"]

data/spec/validations_spec.rb

@@ -50,7 +50,7 @@ describe Organ::Validations do
 
   describe "#validate_presence" do
     describe "when attribute has nil value" do
-      it "appends an error" do
+      it "appends a :blank error" do
         validator.validate_presence(:username)
         assert_includes(validator.errors[:username], :blank)
         assert_equal(1, validator.errors[:username].size)
@@ -60,7 +60,7 @@ describe Organ::Validations do
     describe "when attribute has empty string value" do
       let(:username_value) { "" }
 
-      it "appends an error" do
+      it "appends a :blank error" do
         validator.validate_presence(:username)
         assert_includes(validator.errors[:username], :blank)
         assert_equal(1, validator.errors[:username].size)
@@ -70,46 +70,96 @@ describe Organ::Validations do
 
   describe "#validate_uniqueness" do
     describe "when block returns false" do
-      it "appends a :taken error" do
-        validator.validate_uniqueness(:username) { |u| false }
-        assert_includes(validator.errors[:username], :taken)
-        assert_equal(1, validator.errors[:username].size)
+      describe "when value is not present" do
+        let(:username_value) { nil }
+
+        it "doesn't append any error" do
+          validator.validate_uniqueness(:username) { |u| false }
+
+          assert_equal(0, validator.errors[:username].size)
+        end
+      end
+
+      describe "when value is present" do
+        let(:username_value) { "username" }
+
+        it "appends a :taken error" do
+          validator.validate_uniqueness(:username) { |u| false }
+          assert_includes(validator.errors[:username], :taken)
+          assert_equal(1, validator.errors[:username].size)
+        end
       end
     end
   end
 
   describe "#validate_email_format" do
     describe "when value is not an email" do
-      let(:username_value) { "not.an@email" }
+      describe "when value is not present" do
+        let(:username_value) { nil }
 
-      it "appends an :invalid error" do
-        validator.validate_email_format(:username)
-        assert_includes(validator.errors[:username], :invalid)
-        assert_equal(1, validator.errors[:username].size)
+        it "doesn't append any error" do
+          validator.validate_email_format(:username)
+
+          assert_equal(0, validator.errors[:username].size)
+        end
+      end
+
+      describe "when value is present" do
+        let(:username_value) { "not.an@email" }
+
+        it "appends an :invalid error" do
+          validator.validate_email_format(:username)
+          assert_includes(validator.errors[:username], :invalid)
+          assert_equal(1, validator.errors[:username].size)
+        end
       end
     end
   end
 
   describe "#validate_format" do
     describe "when value does not match the regexp" do
-      let(:username_value) { "ema8l" }
+      describe "when value is not present" do
+        let(:username_value) { nil }
 
-      it "appends an :invalid error" do
-        validator.validate_format(:username, /\A[a-z]+\Z/)
-        assert_includes(validator.errors[:username], :invalid)
-        assert_equal(1, validator.errors[:username].size)
+        it "doesn't append any error" do
+          validator.validate_format(:username, /\A[a-z]+\Z/)
+
+          assert_equal(0, validator.errors[:username].size)
+        end
+      end
+
+      describe "when value is present" do
+        let(:username_value) { "ema8l" }
+
+        it "appends an :invalid error" do
+          validator.validate_format(:username, /\A[a-z]+\Z/)
+          assert_includes(validator.errors[:username], :invalid)
+          assert_equal(1, validator.errors[:username].size)
+        end
       end
     end
   end
 
   describe "#validate_length" do
     describe "when value size is less than the min" do
-      let(:username_value) { "ema8l" }
+      describe "when value is not present" do
+        let(:username_value) { nil }
 
-      it "appends a :too_short error" do
-        validator.validate_length(:username, :min => 8)
-        assert_includes(validator.errors[:username], :too_short)
-        assert_equal(1, validator.errors[:username].size)
+        it "doesn't append any error" do
+          validator.validate_length(:username, :min => 8)
+
+          assert_equal(0, validator.errors[:username].size)
+        end
+      end
+
+      describe "when value is present" do
+        let(:username_value) { "ema8l" }
+
+        it "appends a :too_short error" do
+          validator.validate_length(:username, :min => 8)
+          assert_includes(validator.errors[:username], :too_short)
+          assert_equal(1, validator.errors[:username].size)
+        end
       end
     end
 
@@ -126,24 +176,48 @@ describe Organ::Validations do
 
   describe "#validate_inclusion" do
     describe "when is not included in the list" do
-      let(:username_value) { 1 }
+      describe "when value is not present" do
+        let(:username_value) { nil }
 
-      it "appends a :not_included error" do
-        validator.validate_inclusion(:username, [2, 3])
-        assert_includes(validator.errors[:username], :not_included)
-        assert_equal(1, validator.errors[:username].size)
+        it "doesn't append any error" do
+          validator.validate_inclusion(:username, [2, 3])
+
+          assert_equal(0, validator.errors[:username].size)
+        end
+      end
+
+      describe "when value is present" do
+        let(:username_value) { 1 }
+
+        it "appends a :not_included error" do
+          validator.validate_inclusion(:username, [2, 3])
+          assert_includes(validator.errors[:username], :not_included)
+          assert_equal(1, validator.errors[:username].size)
+        end
       end
     end
   end
 
   describe "#validate_range" do
     describe "when value is less than the min" do
-      let(:username_value) { 5 }
+      describe "when value is not present" do
+        let(:username_value) { nil }
 
-      it "appends a :less_than error" do
-        validator.validate_range(:username, :min => 8)
-        assert_includes(validator.errors[:username], :less_than)
-        assert_equal(1, validator.errors[:username].size)
+        it "doesn't append any error" do
+          validator.validate_range(:username, :min => 8)
+
+          assert_equal(0, validator.errors[:username].size)
+        end
+      end
+
+      describe "when value is present" do
+        let(:username_value) { 5 }
+
+        it "appends a :less_than error" do
+          validator.validate_range(:username, :min => 8)
+          assert_includes(validator.errors[:username], :less_than)
+          assert_equal(1, validator.errors[:username].size)
+        end
       end
     end
 
@@ -158,4 +232,36 @@ describe Organ::Validations do
     end
   end
 
+  describe "#validation_block" do
+    describe "when form has no errors" do
+      let(:username_value) { "validusername" }
+
+      it "calls the given block" do
+        validator.validate_presence(:username)
+
+        block_called = 0
+
+        validator.validation_block do
+          block_called += 1
+        end
+
+        assert_equal(1, block_called)
+      end
+    end
+
+    describe "when form has errors" do
+      it "doesn't call the given block" do
+        validator.validate_presence(:username)
+
+        block_called = 0
+
+        validator.validation_block do
+          block_called += 1
+        end
+
+        assert_equal(0, block_called)
+      end
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: organ
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Sebastian Borrazas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies: []
 description: A small library for manipulating form-based data with validations and
   attributes coercion.