pageturner 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ec92e81b1919467490096e12c1bb8413a028262
-  data.tar.gz: 2215eda44407930869479a61c51f40c631d971b8
+  metadata.gz: eaeccd8d18f2c48b0c8c4d86b07221cacb1923ec
+  data.tar.gz: 5041e0de3262ad5b06c442be7e904a771c9c6b20
 SHA512:
-  metadata.gz: 9c8ada0c35616416882e52147758e98dfb86222ac440f17c194f27eebc057da2013ae4331742b04356223d59b95881e936284a13e621168b5ce9b7ae68e96df4
-  data.tar.gz: 6de96592c15e9cd52ef14b08c09d1f378107877c93df23b2bdec14817f5fb9a8115c924da77e785f6633c966e1080cb19e37064dc9f539551f617f693d88c63c
+  metadata.gz: 7ef1390fc398ba7daa3fa207c7cf9fe947d676c8e07d843a76d8a60fbfd2c50c7d295f49a5ed1ee510f8d37b6d912b751453dd31803c327737276573ac011808
+  data.tar.gz: ffe3748684edeae86561ced8c73e01a4d873d9282486ddcf4837d25125f2951ed7b94120d0bbc065ed07c00296a37e9974ff87a8ad9a9ef2057e4875f0f0ffbf

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v4.0.0
+
+## Backwards Incompatible Changes
+
+* Support pagination over columns that are referenced differently in the database schema than in the application code. Although this looks like a feature add, it does break backwards compatibility on the assumptions that Pageturner makes on how the `anchor_column` is referenced in your database and application. Pageturner will now make less assumptions about that by allowing users to pass in database and application translations for the `anchor_column` as input. **Test your use cases after upgrading.**
+
 # v3.1.0
 
 ## Changes

data/README.md

@@ -56,6 +56,15 @@ Pageturner will send the `anchor_column_active_record_identifier` as a method ch
 
 ## API
 
+### `#has_next_page?`
+
+Returns whether or not there is a next page.
+
+```ruby
+irb(main):001:0> @pagination.has_next_page?
+=> true
+```
+
 ### `#next_cursor`
 
 Returns the next page's cursor.

data/lib/pageturner.rb

@@ -4,6 +4,7 @@ class Pageturner
   DESC = "desc"
   GREATER_THAN_OPERATOR = ">"
   LESS_THAN_OPERATOR = "<"
+  LOOKAHEAD = 1
 
   # @param [String] anchor_column - Field to paginate on.
   # @param [Anything, nil] anchor_value - Value of the anchor_column for the record to paginate from.
@@ -36,6 +37,13 @@ class Pageturner
     end
   end
 
+  def has_next_page?
+    # Load the current page.
+    self.resources
+
+    @has_next_page
+  end
+
   def resources
     # Memoize expensive querying.
     return @result if defined?(@result)
@@ -56,20 +64,16 @@ class Pageturner
   private
 
   def calculate_resources
-    resources =
-      if can_calculate_nth_page?
-        calculate_next_page
-      else
-        calculate_first_page
-      end
-
-    resources
+    (can_calculate_nth_page? ? calculate_next_page : calculate_first_page).tap do |resources|
+      @has_next_page = resources.size > @page_size
+    end.take(@page_size)
   end
 
   def comparator_for_fetching_resources
-    if @sort_direction == Pageturner::ASC
+    case @sort_direction
+    when Pageturner::ASC
       GREATER_THAN_OPERATOR
-    elsif @sort_direction == Pageturner::DESC
+    when Pageturner::DESC
       LESS_THAN_OPERATOR
     else
       raise COMPARATOR_INTERNAL_BUG
@@ -81,7 +85,7 @@ class Pageturner
   end
 
   def calculate_first_page
-    apply_sort_direction(@ar_relation)
+    apply_order_and_limit(@ar_relation)
   end
 
   def calculate_next_page
@@ -107,13 +111,13 @@ class Pageturner
         @ar_relation.where("#{qualified_anchor_column} IS NULL AND #{qualified_anchor_pk_column} #{comparator_for_fetching_resources} ?", @anchor_id)
       end
 
-    apply_sort_direction(where_clause)
+    apply_order_and_limit(where_clause)
   end
 
-  def apply_sort_direction(ar_relation)
+  def apply_order_and_limit(ar_relation)
     ar_relation
       .order("#{@anchor_column_sql_identifier} #{@sort_direction}", @ar_relation.primary_key => @sort_direction)
-      .limit(@page_size)
+      .limit(@page_size + LOOKAHEAD)
   end
 
   def nulls_listed_first?

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       = "4.0.0"
+  spec.version       = "4.1.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: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - crzrcn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord