constructable 0.3.4 → 0.4.0

data/README.markdown

@@ -15,14 +15,14 @@ end
 ```
 
 Then you can construct objects by providing a hash as the last argument
-to ProgrammingLanguage.new like this:
+to ```ProgrammingLanguage.new``` like this:
 
 ```ruby
 ruby = ProgrammingLanguage.new(name: 'Ruby', creator: 'Yukihiro Matsumoto')
 ```
 
-The object _ruby_ will now have the instance variables _@name_ and
-_@creator_ set to _'Ruby'_ and _'Yukihiro Matsumoto'_.
+The object ```ruby``` will now have the instance variables ```@name``` and
+```@creator``` set to ```'Ruby'``` and ```'Yukihiro Matsumoto'```.
 
 
 ## Setters, Getters
@@ -80,12 +80,7 @@ turtle.biological_class
 ```
 
 
-## Validations
-
-You can setup validation for constructable attributes, so the users of
-your api won't provide weird values or none at all:
-
-### required
+## Required attributes
 
 ```ruby
 class Holidays
@@ -96,33 +91,6 @@ summer_holidays = Holidays.new
 # raises AttributeError, ':when is a required attribute'
 ```
 
-### validate\_type
-
-```ruby
-class Conference
-  constructable :attendees, validate_type: Integer
-end
-
-euruko = Conference.new('~300') # btw, euruko was really great!
-# raises AttributeError, ':attendees must be of type Integer'
-```
-
-### validate
-
-```ruby
-class Farm
-  costructable :animals,
-    validate_type: Array,
-    validate: ->(array_of_animals) do
-      array_of_animals.all? { |animal| animal.is_a?(String) 
-    end
-end
-
-big_farm = Farm.new(animals: [:pigs, :cows])
-# raises AttributeError, ':animals has not passed validation'
-```
-
-
 ## Convert your attributes
 
 You can pass a converter as an option for a constructable attribute,
@@ -162,15 +130,16 @@ rails.opinionated
 ## Redefining setters and getters
 
 You can redefine the setters and getters provided by the constructable
-macro and still get all the validations and stuff by calling super:
+macro and still get all the validations and stuff by calling ```super```:
 
 ```ruby
 class Song
-  constructable :length, accessible: true, validate_type: Integer
+  constructable :length, accessible: true, required: true
 
 
   def length=(length)
-    if length.is_a?(String) && length =~ /(\d{,2}):(\d{,2})/
+    case length
+    when /(\d{,2}):(\d{,2})/
       @length = $1.to_i * 60 + $2.to_i
     else
      super
@@ -185,17 +154,17 @@ song.length = '1:30'
 song.length
 #=> 90
 
-song.length = 'abc'
-# raises AttributeError, ':length must be of type Integer'
+song.length = nil
+# raises AttributeError, ':length is a required attribute'
 
-song = Song.new(name: 'Aaron', length: '6:01')
+song = Song.new(name: 'Aaron', length: 190)
 #=> #<Song:0x0x00000100941528 @length=190 @name="Aaron" @name_history=["Aaron"]>
 ```
 
 ## constructable\_attributes method
 
 You can all the constructable attributes and their values of your class as a hash,
-by calling the constructable_attributes method from within an instance
+by calling the ```constructable_attributes``` method from within an instance
 of your class:
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.4.0

data/constructable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{constructable}
-  s.version = "0.3.4"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Manuel Korfmann"]
-  s.date = %q{2011-06-19}
+  s.date = %q{2011-07-09}
   s.description = %q{Makes constructing objects through an attributes hash easier}
   s.email = %q{manu@korfmann.info}
   s.extra_rdoc_files = [

data/lib/constructable/attribute.rb

@@ -1,21 +1,8 @@
 module Constructable
   class Attribute
-    ATTRIBUTES = [:group, :writable, :readable, :accessible, :required, :validate, :default, :validate_type, :converter]
+    ATTRIBUTES = [:group, :writable, :readable, :accessible, :required, :default, :converter]
     attr_accessor *ATTRIBUTES, :name
 
-    REQUIREMENTS = [
-      {
-        name: :validate_type,
-        message: proc {":#{self.name} must be of type #{self.validate_type}"},
-        check: ->(value) { value.is_a? self.validate_type }
-      },
-      {
-        name: :validate,
-        message: proc {":#{self.name} did not pass validation"},
-        check: ->(value) { self.validate.call(value)}
-      }
-    ]
-
     def initialize(name, options = {})
       @name = name
       ATTRIBUTES.each do |attribute|
@@ -38,20 +25,8 @@ module Constructable
       (self.name.to_s + '=').to_sym
     end
 
-    def check_for_requirement(requirement, value)
-      if self.send requirement[:name]
-        unless self.instance_exec(value,&requirement[:check])
-          raise AttributeError, instance_eval(&requirement[:message])
-        end
-      end
-    end
-    private :check_for_requirement
-
     def process(value)
       unless value.nil?
-        REQUIREMENTS.each do |requirement|
-          check_for_requirement(requirement, value)
-        end
         self.converter ? converter.(value) : value
       else
         raise AttributeError, ":#{self.name} is a required attribute" if self.required

data/test/constructable/test_attribute.rb

@@ -50,41 +50,6 @@ describe 'Attribute' do
       end
     end
 
-    describe 'validator' do
-      it 'checks for validate_type first' do
-        attribute = Attribute.new(:array, validate_type: Array, validate: ->(value) { value.all? { |s| String === s }})
-        assert_raises AttributeError do
-          attribute.process('obviously not an array')
-        end
-      end
-
-      it 'should raise an AttributeError if the validator doesn\'t pass' do
-        attribute = Attribute.new(:foo, validate: ->(number) { number < 5 })
-        begin
-          attribute.process(6)
-        rescue Exception => e
-          assert AttributeError === e, "[#{e.class},#{e.message}] was not expected"
-          assert_equal ':foo did not pass validation', e.message
-        else
-          assert false, 'AttributeError was not raised'
-        end
-      end
-    end
-
-    describe 'validate_type check' do
-      it 'should raise an AttributeError if the value has not the wanted validate_type' do
-        attribute = Attribute.new(:foo, validate_type: Integer)
-        begin
-          attribute.process('notanumber')
-        rescue Exception => e
-          assert AttributeError === e, "[#{e.class},#{e.message}] was not expected"
-          assert_equal ':foo must be of type Integer', e.message
-        else
-          assert false, 'AttributeError was not raised'
-        end
-      end
-    end
-
     describe 'default value' do
       it 'should be possible to provide a default value' do
         attribute = Attribute.new(:foo, default: ->{ :bar })

data/test/constructable/test_constructable.rb

@@ -7,11 +7,11 @@ describe 'integration' do
       end
 
       it 'has a nice syntax' do
-        @klass.constructable :foo, :bar, accessible: true, validate_type: Integer
+        @klass.constructable :foo, :bar, accessible: true, required: true
         instance = @klass.new(foo: 5, bar: 2)
         assert_equal 5, instance.foo
         assert_raises AttributeError do
-          instance.bar = '5'
+          instance.bar = nil
         end
       end
 

data/test/constructable/test_constructor.rb

@@ -14,10 +14,10 @@ describe 'Constructor' do
     end
 
     it 'defines public setters validating like in the constructor' do
-      @klass.constructable :integer, validate_type: Integer, writable: true
-      instance = @klass.new
+      @klass.constructable :integer, required: true, writable: true
+      instance = @klass.new(integer: 1)
       assert_raises AttributeError do
-        instance.integer = 6.6
+        instance.integer = nil
       end
     end
 
@@ -25,14 +25,14 @@ describe 'Constructor' do
 
       describe 'class' do
         it 'getters ' do
-          @klass.constructable :integer, validate_type: Integer, accessible: true
+          @klass.constructable :integer,  accessible: true
           @klass.class_eval { define_method(:integer){ 1 } }
           instance = @klass.new(integer: 2)
           assert_equal 1, instance.integer
         end
 
         it 'setters ' do
-          @klass.constructable :integer, validate_type: Integer, accessible: true
+          @klass.constructable :integer, accessible: true
           @klass.class_eval { def integer=(foo);@integer = 1;end }
           instance = @klass.new(integer: 4)
           instance.integer = 5
@@ -42,7 +42,7 @@ describe 'Constructor' do
 
       describe 'module' do
         before do
-          @module.constructable :integer, validate_type: Integer, accessible: true
+          @module.constructable :integer, accessible: true
         end
 
         it 'getters ' do
@@ -74,18 +74,18 @@ describe 'Constructor' do
 
       describe 'allows to super to the generated method' do
         it 'gets' do
-          @klass.constructable :integer, validate_type: Integer, accessible: true
+          @klass.constructable :integer, accessible: true
           @klass.class_eval { def integer; super ;end }
           instance = @klass.new(integer: 2)
           assert_equal 2, instance.integer
         end
 
         it 'sets' do
-          @klass.constructable :integer, validate_type: Integer, accessible: true
+          @klass.constructable :integer, required: true, accessible: true
           @klass.class_eval { def integer=(value); super ;end }
           instance = @klass.new(integer: 2)
           assert_raises Constructable::AttributeError do
-            instance.integer = :not_an_integer
+            instance.integer = nil
           end
         end
       end

metadata

@@ -2,7 +2,7 @@
 name: constructable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors: 
 - Manuel Korfmann
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-19 00:00:00 +02:00
+date: 2011-07-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4277054694638453062
+      hash: 4244750192916638565
       segments: 
       - 0
       version: "0"