composite_primary_keys 3.0.9 → 3.1.0

data/History.txt

@@ -1,3 +1,9 @@
+== 3.1.0 2010-12-17
+* Add back in rake test tasks (Toby Cabot)
+* Add support for multiple string composite keys (wouter)
+* Remove support for find('3,3').  Instead use find([3,3])
+
+
 == 3.0.9 2010-12-04
 * Fix up support for composite key fixtures.
 

data/Rakefile

@@ -19,4 +19,13 @@ Rake::GemPackageTask.new(spec).define
 # Now load in other task files
 Dir.glob('tasks/**/*.rake').each do |rake_file|
   load File.join(File.dirname(__FILE__), rake_file)
-end
+end
+
+# Set up test tasks
+for adapter in %w( mysql sqlite oracle oracle_enhanced postgresql ibm_db )
+  Rake::TestTask.new("test_#{adapter}") do |t|
+    t.libs << "test" << "test/connections/native_#{adapter}"
+    t.pattern = "test/test_*.rb"
+    t.verbose = true
+  end
+end

data/lib/composite_primary_keys.rb

@@ -1,75 +1,75 @@
-#--
-# Copyright (c) 2006 Nic Williams
-#
-# 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.
-#++
-
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-unless defined?(ActiveRecord)
-  begin
-    require 'active_record'  
-  rescue LoadError
-    require 'rubygems'
-    gem 'active_record'
-  end
-end
-
-require 'active_record/associations.rb'
-require 'active_record/associations/association_proxy.rb'
-require 'active_record/associations/association_collection'
-require 'active_record/associations/association_proxy'
-require 'active_record/associations/belongs_to_association'
-require 'active_record/associations/belongs_to_polymorphic_association'
-require 'active_record/associations/has_and_belongs_to_many_association'
-require 'active_record/associations/has_many_association'
-require 'active_record/associations/has_one_association'
-require 'active_record/associations/has_one_through_association'
-require 'active_record/associations/through_association_scope'
-require 'active_record/relation/query_methods'
-require 'active_record/attribute_methods/primary_key'
-require 'active_record/fixtures'
-
-require 'composite_primary_keys/composite_arrays'
-require 'composite_primary_keys/associations'
-require 'composite_primary_keys/associations/association_proxy'
-require 'composite_primary_keys/associations/has_one_association'
-require 'composite_primary_keys/associations/has_many_association'
-require 'composite_primary_keys/associations/has_and_belongs_to_many_association'
-require 'composite_primary_keys/associations/through_association_scope'
-require 'composite_primary_keys/association_preload'
-require 'composite_primary_keys/reflection'
-require 'composite_primary_keys/relation'
-require 'composite_primary_keys/read'
-require 'composite_primary_keys/finder_methods'
-require 'composite_primary_keys/base'
-require 'composite_primary_keys/calculations'
-require 'composite_primary_keys/validations/uniqueness'
-require 'composite_primary_keys/query_methods'
-require 'composite_primary_keys/primary_key'
-require 'composite_primary_keys/fixtures'
-
-Dir[File.dirname(__FILE__) + '/composite_primary_keys/connection_adapters/*.rb'].each do |adapter|
-  begin
-    require adapter.gsub('.rb','')
-  rescue MissingSourceFile
-  end
-end
+#--
+# Copyright (c) 2006 Nic Williams
+#
+# 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.
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+unless defined?(ActiveRecord)
+  begin
+    require 'active_record'  
+  rescue LoadError
+    require 'rubygems'
+    gem 'active_record'
+  end
+end
+
+require 'active_record/associations.rb'
+require 'active_record/associations/association_proxy.rb'
+require 'active_record/associations/association_collection'
+require 'active_record/associations/association_proxy'
+require 'active_record/associations/belongs_to_association'
+require 'active_record/associations/belongs_to_polymorphic_association'
+require 'active_record/associations/has_and_belongs_to_many_association'
+require 'active_record/associations/has_many_association'
+require 'active_record/associations/has_one_association'
+require 'active_record/associations/has_one_through_association'
+require 'active_record/associations/through_association_scope'
+require 'active_record/relation/query_methods'
+require 'active_record/attribute_methods/primary_key'
+require 'active_record/fixtures'
+
+require 'composite_primary_keys/composite_arrays'
+require 'composite_primary_keys/associations'
+require 'composite_primary_keys/associations/association_proxy'
+require 'composite_primary_keys/associations/has_one_association'
+require 'composite_primary_keys/associations/has_many_association'
+require 'composite_primary_keys/associations/has_and_belongs_to_many_association'
+require 'composite_primary_keys/associations/through_association_scope'
+require 'composite_primary_keys/association_preload'
+require 'composite_primary_keys/reflection'
+require 'composite_primary_keys/relation'
+require 'composite_primary_keys/read'
+require 'composite_primary_keys/finder_methods'
+require 'composite_primary_keys/base'
+require 'composite_primary_keys/calculations'
+require 'composite_primary_keys/validations/uniqueness'
+require 'composite_primary_keys/query_methods'
+require 'composite_primary_keys/primary_key'
+require 'composite_primary_keys/fixtures'
+
+Dir[File.dirname(__FILE__) + '/composite_primary_keys/connection_adapters/*.rb'].each do |adapter|
+  begin
+    require adapter.gsub('.rb','')
+  rescue MissingSourceFile
+  end
+end

