cohort_scope 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/cohort_scope.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cohort_scope}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Seamus Abshere", "Andy Rossmeissl", "Derek Kastner"]
-  s.date = %q{2010-10-15}
+  s.date = %q{2010-10-29}
   s.description = %q{Provides big_cohort, which widens by finding the constraint that eliminates the most records and removing it. Also provides strict_cohort, which widens by eliminating constraints in order.}
   s.email = %q{seamus@abshere.net}
   s.extra_rdoc_files = [
@@ -38,9 +38,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Provides cohorts (in the form of ActiveRecord scopes) that dynamically widen until they contain a certain number of records.}
   s.test_files = [
-    "test/helper.rb",
-     "test/test_cohort.rb",
-     "test/test_cohort_scope.rb"
+    "test/test_cohort.rb",
+     "test/test_cohort_scope.rb",
+     "test/helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/cohort_scope/cohort.rb

@@ -32,9 +32,9 @@ module CohortScope
         conditions = constraints.inject(new_hash) do |memo, tuple|
           k, v = tuple
           if v.kind_of?(ActiveRecord::Base)
-            primary_key = association_primary_key(model, k)
-            param = v.respond_to?(primary_key) ? v.send(primary_key) : v.to_param
-            condition = { primary_key => param }
+            foreign_key = association_foreign_key model, k
+            lookup_value = association_lookup_value model, k, v
+            condition = { foreign_key => lookup_value }
           elsif !v.nil?
             condition = { k => v }
           end
@@ -44,21 +44,37 @@ module CohortScope
         conditions
       end
       
-      # Convert constraints that are provided as ActiveRecord::Base objects into their corresponding integer primary keys.
+      # Convert constraints that are provided as ActiveRecord::Base objects into their corresponding primary keys.
       #
       # Only works for <tt>belongs_to</tt> relationships.
       #
-      # For example, :car => <#Car> might get translated into :car_id => 44.
-      def association_primary_key(model, name)
-        @_cohort_association_primary_keys ||= {}
-        return @_cohort_association_primary_keys[name] if @_cohort_association_primary_keys.has_key? name
-        a = model.reflect_on_association name
-        raise "there is no association #{name.inspect} on #{model}" if a.nil?
-        raise "can't use cohort scope on :through associations (#{self.name} #{name})" if a.options.has_key? :through
-        if !a.primary_key_name.blank?
-          @_cohort_association_primary_keys[name] = a.primary_key_name
+      # For example, :car => <#Car> might get translated into :car_id => 44 or :car_type => 44 if :foreign_key option is given.
+      def association_foreign_key(model, name)
+        @_cohort_association_foreign_keys ||= {}
+        return @_cohort_association_foreign_keys[name] if @_cohort_association_foreign_keys.has_key? name
+        association = model.reflect_on_association name
+        raise "there is no association #{name.inspect} on #{model}" if association.nil?
+        raise "can't use cohort scope on :through associations (#{self.name} #{name})" if association.options.has_key? :through
+        foreign_key = association.instance_variable_get(:@options)[:foreign_key]
+        if !foreign_key.blank?
+          @_cohort_association_foreign_keys[name] = foreign_key
         else
-          raise "we need some other way to find primary key"
+          @_cohort_association_foreign_keys[name] = association.primary_key_name
+        end
+      end
+      
+      # Convert constraints that are provided as ActiveRecord::Base objects into their corresponding lookup values
+      #
+      # Only works for <tt>belongs_to</tt> relationships.
+      #
+      # For example, :car => <#Car> might get translated into :car_id => 44 or :car_id => 'JHK123' if :primary_key option is given.
+      def association_lookup_value(model, name, value)
+        association = model.reflect_on_association name
+        primary_key = association.instance_variable_get(:@options)[:primary_key]
+        if primary_key.blank?
+          value.to_param
+        else
+          value.send primary_key
         end
       end
     end

data/test/helper.rb

@@ -1,7 +1,6 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
-require 'ruby-debug'
 require 'logger'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

data/test/test_cohort.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestCohortScope < Test::Unit::TestCase
+class TestCohort < Test::Unit::TestCase
   def setup
     Citizen.minimum_cohort_size = 3
     @date_range = (Date.parse('1980-01-01')..Date.parse('1990-01-01'))
@@ -30,15 +30,28 @@ class TestCohortScope < Test::Unit::TestCase
     end
   end
 
-  context '.association_primary_key' do
-    should 'include constraints that are models related by a primary key' do
+  context '.association_foreign_key' do
+    should 'include constraints that are models related by a standard foreign key' do
       gob = Resident.find_by_name('Gob')
-      key = CohortScope::Cohort.association_primary_key Resident, :house
+      key = CohortScope::Cohort.association_foreign_key Resident, :house
       assert_equal 'resident_id', key
     end
-    should 'include constraints that are models related by a non-primary key' do
-      key = CohortScope::Cohort.association_primary_key House, :style
+    should 'include constraints that are models related by a non-standard foreign key' do
+      key = CohortScope::Cohort.association_foreign_key House, :style
       assert_equal 'period', key
     end
   end
+
+  context '.association_lookup_value' do
+    should 'include constraints that are models related by a standard foreign key' do
+      gob = Resident.find_by_name('Gob')
+      lookup = CohortScope::Cohort.association_lookup_value Resident, :house, gob
+      assert_equal gob.to_param, lookup
+    end
+    should 'include constraints that are models related by a non-standard foreign key key' do
+      rev = Style.find_by_name 'classical revival'
+      lookup = CohortScope::Cohort.association_lookup_value House, :style, rev
+      assert_equal 'arts and crafts', lookup
+    end
+  end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cohort_scope
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -17,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-15 00:00:00 -04:00
+date: 2010-10-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,7 +27,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: -1848230024
         segments: 
         - 3
         - 0
@@ -45,7 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: -1848230024
         segments: 
         - 3
         - 0
@@ -62,7 +59,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 33
         segments: 
         - 2
         - 10
@@ -78,7 +74,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -122,7 +117,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -131,7 +125,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -143,6 +136,6 @@ signing_key:
 specification_version: 3
 summary: Provides cohorts (in the form of ActiveRecord scopes) that dynamically widen until they contain a certain number of records.
 test_files: 
-- test/helper.rb
 - test/test_cohort.rb
 - test/test_cohort_scope.rb
+- test/helper.rb