jsom-pagination 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659a0357cf67703a54dff3cfb06a965e91313102e5a1b9a313828cca8bb6515a
-  data.tar.gz: 4c7257c42ebf3809cfb3656257b5c79492aee30e983fd2da1dc2653fba4ff5d0
+  metadata.gz: 83137a4848a276bed8f982609a3b7de765a311718d983db6a7694f9abe99327d
+  data.tar.gz: c427e98b74e1c00c5d40f5546c943455c5c42ffddf1aa5ee2c037c03997a996a
 SHA512:
-  metadata.gz: 83ec1de4a1a1d9337b83cd3e51c40b2d41ca5cbaca7e098c6cdce9141148cdd21416c98eabbe8673fc32c6631656e290a338e2c3962e6ba70d3e85ef1034c967
-  data.tar.gz: '051196bfc9e1b8ad9bae79857cdfff9d915209b1e0e3a66f5786bcfd2962c18f673ea500fb25d7d70312f51013715640b0fd84044a7f22a56b46b0418435d728'
+  metadata.gz: 5b0067520185211ad3bee63fff7d60aedb109985680bc59e63f7c10600f41ae8e65ce787652f445d2df54b377b87ed8569d4f5b80f3db7a409a31815005b08dd
+  data.tar.gz: '00596d4aeb84d6f19ce513debfcca21a00314f5145c2ec8d9bfa8b627551081c0bff5c6c0a4036ec795535e0f62628a651da2587df1bacfdd0c8d9228928134e'

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Test & Release
+
+on:
+  push:
+    branches: [ release ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Run tests
+      run: |
+        bundle install
+        bundle exec rspec
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/gem-test.yml

@@ -0,0 +1,29 @@
+name: Run tests
+
+on:
+  push:
+    branches-ignore: [ release ]
+  pull_request:
+    branches: [ master release ]
+
+jobs:
+  build:
+    name: Build + Test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Run tests
+      run: |
+        bundle install
+        CI=true bundle exec rspec
+    - name: Upload report
+      run: |
+        mv ./coverage/coverage.xml cobertura.xml
+        bash <(curl -Ls https://coverage.codacy.com/get.sh) report
+      env:
+        CODACY_PROJECT_TOKEN: ${{secrets.CODACY_PROJECT_TOKEN}}

data/.gitignore

@@ -6,6 +6,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+/node_modules/
 
 # rspec failure tracking
 .rspec_status
+.DS_Store
+package.json
+package-lock.json

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*_spec.rb"

data/CODE_OF_CONDUCT.md

@@ -14,22 +14,26 @@ orientation.
 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
+-   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
+-   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
 
@@ -55,7 +59,7 @@ 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
+reported by contacting the project team at [sebastian@driggl.com.](mailto: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.
@@ -71,4 +75,5 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
 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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jsom-pagination (0.1.0)
+    jsom-pagination (0.1.1)
       dry-struct (~> 1.3.0)
       pagy (~> 3.8.3)
 
@@ -10,6 +10,7 @@ GEM
   specs:
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
+    docile (1.3.2)
     dry-configurable (0.11.6)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
@@ -53,6 +54,12 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-cobertura (1.4.0)
+      simplecov (~> 0.8)
+    simplecov-html (0.12.2)
 
 PLATFORMS
   ruby
@@ -61,6 +68,8 @@ DEPENDENCIES
   jsom-pagination!
   rake (~> 12.0)
   rspec (~> 3.0)
+  simplecov
+  simplecov-cobertura
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,5 +1,9 @@
 # JSOM::Pagination
 
+[![Gem Version](https://badge.fury.io/rb/jsom-pagination.svg)](https://badge.fury.io/rb/jsom-pagination)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/bc98c8c017c64b70a11ca79aea6c3e3c)](https://app.codacy.com/gh/useo-pl/jsom-pagination?utm_source=github.com&utm_medium=referral&utm_content=useo-pl/jsom-pagination&utm_campaign=Badge_Grade_Dashboard)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/eab277bd1f694da88691a2e645adbe96)](https://www.codacy.com/gh/useo-pl/jsom-pagination?utm_source=github.com&utm_medium=referral&utm_content=useo-pl/jsom-pagination&utm_campaign=Badge_Coverage)
+
 An easy to use JSON:API support for web applications.
 
 ## Installation
@@ -12,31 +16,35 @@ gem 'jsom-pagination'
 
 And then execute:
 
-    $ bundle install
+```shell
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install jsom-pagination
+```shell
+$ gem install jsom-pagination
+```
 
 ## Usage
 
-**For arrays**
+### 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')
+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_url: 'https://example.com')
 ```
 
-**For ActiveRecord collections**
+### 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')
+paginator = JSOM::Pagination::Paginator.new
+collection = Article.published
+paginated = paginator.call(collection, params: { number: 2, size: 3 }, base_url: 'https://example.com')
 ```
 
-**Meta data object**
+### Meta data object
 
 You can call `meta` on the paginated collection to easily get meta information about the paginated results
 
@@ -48,7 +56,7 @@ paginated.meta.to_h
 # => {:total=>10, :pages=>4}
 ```
 
-**Links object**
+### Links object
 
 You can call `links` on the paginated collection to easily get collection of pagination links for the client
 
@@ -66,10 +74,9 @@ paginated.links.to_h
 # }
 ```
 
-
 ### Rendering using fast_jsonapi
 
-```
+```ruby
 options = { meta: paginated.meta.to_h, links: paginated.links.to_h }
 render json: serializer.new(paginated.items, options)
 ```
@@ -82,8 +89,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
-
+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
 

data/jsom-pagination.gemspec

@@ -2,6 +2,8 @@
 
 require_relative 'lib/jsom/pagination/version'
 
+# rubocop:disable Metrics/BlockLength
+#
 Gem::Specification.new do |spec|
   spec.name = 'jsom-pagination'
   spec.version = JSOM::Pagination::VERSION
@@ -37,4 +39,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'dry-struct', '~>1.3.0'
   spec.add_dependency 'pagy', '~>3.8.3'
+
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-cobertura'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/jsom/pagination/paginator.rb

@@ -26,7 +26,7 @@ module JSOM
           else
             collection.offset(pagy.offset).limit(pagy.items).to_a
           end
-        return pagy, paginated
+        [pagy, paginated]
       end
     end
   end

data/lib/jsom/pagination/pagy.rb

@@ -2,169 +2,20 @@
 
 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
+# 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-types'
 
 module JSOM
@@ -7,4 +9,3 @@ module JSOM
     end
   end
 end
-

data/lib/jsom/pagination/version.rb

@@ -2,6 +2,6 @@
 
 module JSOM
   module Pagination
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsom-pagination
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sebastian Wilgosz
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2020-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.8.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  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: |2
       Easy to use, framework-agnostic set of methods useful for
       integrating JSON:API in your project.
@@ -47,8 +75,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/gem-test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -78,7 +109,7 @@ metadata:
   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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -94,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A pagination support for JSON:API based web applications.
 test_files: []