property 0.5.0 → 0.6.0

data/.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 coverage
+*.gem

data/History.txt

@@ -1,10 +1,15 @@
-== 0.4.0 2010-02-02
+== 0.6.0 2010-02-11
 
 * 1 major enhancement
-  * initial plugin code
+  * enabled ruby accessors in model
 
 == 0.5.0 2010-02-11
 
 * 2 major enhancement
   * changed plugin into gem
-  * using Rails columns to handle defaults and type casting
+  * using Rails columns to handle defaults and type casting
+
+== 0.4.0 2010-02-02
+
+* 1 major enhancement
+  * initial plugin code

data/Rakefile

@@ -43,7 +43,7 @@ begin
 
     # Gem dependecies
     gemspec.add_development_dependency('shoulda')
-    gemspec.add_dependency('active_record')
+    gemspec.add_dependency('activerecord')
   end
 rescue LoadError
   puts "Jeweler not available. Gem packaging tasks not available."

data/lib/property.rb

@@ -6,7 +6,7 @@ require 'property/declaration'
 require 'property/serialization/json'
 
 module Property
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 
   def self.included(base)
     base.class_eval do

data/lib/property/attribute.rb

@@ -50,11 +50,11 @@ module Property
 
       private
         def attributes_with_properties=(attributes, guard_protected_attributes = true)
-          columns = self.class.column_names
+          property_columns = self.class.property_columns
           properties = {}
 
           attributes.keys.each do |k|
-            if !respond_to?("#{k}=") && !columns.include?(k)
+            if property_columns.include?(k)
               properties[k] = attributes.delete(k)
             end
           end
@@ -74,7 +74,6 @@ module Property
 
         def dump_properties
           if @properties
-            @properties.compact!
             if !@properties.empty?
               write_attribute('properties', encode_properties(@properties))
             else

data/lib/property/column.rb

@@ -6,6 +6,7 @@ module Property
   # such as name, type and options. It is also used to typecast from strings to
   # the proper type (date, integer, float, etc).
   class Column < ::ActiveRecord::ConnectionAdapters::Column
+    SAFE_NAMES_REGEXP = %r{\A[a-zA-Z_]+\Z}
 
     def initialize(name, default, type, options={})
       name = name.to_s
@@ -14,14 +15,11 @@ module Property
     end
 
     def validate(value, errors)
-      if !value.kind_of?(klass)
-        if value.nil?
-          default
-        else
-          errors.add("#{name}", "invalid data type. Received #{value.class}, expected #{klass}.")
-          nil
-        end
-      end
+      # Do nothing for the moment
+    end
+
+    def should_create_accessors?
+      name =~ SAFE_NAMES_REGEXP
     end
 
     def indexed?

data/lib/property/declaration.rb

@@ -28,7 +28,9 @@ module Property
           if columns[name.to_s]
             raise TypeError.new("Property '#{name}' is already defined.")
           else
-            own_columns[name] = Property::Column.new(name, default, type, options)
+            new_column = Property::Column.new(name, default, type, options)
+            own_columns[new_column.name] = new_column
+            @klass.define_property_methods(new_column) if new_column.should_create_accessors?
           end
         end
 
@@ -107,6 +109,87 @@ module Property
           {}
         end
       end
