jsom-pagination 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 659a0357cf67703a54dff3cfb06a965e91313102e5a1b9a313828cca8bb6515a
+  data.tar.gz: 4c7257c42ebf3809cfb3656257b5c79492aee30e983fd2da1dc2653fba4ff5d0
+SHA512:
+  metadata.gz: 83ec1de4a1a1d9337b83cd3e51c40b2d41ca5cbaca7e098c6cdce9141148cdd21416c98eabbe8673fc32c6631656e290a338e2c3962e6ba70d3e85ef1034c967
+  data.tar.gz: '051196bfc9e1b8ad9bae79857cdfff9d915209b1e0e3a66f5786bcfd2962c18f673ea500fb25d7d70312f51013715640b0fd84044a7f22a56b46b0418435d728'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+jsom-pagination

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sebastian@driggl.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsom-pagination.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    jsom-pagination (0.1.0)
+      dry-struct (~> 1.3.0)
+      pagy (~> 3.8.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.7)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-struct (1.3.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-types (~> 1.3)
+      ice_nine (~> 0.11)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    ice_nine (0.11.2)
+    pagy (3.8.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jsom-pagination!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sebastian Wilgosz
+
+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,94 @@
+# JSOM::Pagination
+
+An easy to use JSON:API support for web applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsom-pagination'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jsom-pagination
+
+## Usage
+
+**For arrays**
+
+```ruby
+  paginator = JSOM::Pagination::Paginator.new
+  collection = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+  paginated = paginator.call(collection, params: { number: 2, size: 3 }, base_ur: 'https://example.com')
+```
+
+**For ActiveRecord collections**
+
+```ruby
+  paginator = JSOM::Pagination::Paginator.new
+  collection = Article.published
+  paginated = paginator.call(collection, params: { number: 2, size: 3 }, base_ur: 'https://example.com')
+```
+
+**Meta data object**
+
+You can call `meta` on the paginated collection to easily get meta information about the paginated results
+
+```ruby
+paginated.meta
+# => #<JSOM::Pagination::MetaData total=10 pages=4>
+
+paginated.meta.to_h
+# => {:total=>10, :pages=>4}
+```
+
+**Links object**
+
+You can call `links` on the paginated collection to easily get collection of pagination links for the client
+
+```ruby
+paginated.links
+# => #<JSOM::Pagination::Links:0x00007fdf5d0dd2b8 @url="https://example.com", @page=#<JSOM::Pagination::Page number=2 size=3>, @total_pages=4, @first="https://example.com?page[size]=3", @prev="https://example.com?page[size]=3", @self="https://example.com?page[number]=2&page[size]=3", @next="https://example.com?page[number]=3&page[size]=3", @last="https://example.com?page[number]=4&page[size]=3">
+
+paginated.links.to_h
+# => {
+#   :first=>"https://example.com?page[size]=3",
+#   :prev=>"https://example.com?page[size]=3",
+#   :self=>"https://example.com?page[number]=2&page[size]=3",
+#   :next=>"https://example.com?page[number]=3&page[size]=3",
+#   :last=>"https://example.com?page[number]=4&page[size]=3"
+# }
+```
+
+
+### Rendering using fast_jsonapi
+
+```
+options = { meta: paginated.meta.to_h, links: paginated.links.to_h }
+render json: serializer.new(paginated.items, options)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/useo-pl/jsom-pagination. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/useo-pl/jsom-pagination/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JSOM::Pagination project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/useo-pl/jsom-pagination/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'jsom/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(__FILE__)

data/bin/setup

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

data/jsom-pagination.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/jsom/pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'jsom-pagination'
+  spec.version = JSOM::Pagination::VERSION
+  spec.authors = ['Sebastian Wilgosz']
+  spec.email = ['sebastian@driggl.com']
+
+  spec.summary = 'A pagination support for JSON:API based web applications.'
+  spec.description = <<-STRING
+    Easy to use, framework-agnostic set of methods useful for
+    integrating JSON:API in your project.
+  STRING
+  spec.homepage = 'https://github.com/useo-pl/jsom-pagination'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/useo-pl/jsom-pagination'
+  spec.metadata['changelog_uri'] = 'https://github.com/useo-pl/jsom-pagination/releases'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-struct', '~>1.3.0'
+  spec.add_dependency 'pagy', '~>3.8.3'
+end

data/lib/jsom/pagination.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'jsom/pagination/version'
+require 'jsom/pagination/pagy'
+
+require 'jsom/pagination/page'
+require 'jsom/pagination/meta_data'
+require 'jsom/pagination/links'
+require 'jsom/pagination/collection'
+require 'jsom/pagination/paginator'
+
+module JSOM
+  module Pagination
+    class Error < StandardError; end
+  end
+end

data/lib/jsom/pagination/collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module JSOM
+  module Pagination
+    class Collection < Dry::Struct
+      attribute :items, Types::Strict::Array
+      attribute :meta, Types.Instance(MetaData)
+      attribute :links, Types::Instance(Links)
+    end
+  end
+end

data/lib/jsom/pagination/links.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module JSOM
+  module Pagination
+    class Links
+      DEFAULT_PAGE_SIZE = 20
+
+      def to_h
+        {
+          first: @first,
+          prev: @prev,
+          self: @self,
+          next: @next,
+          last: @last
+        }.reject { |_key, value| value.nil? }
+      end
+
+      def first
+        @first || generate_url(1)
+      end
+
+      def last
+        @last || generate_url(total_pages)
+      end
+
+      attr_reader :prev, :next, :self
+
+      private
+
+      attr_reader :page, :total_pages, :url
+
+      def initialize(page:, url:, total_pages:)
+        @url = url
+        @page = page
+        @total_pages = total_pages
+        generate_links
+      end
+
+      def generate_links
+        if page.number > 1
+          @first = generate_url(1)
+          @prev = generate_url(page.number - 1)
+        end
+        @self = generate_url(page.number)
+
+        return unless page.number < total_pages
+
+        @next = generate_url(page.number + 1)
+        @last = generate_url(total_pages)
+      end
+
+      def generate_url(page_number)
+        [url, url_params(page_number)].reject(&:empty?).join('?')
+      end
+
+      def url_params(page_number)
+        url_params = {}
+        url_params[:page] = {} if include_per_page? || include_page?(page_number)
+        url_params[:page][:number] = page_number if include_page?(page_number)
+        url_params[:page][:size] = page.size if include_per_page?
+        to_query(url_params)
+      end
+
+      def to_query(obj, namespace = nil)
+        query = obj.collect do |key, value|
+          if value.is_a?(Hash)
+            to_query(value, namespace ? "#{namespace}[#{key}]" : key)
+          else
+            ["#{namespace}[#{key}]", value].join('=')
+          end
+        end.compact
+
+        query.join('&')
+      end
+
+      def include_per_page?
+        page.size != DEFAULT_PAGE_SIZE
+      end
+
+      def include_page?(page_number)
+        page_number > 1
+      end
+    end
+  end
+end

data/lib/jsom/pagination/meta_data.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+require 'jsom/pagination/types'
+
+module JSOM
+  module Pagination
+    class MetaData < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :total, Types::Params::Integer
+      attribute :pages, Types::Params::Integer
+    end
+  end
+end

data/lib/jsom/pagination/page.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+require 'jsom/pagination/types'
+
+module JSOM
+  module Pagination
+    # A value object for requested page. Usage:
+    # JSOM::Pagination::Page.new(number: 1, size: 20)
+    # Works for string values and symbols, supports defaults.
+    # Ignores extra keys
+    # Sets 1 for negative values
+    #
+    class Page < Dry::Struct
+      transform_keys(&:to_sym)
+
+      transform_types do |type|
+        return type unless type.default?
+
+        type.constructor do |value|
+          if value.nil?
+            Dry::Types::Undefined
+          elsif value == Dry::Types::Undefined
+            value
+          elsif Dry::Types['params.integer'][value].negative?
+            1
+          else
+            value
+          end
+        end
+      end
+
+      attribute :number, Types::Params::Integer.default(1)
+      attribute :size, Types::Params::Integer.default(20)
+    end
+  end
+end

data/lib/jsom/pagination/paginator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module JSOM
+  module Pagination
+    class Paginator
+      def call(collection, params:, base_url: '')
+        @page = Page.new(params)
+
+        pagy, records = pagy_custom(collection, page: page)
+
+        meta = MetaData.new(total: pagy.count, pages: pagy.pages)
+        # pagy methods: :count, :page, :items, :vars, :pages, :last, :offset, :from, :to, :prev, :next
+        links = Links.new(page: page, total_pages: pagy.pages, url: base_url)
+        Collection.new(items: records, links: links, meta: meta)
+      end
+
+      private
+
+      attr_reader :page
+
+      def pagy_custom(collection, page:)
+        pagy = Pagy.new(count: collection.count, page: page.number, items: page.size)
+        paginated =
+          if collection.is_a?(Array)
+            collection[pagy.offset, pagy.items]
+          else
+            collection.offset(pagy.offset).limit(pagy.items).to_a
+          end
+        return pagy, paginated
+      end
+    end
+  end
+end

data/lib/jsom/pagination/pagy.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'pagy'
+
+# Pagy initializer file (3.8.3)
+# Customize only what you really need and notice that Pagy works also without any of the following lines.
+# Should you just cherry pick part of this file, please maintain the require-order of the extras
+
+# Extras
+# See https://ddnexus.github.io/pagy/extras
+
+# Backend Extras
+
+# Array extra: Paginate arrays efficiently, avoiding expensive array-wrapping and without overriding
+# See https://ddnexus.github.io/pagy/extras/array
+require 'pagy/extras/array'
+
+# Countless extra: Paginate without any count, saving one query per rendering
+# See https://ddnexus.github.io/pagy/extras/countless
+# require 'pagy/extras/countless'
+# Pagy::VARS[:cycle] = false    # default
+
+# Elasticsearch Rails extra: Paginate `ElasticsearchRails::Results` objects
+# See https://ddnexus.github.io/pagy/extras/elasticsearch_rails
+# require 'pagy/extras/elasticsearch_rails'
+
+# Searchkick extra: Paginate `Searchkick::Results` objects
+# See https://ddnexus.github.io/pagy/extras/searchkick
+# require 'pagy/extras/searchkick'
+
+
+# Frontend Extras
+
+# Bootstrap extra: Add nav, nav_js and combo_nav_js helpers and templates for Bootstrap pagination
+# See https://ddnexus.github.io/pagy/extras/bootstrap
+# require 'pagy/extras/bootstrap'
+
+# Bulma extra: Add nav, nav_js and combo_nav_js helpers and templates for Bulma pagination
+# See https://ddnexus.github.io/pagy/extras/bulma
+# require 'pagy/extras/bulma'
+
+# Foundation extra: Add nav, nav_js and combo_nav_js helpers and templates for Foundation pagination
+# See https://ddnexus.github.io/pagy/extras/foundation
+# require 'pagy/extras/foundation'
+
+# Materialize extra: Add nav, nav_js and combo_nav_js helpers for Materialize pagination
+# See https://ddnexus.github.io/pagy/extras/materialize
+# require 'pagy/extras/materialize'
+
+# Navs extra: Add nav_js and combo_nav_js javascript helpers
+# Notice: the other frontend extras add their own framework-styled versions,
+# so require this extra only if you need the unstyled version
+# See https://ddnexus.github.io/pagy/extras/navs
+# require 'pagy/extras/navs'
+
+# Semantic extra: Add nav, nav_js and combo_nav_js helpers for Semantic UI pagination
+# See https://ddnexus.github.io/pagy/extras/semantic
+# require 'pagy/extras/semantic'
+
+# UIkit extra: Add nav helper and templates for UIkit pagination
+# See https://ddnexus.github.io/pagy/extras/uikit
+# require 'pagy/extras/uikit'
+
+# Multi size var used by the *_nav_js helpers
+# See https://ddnexus.github.io/pagy/extras/navs#steps
+# Pagy::VARS[:steps] = { 0 => [2,3,3,2], 540 => [3,5,5,3], 720 => [5,7,7,5] }   # example
+
+
+# Feature Extras
+
+# Headers extra: http response headers (and other helpers) useful for API pagination
+# See http://ddnexus.github.io/pagy/extras/headers
+# require 'pagy/extras/headers'
+# Pagy::VARS[:headers] = { page: 'Current-Page', items: 'Page-Items', count: 'Total-Count', pages: 'Total-Pages' }     # default
+
+# Support extra: Extra support for features like: incremental, infinite, auto-scroll pagination
+# See https://ddnexus.github.io/pagy/extras/support
+# require 'pagy/extras/support'
+
+# Items extra: Allow the client to request a custom number of items per page with an optional selector UI
+# See https://ddnexus.github.io/pagy/extras/items
+# require 'pagy/extras/items'
+# Pagy::VARS[:items_param] = :items    # default
+# Pagy::VARS[:max_items]   = 100       # default
+
+# Overflow extra: Allow for easy handling of overflowing pages
+# See https://ddnexus.github.io/pagy/extras/overflow
+require 'pagy/extras/overflow'
+
+Pagy::VARS[:overflow] = :empty_page
+
+# Metadata extra: Provides the pagination metadata to Javascript frameworks like Vue.js, react.js, etc.
+# See https://ddnexus.github.io/pagy/extras/metadata
+# you must require the shared internal extra (BEFORE the metadata extra) ONLY if you need also the :sequels
+# require 'pagy/extras/shared'
+# require 'pagy/extras/metadata'
+# For performance reason, you should explicitly set ONLY the metadata you use in the frontend
+# Pagy::VARS[:metadata] = [:scaffold_url, :count, :page, :prev, :next, :last]    # example
+
+# Trim extra: Remove the page=1 param from links
+# See https://ddnexus.github.io/pagy/extras/trim
+# require 'pagy/extras/trim'
+
+
+
+# Pagy Variables
+# See https://ddnexus.github.io/pagy/api/pagy#variables
+# All the Pagy::VARS are set for all the Pagy instances but can be overridden
+# per instance by just passing them to Pagy.new or the #pagy controller method
+
+
+# Instance variables
+# See https://ddnexus.github.io/pagy/api/pagy#instance-variables
+# Pagy::VARS[:items] = 20                                   # default
+
+
+# Other Variables
+# See https://ddnexus.github.io/pagy/api/pagy#other-variables
+# Pagy::VARS[:size]       = [1,4,4,1]                       # default
+# Pagy::VARS[:page_param] = :page                           # default
+# Pagy::VARS[:params]     = {}                              # default
+# Pagy::VARS[:anchor]     = '#anchor'                       # example
+# Pagy::VARS[:link_extra] = 'data-remote="true"'            # example
+
+
+# Rails
+
+# Rails: extras assets path required by the helpers that use javascript
+# (pagy*_nav_js, pagy*_combo_nav_js, and pagy_items_selector_js)
+# See https://ddnexus.github.io/pagy/extras#javascript
+# Rails.application.config.assets.paths << Pagy.root.join('javascripts')
+
+
+# I18n
+
+# Pagy internal I18n: ~18x faster using ~10x less memory than the i18n gem
+# See https://ddnexus.github.io/pagy/api/frontend#i18n
+# Notice: No need to configure anything in this section if your app uses only "en"
+# or if you use the i18n extra below
+#
+# Examples:
+# load the "de" built-in locale:
+# Pagy::I18n.load(locale: 'de')
+#
+# load the "de" locale defined in the custom file at :filepath:
+# Pagy::I18n.load(locale: 'de', filepath: 'path/to/pagy-de.yml')
+#
+# load the "de", "en" and "es" built-in locales:
+# (the first passed :locale will be used also as the default_locale)
+# Pagy::I18n.load({locale: 'de'},
+#                 {locale: 'en'},
+#                 {locale: 'es'})
+#
+# load the "en" built-in locale, a custom "es" locale,
+# and a totally custom locale complete with a custom :pluralize proc:
+# (the first passed :locale will be used also as the default_locale)
+# Pagy::I18n.load({locale: 'en'},
+#                 {locale: 'es', filepath: 'path/to/pagy-es.yml'},
+#                 {locale: 'xyz',  # not built-in
+#                  filepath: 'path/to/pagy-xyz.yml',
+#                  pluralize: lambda{|count| ... } )
+
+
+# I18n extra: uses the standard i18n gem which is ~18x slower using ~10x more memory
+# than the default pagy internal i18n (see above)
+# See https://ddnexus.github.io/pagy/extras/i18n
+# require 'pagy/extras/i18n'
+
+# Default i18n key
+# Pagy::VARS[:i18n_key] = 'pagy.item_name'   # default

data/lib/jsom/pagination/types.rb

@@ -0,0 +1,10 @@
+require 'dry-types'
+
+module JSOM
+  module Pagination
+    module Types
+      include Dry.Types()
+    end
+  end
+end
+

data/lib/jsom/pagination/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module JSOM
+  module Pagination
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: jsom-pagination
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Wilgosz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+description: |2
+      Easy to use, framework-agnostic set of methods useful for
+      integrating JSON:API in your project.
+email:
+- sebastian@driggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsom-pagination.gemspec
+- lib/jsom/pagination.rb
+- lib/jsom/pagination/collection.rb
+- lib/jsom/pagination/links.rb
+- lib/jsom/pagination/meta_data.rb
+- lib/jsom/pagination/page.rb
+- lib/jsom/pagination/paginator.rb
+- lib/jsom/pagination/pagy.rb
+- lib/jsom/pagination/types.rb
+- lib/jsom/pagination/version.rb
+homepage: https://github.com/useo-pl/jsom-pagination
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/useo-pl/jsom-pagination
+  source_code_uri: https://github.com/useo-pl/jsom-pagination
+  changelog_uri: https://github.com/useo-pl/jsom-pagination/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A pagination support for JSON:API based web applications.
+test_files: []