property 0.8.0 → 0.8.1

data/History.txt

@@ -1,3 +1,9 @@
+== 0.8.1 2010-02-14
+
+* 2 major enhancement
+  * enabled behavior method definitions
+  * enabled external storage with 'store_properties_in' method
+
 == 0.8.0 2010-02-11
 
 * 3 major enhancements

data/README.rdoc

@@ -1,8 +1,9 @@
-== DESCRIPTION:
+== Property
 
 Wrap model properties into a single database column and declare properties from within the model.
 
 website: http://zenadmin.org/635
+
 license: MIT
 
 == Status: Beta
@@ -51,20 +52,53 @@ And set them with:
 Properties would not be really fun if you could not add new properties to your instances depending
 on some flags. First define the behaviors:
 
-  @a_picture = Property::Behavior.new do |p|
+  @picture = Property::Behavior.new do |p|
     p.integer :width,  :default => :get_width
     p.integer :height, :default => :get_height
     p.string  'camera'
     p.string  'location'
+
+    p.actions do
+      # Define new methods to insert into model
+
+      def get_width
+        image.width
+      end
+
+      def get_height
+        image.height
+      end
+
+      def image
+        raise 'Missing file' unless @file
+        @image ||= ImageBuilder(@file)
+      end
+    end
   end
 
 And then, either when creating new pictures or updating them, you need to include the behavior:
 
-  @model.behave_like @a_picture
+  @model.behave_like @picture
 
-The model now has the picture's properties defined, with accessors like @model.camera and default
-values will be fetched on save.
+The model now has the picture's properties defined, with accessors like @model.camera, methods like
+@model.image, get_with, etc and default values will be fetched on save.
 
 Note that you do not need to include a behavior just to read the data as long as you use the 'prop'
 accessor.
 
+== External storage
+
+You might need to define properties in a model but store them in another model (versioning). In this
+case you can simply use 'store_properties_in' class method:
+
+  class Contact < ActiveRecord::Base
+    include Property
+    store_properties_in :version
+    property do |p|
+      p.string 'name', 'first_name'
+      p.string 'childhood', :default => 'happy'
+    end
+  end
+
+Doing so will not touch the storage class. All property definitions, validations and method
+definitions are executed on the 'Contact' class.

data/lib/property.rb

@@ -9,7 +9,7 @@ require 'property/serialization/json'
 require 'property/core_ext/time'
 
 module Property
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 
   def self.included(base)
     base.class_eval do

data/lib/property/attribute.rb

@@ -13,18 +13,56 @@ module Property
   module Attribute
 
     def self.included(base)
+      base.extend ClassMethods
+
       base.class_eval do
         include InstanceMethods
         include Serialization::JSON
         include Declaration
         include Dirty
 
+        store_properties_in self
+
         before_save :dump_properties
 
         alias_method_chain :attributes=,  :properties
       end
     end
 
+    module ClassMethods
+      def store_properties_in(accessor)
+        if accessor.nil? || accessor == self
+          accessor = ''
+        else
+          accessor = "#{accessor}."
+        end
+        load_and_dump_methods =<<-EOF
+          private
+            def load_properties
+              raw_data = #{accessor}read_attribute('properties')
+              prop = raw_data ? decode_properties(raw_data) : Properties.new
+              # We need to set the owner to access property definitions and enable
+              # type casting on write.
+              prop.owner = self
+              prop
+            end
+
+            def dump_properties
+              if @properties
+                if !@properties.empty?
+                  #{accessor}write_attribute('properties', encode_properties(@properties))
+                else
+                  #{accessor}write_attribute('properties', nil)
+                end
+              end
+              @properties.clear_changes!
+              true
+            end
+        EOF
+        class_eval(load_and_dump_methods, __FILE__, __LINE__)
+      end
+    end
+
     module InstanceMethods
       def properties
         @properties ||= load_properties
@@ -62,27 +100,6 @@ module Property
           self.properties = properties
           self.attributes_without_properties = attributes
         end
-
-        def load_properties
-          raw_data = read_attribute('properties')
-          prop = raw_data ? decode_properties(raw_data) : Properties.new
-          # We need to set the owner to access property definitions and enable
-          # type casting on write.
-          prop.owner = self
-          prop
-        end
-
-        def dump_properties
-          if @properties
-            if !@properties.empty?
-              write_attribute('properties', encode_properties(@properties))
-            else
-              write_attribute('properties', nil)
-            end
-          end
-          @properties.clear_changes!
-          true
-        end
     end # InstanceMethods
   end # Attribute
 end # Property

