property 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,11 @@
+== 1.1.0 2010-07-22
+
+* Major enhancements
+  * Storing original role in column.
+  * Using 'idx_' as prefix by default instead of 'i_'.
+  * Pluralizing index table names.
+  * Added 'index_group' setting to use with Proc indexes on properties.
+
 == 1.0.0 2010-05-27
 
 * Major enhancements

data/Rakefile

@@ -1,7 +1,7 @@
 require 'pathname'
 $LOAD_PATH.unshift((Pathname(__FILE__).dirname +  'lib').expand_path)
 
-require 'property'
+require 'property/version'
 require 'rake'
 require 'rake/testtask'
 

data/lib/property/column.rb

@@ -15,6 +15,7 @@ module Property
       if type.kind_of?(Class)
         @klass = type
       end
+
       super(name, default, type, options)
       extract_property_options(options)
     end
@@ -44,10 +45,16 @@ module Property
       end
     end
 
+    # Return the class related to the type of property stored (String, Integer, etc).
     def klass
       @klass || super
     end
 
+    # Return the role in which the column was originally defined.
+    def role
+      @role
+    end
+
     # Property type used instead of 'type' when column is stored
     alias ptype type
 
@@ -62,16 +69,23 @@ module Property
       end
     end
 
+    # Return the Proc to use to build index (usually nil).
+    def index_proc
+      @index_proc
+    end
+
     private
       def extract_property_options(options)
         @index = options.delete(:index) || options.delete(:indexed)
+        @role  = options.delete(:role)
         if @index == true
-          @index = ptype
-        end
-
-        if @index.blank?
+          @index = (options.delete(:index_group) || ptype).to_s
+        elsif @index.kind_of?(Proc)
+          @index_proc = @index
+          @index = (options.delete(:index_group) || ptype).to_s
+        elsif @index.blank?
           @index = nil
-        elsif @index.kind_of?(Symbol)
+        else
           @index = @index.to_s
         end
       end

data/lib/property/db.rb

@@ -28,24 +28,33 @@ module Property
       ActiveRecord::Base.connection
     end
 
+    def quote(value)
+      connection.quote(value)
+    end
+
     # Insert a list of values (multicolumn insert). The values should be properly escaped before
     # being passed to this method.
     def insert_many(table, columns, values)
-      values = values.compact.uniq
+      values = values.compact.uniq.map do |list|
+        list.map {|e| quote(e)}
+      end
+
+      columns = columns.map {|e| connection.quote_column_name(e)}.join(',')
+
       case adapter
       when 'sqlite3'
-        pre_query = "INSERT INTO #{table} (#{columns.join(',')}) VALUES "
+        pre_query = "INSERT INTO #{table} (#{columns}) VALUES "
         values.each do |v|
           execute pre_query + "(#{v.join(',')})"
         end
       else
         values = values.map {|v| "(#{v.join(',')})"}.join(', ')
-        execute "INSERT INTO #{table} (#{columns.map{|c| "`#{c}`"}.join(',')}) VALUES #{values}"
+        execute "INSERT INTO #{table} (#{columns}) VALUES #{values}"
       end
     end
 
     def fetch_attributes(attributes, table_name, sql)
-      sql = "SELECT #{attributes.map{|a| connection.quote_column_name(a)}.join(',')} FROM #{table_name} WHERE #{sql}"
+      sql = "SELECT #{attributes.map {|a| connection.quote_column_name(a)}.join(',')} FROM #{table_name} WHERE #{sql}"
       connection.select_all(sql)
     end
   end # Db

data/lib/property/index.rb

@@ -3,6 +3,7 @@ module Property
   # Property::Declaration module is used to declare property definitions in a Class. The module
   # also manages property inheritence in sub-classes.
   module Index
+    KEY = Property::Db.connection.quote_column_name('key')
 
     def self.included(base)
       base.class_eval do
@@ -14,16 +15,25 @@ module Property
     end
 
     module ClassMethods
+
+      # Return the table name for the given index group. Produces something like 'idx_pages_strings'.
+      def index_table_name(group_name)
+        "idx_#{table_name}_#{group_name}s"
+      end
     end
 
     module InstanceMethods
 
