jbuilder_pagination_plus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b598e1844ee0ffb21795036c763ded62f5aaebba
+  data.tar.gz: 0f8f48ea56bb67c9edf48f818cc589714c73294a
+SHA512:
+  metadata.gz: f79f1c3771d7b01761026e91073daf0e7d1a66c1758fcd0c1daec3e5386deabb5e497c88f6373fb8e527c319add201c9c96dc3462b806443de732848d7d98ba0
+  data.tar.gz: 973a9854fd17438a380d4ef223ffc99b6e69bfd15a6579b0be54c960eb3b7605ad41c7892b0bc43a957c52dd98109372ca44300c6a5f60e1fd14aa6e3985e399

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sw?
+.idea/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+jbuilder_pagination

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.3

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jbuilder_pagination_plus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bruno Bacarini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# Jbuilder Pagination Plus [![Build Status](https://travis-ci.org/PinsterTeam/jbuilder_pagination_plus.svg?branch=master)](https://travis-ci.org/PinsterTeam/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.
+
+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).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jbuilder_pagination_plus', require: 'jbuilder/pagination'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jbuilder_pagination_plus
+
+## Usage
+
+###### Kaminari examples
+```ruby
+#array
+@posts = paginate Kaminari.paginate_array([1, 2, 3])
+
+#active_record
+@posts = paginate Post
+```
+
+###### WillPaginate examples
+
+```ruby
+#array
+@posts = [1,2,3].paginate(page: 3, per_page: 1)
+
+#active_record
+@posts = Post.page(3).per_page(1)
+```
+
+And then in your `*.json.jbuilder`
+
+```ruby
+json.links do
+  json.pages! @posts, url: "http://example.com/posts", query_parameters: { additional: 'parameters' }
+end
+json.data do
+  # Whatever your data is
+end
+
+# {
+#    "links": {
+#      "self": "http://example.com/posts?page[number]=3&page[size]=1&additional=parameters",
+#      "first": "http://example.com/posts?page[number]=1&page[size]=1&additional=parameters",
+#      "prev": "http://example.com/posts?page[number]=2&page[size]=1&additional=parameters",
+#      "next": "http://example.com/posts?page[number]=4&page[size]=1&additional=parameters",
+#      "last": "http://example.com/posts?page[number]=13&page[size]=1&additional=parameters"
+#    },
+#    "data": {
+#      ...
+#    } 
+# }  
+```
+The options `url` and  `query_parameters` are opcionals.
+
+In case there is no pagination at all, `links` will be omitted.
+
+## 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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jbuilder/pagination"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install --jobs=3 --retry=3
+
+# Do any other automated setup that you need to do here

data/jbuilder_pagination_plus.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jbuilder/pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "jbuilder_pagination_plus"
+  spec.version = Jbuilder::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.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  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_development_dependency 'pry', '~> 0'
+end

data/lib/concerns/pagination.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'exceptions/unpageable_resource_error'
+
+module Pagination
+  # The order of this hash matters, elements are pulled off the end by calling .pop recursively
+  DEFAULT_PAGINATION = [[:page, ->(params) { params.dig(:page, :number) }],
+                        [:per, ->(params) { params.dig(:page, :size) }]].freeze
+
+  def paginate(pageable_resource, methods = DEFAULT_PAGINATION.dup, params = self.params)
+    return pageable_resource if methods.blank?
+    key_value_array = methods.pop
+    build_pagination(key_value_array, paginate(pageable_resource, methods, params), params)
+  end
+
+  private
+
+    def build_pagination(key_value_array, pageable_resource, params)
+      unless pageable_resource.respond_to?(key_value_array[0])
+        raise 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))
+    end
+end

data/lib/exceptions/unpageable_resource_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class UnpageableResourceError < StandardError
+  def initialize(message)
+    super(message)
+  end
+end

data/lib/jbuilder/pagination/pages.rb

@@ -0,0 +1,41 @@
+class Jbuilder
+  ONE_PAGE = 1
+
+  def pages!(collection, options={})
+    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}"
+    end
+  end
+
+  private
+
+  def pages_from(collection)
+    {}.tap do |pages|
+      pages[:self] = collection.current_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
+      end
+
+      unless collection.current_page == collection.total_pages
+        pages[:next] = collection.current_page + ONE_PAGE
+        pages[:last] = collection.total_pages
+      end
+    end
+  end
+
+  def query_parameters(options)
+    @query_parameters ||= options.fetch(:query_parameters, {})
+  end
+
+  def is_paginated?(collection)
+    collection.respond_to?(:current_page) &&
+      collection.respond_to?(:total_pages) &&
+      collection.respond_to?(:size)
+  end
+end

data/lib/jbuilder/pagination/version.rb

@@ -0,0 +1,5 @@
+module Jbuilder
+  class Pagination
+    VERSION = "0.0.1"
+  end
+end

data/lib/jbuilder/pagination.rb

@@ -0,0 +1,3 @@
+require "jbuilder"
+require "jbuilder/pagination/pages"
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: jbuilder_pagination_plus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruno Bacarini
+- Andrew Newell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+email:
+- bacarini.bruno@gmail.com
+- scytherswings@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jbuilder_pagination_plus.gemspec
+- lib/concerns/pagination.rb
+- lib/exceptions/unpageable_resource_error.rb
+- lib/jbuilder/pagination.rb
+- lib/jbuilder/pagination/pages.rb
+- lib/jbuilder/pagination/version.rb
+homepage: https://github.com/PinsterTeam/jbuilder_pagination_plus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Jbuilder extension to allows pagination according to JSON API format
+test_files: []