smart_properties 1.2.1 → 1.2.2

data/lib/smart_properties.rb

@@ -22,7 +22,7 @@
 #
 module SmartProperties
 
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 
   class Property
 
@@ -115,69 +115,35 @@ module SmartProperties
 
   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)
+  class PropertyCollection
 
-    ##
-    # 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
+    include Enumerable
 
-    ##
-    # 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
+    attr_reader :parent
+
+    def initialize(parent = nil)
+      @parent = parent
+      @collection = {}
     end
 
-    ##
-    # Returns the name of this singleton object.
-    #
-    # @return String
-    #
-    def inspect
-      "AttributeBuilder"
+    def []=(name, value)
+      collection[name] = value
     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 [](name)
+      collection_with_parent_collection[name]
+    end
 
-        def to_hash
-          Hash[each_pair.to_a]
-        end
-      end
+    def each(&block)
+      collection_with_parent_collection.each(&block)
     end
 
-    private
+    protected
 
-      def property_names_for(klass)
-        klass.properties.keys
-      end
+      attr_accessor :collection
 
-      def store
-        @store ||= {}
+      def collection_with_parent_collection
+        parent.nil? ? collection : parent.collection.merge(collection)
       end
 
   end
@@ -196,7 +162,7 @@ module SmartProperties
           (ancestors[1..-1].find { |klass| klass.ancestors.include?(SmartProperties) && klass != SmartProperties })
         end
 
-        parent ? parent.properties.dup : {}
+        parent.nil? ? PropertyCollection.new : PropertyCollection.new(parent.properties)
       end
     end
 
@@ -281,11 +247,21 @@ module SmartProperties
   #
   def initialize(attrs = {}, &block)
     attrs ||= {}
-    attrs = attrs.merge(AttributeBuilder.build_attributes_for(self.class, &block)) if block
+    properties = self.class.properties.each.to_a
+
+    # Assign attributes or default values
+    properties.each do |_, property|
+      value = attrs.fetch(property.name, property.default(self))
+      send(:"#{property.name}=", value) if value
+    end
+
+    # Exectue configuration block
+    block.call(self) if block
 
-    self.class.properties.each do |_, property|
-      value = attrs.key?(property.name) ? attrs.delete(property.name) : property.default(self)
-      send(:"#{property.name}=", value)
+    # Check presence of all required properties
+    faulty_properties = properties.select { |_, property| property.required? && send(property.name).nil? }
+    unless faulty_properties.empty?
+      raise ArgumentError, "#{self.class.name} requires the following properties to be set: #{faulty_properties.map { |_, property| property.name }.sort.join(' ')}"
     end
   end
 

data/smart_properties.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SmartProperties::VERSION
 
-  gem.add_development_dependency "rspec", "~> 2.0"
+  gem.add_development_dependency "rspec", "~> 2.12"
   gem.add_development_dependency "rake", "~> 0.8"
   gem.add_development_dependency "guard-rspec", "~> 0.7"
 end

data/spec/smart_properties_spec.rb

@@ -62,8 +62,7 @@ describe SmartProperties do
       klass
     end
 
-    its(:properties) { should have(1).property }
-    its(:properties) { should have_key(:title) }
+    it { should have_smart_property(:title) }
 
     context "instances of this class" do
 
@@ -124,8 +123,7 @@ describe SmartProperties do
         Class.new(superklass)
       end
 
-      its(:properties) { should have(1).property }
-      its(:properties) { should have_key(:title) }
+      it { should have_smart_property(:title) }
 
       context "instances of this subclass" do
 
@@ -168,9 +166,8 @@ describe SmartProperties do
         end
       end
 
-      its(:properties) { should have(2).property }
-      its(:properties) { should have_key(:title) }
-      its(:properties) { should have_key(:text) }
+      it { should have_smart_property(:title) }
+      it { should have_smart_property(:text) }
 
       context "instances of this subclass" do
 
@@ -253,9 +250,8 @@ describe SmartProperties do
         end
       end
 
-      its(:properties) { should have(2).property }
-      its(:properties) { should have_key(:title) }
-      its(:properties) { should have_key(:type) }
+      it { should have_smart_property(:title) }
+      it { should have_smart_property(:type) }
 
       context "instances of this class" do
 
@@ -489,29 +485,16 @@ describe SmartProperties do
 
     before do
       klass.tap do |c|
-        c.send(:property, :subject)
+        c.send(:property, :priority)
       end
     end
 
-    context "the class's properties" do
+    context "the class" do
 
-      subject { klass.properties }
+      subject { klass }
 
-      it { should have_key(:title) }
-      it { should have_key(:subject) }
-
-    end
-
-    context "the subclass's properties" do
-
-      subject { subklass.properties }
-
-      it { should have_key(:title) }
-      it { should have_key(:body) }
-
-      pending '(dynamically defined property is not inherited)' do
-        it { should have_key(:subject) }
-      end
+      it { should have_smart_property(:title) }
+      it { should have_smart_property(:priority) }
 
     end
 
@@ -519,7 +502,11 @@ describe SmartProperties do
 
       subject { subklass }
 
-      it "should be initializable using a block", :pending => true do
+      it { should have_smart_property(:title) }
+      it { should have_smart_property(:body) }
+      it { should have_smart_property(:priority) }
+
+      it "should be initializable using a block" do
         configuration_instructions = lambda do |s|
           s.title = "Lorem Ipsum"
           s.priority = :low
@@ -543,4 +530,94 @@ describe SmartProperties do
 
   end
 
+  context "when building a class that has a property which is not required and has a default" do
+
+    subject(:klass) do
+      Class.new.tap do |c|
+        c.send(:include, described_class)
+        c.send(:property, :title, :default => 'Lorem Ipsum')
+      end
+    end
+
+    context 'instances of that class' do
+
+      context 'when created with a set of attributes that explicitly contains nil for the title' do
+
+        subject(:instance) { klass.new :title => nil }
+
+        it "should have no title" do
+          instance.title.should be_nil
+        end
+
+      end
+
+      context 'when created without any arguments' do
+
+        subject(:instance) { klass.new }
+
+        it "should have the default title" do
+          instance.title.should be == 'Lorem Ipsum'
+        end
+
+      end
+
+      context 'when created with an empty block' do
+
+        subject(:instance) { klass.new {} }
+
+        it "should have the default title" do
+          instance.title.should be == 'Lorem Ipsum'
+        end
+
+      end
+
+    end
+
+  end
+
+  context "when building a class that has a property which is required and has no default" do
+
+    subject(:klass) do
+      Class.new.tap do |c|
+        c.send(:include, described_class)
+        c.send(:property, :title, :required => true)
+
+        def c.name; "Dummy"; end
+      end
+    end
+
+    context 'instances of that class' do
+
+      context 'when created with a set of attributes that explicitly contains nil for the title' do
+
+        subject(:instance) { klass.new :title => 'Lorem Ipsum' }
+
+        it "should have no title" do
+          instance.title.should be == 'Lorem Ipsum'
+        end
+
+      end
+
+      context 'when created with an block specifying that property' do
+
+        subject(:instance) { klass.new { |i| i.title = 'Lorem Ipsum' } }
+
+        it "should have the default title" do
+          instance.title.should be == 'Lorem Ipsum'
+        end
+
+      end
+
+      context "when created with no arguments" do
+
+        it "should raise an error stating that required properties are missing" do
+          expect { subject.new }.to raise_error(ArgumentError, "Dummy requires the following properties to be set: title")
+        end
+
+      end
+
+    end
+
+  end
+
 end

data/spec/support/smart_property_matcher.rb

@@ -0,0 +1,46 @@
+module Matchers
+  class SmartPropertyMatcher
+
+    attr_reader :property_name
+    attr_reader :instance
+
+    def initialize(property_name)
+      @property_name = property_name
+    end
+
+    def matches?(instance)
+      @instance = instance
+      smart_property_enabled? && is_smart_property?
+    end
+
+    def failure_message
+      return "expected #{instance.class.name} to have a property named #{property_name}" if smart_property_enabled?
+      return "expected #{instance.class.name} to be smart property enabled"
+    end
+
+    def negative_failure_message
+      "expected #{instance.class.name} to not have a property named #{property_name}"
+    end
+
+    private
+
+      def smart_property_enabled?
+        instance.ancestors.include?(::SmartProperties)
+      end
+
+      def is_smart_property?
+        instance.properties[property_name].kind_of?(::SmartProperties::Property)
+      end
+
+  end
+
+  def has_smart_property(*args)
+    SmartPropertyMatcher.new(*args)
+  end
+
+  alias :have_smart_property :has_smart_property
+end
+
+RSpec.configure do |spec|
+  spec.include(Matchers)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_properties
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2012-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,7 @@ files:
 - smart_properties.gemspec
 - spec/smart_properties_spec.rb
 - spec/spec_helper.rb
+- spec/support/smart_property_matcher.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -94,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 183774927770524698
+      hash: 1846347248225497114
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 183774927770524698
+      hash: 1846347248225497114
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -113,4 +114,5 @@ summary: SmartProperties – Ruby accessors on steroids
 test_files:
 - spec/smart_properties_spec.rb
 - spec/spec_helper.rb
+- spec/support/smart_property_matcher.rb
 has_rdoc: