pageturner 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0afa7cf02e4c3655d869a7f421707e670a49bb3
-  data.tar.gz: ae0872c1dec41ce653006251e6f6a4ebedcda089
+  metadata.gz: ef072fcfdb860880f1bc64576edc8d19660b0f4a
+  data.tar.gz: 733fa952412342474a7055a5bfc1bf9eb25658c6
 SHA512:
-  metadata.gz: 4d40b38322ef458601ecf123096d076acfd7bb4387edd523afdbde9e2e72d3b527063d7aead28888150d52be0b610e0a06e33c5deaa3367c753a4aec53393d5b
-  data.tar.gz: a8f56d7eec03a48da0506cad1218a4c8f99f3ab645d25ebcc35c6a4aa4a292d09dd6684bd8955582b16b235a37b56fa53f85383355954ef4805aa93c4f3d658d
+  metadata.gz: 62ae914ea2acd998b3997da0601582cc148d43f97aae635ac7231f7e6efca0014698a11b5407dbc92bc8a948b0c2bf2370aa8769997ef5c77268252bb5685bcf
+  data.tar.gz: 453d69ab87fc3166623a16608da51c44c774343eea3af15452a82fd5c04b39e84b451d4a0a9065f41e5f98afa33f1b5f05aa5042b0695a56bd17769ce228c772

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v3.0.0
+
+## Backwards Incompatible Changes
+
+* https://github.com/crzrcn/pageturner/commit/eec35955cd273f8fa3fe35ae574cc70a7e775293 - Remove the concern of the next page's URL. Only the application that uses Pageturner has complete knowledge about the URLs that form each page of resources. Pageturner should only be concerned with pagination state. Pageturner will now expose the next page's cursor to achieve this.
+  * Removes `#next_page` in favor of `#next_cursor`. `#next_cursor` returns pagination state that the application can use to create the next page's URL.
+
 # v2.0.0
 
 ## Backwards Incompatible Changes

data/README.md

@@ -15,15 +15,14 @@ query = Model.where(params[:filters])
   anchor_value: params[:last_value],
   ar_relation: query,
   sort_direction: Pageturner::DESC,
-  page_size: 25,
-  path_helper: lambda do |anchor_column:, anchor_value:, sort_direction:, anchor_id:|
-    models_path(
-      anchor_column: anchor_column,
-      anchor_value: anchor_value,
-      sort_direction: sort_direction,
-      anchor_id: anchor_id
-    )
-  end
+  page_size: 25
+)
+
+@next_path = model_path(
+  anchor_column: @pagination.next_cursor[:anchor_column]
+  anchor_id: @pagination.next_cursor[:anchor_id],
+  anchor_value: @pagination.next_cursor[:anchor_value],
+  sort_direction: @pagination.next_cursor[:sort_direction]
 )
 ```
 
@@ -35,15 +34,33 @@ json.models @pagination.resources do |resource|
 end
 
 json.pagination do
-  json.next_page @pagination.next_page
+  json.next_path @next_path
 end
 ```
 
 ## API
 
-### `#next_page`
+### `#next_cursor`
+
+Returns the next page's cursor.
 
-Returns the next page's path.
+```ruby
+query = Model.where(params[:filters])
+
+@pagination = Pageturner.new(
+  anchor_column: "name",
+  anchor_id: params[:last_id],
+  anchor_value: params[:last_value],
+  ar_relation: query,
+  sort_direction: Pageturner::DESC,
+  page_size: 25
+)
+```
+
+```ruby
+irb(main):001:0> @pagination.next_cursor
+=> {:anchor_column=>"name", :anchor_value=>"foo", :sort_direction=>"desc", :anchor_id=>3}
+```
 
 ### `#resources`
 

data/lib/pageturner.rb

@@ -9,9 +9,8 @@ class Pageturner
   # @param [String|Number|nil] anchor_value - Value of the anchor_column for the record to paginate from.
   # @param [ActiveRecord::Relation] ar_relation - Resource collection to paginate.
   # @param [String] sort_direction - Order of the pagination. Valid values: Pageturner::ASC, Pageturner::DESC.
-  # @param [Proc] path_helper - Function that generates the next page link. This function should have any state that's not relevant to pagination partially applied.
   # @param [Number] anchor_id - ID of the record to paginate from.
-  def initialize(anchor_column:, anchor_value:, ar_relation:, sort_direction:, page_size:, path_helper:, anchor_id:)
+  def initialize(anchor_column:, anchor_value:, ar_relation:, sort_direction:, page_size:, anchor_id:)
     # To be used outside dynamic SQL statements.
     @anchor_column = anchor_column
 
@@ -29,7 +28,6 @@ class Pageturner
 
     @sort_direction = sort_direction
     @page_size = page_size
-    @path_helper = path_helper
     @anchor_id = anchor_id
 
     unless [Pageturner::ASC, Pageturner::DESC].include?(@sort_direction)
@@ -44,7 +42,7 @@ class Pageturner
     @result = calculate_resources
   end
 
-  def next_page
+  def next_cursor
     anchor_value =
       if external_anchor_column?
         public_send_chain_from_sql(self.resources.last, @anchor_column)
@@ -52,12 +50,12 @@ class Pageturner
         self.resources.last&.public_send(@anchor_column)
       end
 
-    @path_helper.call(
+    {
       anchor_column: @anchor_column,
       anchor_value: anchor_value,
       sort_direction: @sort_direction,
       anchor_id: self.resources.last&.id
-    )
+    }
   end
 
   private

data/pageturner.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "pageturner"
-  spec.version       = "2.0.0"
+  spec.version       = "3.0.0"
   spec.authors       = ["crzrcn"]
   spec.email         = ["fernanlink@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pageturner
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - crzrcn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-17 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord