property 2.1.0 → 2.1.1

data/History.txt

@@ -1,8 +1,20 @@
+== 2.1.1 2010-11-23
+
+* Major enhancements
+  * Not raising an error on invalid attributes.
+  * Avoid bad attributes being used to 'send' messages during error message building.
+  * Not setting an error for blank values.
+
+* Minor enhancements
+  * Made defined_columns public.
+  * Fixed a bug where all columns would be parsed for each role.
+  * Fixed a bug where group_indices would be overwritten during initialization.
+
 == 2.1.0 2010-11-15
 
 * Major enhancements
   * Added support for custom Schema classes through SchemaModule and StoredSchema.
-  
+
 == 2.0.0 2010-11-10
 
 * Major enhancements

data/lib/property/attribute.rb

@@ -94,16 +94,17 @@ module Property
         def attributes_with_properties=(attributes, guard_protected_attributes = true)
           property_columns = schema.column_names
 
-          properties = {}
+          model_attrs  = {}
 
           attributes.keys.each do |k|
-            if property_columns.include?(k)
-              properties[k] = attributes.delete(k)
+            if respond_to?("#{k}=")
+              model_attrs[k] = attributes.delete(k)
             end
           end
-
-          self.properties = properties
-          self.attributes_without_properties = attributes
+          
+          # Properties validation will add errors on invalid keys.
+          self.properties = attributes
+          self.attributes_without_properties = model_attrs
         end
     end # InstanceMethods
   end # Attribute

data/lib/property/properties.rb

@@ -1,4 +1,18 @@
 module Property
+  class AttributeError < ActiveRecord::Error
+    def default_options
+      options.reverse_merge :scope => [:activerecord, :errors],
+                            :model => @base.class.human_name,
+                            :attribute => @base.class.human_attribute_name(attribute.to_s)
+    end
+
+    # SECURITY: MAKE SURE WE DO NOT SEND.
+    # Value is already in 'options'.
+    def value
+      nil
+    end
+  end
+
   class Properties < Hash
     attr_accessor :owner
     include Property::DirtyProperties
@@ -49,8 +63,12 @@ module Property
       bad_keys.each do |key|
         if original_hash[key] == self[key]
           # ignore invalid legacy value
+        elsif self[key].blank?
+          # ignore blank values
+          self.delete(key)
         else
-          errors.add("#{key}", 'property not declared')
+          # We use our own Error class to make sure 'send' is not used on error keys.
+          errors.add(key, Property::AttributeError.new(@owner, key, nil, :message => 'property not declared', :value => self[key]))
         end
       end
 

data/lib/property/role.rb

@@ -30,7 +30,6 @@ module Property
     # Initialize a new role with the given name
     def initialize(name, opts = nil)
       @name = name
-      initialize_role_module
     end
   end
 end

data/lib/property/role_module.rb

@@ -74,7 +74,7 @@ module Property
     # will be yielded with the record and should return a hash of key => value pairs.
     def index(type, &block)
       #                 type,  key, proc
-      @group_indices << [type, nil, block]
+      group_indices << [type, nil, block]
     end
 
     # Returns true if the role is used by the given object. A role is
@@ -90,13 +90,13 @@ module Property
       object.properties.keys & column_names
     end
 
-    # Return a list of index definitions in the form [type, key, proc_or_nil]
-    def indices
-      columns.values.select do |c|
+    # Return a list of index definitions from the defined columns in the form [type, key, proc_or_nil]
+    def defined_indices
+      defined_columns.values.select do |c|
         c.indexed?
       end.map do |c|
         [c.index, c.name, c.index_proc]
-      end + @group_indices
+      end + group_indices
     end
 
     def inspect
@@ -104,14 +104,14 @@ module Property
       "#<#{self.class}:#{sprintf("0x%x", object_id)} #{defined_columns.keys.inspect}>"
     end
 
-    protected
-      def initialize_role_module
-        @group_indices = []
-      end
+    # List all property columns defined for this role
+    def defined_columns
+      @defined_columns ||= {}
+    end
 
-      # List all property columns defined for this role
-      def defined_columns
-        @defined_columns ||= {}
+    protected
+      def group_indices
+        @group_indices ||= []
       end
 
       # @internal

data/lib/property/schema_module.rb

@@ -45,7 +45,7 @@ module Property
     def index_groups
       index_groups = {}
       @roles.flatten.uniq.each do |b|
-        b.indices.each do |list|
+        b.defined_indices.each do |list|
           (index_groups[list.first] ||= []) << list[1..-1]
         end
       end

data/lib/property/stored_role.rb

@@ -22,9 +22,6 @@ module Property
       base.class_eval do
         after_save :update_columns
         validates_presence_of :name
-        def after_initialize
-          initialize_role_module
-        end
         
         extend ClassMethods
 
@@ -45,12 +42,6 @@ module Property
 
           obj
         end
-
-        # Initialize a new role with the given name
-        def initialize(*args)
-          super
-          initialize_role_module
-        end
       end
     end # included
 
@@ -72,7 +63,6 @@ module Property
 
     private
       def load_columns_from_db
-        initialize_role_module
         @columns_from_db_loaded = true
         @original_columns = {}
         stored_columns.each do |column|

data/lib/property/version.rb

@@ -1,3 +1,3 @@
 module Property
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/property.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{property}
-  s.version = "2.1.0"
+  s.version = "2.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Renaud Kern", "Gaspard Bucher"]
-  s.date = %q{2010-11-15}
+  s.date = %q{2010-11-23}
   s.description = %q{Wrap model properties into a single database column and declare properties from within the model.}
   s.email = %q{gaspard@teti.ch}
   s.extra_rdoc_files = [

data/test/shoulda_macros/index.rb

@@ -53,7 +53,19 @@ class Test::Unit::TestCase
           end
         end
       end
-    end # An instance of Person
+      
+      should 'build a group of indices' do
+        assert_equal Hash['ml_string'=>[['poem', nil]], 'integer'=>[['year', nil]]], subject.schema.index_groups
+      end
+      
+      should 'build indices array' do
+        assert_equal [['integer', 'year', nil], ['ml_string', 'poem', nil]], @poet.defined_indices
+      end
+      
+      should 'only use defined propertys to build indices array' do
+        assert_equal [], subject.schema.defined_indices
+      end
+    end # assigned to an instance of Dummy
   end
 
   def self.should_not_maintain_indices

data/test/shoulda_macros/role.rb

@@ -54,10 +54,10 @@ class Test::Unit::TestCase
       assert column.indexed?
     end
 
-    should 'return a list of indices on indices' do
+    should 'return a list of indices on defined_indices' do
       subject.property.string('rolodex', :index => true)
       subject.property.integer('foobar', :index => true)
-      assert_equal %w{integer string}, subject.indices.map {|i| i[0].to_s }.sort
+      assert_equal %w{integer string}, subject.defined_indices.map {|i| i[0].to_s }.sort
     end
 
     context 'created with a Hash' do

data/test/unit/property/attribute_test.rb

@@ -259,7 +259,7 @@ class AttributeTest < Test::Unit::TestCase
     should 'call native methods' do
       assert_equal 'please', subject.backup
     end
-  end
+  end # Setting attributes
 
   context 'Initializing an object' do
     subject { Version.new('foo'=>'bar', 'title'=>'test', 'backup' => 'please') }
@@ -281,7 +281,7 @@ class AttributeTest < Test::Unit::TestCase
     setup do
       version = Version.create('title' => 'first', 'tic' => 'tac')
       @version = Version.find(version.id)
-      assert subject.update_attributes('foo'=>'bar', 'title'=>'test', 'backup' => 'please')
+      assert subject.update_attributes(:foo=>'bar', 'title'=>'test', 'backup' => 'please')
     end
 
     subject { @version }

data/test/unit/property/index_simple_test.rb

@@ -35,6 +35,10 @@ class IndexSimpleTest < ActiveSupport::TestCase
     should 'group indices by type' do
       assert_equal %w{integer special}, subject.index_groups.keys.map(&:to_s).sort
     end
+    
+    should 'not contain duplicates' do
+      assert_equal Hash["special"=>[["name", nil]], "integer"=>[["age", nil]]], subject.index_groups
+    end
   end
 
   context 'A class with a simple index definition' do

data/test/unit/property/role_test.rb

@@ -27,6 +27,7 @@ class RoleTest < ActiveSupport::TestCase
       @poet = Property::Role.new('Poet') do |p|
         p.string  'poem', :index => :ml_string
         p.integer 'year', :index => true
+        p.integer 'age'
       end
     end
 

data/test/unit/property/validation_test.rb

@@ -10,23 +10,53 @@ class ValidationTest < Test::Unit::TestCase
       property.float 'boat'
       property.string 'bird_name'
       property.serialize 'cat', Cat
+      
+      def infamous
+        raise Exception.new("Should not send!")
+      end
     end
 
     subject { Pirate.create }
 
     context 'without a property column' do
-      should 'raise ActiveRecord::UnknownAttributeError when using attributes=' do
-        assert_raise(ActiveRecord::UnknownAttributeError) do
+      context 'set with attributes=' do
+        should 'not raise an error' do
           subject.update_attributes('infamous' => 'dictator')
         end
-      end
 
-      should 'set an error message on the property when set directly' do
+        should 'set an error message' do
+          subject.update_attributes('infamous' => 'dictator')
+          assert_equal subject.errors['infamous'], 'property not declared'
+        end
+      end # set with attributes=
+
+      should 'set an error message' do
         subject.prop['infamous'] = 'dictator'
         assert !subject.save
         assert_equal subject.errors['infamous'], 'property not declared'
       end
-
+      
+      should 'not send to get value in error message' do
+        subject.prop['infamous'] = 'dictator'
+        assert !subject.save
+        assert_nothing_raised do
+          subject.errors.each_error do |key, error|
+            assert_equal 'Infamous property not declared', error.full_message
+          end
+        end
+      end
+      
+      context 'with blank value' do
+        
+        should 'not set an error message' do
+          subject.prop['infamous'] = ''
+          subject.prop['greedy']   = nil
+          assert subject.save
+          assert_nil subject.errors['infamous']
+          assert_nil subject.errors['greedy']
+        end
+      end # with blank value
+      
       context 'with dirty' do
         should 'validate if property was not changed' do
           subject.prop.instance_eval do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: property
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 2
   - 1
-  - 0
-  version: 2.1.0
+  - 1
+  version: 2.1.1
 platform: ruby
 authors: 
 - Renaud Kern
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-15 00:00:00 +01:00
+date: 2010-11-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency