hatch 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDlkZmRlM2ViZDQxZDFiODVlNGY3ZTNmNzcyMTMzZTViZWQ5OTc1Mw==
-  data.tar.gz: !binary |-
-    YTk3Nzg0NDk0MGIzMzI4NWNmNzIzZjdkZWM3YjM3YjhkMGEyODA1ZQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NGM4MjIyZmI2MzE3OTgzNmQ5YzI5YjI3OTkwN2I3NDRiNGQ1M2JiNTQzMzgw
-    NzAyYTc1ZmM0OTRiZTg3Y2RmMTNhYzA2OWU2NDBlYjE1MmRiYTMwZGFjYTY5
-    ODA2ZTk2YzA2ZDU2NDI4MDM4MzZhZTIyYTEwNDVmNjg5ZjBmZmU=
-  data.tar.gz: !binary |-
-    Y2QyZDkyNjA2Y2Y5YzM5ZjkzNzdiOGU0MDYzNzlkNTJhMTY0NTA3MjE4YjIz
-    Yjc1NTdhYjBiZWMyYjJjYzRkN2I2ZmE0MWU5NjBiOWNjNDdiODBjMWRlOTc3
-    NmJkYzcwYTViZmVjMDFhYmU5YWE2YjFlODRiMzY4YjJmMTczZGY=
+SHA1:
+  metadata.gz: bd01fbcc30072e37286dc7730b09873dbf7a51df
+  data.tar.gz: c69e71d77e49ee54a0f669dd520e339a2dba26b4
+SHA512:
+  metadata.gz: 43cbf31600f855994c6f323e2b2c6c69b78742d7497748ef92e59c53bb5e794e103437ff4df1007c3530cd1f3ac657e52ce141d866a60f1d8279cb4d9a36cab7
+  data.tar.gz: e05048b602d6a90c3736d0096f8cb141960b65b504da6c6506c382a30866d3de4b19a83231ebcd53b99963bd59cf6590e9312b24aa61366e540656095e154dee

data/README.md

@@ -11,7 +11,6 @@ Installation
 Usage
 -----
 
-
 Tell `Hatch` how to certify the attributes of your models, and it will give you the appropriate object.
 
 If you don't hatch your model with all the correct attributes, you'll get an object representing an invalid instance of it.
@@ -55,7 +54,7 @@ In case you're wondering, the `Model::InvalidModel` is polymorphic with your `Mo
 class Address
   include Hatch
 
