wor-paginate 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4481aa957c0963f107c5f1bdd9b2c6859cf91930aa7737e1a184a5634ad2bddf
-  data.tar.gz: 3a66f12b6c3348f7e43aa98586218d812ba6df36f6917a926d8bd1abc19caf61
+  metadata.gz: bd8ccaf4d5f8af78619449bf39383c133e41d193e3db20db6bb98f79077b6bdc
+  data.tar.gz: d42ed079f99f0ed72379507f0f9bfa4225e977074d9eea85dace43ef7120dce0
 SHA512:
-  metadata.gz: 8924bd31085db92676e53a290e5d9ae109295f15af0a908b798dec323a99a5c9b97a1b367cdc17f219126167bf4d6f703cc44a419c5d06acee3d8fe81d96c2d8
-  data.tar.gz: 989d4fb9cef8a3e149178c1f1a777195f1b63b54ddf6e2be10e7612b11bb95a04ba6b3280680a90918e56473efba951439bfeb362eb681a98e4f7cdfe5a33254
+  metadata.gz: f6bd84a58f0c0879756e2954c0e25ee7e0cdf3206c471b4640304f2cd9853e60029857d21000618a95d6678aa60b2c14a24fac4c6991f9d9df95419c4651a7d7
+  data.tar.gz: 3066ece4481767bf0adcdbe2c295c453b7ad2c8340d0175a20b27680886c79e01ede4c102b59aed0f806405275509e3108545c79448cd670e4b791af7b0ad8b4

data/.gitignore

@@ -1,5 +1,7 @@
 spec/dummy/db/*.sqlite3
 spec/dummy/db/*.sqlite3-journal
+spec/dummy/db/*.sqlite3-shm
+spec/dummy/db/*.sqlite3-wal
 /test.sqlite3
 spec/dummy/log/*.log
 spec/dummy/tmp/

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Change log
 
+### V0.4.2
+* [#3](https://github.com/icoluccio/wor-paginate/pull/3) Add Pagy adapter - [@icoluccio](https://github.com/icoluccio).
+* [#4](https://github.com/icoluccio/wor-paginate/pull/4) Remove remaining rubocop:disable/:enable comments - [@icoluccio](https://github.com/icoluccio).
+* [#5](https://github.com/icoluccio/wor-paginate/pull/5) Document Kaminari/will_paginate Model.page collision - [@icoluccio](https://github.com/icoluccio).
+
+### V0.4.1
+* [#2](https://github.com/icoluccio/wor-paginate/pull/2) Remove remaining dead Wolox links - [@icoluccio](https://github.com/icoluccio).
+
 ### V0.4.0
 * [#1](https://github.com/icoluccio/wor-paginate/pull/1) Add Rails 8.0/8.1 support, HTTP-level request specs, and rubocop cleanup - [@icoluccio](https://github.com/icoluccio).
 

data/Gemfile

@@ -23,6 +23,7 @@ group :development, :test do
   gem 'generator_spec', '~> 0.10'
   gem 'kaminari', '~> 1.2'
   gem 'overcommit', '~> 0.71'
+  gem 'pagy', '~> 43.0'
   gem 'panko_serializer', '~> 0.8.5'
   gem 'puma', '~> 6.0'
   gem 'rake', '~> 13.0'

data/README.md

@@ -14,7 +14,8 @@ Wor::Paginate
       - [Custom options](#custom-options)
       - [Custom formatters](#custom-formatters)
       - [Custom adapters](#custom-adapters)
-    - [Working with Kaminari or will_paginate](#working-with-kaminari-or-will_paginate)
+    - [Working with Kaminari, will_paginate, or Pagy](#working-with-kaminari-will_paginate-or-pagy)
+      - [Kaminari and will_paginate both define `Model.page`](#kaminari-and-will_paginate-both-define-modelpage)
     - [Test helpers](#test-helpers)
   - [Contributing](#contributing)
   - [Releases](#releases)
@@ -263,8 +264,39 @@ There are also helper methods available to dynamically operate the gem's adapter
 When the gem paginates, it tries to adapt the content to the first adapter that is "adaptable" for the content (unless a custom adapter has been passed to render_paginated or a default_adapter has been defined in the initializer). So beware of which adapters (and in which order) you are leaving in the `Wor::Paginate::Config.adapters` array, because depending on those, the gem will try to adapt the content.
 
 
-### Working with Kaminari or will_paginate
-If either Kaminari or will_paginate is required in the project, Wor::Paginate will use them for pagination with no code or configuration change.
+### Working with Kaminari, will_paginate, or Pagy
+If Kaminari, will_paginate, or [Pagy](https://github.com/ddnexus/pagy) is required in the project, Wor::Paginate will use it for pagination with no code or configuration change.
+
+If more than one is available, Wor::Paginate prefers will_paginate, then Kaminari, then Pagy (the order they're checked in `Config::DEFAULT_ADAPTERS`). To opt out of one, for example if Pagy happens to be in your bundle for unrelated reasons, call `Wor::Paginate::Config.remove_adapter(Wor::Paginate::Adapters::Pagy)` in the initializer.
+
+#### Kaminari and will_paginate both define `Model.page`
+Kaminari and will_paginate each add their own `page` class method to your models, for the same purpose but with a different return value. Whichever gem's Rails initializer happens to run last silently overwrites the other's definition. This isn't affected by Gemfile order.
+
+Wor::Paginate's own adapter selection already routes around this (see the precedence above). If you specifically need Kaminari's own pagination behavior while will_paginate is also installed, rename Kaminari's method and subclass the built-in Kaminari adapter, overriding only the two methods that call `.page` literally:
+
+```ruby
+# config/initializers/kaminari.rb
+Kaminari.configure do |config|
+  config.page_method_name = :kpage
+end
+```
+
+```ruby
+# app/adapters/kaminari_renamed_adapter.rb
+class KaminariRenamedAdapter < Wor::Paginate::Adapters::Kaminari
+  def required_methods
+    %i[kpage]
+  end
+
+  def paginated_content
+    @paginated_content ||= @content.kpage(@page).per(@limit)
+  end
+end
+```
+
+```ruby
+render_paginated SomeModel, adapter: KaminariRenamedAdapter
+```
 
 ### Test helpers
 You can use the `be_paginated` matcher to test your endpoints. It also accepts the `with` chain method to receive a formatter.
@@ -345,9 +377,7 @@ This project was developed by:
 * [Hugo Farji](https://github.com/hdf1986)
 * [Alan Halatian](https://github.com/alanhala)
 
-Originally at [Wolox](http://www.wolox.com.ar)
-
-[![Wolox](https://raw.githubusercontent.com/Wolox/press-kit/master/logos/logo_banner.png)](http://www.wolox.com.ar)
+Originally at Wolox
 
 ## License
 

data/lib/generators/templates/wor_paginate.rb

@@ -8,7 +8,7 @@ Wor::Paginate.configure do |config|
   # In case you want to use other format for your response, you can override our formatter here
   # You can extend from Wor::Paginate::Formatters::Base and override the 'format' method
   # For more info about available methods for formatters see:
-  # https://github.com/Wolox/wor-paginate/blob/master/lib/wor/paginate/formatters/base.rb
+  # https://github.com/icoluccio/wor-paginate/blob/main/lib/wor/paginate/formatters/base.rb
   # config.formatter = Wor::Paginate::Formatters::AmsFormatter
 
   # Configure a default adapter to use on pagination
@@ -20,6 +20,7 @@ Wor::Paginate.configure do |config|
   # Wor::Paginate::Adapters::WillPaginateAlreadyPaginated
   # Wor::Paginate::Adapters::WillPaginate
   # Wor::Paginate::Adapters::Kaminari
+  # Wor::Paginate::Adapters::Pagy
   # Wor::Paginate::Adapters::ActiveRecord
   # Wor::Paginate::Adapters::Enumerable
 
@@ -30,6 +31,7 @@ Wor::Paginate.configure do |config|
   # Adapters::WillPaginateAlreadyPaginated,
   # Adapters::WillPaginate,
   # Adapters::Kaminari,
+  # Adapters::Pagy,
   # Adapters::ActiveRecord,
   # Adapters::Enumerable
   # ]

data/lib/wor/paginate/adapters/pagy.rb

@@ -0,0 +1,46 @@
+require_relative 'helpers/total_count'
+
+# Used when render_paginated is called with an ActiveRecord directly, with the
+# pagy gem loaded. Something like
+### render_paginated DummyModel
+module Wor
+  module Paginate
+    module Adapters
+      class Pagy < Base
+        include Helpers::TotalCount
+
+        def adapt?
+          defined?(::Pagy::Offset) && super
+        end
+
+        def required_methods
+          %i[offset limit table_name]
+        end
+
+        def paginated_content
+          @paginated_content ||= pagy.records(@content)
+        end
+
+        delegate :count, to: :paginated_content
+
+        def total_pages
+          pagy.pages
+        end
+
+        def next_page
+          pagy.next
+        end
+
+        def previous_page
+          pagy.previous
+        end
+
+        private
+
+        def pagy
+          @pagy ||= ::Pagy::Offset.new(count: total_count, page: @page, limit: @limit)
+        end
+      end
+    end
+  end
+end

data/lib/wor/paginate/config.rb

@@ -16,6 +16,7 @@ module Wor
         will_paginate_paginated: Adapters::WillPaginateAlreadyPaginated,
         will_paginate: Adapters::WillPaginate,
         kaminari: Adapters::Kaminari,
+        pagy: Adapters::Pagy,
         active_record: Adapters::ActiveRecord,
         enumerable: Adapters::Enumerable
       }.freeze

data/lib/wor/paginate/formatters/base.rb

@@ -5,7 +5,7 @@ module Wor
     module Formatters
       class Base
         include Utils::UriHelper
-        attr_accessor :adapter, :content, :formatter, :options
+        attr_accessor :adapter, :formatter, :options
 
         def initialize(adapter, options = {})
           @adapter = adapter
@@ -35,9 +35,7 @@ module Wor
         end
 
         def paginated_content
-          # rubocop:disable Naming/MemoizedInstanceVariableName -- @content matches the public `content` attr_accessor above; renaming it would silently change what `content` returns.
-          @content ||= adapter.paginated_content
-          # rubocop:enable Naming/MemoizedInstanceVariableName
+          @paginated_content ||= adapter.paginated_content
         end
 
         def serialized_content

data/lib/wor/paginate/version.rb

@@ -1,5 +1,5 @@
 module Wor
   module Paginate
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.4.2'.freeze
   end
 end

data/lib/wor/paginate.rb

@@ -3,6 +3,7 @@ require_relative 'paginate/adapters/active_record'
 require_relative 'paginate/adapters/enumerable'
 require_relative 'paginate/adapters/kaminari'
 require_relative 'paginate/adapters/will_paginate'
+require_relative 'paginate/adapters/pagy'
 require_relative 'paginate/adapters/kaminari_already_paginated'
 require_relative 'paginate/adapters/will_paginate_already_paginated'
 require_relative 'paginate/exceptions/dependency_error'

data/wor-paginate.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.date        = Date.today
   s.authors     = ["icoluccio", "mnmallea", "holywyvern", "lucasVoboril"]
-  s.email       = ["ignacio.coluccio@wolox.com.ar", "martin.mallea@wolox.com.ar", "ramiro.rojo@wolox.com.ar", "lucas.voboril@wolox.com.ar"]
+  s.email       = ["ignacio.coluccio@gmail.com", "martin.mallea@wolox.com.ar", "ramiro.rojo@wolox.com.ar", "lucas.voboril@wolox.com.ar"]
   s.homepage    = "https://github.com/icoluccio/wor-paginate"
   s.summary     = "Simplified pagination for Rails API controllers"
-  s.description = "Wor::Paginate is a gem for Rails that simplifies pagination, particularly for controller methods, while standardizing JSON output for APIs. It's meant to work both as a standalone pagination gem and as an extra layer over Kaminari and will_paginate"
+  s.description = "Wor::Paginate is a gem for Rails that simplifies pagination, particularly for controller methods, while standardizing JSON output for APIs. It's meant to work both as a standalone pagination gem and as an extra layer over Kaminari, will_paginate, or Pagy"
   s.license     = "MIT"
 
   s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec)/}) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wor-paginate
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - icoluccio
@@ -10,7 +10,7 @@ authors:
 - lucasVoboril
 bindir: bin
 cert_chain: []
-date: 2026-08-01 00:00:00.000000000 Z
+date: 2026-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -54,10 +54,10 @@ dependencies:
         version: '9'
 description: Wor::Paginate is a gem for Rails that simplifies pagination, particularly
   for controller methods, while standardizing JSON output for APIs. It's meant to
-  work both as a standalone pagination gem and as an extra layer over Kaminari and
-  will_paginate
+  work both as a standalone pagination gem and as an extra layer over Kaminari, will_paginate,
+  or Pagy
 email:
-- ignacio.coluccio@wolox.com.ar
+- ignacio.coluccio@gmail.com
 - martin.mallea@wolox.com.ar
 - ramiro.rojo@wolox.com.ar
 - lucas.voboril@wolox.com.ar
@@ -84,6 +84,7 @@ files:
 - lib/wor/paginate/adapters/helpers/total_count.rb
 - lib/wor/paginate/adapters/kaminari.rb
 - lib/wor/paginate/adapters/kaminari_already_paginated.rb
+- lib/wor/paginate/adapters/pagy.rb
 - lib/wor/paginate/adapters/will_paginate.rb
 - lib/wor/paginate/adapters/will_paginate_already_paginated.rb
 - lib/wor/paginate/config.rb