picky-client 4.11.3 → 4.12.0

data/lib/picky-client/convenience.rb

@@ -36,7 +36,9 @@ module Picky
 
     # Populates the ids with (rendered) model instances.
     #
-    # Give it an AR class and options for the find and it
+    # It does this by calling #find_by_id on the given model class.
+    #
+    # Give it eg. an ActiveRecord class and options for the find_by_id and it
     # will yield each found result for you to render.
     #
     # If you don't pass it a block, it will just use the AR results.
@@ -49,12 +51,16 @@ module Picky
     #
     # === Options
     # * up_to: Amount of results to populate. All of them by default.
-    # * The rest of the options are directly passed through to the ModelClass.find(ids, options) method. Default is {}.
+    # * finder_method: Specify which AR finder method you want to load the model with. Default is #find_by_id.
+    # * The rest of the options are directly passed through to the ModelClass.find_by_id(ids, options) method. Default is {}.
     #
     def populate_with model_class, options = {}, &block
-      the_ids  = ids options.delete(:up_to)
-
-      objects = model_class.find the_ids, options
+      the_ids       = ids options.delete(:up_to)
+      finder_method = options.delete(:finder_method) || :find_by_id
+      
+      # Call finder method.
+      #
+      objects = model_class.send finder_method, the_ids, options
 
       # Put together a mapping.
       #
@@ -66,9 +72,13 @@ module Picky
       # Preserves the order
       #
       objects = the_ids.map { |id| mapped_entries[id] }
-
-      objects.collect! &block if block_given?
-
+      
+      # Replace objects with rendered versions if a block is given.
+      #
+      objects.collect! &block if block
+      
+      # Enhance the allocations with the objects or rendered objects.
+      #
       amend_ids_with objects
 
       objects
@@ -112,4 +122,4 @@ module Picky
     end
 
   end
-end
+end

data/spec/picky-client/convenience_spec.rb

@@ -93,7 +93,7 @@ describe Picky::Convenience do
         def initialize id
           @id = id
         end
-        def self.find ids, options = {}
+        def self.find_by_id ids, options = {}
           ids.map { |id| new(id) }
         end
         def == other
@@ -113,6 +113,10 @@ describe Picky::Convenience do
       @results.populate_with(ARClass) { |ar_instance| ar_instance.id.to_s }
       @results.ids.should_not be_empty
     end
+    it "should allow you to override the finder method you use" do
+      ARClass.should_receive(:find_by_id).and_return((1..20).map { |id| ARClass.new(id) })
+      @results.populate_with ARClass, :finder_method => :find_by_id
+    end
   end
 
   describe 'replace_ids_with' do
@@ -210,4 +214,4 @@ describe Picky::Convenience do
     end
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky-client
 version: !ruby/object:Gem::Version
-  version: 4.11.3
+  version: 4.12.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby