api_only_pagination 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6d061e8e8b177a9162d5d74908e3cc3ba5e2fc2bae27e5d4623c036b31a8690
-  data.tar.gz: 6a8de04ac9425d054808fbb3c5d4554c28a3444753229f2a047891ebaa183a63
+  metadata.gz: f9b67d605d6da1e12e6ecde2eb1dda4d48b6e9b22223c8e5f92085b639af3e28
+  data.tar.gz: b0a68efae6b619150cd9c2d123f3f4c2d616bfcec632a9a785b27d5c59ea7c3d
 SHA512:
-  metadata.gz: e187502965e71964a3224647ffbaa34e13763780c292d8f01a3c2e350632bff1738d314a10a8b9534bf84522f6fdfdf8bad020c6dca122907040f27cc19a692b
-  data.tar.gz: d2d059b67a91be138b6aae23d0506c41c5d5c8ee957f5de172e338d5e2c2c53a6786d51f77606e24295f452fd354e7f0a986dd0a28c794032391effbbc4ae9b5
+  metadata.gz: 80bd7f472ee99ce2da2018761bc2c028a2fb77762b1dead34e07f78a8fdbee0e7c24999892cb77403355c12e415801b60c7aa509bd85ed7db9bd3192382cbdd1
+  data.tar.gz: b21c4af4ac4ecb4d609d052e1be7ad4436f064706c8b29fe34f27483d0771e77a820cac12b49f3cc9560cbf82c3fea1e2b6d933031c6183c13b6251e25293f68

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -11,3 +11,7 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.5] - 2026-10-30
+
+- Fix: negative `page`/`per_page` values produced invalid SQL; any value that isn't a positive integer now falls back to the configured default
+- Fix: paginating relations with `group` or a custom `select` raised errors while counting
+- Fix: `last_page?` returned false for empty results and for pages past the end
+- Remove a no-op `ActiveRecord::Relation.include`; chained calls such as `User.where(...).do_paginate` are unaffected
+- Add a real spec suite (in-memory SQLite) and CI across Ruby 3.2–3.4 and ActiveRecord 6.1–8.1
+
 ## [0.1.0] - 2023-03-23
 
 - Initial release

data/CLAUDE.md

@@ -0,0 +1,40 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project
+
+`api_only_pagination` is a small Ruby gem that adds offset pagination to ActiveRecord models and relations for API-only apps. It returns a plain response object (data + page metadata) instead of view helpers. Depends on `activerecord >= 5.0`; targets Ruby >= 2.6.
+
+## Commands
+
+```bash
+bin/setup                         # install dependencies
+bin/console                       # IRB with the gem loaded
+bundle exec rake                  # specs + RuboCop (what CI runs)
+bundle exec rubocop               # lint
+bundle exec rspec                 # run specs
+bundle exec rspec spec/api_only_pagination_spec.rb:13   # single example
+bundle exec rake install          # install gem locally
+bundle exec rake release          # tag + push to rubygems (bump lib/api_only_pagination/version.rb first)
+```
+
+Specs run against an in-memory SQLite database; `spec/spec_helper.rb` defines the schema and a `User` model, and resets records and configuration before each example.
+
+CI (`.github/workflows/ci.yml`) runs specs against every Gemfile in `gemfiles/` (one per ActiveRecord version) on several Rubies. To reproduce one locally: `BUNDLE_GEMFILE=gemfiles/activerecord_7.2.gemfile bundle install && BUNDLE_GEMFILE=gemfiles/activerecord_7.2.gemfile bundle exec rspec`. When adding a Rails version, add a gemfile and a matrix entry.
+
+## Architecture
+
+The call flow spans several small files in `lib/api_only_pagination/`:
+
+1. **Hooking into ActiveRecord** (`lib/api_only_pagination.rb`): an `ActiveSupport.on_load(:active_record)` block includes `ActiveRecordPaginate` into `ActiveRecord::Base`. Chained calls like `User.where(...).do_paginate` still work, because a relation passes unknown methods to its model class while applying its own scope, so `all` inside the method returns the scoped relation.
+2. **`ActiveRecordPaginate`**: defines three aliases, `do_paginate`, `paginate`, and `paginated_response`, each taking `(page, per_page)`. They wrap `all` in a `Pagination` and build a `PaginatedData`.
+3. **`Pagination`**: runs `collection.count(:all)` once when it's constructed (for grouped relations it counts the groups), then applies `limit`/`offset` from the metadata in `results`. `results` is still a lazy relation.
+4. **`Paginate`**: the metadata and normalization logic. Any page/per_page value that isn't a positive integer (nil, zero, negative, non-numeric) falls back to the configured default, and `per_page` is capped at `max_per_page`. It also computes `offset`, `total_pages`, and next/previous helpers.
+5. **`PaginatedData`**: a plain object with `data`, `per_page`, `current_page`, `total_pages`, and `total_records`. The README shows the result as a hash, but it's actually this object.
+
+**Configuration** (`Configuration` + `ApiOnlyPagination.configure`/`.reset`): `default_page_size` (20), `max_per_page` (100), `default_page` (1). Values are read when each call runs, so changes take effect right away.
+
+## Style
+
+RuboCop (`.rubocop.yml`): double-quoted strings, max line length 120, `TargetRubyVersion` 2.6. Every file starts with `# frozen_string_literal: true`.

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "sqlite3", "~> 1.4"

data/Gemfile.lock

@@ -1,25 +1,12 @@
 PATH
   remote: .
   specs:
-    api_only_pagination (0.1.2)
+    api_only_pagination (0.1.5)
       activerecord (>= 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.7.3)
-      actionview (= 6.1.7.3)
-      activesupport (= 6.1.7.3)
-      rack (~> 2.0, >= 2.0.9)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.7.3)
-      activesupport (= 6.1.7.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
     activemodel (6.1.7.3)
       activesupport (= 6.1.7.3)
     activerecord (6.1.7.3)
@@ -32,39 +19,17 @@ GEM
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    builder (3.2.4)
     concurrent-ruby (1.2.2)
-    crass (1.0.6)
     diff-lcs (1.5.0)
-    erubi (1.12.0)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.1)
-    loofah (2.20.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
     minitest (5.18.0)
-    nokogiri (1.13.10-x86_64-darwin)
-      racc (~> 1.4)
     parallel (1.21.0)
-    parser (3.2.1.1)
+    parser (3.3.13.0)
       ast (~> 2.4.1)
-    racc (1.6.2)
-    rack (2.2.7)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (6.1.7.3)
-      actionpack (= 6.1.7.3)
-      activesupport (= 6.1.7.3)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
+      racc
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.3.0)
@@ -81,14 +46,6 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-rails (4.0.2)
-      actionpack (>= 4.2)
-      activesupport (>= 4.2)
-      railties (>= 4.2)
-      rspec-core (~> 3.10)
-      rspec-expectations (~> 3.10)
-      rspec-mocks (~> 3.10)
-      rspec-support (~> 3.10)
     rspec-support (3.10.2)
     rubocop (1.48.1)
       json (~> 2.3)
@@ -103,21 +60,25 @@ GEM
     rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.11.0)
-    thor (1.2.1)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
     zeitwerk (2.6.8)
 
 PLATFORMS
+  arm64-darwin-25
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   api_only_pagination!
   rake (~> 13.0)
   rspec (~> 3.6)
-  rspec-rails (~> 4.0)
   rubocop (~> 1.21)
+  sqlite3 (~> 1.4)
 
 BUNDLED WITH
    2.4.9

data/Rakefile

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: :rubocop
+task default: %i[spec rubocop]

data/api_only_pagination.gemspec

@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_dependency "activerecord", ">= 5.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rspec-rails", "~> 4.0"
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
 

data/gemfiles/activerecord_6.1.gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 6.1.0"
+gem "rake", "~> 13.0"
+gem "sqlite3", "~> 1.4"
+
+# Rails < 7.1 breaks with concurrent-ruby 1.3.5+ and relies on gems Ruby 3.4 no longer ships by default
+gem "base64"
+gem "bigdecimal"
+gem "concurrent-ruby", "< 1.3.5"
+gem "logger"
+gem "mutex_m"

data/gemfiles/activerecord_7.0.gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 7.0.0"
+gem "rake", "~> 13.0"
+gem "sqlite3", "~> 1.4"
+
+# Rails < 7.1 breaks with concurrent-ruby 1.3.5+ and relies on gems Ruby 3.4 no longer ships by default
+gem "base64"
+gem "bigdecimal"
+gem "concurrent-ruby", "< 1.3.5"
+gem "logger"
+gem "mutex_m"

data/gemfiles/activerecord_7.1.gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 7.1.0"
+gem "rake", "~> 13.0"
+gem "sqlite3", "~> 1.6", ">= 1.6.6"

data/gemfiles/activerecord_7.2.gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 7.2.0"
+gem "rake", "~> 13.0"
+gem "sqlite3", ">= 1.6.6"

data/gemfiles/activerecord_8.0.gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 8.0.0"
+gem "rake", "~> 13.0"
+gem "sqlite3", ">= 2.1"

data/gemfiles/activerecord_8.1.gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 8.1.0"
+gem "rake", "~> 13.0"
+gem "sqlite3", ">= 2.1"

data/lib/api_only_pagination/active_record_paginate.rb

@@ -3,20 +3,25 @@
 require "active_record"
 
 module ApiOnlyPagination
+  # Adds do_paginate (and its aliases) to every ActiveRecord model and, through delegation, to relations
   module ActiveRecordPaginate
     extend ActiveSupport::Concern
+
+    # Pagination entry points available on models and relations
     module ClassMethods
-      def do_paginate(page = ApiOnlyPagination.configuration.default_page,
-                      per_page = ApiOnlyPagination.configuration.default_page_size)
-        pagination = ApiOnlyPagination::Pagination.new(all, { page: page, per_page: per_page })
-        meta_data = pagination.metadata
+      %i[do_paginate paginate paginated_response].each do |access_method|
+        # nil page/per_page fall back to the configured defaults in Paginate
+        define_method(access_method) do |page = nil, per_page = nil|
+          pagination = ApiOnlyPagination::Pagination.new(all, { page: page, per_page: per_page })
+          meta_data = pagination.metadata
 
-        ApiOnlyPagination::PaginatedData
-          .new(data: pagination.results,
-               per_page: meta_data.per_page,
-               current_page: page,
-               total_pages: meta_data.total_pages,
-               total_records: meta_data.count)
+          ApiOnlyPagination::PaginatedData
+            .new(data: pagination.results,
+                 per_page: meta_data.per_page,
+                 current_page: meta_data.page,
+                 total_pages: meta_data.total_pages,
+                 total_records: meta_data.count)
+        end
       end
     end
   end

data/lib/api_only_pagination/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module ApiOnlyPagination
+  # Global settings, changed through ApiOnlyPagination.configure
   class Configuration
     attr_accessor :default_page_size, :max_per_page, :default_page
 

data/lib/api_only_pagination/paginate.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
 module ApiOnlyPagination
+  # Normalizes page/per_page input and computes page metadata from a record count
   class Paginate
     attr_reader :page, :count, :per_page
 
     def initialize(page, per_page, count)
-      @page     = (page || ApiOnlyPagination.configuration.default_page).to_i
+      config    = ApiOnlyPagination.configuration
+      @page     = positive_integer(page) || config.default_page
       @count    = count
-      @per_page = [(per_page.to_i || ApiOnlyPagination.configuration.default_page_size),
-                   ApiOnlyPagination.configuration.max_per_page].min
+      @per_page = [positive_integer(per_page) || config.default_page_size, config.max_per_page].min
     end
 
     def offset
-      return 0 if page == 1
-
-      per_page * (page.to_i - 1)
+      per_page * (page - 1)
     end
 
     def next_page
@@ -34,7 +33,7 @@ module ApiOnlyPagination
     end
 
     def last_page?
-      page == total_pages
+      page >= total_pages
     end
 
     def first_page?
@@ -44,5 +43,13 @@ module ApiOnlyPagination
     def total_pages
       (count / per_page.to_f).ceil
     end
+
+    private
+
+    # nil, zero, negative and non-numeric values (e.g. "abc") all become nil
+    def positive_integer(value)
+      integer = value.to_i
+      integer if integer.positive?
+    end
   end
 end

data/lib/api_only_pagination/pagination.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 module ApiOnlyPagination
+  # Counts a relation and applies limit/offset for the requested page
   class Pagination
     attr_reader :collection, :params
 
     def initialize(collection, params = {})
       @collection = collection
-      @params = params.merge(count: collection.count)
+      @params = params.merge(count: total_count)
     end
 
     def metadata
@@ -18,5 +19,13 @@ module ApiOnlyPagination
         .limit(metadata.per_page)
         .offset(metadata.offset)
     end
+
+    private
+
+    # count(:all) ignores custom selects; grouped relations return a Hash of group => count
+    def total_count
+      count = collection.count(:all)
+      count.is_a?(Hash) ? count.size : count
+    end
   end
 end

data/lib/api_only_pagination/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApiOnlyPagination
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/lib/api_only_pagination.rb

@@ -8,6 +8,7 @@ require_relative "api_only_pagination/pagination"
 require_relative "api_only_pagination/paginated_data"
 require_relative "api_only_pagination/active_record_paginate"
 
+# Offset pagination for ActiveRecord that returns data plus page metadata for API responses
 module ApiOnlyPagination
   class << self
     def configuration
@@ -26,5 +27,4 @@ end
 
 ActiveSupport.on_load(:active_record) do
   include ApiOnlyPagination::ActiveRecordPaginate
-  ActiveRecord::Relation.include(ApiOnlyPagination::ActiveRecordPaginate)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_only_pagination
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Ashok
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2026-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 description: pagination with api response only
 email:
 - kingkoirala1@gmail.com
@@ -59,8 +45,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -68,6 +56,12 @@ files:
 - README.md
 - Rakefile
 - api_only_pagination.gemspec
+- gemfiles/activerecord_6.1.gemfile
+- gemfiles/activerecord_7.0.gemfile
+- gemfiles/activerecord_7.1.gemfile
+- gemfiles/activerecord_7.2.gemfile
+- gemfiles/activerecord_8.0.gemfile
+- gemfiles/activerecord_8.1.gemfile
 - lib/api_only_pagination.rb
 - lib/api_only_pagination/active_record_paginate.rb
 - lib/api_only_pagination/configuration.rb
@@ -97,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: pagination with api response only