graphql_rails 0.5.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d31436f40d036cd543c69a2b59e442d2498eb6349d61c4454dc9376e0caf4de0
-  data.tar.gz: 9b5041b648314fbff349e614e9b1f6be43f94bff32490f8de0dc4a23bb28c6a7
+  metadata.gz: 60ad653d6c6acbfe0816f0b7ddb406dae7131b1c07f86f7ab35b98813079edb1
+  data.tar.gz: ff9446c8240615d5cba3e6ac3206444d47d257d201278e0860d765976c8f99fc
 SHA512:
-  metadata.gz: 72d4881a3aa604c19f38f53e4b77fdea562e7b804d8cec6a125789da32b6b215c298f5dcd1a747680a72c2e65571d0f30ab7b47597758fbb632bf21731f9bf70
-  data.tar.gz: 0a7ec0c5d6bf383c89b82109a4c120137e470f7e187ab8a3ab791840706abd6b0a49933b1bcead76437603fff546fc66ebd024fad8067bea6558d60499c587b0
+  metadata.gz: 59caf8be61dcf8777a5cdc2ac498f389006e8630b9ef62076976a0be849e8e09466e8a7b76891bf6a5b42510f5efc0856666383e9bd6e3e68c245500fb308d47
+  data.tar.gz: 9851cb4dd601fa253c5790f39cbdf835403e08814c85db9f0646bd986ccb62650249216b2225f20dfa8ada581e0bd374e3eb30001dc51f2eb7a182d9c2f626c6

data/.hound.yml

@@ -1,3 +1,4 @@
 rubocop:
   config_file: .rubocop.yml
+  version: 0.91.0
 fail_on_violations: true

data/.rubocop.yml

@@ -3,7 +3,7 @@ require: rubocop-rspec
 RSpec/NestedGroups:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: true
   Max: 120
 
@@ -21,7 +21,7 @@ Lint/AmbiguousBlockAssociation:
   Exclude:
     - spec/**/*.rb
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     - 'to'
     - 'at'
@@ -35,7 +35,7 @@ Style/ClassAndModuleChildren:
     - spec/**/*_spec.rb
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   Exclude:
     - bin/*
     - graphql_rails.gemspec

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.7.1

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -9,6 +9,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added/Changed/Deprecated/Removed/Fixed/Security: YOUR CHANGE HERE
 
+* Added: `options` argument to model level attribute. Allows disabling automatic camelCase
+* Fixed: methods with complex input arguments receives `Hash` instances instead of `GraphQL::Schema::InputObject`
+
+## [1.0.0](2020-02-07)
+
+* Added: "required" and "optional" flags for attribute
+* Added: grouped routes
+* Added: added argument to model.attribute
+* Added: added graphql_context to model
+* Removed: `action.can_return_nil` was removed, because it does no affect anymore
+* Removed: default `action` model was removed. Now each action must have `returns` part
+* Added: default router added. No need to assign value to constant on Router.draw
+* Added: default action added. Now actions can have custom defaults
+* Added: default controller model added. Now actions can be defined in more dynamic way
+* Added: install generator. Now it's possible to generate boilerplate code
+
+## [0.8.0] (2019-09-03)
+
+* Added: permit_input action config with extended list of permitted input options
+* Added: model decorators
+* Added: controller action instrumentation [@povilasjurcys](https://github.com/povilasjurcys)
+* Added: sentry and lograge integrations
+* Added: required: true flag for permitted attributes, inputs and model attributes
+
+## 0.7.0 (2019-05-15)
+
+* Added: input type now accepts `enum` param which allows create enum fields
+* Added: routes now accepts `suffix: true` flag which generates GraphQL field with appended action name to the end of resource name
+
+## 0.6.0 (2019-04-29)
+
+* Breaking change: controller params are always underscored [@povilasjurcys](https://github.com/povilasjurcys).
+* Breaking change: cursor in paginated responses has plain index value by default [@povilasjurcys](https://github.com/povilasjurcys).
+* Fixed: do not crash when testing paginated actions [@povilasjurcys](https://github.com/povilasjurcys).
+
 ## 0.5.2 (2019-04-24)
 
 * Fixed: do not crash when using Connection types in non Ruby on Rails project [@povilasjurcys](https://github.com/povilasjurcys).

data/Gemfile

@@ -5,8 +5,9 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 group :development do
-  gem 'rubocop'
-  gem 'rubocop-rspec'
+  gem 'rubocop', '0.91.0'
+  gem 'rubocop-performance', '~> 1.8', '>= 1.8.1'
+  gem 'rubocop-rspec', '~> 1.44', '>= 1.44.1'
 end
 
 group :test do

data/Gemfile.lock

@@ -1,110 +1,218 @@
 PATH
   remote: .
   specs:
-    graphql_rails (0.5.2)
+    graphql_rails (1.1.0)
       activesupport (>= 4)
-      graphql (~> 1)
+      graphql (~> 1.11, >= 1.11.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.2.1)
-      activesupport (= 5.2.2.1)
-    activerecord (5.2.2.1)
-      activemodel (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
-      arel (>= 9.0)
-    activesupport (5.2.2.1)
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.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)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.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)
+      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)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.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)
+      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)
       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)
-    bson (4.4.2)
-    byebug (11.0.1)
-    codecov (0.1.14)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    bson (4.11.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    codecov (0.2.12)
       json
       simplecov
-      url
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    graphql (1.9.4)
-    i18n (1.6.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    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.11.6)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
-    json (2.2.0)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    mongo (2.8.0)
-      bson (>= 4.4.2, < 5.0.0)
-    mongoid (7.0.2)
-      activemodel (>= 5.1, < 6.0.0)
-      mongo (>= 2.5.1, < 3.0.0)
-    parallel (1.16.0)
-    parser (2.6.2.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
+    json (2.3.1)
+    loofah (2.7.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)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    mongo (2.13.1)
+      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.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
       byebug (~> 11.0)
-      pry (~> 0.10)
-    psych (3.1.0)
+      pry (~> 0.13.0)
+    rack (2.2.3)
+    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)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
-    rake (10.5.0)
-    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.2)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    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-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.66.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (0.91.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.4.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    rubocop-rspec (1.32.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.19.1)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
-    url (0.3.2)
+    unicode-display_width (1.7.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activerecord
-  bundler (~> 1.16)
+  bundler (~> 2)
   codecov
   graphql_rails!
   mongoid
   pry-byebug
-  rake (~> 10.0)
+  rails (~> 6)
+  rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop
-  rubocop-rspec
+  rubocop (= 0.91.0)
+  rubocop-performance (~> 1.8, >= 1.8.1)
+  rubocop-rspec (~> 1.44, >= 1.44.1)
   simplecov
 
 BUNDLED WITH
-   1.16.4
+   2.1.4

data/docs/README.md

@@ -1,5 +1,9 @@
 # GraphqlRails
 
+[![Build Status](https://travis-ci.org/samesystem/graphql_rails.svg?branch=master)](https://travis-ci.org/samesystem/graphql_rails)
+[![codecov](https://codecov.io/gh/samesystem/graphql_rails/branch/master/graph/badge.svg)](https://codecov.io/gh/samesystem/graphql_rails)
+[![Documentation](https://readthedocs.org/projects/ansicolortags/badge/?version=latest)](https://samesystem.github.io/graphql_rails)
+
 Rails style structure for GraphQL API.
 
 ## Installation
@@ -18,12 +22,21 @@ Or install it yourself as:
 
     $ gem install graphql_rails
 
+## Getting started
+
+Execute:
+
+    $ bundle exec rails g graphql_rails:install
+
+This will generate code which will let you start your graphql faster
+
 ## Usage
 
 ### Define GraphQL schema as RoR routes
 
 ```ruby
-MyGraphqlSchema = GraphqlRails::Router.draw do
+# config/graphql/routes.rb
+GraphqlRails::Router.draw do
   # will create createUser, updateUser, deleteUser mutations and user, users queries.
   # expects that UsersController class exist
   resources :users
@@ -37,6 +50,7 @@ end
 ### Define your Graphql model
 
 ```ruby
+# app/models/user.rb
 class User # works with any class including ActiveRecord
   include GraphqlRails::Model
 
@@ -53,10 +67,12 @@ end
 ### Define controller
 
 ```ruby
-class UsersController < GraphqlRails::Controller
+# 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!')
 
   def change_user_password
     user = User.find(params[:id])
@@ -66,7 +82,9 @@ class UsersController < GraphqlRails::Controller
     user # or SomeDecorator.new(user)
   end
 
-  action(:search).permit(search_fields!: SearchFieldsInput) # you can specify your own input fields
+  action(:search)
+    .permit(search_fields!: SearchFieldsInput) # you can specify your own input fields
+    .returns('[User!]!')
   def search
   end
 end
@@ -75,7 +93,7 @@ end
 ## Routes
 
 ```ruby
-MyGraphqlSchema = GraphqlRails::Router.draw do
+GraphqlRails::Router.draw do
   # generates `friend`, `createFriend`, `updateFriend`, `destroyFriend`, `friends` routes
   resources :friends
   resources :shops, only: [:show, :index] # generates `shop` and `shops` routes only
@@ -91,10 +109,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
@@ -128,11 +146,13 @@ There are 3 helper methods:
 
 ```ruby
 class MyGraphqlController
+  action(:create_user).permit(:full_name, :email).returns(User)
+  action(:index).returns('String')
+
   def index
     "Called from index: #{params[:message]}"
   end
 
-  action(:create_user).permit(:full_name, :email)
   def create_user
     User.create!(params)
   end
@@ -167,6 +187,25 @@ RSpec.describe MyGraphqlController, type: :graphql_controller do
 end
 ```
 
+### Integrating GraphqlRails with other tools
+
+In order to make GraphqlRails work with tools such as lograge or sentry, you need to enable them. In Ruby on Rails, you can add initializer:
+
+```ruby
+# config/initializers/graphql_rails.rb
+GraphqlRails::Integrations.enable(:lograge, :sentry)
+```
+
+At the moment, GraphqlRails supports following integrations:
+
+* lograge
+* sentry
+
+If you need to build something custom, check [logging_and_monitoring documentation](logging_and_monitoring/logging_and_monitoring.md) for more details.
+
+## Detailed documentation
+
+Check https://samesystem.github.io/graphql_rails for more details
 
 ## Development
 
@@ -176,7 +215,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/graphql_rails. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/samesystem/graphql_rails. 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.
 
 ## License
 
@@ -184,4 +223,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the GraphqlRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/graphql_rails/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the GraphqlRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/samesystem/graphql_rails/blob/master/CODE_OF_CONDUCT.md).