graphql-pagination 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b902c58fce73cf2785b2f6a1938f9578c89e9b235c081a6e5c769f0c747acece
-  data.tar.gz: ee72aa64adb804a3a5458530cc426a3fd98a54d910eaa53cdccb088573ce9361
+  metadata.gz: ba2564755b00967af752c896752143dae2de5519edc1b3b4528ff653b1a30ef1
+  data.tar.gz: 469bb8190f417420ca82535b854b1dff1c039dea9a0fa5998f3f85df83ae7776
 SHA512:
-  metadata.gz: cef3d062eb3f7eaf42617fbe44fb4b33400df6ce03d60a6b10715e3a3066c780ad74482a2e78ec11dc382c1a415fb4c8bb96f9a6c02f1f85d89d48c49b36d940
-  data.tar.gz: 534eda25a1be3daab2259787696e1ea604d040cd8e8ade5883beea90d755acfe6246433742d19579d703bbcda14cc194dcc7b4e10717d1d53666db55cc0dc751
+  metadata.gz: 9517c649c9e976eee72e1144bed30c9bc7f4e5a0eae51822e063605d0a110a66d0706b156b0122a51abb81efa5cd548607de594624453ea9b0addf8e34876757
+  data.tar.gz: 5a3ef06d7912a19bc8c5382873898af974e5bc1f23a130d9cee04a70be2fdb84e58499954057d7ac58bc6d6e3a0ab09eb48311cd2e7d9cf63977dd763e6663dc

data/.bundler-version

@@ -1 +1 @@
-2.3.12
+2.3.22

data/.github/workflows/ci.yml

@@ -14,12 +14,9 @@ jobs:
         ruby-version: ['3.0', 3.1]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - 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@bd94d6a504586da892a5753afdd1480096ed30df
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    graphql-pagination (2.0.1)
+    graphql-pagination (2.1.0)
       graphql (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.2.4)
-      activesupport (= 7.0.2.4)
-    activerecord (7.0.2.4)
-      activemodel (= 7.0.2.4)
-      activesupport (= 7.0.2.4)
-    activesupport (7.0.2.4)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -21,24 +21,25 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    graphql (2.0.7)
-    i18n (1.10.0)
+    graphql (2.0.14)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
+    json (2.6.2)
     kaminari-activerecord (1.2.2)
       activerecord
       kaminari-core (= 1.2.2)
     kaminari-core (1.2.2)
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.16.3)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.3.1)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -46,32 +47,33 @@ GEM
       rspec-mocks (~> 3.11.0)
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.28.2)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.10.0)
-      rubocop (~> 1.19)
+    rubocop-rspec (2.13.2)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   aarch64-linux-musl
@@ -94,4 +96,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.3.12
+   2.3.24

data/README.md

@@ -73,6 +73,25 @@ Value returned by query resolver must be a kaminari object or implements its pag
 }
 ```
 
+## Custom Base
+
+By default the resulting collection_type class is a direct descendant of
+graphql-ruby's GraphQL::Schema::Object, however you may require your own
+behaviours and properties on the collection class itself such as defining
+[custom visibility](https://graphql-ruby.org/authorization/visibility.html#object-visibility).
+
+This can be done by passing in your own custom class, to be inherited from:
+
+```ruby
+class MyBaseType < GraphQL::Schema::Object
+  def self.visible?(context)
+    # ...
+  end
+end
+
+field :fruits, Types::FruitType.collection_type(collection_base: MyBaseType)
+```
+
 ## Custom Metadata
 
 By default, the following fields are present in the metadata block:

data/Rakefile

@@ -6,4 +6,4 @@ RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
 task ci: %i[spec rubocop]
-task default: %i[spec rubocop:auto_correct]
+task default: %i[spec rubocop:autocorrect_all]

data/lib/graphql_pagination/collection_base_error.rb

@@ -0,0 +1,8 @@
+module GraphqlPagination
+  class CollectionBaseError < StandardError
+    def message
+      "CollectionBaseError: The collection_type attribute must inherit from
+      or be a GraphQL::Schema::Object"
+    end
+  end
+end

data/lib/graphql_pagination/collection_type.rb

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

data/lib/graphql_pagination/version.rb

@@ -1,3 +1,3 @@
 module GraphqlPagination
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/lib/graphql_pagination.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-pagination
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -165,6 +165,7 @@ files:
 - graphql-pagination.gemspec
 - lib/graphql-pagination.rb
 - lib/graphql_pagination.rb
+- lib/graphql_pagination/collection_base_error.rb
 - lib/graphql_pagination/collection_metadata_type.rb
 - lib/graphql_pagination/collection_type.rb
 - lib/graphql_pagination/version.rb
@@ -190,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Page-based kaminari pagination for graphql.