composite_primary_keys 0.7.5 → 0.8.0

data/Manifest.txt

@@ -0,0 +1,75 @@
+CHANGELOG
+Manifest.txt
+README
+Rakefile
+install.rb
+lib/composite_primary_keys.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/version.rb
+scripts/txt2html
+scripts/txt2js
+test/abstract_unit.rb
+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/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/streets.yml
+test/fixtures/suburb.rb
+test/fixtures/suburbs.yml
+test/fixtures/tariff.rb
+test/fixtures/tariffs.yml
+test/fixtures/user.rb
+test/fixtures/users.yml
+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/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.js
+website/template.rhtml
+website/version-raw.js
+website/version-raw.txt
+website/version.js
+website/version.txt

data/Rakefile

@@ -1,12 +1,56 @@
 require 'rubygems'
 require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
 require File.join(File.dirname(__FILE__), 'lib', 'composite_primary_keys', 'version')
 
+AUTHOR = "Dr Nic Williams"
+EMAIL = "drnicwilliams@gmail.com"
+DESCRIPTION = "Composite key support for ActiveRecords"
+GEM_NAME = "composite_primary_keys" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "compositekeys"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+REV = nil #File.read(".svn/entries")[/committed-rev="(\d+)"/, 1] rescue nil
+VERSION = ENV['VERSION'] || (CompositePrimaryKeys::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "newgem documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERSION) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test*.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  p.extra_deps = [['activerecord', '>= 1.14.3']]  #An array of rubygem dependencies.
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+end
+
 PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
 PKG_NAME      = 'composite_primary_keys'
 PKG_VERSION   = CompositePrimaryKeys::VERSION::STRING + PKG_BUILD
@@ -18,16 +62,10 @@ RUBY_FORGE_PROJECT = "compositekeys"
 RUBY_FORGE_USER    = "nicwilliams"
 
 
-desc "Default Task"
-task :default => [ :test_mysql ] # UNTESTED =, :test_sqlite, :test_postgresql ]
-task :test    => [ :test_mysql ]
-
-# Run the unit tests
-
-for adapter in %w( mysql ) # UNTESTED - postgresql sqlite sqlite3 firebird sqlserver sqlserver_odbc db2 oracle sybase openbase )
+for adapter in %w( mysql sqlite oracle postgresql ) # UNTESTED - firebird sqlserver sqlserver_odbc db2 sybase openbase )
   Rake::TestTask.new("test_#{adapter}") { |t|
     t.libs << "test" << "test/connections/native_#{adapter}"
-    t.pattern = "test/*_test{,_#{adapter}}.rb"
+    t.pattern = "test/test_*.rb"
     t.verbose = true
   }
 end
@@ -37,121 +75,65 @@ SCHEMA_PATH = File.join(File.dirname(__FILE__), *%w(test fixtures db_definitions
 desc 'Build the MySQL test databases'
 task :build_mysql_databases do 
   puts File.join(SCHEMA_PATH, 'mysql.sql')
-  %x( mysqladmin -u root create "#{PKG_NAME}_unittest" )
-  %x( mysql -u root "#{PKG_NAME}_unittest" < #{File.join(SCHEMA_PATH, 'mysql.sql')} )
+  sh %{ mysqladmin -u root create "#{PKG_NAME}_unittest" }
+  sh %{ mysql -u root "#{PKG_NAME}_unittest" < #{File.join(SCHEMA_PATH, 'mysql.sql')} }
 end
 
 desc 'Drop the MySQL test databases'
 task :drop_mysql_databases do 
-  %x( mysqladmin -u root -f drop "#{PKG_NAME}_unittest" )
+  sh %{ mysqladmin -u root -f drop "#{PKG_NAME}_unittest" }
 end
 
 desc 'Rebuild the MySQL test databases'
+
 task :rebuild_mysql_databases => [:drop_mysql_databases, :build_mysql_databases]
 
+desc 'Build the sqlite test databases'
+task :build_sqlite_databases do 
+  file = File.join(SCHEMA_PATH, 'sqlite.sql')
+  cmd = "sqlite3 test.db < #{file}"
+  puts cmd
+  sh %{ #{cmd} }
+end
+
+desc 'Drop the sqlite test databases'
+task :drop_sqlite_databases do 
+  sh %{ rm -f test.db }
+end
+
+desc 'Rebuild the sqlite test databases'
+task :rebuild_sqlite_databases => [:drop_sqlite_databases, :build_sqlite_databases]
+
 desc 'Build the PostgreSQL test databases'
 task :build_postgresql_databases do 
-  %x( createdb "#{PKG_NAME}_unittest" )
-  %x( psql "#{PKG_NAME}_unittest" -f #{File.join(SCHEMA_PATH, 'postgresql.sql')} )
+  sh %{ createdb "#{PKG_NAME}_unittest" }
+  sh %{ psql "#{PKG_NAME}_unittest" -f #{File.join(SCHEMA_PATH, 'postgresql.sql')} }
 end
 
 desc 'Drop the PostgreSQL test databases'
 task :drop_postgresql_databases do 
-  %x( dropdb   "#{PKG_NAME}_unittest" )
+  sh %{ dropdb "#{PKG_NAME}_unittest" }
 end
 
 desc 'Rebuild the PostgreSQL test databases'
 task :rebuild_postgresql_databases => [:drop_postgresql_databases, :build_postgresql_databases]
 
-# Generate the RDoc documentation
-
-Rake::RDocTask.new { |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title    = "Composite Primary Keys -- Composite keys for Active Records/Rails"
-  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
-  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
-  rdoc.rdoc_files.include('README', 'CHANGELOG')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.exclude('lib/active_record/vendor/*')
-  rdoc.rdoc_files.include('dev-utils/*.rb')
-}
-
-# Enhance rdoc task to copy referenced images also
-task :rdoc do
-  FileUtils.mkdir_p "doc/files/examples/"
+desc 'Generate website files'
+task :website_generate do
+  sh %{ ruby scripts/txt2html website/index.txt > website/index.html }
+  sh %{ ruby scripts/txt2js website/version.txt > website/version.js }
+  sh %{ ruby scripts/txt2js website/version-raw.txt > website/version-raw.js }
 end
 
-
-# Create compressed packages
-
-dist_dirs = [ "lib", "test", "website", "scripts" ]
-
-spec = Gem::Specification.new do |s|
-  s.name = PKG_NAME
-  s.version = PKG_VERSION
-  s.summary = "Support for composite primary keys in ActiveRecords"
-  s.description = %q{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.}
-
-  s.files = [ "Rakefile", "install.rb", "README", "CHANGELOG" ]
-  dist_dirs.each do |dir|
-    s.files = s.files + Dir.glob( "#{dir}/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
-  end
-  
-  s.add_dependency('activerecord', '>= 1.14.3' + PKG_BUILD)
-
-  s.require_path = 'lib'
-  s.autorequire = 'composite_primary_keys'
-
-  s.has_rdoc = true
-  s.extra_rdoc_files = %w( README )
-  s.rdoc_options.concat ['--main',  'README']
-  
-  s.author = "Dr Nic Williams"
-  s.email = "drnicwilliams@gmail.com"
-  s.homepage = "http://compositekeys.rubyforge.org"
-  s.rubyforge_project = "compositekeys"
-end
-  
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = false
-  p.need_zip = false
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  local_dir = 'website'
+  sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
 end
 
-task :lines do
-  lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
-
-  for file_name in FileList["lib/composite_primary_keys/**/*.rb"]
-    next if file_name =~ /vendor/
-    f = File.open(file_name)
-
-    while line = f.gets
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
-    end
-    puts "L: #{sprintf("%4d", lines)}, LOC #{sprintf("%4d", codelines)} | #{file_name}"
-    
-    total_lines     += lines
-    total_codelines += codelines
-    
-    lines, codelines = 0, 0
-  end
-
-  puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload] do
 end
-
-
-# Publishing ------------------------------------------------------
-
-desc "Publish the release files to RubyForge."
-task :release => [ :package ] do
-  `ruby scripts/rubyforge login`
-
-  for ext in %w( gem tgz zip )
-    release_command = "ruby scripts/rubyforge add_release #{PKG_NAME} #{PKG_NAME} 'REL #{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}"
-    puts release_command
-    system(release_command)
-  end
-end

data/lib/composite_primary_keys.rb

@@ -39,7 +39,15 @@ require 'composite_primary_keys/composite_arrays'
 require 'composite_primary_keys/associations'
 require 'composite_primary_keys/reflection'
 require 'composite_primary_keys/base'
+require 'composite_primary_keys/calculations'
 
 ActiveRecord::Base.class_eval do
   include CompositePrimaryKeys::ActiveRecord::Base
 end
+
+RAILS_CONNECTION_ADAPTERS.each do |adapter|
+  begin
+    require "composite_primary_keys/connection_adapters/" + adapter + "_adapter"
+  rescue MissingSourceFile
+  end
+end

data/lib/composite_primary_keys/associations.rb

@@ -125,10 +125,12 @@ module ActiveRecord::Associations::ClassMethods
       def composite_association_join
         join = case reflection.macro
           when :has_and_belongs_to_many
+            # TODO replace (keys) = (ids), with key1=id1 and key2=id2
             " LEFT OUTER JOIN %s ON (%s) = (%s) " % [
                table_alias_for(options[:join_table], aliased_join_table_name),
                full_keys(aliased_join_table_name, options[:foreign_key] || reflection.active_record.to_s.classify.foreign_key),
                full_keys(reflection.active_record.table_name, reflection.active_record.primary_key)] +
+           # TODO replace (keys) = (ids), with key1=id1 and key2=id2
             " LEFT OUTER JOIN %s ON (%s) = (%s) " % [
                table_name_and_alias, 
                full_keys(aliased_table_name, klass.primary_key),
@@ -153,10 +155,12 @@ module ActiveRecord::Associations::ClassMethods
                         second_key = options[:foreign_key] || primary_key
                     end
                     
+                    # TODO replace (keys) = (ids), with key1=id1 and key2=id2
                     " LEFT OUTER JOIN %s ON (%s) = (%s) "  % [
                       table_alias_for(through_reflection.klass.table_name, aliased_join_table_name), 
                       full_keys(aliased_join_table_name, through_reflection.primary_key_name),
                       full_keys(parent.aliased_table_name, parent.primary_key)] +
+                    # TODO replace (keys) = (ids), with key1=id1 and key2=id2
                     " LEFT OUTER JOIN %s ON (%s) = (%s) " % [
                       table_name_and_alias,
                       full_keys(aliased_table_name, first_key), 
@@ -171,17 +175,21 @@ module ActiveRecord::Associations::ClassMethods
                 raise AssociationNotSupported, "Polymorphic joins not supported for composite keys"
               else
                 foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
-                " LEFT OUTER JOIN %s ON (%s) = (%s) " % [
+                # TODO replace (keys) = (ids), with key1=id1 and key2=id2
+                " LEFT OUTER JOIN %s ON %s " % [
                   table_name_and_alias,
-                  full_keys(aliased_table_name, foreign_key),
-                  full_keys(parent.aliased_table_name, parent.primary_key)
+                  composite_join_clause(
+                    full_keys(aliased_table_name, foreign_key), 
+                    full_keys(parent.aliased_table_name, parent.primary_key)),
                 ]
             end
           when :belongs_to
-            " LEFT OUTER JOIN %s ON (%s) = (%s) " % [
+            # TODO replace (keys) = (ids), with key1=id1 and key2=id2
+            " LEFT OUTER JOIN %s ON %s " % [
                table_name_and_alias, 
-               full_keys(aliased_table_name, reflection.klass.primary_key),
-               full_keys(parent.aliased_table_name, options[:foreign_key] || klass.to_s.foreign_key)
+               composite_join_clause(
+                 full_keys(aliased_table_name, reflection.klass.primary_key), 
+                 full_keys(parent.aliased_table_name, options[:foreign_key] || klass.to_s.foreign_key)),
               ]
           else
             ""
@@ -197,12 +205,47 @@ module ActiveRecord::Associations::ClassMethods
       def full_keys(table_name, keys)
         keys.collect {|key| "#{table_name}.#{key}"}.join(CompositePrimaryKeys::ID_SEP)
       end
+
+      def composite_join_clause(full_keys1, full_keys2)
+        full_keys1 = full_keys1.split(CompositePrimaryKeys::ID_SEP) if full_keys1.is_a?(String)
+        full_keys2 = full_keys2.split(CompositePrimaryKeys::ID_SEP) if full_keys2.is_a?(String)
+        where_clause = [full_keys1, full_keys2].transpose.map do |key_pair|
+          "#{key_pair.first}=#{key_pair.last}"
+        end.join(" AND ")
+        "(#{where_clause})"
+      end
     end
   end
 end
 
 module ActiveRecord::Associations
   class AssociationProxy #:nodoc:
+    
+    def composite_where_clause(full_keys, ids)
+      full_keys = full_keys.split(CompositePrimaryKeys::ID_SEP) if full_keys.is_a?(String)
+      if ids.is_a?(String)
+        ids = [[ids]]
+      elsif not ids.first.is_a?(Array) # if single comp key passed, turn into an array of 1
+        ids = [ids.to_composite_ids]
+      end
+      where_clause = ids.map do |id_set|
+        transposed = id_set.size == 1 ? [[full_keys, id_set.first]] : [full_keys, id_set].transpose
+        transposed.map do |full_key, id|
+          "#{full_key.to_s}=#{@reflection.klass.sanitize(id)}"
+        end.join(" AND ")
+      end.join(") OR (")
+      "(#{where_clause})"
+    end
+
+    def composite_join_clause(full_keys1, full_keys2)
+      full_keys1 = full_keys1.split(CompositePrimaryKeys::ID_SEP) if full_keys1.is_a?(String)
+      full_keys2 = full_keys2.split(CompositePrimaryKeys::ID_SEP) if full_keys2.is_a?(String)
+      where_clause = [full_keys1, full_keys2].transpose.map do |key_pair|
+        "#{key_pair.first}=#{key_pair.last}"
+      end.join(" AND ")
+      "(#{where_clause})"
+    end
+
     def full_keys(table_name, keys)
       keys = keys.split(CompositePrimaryKeys::ID_SEP) if keys.is_a?(String)
       keys.is_a?(Array) ?
@@ -211,7 +254,7 @@ module ActiveRecord::Associations
     end
     
     def full_columns_equals(table_name, keys, quoted_ids)
-      if keys.is_a?(Symbol) or (keys.is_a?(String) and keys == keys.split(CompositePrimaryKeys::ID_SEP))
+      if keys.is_a?(Symbol) or (keys.is_a?(String) and keys == keys.to_s.split(CompositePrimaryKeys::ID_SEP))
         return "#{table_name}.#{keys} = #{quoted_ids}"
       end
       keys = keys.split(CompositePrimaryKeys::ID_SEP) if keys.is_a?(String)
@@ -259,10 +302,8 @@ module ActiveRecord::Associations
             "#{@reflection.klass.table_name}.#{@reflection.options[:as]}_id = #{@owner.quoted_id} AND " + 
             "#{@reflection.klass.table_name}.#{@reflection.options[:as]}_type = #{@owner.class.quote @owner.class.base_class.name.to_s}"          
         else
-          @finder_sql = "(%s) = (%s)" % [
-            full_keys(@reflection.table_name, @reflection.primary_key_name),
-            @owner.quoted_id
-          ]
+          @finder_sql = full_columns_equals(@reflection.klass.table_name, 
+                                  @reflection.primary_key_name, @owner.quoted_id)
       end
       @finder_sql << " AND (#{conditions})" if conditions
     end
@@ -298,10 +339,11 @@ module ActiveRecord::Associations
             end
           end
 
-          "INNER JOIN %s ON (%s) = (%s) %s #{@reflection.options[:joins]} #{custom_joins}" % [
+          "INNER JOIN %s ON %s %s #{@reflection.options[:joins]} #{custom_joins}" % [
             @reflection.through_reflection.table_name,
-            full_keys(@reflection.table_name, reflection_primary_key),
-            full_keys(@reflection.through_reflection.table_name, source_primary_key),
+            composite_join_clause(
+              full_keys(@reflection.table_name, reflection_primary_key), 
+              full_keys(@reflection.through_reflection.table_name, source_primary_key)),
             polymorphic_join
           ]
     end
@@ -311,10 +353,16 @@ module ActiveRecord::Associations
         when @reflection.options[:finder_sql]
           @finder_sql = interpolate_sql(@reflection.options[:finder_sql])
 
-          @finder_sql = "(%s) = (%s)" % [
-                          full_keys(@reflection.klass.table_name, @reflection.primary_key_name),
-                          @owner.quoted_id
-                        ]
+          @finder_sql << " AND (#{conditions})" if conditions
+        when @reflection.options[:as]
+          @finder_sql = 
+            "#{@reflection.klass.table_name}.#{@reflection.options[:as]}_id = #{@owner.quoted_id} AND " + 
+            "#{@reflection.klass.table_name}.#{@reflection.options[:as]}_type = #{@owner.class.quote_value(@owner.class.base_class.name.to_s)}"
+          @finder_sql << " AND (#{conditions})" if conditions
+        
+        else
+          @finder_sql = composite_where_clause(
+            full_keys(@reflection.klass.table_name, @reflection.primary_key_name), @owner.quoted_id),
           @finder_sql << " AND (#{conditions})" if conditions
       end