+      def rebuild_index!
+        property_index
+      end
+
       private
         # Retrieve the current indices for a given group (:string, :text, etc)
         def get_indices(group_name)
           return {} if new_record?
           res = {}
-          Property::Db.fetch_attributes(['key', 'value'], index_table_name(group_name), index_reader_sql(group_name)).each do |row|
+          Property::Db.fetch_attributes(%w{key value}, index_table_name(group_name), index_reader_sql(group_name)).each do |row|
             res[row['key']] = row['value']
           end
           res
@@ -34,13 +44,13 @@ module Property
             if k == :with
               v.map do |subk, subv|
                 if subv.kind_of?(Array)
-                  "`#{subk}` IN (#{subv.map {|ssubv| connection.quote(ssubv)}.join(',')})"
+                  "#{subk} IN (#{subv.map {|ssubv| connection.quote(ssubv)}.join(',')})"
                 else
-                  "`#{subk}` = #{self.class.connection.quote(subv)}"
+                  "#{subk} = #{self.class.connection.quote(subv)}"
                 end
               end.join(' AND ')
             else
-              "`#{k}` = #{self.class.connection.quote(v)}"
+              "#{k} = #{self.class.connection.quote(v)}"
             end
           end.join(' AND ')
         end
@@ -54,7 +64,7 @@ module Property
         end
 
         def index_table_name(group_name)
-          "i_#{group_name}_#{self.class.table_name}"
+          self.class.index_table_name(group_name)
         end
 
         def index_foreign_key
@@ -90,12 +100,11 @@ module Property
           end
 
           values = new_keys.map do |key|
-            [connection.quote(key), connection.quote(cur_indices[key])]
+            [key, cur_indices[key]]
           end
 
           res = []
           foreign_values.each do |list|
-            list = list.map {|k| connection.quote(k)}
             values.each do |value|
               res << (list + value)
             end
@@ -127,12 +136,12 @@ module Property
 
         # Update an index entry
         def update_index(group_name, key, value)
-          self.class.connection.execute "UPDATE #{index_table_name(group_name)} SET `value` = #{connection.quote(value)} WHERE #{index_reader_sql(group_name)} AND `key` = #{connection.quote(key)}"
+          self.class.connection.execute "UPDATE #{index_table_name(group_name)} SET value = #{connection.quote(value)} WHERE #{index_reader_sql(group_name)} AND #{KEY} = #{connection.quote(key)}"
         end
 
         # Delete a list of indices (value became blank).
         def delete_indices(group_name, keys)
-          self.class.connection.execute "DELETE FROM #{index_table_name(group_name)} WHERE #{index_reader_sql(group_name)} AND `key` IN (#{keys.map{|key| connection.quote(key)}.join(',')})"
+          self.class.connection.execute "DELETE FROM #{index_table_name(group_name)} WHERE #{index_reader_sql(group_name)} AND #{KEY} IN (#{keys.map{|key| connection.quote(key)}.join(',')})"
         end
 
         # This method prepares the index
@@ -202,7 +211,7 @@ module Property
             if group_name.kind_of?(Class)
               group_name.delete_property_index(self)
             else
-              connection.execute "DELETE FROM #{index_table_name(group_name)} WHERE `#{foreign_key}` = #{current_id}"
+              connection.execute "DELETE FROM #{index_table_name(group_name)} WHERE #{foreign_key} = #{current_id}"
             end
           end
         end

data/lib/property/role_module.rb

@@ -39,13 +39,7 @@ module Property
       columns.values.select do |c|
         c.indexed?
       end.map do |c|
-        if c.index == true
-          [c.type.to_sym, c.name]
-        elsif c.index.kind_of?(Proc)
-          [c.type.to_sym, c.name, c.index]
-        else
-          [c.index,       c.name]
-        end
+        [c.index, c.name, c.index_proc]
       end + @group_indices
     end
 
@@ -132,7 +126,7 @@ module Property
                   options = args.extract_options!
                   column_names = args.flatten
                   default = options.delete(:default)
-                  column_names.each { |name| role.add_column(Property::Column.new(name, default, '#{column_type}', options)) }
+                  column_names.each { |name| role.add_column(Property::Column.new(name, default, '#{column_type}', options.merge(:role => role))) }
                 end
               EOV
             end
