rb_pager 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdd82410767649de7ec56d84ba2c311a08555eb4e53ca47e0974f8e54540cf02
-  data.tar.gz: fcc26daca9475701f37e4e5f259e8921edb2fd961ce64e874df1cf3cca84e33a
+  metadata.gz: 8a0e694279afddf482e72b7f03ced23218b0690fb91652ae41b24bd352f0e7b0
+  data.tar.gz: 256f353dce8cf5cf3d7c8350e16495b8fdfa6fac3324ca728bf6ba6aa92119d9
 SHA512:
-  metadata.gz: 335ff86d22e237f2f14826edaf9357b220e0b48019dc9f0534b7f611370ae7f15fdff6956da2a552c25a9fe316de7b5215079a690485c95a08171dd6d633a9d3
-  data.tar.gz: 12bc348e3abd3f82bfaee15fbd52a8ea15ca4ab9aca9da92cc0e3ba9e3345cb205bda27e4e1b9b05ae44fae84c330a77e978d2e3273027dec25e5eed4089720c
+  metadata.gz: 7997c4ad68aa0381d6bdde26f81ad5eddab52284e64b8f9d452422e033b64308932eac85a8ce1c846bed3dd87f9cc2a5526f8a12c578e766e0d52384ef381275
+  data.tar.gz: 75f5cdf577645968acd5b3155cb488d6abe907fc84c65d27717b29bdd237b18b07dcb1fd347fbfaf85d12ada565bbefda0ebd502b39c7df89c22b8d21ed44f97

data/README.md

@@ -9,7 +9,7 @@ For example, with offset–limit pagination, if an item from a prior page is del
 
 Cursor-based pagination also performs better for large data sets under most implementations.
 
-To support cursor-based pagination, this specification defines three query parameters `after`, `limit`, `sort`
+To support cursor-based pagination, this specification defines four query parameters `after`, `before`, `limit`, and `sort`
 
 ## Installation
 
@@ -52,22 +52,25 @@ Employee.pager(after:  'w33t44==', limit:  10, sort:  'created_at')
 Employee.pager(after:  'w33t44==', limit:  10, sort:  '-created_at')
 
 # [order by non uniq column](https://engineering.shopify.com/blogs/engineering/pagination-relative-cursors)
-# /employee?limit=10&sort=name,id
+# /employee?limit=10&sort=name,id&after=w33t44==
 Employee.pager(after:  'w33t44==', limit:  10, sort:  'name,id')
 
+# /employee?limit=10&sort=name,id&before=w33t44==
+Employee.pager(before:  'w33t44==', limit:  10, sort:  'name,id')
+
 # on EmployeesController
 records, meta = Employee.pager(limit:  15)
-# meta => { next_cursor => 'uahOI==' }
+# meta => { prev_cursor => 'ergOW==' next_cursor => 'uahOI==' }
 render  json: EmployeeSerializer.new(records, meta: meta).serialized_json, status:  :ok
 ```
 
 ## On progress
 
- - [ ] implement  `before`  cursor
- - [ ] meta url for first, last, next and previous page, collection size
+ - [x] implement  `before`  cursor
+ - [x] meta url for next and previous page
+ - [ ] meta url for first, last and collection size
  - [ ] [error-cases](https://jsonapi.org/profiles/ethanresnick/cursor-pagination/#auto-id-error-cases)
  - [ ] custom encoder
- - [ ] ui helper
 
 ## Development
 

data/lib/config/rb_pager.rb

@@ -1,4 +1,4 @@
-# Pager.configure do |config|
+# RbPager.configure do |config|
 #   config.limit = 15
 #   config.max_limit = 100
 # end

data/lib/rb_pager.rb

@@ -1,6 +1,7 @@
 require 'active_record'
 require 'rb_pager/version'
 require 'rb_pager/configuration'
+require 'rb_pager/base64_encoder'
 
 module RbPager
   class InvalidLimitValueError < StandardError; end
@@ -17,5 +18,6 @@ end
 
 if defined?(ActiveRecord)
   require 'rb_pager/orm/pager_active_record'
+  require 'rb_pager/orm/active_record_relation_methods'
   ActiveRecord::Base.send :include, RbPager::ActiveRecord
 end

data/lib/rb_pager/base64_encoder.rb

@@ -0,0 +1,19 @@
+require 'base64'
+module RbPager
+  module Base64Encoder
+    def encode(data)
+      Base64.strict_encode64(data)
+    end
+
+    def decode(data)
+      return nil if data.nil?
+
+      decoded_data = Base64.strict_decode64(data)
+      Hash[
+        decoded_data.split(',').map do |pair|
+          k, v = pair.split(':', 2)
+        end
+      ]
+    end
+  end
+end

data/lib/rb_pager/orm/active_record_relation_methods.rb

@@ -0,0 +1,36 @@
+module RbPager
+  module ActiveRecord
+    module ActiveRecordRelationMethods
+      def left_over?
+        @left_over ||= begin
+          # Cache #size otherwise multiple calls to the database will occur.
+          size.positive? && size < total_size
+        end
+      end
+
+      # Returns number of records that exist in scope of the current cursor
+      def total_size(column_name = :all) #:nodoc:
+        # #count overrides the #select which could include generated columns
+        # referenced in #order, so skip #order here, where it's irrelevant to the
+        # result anyway.
+        @total_size ||= begin
+          context = except(:offset, :limit, :order)
+
+          # Remove includes only if they are irrelevant
+          context = context.except(:includes) unless references_eager_loaded_tables?
+
+          args = [column_name]
+
+          # .group returns an OrderedHash that responds to #count
+          context = context.count(*args)
+
+          if context.is_a?(Hash) || context.is_a?(ActiveSupport::OrderedHash)
+            context.count
+          else
+            context.respond_to?(:count) ? context.count(*args) : context
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rb_pager/orm/pager_active_record.rb

@@ -3,40 +3,28 @@ module RbPager
     extend ActiveSupport::Concern
 
     module ClassMethods
+      include ::RbPager::Base64Encoder
+
       AR_ORDER = { '+' => :asc, '-' => :desc }
 
       def pager(after: nil, before: nil, limit: nil, sort: nil)
         raise InvalidLimitValueError if limit && limit < 1
         instance_variable_set(:@sorted_columns, nil)
+        instance_variable_set(:@collection, nil)
+        instance_variable_set(:@records, nil)
 
-        page_limit = limit || RbPager.configuration.limit
+        @page_limit = limit || RbPager.configuration.limit
         @sort = sort
+
         @after = decode(after)
         @before = decode(before)
         @direction = :next
 
-        collection = where(apply_after)
-        collection = collection.where(apply_before)
-        collection = collection.order(sorted_columns)
-                               .extending(ActiveRecordRelationMethods)
-                               .limit(page_limit)
-
-        create_paginate_meta(collection)
+        create_paginate_meta
       end
 
       private
 
-      def decode(cursor)
-        return nil if cursor.nil?
-
-        decode = Base64.strict_decode64(cursor)
-        Hash[
-          decode.split(',').map do |pair|
-            k, v = pair.split(':', 2)
-          end
-        ]
-      end
-
       def apply_after
         return nil if @after.nil?
 
@@ -90,71 +78,50 @@ module RbPager
         sorted_params
       end
 
-      def create_paginate_meta(collection)
+      def create_paginate_meta
         cursor = cursor(collection)
 
         meta = { prev_cursor: cursor.first, next_cursor: cursor.last }
         [collection, meta]
       end
 
+      def collection
+        @collection ||= where(apply_after)
+                        .where(apply_before)
+                        .order(sorted_columns)
+                        .extending(ActiveRecordRelationMethods)
+                        .limit(@page_limit)
+      end
+
+      def records
+        @records || collection.to_a
+      end
+
       def cursor(collection)
         return ['', ''] if collection.total_size.zero?
 
         prev_cursor, next_cursor = [], []
 
         if sorted_columns.blank?
-          prev_cursor = ["#{primary_key}:#{collection.first.send(primary_key)}"]
-          next_cursor = ["#{primary_key}:#{collection.last.send(primary_key)}"]
+          prev_cursor = ["#{primary_key}:#{records.first.send(primary_key)}"]
+          next_cursor = ["#{primary_key}:#{records.last.send(primary_key)}"]
         else
           sorted_columns.each do |key, _value|
             if type_for_attribute(key).type.eql? :datetime
-              prev_cursor << "#{key}:#{collection.first.send(key).rfc3339(9)}"
-              next_cursor << "#{key}:#{collection.last.send(key).rfc3339(9)}"
+              prev_cursor << "#{key}:#{records.first.send(key).rfc3339(9)}"
+              next_cursor << "#{key}:#{records.last.send(key).rfc3339(9)}"
               next
             end
 
-            prev_cursor << "#{key}:#{collection.first.send(key)}"
-            next_cursor << "#{key}:#{collection.last.send(key)}"
+            prev_cursor << "#{key}:#{records.first.send(key)}"
+            next_cursor << "#{key}:#{records.last.send(key)}"
           end
         end
 
-        return ['', Base64.strict_encode64(next_cursor.join(','))] if (@after.nil? && @before.nil?) || @direction.eql?(:prev) && !collection.left_over?
-        return [Base64.strict_encode64(prev_cursor.join(',')), ''] if @direction.eql?(:next) && !collection.left_over?
+        return ['', encode(next_cursor.join(','))] if (@after.nil? && @before.nil?) || @direction.eql?(:prev) && !collection.left_over?
+        return [encode(prev_cursor.join(',')), ''] if @direction.eql?(:next) && !collection.left_over?
 
-        [Base64.strict_encode64(prev_cursor.join(',')), Base64.strict_encode64(next_cursor.join(','))]
-      end
-    end
-
-    module ActiveRecordRelationMethods
-      def left_over?
-        @left_over ||= begin
-          # Cache #size otherwise multiple calls to the database will occur.
-          size.positive? && size < total_size
-        end
-      end
-
-      # Returns number of records that exist in scope of the current cursor
-      def total_size(column_name = :all) #:nodoc:
-        # #count overrides the #select which could include generated columns
-        # referenced in #order, so skip #order here, where it's irrelevant to the
-        # result anyway.
-        @total_size ||= begin
-          context = except(:offset, :limit, :order)
-
-          # Remove includes only if they are irrelevant
-          context = context.except(:includes) unless references_eager_loaded_tables?
-
-          args = [column_name]
-
-          # .group returns an OrderedHash that responds to #count
-          context = context.count(*args)
-
-          if context.is_a?(Hash) || context.is_a?(ActiveSupport::OrderedHash)
-            context.count
-          else
-            context.respond_to?(:count) ? context.count(*args) : context
-          end
-        end
+        [encode(prev_cursor.join(',')), encode(next_cursor.join(','))]
       end
     end
   end

data/lib/rb_pager/version.rb

@@ -1,3 +1,3 @@
 module RbPager
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb_pager
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - BambangSinaga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -88,7 +88,9 @@ files:
 - bin/setup
 - lib/config/rb_pager.rb
 - lib/rb_pager.rb
+- lib/rb_pager/base64_encoder.rb
 - lib/rb_pager/configuration.rb
+- lib/rb_pager/orm/active_record_relation_methods.rb
 - lib/rb_pager/orm/pager_active_record.rb
 - lib/rb_pager/version.rb
 - rb_pager.gemspec