dase 3.2.2 → 3.2.4

data/README.md

@@ -37,28 +37,36 @@ Since it's a sort of a "hack", make sure you specified the version number for "d
   end
 ```
 
-### Advanced usage:
-
-You can specify a hash of options which will be passed to the underlying finder 
+### Using :conditions hash
+Specify a hash of options which will be passed to the underlying finder 
 which retrieves the association. Valid keys are: :conditions, :group, :having, :joins, :include
 ```
-Author.includes_count_of(:articles, :conditions => {:year => 2012})
+Author.includes_count_of(:articles, :conditions => {:year => 2012})   # counts only articles in year 2012
 ```
 
+### Using scope merging
+```
+scope = Article.where(:year => 2012)
+Author.includes_count_of(:articles, :only => scope)   # counts only articles in year 2012
+```
 
-### Known problems
-
-1. Dase doesn't support :through option on associations
-2. You can't put includes_count_of calls into a scope declaration, like this:
+### Using block syntax
+```
+Author.includes_count_of(:articles){ where(:year => 2012) }        # in the block, 'self' is a Relation instance
+Author.includes_count_of(:articles){ |scope| scope.where(:year => 2012) }   # 'self' is the same inside and outside the block
+```
 
+### Renaming counter column
 ```
-class Author
-   scope :with_counters, lambda {
-      includes_count_of(:articles)    # this will not work!!!
-   }
-end
+sites = WebSite.includes_count_of(:users, :conditions => {:role => 'admin'}, :as => :admins_count)   
+sites.each { |site| puts "Site #{site.url} has #{site.admins_count} admin users" }
 ```
 
+
+### Known problems
+
+Dase doesn't support polymorphism.
+
 ## How it works
 
 Here's a pseudo-code that gives an idea on how it works internally

data/lib/dase/mp_active_record_base.rb

@@ -4,7 +4,7 @@ module Dase
   module ARBaseInstanceMethods
     def set_dase_counter(name, value)
       @dase_counters ||= {}
-      @dase_counters[name] = value
+      @dase_counters[name.to_sym] = value
     end
 
     def get_dase_counter(name)
@@ -23,6 +23,15 @@ module Dase
       end
     end
 
+    # This method uses traditions counting method
+    # and stores the results in dase-compatible form
+    def refresh_dase_counters!(*associations)
+      associations.flatten.each do |assoc|
+        value = self.send(assoc).count   # i.e. book.quotes.count
+        set_dase_counter "#{column}_count", value   # i.e. book.quotes_count = value
+      end
+    end
+
     private
 
     def self.included(klass)

data/lib/dase/mp_active_record_relation.rb

@@ -5,29 +5,26 @@ module Dase
     def includes_count_of(*args)
       args.reject! { |a| a.blank? }
       options = args.extract_options!
-      options.assert_valid_keys(:as, :conditions, :group, :having, :limit, :offset, :joins, :include, :from, :lock)
+      options.assert_valid_keys(:proc, :as, :only, :conditions, :group, :having, :limit, :offset, :joins, :include, :from, :lock)
       return self if args.empty?
       if options.present? and args.many?
         raise ArgumentError, "includes_count_of takes either multiple associations OR single association + options"
       end
       relation = clone
       relation.dase_values ||= {}
+      #options[:proc] = block if block
       args.each do |arg|
-        if options[:as].present?
-          options[:association] = arg
-          relation.dase_values[options[:as].to_sym] = options
-        else
-          relation.dase_values[arg] = options
-        end
+        options[:association] = arg.to_sym
+        options[:as] = (options[:as] || "#{arg}_count").to_sym
+        relation.dase_values[options[:as]] = options
       end
       relation
     end
 
     def attach_dase_counters_to_records
       if dase_values.present? and !@has_dase_counters
-        dase_values.each do |association, options|
-          association = options.delete(:association) if options[:association]
-          Dase::Preloader.new(@records, association, options).run
+        dase_values.each do |name, options|
+          Dase::Preloader.new(@records, options[:association], options).run
         end
         @has_dase_counters = true
       end

data/lib/dase/preloader.rb

@@ -10,9 +10,18 @@ module Dase
     end
 
     # Not implemented yet
-    #class HasManyThrough < ::ActiveRecord::Associations::Preloader::HasManyThrough
-    #  include Dase::PreloaderMethods
-    #end
+    class HasManyThrough < ::ActiveRecord::Associations::Preloader::HasManyThrough
+      include Dase::PreloaderMethods
+
+      def prefixed_foreign_key
+        "#{reflection.active_record.table_name}.#{reflection.active_record_primary_key}"
+      end
+
+      def records_for(ids)
+        reflection.active_record.joins(reflection.name).
+            where(prefixed_foreign_key => ids)
+      end
+    end
 
     # an overloaded version of ActiveRecord::Associations::Preloader's preloader_for
     # which returns a class of a custom preloader for a given association
@@ -20,7 +29,8 @@ module Dase
       case reflection.macro
         when :has_many
           if reflection.options[:through]
-            raise NotImplementedError, "The support for HasManyThrough associations is not implemented yet"
+            HasManyThrough
+            #raise NotImplementedError, "The support for HasManyThrough associations is not implemented yet"
           else
             HasMany
           end

data/lib/dase/preloader_methods.rb

@@ -4,19 +4,36 @@ module Dase
     def initialize(klass, owners, reflection, preload_options)
       # grabbing our options
       preload_options = preload_options.clone
+      @dase_association = preload_options.delete(:association)
       @dase_counter_name = preload_options.delete(:as)
+      @dase_scope_to_merge = preload_options.delete(:only)
+      #@dase_proc = preload_options.delete(:proc)
       super(klass, owners, reflection, preload_options)
     end
 
+    def prefixed_foreign_key
+      "#{scoped.quoted_table_name}.#{reflection.foreign_key}"
+    end
+
     def preload
-      counter_name = @dase_counter_name || "#{reflection.name}_count".to_sym
       pk = model.primary_key.to_sym
       ids = owners.map(&pk)
-      fk = "#{scoped.quoted_table_name}.#{reflection.foreign_key}"
-      counters_hash = records_for(ids).count(group: fk)
+      scope = records_for(ids)
+      scope = scope.merge(@dase_scope_to_merge) if @dase_scope_to_merge
+      #if @dase_proc # support for includes_count_of(...){ where(...) } syntax
+      #  case @dase_proc.arity
+      #    when 0
+      #      scope = scope.instance_eval &@dase_proc
+      #    when 1
+      #      scope = @dase_proc.call(scope)
+      #    else
+      #      raise ArgumentError, "The block passed to includes_count_of takes 0 or 1 arguments"
+      #  end
+      #end
+      counters_hash = scope.count(:group => prefixed_foreign_key)
       owners.each do |owner|
         value = counters_hash[owner[pk]] || 0 # 0 is "default count", when no records found
-        owner.set_dase_counter(counter_name, value)
+        owner.set_dase_counter(@dase_counter_name, value)
       end
     end
 

data/lib/dase/version.rb

@@ -1,3 +1,3 @@
 module Dase
-  VERSION = "3.2.2"
+  VERSION = "3.2.4"
 end

data/test/fixtures/author.rb

@@ -5,6 +5,7 @@ class Author < ActiveRecord::Base
   has_many :old_books, :class_name => "Book", :conditions => {:year => 1990}
 
   has_many :quotes, :through => :books
+  has_many :scores, :through => :quotes
 
   scope :with_count_of_books, lambda { includes_count_of(:books) }
 

data/test/fixtures/book.rb

@@ -4,4 +4,6 @@ class Book < ActiveRecord::Base
   belongs_to :author
   has_many :quotes
 
+  scope :year2012, lambda{ where(:year => 2012) }
+
 end

data/test/fixtures/like.rb

@@ -0,0 +1,4 @@
+class Like < ActiveRecord::Base
+  belongs_to :quote
+  has_one :author, :through => :quote
+end

data/test/fixtures/likes.yml

@@ -0,0 +1,10 @@
+good:
+  id: 1
+  quote_id: 1
+  score: 5
+
+bad:
+  id: 2
+  quote_id: 1
+  score: 2
+

data/test/fixtures/quote.rb

@@ -1,4 +1,5 @@
 class Quote < ActiveRecord::Base
   belongs_to :book
-
+  #has_one :author, :through => :book
+  has_many :scores, :class_name => 'Like', :foreign_key => "quote_id"
 end

data/test/fixtures/schema.rb

@@ -19,4 +19,10 @@ ActiveRecord::Schema.define do
     t.integer "book_id"
   end
 
+  create_table "likes", :force => true do |t|
+    t.integer "score"
+    t.integer "quote_id"
+  end
+
+
 end

data/test/test_dase.rb

@@ -57,13 +57,42 @@ class TestBase < Test::Unit::TestCase
       compare_counts(traditional_counts, dase_counts, true_counts)
     end
 
-    # Not yet implemented
-    #should "count quotations" do
-    #  traditional_counts = Author.order(:name).map { |a| a.quotes.count }
-    #  dase_counts = Author.order(:name).includes_count_of(:quotes).map { |a| a.quotes_count }
+    should "count books for year 2012 using :only option" do
+      dase_counts = Author.includes_count_of(:books, :only => Book.year2012).order(:name).map { |a| a.books_count }
+      # the order is: Bobby, Joe, Teddy - due to order(:name)
+      true_counts = [0, 1, 0] # see books.yml
+      assert_equal true_counts, dase_counts, "results mismatch"
+    end
+
+    #should "count using block conditions (arity: 0)" do
+    #  dase_counts = Author.includes_count_of(:books){where(:year => 2012)}.order(:name).map { |a| a.books_count }
     #  # the order is: Bobby, Joe, Teddy - due to order(:name)
-    #  true_counts = [2, 1, 0] # see quotes.yml
-    #  compare_counts(traditional_counts, dase_counts, true_counts)
+    #  true_counts = [0, 1, 0] # see books.yml
+    #  assert_equal true_counts, dase_counts, "results mismatch"
     #end
+    #
+    #should "count using block conditions (arity: 1)" do
+    #  @y = 2012
+    #  dase_counts = Author.includes_count_of(:books){ |books| books.where(:year => @y)}.order(:name).map { |a| a.books_count }
+    #  # the order is: Bobby, Joe, Teddy - due to order(:name)
+    #  true_counts = [0, 1, 0] # see books.yml
+    #  assert_equal true_counts, dase_counts, "results mismatch"
+    #end
+
+    should "count likes" do
+      dase_counts = Author.order(:name).includes_count_of(:scores).map { |a| a.scores_count }
+      # the order is: Bobby, Joe, Teddy - due to order(:name)
+      true_counts = [0, 2, 0] # see likes.yml
+      assert_equal true_counts, dase_counts, "results mismatch"
+    end
+
+    should "count quotations" do
+      traditional_counts = Author.order(:name).map { |a| a.quotes.count }
+      dase_counts = Author.order(:name).includes_count_of(:quotes).map { |a| a.quotes_count }
+      # the order is: Bobby, Joe, Teddy - due to order(:name)
+      true_counts = [2, 1, 0] # see quotes.yml
+      compare_counts(traditional_counts, dase_counts, true_counts)
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dase
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-23 00:00:00.000000000 Z
+date: 2012-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70318116217480 !ruby/object:Gem::Requirement
+  requirement: &70360982006260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70318116217480
+  version_requirements: *70360982006260
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70318116214540 !ruby/object:Gem::Requirement
+  requirement: &70360982005420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70318116214540
+  version_requirements: *70360982005420
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70318116213300 !ruby/object:Gem::Requirement
+  requirement: &70360982004720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70318116213300
+  version_requirements: *70360982004720
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70318116211980 !ruby/object:Gem::Requirement
+  requirement: &70360982003420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *70318116211980
+  version_requirements: *70360982003420
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70318116211100 !ruby/object:Gem::Requirement
+  requirement: &70360982001620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70318116211100
+  version_requirements: *70360982001620
 description: ! "Dase gem creates includes_count_of method in ActiveRecord::Relation\n
   \                        to count associated records efficiently. See examples at
   https://github.com/vovayartsev/dase\n                      "
@@ -91,6 +91,8 @@ files:
 - test/fixtures/authors.yml
 - test/fixtures/book.rb
 - test/fixtures/books.yml
+- test/fixtures/like.rb
+- test/fixtures/likes.yml
 - test/fixtures/quote.rb
 - test/fixtures/quotes.yml
 - test/fixtures/schema.rb
@@ -126,6 +128,8 @@ test_files:
 - test/fixtures/authors.yml
 - test/fixtures/book.rb
 - test/fixtures/books.yml
+- test/fixtures/like.rb
+- test/fixtures/likes.yml
 - test/fixtures/quote.rb
 - test/fixtures/quotes.yml
 - test/fixtures/schema.rb