eager_counting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 782fb92403f0813636efd75ebce1f29c15c8471e
+  data.tar.gz: 57f313359f23e84271d7ed34457f360200193b64
+SHA512:
+  metadata.gz: 120cc93ef8078e302b3e5f640c1e6233dd646ae9c688e0e876cc3084220498c4cd24bd052620902a270eaa95d5389575b72350eb049fe1c306f376343c8aa41c
+  data.tar.gz: 327228c462d576bb4140b8defe8d460907ca3c50a7e8c9d1a5bb9145e44e3236d15c7e8a0c280f0d1fb7207ac26fac087cc43171c203679e4e33ba93e44ecbdc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tim 'S.D.Eagle' Zeitz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# EagerCounting
+Avoid N+1 Queries caused by `count` calls!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eager_counting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eager_counting
+
+## Usage
+
+Include the `EagerCounting::CountBy` module on any `ActiveRecord` class.
+
+```ruby
+class Comment < ActiveRecord::Base
+  include EagerCounting::CountBy
+  belongs_to :author
+  belongs_to :commentable, polymorphic: true
+end
+```
+
+This will allow you to call `count_by` on scopes of this class.
+`count_by` performs a count grouped by the given association.
+This means it will return a hash mapping the ids of the associated objects
+to the number of rows this class has for each of them.
+
+### Examples:
+
+```ruby
+Comment.count_by(:author) # => hash with author id mapped to number of comments this user made
+```
+
+You can call this method on any relation object of the class you included it on
+
+```ruby
+Comment.where(spam: false).count_by(:author) # => will only count non spam comments
+```
+
+With the second argument you can also limit the scope of the association by which to count
+
+```ruby
+Comment.count_by(:author, User.where(admin: false)) # => only count comments by non admin users
+```
+
+By passing an hash as the association you can count by joined associations
+
+```ruby
+Comment.count_by(author: { city: :country }) # => count comments by the country their from
+```
+
+You can also use it on polymoprhic associations.
+For that the second parameter is necessary to select the type of things to count by.
+
+```ruby
+Comment.count_by(:commentable, Picture.all) # => how many comments does each picture have?
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/foobar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EagerCounting'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/eager_counting.rb

@@ -0,0 +1,4 @@
+require 'eager_counting/count_by'
+
+module EagerCounting
+end

data/lib/eager_counting/count_by.rb

@@ -0,0 +1,87 @@
+require 'active_support/concern'
+
+module EagerCounting
+  ##
+  # This module contains the ::count_by method.
+  # Include it to enable ::count_by on your model class
+  module CountBy
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      ##
+      # Performs a count grouped by the given association.
+      # This means it will return a hash mapping the ids of the associated objects
+      # to the number of rows this class has for each of them.
+      #
+      # Example:
+      #
+      #   class Comment < ActiveRecord::Base
+      #     include EagerCounting::CountBy
+      #     belongs_to :author
+      #     belongs_to :commentable, polymorphic: true
+      #   end
+      #
+      #   Comment.count_by(:author) # => hash with author id mapped to number of comments this user made
+      #
+      # You can call this method on any relation object of the class you included it on
+      #
+      #   Comment.where(spam: false).count_by(:author) # => will only count non spam comments
+      #
+      # With the second argument you can also limit the scope of the association by which to count
+      #
+      #   Comment.count_by(:author, User.where(admin: false)) # => only count comments by non admin users
+      #
+      # By passing an hash as the association you can count by joined associations
+      #
+      #   Comment.count_by(author: { city: :country }) # => count comments by the country their from
+      #
+      # You can also use it on polymoprhic associations.
+      # For that the second parameter is necessary to select the type of things to count by.
+      #
+      #   Comment.count_by(:commentable, Picture.all) # => how many comments does each picture have?
+      #
+      def count_by(association_target, scope = nil)
+        association = deepest_value(association_target).to_s
+        scope ||= association.camelize.constantize.all
+        join = without_deepest_value(association_target)
+        target_model = self
+
+        if association_target.is_a? Hash
+          target_model = deepest_value(join).to_s.singularize.camelize.constantize
+        end
+
+        query = joins(join)
+          .merge(target_model.where(association => scope))
+          .group(association_column_name(target_model, association))
+          .count
+
+        Hash.new(0).merge query
+      end
+
+      private
+
+      def association_column_name(klass, association)
+        "#{klass.table_name}.#{klass.reflections[association].foreign_key}"
+      end
+
+      def without_deepest_value(map)
+        return {} unless map.is_a? Hash
+        key, value = map.to_a.first
+        if value.is_a? Hash
+          { key => without_deepest_value(value) }
+        else
+          key
+        end
+      end
+
+      def deepest_value(value)
+        if value.is_a? Hash
+          deepest_value(value.values.first)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/eager_counting/version.rb

@@ -0,0 +1,3 @@
+module EagerCounting
+  VERSION = "0.1.0"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/action.rb

@@ -0,0 +1,6 @@
+class Action < ActiveRecord::Base
+  include EagerCounting::CountBy
+
+  belongs_to :visit
+  belongs_to :product
+end

data/test/dummy/app/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment < ActiveRecord::Base
+  include EagerCounting::CountBy
+
+  belongs_to :commentable, polymorphic: true
+end

data/test/dummy/app/models/country.rb

@@ -0,0 +1,3 @@
+class Country < ActiveRecord::Base
+  has_many :places
+end

data/test/dummy/app/models/place.rb

@@ -0,0 +1,6 @@
+class Place < ActiveRecord::Base
+  belongs_to :country
+
+  has_many :comments, as: :commentable
+  has_many :visits
+end

data/test/dummy/app/models/product.rb

@@ -0,0 +1,3 @@
+class Product < ActiveRecord::Base
+  has_many :actions
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many :visits
+end

data/test/dummy/app/models/visit.rb

@@ -0,0 +1,8 @@
+class Visit < ActiveRecord::Base
+  include EagerCounting::CountBy
+
+  belongs_to :place
+  belongs_to :user
+
+  has_many :actions
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application