wor-paginate 0.1.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f09070288ef65ad8eb2bf6ba05b8eead1911ac05
-  data.tar.gz: 2261daf2882a9452432b0eb59609f9ab89713463
+SHA256:
+  metadata.gz: 2465192c522659e0f6e779d73cda2dfaa3fa47aca0966ebc9fd4292587143cea
+  data.tar.gz: d71ab589396a9f76e25849e63bec31a1fe5aafcd1dd54c3b9ca79104957cbee7
 SHA512:
-  metadata.gz: f5aa479217e9dfa235b14c0a98678679b4c25e2fa997b470b204193bbb59ffaf670c6b33595e9d020a642064e86fd7f5348904e8724bbe10b1b755f60726dda5
-  data.tar.gz: 5beb45a05d1d79ee1b215186463bfab3ca430dc92204ce6e2e0a321930144149b44bc9f5c6eda697bbaaebc025ea8e39fb6bd57dd8011af72c3154fe35e4322e
+  metadata.gz: 8ed75b64b43ffe168a35a09a054532c384d51470e3942964b8a60ac191644b264e8d42a59e73ceea3485a0cc7680162a74dcd9d81b5581a110bb8510f965dfcc
+  data.tar.gz: 93143a274cdbd3bbaffe3898fa4038de9173b6d916eab033e5ae13c8fcaceb63baefc8c7a4d0a6c6ffbb4fc2f6513c2d68769a533fdc05416d3d5336c256dfd8

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 2.4.7
   - 2.5.6
   - 2.6.4
+  - 2.7.0
   - ruby-head
 
 before_install:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Change log
 
+### V0.2.0
+* [#95](https://github.com/Wolox/wor-paginate/pull/95) Added total_count option to overwrite the count in render_paginated  - [@juanpablo-rojas](https://github.com/juanpablo-rojas).
+* [#93](https://github.com/Wolox/wor-paginate/pull/93) Infinite scroll - [@mnmallea](https://github.com/mnmallea).
+* [#92](https://github.com/Wolox/wor-paginate/pull/92) Ruby 2.7.0 support - [@mnmallea](https://github.com/mnmallea).
+* [#91](https://github.com/Wolox/wor-paginate/pull/91) Navigation links - [@mnmallea](https://github.com/mnmallea).
+
 ### V0.1.10
 * [#90](https://github.com/Wolox/wor-paginate/pull/90) Verify that default adapter adapts - [@mtejedorwolox](https://github.com/mtejedorwolox).
 

data/Gemfile

@@ -15,7 +15,7 @@ gemspec
 
 group :development, :test do
   gem 'active_model_serializers', '~> 0.10.0'
-  gem 'bundler', '~> 2.0.1'
+  gem 'bundler', '>= 2.0.1'
   gem 'byebug', '~> 9.0'
   gem 'codeclimate-test-reporter', '~> 1.0.0'
   gem 'database_cleaner', '~> 1.6.0'

data/README.md

@@ -89,7 +89,9 @@ The response to the index will then be:
   "total_count": 28,
   "current_page": 1,
   "previous_page": null,
-  "next_page": 2
+  "next_page": 2,
+  "previous_page_url": null,
+  "next_page_url": "http://api.example.com/users?page=2
 }
 ```
 
@@ -131,6 +133,43 @@ class CustomSerializer < ActiveModel::Serializer
 end
 ```
 
+##### total_count
+You can overwrite the `total_count` pagination param by passing it as a single option to the method. This could be used if the whole collection to be paginated is complex and has the risk to broke when counting all the records.
+
+```ruby
+  render_paginated DummyModel, total_count: 50
+```
+
+##### preserve_records
+> WARNING: This option only works with an ActiveRecord collection.
+
+Preserve records option can be added to `render_paginated` to mantain current records. This allow to navigate pages like an infinite scroll without adding new records when switching pages.
+
+- Timestamp mode (default)
+```ruby
+def index
+  render_paginated SomeModel, preserve_records: true 
+end
+
+# You can customize the field used to preserve this records (default is 'created_at')
+def index
+  render_paginated SomeModel, preserve_records: { by: :timestamp, field: :custom_time_field } 
+end
+```
+
+- PK mode
+```ruby
+def index
+  render_paginated SomeModel, preserve_records: { by: :id } 
+end
+
+# You can customize the field used to preserve this records (default is 'id')
+def index
+  render_paginated SomeModel, preserve_records: { by: :id, field: :my_custom_id_field }
+end
+```
+
+
 #### Custom formatters
 A formatter is an object that defines the output of the render_paginated method. In case the application needs a different format for a request, it can be passed to the `render_paginated` method using the `formatter` option:
 ```ruby
@@ -209,7 +248,6 @@ end
 ## About ##
 
 The current maintainers of this gem are :
-* [Lucas Voboril](https://github.com/lucasVoboril)
 * [Martín Mallea](https://github.com/mnmallea)
 
 This project was developed by:

data/lib/wor/paginate/formatter.rb

@@ -1,6 +1,9 @@
+require_relative 'utils/uri_helper'
+
 module Wor
   module Paginate
     class Formatter
+      include Utils::UriHelper
       attr_accessor :adapter, :content, :formatter, :options
 
       def initialize(adapter, options = {})
@@ -8,15 +11,17 @@ module Wor
         @options = options
       end
 
-      def format
+      def format # rubocop: disable Metrics/MethodLength
         {
           page: serialized_content,
           count: count,
           total_pages: total_pages,
-          total_count: total_count,
+          total_count: options[:total_count] || total_count,
           current_page: current_page,
           previous_page: previous_page,
-          next_page: next_page
+          next_page: next_page,
+          next_page_url: page_url(next_page),
+          previous_page_url: page_url(previous_page)
         }
       end
 
@@ -46,6 +51,16 @@ module Wor
       def serializer
         options[:each_serializer]
       end
+
+      def page_url(page)
+        return nil unless page
+
+        replace_query_params(current_url, page: page)
+      end
+
+      def current_url
+        options[:_current_url]
+      end
     end
   end
 end

data/lib/wor/paginate/paginate.rb

@@ -1,3 +1,5 @@
+require_relative 'utils/preserve_records_helper'
+
 module Wor
   module Paginate
     # The order of this array is important!
@@ -18,9 +20,19 @@ module Wor
     end
 
     def paginate(content, options = {})
+      current_url = request.original_url
+
+      if (preserve_records = options[:preserve_records])
+        content, current_url = Wor::Paginate::Utils::PreserveRecordsHelper
+                               .new(content, current_url,
+                                    preserve_records.is_a?(Hash) ? preserve_records : {}).call
+      end
+
       adapter = find_adapter_for_content(content, options)
       raise Exceptions::NoPaginationAdapter if adapter.blank?
-      formatter_class(options).new(adapter, options).format
+
+      formatter_class(options).new(adapter, options.merge(_current_url: current_url))
+                              .format
     end
 
     def render_paginate_with_include(content, options)
@@ -44,15 +56,15 @@ module Wor
     end
 
     def option_limit(options)
-      options[:limit].to_i unless options[:limit].nil?
+      options[:limit]&.to_i
     end
 
     def option_max_limit(options)
-      options[:max_limit].to_i unless options[:max_limit].nil?
+      options[:max_limit]&.to_i
     end
 
     def param_limit
-      params[Config.per_page_param].to_i unless params[Config.per_page_param].nil?
+      params[Config.per_page_param]&.to_i
     end
 
     def includes?(options)

data/lib/wor/paginate/rspec.rb

@@ -30,7 +30,7 @@ RSpec::Matchers.define :be_paginated do
   match do |actual_response|
     response = parse_response(actual_response)
     formatter = @custom_formatter || Wor::Paginate::Formatter
-    @formatted_keys = formatter.new(MockedAdapter.new).format.as_json.keys
+    @formatted_keys = formatter.new(MockedAdapter.new, _current_url: 'http://exaple.com/').format.as_json.keys
     response.keys == @formatted_keys
   end
 

data/lib/wor/paginate/utils/preserve_modes.rb

@@ -0,0 +1,33 @@
+module Wor
+  module Paginate
+    module Utils
+      module PreserveModes
+        module Timestamp
+          def self.default_field
+            :created_at
+          end
+
+          def self.last_value(query_param_value, _content, _field)
+            query_param_value ? Time.parse(query_param_value) : now_timestamp
+          end
+
+          private_class_method
+
+          def self.now_timestamp
+            Time.zone.now.iso8601(10)
+          end
+        end
+
+        module Id
+          def self.default_field
+            :id
+          end
+
+          def self.last_value(query_param_value, content, field)
+            query_param_value || content.maximum(field)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wor/paginate/utils/preserve_records_helper.rb

@@ -0,0 +1,49 @@
+require_relative 'uri_helper'
+require_relative 'preserve_modes'
+
+module Wor
+  module Paginate
+    module Utils
+      class PreserveRecordsHelper
+        def initialize(content, url, options)
+          @content = content
+          @url = url
+          @options = options
+        end
+
+        def call
+          [content.where("#{field} <= :last_value", last_value: last_value),
+           UriHelper.replace_query_params(url, query_param_name => last_value)]
+        end
+
+        private
+
+        attr_reader :content, :url, :options
+
+        def by
+          @by ||= begin
+            by = options[:by]&.to_s || 'timestamp'
+            raise ArgumentError, "'by' option should be 'id' or 'timestamp'" unless
+              %w[timestamp id].include? by
+            "Wor::Paginate::Utils::PreserveModes::#{by.classify}".constantize
+          end
+        end
+
+        def field
+          @field ||= options[:field] || by.default_field
+        end
+
+        def last_value
+          @last_value ||= begin
+            query_param_value = UriHelper.query_params(url)[query_param_name]
+            by.last_value(query_param_value, content, field)
+          end
+        end
+
+        def query_param_name
+          @query_param_name ||= "#{field}_let"
+        end
+      end
+    end
+  end
+end

data/lib/wor/paginate/utils/uri_helper.rb

@@ -0,0 +1,20 @@
+module Wor
+  module Paginate
+    module Utils
+      module UriHelper
+        def replace_query_params(uri_string, new_query)
+          uri = URI.parse(uri_string)
+          query = Rack::Utils.parse_query(uri.query)
+          uri.query = Rack::Utils.build_query(query.with_indifferent_access.merge(new_query))
+          uri.to_s
+        end
+
+        def query_params(uri_string)
+          Rack::Utils.parse_query(URI.parse(uri_string).query).with_indifferent_access
+        end
+
+        module_function :replace_query_params, :query_params
+      end
+    end
+  end
+end

data/lib/wor/paginate/version.rb

@@ -1,5 +1,5 @@
 module Wor
   module Paginate
-    VERSION = '0.1.10'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wor-paginate
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - icoluccio
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -80,6 +80,9 @@ files:
 - lib/wor/paginate/formatter.rb
 - lib/wor/paginate/paginate.rb
 - lib/wor/paginate/rspec.rb
+- lib/wor/paginate/utils/preserve_modes.rb
+- lib/wor/paginate/utils/preserve_records_helper.rb
+- lib/wor/paginate/utils/uri_helper.rb
 - lib/wor/paginate/version.rb
 - pull_request_template.md
 - test.sqlite3
@@ -103,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simplified pagination for Rails API controllers