+
+      def define_property_methods(column)
+        name = column.name
+        unless instance_method_already_implemented?(name)
+          if create_time_zone_conversion_attribute?(name, column)
+            define_read_property_method_for_time_zone_conversion(name)
+          else
+            define_read_property_method(name.to_sym, name, column)
+          end
+        end
+
+        unless instance_method_already_implemented?("#{name}=")
+          if create_time_zone_conversion_attribute?(name, column)
+            define_write_property_method_for_time_zone_conversion(name)
+          else
+            define_write_property_method(name.to_sym)
+          end
+        end
+
+        unless instance_method_already_implemented?("#{name}?")
+          define_question_property_method(name)
+        end
+      end
+
+      private
+        # Define a property reader method.  Cope with nil column.
+        def define_read_property_method(symbol, attr_name, column)
+          # Unlike rails, we do not cast on read
+          evaluate_attribute_property_method attr_name, "def #{symbol}; prop['#{attr_name}']; end"
+        end
+
+        # Defined for all +datetime+ and +timestamp+ attributes when +time_zone_aware_attributes+ are enabled.
+        # This enhanced read method automatically converts the UTC time stored in the database to the time zone stored in Time.zone.
+        def define_read_property_method_for_time_zone_conversion(attr_name)
+          method_body = <<-EOV
+            def #{attr_name}(reload = false)
+              cached = @attributes_cache['#{attr_name}']
+              return cached if cached && !reload
+              time = properties['#{attr_name}']
+              @attributes_cache['#{attr_name}'] = time.acts_like?(:time) ? time.in_time_zone : time
+            end
+          EOV
+          evaluate_attribute_property_method attr_name, method_body
+        end
+
+        # Defines a predicate method <tt>attr_name?</tt>.
+        def define_question_property_method(attr_name)
+          evaluate_attribute_property_method attr_name, "def #{attr_name}?; prop['#{attr_name}']; end", "#{attr_name}?"
+        end
+
+        def define_write_property_method(attr_name)
+          evaluate_attribute_property_method attr_name, "def #{attr_name}=(new_value);prop['#{attr_name}'] = new_value; end", "#{attr_name}="
+        end
+
+        # Defined for all +datetime+ and +timestamp+ attributes when +time_zone_aware_attributes+ are enabled.
+        # This enhanced write method will automatically convert the time passed to it to the zone stored in Time.zone.
+        def define_write_property_method_for_time_zone_conversion(attr_name)
+          method_body = <<-EOV
+            def #{attr_name}=(time)
+              unless time.acts_like?(:time)
+                time = time.is_a?(String) ? Time.zone.parse(time) : time.to_time rescue time
+              end
+              time = time.in_time_zone rescue nil if time
+              prop['#{attr_name}'] = time
+            end
+          EOV
+          evaluate_attribute_property_method attr_name, method_body, "#{attr_name}="
+        end
+
+        # Evaluate the definition for an attribute related method
+        def evaluate_attribute_property_method(attr_name, method_definition, method_name=attr_name)
+          begin
+            class_eval(method_definition, __FILE__, __LINE__)
+          rescue SyntaxError => err
+            if logger
+              logger.warn "Exception occurred during method compilation."
+              logger.warn "Maybe #{attr_name} is not a valid Ruby identifier?"
+              logger.warn err.message
+            end
+          end
+        end
     end # ClassMethods
 
     module InstanceMethods

data/lib/property/dirty.rb

@@ -47,11 +47,6 @@ module Property
       super
     end
 
-    def merge!(other_hash)
-      @original_hash ||= self.dup
-      super
-    end
-
     def changed?
       !changes.empty?
     end
@@ -62,7 +57,6 @@ module Property
 
     def changes
       return {} unless @original_hash
-      compact!
       changes = {}
 
       # look for updated value

data/lib/property/properties.rb

@@ -8,10 +8,7 @@ module Property
     end
 
     def to_json(*args)
-      {
-        'json_class' => self.class.name,
-        'data' => Hash[self]
-      }.to_json(*args)
+      { 'json_class' => self.class.name, 'data' => Hash[self] }.to_json(*args)
     end
 
     def []=(key, value)
@@ -44,8 +41,9 @@ module Property
       errors = @owner.errors
       no_errors = true
 
-      bad_keys     = keys - column_names
-      missing_keys = column_names - keys
+      bad_keys         = keys - column_names
+      missing_keys     = column_names - keys
+      keys_to_validate = keys - bad_keys
 
       bad_keys.each do |key|
         errors.add("#{key}", 'property is not declared')
@@ -58,21 +56,14 @@ module Property
         end
       end
 
-      bad_keys.empty?
-    end
+      keys_to_validate.each do |key|
+        columns[key].validate(self[key], errors)
+      end
 
-    def compact!
-      #keys.each do |key|
-      #  if self[key].nil?
-      #    delete(key)
-      #  end
-      #end
+      bad_keys.empty?
     end
 
     private
-      def write_attribute(key, value)
-      end
-
       def columns
         @columns ||= @owner.class.property_columns
       end

data/property.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{property}
+  s.version = "0.6.0"
+
+  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-02-11}
+  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 = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "generators/property/property_generator.rb",
+     "lib/property.rb",
+     "lib/property/attribute.rb",
+     "lib/property/column.rb",
+     "lib/property/declaration.rb",
+     "lib/property/dirty.rb",
+     "lib/property/properties.rb",
+     "lib/property/serialization/json.rb",
+     "lib/property/serialization/marshal.rb",
+     "lib/property/serialization/yaml.rb",
+     "property.gemspec",
+     "test/fixtures.rb",
+     "test/shoulda_macros/serialization.rb",
+     "test/test_helper.rb",
+     "test/unit/property/attribute_test.rb",
+     "test/unit/property/declaration_test.rb",
+     "test/unit/property/dirty_test.rb",
+     "test/unit/property/validation_test.rb",
+     "test/unit/serialization/json_test.rb",
+     "test/unit/serialization/marshal_test.rb",
+     "test/unit/serialization/yaml_test.rb"
+  ]
+  s.homepage = %q{http://zenadmin.org/635}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{property}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{model properties wrap into a single database column}
+  s.test_files = [
+    "test/fixtures.rb",
+     "test/shoulda_macros/serialization.rb",
+     "test/test_helper.rb",
+     "test/unit/property/attribute_test.rb",
+     "test/unit/property/declaration_test.rb",
+     "test/unit/property/dirty_test.rb",
+     "test/unit/property/validation_test.rb",
+     "test/unit/serialization/json_test.rb",
+     "test/unit/serialization/marshal_test.rb",
+     "test/unit/serialization/yaml_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/test/unit/property/attribute_test.rb

@@ -59,9 +59,18 @@ class AttributeTest < Test::Unit::TestCase
       end
     end
 
-    should 'with merge! should merge new attributes' do
-      subject.properties.merge!({'b'=>'bravo', 'c'=>'charlie'})
-      assert_equal Hash['foo' => 'bar', 'b' => 'bravo', 'c' => 'charlie'], subject.properties
+    context 'with merge!' do
+      should 'merge new attributes' do
+        subject.properties.merge!({'b'=>'bravo', 'c'=>'charlie'})
+        assert_equal Hash['foo' => 'bar', 'b' => 'bravo', 'c' => 'charlie'], subject.properties
+      end
+    end
+
+    context 'with native ruby methods' do
+      should 'update current value' do
+        subject.foo = 'floppy disk'
+        assert_equal Hash['foo' => 'floppy disk'], subject.properties
+      end
     end
   end
 
@@ -95,6 +104,18 @@ class AttributeTest < Test::Unit::TestCase
       assert_equal Hash['foo'=>'bar', :tic=>:tac], subject.properties
     end
 
+    should 'be accessible with native methods' do
+      assert_equal 'bar', subject.foo
+    end
+
+    should 'respond true on predicate method' do
+      assert subject.foo?
+    end
+
+    should 'not respond true on predicate method if empty' do
+      assert !subject.comment?
+    end
+
     should 'be a kind of Hash' do
       assert_kind_of Hash, subject.properties
     end

data/test/unit/property/declaration_test.rb

@@ -64,6 +64,23 @@ class DeclarationTest < Test::Unit::TestCase
       assert_kind_of Property::Column, subject.property_columns['weapon']
     end
 
+    should 'create ruby accessors' do
+      subject.property.string('weapon')
+      assert subject.instance_methods.include?('weapon')
+      assert subject.instance_methods.include?('weapon=')
+      assert subject.instance_methods.include?('weapon?')
+    end
+
+    should 'not create accessors for illegal ruby names' do
+      bad_names = ['some.thing', 'puts("yo")', '/var/', 'hello darness']
+      assert_nothing_raised { subject.property.string bad_names }
+      bad_names.each do |bad_name|
+        assert !subject.instance_methods.include?(bad_name)
+        assert !subject.instance_methods.include?("#{bad_name}=")
+        assert !subject.instance_methods.include?("#{bad_name}?")
+      end
+    end
+
     should 'allow string columns' do
       subject.property.string('weapon')
       column = subject.property_columns['weapon']
@@ -72,6 +89,14 @@ class DeclarationTest < Test::Unit::TestCase
       assert_equal :string, column.type
     end
 
+    should 'treat symbol keys as strings' do
+      subject.property.string(:weapon)
+      column = subject.property_columns['weapon']
+      assert_equal 'weapon', column.name
+      assert_equal String, column.klass
+      assert_equal :string, column.type
+    end
+
     should 'allow integer columns' do
       subject.property.integer('indestructible')
       column = subject.property_columns['indestructible']

data/test/unit/property/dirty_test.rb

@@ -36,7 +36,8 @@ class DirtyTest < Test::Unit::TestCase
 
     context 'with changed properties' do
       setup do
-        subject.properties = {'foo'=>'barre', 'tic'=>'taaac'}
+        subject.properties = {'foo'=>'barre'}
+        subject.properties.delete('tic')
       end
 
       should_behave_nice_after_save('barre')
@@ -58,11 +59,11 @@ class DirtyTest < Test::Unit::TestCase
       end
 
       should 'return property changes with changes' do
-        assert_equal Hash['tic'=>['tac', 'taaac'], 'foo'=>['bar', 'barre']], subject.changes
+        assert_equal Hash['tic'=>['tac', nil], 'foo'=>['bar', 'barre']], subject.changes
       end
 
       should 'return property changes with properties.changes' do
-        assert_equal Hash['tic'=>['tac', 'taaac'], 'foo'=>['bar', 'barre']], subject.properties.changes
+        assert_equal Hash['tic'=>['tac', nil], 'foo'=>['bar', 'barre']], subject.properties.changes
       end
 
       should 'return true on properties.key_changed?' do
@@ -152,6 +153,10 @@ class DirtyTest < Test::Unit::TestCase
       should 'return previous value on properties.key_was' do
         assert_equal 'bar', subject.properties.foo_was
       end
+
+      should 'raise NoMethodError on other missing methods' do
+        assert_raise(NoMethodError) { subject.properties.sleep }
+      end
     end
   end
 end

data/test/unit/property/validation_test.rb

@@ -14,15 +14,15 @@ class ValidationTest < Test::Unit::TestCase
     subject { Pirate.create }
 
     context 'without a property column' do
-      setup do
-        assert !subject.update_attributes('honest' => 'man')
-      end
-
-      should 'render object invalid' do
-        assert subject.invalid?
+      should 'raise ActiveRecord::UnknownAttributeError when using attributes=' do
+        assert_raise(ActiveRecord::UnknownAttributeError) do
+          subject.update_attributes('honest' => 'man')
+        end
       end
 
-      should 'set an error message on the property' do
+      should 'set an error message on the property when set directly' do
+        subject.prop['honest'] = 'man'
+        assert !subject.save
         assert_contains subject.errors.full_messages, 'Honest property is not declared'
         assert_equal subject.errors['honest'], 'property is not declared'
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: property
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Renaud Kern
@@ -24,7 +24,7 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: active_record
+  name: activerecord
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -57,6 +57,7 @@ files:
 - lib/property/serialization/json.rb
 - lib/property/serialization/marshal.rb
 - lib/property/serialization/yaml.rb
+- property.gemspec
 - test/fixtures.rb
 - test/shoulda_macros/serialization.rb
 - test/test_helper.rb