graphql-pagination 0.2.2 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5126cd4efa227e900819533d8174c3f5f79796155c89400aefd6fa4a62b097bf
-  data.tar.gz: a9161702e52430cc5486245c647dfe82c4c741372557e5709d06a93783f7e2ce
+  metadata.gz: d7ce3ca921537d2ba59ab369f8b13ef3589c795a071f229f26638de2b8c2e0e9
+  data.tar.gz: 5251b02d2ded1d15fcc83decdcc66a01f653145037306a4d8f1d797a8774cf7b
 SHA512:
-  metadata.gz: 76d3e6b848b1ce9a3072812c692b6e9c395c0b80c0c6d60a853c4721f976a07b83f9d9b0204de9056926b13e8b114b8164a869d9555636b61d971f5f9f1d9403
-  data.tar.gz: 5b789bad2cea40103da4fe25a9cd7ab24caf6d73e3ebd6167e52aba5f78c9f725fa067b2fea089ff0e02084cc01af1d2b20bbb87ce22438e121ee62998e10d73
+  metadata.gz: d2a37bdf12b318733d60f7fc3c55cfd7ba41891fb9ecda2e0eadb8c1d639b9d43182967f03bb357bf787499f4e0d534e58e2907e4800a7dc7fda72de2f10413f
+  data.tar.gz: 859d828658d4e02f4680762157280b0a9925557e9b862048a3dd06d8060a42fa5fbca380b180a35b65b08a8fd4fafe11b8f2b5772a464100ab9c7fd65faed65a

data/.dependabot/config.yml

@@ -0,0 +1,11 @@
+version: 1
+
+update_configs:
+  - package_manager: "ruby:bundler"
+    directory: "/"
+    update_schedule: "monthly"
+    commit_message:
+      prefix: "[dependabot]"
+    allowed_updates:
+      - match:
+          update_type: "all"

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
+# this will allow Dependabot to automatically merge dependency update PRs where CI passes
+# from: https://github.com/hmarr/auto-approve-action
+name: Auto approve Dependabot 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]'
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Cached rubocop config files
+.rubocop-http*

data/.travis.yml

@@ -3,7 +3,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-before_install: gem install bundler -v 2.0.1
+  - 2.6
+  - 2.7
+before_install: gem install bundler
+script:
+  - bundle exec rake spec
+  - bundle exec rake rubocop

data/Gemfile.lock

@@ -1,71 +1,80 @@
 PATH
   remote: .
   specs:
-    graphql-pagination (0.2.2)
-      graphql (~> 1.9.4)
+    graphql-pagination (1.1.2)
+      graphql (~> 1.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activesupport (5.2.3)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    graphql (1.9.6)
-    i18n (1.6.0)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    graphql (1.11.4)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
-    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.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.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.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.1)
+    regexp_parser (1.7.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.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.71.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.90.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -78,6 +87,8 @@ DEPENDENCIES
   rake
   rspec
   rubocop
+  rubocop-performance
+  rubocop-rspec
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

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 {
@@ -51,29 +50,52 @@ 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,27 +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{^(test|spec|features)/}) }
+    `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.add_dependency 'graphql', '~> 1.9.4'
+  spec.required_ruby_version = '>= 2.6'
+
+  spec.add_dependency 'graphql', '~> 1.9'
 
   spec.add_development_dependency 'kaminari-activerecord'
   spec.add_development_dependency 'kaminari-core'
@@ -31,4 +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-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,6 +1,6 @@
 module GraphqlPagination
   module CollectionType
-    def collection_type
+    def collection_type(metadata_type: GraphqlPagination::CollectionMetadataType)
       @collection_type ||= begin
         type_name = "#{graphql_name}Collection"
         source_type = self
@@ -8,7 +8,7 @@ module GraphqlPagination
         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.2'.freeze
+  VERSION = '1.1.2'.freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: graphql-pagination
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.1.2
 platform: ruby
 authors:
 - Krzysztof Knapik
 - RenoFi Engineering Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2020-09-02 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.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.4
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: kaminari-activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Page-based kaminari pagination for graphql returning collection and pagination
   metadata.
 email:
@@ -118,20 +146,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".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"
 - ".gitignore"
-- ".hound.yml"
 - ".rspec"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - graphql-pagination.gemspec
 - lib/graphql-pagination.rb
 - lib/graphql_pagination.rb
@@ -144,7 +172,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
@@ -152,15 +180,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Page-based kaminari pagination for graphql.
 test_files: []

data/.hound.yml

@@ -1,4 +0,0 @@
-fail_on_violations: true
-
-rubocop:
-  config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,62 +0,0 @@
-Gemspec/RequiredRubyVersion:
-  Include:
-    - 2.4
-    - 2.5
-    - 2.6
-
-Lint/UnusedBlockArgument:
-  Enabled: false
-
-Layout/AlignHash:
-  Enabled: false
-
-Naming/FileName:
-  Enabled: false
-
-Metrics/BlockLength:
-  Max: 30
-  Exclude:
-    - '**/*_spec.rb'
-
-Metrics/LineLength:
-  Max: 140
-
-Metrics/MethodLength:
-  Max: 20
-
-Security/YAMLLoad:
-  Enabled: false
-
-Style/BlockDelimiters:
-  EnforcedStyle: braces_for_chaining
-
-Style/Documentation:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/EachWithObject:
-  Enabled: false
-
-Style/MethodMissingSuper:
-  Enabled: false
-
-Style/MissingRespondToMissing:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/RescueStandardError:
-  Exclude:
-    - 'spec/*.rb'
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Style/TrivialAccessors:
-  Enabled: false

data/.ruby-gemset

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

data/.ruby-version

@@ -1 +0,0 @@
-2.6.3

data/bin/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'rack_graphql'
-require 'pry'
-require 'irb'
-
-IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install