composite_primary_keys 13.0.0 → 14.0.2

data/README.rdoc

@@ -1,181 +1,182 @@
-= Composite Primary Keys for ActiveRecords
-
-== Summary
-
-ActiveRecords infamously doesn't support composite primary keys.
-This gem, composite_primary_keys, or CPK for short, extends ActiveRecord
-to support composite keys.
-
-== Installation
-
-    gem install composite_primary_keys
-
-If you are using Rails add the following to your Gemfile:
-
-  gem 'composite_primary_keys', '=x.x.x' (see next section about what version to use)
-
-== Versions
-
-Every major version of ActiveRecord has included numerous internal changes.  As a result,
-CPK has to be rewritten for each version of ActiveRecord.  To help keep
-things straight, here is the mapping:
-
-    Version 13.x is designed to work with ActiveRecord 6.1.x
-    Version 12.x is designed to work with ActiveRecord 6.0.x
-    Version 11.x is designed to work with ActiveRecord 5.2.x
-    Version 10.x is designed to work with ActiveRecord 5.1.x
-    Version  9.x is designed to work with ActiveRecord 5.0.x
-    Version  8.x is designed to work with ActiveRecord 4.2.x
-    Version  7.x is designed to work with ActiveRecord 4.1.x
-    Version  6.x is designed to work with ActiveRecord 4.0.x
-    Version  5.x is designed to work with ActiveRecord 3.2.x
-    Version  4.x is designed to work with ActiveRecord 3.1.x
-
-Run the following command to list available versions:
-
-    gem list composite_primary_keys -ra
-
-== The basics
-
-A model with composite primary keys is defined like this:
-
-  class Membership < ActiveRecord::Base
-    self.primary_keys = :user_id, :group_id
-    belongs_to :user
-    belongs_to :group
-    has_many :statuses, :class_name => 'MembershipStatus', :foreign_key => [:user_id, :group_id]
-  end
-
-Note the addition of the line:
-
-    self.primary_keys = :user_id, :group_id
-
-
-A model associated with a composite key model is defined like this:
-
-  class MembershipStatus < ActiveRecord::Base
-    belongs_to :membership, :foreign_key => [:user_id, :group_id]
-  end
-
-That is, associations can include composite keys too.  All Rails association types are supported. Nice.
-
-== Usage
-
-Once you’ve created your models to specify composite primary keys (such as the Membership class)
-and associations (such as MembershipStatus#membership), you can use them like any normal model
-with associations.
-
-But first, lets check out our primary keys.
-
-  MembershipStatus.primary_key # => "id"    # normal single key
-  Membership.primary_key  # => [:user_id, :group_id] # composite keys
-  Membership.primary_key.to_s # => "user_id,group_id"
-
-Now we want to be able to find instances using the same syntax we always use for ActiveRecords…
-
-  MembershipStatus.find(1)    # single id returns single instance
-  => <MembershipStatus:0x392a8c8 @attributes={"id"=>"1", "status"=>"Active"}>
-
-  Membership.find([1,1])  # composite ids returns single instance
-  => <Membership:0x39218b0 @attributes={"user_id"=>"1", "group_id"=>"1"}>
-
-Notice the use of an array to specify the composite key values.
-
-NOTE - API CHANGE.  CPK Version 6.x and earlier used to allow composite keys to be listed out
-like this:
-
-  Membership.find(1,1)
-
-This usage is no longer supported.
-
-== Databases
-
-CPK supports the following databases:
-
- * PostgreSQL
- * MySQL
- * MariaDB
- * Oracle
- * DB2
- * SQLite
- * SQLServer
-
-== Tests
-
-To run tests you first need to install the appropriate gems for the database you want to test.  Database gems are
-divided into the following bundler groups:
-
- * mysql
- * oracle
- * postgresql
- * sqlite
- * sqlserver
-
-Since it is likely you do not have all the above databases installed on your computer, you want to install just the
-gems for your database.  For example, to test postgresql you would install the appropriate gems like this:
-
-  bundler config set --local without "mysql oracle sqlite sqlserver"
-  bundler install
-
-Once you have installed the appropriate gems, the next step is to create the test database. There is a rake
-command for each database. Using our example:
-
-  rake postgresql:build_database
-
-You can also rebuild the database if it already exists using this command:
-
-  rake postgresql:rebuild_database
-
-To get a list of commands for your database use:
-
-  Rake -T
-
-Finally, to run tests:
-
-  rake postgresql:test
-
-Travis build status: {<img src="https://travis-ci.com/composite-primary-keys/composite_primary_keys.svg" alt="Build Status" />}[https://travis-ci.com/composite-primary-keys/composite_primary_keys]
-
-=== DB2
-
-DB2 is no longer supported due to difficulties in getting the ibm_db2 gem to build.  Thus tests
-have not been run against db2.
-
-=== MariaDb (mysql)
-
-MariaDb is fully supported with all tests passing.
-
-=== Oracle
-
-Oracle is fully supported with all tests passing.
-
-=== Postgresql
-
-Postgresql is fully supported with all tests passing.
-
-=== Sqlite 3
-
-The sqlite database is created at the path composite_primary_keys/db.  Note you must *first* create the database using the
-built-in rake task before running tests:
-
-  rake sqlite:build_database
-
-For sqlite3 to work correctly, you must manually require 'composite_primary_keys/connection_adapters/sqlite3_adapter' after
-loading the CPK gem.
-
-=== SqlServer
-
-SqlServer is partially supported.  There are a number of failing tests - patches welcomed.
-
-== Questions, Discussion and Contributions
-
-For help please visit https://github.com/composite-primary-keys/composite_primary_keys.
-
-== Author
-
-First version was written by Dr Nic Williams.
-
-Maintained by Charlie Savage
-
-Contributions by many!
-
+= Composite Primary Keys for ActiveRecords
+
+== Summary
+
+ActiveRecords infamously doesn't support composite primary keys.
+This gem, composite_primary_keys, or CPK for short, extends ActiveRecord
+to support composite keys.
+
+== Installation
+
+    gem install composite_primary_keys
+
+If you are using Rails add the following to your Gemfile:
+
+  gem 'composite_primary_keys', '=x.x.x' (see next section about what version to use)
+
+== Versions
+
+Every major version of ActiveRecord has included numerous internal changes.  As a result,
+CPK has to be rewritten for each version of ActiveRecord.  To help keep
+things straight, here is the mapping:
+
+    Version 14.x is designed to work with ActiveRecord 7.0.x
+    Version 13.x is designed to work with ActiveRecord 6.1.x
+    Version 12.x is designed to work with ActiveRecord 6.0.x
+    Version 11.x is designed to work with ActiveRecord 5.2.x
+    Version 10.x is designed to work with ActiveRecord 5.1.x
+    Version  9.x is designed to work with ActiveRecord 5.0.x
+    Version  8.x is designed to work with ActiveRecord 4.2.x
+    Version  7.x is designed to work with ActiveRecord 4.1.x
+    Version  6.x is designed to work with ActiveRecord 4.0.x
+    Version  5.x is designed to work with ActiveRecord 3.2.x
+    Version  4.x is designed to work with ActiveRecord 3.1.x
+
+Run the following command to list available versions:
+
+    gem list composite_primary_keys -ra
+
+== The basics
+
+A model with composite primary keys is defined like this:
+
+  class Membership < ActiveRecord::Base
+    self.primary_keys = :user_id, :group_id
+    belongs_to :user
+    belongs_to :group
+    has_many :statuses, :class_name => 'MembershipStatus', :foreign_key => [:user_id, :group_id]
+  end
+
+Note the addition of the line:
+
+    self.primary_keys = :user_id, :group_id
+
+
+A model associated with a composite key model is defined like this:
+
+  class MembershipStatus < ActiveRecord::Base
+    belongs_to :membership, :foreign_key => [:user_id, :group_id]
+  end
+
+That is, associations can include composite keys too.  All Rails association types are supported. Nice.
+
+== Usage
+
+Once you’ve created your models to specify composite primary keys (such as the Membership class)
+and associations (such as MembershipStatus#membership), you can use them like any normal model
+with associations.
+
+But first, lets check out our primary keys.
+
+  MembershipStatus.primary_key # => "id"    # normal single key
+  Membership.primary_key  # => [:user_id, :group_id] # composite keys
+  Membership.primary_key.to_s # => "user_id,group_id"
+
+Now we want to be able to find instances using the same syntax we always use for ActiveRecords…
+
+  MembershipStatus.find(1)    # single id returns single instance
+  => <MembershipStatus:0x392a8c8 @attributes={"id"=>"1", "status"=>"Active"}>
+
+  Membership.find([1,1])  # composite ids returns single instance
+  => <Membership:0x39218b0 @attributes={"user_id"=>"1", "group_id"=>"1"}>
+
+Notice the use of an array to specify the composite key values.
+
+NOTE - API CHANGE.  CPK Version 6.x and earlier used to allow composite keys to be listed out
+like this:
+
+  Membership.find(1,1)
+
+This usage is no longer supported.
+
+== Databases
+
+CPK supports the following databases:
+
+ * PostgreSQL
+ * MySQL
+ * MariaDB
+ * Oracle
+ * DB2
+ * SQLite
+ * SQLServer
+
+== Tests
+
+To run tests you first need to install the appropriate gems for the database you want to test.  Database gems are
+divided into the following bundler groups:
+
+ * mysql
+ * oracle
+ * postgresql
+ * sqlite
+ * sqlserver
+
+Since it is likely you do not have all the above databases installed on your computer, you want to install just the
+gems for your database.  For example, to test postgresql you would install the appropriate gems like this:
+
+  bundler config set --local without "mysql oracle sqlite sqlserver"
+  bundler install
+
+Once you have installed the appropriate gems, the next step is to create the test database. There is a rake
+command for each database. Using our example:
+
+  rake postgresql:build_database
+
+You can also rebuild the database if it already exists using this command:
+
+  rake postgresql:rebuild_database
+
+To get a list of commands for your database use:
+
+  Rake -T
+
+Finally, to run tests:
+
+  rake postgresql:test
+
+Travis build status: {<img src="https://travis-ci.com/composite-primary-keys/composite_primary_keys.svg" alt="Build Status" />}[https://travis-ci.com/composite-primary-keys/composite_primary_keys]
+
+=== DB2
+
+DB2 is no longer supported due to difficulties in getting the ibm_db2 gem to build.  Thus tests
+have not been run against db2.
+
+=== MariaDb (mysql)
+
+MariaDb is fully supported with all tests passing.
+
+=== Oracle
+
+Oracle is fully supported with all tests passing.
+
+=== Postgresql
+
+Postgresql is fully supported with all tests passing.
+
+=== Sqlite 3
+
+The sqlite database is created at the path composite_primary_keys/db.  Note you must *first* create the database using the
+built-in rake task before running tests:
+
+  rake sqlite:build_database
+
+For sqlite3 to work correctly, you must manually require 'composite_primary_keys/connection_adapters/sqlite3_adapter' after
+loading the CPK gem.
+
+=== SqlServer
+
+SqlServer is partially supported.  There are a number of failing tests - patches welcomed.
+
+== Questions, Discussion and Contributions
+
+For help please visit https://github.com/composite-primary-keys/composite_primary_keys.
+
+== Author
+
+First version was written by Dr Nic Williams.
+
+Maintained by Charlie Savage
+
+Contributions by many!
+

data/Rakefile

@@ -1,37 +1,37 @@
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rubygems/package_task'
-
-# Set global variable so other tasks can access them
-::PROJECT_ROOT = File.expand_path(".")
-::GEM_NAME = 'composite_primary_keys'
-
-require File.join(PROJECT_ROOT, 'lib', 'composite_primary_keys')
-require File.join(PROJECT_ROOT, 'test', 'connections', 'connection_spec')
-
-# Read the spec file
-spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
-
-# Setup Rake tasks for managing the gem
-Gem::PackageTask.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
-
-# Set up test tasks for each supported connection adapter
-%w(mysql sqlite oracle oracle_enhanced postgresql ibm_db sqlserver).each do |adapter|
-  namespace adapter do
-    desc "Run tests using the #{adapter} adapter"
-    task "test" do
-      ENV["ADAPTER"] = adapter
-      Rake::TestTask.new("subtest_#{adapter}") do |t|
-        t.libs << "test"
-      end
-      Rake::Task["subtest_#{adapter}"].invoke
-    end
-  end
-end
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rubygems/package_task'
+
+# Set global variable so other tasks can access them
+::PROJECT_ROOT = File.expand_path(".")
+::GEM_NAME = 'composite_primary_keys'
+
+require File.join(PROJECT_ROOT, 'lib', 'composite_primary_keys')
+require File.join(PROJECT_ROOT, 'test', 'connections', 'connection_spec')
+
+# Read the spec file
+spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
+
+# Setup Rake tasks for managing the gem
+Gem::PackageTask.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
+
+# Set up test tasks for each supported connection adapter
+%w(mysql sqlite oracle oracle_enhanced postgresql ibm_db sqlserver).each do |adapter|
+  namespace adapter do
+    desc "Run tests using the #{adapter} adapter"
+    task "test" do
+      ENV["ADAPTER"] = adapter
+      Rake::TestTask.new("subtest_#{adapter}") do |t|
+        t.libs << "test"
+      end
+      Rake::Task["subtest_#{adapter}"].invoke
+    end
+  end
+end

data/lib/composite_primary_keys/arel/sqlserver.rb

@@ -1,37 +1,37 @@
-module Arel
-  module Visitors
-    class SQLServer < Arel::Visitors::ToSql
-      def make_Fetch_Possible_And_Deterministic o
-        return if o.limit.nil? && o.offset.nil?
-        t = table_From_Statement o
-        pk = primary_Key_From_Table t
-        return unless pk
-        if o.orders.empty?
-          # Prefer deterministic vs a simple `(SELECT NULL)` expr.
-          # CPK
-          #o.orders = [pk.asc]
-          o.orders = pk.map {|a_pk| a_pk.asc}
-        end
-      end
-
-      def primary_Key_From_Table t
-        return unless t
-        column_name = @connection.schema_cache.primary_keys(t.name) ||
-          @connection.schema_cache.columns_hash(t.name).first.try(:second).try(:name)
-
-        # CPK
-        # column_name ? t[column_name] : nil
-        case column_name
-          when Array
-            column_name.map do |name|
-              t[name]
-            end
-          when NilClass
-            nil
-          else
-            [t[column_name]]
-        end
-      end
-    end
-  end
-end
+module Arel
+  module Visitors
+    class SQLServer < Arel::Visitors::ToSql
+      def make_Fetch_Possible_And_Deterministic o
+        return if o.limit.nil? && o.offset.nil?
+        t = table_From_Statement o
+        pk = primary_Key_From_Table t
+        return unless pk
+        if o.orders.empty?
+          # Prefer deterministic vs a simple `(SELECT NULL)` expr.
+          # CPK
+          #o.orders = [pk.asc]
+          o.orders = pk.map {|a_pk| a_pk.asc}
+        end
+      end
+
+      def primary_Key_From_Table t
+        return unless t
+        column_name = @connection.schema_cache.primary_keys(t.name) ||
+          @connection.schema_cache.columns_hash(t.name).first.try(:second).try(:name)
+
+        # CPK
+        # column_name ? t[column_name] : nil
+        case column_name
+          when Array
+            column_name.map do |name|
+              t[name]
+            end
+          when NilClass
+            nil
+          else
+            [t[column_name]]
+        end
+      end
+    end
+  end
+end

data/lib/composite_primary_keys/arel/to_sql.rb

@@ -1,18 +1,18 @@
-module Arel
-  module Visitors
-    class ToSql
-      def visit_CompositePrimaryKeys_CompositeKeys o, collector
-        values = o.map do |key|
-          case key
-            when Arel::Attributes::Attribute
-              "#{key.relation.name}.#{key.name}"
-            else
-              key
-          end
-        end
-        collector << "(#{values.join(', ')})"
-        collector
-      end
-    end
-  end
-end
+module Arel
+  module Visitors
+    class ToSql
+      def visit_CompositePrimaryKeys_CompositeKeys o, collector
+        values = o.map do |key|
+          case key
+            when Arel::Attributes::Attribute
+              "#{key.relation.name}.#{key.name}"
+            else
+              key
+          end
+        end
+        collector << "(#{values.join(', ')})"
+        collector
+      end
+    end
+  end
+end

data/lib/composite_primary_keys/associations/association.rb

@@ -1,23 +1,23 @@
-module ActiveRecord
-  module Associations
-    class Association
-      def creation_attributes
-        attributes = {}
-
-        if (reflection.has_one? || reflection.collection?) && !options[:through]
-          # CPK
-          # attributes[reflection.foreign_key] = owner[reflection.active_record_primary_key]
-          Array(reflection.foreign_key).zip(Array(reflection.active_record_primary_key)).each do |key1, key2|
-            attributes[key1] = owner[key2]
-          end
-
-          if reflection.options[:as]
-            attributes[reflection.type] = owner.class.base_class.name
-          end
-        end
-
-        attributes
-      end
-    end
-  end
-end
+module ActiveRecord
+  module Associations
+    class Association
+      def creation_attributes
+        attributes = {}
+
+        if (reflection.has_one? || reflection.collection?) && !options[:through]
+          # CPK
+          # attributes[reflection.foreign_key] = owner[reflection.active_record_primary_key]
+          Array(reflection.foreign_key).zip(Array(reflection.active_record_primary_key)).each do |key1, key2|
+            attributes[key1] = owner[key2]
+          end
+
+          if reflection.options[:as]
+            attributes[reflection.type] = owner.class.base_class.name
+          end
+        end
+
+        attributes
+      end
+    end
+  end
+end

data/lib/composite_primary_keys/associations/collection_association.rb

@@ -1,32 +1,32 @@
-module CompositePrimaryKeys
-  module CollectionAssociation
-    def ids_writer(ids)
-      primary_key = reflection.association_primary_key
-      pk_type = klass.type_for_attribute(primary_key)
-      ids = Array(ids).reject(&:blank?)
-      ids.map! { |i| pk_type.cast(i) }
-
-      # CPK-
-      if primary_key.is_a?(Array)
-        predicate = CompositePrimaryKeys::Predicates.cpk_in_predicate(klass.arel_table, reflection.association_primary_key, ids)
-        records = klass.where(predicate).index_by do |r|
-          reflection.association_primary_key.map{ |k| r.send(k) }
-        end.values_at(*ids)
-      else
-        records = klass.where(primary_key => ids).index_by do |r|
-          r.public_send(primary_key)
-        end.values_at(*ids).compact
-      end
-
-      if records.size != ids.size
-        found_ids = records.map { |record| record.public_send(primary_key) }
-        not_found_ids = ids - found_ids
-        klass.all.raise_record_not_found_exception!(ids, records.size, ids.size, primary_key, not_found_ids)
-      else
-        replace(records)
-      end
-    end
-  end
-end
-
+module CompositePrimaryKeys
+  module CollectionAssociation
+    def ids_writer(ids)
+      primary_key = reflection.association_primary_key
+      pk_type = klass.type_for_attribute(primary_key)
+      ids = Array(ids).reject(&:blank?)
+      ids.map! { |i| pk_type.cast(i) }
+
+      # CPK-
+      if primary_key.is_a?(Array)
+        predicate = CompositePrimaryKeys::Predicates.cpk_in_predicate(klass.arel_table, reflection.association_primary_key, ids)
+        records = klass.where(predicate).index_by do |r|
+          reflection.association_primary_key.map{ |k| r.send(k) }
+        end.values_at(*ids)
+      else
+        records = klass.where(primary_key => ids).index_by do |r|
+          r.public_send(primary_key)
+        end.values_at(*ids).compact
+      end
+
+      if records.size != ids.size
+        found_ids = records.map { |record| record.public_send(primary_key) }
+        not_found_ids = ids - found_ids
+        klass.all.raise_record_not_found_exception!(ids, records.size, ids.size, primary_key, not_found_ids)
+      else
+        replace(records)
+      end
+    end
+  end
+end
+
 ActiveRecord::Associations::CollectionAssociation.prepend CompositePrimaryKeys::CollectionAssociation