graphql-pagination 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ea955b90a7643f1fbbe2ec88c466e1417b7f9f9d0aecae8c86e3072ea787b26
-  data.tar.gz: 005f943ce8ca3788992052752f1a5e616f0a502640054e46d6f051347048b6c1
+  metadata.gz: ac8eec73e3f4bf23e60cf8cca10cee6066b1f72ba02b4abfe62a5d64a1973b84
+  data.tar.gz: d5128484c2d064e47d06a36d3b46404361f2f85873442222882b62c376421363
 SHA512:
-  metadata.gz: 6aaa55de384cc91b9e31069e5c3bc2e9970081ba6c04fd95df5dad2ebe391a72d7f050bbb518ebab3b9525a2260eeb931805759d73bb1c705e7c4e6a1043c74f
-  data.tar.gz: 5904d27c1e2c34aec87cecee6770c0187508f25851e8f0f4e2c1ad87c22593427d54d9a76bd5c425a1f088d8430ec332ad630a6724b6b17e9c02070b3e62cbec
+  metadata.gz: e48de20398166c2632c8751978882ec75db86714b2703667886da512813b5c027cdb8ee5e0179229a3a2e2e10a887b683abf4365a6477b441d1586660f9459df
+  data.tar.gz: 9006adcb4177edd4fbe1d1f2f03e2778f87faf920ac9ce8caf9e57b1265859cde04677ce9c163c2d68e421dea5f8c43af45695e469ac22af553961c846f6f68f

data/.bundler-version

@@ -0,0 +1 @@
+2.2.23

data/.dependabot/config.yml

@@ -3,16 +3,14 @@ version: 1
 update_configs:
   - package_manager: "ruby:bundler"
     directory: "/"
-    update_schedule: "monthly"
+    update_schedule: "daily"
     commit_message:
       prefix: "[dependabot]"
     allowed_updates:
       - match:
-          update_type: "all"
+          dependency_type: "all"
+          update_type: "security"
     automerged_updates:
       - match:
-          dependency_type: "development"
-          update_type: "all"
-      - match:
-          dependency_type: "production"
-          update_type: "all"
+          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,6 @@
+## Description, motivation and context
+<!--- Describe your changes in detail -->
+<!--- Why is this change required? What problem does it solve? -->
+
+## Related issue(s) or PR(s)
+<!--- GH issue number -->

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/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Run tests
+      run: bundle exec rake ci

data/Gemfile.lock

@@ -1,80 +1,85 @@
 PATH
   remote: .
   specs:
-    graphql-pagination (1.1.0)
-      graphql (~> 1.9)
+    graphql-pagination (1.2.0)
+      graphql (~> 1.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.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.6)
-    diff-lcs (1.3)
-    graphql (1.10.3)
-    i18n (1.8.2)
+      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.2.0)
+    kaminari-activerecord (1.2.1)
       activerecord
-      kaminari-core (= 1.2.0)
-    kaminari-core (1.2.0)
-    method_source (0.9.2)
-    minitest (5.14.0)
-    parallel (1.19.1)
-    parser (2.7.0.3)
-      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)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    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.1)
+      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.2)
-    rubocop (0.80.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.7.0.1)
+      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.2)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.38.1)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    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!
@@ -84,8 +89,8 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
+  rubocop-rake
   rubocop-rspec
 
 BUNDLED WITH
-   2.0.2
+   2.2.23

data/README.md

@@ -22,17 +22,16 @@ Add `graphql-pagination` to your Gemfile, you can use `kaminari-activerecord` or
     argument :limit, Integer, required: false
   end
 
-  def fruit(page: nil, limit: nil)
+  def fruits(page: nil, limit: nil)
     ::Fruit.page(page).per(limit)
   end
 ```
 
 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

@@ -5,4 +5,5 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: %i[rubocop spec]
+task ci: %i[spec rubocop]
+task default: %i[spec rubocop:auto_correct]

data/graphql-pagination.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_dependency 'graphql', '~> 1.9'
+  spec.add_dependency 'graphql', '~> 1.12'
 
   spec.add_development_dependency 'kaminari-activerecord'
   spec.add_development_dependency 'kaminari-core'
@@ -33,6 +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_type.rb

@@ -1,7 +1,8 @@
 module GraphqlPagination
   module CollectionType
     def collection_type(metadata_type: GraphqlPagination::CollectionMetadataType)
-      @collection_type ||= begin
+      @collection_types ||= {}
+      @collection_types[metadata_type] ||= begin
         type_name = "#{graphql_name}Collection"
         source_type = self
 

data/lib/graphql_pagination/version.rb

@@ -1,3 +1,3 @@
 module GraphqlPagination
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: graphql-pagination
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Krzysztof Knapik
 - RenoFi Engineering Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2021-07-15 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'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: kaminari-activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,10 +146,17 @@ 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"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -167,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
@@ -175,15 +182,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 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.23
+signing_key:
 specification_version: 4
 summary: Page-based kaminari pagination for graphql.
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6
-before_install: gem install bundler
-script:
-  - bundle exec rake spec
-  - bundle exec rake rubocop