dase 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1a4d6f990d789d3a9a7a7d79995e3bd9177c98a
-  data.tar.gz: 5c4be473b6ddc9a2c8933207044ae224d8ebe1bc
+  metadata.gz: 75b57d1d16a33aaf6039f6aff02fb26342ef15c3
+  data.tar.gz: bb177eeae7391ba894d15395d05917bb71b1de82
 SHA512:
-  metadata.gz: 1b41222641e271a29db1a2c7d9283d00d005f9ebdca0317d13d2bb8a11daa1d16e3c490afd3ca86ddbceb5bb0b58bbc3d870ed057d09c40c6f2d5596b3b07fa3
-  data.tar.gz: 4790d98c1bcfd56ba5e8334b0841814f5f4936163449a3c09b8d90682caa390f006fff51c3a59f28af127443f72f044f95212d2ceba9f3b13e38c1dc1565d846
+  metadata.gz: f128f08ff9148ec3e97b3c781ca502cbe6863ee5440d577f815723f6d1d6c6cdc6feb6760c840db9818986f5b87cbed10e235a7bb8ad233579c1b9e8d80ee9b5
+  data.tar.gz: 9914f5bc4f059db6c6395bf754136d8d910b95233333236c2f4a2d928b35f8d8181e910777eb54fd0c747ca70b6176f9730034971516cfd649cdda7a3cc2b774

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
   - "1.9.3"
-  - rbx-19mode
+  - "2.1.4"
+  #- rbx-19mode
   #- jruby-19mode # JRuby in 1.9 mode
 
 # uncomment this line if your project needs to run something other than `rake`:

data/README.md

@@ -2,99 +2,75 @@
 
 ## Overview
 
