property 0.5.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+coverage

data/History.txt

@@ -0,0 +1,10 @@
+== 0.4.0 2010-02-02
+
+* 1 major enhancement
+  * initial plugin code
+
+== 0.5.0 2010-02-11
+
+* 2 major enhancement
+  * changed plugin into gem
+  * using Rails columns to handle defaults and type casting

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Gaspard Bucher (http://teti.ch)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,48 @@
+== DESCRIPTION:
+
+Wrap model properties into a single database column and declare properties from within the model.
+
+website: http://zenadmin.org/635
+license: MIT
+
+== Status: Beta
+
+The gem works fine, even though it still needs some more features like property definition
+changes detections and migrations.
+
+== Usage
+
+You first need to create a migration to add a 'text' field named 'properties' to
+your model. Something like this:
+
+ class AddPropertyToContact < ActiveRecord::Migration
+   def self.up
+     add_column :contacts, :properties, :text
+   end
+
+   def self.down
+     remove_column :contacts, :properties
+   end
+ end
+
+Once your database is ready, you need to declare the property columns:
+
+ class Contact < ActiveRecord::Base
+   include Property
+   property do |p|
+     p.string  'first_name', 'name', 'phone'
+     p.datetime 'contacted_at', :default => Proc.new {Time.now}
+   end
+  end
+
+You can now read property values with:
+
+  @contact.prop['first_name']
+  @contact.first_name
+
+And set them with:
+
+  @contact.update_attributes('first_name' => 'Mahatma')
+  @contact.prop['name'] = 'Gandhi'
+  @contact.name = 'Gandhi'
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'pathname'
+$LOAD_PATH.unshift((Pathname(__FILE__).dirname +  'lib').expand_path)
+
+require 'property'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs     << 'lib' << 'test'
+  test.pattern  = 'test/**/**_test.rb'
+  test.verbose  = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test' << 'lib'
+    test.pattern = 'test/**/**_test.rb'
+    test.verbose = true
+    test.rcov_opts = ['-T', '--exclude-only', '"test\/,^\/"']
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end
+
+task :default => :test
+
+
+# GEM management
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'property'
+    gemspec.summary = 'model properties wrap into a single database column'
+    gemspec.description = "Wrap model properties into a single database column and declare properties from within the model."
+    gemspec.email = "gaspard@teti.ch"
+    gemspec.homepage = "http://zenadmin.org/635"
+    gemspec.authors = ['Renaud Kern', 'Gaspard Bucher']
+    gemspec.version = Property::VERSION
+    gemspec.rubyforge_project = 'property'
+
+    # Gem dependecies
+    gemspec.add_development_dependency('shoulda')
+    gemspec.add_dependency('active_record')
+  end
+rescue LoadError
+  puts "Jeweler not available. Gem packaging tasks not available."
+end
+#

data/generators/property/property_generator.rb

@@ -0,0 +1,12 @@
+class PropretyGenerator < MigrationGenerator
+
+  def initialize(runtime_args, runtime_options={})
+    super(["property=rety_migration"])
+  end
+
+  def manifest
+    record do |m|
+      m.migration_template( 'migration.rb', 'db/migrate')
+    end
+  end
+end

data/lib/property.rb

@@ -0,0 +1,16 @@
+require 'property/attribute'
+require 'property/dirty'
+require 'property/properties'
+require 'property/column'
+require 'property/declaration'
+require 'property/serialization/json'
+
+module Property
+  VERSION = '0.5.0'
+
+  def self.included(base)
+    base.class_eval do
+      include ::Property::Attribute
+    end
+  end
+end

data/lib/property/attribute.rb

@@ -0,0 +1,89 @@
+module Property
+  # The Property::Attribute module is included in ActiveRecord model for CRUD operations
+  # on properties. These ared stored in a table field called 'properties' and are accessed
+  # with #properties or #prop and properties= methods.
+  #
+  # The properties are encoded et decoded with a serialization tool than you can change by including
+  # a Serialization module that should implement 'encode_properties' and 'decode_properties'.
+  # The default is to use Marshal through Property::Serialization::Marshal.
+  #
+  # The attributes= method filters native attributes and properties in order to store
+  # them apart.
+  #
+  module Attribute
+
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        include Serialization::JSON
+        include Declaration
+        include Dirty
+
+        before_save :dump_properties
+
+        alias_method_chain :attributes=,  :properties
+      end
+    end
+
+    module InstanceMethods
+      def properties
+        @properties ||= load_properties
+      end
+
+      alias_method :prop, :properties
+
+      # Define a set of properties. This acts like 'attributes=': it merges the current
+      # properties with the list of provided key/values. Note that unlike 'attributes=',
+      # the keys must be provided as strings, not symbols. For efficiency reasons and
+      # simplification of the API, we do not convert from symbols.
+      def properties=(new_properties)
+        return if new_properties.nil?
+        properties.merge!(new_properties)
+      end
+
+      alias_method :prop=, :properties=
+
+      # Force a reload of the properties from the ones stored in the database.
+      def reload_properties!
+        @properties = load_properties
+      end
+
+      private
+        def attributes_with_properties=(attributes, guard_protected_attributes = true)
+          columns = self.class.column_names
+          properties = {}
+
+          attributes.keys.each do |k|
+            if !respond_to?("#{k}=") && !columns.include?(k)
+              properties[k] = attributes.delete(k)
+            end
+          end
+
+          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
+            @properties.compact!
+            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/column.rb

@@ -0,0 +1,35 @@
+require 'active_record'
+ActiveRecord.load_all!
+
+module Property
+  # The Column class is used to hold information about a Property declaration,
+  # 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
+
+    def initialize(name, default, type, options={})
+      name = name.to_s
+      extract_property_options(options)
+      super(name, default, type, options)
+    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
+    end
+
+    def indexed?
+      @indexed
+    end
+
+    def extract_property_options(options)
+      @indexed = options.delete(:indexed)
+    end
+  end # Column
+end # Property

data/lib/property/declaration.rb

@@ -0,0 +1,120 @@
+module Property
+
+  # Property::Declaration module is used to declare property definitions in a Class. The module
+  # also manages property inheritence in sub-classes.
+  module Declaration
+
+    def self.included(base)
+      base.class_eval do
+        extend  ClassMethods
+        include InstanceMethods
+
+        class << self
+          attr_accessor :own_property_columns
+          attr_accessor :property_definition_proxy
+        end
+
+        validate :properties_validation, :if => :properties
+      end
+    end
+
+    module ClassMethods
+      class DefinitionProxy
+        def initialize(klass)
+          @klass = klass
+        end
+
+        def column(name, default, type, options)
+          if columns[name.to_s]
+            raise TypeError.new("Property '#{name}' is already defined.")
+          else
+            own_columns[name] = Property::Column.new(name, default, type, options)
+          end
+        end
+
+        # If someday we find the need to insert other native classes directly in the DB, we
+        # could use this:
+        # p.serialize MyClass, xxx, xxx
+        # def serialize(klass, name, options={})
+        #   if @klass.super_property_columns[name.to_s]
+        #     raise TypeError.new("Property '#{name}' is already defined in a superclass.")
+        #   elsif !@klass.validate_property_class(type)
+        #     raise TypeError.new("Custom type '#{type}' cannot be serialized.")
+        #   else
+        #     # Find a way to insert the type (maybe with 'serialize'...)
+        #     # (@klass.own_property_columns ||= {})[name] = Property::Column.new(name, type, options)
+        #   end
+        # 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| column(name, default, '#{column_type}', options) }
+            end
+          EOV
+        end
+
+        private
+          def own_columns
+            @klass.own_property_columns ||= {}
+          end
+
+          def columns
+            @klass.property_columns
+          end
+
+      end
+
+      # Use this class method to declare properties that will be used in your models. Note
+      # that you must provide string keys. Example:
+      #  property.string 'phone', :default => ''
+      #
+      # You can also use a block:
+      #  property do |p|
+      #    p.string 'phone', 'name', :default => ''
+      #  end
+      def property
+        proxy = self.property_definition_proxy ||= DefinitionProxy.new(self)
+        if block_given?
+          yield proxy
+        end
+        proxy
+      end
+
+      # Return the list of all properties defined for the current class, including the properties
+      # defined in the parent class.
+      def property_columns
+        super_property_columns.merge(self.own_property_columns || {})
+      end
+
+      def property_column_names
+        property_columns.keys
+      end
+
+      def super_property_columns
+        if superclass.respond_to?(:property_columns)
+          superclass.property_columns
+        else
+          {}
+        end
+      end
+    end # ClassMethods
+
+    module InstanceMethods
+
+      protected
+        def properties_validation
+          properties.validate
+        end
+    end # InsanceMethods
+  end # Declaration
+end # Property

data/lib/property/dirty.rb

@@ -0,0 +1,98 @@
+module Property
+  # This module implement ActiveRecord::Dirty functionalities with Property attributes. It
+  # enables the usual 'changed?' and 'changes' to include property changes. Unlike dirty,
+  # 'foo_changed?' and 'foo_was' are not defined in the model and should be replaced by
+  # #prop.foo_changed? and prop.foo_was.
+  #
+  # If you need to find the property changes only, you can use #prop.changes or prop.changed?
+  #
+  module Dirty
+
+    private
+
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :changed?, :properties
+          alias_method_chain :changed,  :properties
+          alias_method_chain :changes,  :properties
+        end
+      end
+
+      def changed_with_properties?
+        changed_without_properties? || properties.changed?
+      end
+
+      def changed_with_properties
+        changed_without_properties + properties.changed
+      end
+
+      def changes_with_properties
+        changes_without_properties.merge properties.changes
+      end
+
+  end # Dirty
+
+  # This module implements ActiveRecord::Dirty functionalities for the properties hash.
+  module DirtyProperties
+    CHANGED_REGEXP = %r{(.+)_changed\?$}
+    WAS_REGEXP = %r{(.+)_was$}
+
+    def []=(key, value)
+      @original_hash ||= self.dup
+      super
+    end
+
+    def delete(key)
+      @original_hash ||= self.dup
+      super
+    end
+
+    def merge!(other_hash)
+      @original_hash ||= self.dup
+      super
+    end
+
+    def changed?
+      !changes.empty?
+    end
+
+    def changed
+      changes.keys
+    end
+
+    def changes
+      return {} unless @original_hash
+      compact!
+      changes = {}
+
+      # look for updated value
+      each do |key, new_value|
+        if new_value != (old_value = @original_hash[key])
+          changes[key] = [old_value, new_value]
+        end
+      end
+
+      # look for deleted value
+      (@original_hash.keys - keys).each do |key|
+        changes[key] = [@original_hash[key], nil]
+      end
+
+      changes
+    end
+
+    # This method should be called to reset dirty information before dump
+    def clear_changes!
+      remove_instance_variable(:@original_hash) if defined?(@original_hash)
+    end
+
+    def method_missing(method, *args)
+      if method.to_s =~ CHANGED_REGEXP
+        !changes[$1].nil?
+      elsif method.to_s =~ WAS_REGEXP
+        (@original_hash || self)[$1]
+      else
+        super
+      end
+    end
+  end
+end # Property