ezcater_rubocop 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 511f81e30ff5765d51a825d7b8606ebfa3c05d34e8c567dc7876ea7140e63d8a
-  data.tar.gz: f01eb84d2556225ac5be3e2c0ec206b6c1f5f8dc3fa8f6ad5bf6de400b474514
+  metadata.gz: 3e4ab0e968f3876d0ce517e56e4f4d4f85d4a512148d76eddc3b90afb27b030e
+  data.tar.gz: 1222c65a574b4aeab13b5372a4e2fc0c4c3af89e6f611dcfd82a41879343e198
 SHA512:
-  metadata.gz: 6283449ed5c2181a90557d786e074e285841c8fc8ea5f0d693fd40d52c536121b50267d0352d266e60ed3bb62e1d2aae0be87f64024cb9418cf65daf7311993f
-  data.tar.gz: 5385a45fb8dfb260eda7d3fdaf8adaf3dc2b05f6ab6532c622744f4c2c4fab06ac3909b71d74ba7bc4a68fc87bf311f7d69246afcbb84c62f12912c6f215c3f3
+  metadata.gz: 173c89e6a3c9eb6b022b90ccc0d28c49b44331d42617e082d5fcd1380e0c2b2ad834250608a87556c9dd5e664d770009d1499a77fa002ad4270740b1069f2b44
+  data.tar.gz: 924a0d9ed141df769723ed76ab30aae9625da0f1890ab75125c94f74ca1fa9e0cb6c31b0b4f8c74d0418031890c07f6f4dad1eadedbc1424e314fff32c16bc0f

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.1

data/CHANGELOG.md

@@ -6,11 +6,27 @@ This gem is moving onto its own [Semantic Versioning](https://semver.org/) schem
 
 Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of RuboCop. The first release of the ezcater_rubocop gem was `v0.49.0`.
 
+## 4.0.0
+
+- Add the [rubcop-graphql](https://github.com/DmitryTsepelev/rubocop-graphql) helpers and enable
+    them by default
+- Remove `Ezcater/GraphqlFieldsNaming` cop. The same rule exists in `rubocop-graphql`.
+
+## v3.0.2
+
+- Loosen restrictions to allow for Ruby 3.1 and latest dependency gems
+
+## v3.0.1
+
+- Fix the RspecDotNotSelfDot cop to work with rubocop-rspec
+- Exclude appraisal generated gemfiles for possible embedded gems in rails apps
+
 ## v3.0.0
-- Upgrade rubocop:       1.16.0
+
+- Upgrade rubocop: 1.16.0
 - Upgrade rubocop-rails: 2.10.1
 - Upgrade rubocop-rspec: 2.3.0
-- This is a major upgrade because a large number of cops have been introduced, tweaked, or renamed.  Here is an aggregate of the breaking changes introduced
+- This is a major upgrade because a large number of cops have been introduced, tweaked, or renamed. Here is an aggregate of the breaking changes introduced
   - RuboCop assumes that Cop classes do not define new `on_<type>` methods at runtime (e.g. via `extend` in `initialize`).
   - Enable all pending cops for RuboCop 1.0.
   - Change logic for cop department name computation. Cops inside deep namespaces (5 or more levels deep) now belong to departments with names that are calculated by joining module names starting from the third one with slashes as separators. For example, cop `Rubocop::Cop::Foo::Bar::Baz` now belongs to `Foo/Bar` department (previously it was `Bar`).
@@ -32,101 +48,128 @@ Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of R
   - Enabled pending cop (`RSpec/StubbedMock`).
 
 ## v2.4.0
+
 - Fix `FeatureFlagActive` cop so that it allows feature flag names to be variables in addition to strings.
 - Add check to `FeatureFlagActive` that the first parameter is a string or a variable, and use the appropriate messaging.
 
 ## v2.3.0
+
 - Add `FeatureFlagActive` cop. This provides confidence that upgrading to `ezcater_feature_flag-client` v2.0.0, which
-    contains breaking API changes, can be done safely.
+  contains breaking API changes, can be done safely.
 
 ## v2.2.0
+
 - Require Ruby 2.6 or later.
 - Set `TargetRubyVersion` to 2.6 in `rubocop_gem` configuration.
 
 ## v2.1.0
+
 - Enable `Rails/SaveBang` with `AllowImplicitReturn: false`, and with autocorrection disabled.
 
 ## v2.0.0
+
 - Update to `rubocop` v0.81.0, `rubocop-rspec` v1.38.1 and `rubocop-rails` v2.5.2.
 - This is being released as a major update because cops have been renamed so this is unlikely to be
   a drop-in replacement.
 - This is the first release to support Ruby 2.7.
 
 ## v1.4.1
+
 - Correct a matching syntax issue with `Ezcater/RubyTimeout` so that it applies in the expected cases.
 
 ## v1.4.0
+
 - Add `Ezcater/RubyTimeout` cop.
 
 ## v1.3.0
+
 - Add `Ezcater/GraphqlFieldsNaming` cop.
 
 ## v1.2.0
+
 - Add `Ezcater/RailsTopLevelSqlExecute` to replace `ActiveRecord::Base.connection.execute` with `execute` in `db/migrate/`.
 
 ## v1.1.1
+
 - Exclude `lib/tasks/` for `Ezcater/RailsEnv` and `Ezcater/DirectEnvCheck`.
 
 ## v1.1.0
+
 - Add `Ezcater/RailsEnv` cop.
 - Add `Ezcater/DirectEnvCheck` cop.
 
 ## v1.0.2
+
 - Exclude bootsnap cache directory (`tmp/cache`).
 
 ## v1.0.1
+
 - Disable `Rails/HasAndBelongsToMany` cop.
 - Disable `Style/DoubleNegation` cop.
 
 ## v1.0.0
+
 - Begin using Semantic Versioning
 - Delete `Ezcater/PrivateAttr`
 
 ## v0.61.1
+
 - `Layout/IndentHash` enforces consistent style
 - `Layout/IndentArray` enforces consistent style
 
 ## v0.61.0
+
 - Update to `rubocop` v0.61.1.
 - Update to `rubocop-rspec` v1.30.1
 
 ## v0.59.0
+
 - Disable `Style/NegatedIf`.
 
 ## v0.58.4
+
 - Update `Metrics/BlockLength` to exclude `app/graphql/**/*.rb`
 - Move `Metrics/BlockLength` exclusions for `lib/tasks/**/*.rake` and
   `config/environments/*.rb` into rubocop_rails.yml
 
 ## v0.58.3
+
 - Updated `Layout/MultilineMethodCallIndentation` to `indented`.
 
 ## v0.58.2
+
 - Updated `Ezcater/RspecDotNotSelfDot` to flag offenses for `::class_method`.
 
 ## v0.58.1
+
 - Update to `rubocop-rspec` v1.28.0.
 - Remove configuration for removed `FactoryBot/DynamicAttributeDefinedStatically` cop.
 
 ## v0.58.0
+
 - Update to rubocop v0.58.1.
 - Enable `Naming/MemoizedInstanceVariableName` with required leading
   underscore.
 
 ## v0.57.4
+
 - Configure `Rspec/MessageExpectation` with the `allow` style.
 
 ## v0.57.3
+
 - Do not use broken parser v2.5.1.1.
 
 ## v0.57.2
+
 - Fix `Ezcater/RspecRequireHttpStatusMatcher` cop.
 
 ## v0.57.1
+
 - Add `Ezcater/RspecRequireHttpStatusMatcher` cop.
 - Enable `Rails/HttpStatus` cop and enforce symbols.
 
 ## v0.57.0
+
 - Update to rubocop v0.57.2 and rubocop-rspec v1.27.0.
 - Disable new cop `Naming/MemoizedInstanceVariableName` until configuration
   options are available.
@@ -137,100 +180,128 @@ Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of R
 - Exclude appraisal generated gemfiles for gems.
 
 ## v0.52.8
+
 - Add new configuration `rubocop_gem` for use with gems.
 
 ## v0.52.7
+
 - Enable `Style/FrozenStringLiteralComment` with the `when_needed` style.
 
 ## v0.52.6
+
 - Configure `Style/TrailingCommaInLiteral` with `consistent_comma` style.
 
 ## v0.52.5
+
 - Add `Ezcater/RspecMatchOrderedArray` cop.
 - Fix array equality matcher violations in specs.
 
 ## v0.52.4
+
 - Configure `Style/RegexpLiteral` cop with the `AllowInnerSlashes: true` option.
 
 ## v0.52.3
+
 - Disable `Style/GuardClause` cop.
 - Exclude `spec/integrations` for `RSpec/DescribeClass`.
 
 ## v0.52.2
+
 - Disable `Style/IfUnlessModifier` cop.
 
 ## v0.52.1
+
 - Allow staging as a rails environment for the Rails/UnknownEnv cop.
 
 ## v0.52.0
+
 - Update to rubocop v0.52.1 and rubocop-rspec v1.22.2.
 
 ## v0.51.8
+
 - Disable `RSpec/LetSetup` cop.
 
 ## v0.51.7
+
 - Rename `Ezcater/RspecRequireGqlErrorHelpers` cop to `Ezcater/RequireGqlErrorHelpers`.
 
 ## v0.51.6
+
 - Add `Ezcater/RailsConfiguration` cop.
 - Exclude `config/environments/*.rb` for the `Metrics/BlockLength` cop.
 
 ## v0.51.5
+
 - Add `Ezcater/RspecRequireGqlErrorHelpers` cop.
 
 ## v0.51.4
+
 - Exclude `Gemfile` for the `Metrics/LineLength` cop.
 - Add `system` to the excluded spec directories for `RSpec/DescribeClass`.
 
 ## v0.51.3
+
 - Configure `RSpec/DescribeClass` to exclude the spec directories which
   are excluded by explicit metadata.
 - Exclude `lib/tasks` for the `Metrics/BlockLength` cop.
 
 ## v0.51.2
+
 - Configure `Style/RaiseArgs` to use the `compact` style.
 
 ## v0.51.1
+
 - Disable `Rails/FilePath` cop.
 - Disable `Style/EmptyLiteral` cop.
 
 ## v0.51.0
+
 - Update to rubocop v0.51.0 and rubocop-rspec v1.20.0.
 - Disable new cop `RSpec/ContextWording`.
 - Disable `Style/StderrPuts` for `bin/yarn`.
 
 ## v0.50.5
+
 - Configure `RSpec/NestedGroups` with a `Max` value of 5.
 
 ## v0.50.4
+
 - Configure `Style/PercentLiteralDelimiters` to prefer parentheses.
 
 ## v0.50.3
+
 - Configure `RSpec/MultipleExpectations` with a `Max` value of 5.
 
 ## v0.50.2
+
 - Add `Ezcater/PrivateAttr` custom cop.
 - Configure `RSpec/ExampleLength` with a `Max` value of 25.
 - Add `circle_rubocop.rb` script.
 
 ## v0.50.1
+
 - Add shared configuration.
 - Do not apply `Ezcater/StyleDig` to access using a range.
 
 ## v0.50.0
+
 - Update to rubocop v0.50.0 and rubocop-rspec v1.18.0.
 - Do not apply `Ezcater/StyleDig` to assignments with nested access.
 
 # v0.49.3
+
 - Do not apply `Ezcater/StyleDig` to access using a range.
 
 # v0.49.2
+
 - Do not apply `Ezcater/StyleDig` to assignments to with nested access.
 
 ## v0.49.1
+
 - Add `Ezcater/RspecRequireBrowserMock` cop.
 
 ## v0.49.0
+
 - Initial release.
 - Add `Ezcater/RspecRequireFeatureFlagMock` cop.
 - Add `Ezcater/RspecDotNotSelfDot` cop.

data/README.md

@@ -61,11 +61,11 @@ configuration for existing offenses and auto-correction.
 
 This gem contains a script, `circle_rubocop.rb`, that can be used to run RuboCop in CI.
 
-The behavior of the script is that all files are checked on master or if the rubocop
-configuration has changed. On non-master branches, only the files added or changed on
+The behavior of the script is that all files are checked on main or if the rubocop
+configuration has changed. On non-main branches, only the files added or changed on
 the branch are checked.
 
-For non-master branches, `[rubocop skip]` can be included in the commit message to skip
+For non-main branches, `[rubocop skip]` can be included in the commit message to skip
 running rubocop.
 
 ## Versioning
@@ -74,15 +74,14 @@ This gem is using [Semantic Versioning](https://semver.org/). All version bumps
 
 ## Custom Cops
 
-1. [RailsConfiguration](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rails_configuration.rb) - Enforce use of `Rails.configuration` instead of `Rails.application.config`.
-1. [RequireGqlErrorHelpers](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/require_gql_error_helpers.rb) - Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly.
-1. [RspecDotNotSelfDot](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb) - Enforce ".<class method>" instead of "self.<class method>" and "::<class method>" for example group description.
-1. [RspecMatchOrderedArray](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_match_ordered_array.rb) - Enforce use of `match_ordered_array` matcher instead of `eq` matcher. This matcher comes from the [ezcater_matchers](https://github.com/ezcater/ezcater_matchers) gem.
-1. [RspecRequireBrowserMock](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb) - Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers instead of mocking `Browser` or `EzBrowser` directly.
-1. [RspecRequireFeatureFlagMock](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb) - Enforce use of `mock_feature_flag` helper instead of mocking `FeatureFlag.is_active?` directly.
-1. [RspecRequireHttpStatusMatcher](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_require_http_status_matcher.rb) - Use the HTTP status code matcher, like `expect(response).to have_http_status :bad_request`, rather than `expect(response.code).to eq 400`
-1. [StyleDig](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/style_dig.rb) - Recommend `dig` for deeply nested access.
-1. [GraphqlFieldsNaming](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/graphql_fields_naming.rb) - Enforce the configured style when naming graphQL fields and arguments.
+1. [RailsConfiguration](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rails_configuration.rb) - Enforce use of `Rails.configuration` instead of `Rails.application.config`.
+1. [RequireGqlErrorHelpers](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/require_gql_error_helpers.rb) - Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly.
+1. [RspecDotNotSelfDot](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb) - Enforce ".<class method>" instead of "self.<class method>" and "::<class method>" for example group description.
+1. [RspecMatchOrderedArray](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_match_ordered_array.rb) - Enforce use of `match_ordered_array` matcher instead of `eq` matcher. This matcher comes from the [ezcater_matchers](https://github.com/ezcater/ezcater_matchers) gem.
+1. [RspecRequireBrowserMock](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb) - Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers instead of mocking `Browser` or `EzBrowser` directly.
+1. [RspecRequireFeatureFlagMock](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb) - Enforce use of `mock_feature_flag` helper instead of mocking `FeatureFlag.is_active?` directly.
+1. [RspecRequireHttpStatusMatcher](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_http_status_matcher.rb) - Use the HTTP status code matcher, like `expect(response).to have_http_status :bad_request`, rather than `expect(response.code).to eq 400`
+1. [StyleDig](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/style_dig.rb) - Recommend `dig` for deeply nested access.
 
 ## Development
 

data/bin/circle_rubocop.rb

@@ -4,10 +4,10 @@
 require "English"
 
 # This script is used to run Rubocop in CircleCI so that on branches only
-# the changed files are checked and on master all files are checked.
+# the changed files are checked and on main all files are checked.
 #
 # Additionally if rubocop configuration is changed, all files are checked, and
-# if the commit description on a non-master branch includes [rubocop skip]
+# if the commit description on a non-main branch includes [rubocop skip]
 # then rubocop is skipped.
 
 def run(command)
@@ -20,7 +20,7 @@ def rubocop_everything
 end
 
 begin
-  if ENV["CIRCLE_BRANCH"] == "master"
+  if ENV["CIRCLE_BRANCH"] == "main"
     rubocop_everything
   else
     git_commit_desc = `git log --format=%B -n 1 $CIRCLE_SHA1`
@@ -30,7 +30,7 @@ begin
       exit 0
     end
 
-    changed_files = `git diff --diff-filter=d --name-only origin/master...$CIRCLE_BRANCH`.split("\n").join(" ")
+    changed_files = `git diff --diff-filter=d --name-only origin/main...$CIRCLE_BRANCH`.split("\n").join(" ")
     raise "Failed to identify changed files" unless $CHILD_STATUS.success?
 
     if changed_files.strip.empty? || changed_files.include?(".rubocop")

data/conf/rubocop.yml

@@ -3,6 +3,7 @@ require: ezcater_rubocop
 AllCops:
   DisplayCopNames: true
   NewCops: disable
+  SuggestExtensions: false
 
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
@@ -21,8 +22,8 @@ Metrics/AbcSize:
 
 Metrics/BlockLength:
   Exclude:
-  - "*.gemspec"
-  - "spec/**/*.rb"
+    - "*.gemspec"
+    - "spec/**/*.rb"
 
 Metrics/CyclomaticComplexity:
   Enabled: false
@@ -30,7 +31,7 @@ Metrics/CyclomaticComplexity:
 Layout/LineLength:
   Max: 120
   Exclude:
-  - "Gemfile"
+    - "Gemfile"
 
 Metrics/MethodLength:
   Enabled: true
@@ -45,9 +46,9 @@ Naming/MemoizedInstanceVariableName:
 
 Naming/MethodParameterName:
   AllowedNames:
-  - e
-  - ex
-  - id
+    - e
+    - ex
+    - id
 
 Naming/VariableNumber:
   Enabled: false
@@ -60,12 +61,12 @@ RSpec/ContextWording:
 
 RSpec/DescribeClass:
   Exclude:
-  - "spec/requests/**/*.rb"
-  - "spec/features/**/*.rb"
-  - "spec/routing/**/*.rb"
-  - "spec/views/**/*.rb"
-  - "spec/system/**/*.rb"
-  - "spec/integrations/**/*.rb"
+    - "spec/requests/**/*.rb"
+    - "spec/features/**/*.rb"
+    - "spec/routing/**/*.rb"
+    - "spec/views/**/*.rb"
+    - "spec/system/**/*.rb"
+    - "spec/integrations/**/*.rb"
 
 RSpec/ExampleLength:
   Max: 25
@@ -113,12 +114,12 @@ Style/NumericLiterals:
 
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
-    default: '()'
-    '%i': '()'
-    '%I': '()'
-    '%r': '{}'
-    '%w': '()'
-    '%W': '()'
+    default: "()"
+    "%i": "()"
+    "%I": "()"
+    "%r": "{}"
+    "%w": "()"
+    "%W": "()"
 
 Style/RaiseArgs:
   EnforcedStyle: compact

data/conf/rubocop_rails.yml

@@ -9,6 +9,7 @@ AllCops:
   TargetRailsVersion: 5.2
   Exclude:
     - tmp/cache/**/*
+    - '**/gemfiles/*.gemfile'
 
 Metrics/BlockLength:
   inherit_mode:

data/config/default.yml

@@ -1,61 +1,64 @@
-Ezcater/GraphqlFieldsNaming:
-  EnforcedStyle: snake_case
-  Enabled: true
-  SupportedStyles:
-    - snake_case
-    - camelCase
-  Include:
-    - 'app/graphql/**/*.rb'
-
 Ezcater/RailsConfiguration:
-  Description: 'Enforce the use of `Rails.configuration` instead of `Rails.application.config`.'
+  Description: "Enforce the use of `Rails.configuration` instead of `Rails.application.config`."
   Enabled: true
 
 Ezcater/RailsEnv:
-  Description: 'Enforce the use of `Rails.configuration.x.<foo>` instead of checking `Rails.env`.'
+  Description: "Enforce the use of `Rails.configuration.x.<foo>` instead of checking `Rails.env`."
   Enabled: false
 
 Ezcater/DirectEnvCheck:
-  Description: 'Enforce the use of `Rails.configuration.x.<foo>` instead of checking `ENV`.'
+  Description: "Enforce the use of `Rails.configuration.x.<foo>` instead of checking `ENV`."
   Enabled: false
 
 Ezcater/FeatureFlagActive:
-  Description: 'Enforce the proper arguments are given to EzcaterFeatureFlag.active?'
+  Description: "Enforce the proper arguments are given to EzcaterFeatureFlag.active?"
   Enabled: true
 
 Ezcater/RspecDotNotSelfDot:
   Description: 'Enforce ".<class method>" instead of "self.<class method>" for example group description.'
   Enabled: true
   Include:
-    - '**/*_spec.rb'
+    - "**/*_spec.rb"
 
 Ezcater/RspecRequireBrowserMock:
-  Description: 'Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers instead of mocking `Browser` or `EzBrowser` directly.'
+  Description: "Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers instead of mocking `Browser` or `EzBrowser` directly."
   Enabled: true
   Include:
-    - '**/*_spec.rb'
+    - "**/*_spec.rb"
 
 Ezcater/RspecRequireFeatureFlagMock:
-  Description: 'Enforce use of `mock_feature_flag` helpers instead of mocking `FeatureFlag.is_active?` directly.'
+  Description: "Enforce use of `mock_feature_flag` helpers instead of mocking `FeatureFlag.is_active?` directly."
   Enabled: true
   Include:
-    - '**/*_spec.rb'
+    - "**/*_spec.rb"
 
 Ezcater/RspecRequireHttpStatusMatcher:
-  Description: 'Use the HTTP status code matcher, like `expect(response).to have_http_status :bad_request`, rather than `expect(response.code).to eq 400`'
+  Description: "Use the HTTP status code matcher, like `expect(response).to have_http_status :bad_request`, rather than `expect(response.code).to eq 400`"
   Enabled: true
   Include:
-    - '**/*_spec.rb'
+    - "**/*_spec.rb"
 
 Ezcater/RequireGqlErrorHelpers:
-  Description: 'Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly.'
+  Description: "Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly."
   Enabled: true
 
 Ezcater/StyleDig:
-  Description: 'Recommend `dig` for deeply nested access.'
+  Description: "Recommend `dig` for deeply nested access."
   Enabled: true
   AutoCorrect: false
 
 Ezcater/RubyTimeout:
-  Description: 'Disallow use of `Timeout.timeout` because it is unsafe and can cause unexpected behavior.'
+  Description: "Disallow use of `Timeout.timeout` because it is unsafe and can cause unexpected behavior."
   Enabled: true
+
+GraphQL/FieldDescription:
+  Enabled: false
+GraphQL/ArgumentDescription:
+  Enabled: false
+GraphQL/ObjectDescription:
+  Include:
+    - "**/types/**/*.rb"
+    - "**/mutations/**/*.rb"
+GraphQL/ExtractInputType:
+  Exclude:
+    - "**/input_objects/**/*.rb"

data/ezcater_rubocop.gemspec

@@ -44,15 +44,16 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.6"
 
-  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.11"
   spec.add_development_dependency "rspec_junit_formatter"
-  spec.add_development_dependency "simplecov", "< 0.18.0"
+  spec.add_development_dependency "simplecov"
 
-  spec.add_runtime_dependency "parser", "!= 2.5.1.1"
-  spec.add_runtime_dependency "rubocop", "~> 1.16.0"
-  spec.add_runtime_dependency "rubocop-rails", "~> 2.10.1"
-  spec.add_runtime_dependency "rubocop-rspec", "~> 2.3.0"
+  spec.add_runtime_dependency "parser", ">= 2.6"
+  spec.add_runtime_dependency "rubocop", ">= 1.16.0", "< 2.0"
+  spec.add_runtime_dependency "rubocop-graphql", ">= 0.14.0", "< 1.0"
+  spec.add_runtime_dependency "rubocop-rails", ">= 2.10.1", "< 3.0"
+  spec.add_runtime_dependency "rubocop-rspec", ">= 2.3.0", "< 3.0"
 end

data/lib/ezcater_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzcaterRubocop
-  VERSION = "3.0.0"
+  VERSION = "4.0.0"
 end

data/lib/ezcater_rubocop.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "ezcater_rubocop/version"
+require "rubocop-graphql"
 require "rubocop-rails"
 require "rubocop-rspec"
 
@@ -17,7 +18,6 @@ RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
 
 require "rubocop/cop/ezcater/direct_env_check"
 require "rubocop/cop/ezcater/feature_flag_active"
-require "rubocop/cop/ezcater/graphql_fields_naming"
 require "rubocop/cop/ezcater/rails_configuration"
 require "rubocop/cop/ezcater/rails_env"
 require "rubocop/cop/ezcater/ruby_timeout"

data/lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb

@@ -25,26 +25,44 @@ module RuboCop
 
       class RspecDotNotSelfDot < Cop
         include RuboCop::RSpec::Language
+        extend RuboCop::RSpec::Language::NodePattern
 
-        SELF_DOT_REGEXP = /["']self\./.freeze
-        COLON_COLON_REGEXP = /["'](\:\:)/.freeze
+        RSPEC_EXAMPLE_PREFIXES = ["", "x", "f"].freeze
+        EXAMPLE_GROUP_IDENTIFIERS = (RSPEC_EXAMPLE_PREFIXES.map do |prefix|
+          %w(describe context feature).map { |identifier| "#{prefix}#{identifier}" }
+        end.flatten + %w(example_group)).freeze
+        EXAMPLE_IDENTIFIERS = (RSPEC_EXAMPLE_PREFIXES.map do |prefix|
+          %w(it specify example scenario).map { |identifier| "#{prefix}#{identifier}" }
+        end.flatten + %w(its focus skip)).freeze
+
+        SELF_DOT_REGEXP = /\Aself\./.freeze # rubocop:disable Style/RedundantFreeze
+        COLON_COLON_REGEXP = /\A(\:\:)/.freeze # rubocop:disable Style/RedundantFreeze
 
         SELF_DOT_MSG = 'Use ".<class method>" instead of "self.<class method>" for example group description.'
         COLON_COLON_MSG = 'Use ".<class method>" instead of "::<class method>" for example group description.'
 
-        def on_send(node)
-          example_group?(node) do |doc|
-            if doc.source.match?(SELF_DOT_REGEXP)
-              add_offense(doc, location: :expression, message: SELF_DOT_MSG)
-            elsif doc.source.match?(COLON_COLON_REGEXP)
-              add_offense(doc, location: :expression, message: COLON_COLON_MSG)
-            end
+        def_node_matcher :example_group?, <<~PATTERN
+          (block
+            (send #rspec? {#{EXAMPLE_GROUP_IDENTIFIERS.map { |i| ":#{i}" }.join(' ')}}
+              (str ...) ...
+            ) ...
+          )
+        PATTERN
+
+        def on_block(node)
+          return unless example_group?(node)
+
+          str_node = node.send_node.arguments[0]
+          if str_node.value.match?(SELF_DOT_REGEXP)
+            add_offense(str_node, location: :expression, message: SELF_DOT_MSG)
+          elsif str_node.value.match?(COLON_COLON_REGEXP)
+            add_offense(str_node, location: :expression, message: COLON_COLON_MSG)
           end
         end
 
         def autocorrect(node)
           lambda do |corrector|
-            experession_end = node.source.match?(COLON_COLON_REGEXP) ? 3 : 6
+            experession_end = node.source.match?("::") ? 3 : 6
             corrector.replace(Parser::Source::Range.new(node.source_range.source_buffer,
                                                         node.source_range.begin_pos + 1,
                                                         node.source_range.begin_pos + experession_end), ".")

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -84,72 +84,110 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "!="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.1.1
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "!="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.1.1
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.10.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.10.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: ezCater custom cops and shared configuration
 email:
 - engineering@ezcater.com
@@ -160,6 +198,7 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".tool-versions"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -174,7 +213,6 @@ files:
 - lib/ezcater_rubocop/version.rb
 - lib/rubocop/cop/ezcater/direct_env_check.rb
 - lib/rubocop/cop/ezcater/feature_flag_active.rb
-- lib/rubocop/cop/ezcater/graphql_fields_naming.rb
 - lib/rubocop/cop/ezcater/rails_configuration.rb
 - lib/rubocop/cop/ezcater/rails_env.rb
 - lib/rubocop/cop/ezcater/rails_top_level_sql_execute.rb
@@ -207,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: ezCater custom cops and shared configuration

data/lib/rubocop/cop/ezcater/graphql_fields_naming.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Ezcater
-      # This cop makes sure that GraphQL fields & arguments match the supported style
-      # https://git.io/JeofW
-      #
-      # The cop also ignores when users provide a :camelize option, because
-      # the user is manually requesting to override the value
-      #
-      # @example
-      #   # bad
-      #   field :fooBar, ID, null: false
-      #   argument :barBaz, ID, required: true
-      #
-      #   # good
-      #   field :foo_bar, ID, null: true
-      #   field :foo_bar, ID, null: true do
-      #     argument :bar_baz, ID, required: true
-      #   end
-      #
-      #   field :fooBar, ID, null: true, camelize: true
-      #
-      class GraphqlFieldsNaming < Cop
-        include ConfigurableNaming
-
-        MSG = "Use %<style>s for GraphQL fields & arguments names. " \
-              "See https://git.io/JeofW for our guide. " \
-              "This can be overridden with camelize."
-        FIELD_ADDING_METHODS = %i(field argument).freeze
-        PROCESSABLE_TYPES = %i(sym string).freeze
-
-        def on_send(node)
-          method = method_name(node)
-          first_arg = node.first_argument
-
-          return unless FIELD_ADDING_METHODS.include? method
-          return unless PROCESSABLE_TYPES.include?(first_arg&.type)
-
-          return if includes_camelize?(node)
-
-          check_name(node, first_arg.value, node.first_argument)
-        end
-
-        alias on_super on_send
-        alias on_yield on_send
-
-        private
-
-        def includes_camelize?(node)
-          results = []
-          node.last_argument.each_child_node { |arg| results << args_include_camelize?(arg) }
-          results.any?
-        end
-
-        def args_include_camelize?(arg_pair)
-          key_node = arg_pair.key
-          _value_node = arg_pair.value
-
-          key_node.value.match?(/camelize/)
-        end
-
-        def method_name(node)
-          node.children[1]
-        end
-
-        def message(style)
-          format(MSG, style: style)
-        end
-      end
-    end
-  end
-end