-Dase gem provides 'includes_count_of' method on a relation, which works similar to ActiveRecord's 'includes' method.
-
-![Dase example](https://vovayartsev-home.s3.amazonaws.com/dase-mockup.png)
-
-Calling 'includes_count_of(:articles)' on a relation object adds 'articles_count' method to each of the authors:
-```
-  authors = Author.includes(:publisher).includes_count_of(:articles, :conditions => {:year => 2012})  
-  authors.first.name             # => 'Billy'                
-  authors.first.articles_count   # => 2                
-```
-
-
-## Installation
-
-Add this line to your Rails 3.2.x application's Gemfile:
-
-    gem 'dase', "~> 3.2.4"
+Dase gem provides `includes_count_of` method on a relation, which works similar to ActiveRecord's `preload` method and solves [N+1 query problem](http://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations) when counting records in `has_many` ActiveRecord associations.
 
 ## Usage
 
-### Basic usage:
+Given this data in the DB:
+![Dase example](https://dl.dropboxusercontent.com/u/8560625/dase.png)
 
+and this Rails model definition
+```ruby
+class Author
+  has_many :articles
+end
 ```
-  class Author
-    has_many :articles
-  end
-  
-  Author.includes_count_of(:articles).find_each do |author|
-    puts "#{author.name} has #{author.articles_count} articles published"
-  end
+you can now write this:
+```
+  authors = Author.includes_count_of(:articles)
+  billy = authors.first    # => #<Author name: 'Billy'>                
+  billy.articles_count     # => 2                
 ```
 
-### 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
+with conditions on associated records (only articles in year 2012)
 ```
-Author.includes_count_of(:articles, :conditions => {:year => 2012})   # counts only articles in year 2012
+  Author.includes_count_of(:articles, where: {year: 2012} ) 
 ```
 
-### Using scope merging
+using lambda syntax (in v4.1 and greater)
 ```
-class Article
-  belongs_to :author
-  scope this_year, lambda { where(:year => 2012) }
-end 
-
-results = Author.includes_count_of(:articles, :only => Article.this_year)   
-results.first.articles_count  # => # number of articles of given Author for year 2012 only
+  Author.includes_count_of(:articles, -> { where(year: 2012) } )
 ```
-This is achieved by merging the association scope with the scope provided as ":only => ..." option. 
-No additional checks are performed, and providing the association of proper type is solely your responsibility.
 
-
-### Renaming counter column
+with renamed counter method
 ```
-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" }
+  Author.includes_count_of(:articles, -> { where(year: 2012) }, as: :number_of_articles_in_2012)
 ```
 
-## Compatibility
-
-### Rails versions
-
-This gem is for Rails 3.2.x . Earlier versions are not supported.
-
-Note: the Dase gem version number correlates with the Active Record's versions number,
-which it has been tested with.
-E.g. the latest 3.2.* version of Dase will play nicely with the latest 3.2.* version of Active Record.
-Since dase gem is a sort of a "hack", make sure you specified the version number for "dase" gem in your Gemfile.
-
-### Polymorphic associations and HasManyThrough associations
-
-Polymorphic associations and HasManyThrough associations support should work, but it is not tested quite well.
-Bug reports and pull requests are very welcome.
+with multiple associations counted at once
+```
+  Author.includes_count_of(:articles, :photos, :tweets)
+```
 
-### jRuby support
+## Installation
 
-Not yet
+| Rails version | Add this to Gemfile    |
+|---------------|------------------------|
+| 3.2.x         | gem 'dase', '~> 3.2.0' |
+| 4.0.x         |    ----- N/A -----     |
+| 4.1.x         | gem 'dase', '~> 4.1.0' |
+| 4.2.0.beta2         | gem 'dase', :github => 'vovayartsev/dase', :branch => 'rails-4-2'           |
 
-## How it works
+## Under the hood
 
-Here's a pseudo-code that gives an idea on how it works internally
+When a relation is "materialized", we run a custom preloader which calculates the hash of counters in a single SQL query like this:
 ```
   counters_hash = Article.where(:year => 2012).count(:group => :author_id)
-  Author.find_each do |author|
-    puts "#{author.name} has #{counters_hash[author.id] || 0} articles published"
-  end
 ```
+then we add counters to the parent records like this:
+```
+  define_method(:articles_count) { counters_hash[author.id] || 0 }
+```
+
+## Alternative approaches
+Dase calculates counters dynamically every time you make an SQL query. It makes an extra SQL query for each association processed. These alternatives may be more efficient:
+* Cache column in the DB - see [counter_culture](https://github.com/magnusvk/counter_culture) gem, or [counter_cache](http://guides.rubyonrails.org/association_basics.html#counter_cache) in Rails Guides.
+* Using subquery in SELECT clause, or JOIN+SELECT+GROUP approach, as explained in [that video](http://www.youtube.com/watch?v=rJg3I-leoo4)
 
 ## Name origin
 
 The gem is named by the german mathematician [Johann Dase](http://en.wikipedia.org/wiki/Zacharias_Dase),
-who was a mental calculator - he could count and multiply numbers very quickly. 
+who was a [mental calculator](http://en.wikipedia.org/wiki/Mental_calculator) and could add and multiply numbers very quickly. 
 
 ## Contributing
 
@@ -105,5 +81,10 @@ who was a mental calculator - he could count and multiply numbers very quickly.
 5. Create new Pull Request
 
 
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/vovayartsev/dase/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/vovayartsev/dase/trend.png)](https://bitdeli.com/free "Bitdeli Badge") 
+
+
+
+
 

data/dase.gemspec

@@ -9,18 +9,16 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Vladimir Yartsev"]
   gem.licenses      = ["MIT"]
   gem.email         = ["vovayartsev@gmail.com"]
-  gem.description   = %q{Dase gem creates includes_count_of method in ActiveRecord::Relation
-                         to count associated records efficiently. See examples at https://github.com/vovayartsev/dase
-                      }
+  gem.description   = %q{includes_count_of method on ActiveRecord::Relation to solve N+1 query problem when counting associated records }
   gem.summary       = %q{Provides includes_count_of method on ActiveRecord::Relation to count associated records efficiently}
   gem.homepage      = "https://github.com/vovayartsev/dase"
 
-  gem.add_runtime_dependency "activesupport", ">= 4.0", "<= 4.2"
+  gem.add_runtime_dependency "activesupport", "~> 4.2.0"
 
   if defined? JRUBY_VERSION
     gem.add_development_dependency 'activerecord-jdbcsqlite3-adapter'
   else
-    gem.add_runtime_dependency "activerecord", ">= 4.0", "<= 4.2"
+    gem.add_runtime_dependency "activerecord", "~> 4.2.0"
     gem.add_development_dependency 'sqlite3', '~> 1.3'
   end
 

data/lib/dase/mp_active_record.rb

@@ -27,7 +27,7 @@ module Dase
 
     def merge(other)
       super(other).tap do |result|
-        result.dase_values.merge!(other.dase_values || {}) if other # other == nil is fine too
+        result.dase_values.merge!(other.dase_values) if other # other == nil is fine too
       end
     end
 

data/lib/dase/version.rb

@@ -1,3 +1,3 @@
 module Dase
-  VERSION = '4.1.1'
+  VERSION = '4.2.0'
 end

metadata

@@ -1,55 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dase
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Vladimir Yartsev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -92,9 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-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                      "
+description: 'includes_count_of method on ActiveRecord::Relation to solve N+1 query
+  problem when counting associated records '
 email:
 - vovayartsev@gmail.com
 executables: []
@@ -161,4 +148,3 @@ test_files:
 - test/fixtures/schema.rb
 - test/helper.rb
 - test/test_dase.rb
-has_rdoc: