quick_count 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ae7f0ee1a739008ee5625dbbed9a42940592c9f
-  data.tar.gz: 88a7d737a21479b990f46d1f9eda27e00e8b2a5b
+  metadata.gz: 2c460d264424aeda14e8f593465e17425dca7fac
+  data.tar.gz: b2e0b54686180053afc2726ab7186b690735f80c
 SHA512:
-  metadata.gz: 21368a392aef71e6150be1482e60a7a9b74c5510e3e94f34efd401cebecdb4cba48557790176692f3a623ac351e9826d6636884c6ca20ab70917ad758b264951
-  data.tar.gz: ff4a499e304bcac6ca0562606e80d5c19321437e46f7b60c23f58425d069b1e2d2f7bec6e2f9caeb1f127d0836d94f7d6b2a813f7855c5045b64e62ec60b53d8
+  metadata.gz: 82e0482436336ebcb1810d73e051435a7c215e1e0a73917b9d11464ecf15d8300f79634b1e15f9ae0223998798f0841629f5da2b7b55725c4d727f6b3a32d205
+  data.tar.gz: 855be602cff1d114638664896baaef61f1496085327851d66f0c1d7cc5b119cba150229a80a740989c768e98008d5c52b950647fa520ade73952032d80a5f844

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in quick_count.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+group :development, :test do
+  gem 'pg', platform: :mri
+  gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+end
+

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    quick_count (0.0.1)
+      activemodel (>= 4.1, < 6)
+      activerecord (>= 4.1, < 6)
+      activesupport (>= 4.1, < 6)
+      pg (>= 0.12.0, < 0.30.0)
+      railties (>= 4.1, < 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
+      arel (~> 7.0)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    builder (3.2.3)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    i18n (0.8.1)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    method_source (0.8.2)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    pg (0.20.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-jdbcpostgresql-adapter
+  bundler (~> 1.5)
+  pg
+  pry (~> 0)
+  quick_count!
+  rspec (~> 3.3)
+
+BUNDLED WITH
+   1.13.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Dale Stevens
+
+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,73 @@
+# QuickCount
+
+Based on the answer http://stackoverflow.com/a/7945274/1454158.
+
+It currently supports only Postgres.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quick_count'
+```
+
+And then execute:
+
+    $ bundle
+
+And in a rails console:
+
+    $ QuickCount.install
+
+Or install it yourself as:
+
+    $ gem install quick_count
+
+## Usage
+
+```ruby
+# user.rb
+
+class User < ActiveRecord::Base
+
+end
+
+User.quick_count
+```
+
+
+## Uninstallation
+
+Remove this line to your application's Gemfile:
+
+```ruby
+gem 'quick_count'
+```
+
+And then execute:
+
+    $ bundle
+
+And in a rails console:
+
+    $ QuickCount.uninstall
+
+## License
+Released under the MIT license - http://opensource.org/licenses/MIT
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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]/quick_count.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/count_estimate/active_record/relation.rb

@@ -0,0 +1,15 @@
+require 'active_support/concern'
+
+module CountEstimate
+  module ActiveRecord
+    module Relation
+
+      def count_estimate
+        my_statement = ::ActiveRecord::Base.connection.quote(to_sql)
+        result = ::ActiveRecord::Base.connection.execute("SELECT count_estimate(#{my_statement})")
+        result[0]["count_estimate"]
+      end
+
+    end
+  end
+end

data/lib/quick_count/active_record/base.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+
+module QuickCount
+  module ActiveRecord
+    module Base
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def quick_count
+          result = ::ActiveRecord::Base.connection.execute("SELECT quick_count('#{table_name}')")
+          result[0]["quick_count"]
+        end
+
+        def count_estimate
+          my_statement = ::ActiveRecord::Base.connection.quote(to_sql)
+          result = ::ActiveRecord::Base.connection.execute("SELECT count_estimate(#{my_statement})")
+          result[0]["count_estimate"]
+        end
+
+      end
+
+    end
+  end
+end

data/lib/quick_count/railtie.rb

@@ -0,0 +1,20 @@
+require 'rails/railtie'
+require 'quick_count/active_record/base'
+require 'count_estimate/active_record/relation'
+require 'pry'
+
+module QuickCount
+  class Railtie < Rails::Railtie
+
+    # rake_tasks do
+    #   load "../tasks/quick_count_tasks.rake"
+    # end
+
+    initializer 'quick_count.load' do |app|
+      ActiveSupport.on_load(:active_record) do
+        QuickCount.load
+      end
+    end
+
+  end
+end

data/lib/quick_count/version.rb

@@ -0,0 +1,3 @@
+module QuickCount
+  VERSION = "0.0.2"
+end

data/lib/quick_count.rb

@@ -0,0 +1,64 @@
+require 'quick_count/railtie'
+require 'active_record'
+require 'rake'
+
+module QuickCount
+
+  def self.root
+    @root ||= Pathname.new(File.dirname(File.expand_path(File.dirname(__FILE__), '/../')))
+  end
+
+  def self.load
+    ::ActiveRecord::Base.send :include, QuickCount::ActiveRecord::Base
+    ::ActiveRecord::Relation.send :include, CountEstimate::ActiveRecord::Relation
+  end
+
+  def self.install
+    ::ActiveRecord::Base.connection.execute(<<-eos
+      CREATE OR REPLACE FUNCTION quick_count(table_name text) RETURNS bigint AS
+      $func$
+      DECLARE
+          rec   record;
+          rows  integer;
+      BEGIN
+        RETURN (SELECT SUM(estimate) AS estimate FROM (
+        SELECT
+            SUM(child.reltuples::bigint) AS estimate
+        FROM pg_inherits
+            JOIN pg_class parent            ON pg_inherits.inhparent = parent.oid
+            JOIN pg_class child             ON pg_inherits.inhrelid   = child.oid
+            JOIN pg_namespace nmsp_parent   ON nmsp_parent.oid  = parent.relnamespace
+            JOIN pg_namespace nmsp_child    ON nmsp_child.oid   = child.relnamespace
+        WHERE parent.relname = table_name
+        GROUP BY parent.reltuples
+        UNION SELECT reltuples::bigint AS estimate FROM pg_class where relname=table_name) as tables);
+      END
+      $func$ LANGUAGE plpgsql;
+    eos
+    )
+    ::ActiveRecord::Base.connection.execute(<<-eos
+        CREATE OR REPLACE FUNCTION count_estimate(query text) RETURNS integer AS
+        $func$
+        DECLARE
+            rec   record;
+            rows  integer;
+        BEGIN
+            FOR rec IN EXECUTE 'EXPLAIN ' || query LOOP
+                rows := substring(rec."QUERY PLAN" FROM ' rows=([[:digit:]]+)');
+                EXIT WHEN rows IS NOT NULL;
+            END LOOP;
+
+            RETURN rows;
+        END
+        $func$ LANGUAGE plpgsql;
+    eos
+    )
+  end
+
+  def self.uninstall
+    ::ActiveRecord::Base.connection.execute("DROP FUNCTION quick_count(text);")
+    ::ActiveRecord::Base.connection.execute("DROP FUNCTION count_estimate(text);")
+  end
+
+end
+

data/quick_count.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quick_count/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'quick_count'
+  spec.version       = QuickCount::VERSION
+  spec.authors       = ['Dale Stevens']
+  spec.email         = ['dale@twilightcoders.net']
+
+  spec.summary       = 'Quickly get an accurate count estimation for large tables.'
+  spec.homepage      = "https://github.com/TwilightCoders/quick_count"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.1'
+
+  rails_versions = ['>= 4.1', '< 6']
+
+  spec.add_dependency 'pg', ['>= 0.12.0', '< 0.30.0']
+  spec.add_dependency 'activerecord', rails_versions
+  spec.add_dependency 'activesupport', rails_versions
+  spec.add_dependency 'activemodel', rails_versions
+  spec.add_dependency 'railties', rails_versions
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'pry', '~> 0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quick_count
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dale Stevens
@@ -158,7 +158,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/count_estimate/active_record/relation.rb
+- lib/quick_count.rb
+- lib/quick_count/active_record/base.rb
+- lib/quick_count/railtie.rb
+- lib/quick_count/version.rb
+- quick_count.gemspec
 homepage: https://github.com/TwilightCoders/quick_count
 licenses:
 - MIT