composite_primary_keys 5.0.9 → 5.0.10

data/History.rdoc

@@ -1,3 +1,11 @@
+== 5.0.10 2012-11-21
+* ActiveRecord 3.2.9 compatability (Tom Hughes, Chris Heald, Jack Tang)
+* Add support for find_in_batches (Charlie Savage)
+* Add support for touch method (Macario Ortega)
+* Remove symbolized representation of primary keys to be consistent with ActiveRecord (Tiago Cardoso)
+* Update destroy method to use hash of primary keys over an array. This allows the proper SQL
+  (using IS NULL) to be generated when one of the primary key attributes is nil (Scott Hunter).
+
 == 5.0.9 2012-09-29
 * Enable tests for MS SQL Servder (Enderson Maia)
 * Update ActiveRecord::Base#initialize_dup override in line with ActiveRecord::Base 3.2.5+ (Lucas Maxwell)

data/lib/composite_primary_keys.rb

@@ -26,7 +26,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 unless defined?(ActiveRecord)
   require 'rubygems'
-  gem 'activerecord', '>= 3.2.8', '~> 3.2.0'
+  gem 'activerecord', '>= 3.2.9', '~> 3.2.0'
   require 'active_record'
 end
 
@@ -56,6 +56,7 @@ require 'active_record/attribute_methods/write'
 
 require 'active_record/connection_adapters/abstract_adapter'
 
+require 'active_record/relation/batches'
 require 'active_record/relation/calculations'
 require 'active_record/relation/finder_methods'
 require 'active_record/relation/query_methods'
@@ -94,6 +95,7 @@ require 'composite_primary_keys/attribute_methods/write'
 require 'composite_primary_keys/connection_adapters/abstract_adapter'
 require 'composite_primary_keys/connection_adapters/abstract/connection_specification_changes'
 
+require 'composite_primary_keys/relation/batches'
 require 'composite_primary_keys/relation/calculations'
 require 'composite_primary_keys/relation/finder_methods'
 require 'composite_primary_keys/relation/query_methods'

data/lib/composite_primary_keys/attribute_methods/dirty.rb

@@ -13,12 +13,12 @@ module ActiveRecord
           # The attribute already has an unsaved change.
           if attribute_changed?(attr)
             old = @changed_attributes[attr]
-            @changed_attributes.delete(attr) unless field_changed?(attr, old, value)
+            @changed_attributes.delete(attr) unless _field_changed?(attr, old, value)
           else
             old = clone_attribute_value(:read_attribute, attr)
             # Save Time objects as TimeWithZone if time_zone_aware_attributes == true
             old = old.in_time_zone if clone_with_time_zone_conversion_attribute?(attr, old)
-            @changed_attributes[attr] = old if field_changed?(attr, old, value)
+            @changed_attributes[attr] = old if _field_changed?(attr, old, value)
           end
         end
 

data/lib/composite_primary_keys/base.rb

@@ -27,7 +27,7 @@ module ActiveRecord
           return
         end
 
-        @primary_keys = keys.map { |k| k.to_sym }.to_composite_keys
+        @primary_keys = keys.map { |k| k.to_s }.to_composite_keys
 
         class_eval <<-EOV
           extend  CompositeClassMethods
@@ -70,7 +70,7 @@ module ActiveRecord
 
       @changed_attributes = {}
       self.class.column_defaults.each do |attr, orig_value|
-        @changed_attributes[attr] = orig_value if field_changed?(attr, orig_value, @attributes[attr])
+        @changed_attributes[attr] = orig_value if _field_changed?(attr, orig_value, @attributes[attr])
       end
 
       @aggregation_cache = {}

data/lib/composite_primary_keys/dirty.rb

@@ -5,12 +5,12 @@ module ActiveModel
     end
 
     def primary_key_changed?
-      !!changed.detect { |key| ids_hash.keys.include?(key.to_sym) }
+      !!changed.detect { |key| ids_hash.keys.include?(key.to_s) }
     end
 
     def primary_key_was
       ids_hash.keys.inject(Hash.new) do |result, attribute_name|
-        result[attribute_name.to_sym] = attribute_was(attribute_name.to_s)
+        result[attribute_name] = attribute_was(attribute_name.to_s)
         result
       end
     end

data/lib/composite_primary_keys/persistence.rb

@@ -10,24 +10,20 @@ module ActiveRecord
         #column     = self.class.columns_hash[pk]
         #substitute = connection.substitute_at(column, 0)
 
+        where_hash = {}
         primary_keys = Array(self.class.primary_key)
-        bind_values = Array.new
-        eq_predicates = Array.new
-        primary_keys.each_with_index do |key, i|
-          column = self.class.columns_hash[key.to_s]
-          bind_values << [column, self[key]]
-          substitute = connection.substitute_at(column, i)
-          eq_predicates << self.class.arel_table[key].eq(substitute)
-        end
-        predicate = Arel::Nodes::And.new(eq_predicates)
-        relation = self.class.unscoped.where(predicate)
 
         #relation = self.class.unscoped.where(
         #  self.class.arel_table[pk].eq(substitute))
 
