ezcater_rubocop 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c15a00ae9ee7d51e47aaf97b9fb70308b94992ce89ea2f2240a9405021b90b1
-  data.tar.gz: 80c042251192d29ff9e3fda486fbd18cdd02e9231b3ba381650488dd86a0a14e
+  metadata.gz: caa54b1bc5ab26cb7d499ac8b61e01aeb94bb82de6a7de5c125cbc4a1f4c3c0a
+  data.tar.gz: 4af52c423b5e171436383e3ee85bbfdd72ef1a80e0de7f519a88e44cf21a20ab
 SHA512:
-  metadata.gz: c0c6d395b37d422cbf0d63bd221dd1cc971da352b1af23d9b5c871e922731f8492095d2ceceea4cdb33a630b72bb7799acf69ddb4d9a1bf8046b8e587d1436d2
-  data.tar.gz: f6573e38d0e0b75df186f03941a72552854cb5f22c4fe8f488f2f013ae3d633e6b317b2d4212e22a3d706da795cd78a61ee5dd44e6632006b50fc303787f5780
+  metadata.gz: 7cc9e1d28ef7cb67418d65e16e17e5d43c850c76d3b417a4a264c30a80cb43d648ed0204441e5f612b2719daf241fea818e2aace75338106c16910345137ec56
+  data.tar.gz: 1760b6cdc245067c9d46d6ea9574b1bce15c7c2c1e0dc1b59d53f733a20ac36db2cf137697754f21992d0a76e3dc2dcfba4d11b8fa15b358b5df324523175d9f

data/CHANGELOG.md

@@ -6,20 +6,16 @@ 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`.
 
-## Unreleased
-
-- ...
+## 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.
 

data/README.md

@@ -82,6 +82,7 @@ This gem is using [Semantic Versioning](https://semver.org/). All version bumps
 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.
 
 ## Development
 

data/config/default.yml

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

data/lib/ezcater_rubocop.rb

@@ -15,6 +15,7 @@ config = RuboCop::ConfigLoader.merge_with_default(config, path)
 RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
 
 require "rubocop/cop/ezcater/direct_env_check"
+require "rubocop/cop/ezcater/graphql_fields_naming"
 require "rubocop/cop/ezcater/rails_configuration"
 require "rubocop/cop/ezcater/rails_env"
 require "rubocop/cop/ezcater/rails_top_level_sql_execute"

data/lib/ezcater_rubocop/version.rb

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

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

@@ -0,0 +1,74 @@
+# 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.loc.expression)
+        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-26 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,7 @@ files:
 - lib/ezcater_rubocop.rb
 - lib/ezcater_rubocop/version.rb
 - lib/rubocop/cop/ezcater/direct_env_check.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
@@ -190,7 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ezCater custom cops and shared configuration