datarockets-style 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8cf398f37f77c928364df3e33a874052bb6912f909688e881a03b87cc7d53d1
-  data.tar.gz: 7f3e05cf2f7c6dbdff1e5c506131de539f14974400cefb2e30170be0cabec9c9
+  metadata.gz: fae6be6c9b336722b260f0e5cfd4d650d95e5cd96e453756b5bcbbf3b74f13bd
+  data.tar.gz: 4bb202204deb99f738fad88e8b8b6aebfcb8ba1c59a4ead9a6c8ad39ab25e952
 SHA512:
-  metadata.gz: 4072a041ba599dcad11bfdf6f50c851541f9b77a0a5283989a26d12c121fcc778c11883ccc6eb495fc737674ee5e2c024a9f067150953077bcf2361b45a8425f
-  data.tar.gz: b68cc6a20a6bd27c42071606c27329365fc0e0c400999f66846aa9604b705fccab9d652de8711de69bc4ff25e9c5f121b5a2e11b422ee4b88dbb413ff06adb0b
+  metadata.gz: 12f51702b7b03323daf313e476c1bb70e8daa6ffcea8d1d5c0b7ec2b01915cd31147a77c79c62b3bf876dddbe68fe221def1848c2cbb82d17242f7e1e018719e
+  data.tar.gz: e79c1b517947247f4c76f06e59e1c52816193080162b412b3f3beea3900d97d3f8b32749d99335dfadb1be51266bca04cb0cf385b515034a60def7341577ca39

data/.github/workflows/main.yml

@@ -15,10 +15,10 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up Ruby 2.6
+    - name: Set up Ruby 2.7
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '2.6'
+        ruby-version: '2.7'
         bundler-cache: true
 
     - name: Run linter

data/.rubocop.yml

@@ -7,7 +7,7 @@ inherit_mode:
     - Exclude
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 # for checking cops with interpolation
 Lint/InterpolationCheck:

data/CHANGELOG.md

@@ -4,6 +4,20 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master
 
+## 1.5.0 (2023-09-11)
+
+### Added
+
+* Added GraphQL cops. ([@Anastastasia-B][])
+
+### Changed
+
+* **(Breaking)** Support Ruby >= 2.7.0
+
+* Update rubocop to `1.56.3`. ([@Set27])
+* Update rubocop-rails to `2.21.0`. ([@Set27])
+* Update rubocop-spec to `2.24.0`. ([@Set27])
+
 ## 1.4.0 (2023-02-11)
 
 ### Changed
@@ -272,3 +286,4 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 [@a.branzeanu]: https://github.com/texpert
 [@nikitasakov]: https://github.com/nikitasakov
 [@paydaylight]: https://github.com/paydaylight
+[@Anastastasia-B]: https://github.com/Anastastasia-B

data/Gemfile

@@ -8,4 +8,4 @@ gemspec
 
 gem "pry-byebug"
 gem "rake", "~> 13.0"
-gem "rspec", "~> 3.10"
+gem "rspec", "~> 3.12.0"

data/README.md

@@ -10,14 +10,14 @@ Add this line to your application's Gemfile:
 
 ```ruby
 group :test, :development do
-  gem 'datarockets-style', '~> 1.4.0'
+  gem 'datarockets-style', '~> 1.5.0'
 end
 ```
 
 Or, for a Ruby library, add this to your gemspec:
 
 ```ruby
-spec.add_development_dependency 'datarockets-style', '~> 1.4.0'
+spec.add_development_dependency 'datarockets-style', '~> 1.5.0'
 ```
 
 And then execute:
@@ -60,6 +60,16 @@ inherit_gem:
     - config/rails-locales.yml
 ```
 
+### GraphQL config
+
+To include specific rules for GraphQL, you can add the following config
+
+```yaml
+inherit_gem:
+  datarockets-style:
+    - config/graphql.yml
+```
+
 ### Rspec config
 
 For Rspec tests, you can add a special rubocop config

data/config/graphql.yml

@@ -0,0 +1,10 @@
+require: rubocop-graphql
+
+GraphQL/ExtractInputType:
+  Enabled: false
+
+GraphQL/ExtractType:
+  Enabled: false
+
+GraphQL/ResolverMethodLength:
+  Max: 10

data/datarockets-style.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/datarockets/datarockets-style"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -32,9 +32,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rubocop", "~> 1.45.1"
-  spec.add_dependency "rubocop-rails", "~> 2.17.4"
-  spec.add_dependency "rubocop-rspec", "~> 2.18.1"
+  spec.add_dependency "rubocop", "~> 1.56.3"
+  spec.add_dependency "rubocop-graphql", "~> 1.4"
+  spec.add_dependency "rubocop-rails", "~> 2.21"
+  spec.add_dependency "rubocop-rspec", "~> 2.24"
 
   spec.metadata["rubygems_mfa_required"] = "true"
 end

data/doc/STYLE_GUIDE_GRAPHQL.md

@@ -0,0 +1,486 @@
+# GraphQL Style Guide
+
+This style is based on the rules from [RuboCop::GraphQL](https://github.com/DmitryTsepelev/rubocop-graphql) gem with a few differences.
+
+## Table of contents
+
+* [Style](#Style)
+
+## Style
+
+* <a name="graphql-argument-description"></a>
+  Each argument should have a description.
+  <sup>[[link](#graphql-argument-description)]</sup>
+
+```ruby
+# bad
+class BanUser < BaseMutation
+  argument :uuid, ID, required: true
+end
+
+# good
+class BanUser < BaseMutation
+  argument :uuid, ID, required: true, description: "UUID of the user to ban"
+end
+```
+
+* <a name="graphql-argument-name"></a>
+  All argument names should be snake_case.
+  <sup>[[link](#graphql-argument-name)]</sup>
+
+```ruby
+# bad
+class BanUser < BaseMutation
+  argument :userId, ID, required: true
+end
+
+# good
+class BanUser < BaseMutation
+  argument :user_id, ID, required: true
+end
+```
+
+* <a name="graphql-argument-uniqueness"></a>
+  Avoid duplicate argument definitions.
+  <sup>[[link](#graphql-argument-uniqueness)]</sup>
+
+```ruby
+# bad
+class BanUser < BaseMutation
+  argument :user_id, ID, required: true
+  argument :user_id, ID, required: true
+end
+
+# good
+class BanUser < BaseMutation
+  argument :user_id, ID, required: true
+end
+```
+
+* <a name="graphql-field-definitions"></a>
+  All field definitions should be grouped together.
+  <sup>[[link](#graphql-field-definitions)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  field :first_name, String, null: true
+
+  def first_name
+    object.contact_data.first_name
+  end
+
+  field :last_name, String, null: true
+
+  def last_name
+    object.contact_data.last_name
+  end
+end
+
+# good
+class UserType < BaseType
+  field :first_name, String, null: true
+  field :last_name, String, null: true
+
+  def first_name
+    object.contact_data.first_name
+  end
+
+  def last_name
+    object.contact_data.last_name
+  end
+end
+```
+
+* <a name="graphql-field-description"></a>
+  Each field should have a description.
+  <sup>[[link](#graphql-field-description)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  field :name, String, null: true
+end
+
+# good
+class UserType < BaseType
+  field :name, String, "Name of the user", null: true
+end
+```
+
+* <a name="graphql-field-hash-key"></a>
+  Avoid unnecessary resolver methods in cases when :hash_key option can be used.
+  <sup>[[link](#graphql-field-hash-key)]</sup>
+
+```ruby
+# bad
+class Types::UserType < Types::BaseObject
+  field :phone, String, null: true
+   
+  def phone
+    object[:home_phone]
+  end
+end
+
+# good
+class Types::UserType < Types::BaseObject
+  field :phone, String, null: true, hash_key: :home_phone
+end
+```
+
+* <a name="graphql-field-mathod"></a>
+  Avoid unnecessary resolver methods in cases when :method option can be used.
+  <sup>[[link](#graphql-field-mathod)]</sup>
+
+```ruby
+# bad
+class Types::UserType < Types::BaseObject
+  field :phone, String, null: true
+   
+  def phone
+    object.home_phone
+  end
+end
+
+# good
+class Types::UserType < Types::BaseObject
+  field :phone, String, null: true, method: :home_phone
+end
+```
+
+* <a name="graphql-field-name"></a>
+  All field names should be snake_case.
+  <sup>[[link](#graphql-field-name)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  field :firstName, String, null: true
+end
+
+# good
+class UserType < BaseType
+  field :first_name, String, null: true
+end
+```
+
+* <a name="graphql-field-uniqueness"></a>
+  Avoid duplicate field definitions.
+  <sup>[[link](#graphql-field-uniqueness)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  field :name, String, null: true
+  field :phone, String, null: true
+  field :phone, String, null: true do
+    argument :something, String, required: false
+  end
+end
+
+# good
+class UserType < BaseType
+  field :name, String, null: true
+  field :phone, String, null: true do
+    argument :something, String, required: false
+  end
+end
+```
+
+* <a name="graphql-graphql-name"></a>
+  Types and mutations should have graphql_name configured only if it's different from the default name.
+  <sup>[[link](#graphql-graphql-name)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  graphql_name 'User'
+end
+
+# good
+class UserType < BaseType
+  graphql_name 'Viewer'
+end
+```
+
+* <a name="graphql-max-complexity-schema"></a>
+  Use max_complexity configuration in schema files.
+  <sup>[[link](#graphql-max-complexity-schema)]</sup>
+
+```ruby
+# good
+class AppSchema < BaseSchema
+  max_complexity 42
+end
+```
+
+* <a name="graphql-max-depth-schema"></a>
+  Use max_depth configuration in schema files.
+  <sup>[[link](#graphql-max-depth-schema)]</sup>
+
+```ruby
+# good
+class AppSchema < BaseSchema
+  max_depth 42
+end
+```
+
+* <a name="graphql-multiple-field-definitions"></a>
+  Fields with multiple definitions should be grouped together.
+  <sup>[[link](#graphql-multiple-field-definitions)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  field :first_name, String, null: true
+
+  def first_name
+    object.contact_data.first_name
+  end
+  field :first_name, Name, null: true
+end
+
+# good
+class UserType < BaseType
+  field :first_name, String, null: true
+  field :first_name, Name, null: true
+
+  def first_name
+    object.contact_data.first_name
+  end
+end
+```
+
+* <a name="graphql-not-authorized-node-type"></a>
+  Types that implement Node interface should have `.authorized?` check. Such types can be fetched by ID and therefore should have type level check to avoid accidental information exposure.
+  If `.authorized?` is defined in a parent class, you can add parent to the "SafeBaseClasses" to avoid offenses in children.
+  This cop also checks the `can_can_action` or `pundit_role` methods that can be used as part of the Ruby GraphQL Pro.
+  <sup>[[link](#graphql-not-authorized-node-type)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  implements GraphQL::Types::Relay::Node
+
+  field :uuid, ID, null: false
+end
+
+# good
+class UserType < BaseType
+  implements GraphQL::Types::Relay::Node
+
+  field :uuid, ID, null: false
+
+  def self.authorized?(object, context)
+    super && object.owner == context[:viewer]
+  end
+end
+
+# good
+class UserType < BaseType
+  implements GraphQL::Types::Relay::Node
+
+  pundit_role :staff
+
+  field :uuid, ID, null: false
+end
+
+# good
+class UserType < BaseType
+  implements GraphQL::Types::Relay::Node
+
+  can_can_action :staff
+
+  field :uuid, ID, null: false
+end
+```
+
+* <a name="graphql-object-description"></a>
+  All types (objects, inputs, interfaces, scalars, unions, mutations, subscriptions, and resolvers) should have a description.
+  <sup>[[link](#graphql-object-description)]</sup>
+
+```ruby
+# bad
+class Types::UserType < Types::BaseObject
+  ...
+end
+
+# good
+class Types::UserType < Types::BaseObject
+  description "Represents application user"
+  ...
+end
+```
+
+* <a name="graphql-ordered-arguments"></a>
+  Arguments should be alphabetically sorted within groups.
+  <sup>[[link](#graphql-ordered-arguments)]</sup>
+
+```ruby
+# bad
+class UpdateProfile < BaseMutation
+  argument :uuid, ID, required: true
+  argument :email, String, required: false
+  argument :name, String, required: false
+end
+
+# good
+class UpdateProfile < BaseMutation
+  argument :email, String, required: false
+  argument :name, String, required: false
+end
+
+# good
+class UpdateProfile < BaseMutation
+  argument :uuid, ID, required: true
+
+  argument :email, String, required: false
+  argument :name, String, required: false
+end
+```
+
+* <a name="graphql-ordered-fields"></a>
+  Fields should be alphabetically sorted within groups.
+  <sup>[[link](#graphql-ordered-fields)]</sup>
+
+```ruby
+# bad
+class UpdateProfile < BaseMutation
+  field :phone, String, null: true
+  field :name, String, null: true
+end
+
+# good
+class UpdateProfile < BaseMutation
+  field :name, String, null: true
+  field :phone, String, null: true
+end
+
+# good
+class UpdateProfile < BaseMutation
+  field :phone, String, null: true 
+
+  field :name, String, null: true
+end
+```
+
+* <a name="graphql-resolver-method-length"></a>
+  The length of a resolver method should not exceed 10 lines.
+  <sup>[[link](#graphql-resolver-method-length)]</sup>
+
+* <a name="graphql-unnecessary-argument-camelize"></a>
+  Avoid using :camelize option for arguments where it is unnecessary.
+  <sup>[[link](#graphql-unnecessary-argument-camelize)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  argument :filter, String, required: false, camelize: false
+end
+
+# good
+class UserType < BaseType
+  argument :filter, String, required: false
+end
+
+# good
+class UserType < BaseType
+  argument :email_filter, String, required: false, camelize: true
+end
+```
+
+* <a name="graphql-unnecessary-field-alias"></a>
+  Avoid defining an unnecessary alias, method, or resolver_method.
+  <sup>[[link](#graphql-unnecessary-field-alias)]</sup>
+
+```ruby
+# bad
+field :name, String, "Name of the user", null: true, alias: :name
+field :name, String, "Name of the user", null: true, method: :name
+field :name, String, "Name of the user", null: true, resolver_method: :name
+field :name, String, "Name of the user", null: true, hash_key: :name
+
+# good
+field :name, String, "Name of the user", null: true, alias: :real_name
+field :name, String, "Name of the user", null: true, method: :real_name
+field :name, String, "Name of the user", null: true, resolver_method: :real_name
+field :name, String, "Name of the user", null: true, hash_key: :real_name
+```
+
+* <a name="graphql-unnecessary-field-camelize"></a>
+  Avoid using :camelize option for fields where it is unnecessary.
+  <sup>[[link](#graphql-unnecessary-field-camelize)]</sup>
+
+```ruby
+# bad
+class UserType < BaseType
+  field :name, "Name of the user", String, null: true, camelize: true
+end
+
+# good
+class UserType < BaseType
+  field :name, String, "Name of the user", null: true
+end
+
+# good
+class UserType < BaseType
+  field :first_name, "Name of the user", String, null: true, camelize: true
+end
+```
+
+* <a name="graphql-unused-argument"></a>
+  Arguments should either be listed explicitly or **rest should be in the resolve signature (and similar methods, such as #authorized?).
+  <sup>[[link](#graphql-unused-argument)]</sup>
+
+```ruby
+# bad
+class SomeResolver < Resolvers::Base
+  type SomeType, null: false
+
+  argument :arg1, String, required: true
+  argument :arg2, String, required: true
+
+  def authorized?; end
+  def resolve(arg1:); end
+end
+
+# bad
+class SomeResolver < Resolvers::Base
+  type SomeType, null: false
+
+  argument :arg1, String, required: true
+  argument :arg2, String, required: true
+
+  def resolve; end
+end
+
+# good
+class SomeResolver < Resolvers::Base
+  argument :arg1, String, required: true
+  argument :user_id, String, required: true, loads: Types::UserType
+  argument :post_id, String, loads: Types::PostType, as: :article
+  argument :comment_ids, String, loads: Types::CommentType
+
+  def authorized?(arg1:, user:, article:, comments:); end
+  def resolve(arg1:, user:, article:, comments:); end
+end
+
+# good
+class SomeResolver < Resolvers::Base
+  argument :arg1, String, required: true
+  argument :user_id, String, required: true, loads: Types::UserType
+  argument :comment_ids, String, loads: Types::CommentType
+
+  def resolve(arg1:, **rest); end
+end
+
+# good
+class SomeResolver < Resolvers::Base
+  type SomeType, null: false
+
+  argument :arg1, String, required: true
+  argument :arg2, String, required: true
+
+  def resolve(args); end
+end
+```

data/lib/datarockets_style/formatter/todo_list_formatter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "pathname"
-require_relative "./todo_list_formatter/report_summary"
+require_relative "todo_list_formatter/report_summary"
 
 # This formatter works like default formattter (display dots for files with no offenses and
 # letters for files with problems in the them).

data/lib/datarockets_style/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatarocketsStyle
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,42 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.45.1
+        version: 1.56.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.45.1
+        version: 1.56.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.17.4
+        version: '2.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.17.4
+        version: '2.21'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.18.1
+        version: '2.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.18.1
+        version: '2.24'
 description:
 email:
 - r.dubrovsky@datarockets.com
@@ -78,12 +92,14 @@ files:
 - bin/console
 - bin/setup
 - config/base.yml
+- config/graphql.yml
 - config/rails-locales.yml
 - config/rails.yml
 - config/rspec.yml
 - config/ruby.yml
 - datarockets-style.gemspec
 - doc/STYLE_GUIDE.md
+- doc/STYLE_GUIDE_GRAPHQL.md
 - doc/STYLE_GUIDE_RAILS.md
 - doc/STYLE_GUIDE_RSPEC.md
 - lib/datarockets_style.rb
@@ -108,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="