composite_primary_keys 6.0.5 → 6.0.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTRiYTBhMGQzN2IxNDdkMGZhNjE1MGQ3NDc2ZWZkYTI2NWQ2Nzg1ZQ==
-  data.tar.gz: !binary |-
-    YzNmMGQzNmIxODQ1NTk1ODk1ZDJjMTk4OTg4NDIxZDZlM2I5NzI4Nw==
+SHA1:
+  metadata.gz: cf7821e1dce524f20a81e982faa1042c1bb5cf0b
+  data.tar.gz: 5112714e5ae73ba0335ac34aca8a7f5f699ba6a3
 SHA512:
-  metadata.gz: !binary |-
-    MWYyNTQwMDYyNTgxYmMyM2FjMTdlMjg2ZWU5Yjg4OTZjOTc5YzIzNzRlZDAx
-    MjhmNzk3NzI4NjFmOTc3OWVhMDY4ZThhYjI2NDhiMDQ3YzM0MTA1ZWQzOGM3
-    ZWZjOWE2NDhlNGJkZGU2MGI1Mjk1ZDJmODU2MDIzOTQ0NjExZDU=
-  data.tar.gz: !binary |-
-    NTZmZTQ0ZTNlYjhiZjBmYmE5YWEwZDNkMjViMTM0YjIyYTc1NDRhOTQ3YWU1
-    YzlmMTdkZDc3MmIxNDMwYTUwYWIyOWMwM2IzYzM2YTI3MzVlNmI3YzUzZTVk
-    YmIxZWJjNzc4YWU0YWE3YmRhZjVlODJjMGQwYzZmNWIwMGZmYWM=
+  metadata.gz: 9944a233a344edfdf63b0bd1dfadf70074f241d4b1cce209aa1280307693e124d09b1bd54907ab94f7a23731c8e8b6ab693dee2246eb65475385a478728c5efd
+  data.tar.gz: 7ec24c0880bbab735c1491bd3e6891692974190150deebfe57a7347502718d751f42f7a44ef28fd9161a3a47bb16721244bf7b829d3a0c6b29d7c7e60c8787a4

data/History.rdoc

@@ -1,3 +1,15 @@
+== 6.0.6 (2014-05-26)
+
+* Don't refer to deprecated set_primary_keys in README (Henare Degan)
+* Fix gemspec dependency (Charlie Savage)
+
+== 6.0.5 (2014-05-20)
+
+* Removed debugging output (Dan Draper)
+* Fixes to ensure that has_one associations work correctly (Dan Draper)
+* Fix postgres db migration failure since no result is returned in some cases (seashell-qd)
+* Fix exception raised in method "id=" (seashell.qd@hotmail.com)
+
 == 6.0.3 (2014-04-28)
 
 * Fixes setting of primary key when CPK is not used for a given model (see #191)

data/README.rdoc

@@ -2,54 +2,100 @@
 
 == Summary
 
-ActiveRecords/Rails famously doesn't support composite primary keys.
-This RubyGem extends the activerecord gem to provide CPK support.
+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 verison 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 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
+
+== 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
 
-    require 'composite_primary_keys'
-    class ProductVariation < ActiveRecord::Base
-      self.primary_keys = :product_id, :variation_seq
-    end
+Once you’ve created your models to specify composite primary keys (such as the Membership class)
+and associations (such as MembershipStatus#membership), you can uses them like any normal model
+with associations.
 
-    pv = ProductVariation.find(345, 12)
+But first, lets check out our primary keys.
 
-== Factories
+  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"
 
-    class ModelWithCompositeKeys < ActiveRecord::Base
-      set_primary_keys :id, :updated_at
-    end
+Now we want to be able to find instances using the same syntax we always use for ActiveRecords…
 
-    FactoryGirl.define do
-      factory :model_with_composite_keys do
-        sequence( :id ) { |n| [n,Time.now] }
-        name "Brett"
-      end
-    end
+  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"}>
 
-It even supports composite foreign keys for associations.
+Notice the use of an array to specify the composite key values.
 
-See http://compositekeys.rubyforge.org for more.
+== Databases
 
-== Running Tests
+CPK supports the following databases:
 
-See test/README_tests.rdoc
+ * PostgreSQL
+ * MySQL
+ * Oracle
+ * DB2
+ * SQLite
+ * SQLServer
 
-== Url
+== Running Tests
 
-http://compositekeys.rubyforge.org
+See test/README_tests.rdoc
 
 == Questions, Discussion and Contributions
 
-http://groups.google.com/group/compositekeys
+The CPK home page is hosted at https://github.com/composite-primary-keys/composite_primary_keys.  There
+is also a Google group at https://groups.google.com/forum/#!forum/compositekeys,
+but you'll have better luck getting support using GitHub.
 
 == Author
 
-Written by Dr Nic Williams, drnicwilliams@gmail.
-Contributions by many!
+First version was written by Dr Nic Williams.
 
+Maintained by Charlie Savage
+
+Contributions by many!

data/lib/composite_primary_keys/version.rb

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

data/test/abstract_unit.rb

@@ -1,14 +1,12 @@
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 
-require 'active_support/test_case'
-require 'minitest/autorun'
-require 'minitest/reporters'
-MiniTest::Reporters.use!
-
 # To make debugging easier, test within this source tree versus an installed gem
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 require 'composite_primary_keys'
 
+require 'active_support/test_case'
+require 'minitest/autorun'
+
 # Now load the connection spec
 require File.join(PROJECT_ROOT, "test", "connections", "connection_spec")
 

data/test/connections/databases.yml

@@ -1,18 +1,9 @@
 # To run tests:
 #  1. Copy this file to test/connections/databases.yml.
 #  2. Update to match the databases you want to test against.
-
-mysql:
-  adapter: mysql2
-  username: root
-  database: composite_primary_keys_unittest
-
-sqlite3:
-  adapter: sqlite3
-  database: db/composite_primary_keys_unittest.sqlite
-
+#  3. Build the database using rake <databasename>:build_database
 postgresql:
   adapter: postgresql
   database: composite_primary_keys_unittest
-  username: daniel
+  username: postgres
   host: localhost

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: composite_primary_keys
 version: !ruby/object:Gem::Version
-  version: 6.0.5
+  version: 6.0.6
 platform: ruby
 authors:
 - Dr Nic Williams
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0
 description: Composite key support for ActiveRecord
@@ -197,12 +197,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -218,8 +218,8 @@ test_files:
 - test/setup.rb
 - test/test_aliases.rb
 - test/test_associations.rb
-- test/test_attribute_methods.rb
 - test/test_attributes.rb
+- test/test_attribute_methods.rb
 - test/test_calculations.rb
 - test/test_composite_arrays.rb
 - test/test_counter_cache.rb