composite_primary_keys 0.1.3 → 0.1.4

data/CHANGELOG

@@ -1,3 +1,7 @@
+* 0.1.4 *
+	- it was important that #{primary_key} for composites --> 'key1,key2' and not 'key1key2'
+	  so created PrimaryKeys class
+
 * 0.0.1 * Initial version
  - set_primary_keys(*keys) is the activation class method to transform an ActiveRecord into
  		a composite primary key AR

data/lib/composite_primary_keys.rb

@@ -37,5 +37,5 @@ end
 require 'composite_primary_keys/base'
 
 ActiveRecord::Base.class_eval do
-  include CompositePrimayKeys::ActiveRecord::Base
+  include CompositePrimaryKeys::ActiveRecord::Base
 end

data/lib/composite_primary_keys/base.rb

@@ -1,29 +1,38 @@
-module CompositePrimayKeys
+module CompositePrimaryKeys
   module ActiveRecord #:nodoc:
     module Base #:nodoc:
 
       INVALID_FOR_COMPOSITE_KEYS = 'Not appropriate for composite primary keys'
-      ID_SEP = ','
        
       def self.append_features(base)
         super
+        base.send(:include, InstanceMethods)
         base.extend(ClassMethods)
       end
     
       module ClassMethods
         def set_primary_keys(*keys)
-          @@primary_keys = []
           cattr_accessor :primary_keys 
-          self.primary_keys = keys
+          self.primary_keys = CompositePrimaryKeys::PrimaryKeys.new(keys)
           
           class_eval <<-EOV
-            include CompositePrimayKeys::ActiveRecord::Base::InstanceMethods
-            extend CompositePrimayKeys::ActiveRecord::Base::CompositeClassMethods
+            include CompositePrimaryKeys::ActiveRecord::Base::CompositeInstanceMethods
+            extend CompositePrimaryKeys::ActiveRecord::Base::CompositeClassMethods
           EOV
+          
+          #puts "#{self.class}-#{self}.composite = #{self.composite?}"
+        end
+        
+        def composite?
+          false
         end
       end
+      
+      module InstanceMethods
+        def composite?; self.class.composite?; end
+      end
      
-      module InstanceMethods  
+      module CompositeInstanceMethods  
         
         # A model instance's primary keys is always available as model.ids
         # whether you name it the default 'id' or set it to something else.
@@ -35,7 +44,7 @@ module CompositePrimayKeys
         
         #id_to_s([1,2]) -> "1,2"
         #id_to_s([1,2], '-') -> "1-2"
-        def id_to_s(ids, id_sep = CompositePrimayKeys::ActiveRecord::Base::ID_SEP)
+        def id_to_s(ids, id_sep = CompositePrimaryKeys::ID_SEP)
           ids.map{|id| self.class.sanitize(id)}.join("#{id_sep}")
         end
   
@@ -104,14 +113,16 @@ module CompositePrimayKeys
       end
       
       module CompositeClassMethods
+        def primary_key; primary_keys; end
+        def primary_key=(keys); primary_keys = keys; end
         
-        def primary_keys_to_s(sep = CompositePrimayKeys::ActiveRecord::Base::ID_SEP)
-          primary_keys.map(&:to_s).join(sep)
+        def composite?
+          true
         end
        
         #ids_to_s([[1,2],[7,3]]) -> "(1,2),(7,3)"
         #ids_to_s([[1,2],[7,3]], ',', ';', '', '') -> "1,2;7,3"
-        def ids_to_s(ids, id_sep = CompositePrimayKeys::ActiveRecord::Base::ID_SEP, list_sep = ',', left_bracket = '(', right_bracket = ')')
+        def ids_to_s(ids, id_sep = CompositePrimaryKeys::ID_SEP, list_sep = ',', left_bracket = '(', right_bracket = ')')
           "#{left_bracket}#{ids.map{|id| sanitize(id)}.join('#{id_sep}')}#{right_bracket}"
         end
   
@@ -127,7 +138,7 @@ module CompositePrimayKeys
         # If an array of ids is provided (e.g. delete([1,2], [3,4]), all of them
         # are deleted.
         def delete(*ids)
-          delete_all([ "(#{primary_keys_to_s}) IN (#{ids_to_s(ids)})" ])
+          delete_all([ "(#{primary_keys}) IN (#{ids_to_s(ids)})" ])
         end
   
         # Destroys the record with the given +ids+ by instantiating the object and calling #destroy (all the callbacks are the triggered).
@@ -136,13 +147,6 @@ module CompositePrimayKeys
           ids.first.is_a?(Array) ? ids.each { |id_set| destroy(id_set) } : find(ids).destroy
         end
        
-        # Alias for the composite primary_keys accessor method
-        def primary_key
-          raise CompositePrimayKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
-          # primary_keys
-          # Initially invalidate the method to find places where its used
-        end
-  
         # Returns an array of column objects for the table associated with this class.
         # Each column that matches to one of the primary keys has its
         # primary attribute set to true
@@ -159,24 +163,24 @@ module CompositePrimayKeys
         # Lazy-set the sequence name to the connection's default.  This method
         # is only ever called once since set_sequence_name overrides it.
           def sequence_name #:nodoc:
-            raise CompositePrimayKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
+            raise CompositePrimaryKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
           end
     
           def reset_sequence_name #:nodoc:
-            raise CompositePrimayKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
+            raise CompositePrimaryKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
           end
     
           def set_primary_key(value = nil, &block)
-            raise CompositePrimayKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
+            raise CompositePrimaryKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
           end
        
         private
           def find_one(id, options)
-            raise CompositePrimayKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
+            raise CompositePrimaryKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
           end
        
           def find_some(ids, options)
-            raise CompositePrimayKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
+            raise CompositePrimaryKeys::ActiveRecord::Base::INVALID_FOR_COMPOSITE_KEYS
           end
   
           def find_from_ids(ids, options)

data/lib/composite_primary_keys/primary_keys.rb

@@ -0,0 +1,10 @@
+module CompositePrimaryKeys
+  ID_SEP = ','
+  
+  class PrimaryKeys < Array
+
+    def to_s
+      join(ID_SEP)
+    end
+  end
+end

data/lib/composite_primary_keys/version.rb

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

data/test/abstract_unit.rb

@@ -49,6 +49,29 @@ class Test::Unit::TestCase #:nodoc:
   def assert_no_queries(&block)
     assert_queries(0, &block)
   end
+  
+  cattr_accessor :classes
+protected
+  
+  def testing_with(&block)
+    classes.keys.each do |@key_test|
+      @klass, @primary_keys = classes[@key_test][:class], classes[@key_test][:primary_keys]
+      @first = @klass.find_first
+      yield
+    end
+  end
+  
+  def first_id
+    (1..@primary_keys.length).map {|num| 1}
+  end
+  
+  def first_id_str
+    first_id.join(CompositePrimaryKeys::ID_SEP)
+  end
+  
+  def composite?
+    @key_test != :single
+  end  
 end
 
 def current_adapter?(type)

data/test/dummy_test.rb

@@ -1,4 +1,6 @@
 require 'abstract_unit'
+require 'fixtures/reference_type'
+require 'fixtures/reference_code'
 
 class DummyTest < Test::Unit::TestCase
 

data/test/find_test.rb

@@ -6,7 +6,7 @@ require 'fixtures/reference_code'
 class FindTest < Test::Unit::TestCase
   fixtures :reference_types, :reference_codes
   
-  CLASSES = {
+  @@classes = {
     :single => {
       :class => ReferenceType,
       :primary_keys => [:reference_type_id],
@@ -17,16 +17,6 @@ class FindTest < Test::Unit::TestCase
     }
   }
   
-  def test_primary_keys
-    testing_with do
-      if composite?
-        assert_equal @primary_keys, @klass.primary_keys
-      else
-        assert_equal @primary_keys, [@klass.primary_key.to_sym]
-      end
-    end
-  end
-  
   def test_find_first
     testing_with do
       obj = @klass.find_first
@@ -64,25 +54,4 @@ class FindTest < Test::Unit::TestCase
     end
   end
   
-protected
-  
-  def testing_with(&block)
-    CLASSES.keys.each do |@key_test|
-      @klass, @primary_keys = CLASSES[@key_test][:class], CLASSES[@key_test][:primary_keys]
-      @first = @klass.find_first
-      yield
-    end
-  end
-  
-  def first_id
-    (1..@primary_keys.length).map {|num| 1}
-  end
-  
-  def first_id_str
-    first_id.join(',')
-  end
-  
-  def composite?
-    @key_test != :single
-  end  
 end

data/test/miscellaneous_test.rb

@@ -0,0 +1,33 @@
+require 'abstract_unit'
+require 'fixtures/reference_type'
+require 'fixtures/reference_code'
+
+class MiscellaneousTest < Test::Unit::TestCase
+
+  def test_composite_class
+    testing_with do
+      assert_equal composite?, @klass.composite?
+    end
+  end
+
+  def test_composite_instance
+    testing_with do
+      assert_equal composite?, @first.composite?
+    end
+  end
+  
+  def test_primary_keys
+    testing_with do
+      if composite?
+        assert_not_nil @klass.primary_keys
+        assert_equal @primary_keys, @klass.primary_keys
+        assert_equal @klass.primary_keys, @klass.primary_key
+      else
+        assert_not_nil @klass.primary_key
+        assert_equal @primary_keys, [@klass.primary_key.to_sym]
+      end
+      assert_equal @primary_keys.join(','), @klass.primary_key.to_s
+      # Need a :primary_keys should be Array with to_s overridden
+    end
+  end
+end

data/test/pagination_test.rb

@@ -0,0 +1,31 @@
+require 'abstract_unit'
+require 'fixtures/reference_type'
+require 'fixtures/reference_code'
+require 'action_controller/pagination'
+
+class PaginationTest < Test::Unit::TestCase
+  include ActionController::Pagination
+  DEFAULT_PAGE_SIZE = 2
+  
+  @@classes = {
+    :single => {
+      :class => ReferenceType,
+      :primary_keys => [:reference_type_id],
+    },
+    :dual   => { 
+      :class => ReferenceCode,
+      :primary_keys => [:reference_type_id, :reference_code],
+    }
+  }
+  
+  def setup
+    @params = {}
+  end
+
+  def test_paginate_all
+    testing_with do
+      @object_pages, @objects = paginate :reference_codes, :per_page => DEFAULT_PAGE_SIZE
+      assert_equal 2, @objects.length, "Each page should have #{DEFAULT_PAGE_SIZE} items"
+    end
+  end
+end

data/test/primary_keys_test.rb

@@ -0,0 +1,20 @@
+require 'abstract_unit'
+require 'fixtures/reference_type'
+require 'fixtures/reference_code'
+
+class PrimaryKeyTest < Test::Unit::TestCase
+
+  def test_new
+    keys = CompositePrimaryKeys::PrimaryKeys.new
+    assert_not_nil keys
+    assert_equal '', keys.to_s
+    assert_equal '', "#{keys}"
+  end
+
+  def test_initialize
+    keys = CompositePrimaryKeys::PrimaryKeys.new([1,2,3])
+    assert_not_nil keys
+    assert_equal '1,2,3', keys.to_s
+    assert_equal '1,2,3', "#{keys}"
+  end
+end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: composite_primary_keys
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 date: 2006-07-22 00:00:00 +02:00
 summary: Support for composite primary keys in ActiveRecords
 require_paths: 
@@ -37,11 +37,15 @@ files:
 - lib/composite_primary_keys/version.rb
 - lib/composite_primary_keys/base.rb
 - lib/composite_primary_keys/fixtures.rb
+- lib/composite_primary_keys/primary_keys.rb
 - test/connections
 - test/abstract_unit.rb
 - test/dummy_test.rb
 - test/fixtures
 - test/find_test.rb
+- test/pagination_test.rb
+- test/miscellaneous_test.rb
+- test/primary_keys_test.rb
 - test/connections/native_mysql
 - test/connections/native_mysql/connection.rb
 - test/fixtures/reference_type.rb