constructable 0.3.2 → 0.3.3

data/README.markdown

@@ -24,33 +24,6 @@ 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'_.
 
-## Does not break initialize behaviour
-
-You can use initialize just like you'd normally do:
-
-```ruby
-class Animal
-  constructable [:biological_class, readable: true]
-  attr_reader :name
-
-  GuessBiologicalClass = { ['Pig', 'Cow', 'Whale'] => 'Mammal', [ 'Turtle', 'Caiman' ] => 'Reptile' }
-
-  def initialize(name, options = {})
-    @name = name
-    @biological_class = GuessBiologicalClass.find { |animals,_| animals.include?(name) }.last if options[:guess_biological_class]
-  end
-end
-
-rhinocerus = Animal.new('Rhinocerus', biological_class: 'Mammal')
-rhinocerus.biological_class
-#=> 'Mammal'
-
-turtle = Animal.new('Turtle', guess_biological_class: true)
-turtle.biological_class
-#=> 'Reptile'
-```
-
-
 
 ## Setters, Getters
 
@@ -79,6 +52,34 @@ orient_express.location
 #=> 'Budapest'
 ```
 
+
+## Does not break initialize behaviour
+
+You can use initialize just like you'd normally do:
+
+```ruby
+class Animal
+  constructable [:biological_class, readable: true]
+  attr_reader :name
+
+  GuessBiologicalClass = { ['Pig', 'Cow', 'Whale'] => 'Mammal', [ 'Turtle', 'Caiman' ] => 'Reptile' }
+
+  def initialize(name, options = {})
+    @name = name
+    @biological_class = GuessBiologicalClass.find { |animals,_| animals.include?(name) }.last if options[:guess_biological_class]
+  end
+end
+
+rhinocerus = Animal.new('Rhinocerus', biological_class: 'Mammal')
+rhinocerus.biological_class
+#=> 'Mammal'
+
+turtle = Animal.new('Turtle', guess_biological_class: true)
+turtle.biological_class
+#=> 'Reptile'
+```
+
+
 ## Validations
 
 You can setup validation for constructable attributes, so the users of
@@ -121,6 +122,7 @@ 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,
@@ -139,6 +141,7 @@ small_box.height
 #=> 240
 ```
 
+
 ## Default values
 
 You can also specify, which values your constructable attributes are set
@@ -146,7 +149,7 @@ to by default:
 
 ```ruby
 class Framework
-  constructable :opinionated, default: true
+  constructable :opinionated, default: ->{true}
 end
 
 rails = Framework.new
@@ -155,6 +158,7 @@ rails.opinionated
 
 ```
 
+
 ## Redefining setters and getters
 
 You can redefine the setters and getters provided by the constructable
@@ -173,7 +177,7 @@ class Song
   end
 end
 
-song = Song.new(length: 190)
+song = Song.new(length: '3:10')
 #=> #<Song:0x000001010ea040 @length=190>
 
 song.length = '1:30'
@@ -184,6 +188,30 @@ song.length = 'abc'
 # raises AttributeError, ':length must be of type Integer'
 ```
 
+You can also redefine private setters/getters the constructable
+class macro set up for you:
+
+```ruby
+class Song
+  constructable :name, validate_type: String
+  attribute_reader :name_history
+
+  def initialize(opts = {})
+    @name_history = []
+  end
+
+ private
+
+  def name=(name)
+    @name_histoy += name
+    super
+  end
+end
+
+song = Song.new(name: 'Aaron', length: '6:01')
+#=> #<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,
@@ -212,7 +240,7 @@ impossible, to provide all the magic of this gem, without defining
 the 'included' macro. I thought about getting rid of some of the magic,
 but this would infer with my initial intention, to provide an easy way
 to make constructable classes. If someone has a nice idea, how to solve
-this problem elgantely, please contact me!
+this problem elgantly, please contact me!
 
 ## Copyright
 Copyright (c) 2011 Manuel Korfmann. See LICENSE.txt for

data/Rakefile

@@ -18,12 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/mkorfmann/constructable"
   gem.license = "MIT"
   gem.summary = %Q{Makes constructing objects through an attributes hash easier}
-  gem.description = %Q{
-Adds the class macro Class#constructable to easily define what attributes a Class accepts provided as a hash to Class#new.
-Attributes can be configured in their behaviour in case they are not provided or are in the wrong format.
-Their default value can also be defined and you have granular control on how accessible your attribute is.
-See the documentation for Constructable::Constructable#constructable or the README for more information.
-  }
+  gem.description = %Q{Makes constructing objects through an attributes hash easier}
   gem.email = "manu@korfmann.info"
   gem.authors = ["Manuel Korfmann"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/constructable.gemspec

@@ -5,17 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{constructable}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Manuel Korfmann"]
-  s.date = %q{2011-06-17}
-  s.description = %q{
-Adds the class macro Class#constructable to easily define what attributes a Class accepts provided as a hash to Class#new.
-Attributes can be configured in their behaviour in case they are not provided or are in the wrong format.
-Their default value can also be defined and you have granular control on how accessible your attribute is.
-See the documentation for Constructable::Constructable#constructable or the README for more information.
-  }
+  s.date = %q{2011-06-18}
+  s.description = %q{Makes constructing objects through an attributes hash easier}
   s.email = %q{manu@korfmann.info}
   s.extra_rdoc_files = [
     "LICENSE.txt",

data/lib/constructable/attribute.rb

@@ -2,18 +2,17 @@ module Constructable
   class Attribute
     ATTRIBUTES = [:group, :writable, :readable, :accessible, :required, :validate, :default, :validate_type, :converter]
     attr_accessor *ATTRIBUTES, :name
-    attr_reader :value
 
     REQUIREMENTS = [
-      {
-        name: :validate,
-        message: proc {":#{self.name} did not pass validation"},
-        check: ->(hash) { self.validate.call(hash[self.name])}
-      },
       {
         name: :validate_type,
         message: proc {":#{self.name} must be of type #{self.validate_type}"},
-        check: ->(hash) { hash[self.name].is_a? 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)}
       }
     ]
 
@@ -35,26 +34,24 @@ module Constructable
       ('@' + self.name.to_s).to_sym
     end
 
-    def check_for_requirement(requirement, constructor_hash)
+    def check_for_requirement(requirement, value)
       if self.send requirement[:name]
-        unless self.instance_exec(constructor_hash,&requirement[:check])
+        unless self.instance_exec(value,&requirement[:check])
           raise AttributeError, instance_eval(&requirement[:message])
         end
       end
     end
     private :check_for_requirement
 
-    def process(constructor_hash)
-      unless constructor_hash[self.name].nil?
+    def process(value)
+      unless value.nil?
         REQUIREMENTS.each do |requirement|
-          check_for_requirement(requirement, constructor_hash)
+          check_for_requirement(requirement, value)
         end
-
-        value = constructor_hash[self.name]
         self.converter ? converter.(value) : value
       else
         raise AttributeError, ":#{self.name} is a required attribute" if self.required
-        self.default
+        self.default.call if self.default
       end
     end
   end

data/lib/constructable/constructor.rb

@@ -47,19 +47,21 @@ module Constructable
       attributes = @attributes
       attributes.each do |attribute|
         @module.module_eval do
-          attr_reader attribute.name if attribute.readable
+          attr_reader attribute.name
 
           define_method(:"#{attribute.name}=") do |value|
-            instance_variable_set attribute.ivar_symbol, attribute.process({ attribute.name => value})
-          end if attribute.writable
+            instance_variable_set attribute.ivar_symbol, attribute.process(value)
+          end
+          private attribute.name unless attribute.readable
+          private :"#{attribute.name}=" unless attribute.writable
         end
       end
     end
 
     def construct(constructor_hash, obj)
       constructor_hash ||= {}
-      @attributes.each do |attributes|
-        obj.instance_variable_set(attributes.ivar_symbol, attributes.process(constructor_hash))
+      @attributes.each do |attribute|
+        obj.send :"#{attribute.name}=", constructor_hash[attribute.name]
       end
     end
 

data/test/constructable/test_attribute.rb

@@ -19,19 +19,19 @@ describe 'Attribute' do
   describe 'process' do
     it 'intepretes nil but not false as undefined' do
       attribute = Attribute.new(:foo, default: true)
-      assert_equal false, attribute.process({foo: false})
+      assert_equal false, attribute.process(false)
     end
 
     it 'should raise nothing if no attributes are specified' do
       attribute = Attribute.new(:foo)
-      assert_equal 'bar', attribute.process({foo: 'bar'})
+      assert_equal 'bar', attribute.process('bar')
     end
 
     describe 'required attribute' do
       it 'should raise an AttributeError if required is set to true' do
         attribute = Attribute.new(:foo, required: true)
         begin
-          attribute.process(bar: 'blab')
+          attribute.process(nil)
         rescue Exception => e
           assert AttributeError === e
           assert_equal ':foo is a required attribute', e.message
@@ -45,16 +45,23 @@ describe 'Attribute' do
       it 'does not check for further requirements' do
         attribute = Attribute.new(:foo, validate_type: Integer)
         refute_raises do
-          attribute.process({})
+          attribute.process(nil)
         end
       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(foo: 6)
+          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
@@ -68,7 +75,7 @@ describe 'Attribute' 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(foo: 'notanumber')
+          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
@@ -80,15 +87,15 @@ describe 'Attribute' do
 
     describe 'default value' do
       it 'should be possible to provide a default value' do
-        attribute = Attribute.new(:foo, default: :bar)
-        assert_equal :bar, attribute.process({})
+        attribute = Attribute.new(:foo, default: ->{ :bar })
+        assert_equal :bar, attribute.process(nil)
       end
     end
 
     describe 'convert value' do
       it 'is possible to define a converter(proc) which converts attribute values' do
         attribute = Attribute.new(:number, converter: ->(value) { value.to_i })
-        assert_equal 5, attribute.process({number: '5'})
+        assert_equal 5, attribute.process('5')
       end
     end
   end

data/test/constructable/test_constructor.rb

@@ -22,6 +22,14 @@ describe 'Constructor' do
     end
 
     describe 'redefining' do
+      describe 'constructing a class will call redefined setters' do
+        it 'calls the redefined setters' do
+          @klass.constructable :bacon, readable: true
+          @klass.class_eval { private; def bacon=(value);super(:zomg_bacon);end }
+          instance = @klass.new(bacon: :no_bacon)
+          assert_equal :zomg_bacon, instance.bacon
+        end
+      end
 
       describe 'class' do
         it 'getters ' do
@@ -88,6 +96,13 @@ describe 'Constructor' do
             instance.integer = :not_an_integer
           end
         end
+
+        it 'sets for private setters/getters' do
+          @klass.constructable :integer, validate_type: Integer, readable: true
+          @klass.class_eval { private; def integer=(value); super(value.to_i) ;end }
+          instance = @klass.new(integer: '5')
+          assert_equal 5, instance.integer
+        end
       end
     end
   end

metadata

@@ -2,7 +2,7 @@
 name: constructable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Manuel Korfmann
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-17 00:00:00 +02:00
+date: 2011-06-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,11 +57,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id004
-description: "\n\
-  Adds the class macro Class#constructable to easily define what attributes a Class accepts provided as a hash to Class#new.\n\
-  Attributes can be configured in their behaviour in case they are not provided or are in the wrong format.\n\
-  Their default value can also be defined and you have granular control on how accessible your attribute is.\n\
-  See the documentation for Constructable::Constructable#constructable or the README for more information.\n  "
+description: Makes constructing objects through an attributes hash easier
 email: manu@korfmann.info
 executables: []
 
@@ -104,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 932073679521130628
+      hash: 335237132407385369
       segments: 
       - 0
       version: "0"