active_collection 0.2.3 → 0.2.4

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 3
+:patch: 4
 :major: 0
 :minor: 2

data/active_collection.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{active_collection}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Emde"]
-  s.date = %q{2009-09-16}
+  s.date = %q{2009-10-12}
   s.description = %q{A lazy-loading, Array-like collection proxy for ActiveRecord that understands conditions and paging.}
   s.email = %q{martin.emde@gmail.com}
   s.extra_rdoc_files = [
@@ -26,14 +26,18 @@ Gem::Specification.new do |s|
      "active_collection.gemspec",
      "lib/active_collection.rb",
      "lib/active_collection/base.rb",
+     "lib/active_collection/conditions.rb",
      "lib/active_collection/includes.rb",
      "lib/active_collection/member_class.rb",
+     "lib/active_collection/new_scope.rb",
      "lib/active_collection/order.rb",
      "lib/active_collection/pagination.rb",
      "lib/active_collection/scope.rb",
      "lib/active_collection/serialization.rb",
-     "spec/active_collection_spec.rb",
+     "spec/base_spec.rb",
+     "spec/member_class_spec.rb",
      "spec/pagination_spec.rb",
+     "spec/proxy_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -44,8 +48,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A lazy-loading, Array-like collection proxy for ActiveRecord that understands conditions and paging.}
   s.test_files = [
-    "spec/active_collection_spec.rb",
+    "spec/base_spec.rb",
+     "spec/member_class_spec.rb",
      "spec/pagination_spec.rb",
+     "spec/proxy_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/active_collection/base.rb

@@ -51,16 +51,19 @@ module ActiveCollection
       end
     end
 
+    # dup that doesn't include the collection if it's loaded
+    def unloading_dup
+      d = super
+      d.unload!
+      yield d if block_given?
+      d
+    end
+
     # Implements Enumerable
     def each(&block)
       collection.each(&block)
     end
 
-    # Grab the raw collection.
-    def all
-      collection
-    end
-
     # The emptiness of the collection (limited by query and pagination)
     def empty?
       size.zero?
@@ -69,11 +72,13 @@ module ActiveCollection
     # The size of the collection (limited by query and pagination)
     #
     # It will avoid using a count query if the collection is already loaded.
+    #
+    # (Note that the paginated count is added in the pagination module)
     def size
-      loaded?? collection.size : total_entries
+      loaded?? length : total_entries
     end
 
-    # Always returns the total count regardless of pagination.
+    # Always returns the total count of all records that can be in this collection.
     def total_entries
       @total_entries ||= load_count
     end
@@ -90,6 +95,10 @@ module ActiveCollection
       !!@collection
     end
 
+    def unload!
+      @collection = nil
+    end
+
     protected
 
     # Pass methods on to the collection.
@@ -114,16 +123,6 @@ module ActiveCollection
       @collection ||= load_collection
     end
 
-    # Overload this method to add extra find options.
-    #
-    # :offset and :limit will be overwritten by the pagination_options if the
-    # collection is paginated, because you shouldn't be changing the paging
-    # directly if you're working with a paginated collection
-    # 
-    def query_options
-      {}
-    end
-
     def load_count
       model_class.count(count_options)
     end

data/lib/active_collection/conditions.rb

@@ -0,0 +1,59 @@
+module ActiveCollection
+  module Conditions
+
+    def self.conditiond(mod)
+      mod.extend ClassMethods
+      mod.class_eval do
+        find_scope :conditions_options
+      end
+    end
+
+    module ClassMethods
+      def conditions(*conditions)
+        write_inheritable_attribute(:default_conditions, conditions)
+      end
+
+      def default_conditions
+        read_inheritable_attribute(:default_conditions) ||
+          write_inheritable_attribute(:default_conditions, [])
+      end
+
+      def merge_conditions(a, b)
+        (safe_to_array(a) + safe_to_array(b)).uniq
+      end
+    end
+
+    def each_condition(&block)
+      @conditions ||= self.class.default_conditions
+    end
+
+    def conditions(*conds)
+      unloading_dup { |ac| ac.condition!(*conds) }
+    end
+
+    def condition!(*new_conditions)
+      raise_if_loaded
+      @conditions = self.class.merge_conditions(new_conditions, conditions).uniq
+    end
+
+    def conditions_options
+      { :conditions => @conditions } unless @conditions.blank?
+    end
+
+    protected
+
+    # Taken from ActiveRecord::Base
+    #
+    # Object#to_a is deprecated, though it does have the desired behavior
+    def safe_to_array(o)
+      case o
+      when NilClass
+        []
+      when Array
+        o
+      else
+        [o]
+      end
+    end
+  end
+end

data/lib/active_collection/includes.rb

@@ -19,18 +19,18 @@ module ActiveCollection
     end
 
     def includes
-      @includes = self.class.default_includes
+      @includes ||= self.class.default_includes
     end
 
-    def include(*includes)
-      ac = dup
-      ac.include! *includes
+    def include(*new_includes)
+      ac = unloading_dup
+      ac.include! *new_includes
       ac
     end
 
-    def include!(*includes)
+    def include!(*new_includes)
       raise_if_loaded
-      @includes = (safe_to_array(includes) + safe_to_array(includes)).uniq
+      @includes = (safe_to_array(new_includes) + safe_to_array(includes)).uniq
     end
 
     def include_options

data/lib/active_collection/member_class.rb

@@ -5,27 +5,61 @@ module ActiveCollection
     end
 
     module ClassMethods
+      #
+      # If the name of the class held by your collection cannot be derived from
+      # the name of the collection class (by removing the word Collection from
+      # the end of the collection class name) then use model to set it.
+      #
+      # Example:
+      #
+      #     class WeirdNamedCollection
+      #       model "Normal"
+      #     end
+      # 
+      # This will use the class Normal to do counts and finds.
+      def model(class_name)
+        (@model_class_name = class_name) && @model_class = nil
+      end
+
+      # The actual member class.
+      #
+      # Prints a useful error message if you define your model class wrong.
       def model_class
-        @model_class ||= name.sub(/Collection$/,'').constantize
+        begin
+          @model_class ||= model_class_name.constantize
+        rescue NameError => e
+          raise NameError, %|#{e} - Use 'model "Class"' in the collection to declare the correct model class for #{name}|
+        end
       end
 
+      # Table name of the member class.
       def table_name
         model_class.table_name
       end
 
+      # Plural human name of the member class.
       def human_name(*args)
         model_class.human_name(*args).pluralize
       end
+
+      protected
+
+      def model_class_name
+        @model_class_name || name.sub(/Collection$/,'')
+      end
     end
 
+    # The actual member class.
     def model_class
       self.class.model_class
     end
 
+    # Table name of the member class.
     def table_name
       self.class.table_name
     end
 
+    # Plural human name of the member class.
     def human_name(*args)
       self.class.human_name(*args)
     end

data/lib/active_collection/new_scope.rb

@@ -0,0 +1,140 @@
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/hash/deep_merge'
+
+module ActiveCollection
+  module Scope
+    #extend ActiveSupport::Concern
+
+    def self.included(mod)
+      mod.extend ClassMethods
+    end
+
+    # Find options for loading the collection.
+    #
+    # To add more options, define a method that returns a hash with the
+    # additional options for find and then add it like this:
+    #
+    #   class BeerCollection
+    #     find_scope :awesome_beer_only
+    #
+    #     def awesome_beer_only
+    #       { :conditions => "beer = 'awesome'" }
+    #     end
+    #   end
+    #
+    def find_options
+      self.class.scope_for_find.to_options(self)
+    end
+
+    # Count options for loading the total count.
+    #
+    # To add more options, define a method that returns a hash with the
+    # additional options for count and then add it like this:
+    #
+    #   class BeerCollection
+    #     count_scope :awesome_beer_only
+    #
+    #     def awesome_beer_only
+    #       { :conditions => "beer = 'awesome'" }
+    #     end
+    #   end
+    #
+    def count_options
+      self.class.scope_for_count.to_options(self)
+    end
+
+    module ClassMethods
+      def scopes_for_find
+        ScopeBuilder.new(scope_builder + find_scope_builder)
+      end
+
+      def scopes_for_count
+        ScopeBuilder.new(scope_builder + count_scope_builder)
+      end
+
+      [:scope, :find_scope, :count_scope].each do |scope|
+        module_eval <<-SCOPE, __FILE__, __LINE__
+          def #{scope}(*methods, &block)
+            #{scope} = ScopeBuilder.build(:#{scope}, *methods, &block)
+            @#{scope}_builder ||= ScopeBuilder.new
+            @#{scope}_builder.concat #{scope}
+          end
+
+          def #{scope}_builder
+            @#{scope}_builder ||= ScopeBuilder.new
+            if superclass.respond_to?(:#{scope}_builder)
+              superclass.#{scope}_builder + @#{scope}_builder
+            else
+              @#{scope}_builder
+            end
+          end
+        SCOPE
+      end
+    end
+
+    class ScopeBuilder < Array
+      def self.build(kind, *methods, &block)
+        methods, options = extract_options(*methods, &block)
+        methods.map! { |method| ActiveSupport::Callbacks::Callback.new(kind, method, options) }
+        new(methods)
+      end
+
+      def to_options(object)
+        inject({}) do |h, callback|
+          res = callback.call(object)
+          res ? h.merge(res) : h
+        end
+      end
+
+      def join
+        hash = {}
+        each do |scope|
+          next if scope.blank?
+
+          (scope.keys + hash.keys).uniq.each do |key|
+            merge = hash[key] && params[key] # merge if both scopes have the same key
+
+            if key == :conditions && merge
+              hash[key] = if params[key].is_a?(Hash) && hash[key].is_a?(Hash)
+                            merge_conditions(hash[key].deep_merge(params[key]))
+                          else
+                            merge_conditions(params[key], hash[key])
+                          end
+            elsif key == :include && merge
+              hash[key] = merge_includes(hash[key], params[key]).uniq
+            elsif key == :joins && merge
+              hash[key] = merge_joins(params[key], hash[key])
+            else
+              hash[key] = hash[key] || params[key]
+            end
+          end
+        end
+
+        hash
+      end
+
+      private
+        # Merges conditions so that the result is a valid +condition+
+        def self.merge_conditions(*conditions)
+          segments = []
+
+          conditions.each do |condition|
+            unless condition.blank?
+              sql = model_class.send(:sanitize_sql, condition)
+              segments << sql unless sql.blank?
+            end
+          end
+
+          "(#{segments.join(') AND (')})" unless segments.empty?
+        end
+
+        def self.extract_options(*methods, &block)
+          methods.flatten!
+          options = methods.extract_options!
+          methods << block if block_given?
+          return methods, options
+        end
+    end
+  end
+end
+

data/lib/active_collection/order.rb

@@ -13,7 +13,7 @@ module ActiveCollection
     end
 
     def order_by(order)
-      ac = dup
+      ac = unloading_dup
       ac.order_by! order
       ac
     end

data/lib/active_collection/pagination.rb

@@ -131,7 +131,7 @@ module ActiveCollection
 
     # Total number of pages.
     def total_pages
-      @total_pages ||= (total_entries / per_page.to_f).ceil
+      (total_entries / per_page.to_f).ceil
     end
 
     # return a paginated collection if it isn't already paginated.
@@ -153,6 +153,7 @@ module ActiveCollection
       current_page && current_page > 0
     end
 
+    # TODO clean this up
     def as_data_hash
       data_hash = { "collection" => collection.as_json }
       if paginated?
@@ -164,6 +165,7 @@ module ActiveCollection
       data_hash
     end
 
+    # TODO clean this up
     def to_xml(options = {})
       collect
       options[:indent] ||= 2

data/lib/active_collection/scope.rb

@@ -17,7 +17,7 @@ module ActiveCollection
     #     find_scope :awesome_beer_only
     #
     #     def awesome_beer_only
-    #       { :conditions => "beer = 'awesome'" }
+    #       { :conditions => { :beer => 'awesome' } }
     #     end
     #   end
     #
@@ -34,7 +34,7 @@ module ActiveCollection
     #     count_scope :awesome_beer_only
     #
     #     def awesome_beer_only
-    #       { :conditions => "beer = 'awesome'" }
+    #       { :conditions => { :beer => 'awesome' } }
     #     end
     #   end
     #

data/spec/{active_collection_spec.rb → base_spec.rb}

@@ -1,21 +1,17 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-class BeerCollection < ActiveCollection::Base
-end
-
 class Beer
   def self.human_name(*args)
     "Beer"
   end
 end
 
+class BeerCollection < ActiveCollection::Base
+end
+
 describe ActiveCollection do
   subject { BeerCollection.new }
 
-  it "passes human_name to the member class and then pluralizes" do
-    subject.human_name(:locale => 'en-us').should == "Beers"
-  end
-
   context "(empty)" do
     describe "(count methods)" do
       before do
@@ -29,6 +25,10 @@ describe ActiveCollection do
       it "has size of 0" do
         subject.size.should == 0
       end
+
+      it "has total_entries of 0" do
+        subject.total_entries.should == 0
+      end
     end
 
     describe "(collection loading methods)" do
@@ -44,11 +44,6 @@ describe ActiveCollection do
         subject.length
         Beer.should_not_receive(:count)
         subject.should be_empty
-      end
-
-      it "doesn't load count after loading the collection" do
-        subject.length
-        Beer.should_not_receive(:count)
         subject.size.should == 0
       end
 
@@ -57,16 +52,16 @@ describe ActiveCollection do
         subject.each { |i| count += 1 }
         count.should == 0
       end
+
+      it "returns empty Array on to_a" do
+        subject.to_a.should == []
+      end
     end
   end
 
-  context "(simple collection with 5 records)" do
+  context "(with 5 records)" do
     def records
-      @records ||= begin
-                     beers = []
-                     5.times { beers << Beer.new }
-                     beers
-                   end
+      @records ||= (1..5).map { |i| Beer.new }
     end
 
     describe "(count methods)" do
@@ -98,11 +93,6 @@ describe ActiveCollection do
         subject.length
         Beer.should_not_receive(:count)
         subject.should_not be_empty
-      end
-
-      it "doesn't load count after loading the collection" do
-        subject.length
-        Beer.should_not_receive(:count)
         subject.size.should == 5
       end
 
@@ -111,6 +101,23 @@ describe ActiveCollection do
         subject.each { |i| count += 1 }
         count.should == 5
       end
+
+      it "returns all objects in an Array on to_a" do
+        subject.to_a.should == records
+      end
+
+      it "loads the collection on length" do
+        subject.should_not be_loaded
+        subject.length
+        subject.should be_loaded
+      end
+
+      it "unloads a loaded collection on unload!" do
+        subject.to_a
+        subject.should be_loaded
+        subject.unload!
+        subject.should_not be_loaded
+      end
     end
   end
 end

data/spec/member_class_spec.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Beer
+  def self.human_name(*args)
+    "Beer"
+  end
+
+  def self.table_name
+    "beers"
+  end
+end
+
+class BeerCollection < ActiveCollection::Base
+end
+
+class DunkelBeer
+  def self.human_name(*args)
+    "Dunkel Beer"
+  end
+
+  def self.table_name
+    "dunkel_beers"
+  end
+end
+
+class DarkBeerCollection < ActiveCollection::Base
+  model "DunkelBeer"
+end
+
+class BrokenCollection < ActiveCollection::Base
+end
+
+describe ActiveCollection do
+  context "(with standard name)" do
+    subject { BeerCollection.new }
+
+    it "has the correct model_class" do
+      subject.model_class.should == Beer
+    end
+
+    it "retrieves table_name from member class" do
+      subject.table_name.should == "beers"
+    end
+
+    it "retrieves human_name from member class and pluralizes" do
+      subject.human_name(:locale => 'en-us').should == "Beers"
+    end
+  end
+
+  context "(with model)" do
+    subject { DarkBeerCollection.new }
+
+    it "uses the correct model class" do
+      subject.model_class.should == DunkelBeer
+    end
+
+    it "doesn't affect other classes" do
+      BeerCollection.new.model_class.should == Beer
+    end
+
+    it "retrieves table_name from member class" do
+      subject.table_name.should == "dunkel_beers"
+    end
+
+    it "retrieves human_name from member class and pluralizes" do
+      subject.human_name(:locale => 'en-us').should == "Dunkel Beers"
+    end
+  end
+
+  context "(broken name)" do
+    subject { BrokenCollection.new }
+
+    it "raises a useful error when usage is attempted" do
+      message = "No exception raised."
+      begin
+        subject.model_class
+      rescue NameError => e
+        message = e.to_s
+      end
+      message.should =~ /Use 'model "Class"' in the collection to declare the correct model class for BrokenCollection/
+      message.should =~ /uninitialized constant Broken/
+    end
+  end
+end

data/spec/pagination_spec.rb

@@ -52,7 +52,7 @@ describe ActiveCollection do
 
       it_should_behave_like "an empty collection"
 
-      it "should be out of bounds" do
+      it "is out of bounds" do
         subject.should be_out_of_bounds
       end
 
@@ -70,7 +70,7 @@ describe ActiveCollection do
     end
   end
 
-  context "(simple collection with 5 records)" do
+  context "(with 5 records)" do
     def records
       @records ||= begin
                      beers = []
@@ -113,6 +113,16 @@ describe ActiveCollection do
           subject.total_entries
         end
 
+        it "raises on attempt to force paginate after already loaded" do
+          subject.to_a
+          subject.should be_loaded
+          lambda { subject.paginate! }.should raise_error(ActiveCollection::AlreadyLoadedError)
+        end
+
+        it "returns the same record on 'soft' paginate when already paginated" do
+          subject.paginate.should == subject
+        end
+
         it "yields 5 items to each" do
           count = 0
           subject.each { |i| count += 1 }
@@ -163,6 +173,7 @@ describe ActiveCollection do
           Beer.should_receive(:all).with(:limit => ActiveCollection::Base.per_page, :offset => 0).and_return(records)
           subject.length
         end
+
       end
     end
 
@@ -230,7 +241,7 @@ describe ActiveCollection do
         end
 
         it "calls count to find total_entries even when collection is loaded" do
-          subject.length
+          subject.to_a
           Beer.should_receive(:count).and_return(5)
           subject.total_entries.should == 5
         end

data/spec/proxy_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Beer
+  def self.human_name(*args)
+    "Beer"
+  end
+
+  def self.all(*args)
+    [Beer.new, Beer.new]
+  end
+end
+
+class BeerCollection < ActiveCollection::Base
+end
+
+describe ActiveCollection, "(proxying)" do
+  subject { BeerCollection.new }
+
+  it "responds to array methods" do
+    subject.should respond_to(:map)
+    subject.should respond_to(:slice)
+  end
+
+  it "loads the collection when sending array methods" do
+    Beer.should_receive(:all).and_return([Beer.new])
+    subject.send(:slice, 0).should_not be_nil
+  end
+
+  it "responds to its own instance methods" do
+    subject.should respond_to(:loaded?)
+    subject.should respond_to(:empty?)
+  end
+
+  it "doesn't load the collection when sending collection methods" do
+    Beer.should_not_receive(:all)
+    subject.send(:loaded?).should be_false
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_collection
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Martin Emde
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-16 00:00:00 -07:00
+date: 2009-10-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,14 +41,18 @@ files:
 - active_collection.gemspec
 - lib/active_collection.rb
 - lib/active_collection/base.rb
+- lib/active_collection/conditions.rb
 - lib/active_collection/includes.rb
 - lib/active_collection/member_class.rb
+- lib/active_collection/new_scope.rb
 - lib/active_collection/order.rb
 - lib/active_collection/pagination.rb
 - lib/active_collection/scope.rb
 - lib/active_collection/serialization.rb
-- spec/active_collection_spec.rb
+- spec/base_spec.rb
+- spec/member_class_spec.rb
 - spec/pagination_spec.rb
+- spec/proxy_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -80,6 +84,8 @@ signing_key:
 specification_version: 3
 summary: A lazy-loading, Array-like collection proxy for ActiveRecord that understands conditions and paging.
 test_files: 
-- spec/active_collection_spec.rb
+- spec/base_spec.rb
+- spec/member_class_spec.rb
 - spec/pagination_spec.rb
+- spec/proxy_spec.rb
 - spec/spec_helper.rb