graphql_rails 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd5007444af16b72661bd4c9ad03866017b9fbbaadbd4a4bccc5c788c73f95bf
-  data.tar.gz: 884390854d3490c9b323f82c527b922a087a0617a1a862fb5cbcd3d18f31e955
+  metadata.gz: 9f06459a3c8c16e40dffd181d7c08128558e2bdca598845b9e94f51852681e61
+  data.tar.gz: 1a4ddc9e11a4c5ef22240f7e36b3070bcf89b712c561cad12e41ede1dc18fbc3
 SHA512:
-  metadata.gz: dcc498d22901bfecb649f44b266634ed762d119d0c4d876df04fbe5ae595173e61c3fe53078ea1803000fd5ec6faaa8686e1198aa2037ae6f09b91bf4e20b001
-  data.tar.gz: 58a8ae501e143744082ca85ac0dba51bdcf5883fa949b25d23fd4c5510c28b877c4f5ca9cbc7f0af5d6d19b7c742fa835fa4b6d7afc1ccaaca0b83c153e9aeb9
+  metadata.gz: 23e0d160c19e3c56c00a474cb77eff10c6a86c3ce1c63f3cdb87f4c374f3c10da79b5f2529a14a026f81e6f3b2c32e9b2fecd671bd7b38066e07d020c65fa93a
+  data.tar.gz: a0ade6d1ce611baf97ab0a631770273c98953b04eb3991e3234c12a12f21e893962b62a1785ba5da48de7193c366129d29732c7121fbe6c4404d5e1f05cedda2

data/.github/workflows/ruby.yml

@@ -4,7 +4,7 @@ jobs:
   specs:
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0', '3.1']
 
     runs-on: ubuntu-latest
     env:

data/.ruby-version

@@ -1 +1 @@
-3.0.1
+3.1.2

data/CHANGELOG.md

@@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added/Changed/Deprecated/Removed/Fixed/Security: YOUR CHANGE HERE
 
+## [2.3.0](2022-11-25)
+
+* Added support for Ruby 3.1.2, keyword arguments for decorators support included
+* Added: error backtrace to SystemError
+* Fixed: skip "base" field name in validation error messages
+* Added: router namespaces and named scopes
+* Added: `deprecate` method/option for attributes and input attributes
+
+## [2.2.0](2022-01-25)
+
+* Added: support for subscription type
+* Fixed: correctly detect all graphql-ruby objects when using stringified types
+* Added: make code compatible with newer graphql-ruby version
+
 ## [2.1.0](2022-01-12)
 
 * Added: decorated relations now can be called using "find", "empty?" and "find_by" methods

data/Gemfile.lock

@@ -1,112 +1,111 @@
 PATH
   remote: .
   specs:
-    graphql_rails (2.1.0)
+    graphql_rails (2.3.0)
       activesupport (>= 4)
       graphql (~> 1.12, >= 1.12.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.4)
-      actionpack (= 6.0.3.4)
+    actioncable (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    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)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
+    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)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.4.4)
+      actionview (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
+      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.0.3.4)
-      actionpack (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    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)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionview (6.1.4.4)
+      activesupport (= 6.1.4.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activejob (6.1.4.4)
+      activesupport (= 6.1.4.4)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activestorage (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.4)
+    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)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
-    bson (4.11.0)
+    bson (4.14.0)
     builder (3.2.4)
     byebug (11.1.3)
-    codecov (0.2.12)
-      json
-      simplecov
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    erubi (1.9.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    graphql (1.13.4)
-    i18n (1.8.5)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    graphql (1.13.17)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    json (2.3.1)
-    loofah (2.7.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mimemagic (0.3.10)
-      nokogiri (~> 1)
-      rake
-    mini_mime (1.0.2)
-    mini_portile2 (2.6.1)
-    minitest (5.14.2)
-    mongo (2.13.1)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    mongo (2.17.0)
       bson (>= 4.8.2, < 5.0.0)
-    mongoid (7.1.4)
-      activemodel (>= 5.1, < 6.1)
-      mongo (>= 2.7.0, < 3.0.0)
-    nio4r (2.5.4)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    mongoid (7.3.3)
+      activemodel (>= 5.1, < 6.2)
+      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)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -114,53 +113,53 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    racc (1.5.2)
-    rack (2.2.3)
+    racc (1.6.0)
+    rack (2.2.3.1)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.4)
-      actioncable (= 6.0.3.4)
-      actionmailbox (= 6.0.3.4)
-      actionmailer (= 6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actiontext (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      bundler (>= 1.3.0)
-      railties (= 6.0.3.4)
+    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)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    railties (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (2.1.1)
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
     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.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+    rspec-support (3.10.3)
     rubocop (1.5.2)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -170,35 +169,37 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.5.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.8.1)
-      rubocop (>= 0.87.0)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.3.0)
+    rubocop-rspec (2.4.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.19.1)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    websocket-driver (0.7.3)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      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.4.1)
+    zeitwerk (2.5.3)
 
 PLATFORMS
   ruby

data/docs/README.md

@@ -42,11 +42,12 @@ GraphqlRails::Router.draw do
   resources :users
 
   # if you want custom queries or mutation
-  query 'searchLogs', to: 'logs#search' # redirects request to LogsController
-  mutation 'changeUserPassword', to: 'users#change_password'
+  query 'searchLogs', to: 'logs#search' # action is handled by LogsController#search
 end
 ```
 
+See [Routes docs](components/routes.md) for more info.
+
 ### Define your Graphql model
 
 ```ruby
@@ -56,67 +57,42 @@ class User # works with any class including ActiveRecord
 
   graphql do |c|
     # most common attributes, like :id, :name, :title has default type, so you don't have to specify it (but you can!)
-    c.attribute :id
+    c.attribute(:id)
 
-    c.attribute :email, type: :string
-    c.attribute :surname, type: :string
+    c.attribute(:email).type('String')
+    c.attribute(:surname).type('String')
   end
 end
 ```
 
+See [Model docs](components/model.md) for more info.
+
 ### Define controller
 
 ```ruby
 # app/controllers/graphql/users_controller.rb
 class Graphql::UsersController < GraphqlApplicationController
-  # graphql requires to describe which attributes controller action accepts and which returns
-  action(:change_user_password)
-    .permit(:password!, :id!) # Bang (!) indicates that attribute is required
-    .returns('User!')
+  model('User') # specify that all actions returns User by default
 
-  def change_user_password
-    user = User.find(params[:id])
-    user.update!(password: params[:password])
+  # DRUD actions description
+  action(:index).permit(id: 'ID!').returns_many
+  action(:show).permit(id: 'ID!').returns_single
+  action(:create).permit(email: 'String!').returns_single
+  action(:update).permit(id: 'ID!', email: 'String!').returns_single
+  action(:destroy).permit(id: 'ID!').returns_single
 
-    # returned value needs to have all methods defined in model `graphql do` part
-    user # or SomeDecorator.new(user)
+  def index
+    User.all
   end
 
-  action(:search)
-    .permit(search_fields!: SearchFieldsInput) # you can specify your own input fields
-    .returns('[User!]!')
-  def search
+  def show
+    User.find(params[:id])
   end
+  # ... code for create / update / destroy is skipped ...
 end
 ```
 
-## Routes
-
-```ruby
-GraphqlRails::Router.draw do
-  # generates `friend`, `createFriend`, `updateFriend`, `destroyFriend`, `friends` routes
-  resources :friends
-  resources :shops, only: [:show, :index] # generates `shop` and `shops` routes only
-  resources :orders, except: :update # generates all routes except `updateOrder`
-
-  resources :users do
-    # generates `findUser` query
-    query :find, on: :member
-
-    # generates `searchUsers` query
-    query :search, on: :collection
-  end
-
-  # you can use namespaced controllers too:
-  scope module: 'admin' do
-    # `updateTranslations` route will be handled by `Admin::TranslationsController`
-    mutation :updateTranslations, to: 'translations#update'
-
-    # all :groups routes will be handled by `Admin::GroupsController`
-    resources :groups
-  end
-end
-```
+See [Controller docs](components/controlle.md) for more info.
 
 ## Testing your GraphqlRails::Controller in RSpec
 
@@ -134,6 +110,8 @@ RSpec.configure do |config|
 end
 ```
 
+See [Testing docs](testing/testing.md) for more info.
+
 ### Helper methods
 
 There are 3 helper methods:

data/docs/_sidebar.md

@@ -1,7 +1,6 @@
 * [Home](README)
 * Getting started
   * [Setup](getting_started/setup)
-  * [Quick start](getting_started/quick_start)
 * Components
   * [Routes](components/routes)
   * [Model](components/model)

data/docs/components/controller.md

@@ -144,7 +144,7 @@ end
 If you do not specify `subtype` then default (without name) input will be used. You need to specify subtype if you want to use non-default input:
 
 ```ruby
-class OrderController < GraphqlRails::Controller
+class UsersController < GraphqlRails::Controller
   # this is the input with email and full_name:
   action(:create)
     .permit_input(:input, type: 'User!')
@@ -155,6 +155,20 @@ class OrderController < GraphqlRails::Controller
 end
 ```
 
+#### *deprecated*
+
+You can mark input input as deprecated with `deprecated` option:
+
+```ruby
+class UsersController < GraphqlRails::Controller
+  action(:create)
+    .permit_input(:input, type: 'User', deprecated: true)
+
+  action(:update)
+    .permit_input(:input, type: 'User', deprecated: 'use updateBasicUser instead')
+end
+```
+
 ### *paginated*
 
 You can mark collection action as `paginated`. In this case controller will return relay connection type and it will be possible to return only partial results. No need to do anything on controller side (you should always return full list of items)

data/docs/components/decorator.md

@@ -46,7 +46,7 @@ class UserDecorator < SimpleDelegator
   include GraphqlRails::Model
   include GraphqlRails::Decorator
 
-  graphql_rails do
+  graphql do |c|
     # some setup, attributes, etc...
   end
 

data/docs/components/model.md

@@ -131,6 +131,21 @@ class User
 end
 ```
 
+### attribute.deprecated
+
+Attribute can be marked as deprecated with `deprecated` method:
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql do |c|
+    c.attribute(:legacy_name).deprecated
+    c.attribute(:legacy_id).deprecated('This is my custom deprecation reason')
+  end
+end
+```
+
 ### attribute.groups
 
 Groups are handy feature when you want to have multiple schemas. For example, you want to have public graphql endpoint and internal graphql endpoint where each group has some unique nodes. If attribute has `groups` set, then this attribute will be visible only in appropriate group schemas.
@@ -263,6 +278,23 @@ class User
 end
 ```
 
+#### *deprecated*
+
+You can mark input input as deprecated with `deprecated` option:
+
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql.attribute(:avatar_url)
+         .permit_input(:size, type: :int!, deprecated: true)
+
+  graphql.attribute(:logo_url)
+         .permit_input(:size, type: :int!, deprecated: 'custom image size is deprecated')
+end
+```
+
 ### attribute.paginated
 
 You can mark collection method as `paginated`. In this case method will return relay connection type and it will be possible to return only partial results. No need to do anything on method side (you should always return full list of items)
@@ -523,6 +555,36 @@ class User
 end
 ```
 
+
+#### input attribute deprecation
+
+You can mark input attribute as deprecated with `deprecated` method:
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql.input do |c|
+    c.attribute(:full_name).deprecated('Use firstName and lastName instead')
+    c.attribute(:surname).deprecated
+  end
+end
+```
+
+#### input attribute default value
+
+You can set default value for input attribute:
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql.input do |c|
+    c.attribute(:is_admin).type('Boolean').default_value(false)
+  end
+end
+```
+
 ## graphql_context
 
 It's possible to access graphql_context in your model using method `graphql_context`: