smart_properties 1.1.0 → 1.2.0

data/lib/smart_properties.rb

@@ -1,16 +1,16 @@
 ##
-# {SmartProperties} can be used to easily build more full-fledged accessors 
-# for standard Ruby classes. In contrast to regular accessors, 
-# {SmartProperties} support validation and conversion of input data, as well 
-# as, the specification of default values. Additionally, individual 
+# {SmartProperties} can be used to easily build more full-fledged accessors
+# for standard Ruby classes. In contrast to regular accessors,
+# {SmartProperties} support validation and conversion of input data, as well
+# as, the specification of default values. Additionally, individual
 # {SmartProperties} can be marked as required. This causes the runtime to
 # throw an +ArgumentError+ whenever a required property has not been
 # specified.
 #
-# In order to use {SmartProperties}, simply include the {SmartProperties} 
+# In order to use {SmartProperties}, simply include the {SmartProperties}
 # module and use the {ClassMethods#property} method to define properties.
 #
-# @see ClassMethods#property 
+# @see ClassMethods#property
 #   More information on how to configure properties
 #
 # @example Definition of a property that makes use of all {SmartProperties} features.
@@ -21,9 +21,9 @@
 #                           :required => true
 #
 module SmartProperties
-  
-  VERSION = "1.1.0"
-  
+
+  VERSION = "1.2.0"
+
   class Property
 
     attr_reader :name
@@ -32,13 +32,13 @@ module SmartProperties
 
     def initialize(name, attrs = {})
       attrs = attrs.dup
-      
+
       @name      = name.to_sym
       @default   = attrs.delete(:default)
       @converter = attrs.delete(:converts)
       @accepter  = attrs.delete(:accepts)
       @required  = !!attrs.delete(:required)
-      
+
       unless attrs.empty?
         raise ArgumentError, "SmartProperties do not support the following configuration options: #{attrs.keys.join(', ')}."
       end
@@ -65,7 +65,7 @@ module SmartProperties
         end
       end
     end
-    
+
     def default(scope)
       @default.kind_of?(Proc) ? scope.instance_exec(&@default) : @default
     end
@@ -73,7 +73,7 @@ module SmartProperties
     def accepts?(value, scope)
       return true unless value
       return true unless accepter
-      
+
       if accepter.kind_of?(Enumerable)
         accepter.include?(value)
       elsif !accepter.kind_of?(Proc)
@@ -82,7 +82,7 @@ module SmartProperties
         !!scope.instance_exec(value, &accepter)
       end
     end
-    
+
     def prepare(value, scope)
       if required? && value.nil?
         raise ArgumentError, "#{scope.class.name} requires the property #{self.name} to be set"
@@ -96,10 +96,10 @@ module SmartProperties
 
       @value = value
     end
-    
+
     def define(klass)
       property = self
-      
+
       scope = klass.instance_variable_get(:"@_smart_properties_method_scope") || begin
         m = Module.new
         klass.send(:include, m)
@@ -114,21 +114,88 @@ module SmartProperties
     end
 
   end
-  
+
+  ##
+  # {AttributeBuilder} is a singleton object that builds and keeps track of
+  # annonymous class that can be used to build attribute hashes for smart
+  # property enabled classes.
+  #
+  class << (AttributeBuilder = Object.new)
+
+    ##
+    # Returns an attribute builder for a given klass. If the attribute builder
+    # does not exist yet, it is created.
+    #
+    # @return [Class]
+    #
+    def [](klass)
+      store.fetch(klass) { new(property_names_for(klass)) }
+    end
+
+    ##
+    # Constructs a hash of attributes for a smart property enabled class using
+    # the instructions provided by the block.
+    #
+    # @return [Hash<String, Object>] Hash of attributes
+    #
+    def build_attributes_for(klass, &block)
+      block.nil? ? {} : self[klass].new(&block).to_hash
+    end
+
+    ##
+    # Returns the name of this singleton object.
+    #
+    # @return String
+    #
+    def inspect
+      "AttributeBuilder"
+    end
+    alias :to_s :inspect
+
+    ##
+    # Creates a new anonymous class that can act as an attribute builder.
+    #
+    # @return [Class]
+    #
+    def new(fields)
+      Struct.new(*fields) do
+        def initialize(*args, &block)
+          super
+          yield(self) if block
+        end
+
+        def to_hash
+          Hash[members.zip(entries)]
+        end
+      end
+    end
+
+    private
+
+      def property_names_for(klass)
+        klass.properties.keys
+      end
+
+      def store
+        @store ||= {}
+      end
+
+  end
+
   module ClassMethods
 
     ##
