graphql-pagination 0.2.3 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 338fc0497792b1bd3ca3fff2daf6200978f7c4bfaf43722e834dc29dd629f0c2
-  data.tar.gz: 62430fbde2facf0586e6f898930b01aa49c71bfa77db842bd88fece8ebc4dbe5
+  metadata.gz: afd9e4d2bcb920c10f5db2c679977e74af876dc51fe2d44edde7443d8c21a2a8
+  data.tar.gz: 6485e139197e892711f43a8772c3e4383af9d5a648ec1bd53297a4b662f44857
 SHA512:
-  metadata.gz: c7f95879e8249e61a19624ecf0c73146fd8264997fc9e7d35b49008bc557447e2afd1f20bc65be8b3c3dcc6f0ef21e055bb92cf53c5b6e3bcd351407a3d0fb68
-  data.tar.gz: b37539d880b78d498815f5c6b88966dfefe557f14c2d4a4dc514a7d7e6de8551368e1d6789fd45de3fe889290e34440ff39f8add2bc0c4313fee6eae4eaede6b
+  metadata.gz: afbd70d8259b21d58cbdb7c9b2c2f9f8d027e3648f77c3f5caa6afa5e4644dfc98ba120f1ece568f5faaf177ddf05398a7495b32a2669ab19d0d472f043340ef
+  data.tar.gz: 3651b3536bc483d59fd93090bfa9e3d761f69cfe518bdeb08313b6fc59ad188de0f8a12187adf46df4fed7c7aa603b58b4c015b3457f298e5bf50a53bc2da35c

data/.bundler-version

@@ -0,0 +1 @@
+2.2.22

data/.dependabot/config.yml

@@ -0,0 +1,16 @@
+version: 1
+
+update_configs:
+  - package_manager: "ruby:bundler"
+    directory: "/"
+    update_schedule: "daily"
+    commit_message:
+      prefix: "[dependabot]"
+    allowed_updates:
+      - match:
+          dependency_type: "all"
+          update_type: "security"
+    automerged_updates:
+      - match:
+          dependency_type: "all"
+          update_type: "security:patch"

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to track an issue that has been identified
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Mutation/Query**
+
+**URL and HTTP method (for non-GQL):**
+
+**Sentry or Logs URL:**
+
+**User/authentication details**
+Impacted user name or service account
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

data/.github/ISSUE_TEMPLATE/story.md

@@ -0,0 +1,22 @@
+---
+name: New story
+about: Add a new story for implementation
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the solution**
+A clear and concise description of what you want to happen.
+When will this feature be done?
+
+**Describe the users**
+Who are we building this feature for?
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+Link to any applicable documents describing the feature.
+
+**Designs**
+Link to any applicable designs on Invision.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Description
+<!--- Describe your changes in detail -->
+
+## Related issue(s)
+<!--- GH issue number -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+
+## Screenshots (if appropriate):
+<!--- Please add any screenshots of the feature. -->
+
+## Related PRs
+<!--- Please add links to any related PRs (backend, component packages, etc). -->

data/.github/workflows/auto-approve.yml

@@ -0,0 +1,16 @@
+# automatically approve PRs submitted by Dependabot or Renofidev
+# this will allow Dependabot to automatically merge dependency update PRs where CI passes
+# from: https://github.com/hmarr/auto-approve-action
+name: Auto approve dependency upgrades PRs
+
+on:
+  pull_request
+
+jobs:
+  auto-approve:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: hmarr/auto-approve-action@v2.0.0
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' || github.actor == 'renofidev'
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,19 @@
+name: automerge
+on:
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge
+        uses: "pascalgn/automerge-action@v0.12.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true

data/.travis.yml

@@ -3,9 +3,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.7
-  - 2.6.5
-before_install: gem install bundler -v 2.0.2
+  - 2.7
+  - 3.0
+before_install: gem install bundler
 script:
