ezcater_rubocop 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de7fc9b23bdafa3b1a308dcfc89e404611d8a6d33f9b9e6a43d9d1729d221c52
-  data.tar.gz: 04322af4861d786fd3b35be77d6f1917c0d4b0d77dcb9279c71efb0dab751294
+  metadata.gz: 3e4ab0e968f3876d0ce517e56e4f4d4f85d4a512148d76eddc3b90afb27b030e
+  data.tar.gz: 1222c65a574b4aeab13b5372a4e2fc0c4c3af89e6f611dcfd82a41879343e198
 SHA512:
-  metadata.gz: 26e9b3cba968e6c88621d348efcc1bad551deca81cf97022a42c342f3bd1145162c14ccbb7faaf2d2d5b9abf9b2f469261a96b862a27abcf28b2067746e58786
-  data.tar.gz: e225a8844a45e36ed48c4e9d8139d7c743376b4c4c7655d0a6b03ef3562fa627b5abc3c17959c4ab0541477301780367f71c908706cb3db734b054bead68ca0e
+  metadata.gz: 173c89e6a3c9eb6b022b90ccc0d28c49b44331d42617e082d5fcd1380e0c2b2ad834250608a87556c9dd5e664d770009d1499a77fa002ad4270740b1069f2b44
+  data.tar.gz: 924a0d9ed141df769723ed76ab30aae9625da0f1890ab75125c94f74ca1fa9e0cb6c31b0b4f8c74d0418031890c07f6f4dad1eadedbc1424e314fff32c16bc0f

data/CHANGELOG.md

@@ -6,6 +6,12 @@ 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

data/README.md

@@ -82,7 +82,6 @@ This gem is using [Semantic Versioning](https://semver.org/). All version bumps
 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.
-1. [GraphqlFieldsNaming](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/graphql_fields_naming.rb) - Enforce the configured style when naming graphQL fields and arguments.
 
 ## Development
 

data/config/default.yml

@@ -1,12 +1,3 @@
-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`."
   Enabled: true
@@ -59,3 +50,15 @@ Ezcater/StyleDig:
 Ezcater/RubyTimeout:
   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

@@ -53,6 +53,7 @@ Gem::Specification.new do |spec|
 
   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.2"
+  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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,26 @@ dependencies:
     - - "<"
       - !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
@@ -193,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

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(msg_style)
-          format(MSG, style: msg_style)
-        end
-      end
-    end
-  end
-end