data/lib/composite_primary_keys/base.rb

@@ -1,195 +1,191 @@
-module ActiveRecord
-  class CompositeKeyError < StandardError #:nodoc:
-  end
-
-  class Base
-    INVALID_FOR_COMPOSITE_KEYS = 'Not appropriate for composite primary keys'
-    NOT_IMPLEMENTED_YET        = 'Not implemented for composite primary keys yet'
-
-    class << self
-      def set_primary_keys(*keys)
-        keys = keys.first if keys.first.is_a?(Array)
-
-        if keys.length == 1
-          set_primary_key(keys.first)
-          return
-        end
-
-        cattr_accessor :primary_keys
-        self.primary_keys = keys.map { |k| k.to_sym }
-
-        class_eval <<-EOV
-          extend CompositeClassMethods
-          include CompositeInstanceMethods
-          include CompositePrimaryKeys::ActiveRecord::AssociationPreload
-        EOV
-      end
-
-      def composite?
-        false
-      end
-    end
-
-    def composite?
-      self.class.composite?
-    end
-
-    def [](attr_name)
-      # CPK
-      if attr_name.is_a?(String) and attr_name != attr_name.split(CompositePrimaryKeys::ID_SEP).first
-        attr_name = attr_name.split(CompositePrimaryKeys::ID_SEP)
-      end
-
-      # CPK
-      if attr_name.is_a?(Array)
-        values = attr_name.map {|name| read_attribute(name)}
-        CompositePrimaryKeys::CompositeKeys.new(values)
-      else
-        read_attribute(attr_name)
-      end
-    end
-
-    def []=(attr_name, value)
-      # CPK
-      if attr_name.is_a?(String) and attr_name != attr_name.split(CompositePrimaryKeys::ID_SEP).first
-        attr_name = attr_name.split(CompositePrimaryKeys::ID_SEP)
-      end
-
-      if attr_name.is_a? Array
-        unless value.length == attr_name.length
-          raise "Number of attr_names and values do not match"
-        end
-        [attr_name, value].transpose.map {|name,val| write_attribute(name, val)}
-        value
-      else
-         write_attribute(attr_name, value)
-      end
-    end
-    
-    module CompositeClassMethods
-      def primary_key
-        primary_keys
-      end
-
-      def primary_key=(keys)
-        primary_keys = keys
-      end
-
-      def composite?
-        true
-      end
-
-      #ids_to_s([[1,2],[7,3]]) -> "(1,2),(7,3)"
-      #ids_to_s([[1,2],[7,3]], ',', ';') -> "1,2;7,3"
-      def ids_to_s(many_ids, id_sep = CompositePrimaryKeys::ID_SEP, list_sep = ',', left_bracket = '(', right_bracket = ')')
-        many_ids.map {|ids| "#{left_bracket}#{CompositePrimaryKeys::CompositeKeys.new(ids)}#{right_bracket}"}.join(list_sep)
-      end
-
-      def relation #:nodoc:
-        @relation ||= begin
-          result = Relation.new(self, arel_table)
-          # CPK
-          class << result
-            include CompositePrimaryKeys::ActiveRecord::FinderMethods::InstanceMethods
-            include CompositePrimaryKeys::ActiveRecord::Relation::InstanceMethods
-          end
-          result
-        end
-
-        finder_needs_type_condition? ? @relation.where(type_condition) : @relation
-      end
-    end
-
-    module CompositeInstanceMethods
-      # A model instance's primary keys is always available as model.ids
-      # whether you name it the default 'id' or set it to something else.
-      def id
-        attr_names = self.class.primary_keys
-        ::CompositePrimaryKeys::CompositeKeys.new(attr_names.map { |attr_name| read_attribute(attr_name) })
-      end
-      alias_method :ids, :id
-
-      def ids_hash
-        self.class.primary_key.zip(ids).inject(Hash.new) do |hash, (key, value)|
-          hash[key] = value
-          hash
-        end
-      end
-
-      def to_param
-        id.join(CompositePrimaryKeys::ID_SEP)
-      end
-
-      def id_before_type_cast #:nodoc:
-        raise CompositeKeyError, CompositePrimaryKeys::ActiveRecord::Base::NOT_IMPLEMENTED_YET
-      end
-
-      def quoted_id #:nodoc:
-        [self.class.primary_keys, ids].
-          transpose.
-          map {|attr_name,id| quote_value(id, column_for_attribute(attr_name))}.
-          to_composite_ids
-      end
-
-      # Sets the primary ID.
-      def id=(ids)
-        ids = ids.split(CompositePrimaryKeys::ID_SEP) if ids.is_a?(String)
-        ids.flatten!
-        unless ids.is_a?(Array) and ids.length == self.class.primary_keys.length
-          raise "#{self.class}.id= requires #{self.class.primary_keys.length} ids"
-        end
-        [primary_keys, ids].transpose.each {|key, an_id| write_attribute(key , an_id)}
-        id
-      end
-
-      # Cloned objects have no id assigned and are treated as new records. Note that this is a "shallow" clone
-      # as it copies the object's attributes only, not its associations. The extent of a "deep" clone is
-      # application specific and is therefore left to the application to implement according to its need.
-      def initialize_copy(other)
-        # Think the assertion which fails if the after_initialize callback goes at the end of the method is wrong. The
-        # deleted clone method called new which therefore called the after_initialize callback. It then went on to copy
-        # over the attributes. But if it's copying the attributes afterwards then it hasn't finished initializing right?
-        # For example in the test suite the topic model's after_initialize method sets the author_email_address to
-        # test@test.com. I would have thought this would mean that all cloned models would have an author email address
-        # of test@test.com. However the test_clone test method seems to test that this is not the case. As a result the
-        # after_initialize callback has to be run *before* the copying of the atrributes rather than afterwards in order
-        # for all tests to pass. This makes no sense to me.
-        callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
-        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
-        # CPK
-        #cloned_attributes.delete(self.class.primary_key)
-        self.class.primary_key.each {|key| cloned_attributes.delete(key.to_s)}
-
-        @attributes = cloned_attributes
-        clear_aggregation_cache
-        @attributes_cache = {}
-        @new_record = true
-        ensure_proper_type
-
-        if scope = self.class.send(:current_scoped_methods)
-          create_with = scope.scope_for_create
-          create_with.each { |att,value| self.send("#{att}=", value) } if create_with
-        end
-      end
-
-      def destroy
-        if persisted?
-          # CPK
-          # self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).delete_all
-          self.class.unscoped.where(ids_hash).delete_all
-        end
-
-        @destroyed = true
-        freeze
-      end
-
-      def update(attribute_names = @attributes.keys)
-        attributes_with_values = arel_attributes_values(false, false, attribute_names)
-        return 0 if attributes_with_values.empty?
-        # CPK
-        # self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).arel.update(attributes_with_values)
-        self.class.unscoped.where(ids_hash).arel.update(attributes_with_values)
-      end
-    end
-  end
+module ActiveRecord
+  class CompositeKeyError < StandardError #:nodoc:
+  end
+
+  class Base
+    INVALID_FOR_COMPOSITE_KEYS = 'Not appropriate for composite primary keys'
+    NOT_IMPLEMENTED_YET        = 'Not implemented for composite primary keys yet'
+
+    class << self
+      def set_primary_keys(*keys)
+        keys = keys.first if keys.first.is_a?(Array)
+
+        if keys.length == 1
+          set_primary_key(keys.first)
+          return
+        end
+
+        cattr_accessor :primary_keys
+        self.primary_keys = keys.map { |k| k.to_sym }
+
+        class_eval <<-EOV
+          extend CompositeClassMethods
+          include CompositeInstanceMethods
+          include CompositePrimaryKeys::ActiveRecord::AssociationPreload
+        EOV
+      end
+
+      def composite?
+        false
+      end
+    end
+
+    def composite?
+      self.class.composite?
+    end
+
+    def [](attr_name)
+      # CPK
+      if attr_name.is_a?(String) and attr_name != attr_name.split(CompositePrimaryKeys::ID_SEP).first
+        attr_name = attr_name.split(CompositePrimaryKeys::ID_SEP)
+      end
+
+      # CPK
+      if attr_name.is_a?(Array)
+        values = attr_name.map {|name| read_attribute(name)}
+        CompositePrimaryKeys::CompositeKeys.new(values)
+      else
+        read_attribute(attr_name)
+      end
+    end
+
+    def []=(attr_name, value)
+      # CPK
+      if attr_name.is_a?(String) and attr_name != attr_name.split(CompositePrimaryKeys::ID_SEP).first
+        attr_name = attr_name.split(CompositePrimaryKeys::ID_SEP)
+      end
+
+      if attr_name.is_a? Array
+        unless value.length == attr_name.length
+          raise "Number of attr_names and values do not match"
+        end
+        [attr_name, value].transpose.map {|name,val| write_attribute(name, val)}
+        value
+      else
+         write_attribute(attr_name, value)
+      end
+    end
+    
+    module CompositeClassMethods
+      def primary_key
+        primary_keys
+      end
+
+      def primary_key=(keys)
+        primary_keys = keys
+      end
+
+      def composite?
+        true
+      end
+
+      #ids_to_s([[1,2],[7,3]]) -> "(1,2),(7,3)"
+      #ids_to_s([[1,2],[7,3]], ',', ';') -> "1,2;7,3"
+      def ids_to_s(many_ids, id_sep = CompositePrimaryKeys::ID_SEP, list_sep = ',', left_bracket = '(', right_bracket = ')')
+        many_ids.map {|ids| "#{left_bracket}#{CompositePrimaryKeys::CompositeKeys.new(ids)}#{right_bracket}"}.join(list_sep)
+      end
+
+      def relation #:nodoc:
+        @relation ||= begin
+          result = Relation.new(self, arel_table)
+          # CPK
+          class << result
+            include CompositePrimaryKeys::ActiveRecord::FinderMethods::InstanceMethods
+            include CompositePrimaryKeys::ActiveRecord::Relation::InstanceMethods
+          end
+          result
+        end
+
+        finder_needs_type_condition? ? @relation.where(type_condition) : @relation
+      end
+    end
+
+    module CompositeInstanceMethods
+      # A model instance's primary keys is always available as model.ids
+      # whether you name it the default 'id' or set it to something else.
+      def id
+        attr_names = self.class.primary_keys
+        ::CompositePrimaryKeys::CompositeKeys.new(attr_names.map { |attr_name| read_attribute(attr_name) })
+      end
+      alias_method :ids, :id
+
+      def ids_hash
+        self.class.primary_key.zip(ids).inject(Hash.new) do |hash, (key, value)|
+          hash[key] = value
+          hash
+        end
+      end
+
+      def id_before_type_cast #:nodoc:
+        raise CompositeKeyError, CompositePrimaryKeys::ActiveRecord::Base::NOT_IMPLEMENTED_YET
+      end
+
+      def quoted_id #:nodoc:
+        [self.class.primary_keys, ids].
+          transpose.
+          map {|attr_name,id| quote_value(id, column_for_attribute(attr_name))}.
+          to_composite_ids
+      end
+
+      # Sets the primary ID.
+      def id=(ids)
+        ids = ids.split(CompositePrimaryKeys::ID_SEP) if ids.is_a?(String)
+        ids.flatten!
+        unless ids.is_a?(Array) and ids.length == self.class.primary_keys.length
+          raise "#{self.class}.id= requires #{self.class.primary_keys.length} ids"
+        end
+        [primary_keys, ids].transpose.each {|key, an_id| write_attribute(key , an_id)}
+        id
+      end
+
+      # Cloned objects have no id assigned and are treated as new records. Note that this is a "shallow" clone
+      # as it copies the object's attributes only, not its associations. The extent of a "deep" clone is
+      # application specific and is therefore left to the application to implement according to its need.
+      def initialize_copy(other)
+        # Think the assertion which fails if the after_initialize callback goes at the end of the method is wrong. The
+        # deleted clone method called new which therefore called the after_initialize callback. It then went on to copy
+        # over the attributes. But if it's copying the attributes afterwards then it hasn't finished initializing right?
+        # For example in the test suite the topic model's after_initialize method sets the author_email_address to
+        # test@test.com. I would have thought this would mean that all cloned models would have an author email address
+        # of test@test.com. However the test_clone test method seems to test that this is not the case. As a result the
+        # after_initialize callback has to be run *before* the copying of the atrributes rather than afterwards in order
+        # for all tests to pass. This makes no sense to me.
+        callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
+        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
+        # CPK
+        #cloned_attributes.delete(self.class.primary_key)
+        self.class.primary_key.each {|key| cloned_attributes.delete(key.to_s)}
+
+        @attributes = cloned_attributes
+        clear_aggregation_cache
+        @attributes_cache = {}
+        @new_record = true
+        ensure_proper_type
+
+        if scope = self.class.send(:current_scoped_methods)
+          create_with = scope.scope_for_create
+          create_with.each { |att,value| self.send("#{att}=", value) } if create_with
+        end
+      end
+
+      def destroy
+        if persisted?
+          # CPK
+          # self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).delete_all
+          self.class.unscoped.where(ids_hash).delete_all
+        end
+
+        @destroyed = true
+        freeze
+      end
+
+      def update(attribute_names = @attributes.keys)
+        attributes_with_values = arel_attributes_values(false, false, attribute_names)
+        return 0 if attributes_with_values.empty?
+        # CPK
+        # self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).arel.update(attributes_with_values)
+        self.class.unscoped.where(ids_hash).arel.update(attributes_with_values)
+      end
+    end
+  end
 end