@@ -141,7 +135,7 @@ module Property
             #   p.serialize 'pet', Dog
             def serialize(name, klass, options = {})
               Property.validate_property_class(klass)
-              role.add_column(Property::Column.new(name, nil, klass, options))
+              role.add_column(Property::Column.new(name, nil, klass, options.merge(:role => role)))
             end
 
             # This is used to create complex indices with the following syntax:

data/lib/property/serialization/json.rb

@@ -21,18 +21,22 @@ module Property
 
       def self.included(base)
         Property.validators << Validator
+        base.extend Encoder
       end
 
-      # Encode properties with JSON
-      def encode_properties(properties)
-        properties.to_json
-      end
-
-      # Decode Marshal encoded properties
-      def decode_properties(string)
-        ::JSON.parse(string)
-      end
+      module Encoder
+        # Encode properties with JSON
+        def encode_properties(properties)
+          properties.to_json
+        end
 
+        # Decode Marshal encoded properties
+        def decode_properties(string)
+          ::JSON.parse(string)
+        end
+      end # Encoder
+      include Encoder
+      extend Encoder
     end # JSON
   end # Serialization
 end # Property

data/lib/property/serialization/marshal.rb

@@ -7,18 +7,25 @@ module Property
     #  * no corruption risk if the version of Marshal changes
     #  * it can be accessed by other languages then ruby
     module Marshal
-
-      # Encode properties with Marhsal
-      def encode_properties(properties)
-        # we limit dump depth to 0 (object only: no instance variables)
-        # we have to protect Marshal from serializing instance variables by making a copy
-        [::Marshal::dump(Properties[properties])].pack('m*')
+      def self.included(base)
+        base.extend Encoder
       end
 
-      # Decode Marshal encoded properties
-      def decode_properties(string)
-        ::Marshal::load(string.unpack('m')[0])
-      end
+      module Encoder
+        # Encode properties with Marhsal
+        def encode_properties(properties)
+          # we limit dump depth to 0 (object only: no instance variables)
+          # we have to protect Marshal from serializing instance variables by making a copy
+          [::Marshal::dump(Properties[properties])].pack('m*')
+        end
+
+        # Decode Marshal encoded properties
+        def decode_properties(string)
+          ::Marshal::load(string.unpack('m')[0])
+        end
+      end # Encoder
+      include Encoder
+      extend Encoder
 
     end # Marshal
   end # Serialization

data/lib/property/serialization/yaml.rb

@@ -3,15 +3,23 @@ module Property
     # Use YAML to encode properties. This method is the slowest of all
     # and you should use JSON if you haven't got good reasons not to.
     module YAML
-      # Encode properties with YAML
-      def encode_properties(properties)
-        ::YAML.dump(properties)
+      def self.included(base)
+        base.extend Encoder
       end
 
-      # Decode properties from YAML
-      def decode_properties(string)
-        ::YAML::load(string)
-      end
+      module Encoder
+        # Encode properties with Marhsal
+        def encode_properties(properties)
+          ::YAML.dump(properties)
+        end
+
+        # Decode Marshal encoded properties
+        def decode_properties(string)
+          ::YAML::load(string)
+        end
+      end # Encoder
+      include Encoder
+      extend Encoder
 
     end # Yaml
   end # Serialization

data/lib/property/stored_role.rb

@@ -69,7 +69,7 @@ module Property
         @original_columns = {}
         stored_columns.each do |column|
           @original_columns[column.name] = column
-          add_column(Property::Column.new(column.name, column.default, column.ptype, column.options))
+          add_column(Property::Column.new(column.name, column.default, column.ptype, column.options.merge(:role => self)))
         end
       end
 

data/lib/property/version.rb

@@ -0,0 +1,3 @@
+module Property
+  VERSION = '1.1.0'
+end

data/lib/property.rb

@@ -13,8 +13,6 @@ require 'property/core_ext/time'
 require 'property/base'
 
 module Property
-  VERSION = '1.0.0'
-
   def self.included(base)
     base.class_eval do
       include Attribute

data/property.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{property}
-  s.version = "1.0.0"
+  s.version = "1.1.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-05-27}
+  s.date = %q{2010-07-22}
   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 = [
@@ -43,7 +43,9 @@ Gem::Specification.new do |s|
      "lib/property/serialization/yaml.rb",
      "lib/property/stored_column.rb",
      "lib/property/stored_role.rb",
+     "lib/property/version.rb",
      "property.gemspec",
+     "test/database.rb",
      "test/fixtures.rb",
      "test/shoulda_macros/index.rb",
      "test/shoulda_macros/role.rb",
@@ -51,6 +53,7 @@ Gem::Specification.new do |s|
      "test/test_helper.rb",
      "test/unit/property/attribute_test.rb",
      "test/unit/property/base_test.rb",
+     "test/unit/property/column_test.rb",
      "test/unit/property/declaration_test.rb",
      "test/unit/property/dirty_test.rb",
      "test/unit/property/index_complex_test.rb",
@@ -71,13 +74,15 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{model properties wrap into a single database column}
   s.test_files = [
-    "test/fixtures.rb",
+    "test/database.rb",
+     "test/fixtures.rb",
      "test/shoulda_macros/index.rb",
      "test/shoulda_macros/role.rb",
      "test/shoulda_macros/serialization.rb",
      "test/test_helper.rb",
      "test/unit/property/attribute_test.rb",
      "test/unit/property/base_test.rb",
+     "test/unit/property/column_test.rb",
      "test/unit/property/declaration_test.rb",
      "test/unit/property/dirty_test.rb",
      "test/unit/property/index_complex_test.rb",

data/test/database.rb

@@ -0,0 +1,103 @@
+
+begin
+  class PropertyMigration < ActiveRecord::Migration
+    def self.down
+      drop_table 'employees'
+      drop_table 'versions'
+      drop_table 'string_index'
+    end
+
+    def self.up
+      create_table 'employees' do |t|
+        t.string 'type'
+        t.text   'properties'
+      end
+
+      create_table 'versions' do |t|
+        t.integer 'employee_id'
+        t.string  'properties'
+        t.string  'title'
+        t.string  'comment'
+        t.string  'lang'
+        t.timestamps
+      end
+
+      create_table 'dummies' do |t|
+        t.text    'properties'
+      end
+
+      # index strings in employees
+      create_table 'idx_employees_strings' do |t|
+        t.integer 'employee_id'
+        t.integer 'version_id'
+        t.string  'key'
+        t.string  'value'
+      end
+
+      # multilingual index strings in employees
+      create_table 'idx_employees_ml_strings' do |t|
+        t.integer 'employee_id'
+        t.integer 'version_id'
+        t.string  'lang'
+        t.integer 'site_id'
+        t.string  'key'
+        t.string  'value'
+      end
+
+      # index strings in employees
+      create_table 'idx_employees_specials' do |t|
+        t.integer 'id'
+        t.integer 'employee_id'
+        t.string  'key'
+        t.string  'value'
+      end
+
+      # index integer in employees
+      create_table 'idx_employees_integers' do |t|
+        t.integer 'employee_id'
+        t.integer 'version_id'
+        t.string  'key'
+        t.integer 'value'
+      end
+
+      # index text in employees
+      create_table 'idx_employees_texts' do |t|
+        t.integer 'employee_id'
+        t.string  'key'
+        t.text    'value'
+      end
+
+      # custom or legacy index table
+      create_table 'contacts' do |t|
+        t.integer 'employee_id'
+        t.string 'name'
+        t.string 'other_name'
+      end
+
+      # Database stored role
+      create_table 'roles' do |t|
+        t.integer 'id'
+        t.string 'name'
+      end
+
+      create_table 'columns' do |t|
+        t.integer 'id'
+        t.integer 'role_id'
+        t.string 'name'
+        # Property Type
+        t.string 'ptype'
+        # Indexed (we store an integer so that we can have multiple index types)
+        t.string 'index'
+      end
+    end
+  end
+
+  ActiveRecord::Base.establish_connection(:adapter=>'sqlite3', :database=>':memory:')
+  log_path = Pathname(__FILE__).dirname + '../log/test.log'
+  Dir.mkdir(log_path.dirname) unless File.exist?(log_path.dirname)
+  ActiveRecord::Base.logger = Logger.new(File.open(log_path, 'wb'))
+  ActiveRecord::Migration.verbose = false
+  #PropertyMigration.migrate(:down)
+  PropertyMigration.migrate(:up)
+  ActiveRecord::Migration.verbose = true
+end

data/test/fixtures.rb

@@ -28,122 +28,42 @@ class Version < ActiveRecord::Base
 end
 
 # To test custom class serialization
-class Dog
+class Cat
   attr_accessor :name, :toy
   def self.json_create(data)
-    Dog.new(data['name'], data['toy'])
+    Cat.new(data['name'], data['toy'])
   end
+
   def initialize(name, toy)
     @name, @toy = name, toy
   end
+
   def to_json(*args)
     { 'json_class' => self.class.to_s,
       'name' => @name, 'toy' => @toy
     }.to_json(*args)
   end
+
   def ==(other)
-    other.kind_of?(Dog) && @name == other.name && @toy == other.toy
+    other.kind_of?(Cat) && @name == other.name && @toy == other.toy
   end
 end
 
-begin
-  class PropertyMigration < ActiveRecord::Migration
-    def self.down
-      drop_table 'employees'
-      drop_table 'versions'
-      drop_table 'string_index'
-    end
-
-    def self.up
-      create_table 'employees' do |t|
-        t.string 'type'
-        t.text   'properties'
-      end
-
-      create_table 'versions' do |t|
-        t.integer 'employee_id'
-        t.string  'properties'
-        t.string  'title'
-        t.string  'comment'
-        t.string  'lang'
-        t.timestamps
-      end
-
-      create_table 'dummies' do |t|
-        t.text    'properties'
-      end
-
-      # index strings in employees
-      create_table 'i_string_employees' do |t|
-        t.integer 'employee_id'
-        t.integer 'version_id'
-        t.string  'key'
-        t.string  'value'
-      end
-
-      # multilingual index strings in employees
-      create_table 'i_ml_string_employees' do |t|
-        t.integer 'employee_id'
-        t.integer 'version_id'
-        t.string  'lang'
-        t.integer 'site_id'
-        t.string  'key'
-        t.string  'value'
-      end
-
-      # index strings in employees
-      create_table 'i_special_employees' do |t|
-        t.integer 'employee_id'
-        t.string  'key'
-        t.string  'value'
-      end
-
-      # index integer in employees
-      create_table 'i_integer_employees' do |t|
-        t.integer 'employee_id'
-        t.integer 'version_id'
-        t.string  'key'
-        t.integer 'value'
-      end
-
-      # index text in employees
-      create_table 'i_text_employees' do |t|
-        t.integer 'employee_id'
-        t.string  'key'
-        t.text    'value'
-      end
-
-      # custom or legacy index table
-      create_table 'contacts' do |t|
-        t.integer 'employee_id'
-        t.string 'name'
-        t.string 'other_name'
-      end
-
-      # Database stored role
-      create_table 'roles' do |t|
-        t.integer 'id'
-        t.string 'name'
-      end
-
-      create_table 'columns' do |t|
-        t.integer 'id'
-        t.integer 'role_id'
-        t.string 'name'
-        # Property Type
-        t.string 'ptype'
-        # Indexed (we store an integer so that we can have multiple index types)
-        t.string 'index'
-      end
-    end
-  end
 
-  ActiveRecord::Base.establish_connection(:adapter=>'sqlite3', :database=>':memory:')
-  log_path = Pathname(__FILE__).dirname + '../log/test.log'
-  Dir.mkdir(log_path.dirname) unless File.exist?(log_path.dirname)
-  ActiveRecord::Base.logger = Logger.new(File.open(log_path, 'wb'))
-  ActiveRecord::Migration.verbose = false
-  #PropertyMigration.migrate(:down)
-  PropertyMigration.migrate(:up)
-  ActiveRecord::Migration.verbose = true
-end
+class IdxEmployeesString < ActiveRecord::Base
+end
+
+class IdxEmployeesString < ActiveRecord::Base
+end
+
+class IdxEmployeesMlString < ActiveRecord::Base
+end
+
+class IdxEmployeesInteger < ActiveRecord::Base
+end
+
+class IdxEmployeesText < ActiveRecord::Base
+end
+
+class IdxEmployeesSpecial < ActiveRecord::Base
+end