jsom-pagination 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83137a4848a276bed8f982609a3b7de765a311718d983db6a7694f9abe99327d
-  data.tar.gz: c427e98b74e1c00c5d40f5546c943455c5c42ffddf1aa5ee2c037c03997a996a
+  metadata.gz: 27b6274de4e4cdc7a40b3b729be4b541648402b89a5d1226339df372c6d5926f
+  data.tar.gz: c19be09cfa6e72aae8cd725d102999f5b40fafd56d2973405d4c9b40615342bb
 SHA512:
-  metadata.gz: 5b0067520185211ad3bee63fff7d60aedb109985680bc59e63f7c10600f41ae8e65ce787652f445d2df54b377b87ed8569d4f5b80f3db7a409a31815005b08dd
-  data.tar.gz: '00596d4aeb84d6f19ce513debfcca21a00314f5145c2ec8d9bfa8b627551081c0bff5c6c0a4036ec795535e0f62628a651da2587df1bacfdd0c8d9228928134e'
+  metadata.gz: cb5be3723a23a0c13769a65aa9f0bdc73106348e14c3a970823435641764a2748837f0e8cb282830f652dc7dcc5ddb35c4f0c3aaf3d9e3408f9b52082d4340ad
+  data.tar.gz: e1a3c291ca065a5fad11ae3705d1a60117ca36d82cfe4803f2f16d52d6f276396bc67860e56793f46a75be7527b488ecfa54733d25f1802829099f8a9e97eece

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

@@ -8,13 +8,17 @@ jobs:
   build:
     name: Build + Publish
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.7.1
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
       with:
-        ruby-version: 2.7.1
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: |
         bundle install

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

@@ -10,20 +10,24 @@ jobs:
   build:
     name: Build + Test
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.7.1
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
       with:
-        ruby-version: 2.7.1
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - 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}}
+    # - 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

@@ -13,3 +13,8 @@
 .DS_Store
 package.json
 package-lock.json
+
+#rubocop qa-tools default rules
+.rubocop-https*
+
+/jsom-pagination*.gem

data/.rubocop.disabled.yml

@@ -0,0 +1,12 @@
+# These are all the cops that are disabled in the default configuration.
+
+Style/Copyright:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*_spec.rb"

data/.rubocop.yml

@@ -1,9 +1,11 @@
-inherit_from: .rubocop_todo.yml
+inherit_from:
+  - https://raw.githubusercontent.com/yousty/qa-tools/master/rubocop/base/.rubocop.yml # common enabled rules
+  - https://raw.githubusercontent.com/yousty/qa-tools/master/rubocop/base/.rubocop.disabled.yml # common disabled rules
+  - .rubocop.disabled.yml # project specific disabled rules
 
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*_spec.rb"
+# project specific overwritten rules
 
-Metrics/ModuleLength:
-  Exclude:
-    - "spec/**/*_spec.rb"
+# example:
+# Layout/LineLength:
+# Max: 100
+# AllowHeredoc: true

data/README.md

@@ -1,6 +1,7 @@
 # JSOM::Pagination
 
 [![Gem Version](https://badge.fury.io/rb/jsom-pagination.svg)](https://badge.fury.io/rb/jsom-pagination)
+![Tests](https://github.com/useo-pl/jsom-pagination/workflows/Run%20tests/badge.svg?branch=master&event=push)
 [![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)
 
@@ -81,6 +82,88 @@ options = { meta: paginated.meta.to_h, links: paginated.links.to_h }
 render json: serializer.new(paginated.items, options)
 ```
 
+### Summary
+
+Using the information above, you can put everything all together by using [jsom-pagination](https://github.com/useo-pl/jsom-pagination) in a ruby framework of your choice.
+
+Below is an illustration in [Rails](https://rubyonrails.org/):
+
+```ruby
+# app/controllers/concerns/paginable.rb
+module Paginable
+    extend ActiveSupport::Concern
+    
+    def paginator
+      JSOM::Pagination::Paginator.new
+    end
+    
+    def pagination_params
+      params.permit![:page] # defaults to 20 pages 
+    end
+    
+    def paginate(collection)
+      paginator.call(collection, params: pagination_params, base_url: request.url)
+    end
+  
+    def render_collection(paginated)
+      options = {
+        # meta: paginated.meta.to_h, # Will get total pages, total count, etc.
+        links: paginated.links.to_h
+      }
+      paginated_result = serializer.new(paginated.items, options)
+  
+      render json: paginated_result
+    end
+end
+```
+
+```ruby
+# app/controllers/articles_controllers.rb
+class ArtclesController < ApplicationController
+    include Paginable
+
+    def index
+        articles = articles = Article.order('created_at DESC')
+        paginated = paginate(articles)
+    
+        articles.present? ? render_collection(paginated) : :not_found
+    end
+
+    private
+
+    def serializer
+        ArticleSerializer
+    end
+end
+```
+
+The response from the paginated json will look like below:
+
+```json
+{
+  "data": [
+    {
+      "id": "5404329",
+      "type": "article",
+      "attributes": {
+        "author": "Canan Ercan",
+        "copies": 10000,
+        "publisher": "Webster & Canan Publishers",
+        "price": "700"
+      }
+    }
+  ],
+  "links": {
+    "first": "http://127.0.0.1:3000/api/v1/articles",
+    "prev": "http://127.0.0.1:3000/api/v1/articles?page[number]=349",
+    "self": "http://127.0.0.1:3000/api/v1/articles?page[number]=350",
+    "next": "http://127.0.0.1:3000/api/v1/articles?page[number]=351",
+    "last": "http://127.0.0.1:3000/api/v1/articles?page[number]=352"
+  }
+}
+```
+
+
 ## 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.

data/jsom-pagination.gemspec

@@ -30,15 +30,17 @@ Gem::Specification.new do |spec|
   # 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)/})
+      f.match(%r{^(test|spec|features|Gemfile\.lock)/?})
     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'
+  spec.add_dependency 'dry-struct', '~>1.3'
+  spec.add_dependency 'pagy', '~>4.0'
+  spec.add_dependency 'rack'
+  spec.add_dependency 'addressable', '~> 2.3', '>= 2.3.7'
 
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-cobertura'

data/lib/jsom/pagination/links.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rack/utils'
+require 'addressable'
 module JSOM
   module Pagination
     class Links
@@ -30,12 +32,23 @@ module JSOM
       attr_reader :page, :total_pages, :url
 
       def initialize(page:, url:, total_pages:)
-        @url = url
+        @url = parse_url(url)
         @page = page
         @total_pages = total_pages
         generate_links
       end
 
+      def parse_url(url)
+        uri = Addressable::URI.parse(url)
+
+        url_params = Rack::Utils.parse_nested_query(
+          uri.query
+        ).delete_if { |key, _value| key == 'page' }
+        uri.query = to_query(url_params)
+        uri.query = nil if uri.query.empty?
+        uri
+      end
+
       def generate_links
         if page.number > 1
           @first = generate_url(1)
@@ -50,7 +63,8 @@ module JSOM
       end
 
       def generate_url(page_number)
-        [url, url_params(page_number)].reject(&:empty?).join('?')
+        separator = url.to_s.include?('?') ? '&' : '?'
+        [url.to_s, url_params(page_number)].reject(&:empty?).join(separator)
       end
 
       def url_params(page_number)
@@ -61,12 +75,16 @@ module JSOM
         to_query(url_params)
       end
 
-      def to_query(obj, namespace = nil)
+      def to_query(obj, namespace = '')
         query = obj.collect do |key, value|
           if value.is_a?(Hash)
-            to_query(value, namespace ? "#{namespace}[#{key}]" : key)
+            to_query(value, namespace.empty? ? key : "#{namespace}[#{key}]")
           else
-            ["#{namespace}[#{key}]", value].join('=')
+            if namespace.empty?
+              [key, value].join('=')
+            else
+              ["#{namespace}[#{key}]", value].join('=')
+            end
           end
         end.compact
 

data/lib/jsom/pagination/paginator.rb

@@ -19,7 +19,7 @@ module JSOM
       attr_reader :page
 
       def pagy_custom(collection, page:)
-        pagy = Pagy.new(count: collection.count, page: page.number, items: page.size)
+        pagy = Pagy.new(count: collection.size, page: page.number, items: page.size)
         paginated =
           if collection.is_a?(Array)
             collection[pagy.offset, pagy.items]

data/lib/jsom/pagination/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsom-pagination
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-13 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -16,28 +16,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.7
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -79,13 +113,13 @@ files:
 - ".github/workflows/gem-test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.disabled.yml"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -124,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A pagination support for JSON:API based web applications.

data/Gemfile.lock

@@ -1,75 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jsom-pagination (0.1.1)
-      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)
-    docile (1.3.2)
-    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)
-    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
-
-DEPENDENCIES
-  jsom-pagination!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  simplecov
-  simplecov-cobertura
-
-BUNDLED WITH
-   2.1.4