composite_primary_keys 3.1.1 → 3.1.2

data/History.txt

@@ -1,4 +1,12 @@
-== 3.1.1 2010-02-07
+== 3.1.2 2011-02-26
+* Add back in support for find('3,3') which makes it possible to
+  do find(params[id]).  This implementation is simpler than earlier version
+  improving code readability.
+* Support for finding multiple records either via find([1,2], [3,4])
+* Remove to_composite_ids method which is no longer needed
+
+
+== 3.1.1 2011-02-07
 * Implement id_before_type_cast (Jason Lewis)
 * Add in tests for Model.includes(:other_model)
 * Fix object comparison with nil in composite primary keys (StackNG)

data/lib/composite_primary_keys/base.rb

@@ -125,8 +125,7 @@ module ActiveRecord
       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
+          map {|attr_name,id| quote_value(id, column_for_attribute(attr_name))}
       end
 
       # Sets the primary ID.

data/lib/composite_primary_keys/calculations.rb

@@ -1,29 +1,42 @@
-# TODO - This code doesn't work with ActiveRecord 3.0.3...
-
 #module ActiveRecord
 #  module Calculations
+#    alias :execute_simple_calculation_original :execute_simple_calculation
+#
 #    def execute_simple_calculation(operation, column_name, distinct)
-#      # CPK changes
 #      if column_name.kind_of?(Array)
-#        columns = column_name.map do |primary_key_column|
-#          table[primary_key_column].to_sql
-#        end
-#        projection = "DISTINCT #{columns.join(',')}"
-#        subquery = "(#{table.project(projection).to_sql}) AS subquery"
-#        relation = Arel::Table.new(subquery).project(Arel::SqlLiteral.new('*').count)
-#        type_cast_calculated_value(@klass.connection.select_value(relation.to_sql),
-#                                   column_for(column_name.first), operation)
+#        execute_simple_calculation_cpk(operation, column_name, distinct)
 #      else
-#        column = if @klass.column_names.include?(column_name.to_s)
-#          Arel::Attribute.new(@klass.unscoped, column_name)
-#        else
-#          Arel::SqlLiteral.new(column_name == :all ? "*" : column_name.to_s)
-#        end
+#        execute_simple_calculation_original(operation, column_name, distinct)
+#      end
+#    end
+#
+#    def execute_simple_calculation_cpk(operation, column_name, distinct)
+#      # SELECT COUNT(field1, field2) doens't work so make a subquery
+#      # like SELECT COUNT(*) FROM (SELECT DISTINCT field1, field2)
 #
-#        # Postgresql doesn't like ORDER BY when there are no GROUP BY
-#        relation = except(:order).select(operation == 'count' ? column.count(distinct) : column.send(operation))
-#        type_cast_calculated_value(@klass.connection.select_value(relation.to_sql), column_for(column_name), operation)
+#      columns = column_name.map do |primary_key_column|
+#        table[primary_key_column]
 #      end
+#
+#      subquery = clone.project(columns)
+#      subquery = "(#{subquery.to_sql}) AS calculation_subquery"
+#      relation = Arel::Table.new(Arel::SqlLiteral.new(subquery))#.project(Arel::SqlLiteral.new('*').count)
+#      puts relation.to_sql
+#
+#      #projection = "DISTINCT #{columns.join(',')}"
+#      #subquery = "(#{table.project(projection).to_sql}) AS subquery"
+#
+#      #select_value = ::Arel::Nodes::Count.new(columns, distinct)
+#  #    relation.select_values = columns
+# #     puts @klass.connection.select_value(relation.to_sql)
+##
+#      #type_cast_calculated_value(@klass.connection.select_value(relation.to_sql), column_for(column_name), operation)
+#      #relation.select_values = [count_node]
+#      #projection = "DISTINCT #{columns.join(',')}"
+#      #subquery = "(#{table.project(projection).to_sql}) AS subquery"
+#      #relation = Arel::Table.new(subquery).project(Arel::SqlLiteral.new('*').count)
+#      type_cast_calculated_value(@klass.connection.select_value(relation.to_sql),
+#                                 column_for(column_name.first), operation)
 #    end
 #  end
 #end

data/lib/composite_primary_keys/composite_arrays.rb

@@ -6,10 +6,6 @@ module CompositePrimaryKeys
     def to_composite_keys
       CompositeKeys.new(self)
     end
-
-    def to_composite_ids
-      Array.new(self)
-    end
   end
 
   class CompositeKeys < Array

data/lib/composite_primary_keys/finder_methods.rb

@@ -74,34 +74,49 @@ module CompositePrimaryKeys
         end
 
         def find_with_ids(*ids, &block)
-          return to_a.find(&block) if block_given?
-
-          ids = ids.first if ids.last == nil
-          ids = [ids.to_composite_ids] if not ids.first.kind_of?(Array)
-
-          ids.each do |id_set|
-            unless id_set.is_a?(Array)
-              raise "Ids must be in an Array, instead received: #{id_set.inspect}"
+          return to_a.find { |*block_args| yield(*block_args) } if block_given?
+
+          # Supports:
+          #   find('1,2')             ->  ['1,2']
+          #   find(1,2)               ->  [1,2]
+          #   find([1,2])             -> [['1,2']]
+          #   find([1,2], [3,4])      -> [[1,2],[3,4]]
+          #
+          # Does *not* support:
+          #   find('1,2', '3,4')      ->  ['1,2','3,4']
+
+          # Normalize incoming data.  Note the last arg can be nil.  Happens
+          # when find is called with nil options like the reload method does.
+          ids.compact!
+          ids = [ids] unless ids.first.kind_of?(Array)
+
+          results = ids.map do |cpk_ids|
+            cpk_ids = if cpk_ids.length == 1
+              cpk_ids.first.split(CompositePrimaryKeys::ID_SEP).to_composite_keys
+            else
+              cpk_ids.to_composite_keys
             end
-            unless id_set.length == @klass.primary_keys.length
-              raise "#{id_set.inspect}: Incorrect number of primary keys for #{@klass.name}: #{@klass.primary_keys.inspect}"
+
+            unless cpk_ids.length == @klass.primary_keys.length
+              raise "#{cpk_ids.inspect}: Incorrect number of primary keys for #{@klass.name}: #{@klass.primary_keys.inspect}"
             end
-          end
 
-          new_relation = clone
-          ids.each do |id_set|
-            [@klass.primary_keys, id_set].transpose.map do |key, id|
+            new_relation = clone
+            [@klass.primary_keys, cpk_ids].transpose.map do |key, id|
               new_relation = new_relation.where(key => id)
             end
-          end
+            
+            records = new_relation.to_a
 
-          result = new_relation.to_a
+            if records.empty?
+              conditions = new_relation.arel.where_sql
+              raise(::ActiveRecord::RecordNotFound,
+                    "Couldn't find #{@klass.name} with ID=#{cpk_ids} #{conditions}")
+            end
+            records
+          end.flatten
 
-          if result.size == ids.size
-            ids.size == 1 ? result[0] : result
-          else
-            raise ::ActiveRecord::RecordNotFound, "Couldn't find all #{@klass.name} with IDs (#{ids.inspect})"
-          end
+          ids.length == 1 ? results.first : results
         end
       end
     end

data/lib/composite_primary_keys/fixtures.rb

@@ -1,7 +1,7 @@
 class Fixture
   def [](key)
     if key.is_a? Array
-      key.map { |a_key| self[a_key.to_s] }.to_composite_ids
+      key.map { |a_key| self[a_key.to_s] }
     else
       @fixture[key]
     end

data/lib/composite_primary_keys/version.rb

@@ -2,7 +2,7 @@ module CompositePrimaryKeys
   module VERSION #:nodoc:
     MAJOR = 3
     MINOR = 1
-    TINY  = 1
+    TINY  = 2
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/scripts/txt2html

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
+gem 'RedCloth'
+gem 'syntax'
+
 require 'redcloth'
 require 'syntax/convertors/html'
 require 'erb'

data/tasks/website.rake

@@ -8,8 +8,8 @@ end
 desc 'Upload website files to rubyforge'
 task :website_upload do
   config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-  host = "cfis@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/compositekeys"
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/compositekeys/"
   local_dir = 'website'
   sh %{scp -r #{local_dir}/* #{host}:#{remote_dir}}
 end

data/test/db_test.rb

@@ -0,0 +1,53 @@
+# assoc_test.rb
+
+path = File.expand_path(File.join(File.basename(__FILE__), "..", "lib", "composite_primary_keys"))
+puts path
+
+require File.join(path)
+require 'active_record'
+
+$configuration = {
+  :adapter  => 'postgresql',
+  :database => 'cpk_test',
+  :username => 'postgres'
+}
+
+ActiveRecord::Base.establish_connection($configuration) unless ActiveRecord::Base.connected?
+
+module GlobePG
+  class PGBase < ActiveRecord::Base
+    self.abstract_class = true
+   # establish_connection($configuration) unless connected?
+  end
+end
+
+module GlobePG
+  class TeacherToSchool < PGBase
+    set_table_name 'teacher_to_school'
+    set_primary_keys ['teacherid', 'schoolid']
+
+    belongs_to :globe_teacher, :foreign_key => 'teacherid'
+    belongs_to :globe_school, :foreign_key => 'schoolid'
+  end
+end
+
+module GlobePG
+  class GlobeSchool < PGBase
+    set_table_name 'globe_school'
+    set_primary_key 'schoolid'
+    has_many :teacher_to_schools, :foreign_key => :schoolid
+    has_many :globe_teachers, :through => :teacher_to_schools
+  end
+end
+
+module GlobePG
+  class GlobeTeacher < PGBase
+    set_table_name 'globe_teacher'
+    set_primary_key 'teacherid'
+    has_many :teacher_to_schools, :foreign_key => :teacherid
+    has_many :globe_schools, :through => :teacher_to_schools
+  end
+end
+
+teacher = GlobePG::GlobeTeacher.find_by_teacherid('ZZGLOBEY')
+p teacher.globe_schools 

data/test/fixtures/db_definitions/sqlite.sql

@@ -164,3 +164,9 @@ create table seats (
   customer integer,
   primary key (flight_number, seat)
 );
+
+create table capitols (
+  country text not null,
+  city text not null,
+  primary key (country, city)
+);

data/test/fixtures/reference_codes.yml

@@ -21,10 +21,9 @@ gender_male:
   reference_code: 1
   code_label: MALE
   abbreviation: Male
+  
 gender_female:
   reference_type_id: 2
   reference_code: 2
   code_label: FEMALE
-  abbreviation: Female
-
-  
+  abbreviation: Female  

data/test/setup.rb

@@ -0,0 +1,51 @@
+# setup_db.rb
+require 'dbi'
+
+# Run "createdb cpk_test" first
+
+teacher_to_school = %Q{
+  create table teacher_to_school(
+    schoolid varchar(8),
+    teacherid varchar(8),
+    datebegin date,
+    teacherrole varchar(20),
+    primary key (schoolid, teacherid)
+  );
+
+}
+
+globe_teacher = %Q{
+  create table globe_teacher(
+    teacherid varchar(8) primary key,
+    currentschoolid varchar(8),
+    userid varchar(16)
+  );
+
+}
+
+globe_school = %Q{
+  create table globe_school(
+    schoolid varchar(8) primary key,
+    schoolname varchar(100) not null,
+    city varchar(35) not null
+  )
+
+}
+
+add_records = [
+  "insert into globe_teacher values ('ZZGLOBEY', 'ZZGLOBE1',
+'dberger');",
+  "insert into globe_school values ('ZZCOUCAR', 'NCAR Foothills Lab',
+'Boulder');",
+  "insert into globe_school values ('ZZGLOBE1', 'The GLOBE Program',
+'Boulder');",
+  "insert into teacher_to_school values('ZZGLOBE1', 'ZZGLOBEY', '1-JUN-2010', 'GLOBE OFFICE');",
+  "insert into teacher_to_school values('ZZCOUCAR', 'ZZGLOBEY', '1-AUG-2010', 'GLOBE Teacher');"
+]
+
+DBI.connect('dbi:Pg:cpk_test', 'postgres') do |dbh|
+  dbh.execute(teacher_to_school)
+  dbh.execute(globe_teacher)
+  dbh.execute(globe_school)
+  add_records.each{ |sql| dbh.execute(sql) }
+end 

data/test/test_associations.rb

@@ -26,9 +26,9 @@ class TestAssociations < ActiveSupport::TestCase
   end
 
   def test_count
-    assert_equal 2, Product.count(:include => :product_tariffs)
-    assert_equal 3, Tariff.count(:include => :product_tariffs)
-    assert_equal 2, Tariff.count(:group => :start_date).size
+    assert_equal(2, Product.count(:include => :product_tariffs))
+    assert_equal(3, Tariff.count(:include => :product_tariffs))
+    assert_equal(2, Tariff.count(:group => :start_date))
   end
 
   def test_products

data/test/test_composite_arrays.rb

@@ -21,10 +21,4 @@ class CompositeArraysTest < ActiveSupport::TestCase
     assert_equal CompositePrimaryKeys::CompositeKeys, keys.class
     assert_equal '1,2,3', keys.to_s
   end
-
-  def test_to_composite_ids
-    keys = [1,2,3].to_composite_ids
-    assert_equal Array, keys.class
-    assert_equal '123', keys.to_s
-  end
 end

data/test/test_find.rb

@@ -4,66 +4,54 @@ require 'abstract_unit'
 class TestFind < ActiveSupport::TestCase
   fixtures :capitols, :reference_types, :reference_codes, :suburbs
 
-  CLASSES = {
-    :single => {
-      :class => ReferenceType,
-      :primary_keys => [:reference_type_id],
-    },
-    :dual   => {
-      :class => ReferenceCode,
-      :primary_keys => [:reference_type_id, :reference_code],
-    },
-    :dual_strs   => {
-      :class => ReferenceCode,
-      :primary_keys => ['reference_type_id', 'reference_code'],
-    },
-  }
-
-  def setup
-    self.class.classes = CLASSES
+  def test_find_first
+    ref_code = ReferenceCode.find(:first, :order => 'reference_type_id, reference_code')
+    assert_kind_of(ReferenceCode, ref_code)
+    assert_equal([1,1], ref_code.id)
   end
 
-  def test_find_first
-    testing_with do
-      obj = @klass.find(:first)
-      assert obj
-      assert_equal @klass, obj.class
-    end
+  def test_find_last
+    ref_code = ReferenceCode.find(:last, :order => 'reference_type_id, reference_code')
+    assert_kind_of(ReferenceCode, ref_code)
+    assert_equal([2,2], ref_code.id)
   end
 
-  def test_find
-    testing_with do
-      found = @klass.find(*first_id) # e.g. find(1,1) or find 1,1
-      assert found
-      assert_equal @klass, found.class
-      assert_equal found, @klass.find(found.id)
-    end
+  def test_find_one
+    ref_code = ReferenceCode.find([1,3])
+    assert_not_nil(ref_code)
+    assert_equal([1,3], ref_code.id)
   end
 
-  def test_find_composite_ids
-    testing_with do
-      found = @klass.find(first_id) # e.g. find([1,1].to_composite_ids)
-      assert found
-      assert_equal @klass, found.class
-      assert_equal found, @klass.find(found.id)
-    end
+  def test_find_one_string
+    ref_code = ReferenceCode.find('1,3')
+    assert_kind_of(ReferenceCode, ref_code)
+    assert_equal([1,3], ref_code.id)
   end
 
-  def things_to_look_at
-    testing_with do
-      assert_equal found, @klass.find(found.id.to_s) # fails for 2+ keys
-    end
+  def test_find_some
+    ref_codes = ReferenceCode.find([1,3], [2,1])
+    assert_kind_of(Array, ref_codes)
+    assert_equal(2, ref_codes.length)
+
+    ref_code = ref_codes[0]
+    assert_equal([1,3], ref_code.id)
+
+    ref_code = ref_codes[1]
+    assert_equal([2,1], ref_code.id)
   end
 
   def test_find_with_strings_as_composite_keys
-    found = Capitol.find('The Netherlands', 'Amsterdam')
-    assert found
+    capitol = Capitol.find(['The Netherlands', 'Amsterdam'])
+    assert_kind_of(Capitol, capitol)
+    assert_equal(['The Netherlands', 'Amsterdam'], capitol.id)
   end
 
   def test_not_found
-    assert_raise(::ActiveRecord::RecordNotFound) do
+    error = assert_raise(::ActiveRecord::RecordNotFound) do
       ReferenceCode.find(['999', '999'])
     end
+    assert_equal("Couldn't find ReferenceCode with ID=999,999 WHERE \"reference_codes\".\"reference_type_id\" = 999 AND \"reference_codes\".\"reference_code\" = 999",
+                 error.message)
   end
 
   def test_find_last_suburb
@@ -76,4 +64,4 @@ class TestFind < ActiveSupport::TestCase
     suburb = Suburb.find(:last, :order => 'suburbs.city_id DESC')
     assert_equal([1,1], suburb.id)
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: composite_primary_keys
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
   - 3
   - 1
-  - 1
-  version: 3.1.1
+  - 2
+  version: 3.1.2
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-05 00:00:00 -08:00
+date: 2011-02-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,6 +112,7 @@ files:
 - test/connections/native_oracle_enhanced/connection.rb
 - test/connections/native_postgresql/connection.rb
 - test/connections/native_sqlite/connection.rb
+- test/db_test.rb
 - test/debug.log
 - test/fixtures/article.rb
 - test/fixtures/articles.yml
@@ -181,6 +182,7 @@ files:
 - test/plugins/pagination.rb
 - test/plugins/pagination_helper.rb
 - test/README_tests.txt
+- test/setup.rb
 - test/test_associations.rb
 - test/test_attributes.rb
 - test/test_attribute_methods.rb
@@ -232,15 +234,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: compositekeys
-rubygems_version: 1.5.0
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Composite key support for ActiveRecord
 test_files: 
 - test/abstract_unit.rb
+- test/db_test.rb
 - test/debug.log
 - test/hash_tricks.rb
 - test/README_tests.txt
+- test/setup.rb
 - test/test_associations.rb
 - test/test_attributes.rb
 - test/test_attribute_methods.rb