data/lib/property/behavior.rb

@@ -5,10 +5,10 @@ module Property
   class Behavior
     attr_accessor :name, :included, :accessor_module
 
-    def self.new(name)
+    def self.new(name, &block)
       obj = super
       if block_given?
-        yield obj
+        obj.property(&block)
       end
       obj
     end
@@ -17,7 +17,7 @@ module Property
     def initialize(name)
       @name    = name
       @included_in_schemas = []
-      @accessor_module = Module.new
+      @accessor_module = build_accessor_module
     end
 
     # List all property definitiosn for the current behavior
@@ -40,33 +40,9 @@ module Property
     #  end
     def property
       if block_given?
-        yield self
+        yield accessor_module
       end
-      self
-    end
-
-    # def string(*args)
-    #   options = args.extract_options!
-    #   column_names = args
-    #   default = options.delete(:default)
-    #   column_names.each { |name| column(name, default, 'string', options) }
-    # end
-    %w( string text integer float decimal datetime timestamp time date binary boolean ).each do |column_type|
-      class_eval <<-EOV
-        def #{column_type}(*args)
-          options = args.extract_options!
-          column_names = args
-          default = options.delete(:default)
-          column_names.each { |name| add_column(Property::Column.new(name, default, '#{column_type}', options)) }
-        end
-      EOV
-    end
-
-    # This is used to serialize a non-native DB type. Use:
-    #   p.serialize 'pet', Dog
-    def serialize(name, klass, options = {})
-      Property.validate_property_class(klass)
-      add_column(Property::Column.new(name, nil, klass, options))
+      accessor_module
     end
 
     # @internal
@@ -75,7 +51,56 @@ module Property
       @included_in_schemas << schema
     end
 
+    # @internal
+    def add_column(column)
+      name = column.name
+
+      if columns[name]
+        raise TypeError.new("Property '#{name}' is already defined.")
+      else
+        verify_not_defined_in_schemas_using_this_behavior(name)
+        define_property_methods(column) if column.should_create_accessors?
+        columns[column.name] = column
+      end
+    end
+
     private
+      def build_accessor_module
+        accessor_module = Module.new
+        accessor_module.class_eval do
+          class << self
+            attr_accessor :behavior
+
+            # def string(*args)
+            #   options = args.extract_options!
+            #   column_names = args
+            #   default = options.delete(:default)
+            #   column_names.each { |name| column(name, default, 'string', options) }
+            # end
+            %w( string text integer float decimal datetime timestamp time date binary boolean ).each do |column_type|
+              class_eval <<-EOV
+                def #{column_type}(*args)
+                  options = args.extract_options!
+                  column_names = args
+                  default = options.delete(:default)
+                  column_names.each { |name| behavior.add_column(Property::Column.new(name, default, '#{column_type}', options)) }
+                end
+              EOV
+            end
+
+            # This is used to serialize a non-native DB type. Use:
+            #   p.serialize 'pet', Dog
+            def serialize(name, klass, options = {})
+              Property.validate_property_class(klass)
+              behavior.add_column(Property::Column.new(name, nil, klass, options))
+            end
+
+            alias actions class_eval
+          end
+        end
+        accessor_module.behavior = self
+        accessor_module
+      end
 
       def define_property_methods(column)
         name = column.name
@@ -144,18 +169,6 @@ module Property
         accessor_module.class_eval(method_definition, __FILE__, __LINE__)
       end
 
-      def add_column(column)
-        name = column.name
-
-        if columns[name]
-          raise TypeError.new("Property '#{name}' is already defined.")
-        else
-          verify_not_defined_in_schemas_using_this_behavior(name)
-          define_property_methods(column) if column.should_create_accessors?
-          columns[column.name] = column
-        end
-      end
-
       def verify_not_defined_in_schemas_using_this_behavior(name)
         @included_in_schemas.each do |schema|
           if schema.columns[name]

data/lib/property/column.rb

@@ -32,6 +32,7 @@ module Property
     end
 
     def default_for(owner)
+      default = self.default
       if default.kind_of?(Proc)
         default.call
       elsif default.kind_of?(Symbol)

data/lib/property/declaration.rb

@@ -46,14 +46,8 @@ module Property
       #  property do |p|
       #    p.string 'phone', 'name', :default => ''
       #  end
-      def property
-        setter = schema.behavior
-
-        if block_given?
-          yield setter
-        end
-
-        setter
+      def property(&block)
+        schema.behavior.property(&block)
       end
     end # ClassMethods
 

data/property.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{property}
-  s.version = "0.8.0"
+  s.version = "0.8.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-02-12}
+  s.date = %q{2010-02-14}
   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/fixtures.rb

@@ -56,6 +56,7 @@ begin
       end
 
       create_table "versions" do |t|
+        t.integer 'employee_id'
         t.string  "properties"
         t.string  "title"
         t.string  "comment"

data/test/unit/property/behavior_test.rb

@@ -62,7 +62,13 @@ class BehaviorTest < Test::Unit::TestCase
   context 'Adding a behavior' do
     setup do
       @poet = Property::Behavior.new('Poet') do |p|
-        p.string 'poem'
+        p.string 'poem', :default => :muse
+
+        p.actions do
+          def muse
+            'I am your muse'
+          end
+        end
       end
     end
 
@@ -99,6 +105,21 @@ class BehaviorTest < Test::Unit::TestCase
 
         assert_nothing_raised { subject.poem = 'Poe'}
       end
+
+      should 'add behavior methods to child' do
+        subject = @klass.new
+        assert_raises(NoMethodError) { subject.muse }
+        @parent.behave_like @poet
+
+        assert_nothing_raised { subject.muse }
+      end
+
+      should 'use behavior methos for defaults' do
+        subject = @klass.new
+        @parent.behave_like @poet
+        assert subject.save
+        assert_equal 'I am your muse', subject.poem
+      end
     end
 
     context 'to a parent class' do

data/test/unit/property/declaration_test.rb

@@ -92,6 +92,14 @@ class DeclarationTest < Test::Unit::TestCase
       assert_equal :string, column.type
     end
 
+    should 'allow text columns' do
+      subject.property.text('history')
+      column = subject.schema.columns['history']
+      assert_equal 'history', column.name
+      assert_equal String, column.klass
+      assert_equal :text, column.type
+    end
+
     should 'treat symbol keys as strings' do
       subject.property.string(:weapon)
       column = subject.schema.columns['weapon']
@@ -123,7 +131,7 @@ class DeclarationTest < Test::Unit::TestCase
       assert_equal Time, column.klass
       assert_equal :datetime, column.type
     end
-    
+
     should 'allow serialized columns' do
       Dog = Struct.new(:name, :toy) do
         def self.json_create(data)
@@ -135,7 +143,7 @@ class DeclarationTest < Test::Unit::TestCase
           }.to_json(*args)
         end
       end
-      
+
       subject.property.serialize('pet', Dog)
       column = subject.schema.columns['pet']
       assert_equal 'pet', column.name
@@ -210,4 +218,77 @@ class DeclarationTest < Test::Unit::TestCase
       assert_raise(TypeError) { subject.behave_like 'me' }
     end
   end
-end
+
+  context 'A class with external storage' do
+    class Version < ActiveRecord::Base
+      belongs_to :contact, :class_name => 'DeclarationTest::Contact',
+                 :foreign_key => 'employee_id'
+    end
+
+    Contact = Class.new(ActiveRecord::Base) do
+      set_table_name :employees
+      has_many :versions, :class_name => 'DeclarationTest::Version'
+
+      include Property
+      store_properties_in :version
+
+      property do |p|
+        p.string 'first_name'
+        p.string 'famous', :default => :get_is_famous
+        p.integer 'age'
+
+        p.actions do
+          def get_is_famous
+            'no'
+          end
+        end
+      end
+
+      def version
+        @version ||= begin
+          if new_record?
+            versions.build
+          else
+            Version.first(:conditions => ['employee_id = ?', self.id]) || versions.build
+          end
+        end
+      end
+    end
+
+    setup do
+      @contact = Contact.create('first_name' => 'Martin')
+    end
+
+    subject { @contact }
+
+    should 'store properties in the given instance' do
+      assert_equal Hash["famous"=>"no", "first_name"=>"Martin"], JSON.parse(subject.version['properties'])
+    end
+
+    should 'keep a properties cache in the the main instance' do
+      assert_equal Hash["famous"=>"no", "first_name"=>"Martin"], subject.instance_variable_get(:@properties)
+    end
+
+    should 'behave as if storage was internal' do
+      subject.first_name = 'Hannah'
+      assert_equal 'no', subject.famous
+      assert_equal Hash["first_name"=>["Martin", "Hannah"]], subject.changes
+    end
+  end
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: property
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors: 
 - Renaud Kern
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-12 00:00:00 +01:00
+date: 2010-02-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency