graphql_rails 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f06459a3c8c16e40dffd181d7c08128558e2bdca598845b9e94f51852681e61
-  data.tar.gz: 1a4ddc9e11a4c5ef22240f7e36b3070bcf89b712c561cad12e41ede1dc18fbc3
+  metadata.gz: 47c75badc8873658f461e2bc0f6de0ca35f2c13c7ded2ed66b23b20ee91fc60e
+  data.tar.gz: 551a92383fad945d6fb8c03f190793431b485a8a98256a64e26f892c1e48fc2f
 SHA512:
-  metadata.gz: 23e0d160c19e3c56c00a474cb77eff10c6a86c3ce1c63f3cdb87f4c374f3c10da79b5f2529a14a026f81e6f3b2c32e9b2fecd671bd7b38066e07d020c65fa93a
-  data.tar.gz: a0ade6d1ce611baf97ab0a631770273c98953b04eb3991e3234c12a12f21e893962b62a1785ba5da48de7193c366129d29732c7121fbe6c4404d5e1f05cedda2
+  metadata.gz: 0e852e9c89ee080ca786abfaabea1162d8ed1eadb4086bf7d2f9908c454e56dc8c839ab05f6a3967859188f3c36f32eae1907b45e41476e24fb81f5fb5db8e29
+  data.tar.gz: 0d970a75c022b4635e6c925db92f8d7d22cc67b8e8e41ed8c961c98b2a8aa2c3b4726a29fc736af5151ea935c899b21d454e9af703e9beb6ea9fab378d5fecbf

data/.github/workflows/ruby.yml

@@ -3,14 +3,15 @@ on: [push, pull_request]
 jobs:
   specs:
     strategy:
+      fail-fast: false
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
 
     runs-on: ubuntu-latest
     env:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}

data/CHANGELOG.md

@@ -9,6 +9,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added/Changed/Deprecated/Removed/Fixed/Security: YOUR CHANGE HERE
 
+## [3.0.0](2024-05-31)
+
+* Added: `input.attribute.property` method which allows aliasing input parameter keys
+* Added: possibility to copy attribute config using the `Attribute#same_as` method
+* Fixed: do not ignore custom `max_page_size` for paginated responses
+* Fixed: do not ignore custom `default_page_size` and other options for paginated responses
+* Fixed: do not crash when using deeply nested input definitions
+* Added: `rescue_from` support in controllers
+* Added: Bumped graphql version to 2.1.7
+* Added: `implements` support in models
+* Added: `response.controller` and `response.action_name` methods in RSpecControllerHelpers
+* Removed: stop supporting ruby < 3.0.0
+
+## [2.4.0](2023-11-25)
+
+* Added: `hidden_in_groups` for attributes to be able to skip attribute from certain groups
+* Added: `extras` for attributes to be able to include graphql-ruby extensions
+* Added: `lookahead` as a controller request object field
+* Changed: `subscription` definition to `event` definition in router configuration page
+* Fixed: avoid "Found two visible definitions for X" issues for input types
+
 ## [2.3.0](2022-11-25)
 
 * Added support for Ruby 3.1.2, keyword arguments for decorators support included

data/Gemfile.lock

@@ -1,67 +1,67 @@
 PATH
   remote: .
   specs:
-    graphql_rails (2.3.0)
+    graphql_rails (3.0.0)
       activesupport (>= 4)
-      graphql (~> 1.12, >= 1.12.4)
+      graphql (= 2.1.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.4.4)
-      actionpack (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    actioncable (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.4.4)
-      actionpack (= 6.1.4.4)
-      activejob (= 6.1.4.4)
-      activerecord (= 6.1.4.4)
-      activestorage (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    actionmailbox (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activejob (= 6.1.7.1)
+      activerecord (= 6.1.7.1)
+      activestorage (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
       mail (>= 2.7.1)
-    actionmailer (6.1.4.4)
-      actionpack (= 6.1.4.4)
-      actionview (= 6.1.4.4)
-      activejob (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    actionmailer (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      actionview (= 6.1.7.1)
+      activejob (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.4.4)
-      actionview (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    actionpack (6.1.7.1)
+      actionview (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.4.4)
-      actionpack (= 6.1.4.4)
-      activerecord (= 6.1.4.4)
-      activestorage (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    actiontext (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activerecord (= 6.1.7.1)
+      activestorage (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
       nokogiri (>= 1.8.5)
-    actionview (6.1.4.4)
-      activesupport (= 6.1.4.4)
+    actionview (6.1.7.1)
+      activesupport (= 6.1.7.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.4.4)
-      activesupport (= 6.1.4.4)
+    activejob (6.1.7.1)
+      activesupport (= 6.1.7.1)
       globalid (>= 0.3.6)
-    activemodel (6.1.4.4)
-      activesupport (= 6.1.4.4)
-    activerecord (6.1.4.4)
-      activemodel (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
-    activestorage (6.1.4.4)
-      actionpack (= 6.1.4.4)
-      activejob (= 6.1.4.4)
-      activerecord (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
-      marcel (~> 1.0.0)
+    activemodel (6.1.7.1)
+      activesupport (= 6.1.7.1)
+    activerecord (6.1.7.1)
+      activemodel (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+    activestorage (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activejob (= 6.1.7.1)
+      activerecord (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
+      marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (6.1.4.4)
+    activesupport (6.1.7.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -74,17 +74,18 @@ GEM
     codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.3.1)
     crass (1.0.6)
     diff-lcs (1.5.0)
     docile (1.4.0)
     erubi (1.10.0)
-    globalid (1.0.0)
+    globalid (1.0.1)
       activesupport (>= 5.0)
-    graphql (1.13.17)
-    i18n (1.8.11)
+    graphql (2.1.7)
+      racc (~> 1.4)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.18.0)
+    loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -92,8 +93,8 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
-    minitest (5.15.0)
+    mini_portile2 (2.8.6)
+    minitest (5.23.1)
     mongo (2.17.0)
       bson (>= 4.8.2, < 5.0.0)
     mongoid (7.3.3)
@@ -101,8 +102,8 @@ GEM
       mongo (>= 2.10.5, < 3.0.0)
       ruby2_keywords (~> 0.0.5)
     nio4r (2.5.8)
-    nokogiri (1.13.9)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.16.5)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.21.0)
     parser (3.1.0.0)
@@ -113,40 +114,41 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    racc (1.6.0)
-    rack (2.2.3.1)
+    racc (1.8.0)
+    rack (2.2.9)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.4.4)
-      actioncable (= 6.1.4.4)
-      actionmailbox (= 6.1.4.4)
-      actionmailer (= 6.1.4.4)
-      actionpack (= 6.1.4.4)
-      actiontext (= 6.1.4.4)
-      actionview (= 6.1.4.4)
-      activejob (= 6.1.4.4)
-      activemodel (= 6.1.4.4)
-      activerecord (= 6.1.4.4)
-      activestorage (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    rails (6.1.7.1)
+      actioncable (= 6.1.7.1)
+      actionmailbox (= 6.1.7.1)
+      actionmailer (= 6.1.7.1)
+      actionpack (= 6.1.7.1)
+      actiontext (= 6.1.7.1)
+      actionview (= 6.1.7.1)
+      activejob (= 6.1.7.1)
+      activemodel (= 6.1.7.1)
+      activerecord (= 6.1.7.1)
+      activestorage (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
       bundler (>= 1.15.0)
-      railties (= 6.1.4.4)
+      railties (= 6.1.7.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (6.1.4.4)
-      actionpack (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    rails-html-sanitizer (1.4.4)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (6.1.7.1)
+      actionpack (= 6.1.7.1)
+      activesupport (= 6.1.7.1)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.2.0)
-    rexml (3.2.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -192,14 +194,15 @@ GEM
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
+    strscan (3.1.0)
     thor (1.2.1)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.5.3)
+    zeitwerk (2.6.15)
 
 PLATFORMS
   ruby

data/docs/README.md

@@ -92,7 +92,7 @@ class Graphql::UsersController < GraphqlApplicationController
 end
 ```
 
-See [Controller docs](components/controlle.md) for more info.
+See [Controller docs](components/controller.md) for more info.
 
 ## Testing your GraphqlRails::Controller in RSpec
 

data/docs/components/controller.md

@@ -194,7 +194,21 @@ class UsersController < GraphqlRails::Controller
   action(:index).paginated(max_page_size: 10) # add max items limit
 
   def index
-    User.all # it will render 10 users even you have more
+    User.all # it will render max 10 users even you have requested more
+  end
+end
+```
+
+#### *default_page_size*
+
+Allows to specify max items count per request
+
+```ruby
+class UsersController < GraphqlRails::Controller
+  action(:index).paginated(default_page_size: 5) # add default items per page size
+
+  def index
+    User.all # it will render 5 users even you have more
   end
 end
 ```

data/docs/components/model.md

@@ -101,7 +101,7 @@ Check [graphql-ruby documentation](https://graphql-ruby.org) for more details ab
 
 ### attribute.property
 
-By default graphql attribute names are expected to be same as model methods/attributes, but if you want to use different name on grapqhl side, you can use `property` option:
+By default graphql attribute names are expected to be same as model methods/attributes, but if you want to use different name on graphql side, you can use `property` option:
 
 ```ruby
 class User
@@ -185,6 +185,24 @@ class User
 end
 ```
 
+### attribute.hidden_in_groups
+
+Opposite for Attribute#groups. It hides attribute in given groups
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql do |c|
+    # visible in all schemas (default):
+    c.attribute(:email)
+
+    # visible in all schemas except "external":
+    c.attribute(:nickname).hidden_in_groups(:external)
+  end
+end
+```
+
 ### attribute.options
 
 Allows passing options to attribute definition. Available options:
@@ -200,6 +218,21 @@ class User
     c.attribute :first_name, options: { attribute_name_format: :original } # will be accessible as first_name from client side
   end
 end
+```
+
+### attribute.extras
+
+Allows passing extras to enable [graphql-ruby field extensions](https://graphql-ruby.org/type_definitions/field_extensions.html#using-extras)
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql do |c|
+    c.attribute(:items).extras([:lookahead])
+  end
+end
+```
 
 ### attribute.permit
 
@@ -303,7 +336,7 @@ You can mark collection method as `paginated`. In this case method will return r
 class User
   include GraphqlRails::Model
 
-  graphql.attribute :items, type: '[Item]', paginatted: true
+  graphql.attribute :items, type: '[Item]', paginated: true
 
   def items
     Item.all
@@ -335,6 +368,21 @@ class User
 end
 ```
 
+### attribute.same_as
+
+When you want to have identical attributes, you can use `Attribute#same_as` to make sure that attribute params will stay in sync:
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql do |c|
+    c.attribute(:user_id).type('ID').description('User ID')
+    c.attribute(:person_id).same_as(c.attribute(:user_id))
+  end
+end
+```
+
 ### attribute.with
 
 When you want to define some options dynamically, it's quite handy to use "Attribute#with" method:
@@ -388,7 +436,7 @@ end
 
 ## name
 
-By default grapqhl type name will be same as model name, but you can change it via `name` method
+By default graphql type name will be same as model name, but you can change it via `name` method
 
 ```ruby
 class User
@@ -402,7 +450,7 @@ end
 
 ## description
 
-To improve grapqhl documentation, you can description for your graphql type:
+To improve graphql documentation, you can description for your graphql type:
 
 ```ruby
 class User
@@ -414,12 +462,36 @@ class User
 end
 ```
 
+## implements
+
+`implements` indicates that graphql type implements one or more interfaces:
+
+```ruby
+module UserInterface
+  include GraphQL::Schema::Interface
+  # ....
+end
+
+module AdvancedUserInterface
+  include GraphQL::Schema::Interface
+  # ...
+end
+
+class AdminUser
+  include GraphqlRails::Model
+
+  graphql do |c|
+    c.implements(UserInterface, AdvancedUserInterface)
+  end
+end
+```
+
 ## graphql_type
 
 Sometimes it's handy to get raw graphql type. To do so you can call:
 
 ```ruby
-YourModel.graphql.grapqhl_type
+YourModel.graphql.graphql_type
 ```
 
 ## input
@@ -555,7 +627,6 @@ class User
 end
 ```
 
-
 #### input attribute deprecation
 
 You can mark input attribute as deprecated with `deprecated` method:
@@ -585,6 +656,59 @@ class User
 end
 ```
 
+#### input attribute config copy
+
+You can copy existing config from other attribute using `Attribute#same_as` method:
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql.input(:create) do |c|
+    c.attribute(:first_name).type('String!')
+    c.attribute(:last_name).type('String!')
+  end
+
+  graphql.input(:update) do |c|
+    c.attribute(:id).type('ID!')
+    graphql.input(:contract).attributes.each_value do |attr|
+      c.attribute(attr.name).same_as(attr)
+    end
+  end
+end
+```
+
+#### input attribute property
+
+Sometimes it's handy to have different input attribute on graphql level and different on controller. That's when `Attribute#property` comes to the rescue:
+
+```ruby
+class Post
+  include GraphqlRails::Model
+
+  graphql.input do |c|
+    c.attribute(:author_id).type('ID').property(:user_id)
+  end
+end
+```
+
+Then mutation such as:
+
+```gql
+mutation createPost(input: { authorId: 123 }) {
+  author
+}
+```
+
+Will pass `user_id` instead of `authorId` in controller:
+
+```ruby
+# posts_controller.rb
+def create
+  Post.create!(user_id: params[:input][:user_id])
+end
+```
+
 ## graphql_context
 
 It's possible to access graphql_context in your model using method `graphql_context`:

data/docs/components/routes.md

@@ -21,10 +21,10 @@ MyGraphqlSchema = GraphqlRails::Router.draw do
 
   # you can use namespaced controllers too:
   scope module: 'admin' do
-    # `updateTranslations` route will be handeled by `Admin::TranslationsController`
+    # `updateTranslations` route will be handled by `Admin::TranslationsController`
     mutation :updateTranslations, to: 'translations#update'
 
-    # all :groups routes will be handeled by `Admin::GroupsController`
+    # all :groups routes will be handled by `Admin::GroupsController`
     resources :groups
   end
 end
@@ -40,9 +40,9 @@ If you want to exclude some actions you can use `only` or `except` options.
 
 ```ruby
 MyGraphqlSchema = GraphqlRails::Router.draw do
-  resouces :users
-  resouces :friends, only: :index
-  resouces :posts, except: [:destroy, :index]
+  resources :users
+  resources :friends, only: :index
+  resources :posts, except: [:destroy, :index]
 end
 ```
 
@@ -52,7 +52,7 @@ Sometimes it's handy so have non-CRUD actions in your controller. To define such
 
 ```ruby
 MyGraphqlSchema = GraphqlRails::Router.draw do
-  resouces :users do
+  resources :users do
     mutation :changePassword, on: :member
     query :active, on: :collection
   end
@@ -65,7 +65,7 @@ Sometimes, especially when working with member queries, it sounds better when ac
 
 ```ruby
 MyGraphqlSchema = GraphqlRails::Router.draw do
-  resouces :users do
+  resources :users do
     query :details, on: :member, suffix: true
   end
 end
@@ -73,15 +73,25 @@ end
 
 This will generate `userDetails` field on GraphQL side.
 
-## _query_ and _mutation_ & _subscription_
+## _query_ and _mutation_ & _event_
+
+In case you want to have non-CRUD controller with custom actions you can define your own `query`/`mutation` actions like this:
+
+```ruby
+MyGraphqlSchema = GraphqlRails::Router.draw do
+  mutation :logIn, to: 'sessions#login'
+  query :me, to: 'users#current_user'
+end
 
-in case you want to have non-CRUD controller with custom actions you can define your own `query`/`mutation`/`subscription` actions like this:
+Subscriptions are not really controller actions with a single response type, thus, they're defined differently. In GraphQL you subscribe to event, for example `userCreated`. To do this in graphql_rails you would define `event :user_created` in router definition.
 
 ```ruby
 MyGraphqlSchema = GraphqlRails::Router.draw do
   mutation :logIn, to: 'sessions#login'
   query :me, to: 'users#current_user'
-  subscribtion :new_message, to: 'messages#created'
+
+  event :user_created # expects Subscriptions::UserCreatedSubscription class to be present
+  event :user_deleted, subscription_class: 'Subscriptions::UserDeletedSubscription'
 end
 ```
 

data/graphql_rails.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'graphql', '~> 1.12', '>= 1.12.4'
+  spec.add_dependency 'graphql', '2.1.7'
   spec.add_dependency 'activesupport', '>= 4'
 
   spec.add_development_dependency 'bundler', '~> 2'

data/lib/generators/graphql_rails/templates/graphql_controller.erb

@@ -12,7 +12,7 @@ class GraphqlController < ApplicationController
 
   private
 
-  # data defined here will be accessible via `grapqhl_request.context`
+  # data defined here will be accessible via `graphql_request.context`
   # in GraphqlRails::Controller instances
   def graphql_context
     {}

data/lib/graphql_rails/attributes/attributable.rb

@@ -8,6 +8,12 @@ module GraphqlRails
     # contains methods which are shared between various attribute-like classes
     # expects `initial_name` and `type` to be defined
     module Attributable
+      def initialize_copy(_original)
+        super
+        @attribute_name_parser = nil
+        @type_parser = nil
+      end
+
       def field_name
         attribute_name_parser.field_name
       end