-  - bundle exec rspec
-  - bundle exec rubocop
+  - bundle exec rake spec
+  - bundle exec rake rubocop

data/Gemfile.lock

@@ -1,76 +1,85 @@
 PATH
   remote: .
   specs:
-    graphql-pagination (0.2.3)
-      graphql (~> 1.9.4)
+    graphql-pagination (1.1.3)
+      graphql (~> 1.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.1)
-      activesupport (= 6.0.1)
-    activerecord (6.0.1)
-      activemodel (= 6.0.1)
-      activesupport (= 6.0.1)
-    activesupport (6.0.1)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    graphql (1.9.15)
-    i18n (1.7.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    graphql (1.12.13)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    kaminari-activerecord (1.1.1)
+    kaminari-activerecord (1.2.1)
       activerecord
-      kaminari-core (= 1.1.1)
-    kaminari-core (1.1.1)
-    method_source (0.9.2)
-    minitest (5.13.0)
-    parallel (1.19.1)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+      kaminari-core (= 1.2.1)
+    kaminari-core (1.2.1)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rake (13.0.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.77.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.1)
-      rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.2.2)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   graphql-pagination!
@@ -80,7 +89,8 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
-   2.0.2
+   2.2.15

data/README.md

@@ -29,10 +29,9 @@ Add `graphql-pagination` to your Gemfile, you can use `kaminari-activerecord` or
 
 Value returned by query resolver must be a kaminari object or implements its page scope methods (`current_page`, `limit_value`, `total_count`, `total_pages`).
 
-
 ## GraphQL query
 
