active_record_group_count 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Jan Berdajs
+
+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.rdoc

@@ -0,0 +1,46 @@
+= ActiveRecord Group Count
+
+== Installing
+
+Add it to your project's Gemfile
+
+  gem "active_record_group_count"
+
+and run
+
+  bundle install
+
+== Description
+
+When you do group in Rails (SQL GROUP BY), count will return an ActiveSupport::OrderedHash. Sometimes you want the sum count (count of all the results, not by group). You can do count.keys.count, however this has serious performance issues if you have a lot of groups in the results.
+
+I wrote an ActiveRecord scope that will override the count method to perform a more optimised count query (of course it will now return a FixNum instead of a Hash). You can use this in combination with Kaminari and get much more efficient calculation of total_pages and total_count.
+
+
+== Use
+
+Just use the returns_count_sum scope before calling count:
+
+  MyModel.group(:something).returns_count_sum.count
+
+You can use it with Kaminari too (it's much faster):
+
+  MyModel.group(:something).returns_count_sum.page(1).per(10).total_pages
+
+== Tests
+
+I've tested this project using RSpec.
+
+You can run the tests by running
+
+  rake spec
+
+in the root directory of this gem (so you have to clone it first).
+
+== Problems
+
+If you have problems open an issue here on Github.
+
+== License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordGroupCount'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = %w(--color)
+  spec.pattern = 'spec{,/*/**}/*_spec.rb'
+end
+
+task :default  => [:spec]

data/lib/active_record_group_count.rb

@@ -0,0 +1,2 @@
+require 'active_record_group_count/scope'
+require 'active_record_group_count/railtie' if defined?(::Rails)

data/lib/active_record_group_count/railtie.rb

@@ -0,0 +1,9 @@
+module ActiveRecordGroupCount
+  class Railtie < Rails::Railtie
+    initializer "active_record_group_count.include_in_activerecord" do
+      ActiveSupport.on_load :active_record do
+        include ActiveRecordGroupCount::Scope
+      end
+    end
+  end
+end

data/lib/active_record_group_count/scope.rb

@@ -0,0 +1,19 @@
+module ActiveRecordGroupCount
+  module Scope
+    extend ActiveSupport::Concern
+
+    module ExtensionMethods
+      def count(*args)
+        scope = except(:select).select("1")
+        query = "SELECT count(*) AS count_all FROM (#{scope.to_sql}) x"
+        ActiveRecord::Base.connection.execute(query).first.try(:[], "count_all").to_i
+      end
+    end
+
+    module ClassMethods
+      def returns_count_sum
+        scoped.extending(ExtensionMethods)
+      end
+    end
+  end
+end

data/lib/active_record_group_count/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordGroupCount
+  VERSION = "0.0.1"
+end

data/spec/active_record_group_count/active_record_group_count_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+def create(attrs)
+  TestModel.new.tap do |model|
+    model.assign_attributes(attrs, without_protection: true)
+    model.save
+  end
+end
+
+describe ActiveRecordGroupCount::Scope do
+  before do
+    5.times { |i| create group_id: 1, value: i }
+    3.times { |i| create group_id: 2, value: i }
+  end
+
+  let(:scope) { TestModel.group(:group_id) }
+
+  it { scope.count.class.should == ActiveSupport::OrderedHash }
+  it { scope.count[1].should == 5 }
+  it { scope.count[2].should == 3 }
+  it { scope.pluck('MAX(value)').should == [4, 2] }
+
+  it { scope.returns_count_sum.count.should == 2 }
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: active_record_group_count
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jan Berdajs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Efficient Rails group count if you need the summed up count instead of
+  the hash. Can be used with Kaminari to speed up total_pages and total_count.
+email:
+- mrbrdo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_record_group_count/railtie.rb
+- lib/active_record_group_count/scope.rb
+- lib/active_record_group_count/version.rb
+- lib/active_record_group_count.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- spec/active_record_group_count/active_record_group_count_spec.rb
+homepage: https://github.com/mrbrdo/active_record_group_count
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Efficient Rails group count if you need the summed up count instead of the
+  hash.
+test_files:
+- spec/active_record_group_count/active_record_group_count_spec.rb