property 0.9.0 → 0.9.1

data/History.txt

@@ -1,9 +1,15 @@
+== 0.9.1 2010-03-20
+
+* 1 major enhancement
+  * Added support for custom indexer classes.
+  * Removed after_commit dependency (no need for an after_commit).
+
 == 0.9.0 2010-03-20
 
 * 3 major enhancement
   * Added simple index support.
   * Added complex index support.
-  * Added simple hooks for indexes when properties are stored in a different model.
+  * Added simple hooks for indices when properties are stored in a different model.
 
 * 1 minor enhancement
   * Added 'has_column?' to schema.

data/lib/property.rb

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

data/lib/property/behavior.rb

@@ -17,7 +17,7 @@ module Property
     def initialize(name)
       @name    = name
       @included_in_schemas = []
-      @group_indexes   = []
+      @group_indices   = []
       @accessor_module = build_accessor_module
     end
 
@@ -27,7 +27,7 @@ module Property
     end
 
     # Return a list of index definitions in the form [type, key, proc_or_nil]
-    def indexes
+    def indices
       columns.values.select do |c|
         c.indexed?
       end.map do |c|
@@ -36,7 +36,7 @@ module Property
         else
           [c.type, c.name, c.index]
         end
-      end + @group_indexes
+      end + @group_indices
     end
 
     # Return true if the Behavior contains the given column (property).
@@ -86,7 +86,7 @@ module Property
     # @internal
     def add_index(type, proc)
       #                 type,  key, proc
-      @group_indexes << [type, nil, proc]
+      @group_indices << [type, nil, proc]
     end
 
     private
@@ -120,7 +120,7 @@ module Property
               behavior.add_column(Property::Column.new(name, nil, klass, options))
             end
 
-            # This is used to create complex indexes with the following syntax:
+            # This is used to create complex indices with the following syntax:
             #
             #   p.index(:text) do |r| # r = record
             #     {

data/lib/property/declaration.rb

@@ -38,7 +38,7 @@ module Property
         schema.behave_like behavior
       end
 
-      # Use this class method to declare properties and indexes that will be used in your models.
+      # Use this class method to declare properties and indices that will be used in your models.
       # Example:
       #  property.string 'phone', :default => '', :indexed => true
       #

data/lib/property/index.rb

@@ -1,5 +1,3 @@
-require 'versions/after_commit' # we need Versions gem's 'after_commit'
-
 module Property
 
   # Property::Declaration module is used to declare property definitions in a Class. The module
@@ -10,8 +8,8 @@ module Property
       base.class_eval do
         extend  ClassMethods
         include InstanceMethods
-        before_save :property_index
-        before_destroy :property_index_destroy
+        after_save :property_index
+        after_destroy :property_index_destroy
       end
     end
 
@@ -21,8 +19,8 @@ module Property
     module InstanceMethods
 
       private
-        # Retrieve the current indexes for a given group (:string, :text, etc)
-        def get_indexes(group_name)
+        # 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).each do |row|
@@ -57,39 +55,44 @@ module Property
           foreign_values = nil
 
           schema.index_groups.each do |group_name, definitions|
-            old_indexes = get_indexes(group_name)
-            cur_indexes = {}
+            cur_indices = {}
             definitions.each do |key, proc|
               if key
                 value = prop[key]
                 if !value.blank?
                   if proc
-                    cur_indexes.merge!(proc.call(self))
+                    cur_indices.merge!(proc.call(self))
                   else
-                    cur_indexes[key] = value
+                    cur_indices[key] = value
                   end
                 end
               else
-                cur_indexes.merge!(proc.call(self))
+                cur_indices.merge!(proc.call(self))
               end
             end
 
-            old_keys = old_indexes.keys
-            cur_keys = cur_indexes.keys
+            if group_name.kind_of?(Class)
+              # Use a custom indexer
+              group_name.set_property_index(self, cur_indices)
+            else
+              # Add key/value pairs to the default tables
+              old_indices = get_indices(group_name)
+
+              old_keys = old_indices.keys
+              cur_keys = cur_indices.keys
 
-            new_keys = cur_keys - old_keys
-            del_keys = old_keys - cur_keys
-            upd_keys = cur_keys & old_keys
+              new_keys = cur_keys - old_keys
+              del_keys = old_keys - cur_keys
+              upd_keys = cur_keys & old_keys
 
-            after_commit do
               table_name  = index_table_name(group_name)
 
               upd_keys.each do |key|
-                value = cur_indexes[key]
+                value = cur_indices[key]
                 if value.blank?
                   del_keys << key
                 else
-                  connection.execute "UPDATE #{table_name} SET value = #{connection.quote(cur_indexes[key])} WHERE #{reader_sql} AND key = #{connection.quote(key)}"
+                  connection.execute "UPDATE #{table_name} SET value = #{connection.quote(cur_indices[key])} WHERE #{reader_sql} AND key = #{connection.quote(key)}"
                 end
               end
 
@@ -97,7 +100,7 @@ module Property
                 connection.execute "DELETE FROM #{table_name} WHERE #{reader_sql} AND key IN (#{del_keys.map{|key| connection.quote(key)}.join(',')})"
               end
 
-              new_keys.reject! {|k| cur_indexes[k].blank? }
+              new_keys.reject! {|k| cur_indices[k].blank? }
               if !new_keys.empty?
                 # we evaluate this now to have the id on record creation
                 foreign_keys   ||= index_writer.keys
@@ -107,7 +110,7 @@ module Property
                   table_name,
                   foreign_keys + ['key', 'value'],
                   new_keys.map do |key|
-                    foreign_values + [connection.quote(key), connection.quote(cur_indexes[key])]
+                    foreign_values + [connection.quote(key), connection.quote(cur_indices[key])]
                   end
                 )
               end
@@ -121,7 +124,9 @@ module Property
           foreign_key = index_foreign_key
           current_id  = self.id
           schema.index_groups.each do |group_name, definitions|
-            after_commit do
+            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}"
             end
           end

data/lib/property/schema.rb

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

data/property.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{property}
-  s.version = "0.9.0"
+  s.version = "0.9.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Renaud Kern", "Gaspard Bucher"]
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
      "test/unit/property/declaration_test.rb",
      "test/unit/property/dirty_test.rb",
      "test/unit/property/index_complex_test.rb",
+     "test/unit/property/index_custom_test.rb",
      "test/unit/property/index_foreign_test.rb",
      "test/unit/property/index_simple_test.rb",
      "test/unit/property/validation_test.rb",
@@ -67,6 +68,7 @@ Gem::Specification.new do |s|
      "test/unit/property/declaration_test.rb",
      "test/unit/property/dirty_test.rb",
      "test/unit/property/index_complex_test.rb",
+     "test/unit/property/index_custom_test.rb",
      "test/unit/property/index_foreign_test.rb",
      "test/unit/property/index_simple_test.rb",
      "test/unit/property/validation_test.rb",

data/test/fixtures.rb

@@ -92,10 +92,18 @@ begin
         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
     end
   end
 
   ActiveRecord::Base.establish_connection(:adapter=>'sqlite3', :database=>':memory:')
+#  ActiveRecord::Base.logger = Logger.new(STDOUT)
   ActiveRecord::Migration.verbose = false
   #PropertyMigration.migrate(:down)
   PropertyMigration.migrate(:up)

data/test/unit/property/behavior_test.rb

@@ -58,10 +58,10 @@ class BehaviorTest < Test::Unit::TestCase
       assert column.indexed?
     end
 
-    should 'return a list of indexes on indexes' do
+    should 'return a list of indices on indices' do
       subject.property.string('rolodex', :index => true)
       subject.property.integer('foobar', :index => true)
-      assert_equal %w{integer string}, subject.indexes.map {|i| i[0].to_s }.sort
+      assert_equal %w{integer string}, subject.indices.map {|i| i[0].to_s }.sort
     end
   end # A Behavior
 

data/test/unit/property/index_complex_test.rb

@@ -53,7 +53,7 @@ class IndexComplexTest < ActiveSupport::TestCase
       assert_kind_of Hash, subject.index_groups
     end
 
-    should 'group indexes by type' do
+    should 'group indices by type' do
       assert_equal %w{integer text}, subject.index_groups.keys.map(&:to_s).sort
     end
   end

data/test/unit/property/index_custom_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+require 'fixtures'
+
+class IndexCustomTest < ActiveSupport::TestCase
+  class IndexedContact < ActiveRecord::Base
+    set_table_name :contacts
+
+    def self.set_property_index(person, indices)
+      if index = first(:conditions => ['employee_id = ?', person.id])
+        index.update_attributes(indices)
+      else
+        create(indices.merge(:employee_id => person.id))
+      end
+    end
+
+    def self.delete_property_index(person)
+      delete_all(['employee_id = ?', person.id])
+    end
+  end
+
+  # Index definition class with a legacy table for indices
+  class Person < ActiveRecord::Base
+    include Property
+    set_table_name :employees
+
+    property do |p|
+      p.string 'name'
+      p.string 'first_name'
+
+      p.index(IndexedContact) do |r| # r = record
+        {
+          'name' => "#{r.name}!", # just to test renaming
+          'other_name' => r.first_name
+        }
+      end
+    end
+  end
+
+  context 'A schema from a class with a custom indexer' do
+    subject do
+      Person.schema
+    end
+
+    should 'return a Hash on index_groups' do
+      assert_kind_of Hash, subject.index_groups
+    end
+
+    should 'group indices by type' do
+      assert_equal %w{IndexCustomTest::IndexedContact}, subject.index_groups.keys.map(&:to_s).sort
+    end
+  end
+
+  context 'A class with complex index definition' do
+    subject do
+      Person
+    end
+
+    context 'on record creation' do
+      should 'create index entries in the custom table' do
+        assert_difference('IndexedContact.count', 1) do
+          Person.create('name' => 'Sadr', 'first_name' => 'Shadi')
+        end
+      end
+
+      should 'store key and value pairs linked to the model' do
+        person = Person.create('name' => 'Sadr', 'first_name' => 'Shadi')
+        index  = IndexedContact.first(:conditions => {:employee_id => person.id})
+        assert_equal 'Sadr!', index.name
+        assert_equal 'Shadi', index.other_name
+      end
+    end
+
+    context 'on record update' do
+      setup do
+        @person = Person.create('name' => 'Sadr', 'first_name' => 'Shadi')
+      end
+
+      should 'update index entries' do
+        index  = IndexedContact.first(:conditions => {:employee_id => @person.id})
+        assert_difference('IndexedContact.count', 0) do
+          @person.update_attributes('first_name' => 'Shiva', 'name' => 'Nazar Ahari')
+        end
+
+        index = IndexedContact.find(index.id) # reload (make sure the record has been updated, not recreated)
+
+        assert_equal 'Nazar Ahari!', index.name
+        assert_equal 'Shiva', index.other_name
+      end
+    end
+
+    context 'on record destruction' do
+      should 'remove index entry' do
+        person = Person.create('first_name' => 'Gaspard', 'name' => 'Bucher')
+        assert_difference('IndexedContact.count', -1) do
+          person.destroy
+        end
+      end
+    end
+  end
+end

data/test/unit/property/index_simple_test.rb

@@ -39,7 +39,7 @@ class IndexSimpleTest < ActiveSupport::TestCase
       assert_kind_of Hash, subject.index_groups
     end
 
-    should 'group indexes by type' do
+    should 'group indices by type' do
       assert_equal %w{integer string}, subject.index_groups.keys.map(&:to_s).sort
     end
   end
@@ -116,7 +116,7 @@ class IndexSimpleTest < ActiveSupport::TestCase
           @dog = Dog.create('name' => 'Pavlov')
         end
 
-        should 'not alter indexes' do
+        should 'not alter indices' do
           assert_difference('IndexedIntegerEmp.count', 0) do
             assert_raises(Exception) do
               @dog.update_attributes('name' => 'raise')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 0
-  version: 0.9.0
+  - 1
+  version: 0.9.1
 platform: ruby
 authors: 
 - Renaud Kern
@@ -80,6 +80,7 @@ files:
 - test/unit/property/declaration_test.rb
 - test/unit/property/dirty_test.rb
 - test/unit/property/index_complex_test.rb
+- test/unit/property/index_custom_test.rb
 - test/unit/property/index_foreign_test.rb
 - test/unit/property/index_simple_test.rb
 - test/unit/property/validation_test.rb
@@ -125,6 +126,7 @@ test_files:
 - test/unit/property/declaration_test.rb
 - test/unit/property/dirty_test.rb
 - test/unit/property/index_complex_test.rb
+- test/unit/property/index_custom_test.rb
 - test/unit/property/index_foreign_test.rb
 - test/unit/property/index_simple_test.rb
 - test/unit/property/validation_test.rb