estimate_count 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4820f4b135cde08c8d827ebe9232a0b7fba84d33deefb0b866b904b14cddc754
-  data.tar.gz: 303e049e4e60d36dfbe53b3c58fdbbe3514b9c40c628d79bf42bc779ce30fc15
+  metadata.gz: 7aea186e3b48086345021244c6ec7fb24e5fba0d2eb464e0ef5858c6843539dd
+  data.tar.gz: 4e3988b31ecceec9a39141e2771745bc9bfda212521c3f92faebb7ae680d8898
 SHA512:
-  metadata.gz: 027fe306e6a234b4b3cfd0d810f44990186e5e9e5d59a3e8e5f2ead9acd3e14817729577aad748bb4baccaaafc673cef8fe21d79fbd1cf4ad32e99912c618623
-  data.tar.gz: 89dd325d30d773c160681a4e48660cc0239113ee9b41cef257292b93f75595644af8afab1677beb8ecc108650b8198275b6ecdf829ccdee164aa03de36d91741
+  metadata.gz: b9f4074b66c6a2e2cb42b2816617f4af9ded4b18500c9dc4fe92e484f2f50a9d9692790539712d021db62725428b5009bf06d1cb5dfff8e6a737ca6f5985f952
+  data.tar.gz: dd8ac6e023b16cd382b167703352ff7b254dbc3af06d89a034694aa0ff33b5375b03879ab4c3e548b3f8f46ae94cd87bb6c371d46e6b9f8f539a52da1b8e0051

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
+
+gem "pry"

data/Gemfile.lock

@@ -1,29 +1,34 @@
 PATH
   remote: .
   specs:
-    estimate_count (0.1.0)
+    estimate_count (0.3.0)
       activerecord
-      pg
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activerecord (7.0.3.1)
-      activemodel (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activesupport (7.0.3.1)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    concurrent-ruby (1.1.10)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.16.2)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    mysql2 (0.5.5)
     pg (1.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (13.0.6)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -38,17 +43,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
+  arm64-darwin-21
   arm64-darwin-22
+  ruby
+  x86_64-linux
 
 DEPENDENCIES
-  activerecord
   estimate_count!
+  mysql2
+  pg
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.3.26
+   2.3.10

data/README.md

@@ -2,11 +2,17 @@
 
 This gems help with a common pagination problem in which the calculation of total number of pages takes too long.
 
-Currently only PostgreSQL is supported.
+Currently only PostgreSQL and MySQL are supported.
 
 ## Problem
 
-Let's say you have a table with 1 million records and you want to paginate it. You add filters and sorting. You can use the `count` method to get the total number of records in the table. However, this method will take a long time to execute. This is because the database has to count all the records in the table.
+Let's say you have a table with 1 million records and you want to paginate it. You add filters and sorting. 
+
+Suddenly your performance drops even though you're only displaying a few records per page.
+
+The problematic part is `#count`, which causes the entire scope to be calculated and then counted. This is slow.  However you can use table statistics to estimate the number of records in the table (same as `rows` in `EXPLAIN`). This is much faster.
+
+Be aware though that this rely on table statistics being refreshed from time to time.
 
 ## Example
 Given the following code:
@@ -31,17 +37,13 @@ In a view:
 # app/views/users/index.html.erb
 Total pages - <%= @users.total_pages %>
 ```
-The above code will work fine. However, if you have a table with 1 million records, the `count` method will take a long time to execute. This is because the database has to count all the records in the table.
+If you want to use estimate number of pages change the above line to:
 
 ```ruby
 # app/views/users/index.html.erb
-Total pages - About <%= (@users.estimate_count / @users.per_page).ceil  %>
+Total pages - About <%= (@users.estimate_count / @users.per_page).ceil %>
 ```
 
-This extracts the estimation from PostgreSQL statistics and uses it to calculate the total number of pages. This is much faster than the `count` method. 
-
-You can use it with any pagination library (or without one).
-
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -56,7 +58,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 This gem adds a method `#estimate_count` to the `ActiveRecord::Relation` class.
 
-You can use it for any scope
+You can use it for any scope:
 
 ```ruby
 User.active.estimate_count
@@ -73,7 +75,7 @@ User.active.estimate_count(threshold: 1000)
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` 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`. 
 

data/docker-compose.yml

@@ -0,0 +1,27 @@
+version: "3"
+
+services:
+  mysql:
+      image: mysql:8.0
+      environment:
+          MYSQL_ROOT_PASSWORD: root
+          MYSQL_DATABASE: test
+          MYSQL_USER: test
+          MYSQL_PASSWORD: test
+      ports:
+          - 3306:3306
+      volumes:
+          - ./db/mysql:/var/lib/mysql
+      healthcheck:
+          test: [ "CMD", "mysql", "-u", "root", "-e", "USE test;" ]
+          retries: 1
+  postgresql:
+      image: postgres:15-alpine
+      environment:
+          POSTGRES_USER: test
+          POSTGRES_PASSWORD: test
+          POSTGRES_DB: test
+      ports:
+          - 5432:5432
+      volumes:
+          - ./db/postgresql:/var/lib/postgresql/data

data/lib/estimate_count/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EstimateCount
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/estimate_count.rb

@@ -1,18 +1,36 @@
 # frozen_string_literal: true
 
 require_relative "estimate_count/version"
+require "active_record"
 
 module ActiveRecord
   class Base
     def self.estimate_count(threshold: 1000)
-      full_scope = current_scope.limit(nil).offset(nil)
+      full_scope = current_scope&.limit(nil)&.offset(nil) || all
       rows = estimate_rows(full_scope.to_sql)
       rows = full_scope.count if threshold.is_a?(Integer) && rows < threshold
       rows
     end
 
     private_class_method def self.estimate_rows(query)
+      case connection.adapter_name
+      when "PostgreSQL"
+        estimate_rows_postgresql(query)
+      when "MySQL", "Mysql2"
+        estimate_rows_mysql(query)
+      else
+        raise "Unsupported database"
+      end
+    end
+
+    private_class_method def self.estimate_rows_postgresql(query)
       connection.execute("EXPLAIN #{query}").to_a.first["QUERY PLAN"].match(/rows=(\d+)/)[1].to_i
     end
+
+    private_class_method def self.estimate_rows_mysql(query)
+      result = connection.execute("EXPLAIN FORMAT=TRADITIONAL #{query}")
+      index = result.fields.index("rows")
+      result.first[index].to_i
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: estimate_count
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Hasiński
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-04 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -31,7 +31,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -52,6 +80,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docker-compose.yml
 - lib/estimate_count.rb
 - lib/estimate_count/version.rb
 - sig/estimate_count.rbs
@@ -77,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Adds a method to get an estimate count for an ActiveRecord::Relation