-        # CPK
+        primary_keys.each do |key|
+          where_hash[key.to_s] = self[key]
+        end
+
+        # CPK      
         #relation.bind_values = [[column, id]]
-        relation.bind_values = bind_values
+
+        relation = self.class.unscoped.where(where_hash)
         relation.delete_all
       end
 
@@ -35,6 +31,33 @@ module ActiveRecord
       freeze
     end
 
+    def touch(name = nil)
+      attributes = timestamp_attributes_for_update_in_model
+      attributes << name if name
+
+      unless attributes.empty?
+        current_time = current_time_from_proper_timezone
+        changes = {}
+
+        attributes.each do |column|
+          column = column.to_s
+          changes[column] = write_attribute(column, current_time)
+        end
+
+        changes[self.class.locking_column] = increment_lock if locking_enabled?
+
+        @changed_attributes.except!(*changes.keys)
+
+        relation    = self.class.send(:relation)
+        arel_table  = self.class.arel_table
+        primary_key = self.class.primary_key
+
+        primary_key_predicate = relation.cpk_id_predicate(arel_table, Array(primary_key), Array(id))
+
+        self.class.unscoped.where(primary_key_predicate).update_all(changes) == 1
+      end
+    end
+
     def update(attribute_names = @attributes.keys)
       klass = self.class
       if !self.composite?
@@ -56,4 +79,4 @@ module ActiveRecord
       klass.connection.update stmt.to_sql
     end
   end
-end
+end

data/lib/composite_primary_keys/relation.rb

@@ -2,6 +2,7 @@ module ActiveRecord
   class Relation
     def add_cpk_support
       class << self
+        include CompositePrimaryKeys::ActiveRecord::Batches
         include CompositePrimaryKeys::ActiveRecord::Calculations
         include CompositePrimaryKeys::ActiveRecord::FinderMethods
         include CompositePrimaryKeys::ActiveRecord::QueryMethods

data/lib/composite_primary_keys/relation/batches.rb

@@ -0,0 +1,63 @@
+module CompositePrimaryKeys
+  module ActiveRecord
+    module Batches
+      def find_in_batches(options = {})
+        relation = self
+
+        unless arel.orders.blank? && arel.taken.blank?
+          ActiveRecord::Base.logger.warn("Scoped order and limit are ignored, it's forced to be batch order and batch size")
+        end
+
+        if (finder_options = options.except(:start, :batch_size)).present?
+          raise "You can't specify an order, it's forced to be #{batch_order}" if options[:order].present?
+          raise "You can't specify a limit, it's forced to be the batch_size"  if options[:limit].present?
+
+          relation = apply_finder_options(finder_options)
+        end
+
+        start = options.delete(:start).to_i
+        batch_size = options.delete(:batch_size) || 1000
+
+        relation = relation.reorder(batch_order).limit(batch_size)
+
+        # CPK
+        #records = relation.where(table[primary_key].gteq(start)).all
+        self.primary_key.each do |key|
+          relation = relation.where(table[key].gteq(start))
+        end
+        records = relation.all
+
+        while records.any?
+          records_size = records.size
+          primary_key_offset = records.last.id
+
+          yield records
+
+          break if records_size < batch_size
+
+          if primary_key_offset
+            # CPK
+            #records = relation.where(table[primary_key].gt(primary_key_offset)).to_a
+            self.primary_key.each do |key|
+              relation = relation.where(table[key].gt(primary_key_offset))
+            end
+            records = relation.to_a
+
+          else
+            raise "Primary key not included in the custom select clause"
+          end
+        end
+      end
+
+      private
+
+      def batch_order
+        # CPK
+        #"#{quoted_table_name}.#{quoted_primary_key} ASC"
+        self.primary_key.map do |key|
+          "#{quoted_table_name}.#{key} ASC"
+        end.join(",")
+      end
+    end
+  end
+end

data/lib/composite_primary_keys/version.rb

@@ -2,7 +2,7 @@ module CompositePrimaryKeys
   module VERSION
     MAJOR = 5
     MINOR = 0
-    TINY  = 9
+    TINY  = 10
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/test/fixtures/db_definitions/postgresql.sql

@@ -18,14 +18,18 @@ create table reference_codes (
 create table products (
     id serial not null,
     name varchar(50) default null,
-    primary key (id)
+    primary key (id),
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL
 );
 
 create table tariffs (
     tariff_id  int  not null,
     start_date date not null,
     amount     int  default null,
-    primary key (tariff_id, start_date)
+    primary key (tariff_id, start_date),
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL
 );
 
 create table product_tariffs (

data/test/fixtures/db_definitions/sqlite.sql

@@ -16,13 +16,17 @@ create table reference_codes (
 
 create table products (
     id int(11) not null primary key,
-    name varchar(50) default null
+    name varchar(50) default null,
+    created_at TIMESTAMP,
+    updated_at TIMESTAMP
 );
 
 create table tariffs (
     tariff_id int(11) not null,
     start_date date not null,
     amount integer(11) default null,
+    created_at TIMESTAMP,
+    updated_at TIMESTAMP,
     primary key (tariff_id, start_date)
 );
 

data/test/test_find.rb

@@ -2,7 +2,7 @@ require File.expand_path('../abstract_unit', __FILE__)
 
 # Testing the find action on composite ActiveRecords with two primary keys
 class TestFind < ActiveSupport::TestCase
-  fixtures :capitols, :reference_types, :reference_codes, :suburbs
+  fixtures :capitols, :departments, :reference_types, :reference_codes, :suburbs
 
   def test_find_first
     ref_code = ReferenceCode.find(:first, :order => 'reference_type_id, reference_code')
@@ -75,4 +75,10 @@ class TestFind < ActiveSupport::TestCase
     suburb = Suburb.find(:last, :order => 'suburbs.city_id DESC')
     assert_equal([1,1], suburb.id)
   end
+
+  def test_find_in_batchs
+    departments = Department.find_in_batches do |batch|
+      assert_equal(2, batch.size)
+    end
+  end
 end

data/test/test_ids.rb

@@ -78,7 +78,7 @@ class TestIds < ActiveSupport::TestCase
     testing_with do
       if composite?
         assert_not_nil @klass.primary_keys
-        assert_equal @primary_keys.map {|key| key.to_sym}, @klass.primary_keys
+        assert_equal @primary_keys.map {|key| key.to_s}, @klass.primary_keys
         assert_equal @klass.primary_keys, @klass.primary_key
         assert_kind_of(CompositePrimaryKeys::CompositeKeys, @klass.primary_keys)
         assert_equal @primary_keys.map {|key| key.to_sym}.join(','), @klass.primary_key.to_s
@@ -91,7 +91,7 @@ class TestIds < ActiveSupport::TestCase
   end
 
   def test_inherited_primary_keys
-    assert_equal([:reference_type_id, :reference_code], ChildCpkTest.primary_keys)
+    assert_equal(["reference_type_id", "reference_code"], ChildCpkTest.primary_keys)
   end
 
   def test_inherited_ids

data/test/test_touch.rb

@@ -0,0 +1,23 @@
+# Test cases devised by Santiago that broke the Composite Primary Keys
+# code at one point in time. But no more!!!
+require File.expand_path('../abstract_unit', __FILE__)
+
+class TestTouch < ActiveSupport::TestCase
+  fixtures :products, :tariffs
+
+  def test_touching_a_record_updates_its_timestamp
+    tariff                = tariffs(:flat)
+    previous_amount       = tariff.amount
+    previously_updated_at = tariff.updated_at
+    
+    tariff.amount         = previous_amount + 1
+    tariff.touch
+
+    assert_not_equal previously_updated_at, tariff.updated_at
+    assert_equal previous_amount + 1, tariff.amount
+    assert tariff.amount_changed?, 'tarif amount should have changed'
+    assert tariff.changed?, 'tarif should be marked as changed'
+    tariff.reload
+    assert_not_equal previously_updated_at, tariff.updated_at
+  end
+end

data/test/test_update.rb

@@ -41,13 +41,13 @@ class TestUpdate < ActiveSupport::TestCase
     obj.reference_type_id = 2
     obj.reference_code = 3
     assert(obj.primary_key_changed?)
-    assert_equal({:reference_type_id => 1, :reference_code => 1}, obj.primary_key_was)
-    assert_equal({:reference_type_id => 2, :reference_code => 3}, obj.ids_hash)
+    assert_equal({"reference_type_id" => 1, "reference_code" => 1}, obj.primary_key_was)
+    assert_equal({"reference_type_id" => 2, "reference_code" => 3}, obj.ids_hash)
     assert(obj.save)
     assert(obj.reload)
     assert_equal(2, obj.reference_type_id)
     assert_equal(3, obj.reference_code)
-    assert_equal({:reference_type_id => 2, :reference_code => 3}, obj.ids_hash)
+    assert_equal({"reference_type_id" => 2, "reference_code" => 3}, obj.ids_hash)
     assert_equal([2, 3], obj.id)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: composite_primary_keys
 version: !ruby/object:Gem::Version
-  version: 5.0.9
+  version: 5.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-29 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 3.2.9
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
@@ -30,7 +30,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 3.2.9
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
@@ -70,6 +70,7 @@ files:
 - lib/composite_primary_keys/dirty.rb
 - lib/composite_primary_keys/fixtures.rb
 - lib/composite_primary_keys/persistence.rb
+- lib/composite_primary_keys/relation/batches.rb
 - lib/composite_primary_keys/relation/calculations.rb
 - lib/composite_primary_keys/relation/finder_methods.rb
 - lib/composite_primary_keys/relation/query_methods.rb
@@ -187,6 +188,7 @@ files:
 - test/test_predicates.rb
 - test/test_santiago.rb
 - test/test_suite.rb
+- test/test_touch.rb
 - test/test_tutorial_example.rb
 - test/test_update.rb
 - test/test_validations.rb
@@ -210,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: compositekeys
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Composite key support for ActiveRecord
@@ -240,6 +242,7 @@ test_files:
 - test/test_predicates.rb
 - test/test_santiago.rb
 - test/test_suite.rb
+- test/test_touch.rb
 - test/test_tutorial_example.rb
 - test/test_update.rb
 - test/test_validations.rb