-```
+```graphql
 {
   fruits(page: 2, limit: 2) {
     collection {
@@ -49,31 +48,54 @@ Value returned by query resolver must be a kaminari object or implements its pag
 }
 ```
 
-```
+```json
 {
-  'data': {
-    'checklists': {
-      'collection': [
+  "data": {
+    "checklists": {
+      "collection": [
         {
-          'id': '93938bb3-7a6c-4d35-9961-cbb2d4c9e9ac',
-          'name': 'Apple'
+          "id": "93938bb3-7a6c-4d35-9961-cbb2d4c9e9ac",
+          "name": "Apple"
         },
         {
-          'id': 'b1ee93b2-579a-4107-8454-119bba5afb63',
-          'name': 'Mango'
+          "id": "b1ee93b2-579a-4107-8454-119bba5afb63",
+          "name": "Mango"
         }
       ],
-      'metadata': {
-        'totalPages': 25,
-        'totalCount': 50,
-        'currentPage': 2,
-        'limitValue': 2
+      "metadata": {
+        "totalPages": 25,
+        "totalCount": 50,
+        "currentPage": 2,
+        "limitValue": 2
       }
     }
   }
 }
 ```
 
+## Custom Metadata
+
+By default, the following fields are present in the metadata block:
+
+```graphql
+metadata {
+  totalPages
+  totalCount
+  currentPage
+  limitValue
+}
+```
+
+These fields correspond to the `GraphqlPagination::CollectionMetadataType` used to provide the pagination information for the collection of data delivered. If you want to add more metadata fields to this block, you can do so by extending this `CollectionMetadataType`:
+
+```ruby
+class MyMetadataType < GraphqlPagination::CollectionMetadataType
+  field :custom_field, String, null: false
+end
+
+field :fruits, Types::FruitType.collection_type(metadata_type: MyMetadataType)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/renofi/graphql-pagination. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -81,4 +103,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/renofi
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]

data/graphql-pagination.gemspec

@@ -3,29 +3,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'graphql_pagination/version'
 
 Gem::Specification.new do |spec|
-  spec.name    = 'graphql-pagination'
+  spec.name = 'graphql-pagination'
   spec.version = GraphqlPagination::VERSION
   spec.authors = ['Krzysztof Knapik', 'RenoFi Engineering Team']
-  spec.email   = ['knapo@knapo.net', 'engineering@renofi.com']
+  spec.email = ['knapo@knapo.net', 'engineering@renofi.com']
 
-  spec.summary     = 'Page-based kaminari pagination for graphql.'
+  spec.summary = 'Page-based kaminari pagination for graphql.'
   spec.description = 'Page-based kaminari pagination for graphql returning collection and pagination metadata.'
-  spec.homepage    = 'https://github.com/RenoFi/graphql-pagination'
-  spec.license     = 'MIT'
+  spec.homepage = 'https://github.com/RenoFi/graphql-pagination'
+  spec.license = 'MIT'
 
   spec.metadata['homepage_uri'] = 'https://github.com/RenoFi/graphql-pagination'
   spec.metadata['source_code_uri'] = 'https://github.com/RenoFi/graphql-pagination'
 
   spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_dependency 'graphql', '~> 1.9.4'
+  spec.add_dependency 'graphql', '~> 1.11'
 
   spec.add_development_dependency 'kaminari-activerecord'
   spec.add_development_dependency 'kaminari-core'
@@ -33,5 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
 end

data/lib/graphql_pagination.rb

@@ -5,7 +5,6 @@ require 'graphql/schema/object'
 module GraphqlPagination
 end
 
-require 'graphql_pagination/version'
 require 'graphql_pagination/collection_type'
 require 'graphql_pagination/collection_metadata_type'
 

data/lib/graphql_pagination/collection_metadata_type.rb

@@ -1,8 +1,8 @@
 module GraphqlPagination
   class CollectionMetadataType < GraphQL::Schema::Object
     field :current_page, Integer, null: false
-    field :limit_value,  Integer, null: false
-    field :total_count,  Integer, null: false
-    field :total_pages,  Integer, null: false
+    field :limit_value, Integer, null: false
+    field :total_count, Integer, null: false
+    field :total_pages, Integer, null: false
   end
 end

data/lib/graphql_pagination/collection_type.rb

@@ -1,14 +1,15 @@
 module GraphqlPagination
   module CollectionType
-    def collection_type
-      @collection_type ||= begin
+    def collection_type(metadata_type: GraphqlPagination::CollectionMetadataType)
+      @collection_types ||= {}
+      @collection_types[metadata_type] ||= begin
         type_name = "#{graphql_name}Collection"
         source_type = self
 
         Class.new(GraphQL::Schema::Object) do
           graphql_name type_name
           field :collection, [source_type], null: false
-          field :metadata, GraphqlPagination::CollectionMetadataType, null: false
+          field :metadata, metadata_type, null: false
 
           def collection
             object

data/lib/graphql_pagination/version.rb

@@ -1,3 +1,3 @@
 module GraphqlPagination
-  VERSION = '0.2.3'.freeze
+  VERSION = '1.1.3'.freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: graphql-pagination
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.1.3
 platform: ruby
 authors:
 - Krzysztof Knapik
 - RenoFi Engineering Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.4
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.4
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: kaminari-activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
+  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: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -132,11 +146,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundler-version"
+- ".dependabot/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/story.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/auto-approve.yml"
+- ".github/workflows/auto-merge.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -155,7 +174,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/RenoFi/graphql-pagination
   source_code_uri: https://github.com/RenoFi/graphql-pagination
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,15 +182,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Page-based kaminari pagination for graphql.
 test_files: []

data/.rubocop.yml

@@ -1,12 +0,0 @@
-require:
-  - rubocop-performance
-
-inherit_from:
-  - https://raw.githubusercontent.com/RenoFi/rubocop/master/0.77.yml
-
-AllCops:
-  TargetRubyVersion: 2.5
-
-Naming/FileName:
-  Exclude:
-    - 'lib/*.rb'

data/.ruby-gemset

@@ -1 +0,0 @@
-graphql-pagination

data/.ruby-version

@@ -1 +0,0 @@
-2.6.5