-    # Returns the list of smart properties that for this class. This 
-    # includes the properties that have been defined in the parent classes.
+    # Returns a class's smart properties. This includes the properties that
+    # have been defined in the parent classes.
     #
-    # @return [Array<Property>] The list of properties.
+    # @return [Hash<String, Property>] A map of property names to property instances.
     #
     def properties
-      @_smart_properties ||= begin        
+      @_smart_properties ||= begin
         parent = if self != SmartProperties
           (ancestors[1..-1].find { |klass| klass.ancestors.include?(SmartProperties) && klass != SmartProperties })
         end
-        
+
         parent ? parent.properties.dup : {}
       end
     end
@@ -189,13 +256,13 @@ module SmartProperties
     protected :property
 
   end
-  
+
   class << self
-    
+
     private
-    
+
       ##
-      # Extends the class, which this module is included in, with a property 
+      # Extends the class, which this module is included in, with a property
       # method to define properties.
       #
       # @param [Class] base the class this module is included in
@@ -203,17 +270,18 @@ module SmartProperties
       def included(base)
         base.extend(ClassMethods)
       end
-    
+
   end
-  
+
   ##
   # Implements a key-value enabled constructor that acts as default
   # constructor for all {SmartProperties}-enabled classes.
   #
   # @param [Hash] attrs the set of attributes that is used for initialization
   #
-  def initialize(attrs = {})
+  def initialize(attrs = {}, &block)
     attrs ||= {}
+    attrs = attrs.merge(AttributeBuilder.build_attributes_for(self.class, &block)) if block
 
     self.class.properties.each do |_, property|
       value = attrs.key?(property.name) ? attrs.delete(property.name) : property.default(self)

data/spec/smart_properties_spec.rb

@@ -13,9 +13,9 @@ describe SmartProperties do
     it "should add a .property method" do
       subject.should respond_to(:property)
     end
-    
+
     context "and defining a property with invalid configuration options" do
-      
+
       it "should raise an error reporting one invalid option when one invalid option was given" do
         expect {
           subject.tap do |c|
@@ -25,7 +25,7 @@ describe SmartProperties do
           end
         }.to raise_error(ArgumentError, "SmartProperties do not support the following configuration options: invalid_option.")
       end
-      
+
       it "should raise an error reporting three invalid options when three invalid options were given" do
         expect {
           subject.tap do |c|
@@ -35,30 +35,30 @@ describe SmartProperties do
           end
         }.to raise_error(ArgumentError, "SmartProperties do not support the following configuration options: invalid_option_1, invalid_option_2, invalid_option_3.")
       end
-      
+
     end
 
   end
 
-  context "when used to build a class that has a property called :title on a class" do
-    
+  context "when used to build a class that has a property called :title" do
+
     subject do
       title = Object.new.tap do |o|
         def o.to_title; 'chunky'; end
       end
-      
+
       klass = Class.new.tap do |c|
         c.send(:include, described_class)
         c.instance_eval do
           def name; "TestDummy"; end
-          
+
           property :title, :accepts => String,
                                  :converts => :to_title,
                                  :required => true,
                                  :default => title
         end
       end
-      
+
       klass
     end
 
@@ -66,40 +66,54 @@ describe SmartProperties do
     its(:properties) { should have_key(:title) }
 
     context "instances of this class" do
-      
+
       klass = subject.call
-      
+
       subject do
         klass.new
       end
-      
+
       it { should respond_to(:title) }
       it { should respond_to(:title=) }
-      
+
       it "should have 'chucky' as default value for title" do
         subject.title.should be == 'chunky'
       end
-      
+
       it "should convert all values that are assigned to title into strings" do
         subject.title = double(:to_title => 'bacon')
         subject.title.should be == 'bacon'
       end
-      
+
       it "should not allow to set nil as title" do
         expect { subject.title = nil }.to raise_error(ArgumentError, "TestDummy requires the property title to be set")
       end
-      
+
       it "should not allow to set objects as title that do not respond to #to_title" do
         expect { subject.title = Object.new }.to raise_error(ArgumentError, "Object does not respond to #to_title")
       end
-      
+
       it "should not influence other instances that have been initialized with different attributes" do
         other = klass.new :title => double(:to_title => 'Lorem ipsum')
-        
+
         subject.title.should be == 'chunky'
         other.title.should   be == 'Lorem ipsum'
       end
 
+      context "when initialized with a block" do
+
+        subject do
+          klass.new do |c|
+            c.title = double(:to_title => 'bacon')
+          end
+        end
+
+        it "should have the title specified in the block" do
+          subject.title.should be == 'bacon'
+        end
+
+      end
+
     end
 
     context "when subclassed" do
@@ -127,25 +141,25 @@ describe SmartProperties do
       end
 
       context "instances of this subclass that have been intialized from a set of attributes" do
-        
+
         klass = subject.call
-        
+
         subject do
           klass.new :title => stub(:to_title => 'Message')
         end
-        
+
         it "should have the correct title" do
           subject.title.should be == 'Message'
         end
-        
+
       end
-      
+
     end
 
     context "when subclassed and extended with a property called text" do
-      
+
       superklass = subject.call
-      
+
       subject do
         Class.new(superklass).tap do |c|
           c.instance_eval do
@@ -159,55 +173,78 @@ describe SmartProperties do
       its(:properties) { should have_key(:text) }
 
       context "instances of this subclass" do
-        
+
         klass = subject.call
-        
+
         subject do
           klass.new
         end
-        
+
         it { should respond_to(:title) }
         it { should respond_to(:title=) }
         it { should respond_to(:text) }
         it { should respond_to(:text=) }
-        
+
       end
-      
+
       context "instances of the super class" do
-        
+
         subject do
           superklass.new
         end
-        
+
         it { should_not respond_to(:text) }
         it { should_not respond_to(:text=) }
-        
+
       end
-      
-      context "instances of this subclass that have been intialized from a set of attributes" do
-        
+
+      context "instances of this subclass" do
+
         klass = subject.call
-        
-        subject do
-          klass.new :title => stub(:to_title => 'Message'), :text => "Hello"
-        end
-        
-        it "should have the correct title" do
-          subject.title.should be == 'Message'
+
+        context "when initialized with a set of attributes" do
+
+          subject do
+            klass.new :title => stub(:to_title => 'Message'), :text => "Hello"
+          end
+
+          it "should have the correct title" do
+            subject.title.should be == 'Message'
+          end
+
+          it "should have the correct text" do
+            subject.text.should be == 'Hello'
+          end
+
         end
-        
-        it "should have the correct text" do
-          subject.text.should be == 'Hello'
+
+        context "when initialized with a block" do
+
+          subject do
+            klass.new do |c|
+              c.title = stub(:to_title => 'Message')
+              c.text = "Hello"
+            end
+          end
+
+          it "should have the title specified in the block" do
+            subject.title.should be == 'Message'
+          end
+
+          it "should have the text specified in the block" do
+            subject.text.should be == 'Hello'
+          end
+
         end
-        
+
       end
-      
+
     end
-    
+
     context "when extended with a :type property at runtime" do
-      
+
       klass = subject.call
-      
+
       subject do
         klass.tap do |c|
           c.instance_eval do
@@ -221,50 +258,50 @@ describe SmartProperties do
       its(:properties) { should have_key(:type) }
 
       context "instances of this class" do
-        
+
         klass = subject.call
-        
+
         subject do
           klass.new :title => double(:to_title => 'Lorem ipsum')
         end
-        
+
         it { should respond_to(:type)  }
         it { should respond_to(:type=) }
-        
+
       end
-      
+
       context "when subclassing this class" do
-        
+
         superklass = subject.call
-        
+
         subject do
           Class.new(superklass)
         end
-        
+
         context "instances of this class" do
-          
+
           klass = subject.call
-          
+
           subject do
             klass.new :title => double(:to_title => 'Lorem ipsum')
           end
-          
+
           it { should respond_to :title }
           it { should respond_to :title= }
-          
+
           it { should respond_to :type }
           it { should respond_to :type= }
-          
+
         end
-        
+
       end
-      
+
     end
-    
+
   end
-  
+
   context "when used to build a class that has a property called :title which a lambda statement for conversion" do
-    
+
     subject do
       Class.new.tap do |c|
         c.send(:include, described_class)
@@ -273,106 +310,106 @@ describe SmartProperties do
         end
       end
     end
-    
+
     context "instances of this class" do
-      
+
       klass = subject.call
-      
+
       subject do
         klass.new
       end
-      
+
       it "should convert the property title as specified the lambda statement" do
         subject.title = "Lorem ipsum"
         subject.title.should be == "<title>Lorem ipsum</title>"
       end
-      
+
     end
-    
+
   end
-  
+
   context "when used to build a class that has a property called :visible which uses an array of valid values for acceptance checking" do
-    
+
     subject do
       Class.new.tap do |c|
         def c.name; "TestDummy"; end
-        
+
         c.send(:include, described_class)
-        
+
         c.instance_eval do
           property :visible, :accepts => [true, false]
         end
       end
     end
-    
+
     context "instances of this class" do
-      
+
       klass = subject.call
 
       subject do
         klass.new
       end
-      
+
       it "should allow to set true as value for visible" do
         expect { subject.visible = true }.to_not raise_error
       end
-      
+
       it "should allow to set false as value for visible" do
         expect { subject.visible = false }.to_not raise_error
       end
-      
+
       it "should not allow to set :maybe as value for visible" do
         expect { subject.visible = :maybe }.to raise_error(ArgumentError, "TestDummy does not accept :maybe as value for the property visible")
       end
-      
+
     end
-    
+
   end
-  
+
   context 'when used to build a class that has a property called :license_plate which uses a lambda statement for accpetance checking' do
-    
+
     subject do
       Class.new.tap do |c|
         def c.name; 'TestDummy'; end
-        
+
         c.send(:include, described_class)
-        
+
         c.instance_eval do
           property :license_plate, :accepts => lambda { |v| /\w{1,2} \w{1,2} \d{1,4}/.match(v) }
         end
       end
     end
-    
+
     context 'instances of this class' do
-      
+
       klass = subject.call
-      
+
       subject do
         klass.new
       end
-      
+
       it 'should not a accept "invalid" as value for license_plate' do
         expect { subject.license_plate = "invalid" }.to raise_error(ArgumentError, 'TestDummy does not accept "invalid" as value for the property license_plate')
       end
-      
+
       it 'should accept "NE RD 1337" as license plate' do
         expect { subject.license_plate = "NE RD 1337" }.to_not raise_error
       end
-      
+
     end
-    
+
   end
-  
+
   context 'when used to build a class that has a property called :text whose getter is overriden' do
-    
+
     subject do
       Class.new.tap do |c|
         c.send(:include, described_class)
-        
+
         c.instance_eval do
           property :text, :default => 'Hello'
         end
-        
+
         c.class_eval do
           def text
             "<em>#{super}</em>"
@@ -380,59 +417,59 @@ describe SmartProperties do
         end
       end
     end
-    
+
     context "instances of this class" do
-      
+
       klass = subject.call
-      
+
       subject do
         klass.new
       end
-      
+
       it "should return the accepted value for the property called :text" do
         subject.text.should be == '<em>Hello</em>'
       end
-      
+
     end
-    
+
   end
-  
+
   context 'when used to build a class that has a property called :id whose default value is a lambda statement' do
-    
+
     subject do
       counter = Class.new.tap do |c|
-        
+
         c.class_eval do
           def next
             @counter ||= 0
             @counter += 1
           end
         end
-        
+
       end.new
-      
+
       Class.new.tap do |c|
         c.send(:include, described_class)
-        
+
         c.instance_eval do
           property :id, :default => lambda { counter.next }
         end
       end
     end
-    
+
     context "instances of this class" do
-      
+
       klass = subject.call
-      
+
       it "should have auto-incrementing ids" do
         first_instance = klass.new
         second_instance = klass.new
-        
+
         (second_instance.id - first_instance.id).should be == 1
       end
-      
+
     end
-    
+
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_properties
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-03 00:00:00.000000000 Z
+date: 2012-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2267066308945748271
+      hash: 2972832392315398871
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,10 +135,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2267066308945748271
+      hash: 2972832392315398871
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: SmartProperties – Ruby accessors on steroids