composite_primary_keys 0.7.5 → 0.8.0

data/website/index.txt

@@ -1,109 +1,113 @@
-h1. Composite Primary Keys for Ruby on Rails/ActiveRecords
+h1. Composite Primary Keys
+
+h1. → Ruby on Rails
+
+h1. → ActiveRecords
 
 h2. What
 
 Ruby on Rails does not support composite primary keys. This free software is an extension 
-to the database layer of Rails - ActiveRecords - to support composite primary keys
-as transparently as possible.
+to the database layer of Rails - "ActiveRecords":http://wiki.rubyonrails.com/rails/pages/ActiveRecord - to support composite primary keys as transparently as possible.
+
+Any Ruby script using ActiveRecords can use Composite Primary Keys with this library.
 
 h2. Installing
 
-<pre syntax="ruby">gem install composite_primary_keys</pre>
+<pre syntax="ruby">sudo gem install composite_primary_keys</pre>
 
-To prepare ActiveRecords for composite primary keys...
+Rails: Add the following to the bottom of your <code>environment.rb</code> file
 
 <pre syntax="ruby">require 'composite_primary_keys'</pre>
 
-A class with composite primary keys would look like...
+Ruby scripts: Add the following to the top of your script
+
+<pre syntax="ruby">require 'rubygems'
+require 'composite_primary_keys'</pre>
+
+h2. The basics
 
-<pre syntax="ruby">class ReferenceCode < ActiveRecord::Base
+A model with composite primary keys would look like...
+
+<pre syntax="ruby">class Membership < ActiveRecord::Base
   # set_primary_keys *keys - turns on composite key functionality
-  set_primary_keys :reference_type_id, :reference_code
-  belongs_to :reference_type, :foreign_key => "reference_type_id"
+  set_primary_keys :user_id, :group_id
+  belongs_to :user
+  belongs_to :group
+  has_many :statuses, :class => 'MembershipStatus', :foreign_key => [:user_id, :group_id]
 end</pre>
 
+A model associated with a composite key model would be defined like...
+
+<pre syntax="ruby">class MembershipStatus < ActiveRecord::Base
+  belongs_to :membership, :foreign_key => [:user_id, :group_id]
+end</pre>
+
+That is, associations can include composite keys too. Nice.
+
+h2. Demonstration of usage
 
-Take two classes - <code syntax="ruby">ReferenceType</code> and <code syntax="ruby">ReferenceCode</code>
- - where ReferenceCode has a *composite primary key*, 
- one of which is a foreign key to a parent ReferenceType.
+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.
 
-<pre syntax="ruby">ReferenceType.primary_key
-=> "reference_type_id"                   # normal single key
-ReferenceCode.primary_key
-=> [:reference_type_id, :reference_code] # composite keys
-ReferenceCode.primary_key.to_s
-=> "reference_type_id,reference_code"</pre>
+But first, lets check out our primary keys.
+
+<pre syntax="ruby">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"</pre>
 
 Now we want to be able to find instances using the same syntax we always use for ActiveRecords...
 
-<pre syntax="ruby">ReferenceType.find 1    # single id returns single instance
-=> <ReferenceType:0x392a8c8 @attributes={"reference_type_id"=>"1", 
-"abbreviation"=>"Name Prefix", "type_label"=>"NAME_PREFIX"}>
-ReferenceCode.find 1,1  # composite ids returns single instance
-=> <ReferenceCode:0x39218b0 @attributes={"reference_type_id"=>"1", 
-"code_label"=>"MR", "abbreviation"=>"Mr", "reference_code"=>"1"}></pre>
+<pre syntax="ruby">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"}></pre>
 
 Using "Ruby on Rails":http://www.rubyonrails.org? You'll want to your url_for helpers
 to convert composite keys into strings and back again...
 
-<pre syntax="ruby">param_id = ReferenceCode.find_first.to_param
-=> "1,1"
-ReferenceCode.find param_id
-=> => <ReferenceCode:0x3904288 @attributes={"reference_type_id"=>"1", 
-"code_label"=>"MR", "abbreviation"=>"Mr", "reference_code"=>"1"}></pre>
+<pre syntax="ruby">Membership.find(:first).to_param # => "1,1"</pre>
 
-That is, an ActiveRecord supporting composite keys should behave transparently
-throughout your application.
+And then use the string id within your controller to find the object again
 
+<pre syntax="ruby">params[:id] # => '1,1'
+Membership.find(params[:id])
+=> <Membership:0x3904288 @attributes={"user_id"=>"1", "group_id"=>"1"}></pre>
 
+That is, an ActiveRecord supporting composite keys behaves transparently
+throughout your application. Just like a normal ActiveRecord.
 
-h2. Associations/Composite Foreign Keys
 
-The <code syntax="ruby">has_many, has_one</code>, and <code syntax="ruby">belongs_to</code> 
-associations allow for composite foreign keys.
+h2. Other tricks
 
-<pre syntax="ruby">
-class Product < ActiveRecord::Base
-  set_primary_key :id  # redundant
-  has_many :product_tariffs, :foreign_key => :product_id
-  has_many :tariffs, :through => :product_tariffs, :foreign_key => :product_id
-end
-class ProductTariff < ActiveRecord::Base
-  set_primary_keys :product_id, :tariff_id, :tariff_start_date
-  belongs_to :products, :foreign_key => :product_id
-  belongs_to :tariffs,  :foreign_key => [:tariff_id, :tariff_start_date]
-end
-class Tariff < ActiveRecord::Base
-  set_primary_keys [:tariff_id, :start_date]
-  has_many :product_tariffs, :foreign_key => [:tariff_id, :tariff_start_date]
-end
-</pre>
+Pass a list of composite ids to the <code>#find</code> method
 
-The Tariff table has a composite primary key. Hence, the 
-<code syntax="ruby">belongs_to</code> association from ProductTariff to Tariff
-(called :tariffs) must use a composite foreign key.
+<pre syntax="ruby">Membership.find [1,1], [2,1]
+=> [
+  <Membership:0x394ade8 @attributes={"user_id"=>"1", "group_id"=>"1"}>, 
+  <Membership:0x394ada0 @attributes={"user_id"=>"2", "group_id"=>"1"}>
+]</pre>
 
-The expression must use the :foreign_key option (NOTE, <code>:foreign_keys</code> is not currently supported)
-to specific the ordered list of table
-columns. If the column names in both tables match, then the :foreign_key
-option can be omitted.
+Perform <code>#count</code> operations
 
-Similarly, the <code syntax="ruby">has_many</code> and <code syntax="ruby">has_one</code>
-commands require the same :foreign_key(s) options if the target table
-doesn't have column names that match its own primary key column names.
+<pre syntax="ruby">MembershipStatus.find(:first).memberships.count # => 1</pre>
 
-The order of foreign keys should match the order of the primary keys in the 
-parent table.
+<a name="dbs"></a>
 
-h2. Other tricks
+h2. Which databases?
 
-<pre syntax="ruby">ReferenceCode.find [2,1], [2,2]  # list of composite ids
-=> [
-  <ReferenceCode:0x394ade8 @attributes={"reference_type_id"=>"2", 
-  "code_label"=>"MALE", "abbreviation"=>"Male", "reference_code"=>"1"}>, 
-  <ReferenceCode:0x394ada0 @attributes={"reference_type_id"=>"2", 
-  "code_label"=>"FEMALE", "abbreviation"=>"Female", "reference_code"=>"2"}>
-]</pre>
+
+A suite of unit tests have been run on the following databases supported by ActiveRecord:
+
+|_.Database|_.Test Success|_.User feedback (since 0.8.0)|
+|mysql     |<span class=success>YES</span>|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=Mysql+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=Mysql+is+failing)|
+|sqlite3   |<span class=success>YES</span> (new 0.8.0)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=Sqlite3+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=Sqlite3+is+failing)|
+|postgresql|<span class=success>YES</span> (new 0.8.0)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=Postgresql+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=Postgresql+is+failing)|
+|oracle    |<span class=unknown>???</span> ("I can help":mailto:compositekeys@googlegroups.com?subject=Help+with+Oracle)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=Oracle+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=Oracle+is+failing)|
+|sqlserver |<span class=unknown>???</span> ("I can help":mailto:compositekeys@googlegroups.com?subject=Help+with+SQLServer)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=SQLServer+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=SQLServer+is+failing)|
+|db2       |<span class=unknown>???</span> ("I can help":mailto:compositekeys@googlegroups.com?subject=Help+with+DB2)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=DB2+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=DB2+is+failing)|
+|firebird  |<span class=unknown>???</span> ("I can help":mailto:compositekeys@googlegroups.com?subject=Help+with+Firebird)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=Firebird+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=Firebird+is+failing)|
+|sybase    |<span class=unknown>???</span> ("I can help":mailto:compositekeys@googlegroups.com?subject=Help+with+Sybase)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=Sybase+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=Sybase+is+failing)|
+|openbase  |<span class=unknown>???</span> ("I can help":mailto:compositekeys@googlegroups.com?subject=Help+with+Openbase)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=Openbase+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=Openbase+is+failing)|
+|frontbase |<span class=unknown>???</span> ("I can help":mailto:compositekeys@googlegroups.com?subject=Help+with+Frontbase)|<span class=unknown>???</span> ("Yes!":mailto:compositekeys@googlegroups.com?subject=Frontbase+is+working or "No...":mailto:compositekeys@googlegroups.com?subject=Frontbase+is+failing)|
 
 h2. Dr Nic's Blog
 

data/website/stylesheets/screen.css

@@ -1,5 +1,5 @@
 body {
-  background-color: #115;
+  background-color: #2F30EE;
   font-family: "Georgia", sans-serif;
   font-size: 16px;
   line-height: 1.6em;
@@ -7,7 +7,7 @@ body {
   color: #eee;
 }
 h1, h2, h3, h4, h5, h6 {
-  color: #77f;
+  color: #FFEDFA;
 }
 h1 { 
   font-family: sans-serif;
@@ -15,6 +15,7 @@ h1 {
   font-size: 4em;
   line-height: 0.8em;
   letter-spacing: -0.1ex;
+	margin: 5px;
 }
 li {
   padding: 0;
@@ -37,7 +38,7 @@ blockquote {
 }
 
 #main {
-  width: 40em;
+  width: 45em;
   padding: 0;
   margin: 0 auto;
 }
@@ -47,6 +48,34 @@ blockquote {
   font-size: smaller;
 }
 
+table {
+  font-size: 90%;
+  line-height: 1.4em;
+  color: #ff8;
+  background-color: #111;
+  padding: 2px 10px 2px 10px;
+	border-style: dashed;
+}
+
+th {
+	color: #fff;
+}
+
+td {
+  padding: 2px 10px 2px 10px;
+}
+
+.success {
+	color: #0CC52B;
+}
+
+.failed {
+	color: #E90A1B;
+}
+
+.unknown {
+	color: #995000;
+}
 pre, code {
   font-family: monospace;
   font-size: 90%;
@@ -75,6 +104,7 @@ pre, code {
   color: #66f;
   padding: 15px 20px 10px 20px;
   margin: 0 auto;
+	margin-top: 15px;
   border: 3px solid #66f;
 }
 

data/website/version-raw.js

@@ -1,3 +1,3 @@
 // Announcement JS file
-var version = "0.7.4";
+var version = "0.8.0";
 MagicAnnouncement.show('compositekeys', version);

data/website/version.js

@@ -1,4 +1,4 @@
 // Version JS file
-var version = "0.7.4";
+var version = "0.8.0";
 
 document.write(" - " + version);

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.2
 specification_version: 1
 name: composite_primary_keys
 version: !ruby/object:Gem::Version 
-  version: 0.7.5
-date: 2006-11-14 00:00:00 +01:00
-summary: Support for composite primary keys in ActiveRecords
+  version: 0.8.0
+date: 2007-04-07 00:00:00 +02:00
+summary: Composite key support for ActiveRecords
 require_paths: 
 - lib
 email: drnicwilliams@gmail.com
 homepage: http://compositekeys.rubyforge.org
 rubyforge_project: compositekeys
-description: ActiveRecords only support a single primary key, preventing their use on legacy databases where tables have primary keys over 2+ columns. This solution allows an ActiveRecord to be extended to support multiple keys using the class method set_primary_keys.
-autorequire: composite_primary_keys
+description: Composite key support for ActiveRecords
+autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -25,89 +25,103 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Dr Nic Williams
 files: 
+- CHANGELOG
+- Manifest.txt
+- README
 - Rakefile
 - install.rb
-- README
-- CHANGELOG
 - lib/composite_primary_keys.rb
-- lib/composite_primary_keys
-- lib/composite_primary_keys/composite_arrays.rb
-- lib/composite_primary_keys/version.rb
+- lib/composite_primary_keys/associations.rb
 - lib/composite_primary_keys/base.rb
+- lib/composite_primary_keys/calculations.rb
+- lib/composite_primary_keys/composite_arrays.rb
+- lib/composite_primary_keys/connection_adapters/postgresql_adapter.rb
 - lib/composite_primary_keys/fixtures.rb
 - lib/composite_primary_keys/reflection.rb
-- lib/composite_primary_keys/associations.rb
-- test/composite_arrays_test.rb
-- test/hash_tricks.rb
-- test/delete_test.rb
-- test/ids_test.rb
-- test/find_test.rb
-- test/update_test.rb
+- lib/composite_primary_keys/version.rb
+- scripts/txt2html
+- scripts/txt2js
 - test/abstract_unit.rb
-- test/miscellaneous_test.rb
-- test/pagination_test.rb
-- test/dummy_test.rb
-- test/clone_test.rb
-- test/associations_test.rb
-- test/attributes_test.rb
-- test/create_test.rb
-- test/santiago_test.rb
-- test/fixtures
-- test/connections
-- test/fixtures/reference_type.rb
-- test/fixtures/reference_code.rb
-- test/fixtures/reference_types.yml
-- test/fixtures/reference_codes.yml
+- test/composite_arrays_test.rb
+- test/connections/native_mysql/connection.rb
+- test/connections/native_oracle/connection.rb
+- test/connections/native_postgresql/connection.rb
+- test/connections/native_sqlite/connection.rb
+- test/fixtures/article.rb
+- test/fixtures/articles.yml
+- test/fixtures/db_definitions/mysql.sql
+- test/fixtures/db_definitions/postgresql.sql
+- test/fixtures/db_definitions/sqlite.sql
+- test/fixtures/group.rb
+- test/fixtures/groups.yml
+- test/fixtures/membership.rb
+- test/fixtures/membership_status.rb
+- test/fixtures/membership_statuses.yml
+- test/fixtures/memberships.yml
 - test/fixtures/product.rb
 - test/fixtures/product_tariff.rb
-- test/fixtures/tariff.rb
-- test/fixtures/products.yml
-- test/fixtures/tariffs.yml
 - test/fixtures/product_tariffs.yml
+- test/fixtures/products.yml
+- test/fixtures/reading.rb
+- test/fixtures/readings.yml
+- test/fixtures/reference_code.rb
+- test/fixtures/reference_codes.yml
+- test/fixtures/reference_type.rb
+- test/fixtures/reference_types.yml
 - test/fixtures/street.rb
-- test/fixtures/suburb.rb
 - test/fixtures/streets.yml
+- test/fixtures/suburb.rb
 - test/fixtures/suburbs.yml
-- test/fixtures/article.rb
+- test/fixtures/tariff.rb
+- test/fixtures/tariffs.yml
 - test/fixtures/user.rb
-- test/fixtures/reading.rb
-- test/fixtures/articles.yml
 - test/fixtures/users.yml
-- test/fixtures/readings.yml
-- test/fixtures/db_definitions
-- test/fixtures/db_definitions/mysql.drop.sql
-- test/fixtures/db_definitions/mysql.sql
-- test/connections/native_oracle
-- test/connections/native_mysql
-- test/connections/native_oracle/connection.rb
-- test/connections/native_mysql/connection.rb
-- website/index.txt
-- website/template.rhtml
+- test/hash_tricks.rb
+- test/test_associations.rb
+- test/test_attributes.rb
+- test/test_clone.rb
+- test/test_create.rb
+- test/test_delete.rb
+- test/test_dummy.rb
+- test/test_find.rb
+- test/test_ids.rb
+- test/test_miscellaneous.rb
+- test/test_pagination.rb
+- test/test_santiago.rb
+- test/test_tutorial_examle.rb
+- test/test_update.rb
 - website/index.html
-- website/version.js
+- website/index.txt
+- website/javascripts/rounded_corners_lite.inc.js
+- website/stylesheets/screen.css
 - website/template.js
-- website/version.txt
+- website/template.rhtml
 - website/version-raw.js
 - website/version-raw.txt
-- website/javascripts
-- website/stylesheets
-- website/javascripts/rounded_corners_lite.inc.js
-- website/stylesheets/screen.css
-- scripts/rubyforge-orig
-- scripts/rubyforge
-- scripts/http-access2-2.0.6.gem
-- scripts/txt2html
-- scripts/txt2js
-test_files: []
+- website/version.js
+- website/version.txt
+test_files: 
+- test/test_associations.rb
+- test/test_attributes.rb
+- test/test_clone.rb
+- test/test_create.rb
+- test/test_delete.rb
+- test/test_dummy.rb
+- test/test_find.rb
+- test/test_ids.rb
+- test/test_miscellaneous.rb
+- test/test_pagination.rb
+- test/test_santiago.rb
+- test/test_tutorial_examle.rb
+- test/test_update.rb
+rdoc_options: []
+
+extra_rdoc_files: []
 
-rdoc_options: 
-- --main
-- README
-extra_rdoc_files: 
-- README
 executables: []
 
 extensions: []