next_page 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc0be3e3856dc94bd88845bc1d794eb179bc1b848c734e69788272075ec66f39
-  data.tar.gz: 3069427b0ac1cb6b91ff8ebc686d739805cb6adaadb6a85badf94843d9c5d13f
+  metadata.gz: fc0a222313043518cba95ab5cba8b04ba260a1668d570cae3f8e0450458d8773
+  data.tar.gz: 1e865c0c7de475e1edb754957db1ab6d4f72e863dc9baa995c90c27c8006ca99
 SHA512:
-  metadata.gz: 74f6194348047238078e0b0fe3f5dd3a508b4a2d2a8e260511b19da571b40b187ea8fe79a363becf95f115945c1bedc4e79016bbf43d007ced9788e14924b1b8
-  data.tar.gz: 07db432a16ad366222ce3da4531203535e918be0562ce63c9a6d2fe852f1ad3f4dd90af8e53f2941428374abdfe2fa20397a11bfecc1f1d8633ab4a394fe83c1
+  metadata.gz: 4111d99ac3cca85231988f6dd665c9091416b3a9ad7b29dea0108dc8cd4617cdb38c0f3068d64586741365d463b1c3ea390f28b58199b1ea20fbc7098cf5192d
+  data.tar.gz: 80c2bcbdaa84c8ef48a1f680df6a56fa1607d097b01546c9f553983fd5c4fa171a031abcafc122591576b7b0c2304df65acab3e89cd92ad8e5faabc6d7fe0862

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/next_page.svg)](https://badge.fury.io/rb/next_page)
+[![RuboCop](https://github.com/RockSolt/next_page/workflows/RuboCop/badge.svg)](https://github.com/RockSolt/next_page/actions?query=workflow%3ARuboCop)
+
 # NextPage
 Basic pagination for Rails controllers.
 
@@ -72,12 +75,18 @@ paginate_with default_limit: 12, instance_variable_name: 'data'
 ```
 
 ### Link Helpers
-This gem does not do any rendering. It does provide helper methods for generating links. The resource will include the following additional methods:
+This gem does not do any rendering. It does provide helper methods for generating links. The resource will include the following additional methods (when the request header Accept is `'application/vnd.api+json'`):
 - current_page
 - next_page
 - total_pages
 - per_page
 
+#### Count Query
+In some cases (such as grouping), calling count on the query does not provide an accurate representation. If that is the case, then there are two ways to override the default behavior:
+- provide a count_query that can resolve the attributes
+- specify the following attributes manually: current_page, total_count, and per_page
+
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/next_page/pagination_attributes.rb

@@ -5,9 +5,15 @@ module NextPage
   #
   # Module PaginationAttributes adds in methods required for pagination links: current_page, next_page, and total_pages.
   # It reads the offset and limit on the query to determine the values.
+  #
+  # In some cases the query will not support count. In that case, there are two ways to override the default behavior:
+  # - provide a count_query that can resolve the attributes
+  # - specify the following attributes manually: current_page, total_count, and per_page
   module PaginationAttributes
+    attr_writer :count_query, :current_page, :total_count, :per_page
+
     def current_page
-      @current_page ||= offset_value + 1
+      @current_page ||= count_query.offset_value + 1
     end
 
     def next_page
@@ -15,7 +21,7 @@ module NextPage
     end
 
     def total_count
-      @total_count ||= unscope(:limit).unscope(:offset).count
+      @total_count ||= count_query.unscope(:limit).unscope(:offset).count
     end
 
     def total_pages
@@ -23,7 +29,12 @@ module NextPage
     end
 
     def per_page
-      @per_page ||= limit_value
+      @per_page ||= count_query.limit_value
+    end
+
+    # checks first to see if an override query has been provided, then fails back to self
+    def count_query
+      @count_query || self
     end
   end
 end

data/lib/next_page/paginator.rb

@@ -37,13 +37,10 @@ module NextPage
     end
 
     def paginate_resource(data, params)
-      data.extend(NextPage::PaginationAttributes)
+      assign_pagination_attributes(data, params)
 
       data = sorter.sort(data, params.fetch(:sort, default_sort))
-
-      limit = page_size(params[:page])
-      offset = page_number(params[:page]) - 1
-      data.limit(limit).offset(offset * limit)
+      data.limit(data.per_page).offset((data.current_page - 1) * data.per_page)
     end
 
     private
@@ -62,6 +59,12 @@ module NextPage
       @default_sort ||= "-#{@model_class.primary_key}"
     end
 
+    def assign_pagination_attributes(data, params)
+      data.extend(NextPage::PaginationAttributes)
+      data.per_page = page_size(params[:page])
+      data.current_page = page_number(params[:page])
+    end
+
     def page_size(page)
       if page.present? && page[:size].present?
         page[:size]&.to_i

data/lib/next_page/version.rb

@@ -1,3 +1,3 @@
 module NextPage
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: next_page
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Todd Kummer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.77'
+        version: 0.82.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.77'
+        version: 0.82.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement