jbuilder_pagination_plus 0.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97ca43221a3f22c2b74158298688d92bd46340c9
-  data.tar.gz: 20c8892e8c423755cfd7b3e5e27b812e50f6768b
+SHA256:
+  metadata.gz: 1a546f0bae157155cea8dafe471cd6e7a44dff00cb9a5823f42b53ef2726974d
+  data.tar.gz: dab71bf293fd753e220181d22ab8b9794b45722f532609f55196b442923c1bd6
 SHA512:
-  metadata.gz: f977ecf09a870ff5fe4abe3a89cb766b4994f98e1d90bea0d9dd4d2654c8166e8ce47b627499895abdd6978e76dc31a368eb6ff89e77eeac5fd5d381161734f0
-  data.tar.gz: db68215e0b2c45e2324c66505cf7b38a184099d10cfd6301791b3a7da03bc865217cbb736020025778b0c357e5353bd50bad098e875c127684be1481fa931ee3
+  metadata.gz: cb029327b276555c9e1cb4b05fb7600203dcaa25e8a9e7ebf5b62e2cee523f93d5b967cb6e4c3867b4ff9a4de37d8ff5310f4955109a8ab7e500410329cee815
+  data.tar.gz: 3eb3fe3370f2980db1930c2b27c01d006611ef4b81e6c0496c66840c512f8431f820246cae2135c68ac66dd7592552630b075efdef1c5533d84a4f46422fa108

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.3
+ruby-2.7.1

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-  - 2.4.2
+  - 2.7.1
+sudo: false
 install: bin/setup
 script:
   - bundle exec rspec spec

data/README.md

@@ -1,12 +1,15 @@
-# Jbuilder Pagination Plus [![Build Status](https://travis-ci.org/PinsterTeam/jbuilder_pagination_plus.svg?branch=master)](https://travis-ci.org/PinsterTeam/jbuilder_pagination_plus) [![Gem Version](https://badge.fury.io/rb/jbuilder_pagination_plus.svg)](https://badge.fury.io/rb/jbuilder_pagination_plus)
+# Jbuilder Pagination Plus [![Build Status](https://travis-ci.org/IlluminusLimited/jbuilder_pagination_plus.svg?branch=master)](https://travis-ci.org/IlluminusLimited/jbuilder_pagination_plus) [![Gem Version](https://badge.fury.io/rb/jbuilder_pagination_plus.svg)](https://badge.fury.io/rb/jbuilder_pagination_plus)
 
-[Jbuilder](https://github.com/rails/jbuilder) extension that makes easier to use pagination according to the [JSON API](http://jsonapi.org/format/#fetching-pagination) conventions.
+[Jbuilder](https://github.com/rails/jbuilder) extension that makes easier to use pagination according 
+to the [JSON API](http://jsonapi.org/format/#fetching-pagination) conventions.
 
 Forked from: [https://github.com/bacarini/jbuilder_pagination](https://github.com/bacarini/jbuilder_pagination)
 
 ## Requirement
 
-`JbuilderPaginationPlus` relies on a paginated collection with the methods `current_page`, `total_pages`, and `size`, such as are supported by both [Kaminari](https://github.com/amatsuda/kaminari) or [WillPaginate](https://github.com/mislav/will_paginate).
+`JbuilderPaginationPlus` relies on a paginated collection with the methods `current_page`, `total_pages`, 
+and `size`, such as are supported by both [Kaminari](https://github.com/amatsuda/kaminari) 
+or [WillPaginate](https://github.com/mislav/will_paginate).
 
 ## Installation
 
@@ -26,6 +29,17 @@ Or install it yourself as:
 
 ## Usage
 
+### Controller Module
+
+Import the `Pagination` module in your controller
+
+```ruby
+class ApplicationController < ActionController::API
+  include Pagination
+end
+
+```
+
 ###### Kaminari examples
 ```ruby
 #array
@@ -68,13 +82,60 @@ end
 #    } 
 # }  
 ```
-The options `url` and  `query_parameters` are opcionals.
+The options `url` and  `query_parameters` are optional.
 
 In case there is no pagination at all, `links` will be omitted.
 
+If you want to keep the original query parameters passed in you could do something this: 
+
+```ruby
+json.links do
+  json.pages! @posts, url: request.original_url, query_parameters: { images: params[:images] }
+end
+
+json.data do
+  # Whatever your data is
+end
+```
+
+jbuilder_pagination_plus will deep merge query parameters with the original request parameters.
+
+
+If that's not what you need then you can get the url using rails helpers:
+
+```ruby
+json.links do
+  json.pages! @posts, url: posts_url
+end
+
+json.data do
+  # Whatever your data is
+end
+```
+
+If you need pagination but don't want the performance penalty of counting all of the records, you can use
+to generate links without generating a `last` url. This should be compatible with `Kaminari`'s
+ `without_count` scope which can be used to paginate without issuing a `COUNT(*)` query.
+
+```ruby
+json.links do
+  json.pages_no_count! @posts, url: posts_url
+end
+
+json.data do
+  # Whatever your data is
+end
+```
+
+The `pages!` method will automatically switch to `no_count` mode if it detects that the collection
+doesn't respond properly to a `total_pages` method call.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To run tests, run `rake spec`
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: %i[spec]

data/jbuilder_pagination_plus.gemspec

@@ -5,13 +5,13 @@ require 'jbuilder/pagination/version'
 
 Gem::Specification.new do |spec|
   spec.name = "jbuilder_pagination_plus"
-  spec.version = Jbuilder::Pagination::VERSION
+  spec.version = Pagination::VERSION
   spec.authors = ["Bruno Bacarini", "Andrew Newell"]
   spec.email = ["bacarini.bruno@gmail.com", "scytherswings@gmail.com"]
 
   spec.summary = "Jbuilder extension to allows pagination according to JSON API format"
   spec.description = "Jbuilder extension to allows pagination according to JSON API format. See http://jsonapi.org for details on the format. Also provides methods for simpler pagination in controllers"
-  spec.homepage = "https://github.com/PinsterTeam/jbuilder_pagination_plus"
+  spec.homepage = "https://github.com/IlluminusLimited/jbuilder_pagination_plus"
   spec.license = "MIT"
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'jbuilder', '~> 2.2', '>= 2.2.0'
-  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'rack', '~> 2.0', '>= 2.0.0'
+  spec.add_runtime_dependency 'jbuilder', '~> 2.8', '>= 2.8.0'
+  spec.add_development_dependency 'rspec', '~> 3.8', '>= 3.8.0'
+  spec.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
   spec.add_development_dependency 'pry', '~> 0'
 end

data/lib/jbuilder/pagination.rb

@@ -1,5 +1,6 @@
-require "jbuilder"
-require "jbuilder/pagination/pages"
+require 'rack/utils'
+require 'jbuilder'
+require 'jbuilder/pagination/pages'
 require 'jbuilder/pagination/exceptions/unpageable_resource_error'
 
 module Pagination
@@ -7,6 +8,20 @@ module Pagination
   DEFAULT_PAGINATION = [[:page, ->(params) { params.dig(:page, :number) }],
                         [:per, ->(params) { params.dig(:page, :size) }]].freeze
 
+  NO_COUNT_PAGINATION = [[:page, ->(params) { params.dig(:page, :number) }],
+                         [:per, ->(params) { params.dig(:page, :size) }],
+                         [:without_count]].freeze
+
+  # @param pageable_resource [Object] resource to be paged
+  # @param methods [Array<Symbol, Lambda>] array of methods to call on the pageable_resource
+  # @param params [Object] params object from the controller
+  def paginate_no_count(pageable_resource, methods = NO_COUNT_PAGINATION.dup, params = self.params)
+    paginate(pageable_resource, methods, params)
+  end
+
+  # @param pageable_resource [Object] resource to be paged
+  # @param methods [Array<Symbol, Lambda>] array of methods to call on the pageable_resource
+  # @param params [Object] params object from the controller
   def paginate(pageable_resource, methods = DEFAULT_PAGINATION.dup, params = self.params)
     return pageable_resource if methods.blank?
     key_value_array = methods.pop
@@ -15,11 +30,15 @@ module Pagination
 
   private
 
-    def build_pagination(key_value_array, pageable_resource, params)
-      unless pageable_resource.respond_to?(key_value_array[0])
-        raise Errors::UnpageableResourceError, "Resource does not respond to '#{key_value_array[0]}' method!"
-      end
+  def build_pagination(key_value_array, pageable_resource, params)
+    unless pageable_resource.respond_to?(key_value_array[0])
+      raise Errors::UnpageableResourceError, "Resource does not respond to '#{key_value_array[0]}' method!"
+    end
 
-      pageable_resource.public_send(key_value_array[0], key_value_array[1].call(params))
+    if key_value_array[1].nil?
+      return pageable_resource.public_send(key_value_array[0])
     end
+
+    pageable_resource.public_send(key_value_array[0], key_value_array[1].call(params))
+  end
 end

data/lib/jbuilder/pagination/pages.rb

@@ -1,25 +1,83 @@
 class Jbuilder
   ONE_PAGE = 1
 
-  def pages!(collection, options={})
+  # Used to generate the pagination links for a collection
+  # @param collection [Object] the paginated collection
+  # @param opts [Hash] options to pass in
+  # @option opts [String] :url The url to use
+  # @option opts [Hash] :query_parameters Query parameters to automatically add to any generated urls
+  # @option opts [Boolean] :no_count This can be passed to force pagination without counting the total which is
+  #   an alternative to calling #pages_no_count!
+  def pages!(collection, opts = {})
     return unless collection && is_paginated?(collection)
 
-    pages_from(collection).map do |key, value|
-      params = query_parameters(options).merge(page: { number: value, size: collection.size }).to_query
-      _set_value key, "#{options.fetch(:url, nil)}?#{params}"
+    options_query_parameters, original_params, original_url = handle_url(opts)
+
+    if opts.fetch(:no_count, false)
+      pages_without_count(collection, options_query_parameters, original_params, original_url)
+    elsif is_countable?(collection)
+      pages_with_count(collection, options_query_parameters, original_params, original_url)
+    else
+      pages_without_count(collection, options_query_parameters, original_params, original_url)
     end
   end
 
+  # Used to generate the pagination links for a collection without requiring the total_count
+  # @param collection [Object] the paginated collection
+  # @param opts [Hash] options to pass in
+  # @option opts [String] :url for the url to use
+  # @option opts [Hash] :query_parameters to automatically add to any generated urls
+  def pages_no_count!(collection, opts = {})
+    return unless collection && is_paginated?(collection)
+
+    options_query_parameters, original_params, original_url = handle_url(opts)
+
+    pages_without_count(collection, options_query_parameters, original_params, original_url)
+  end
+
   private
 
+  def handle_url(opts)
+    options_url = opts.fetch(:url, nil)
+    original_url = nil
+    original_params = {}
+    if options_url
+      original_url, original_params = options_url.split("?")
+      original_params = ::Rack::Utils.parse_nested_query(original_params).deep_symbolize_keys
+    end
+    options_query_parameters = opts.fetch(:query_parameters, {})
+    [options_query_parameters, original_params, original_url]
+  end
+
+  def pages_with_count(collection, options_query_parameters, original_params, original_url)
+    pages_from(collection).map do |key, value|
+      build_jbuilder_value(collection, key, options_query_parameters, original_params, original_url, value)
+    end
+  end
+
+
+
+  def pages_without_count(collection, options_query_parameters, original_params, original_url)
+    pages_without_count_from(collection).map do |key, value|
+      build_jbuilder_value(collection, key, options_query_parameters, original_params, original_url, value)
+    end
+  end
+
+  def build_jbuilder_value(collection, key, options_query_parameters, original_params, original_url, value)
+    params = query_parameters(options_query_parameters, original_params)
+               .deep_merge(page: { number: value, size: collection.size })
+               .to_query
+    _set_value key, "#{original_url}?#{params}"
+  end
+
   def pages_from(collection)
     {}.tap do |pages|
       pages[:self] = collection.current_page
-      return pages if collection.total_pages == ONE_PAGE
+      return pages if collection.total_pages <= ONE_PAGE
 
       unless collection.current_page == ONE_PAGE
         pages[:first] = ONE_PAGE
-        pages[:prev]  = collection.current_page - ONE_PAGE
+        pages[:prev] = collection.current_page - ONE_PAGE
       end
 
       unless collection.current_page == collection.total_pages
@@ -29,8 +87,26 @@ class Jbuilder
     end
   end
 
-  def query_parameters(options)
-    @query_parameters ||= options.fetch(:query_parameters, {})
+  def pages_without_count_from(collection)
+    {}.tap do |pages|
+      pages[:self] = collection.current_page
+
+      unless collection.current_page == ONE_PAGE
+        pages[:first] = ONE_PAGE
+        pages[:prev] = collection.current_page - ONE_PAGE
+      end
+
+      if collection.respond_to?(:last_page?) && collection.last_page?
+        # Do nothing
+        return pages
+      else
+        pages[:next] = collection.current_page + ONE_PAGE
+      end
+    end
+  end
+
+  def query_parameters(query_parameters, original_parameters)
+    @query_parameters ||= original_parameters.deep_merge(query_parameters || {}).compact
   end
 
   def is_paginated?(collection)
@@ -38,4 +114,13 @@ class Jbuilder
       collection.respond_to?(:total_pages) &&
       collection.respond_to?(:size)
   end
+
+  # Kaminari raises an exception if you call #total_count on a #without_count-ed collection
+  # Rescue can't be good for performance which is why you should use pages_no_count! if you know you will be
+  # dealing with non-counted collections
+  def is_countable?(collection)
+    collection.total_pages
+  rescue ::StandardError
+    false
+  end
 end

data/lib/jbuilder/pagination/version.rb

@@ -1,5 +1,3 @@
-module Jbuilder
-  class Pagination
-    VERSION = "0.0.2"
-  end
+module Pagination
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder_pagination_plus
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Bruno Bacarini
@@ -9,62 +9,88 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-17 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: jbuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +132,7 @@ files:
 - lib/jbuilder/pagination/exceptions/unpageable_resource_error.rb
 - lib/jbuilder/pagination/pages.rb
 - lib/jbuilder/pagination/version.rb
-homepage: https://github.com/PinsterTeam/jbuilder_pagination_plus
+homepage: https://github.com/IlluminusLimited/jbuilder_pagination_plus
 licenses:
 - MIT
 metadata: {}
@@ -125,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Jbuilder extension to allows pagination according to JSON API format