-  certifies(:street, :not_empty, 'This is an error! Where's my street?!')
+  certifies(:street, :not_empty, "This is an error! Where's my street?!")
   certifies(:number, :positive_number)
 end
 ```
@@ -91,6 +90,34 @@ not_an_address.errors.empty?
 # => false
 ```
 
+Interesting use cases
+---------------------
+
+`Hatch` is essentially a validator, so you can rely on it to certify your attributes before they get to the model.
+
+```ruby
+class AddressForm
+  include Hatch
+
+  certify(:street, 'Address must have a street') do |street|
+    !street.nil? && !street.empty?
+  end
+
+  certify(:number, 'Address must have a positive number') do |number|
+    !number.nil? && number > 0
+  end
+end
+
+# Meanwhile, in your favorite Ruby web framework...
+address_form = AddressForm.hatch(params['address'])
+
+if address_form.valid?
+  Address.create(params['address'])
+else
+  # try again
+end
+```
+
 One of the nicest things about `Hatch` is that errors can be any object of your desire! Power to thy user.
 
 ```ruby

data/hatch.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'hatch'
-  s.version     = '0.1.2'
+  s.version     = '0.1.3'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.summary     = 'Keep valid objects only'
   s.description = "An address without a street? A person without a name? You don't need no invalid objects!"

data/lib/hatch.rb

@@ -22,7 +22,7 @@ module Hatch
         include InvalidInstanceMethods
       end
 
-      klass.const_set("Invalid#{klass}", invalid_class)
+      klass.const_set("Invalid#{klass.name.split('::').last}", invalid_class)
     end
 
     def certify(attribute, error, &block)
@@ -45,77 +45,101 @@ module Hatch
       build(validated_attributes)
     end
 
+    def build(validated_attributes)
+      if validated_attributes.all? {|validated_attribute| validated_attribute.valid?}
+        set_instance_variables(new, *validated_attributes)
+      else
+        const_get("Invalid#{self.to_s.split('::').last}").new(*validated_attributes)
+      end
+    end
+    private :build
+
+    def set_instance_variables(instance, *args)
+      @@validations[instance.class.name.to_sym].keys.each_with_index do |attribute, index|
+        instance.instance_variable_set("@#{attribute}", args[index].value)
+      end
+      instance
+    end
+    private :set_instance_variables
+
     module InvalidInstanceMethods
-      attr_reader :errors
+      attr :errors
 
       def initialize(*validated_attributes)
         @validated_attributes = validated_attributes
         @errors = Errors.build(@validated_attributes)
-        respond_to_instance_methods
+        respond_to_readable_attributes
       end
 
       def valid?
         false
       end
 
-    private
-
-      def respond_to_instance_methods
-        attributes_with_reader_method.each do |attribute|
-          self.class.send :define_method, attribute.attr, -> {attribute.value}
+      def respond_to_readable_attributes
+        readable_attributes.each do |readable_attribute|
+          self.class.send(:define_method,
+                          readable_attribute.attribute,
+                          -> {readable_attribute.value})
         end
       end
+      private :respond_to_readable_attributes
 
-      def attributes_with_reader_method
-        extended_klass = Kernel.const_get(self.class.to_s.split("Invalid").last)
-        instance_methods = extended_klass.instance_methods(false)
+      def readable_attributes
+        instance_methods = extended_class.instance_methods(false)
 
         @validated_attributes.select do |validated_attribute|
-          instance_methods.include?(validated_attribute.attr)
+          instance_methods.include?(validated_attribute.attribute)
+        end
+      end
+      private :readable_attributes
+
+      def extended_class
+        self.class.name.gsub(/(.*)(\:\:Invalid)(.*)/, '\1').split('::').inject(Object) do |mod, class_name|
+          mod.const_get(class_name)
         end
       end
+      private :extended_class
     end
+  end
 
-  private
+  class ValidatedAttribute
+    attr :attribute, :value, :error
 
-    def build(validated_attributes)
-      if validated_attributes.all? {|validated_attribute| validated_attribute.valid?}
-        set_instance_variables(new, *validated_attributes)
+    def self.validate(attribute, value, error, &block)
+      if yield(value)
+        ValidAttribute.new(attribute, value)
       else
-        const_get("Invalid#{self}").new(*validated_attributes)
+        InvalidAttribute.new(attribute, value, error)
       end
     end
 
-    def set_instance_variables(instance, *args)
-      @@validations[instance.class.to_s.to_sym].keys.each_with_index do |attribute, index|
-        instance.instance_variable_set("@#{attribute}", args[index].value)
-      end
-      instance
+    def initialize(attribute, value, error = [])
+      @attribute, @value, @error = attribute, value, error
     end
   end
 
-  class ValidatedAttribute
-    attr_reader :attr, :value, :error
-
-    def self.validate(attr, value, error, &block)
-      new(attr, value, error, yield(value))
+  class ValidAttribute < ValidatedAttribute
+    def valid?
+      true
     end
 
-    def initialize(attr, value, error, valid)
-      @attr, @value, @error, @valid = attr, value, error, valid
+    def invalid?
+      false
     end
+  end
 
+  class InvalidAttribute < ValidatedAttribute
     def valid?
-      @valid
+      false
     end
 
     def invalid?
-      !@valid
+      true
     end
   end
 
   class Validation
-    attr_reader :error, :block
+    attr :error, :block
 
     def initialize(error, &block)
       @error, @block = error, block
@@ -151,14 +175,12 @@ module Hatch
       full_messages.empty?
     end
 
-  private
-
     def self.attributes_and_errors(validated_attributes)
       validated_attributes.map do |validated_attribute|
-        [validated_attribute.attr,
-         validated_attribute.invalid? ? validated_attribute.error : [] ]
+        [validated_attribute.attribute, validated_attribute.error]
       end
     end
+    private_class_method :attributes_and_errors
   end
 end
 

data/test/namespace_test.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require_relative 'support/namespaced_address'
+
+class NamespaceTest < MiniTest::Unit::TestCase
+  def test_namespace
+    address = SomeApp::Address.hatch(street: 'Fake St', number: 1234, city: 'Buenos Aires')
+    assert_instance_of SomeApp::Address, address
+
+    address = SomeApp::Address.hatch(street: 'Fake St', number: -1, city: 'Buenos Aires')
+    assert_instance_of SomeApp::Address::InvalidAddress, address
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hatch
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lucas Tolchinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies: []
 description: An address without a street? A person without a name? You don't need
   no invalid objects!
@@ -19,13 +19,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- hatch.gemspec
 - Rakefile
+- hatch.gemspec
+- lib/hatch.rb
 - test/common_validations_test.rb
 - test/errors_test.rb
+- test/namespace_test.rb
 - test/polymorphism_test.rb
 - test/validation_test.rb
-- lib/hatch.rb
 homepage: http://github.com/tonchis/hatch
 licenses:
 - MIT
@@ -36,17 +37,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Keep valid objects only