ezcater_rubocop 0.51.4 → 0.51.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 533086d512870d79f36bab5edde478a041a32c13
-  data.tar.gz: 317c614d1530561d6d21b9f682acf5171a8f389a
+  metadata.gz: 2e1e4b74af46fc4543ab92ab20a575118a881c72
+  data.tar.gz: 864de83177e58cdcb3af668d6e10feb53dd1f2ae
 SHA512:
-  metadata.gz: ae0fb1e7daa7b2ac3a2f251fe961b0af2d5c41355de2505e6857b53e38244ea80dc76248c74aa127cabd9e9deebb398fd4db541da257218df8c560d5d0338a04
-  data.tar.gz: 4e0247ac0a40198c7dcff2fe98159220526e61fe11a759023e87c33e86d32c1ebca188fccc5cb5b04a822101af6e1ff0d399fe0d75fb54aea6ab4f804bc53406
+  metadata.gz: 3efb0a9492f109fa603cab846955dcf90265b3c0f93213ecba47dbc63cf0ec4ca95691aa69f30ea423130be54d3b8010e3951343de43b17567125045a4d72cf3
+  data.tar.gz: d3bb33303ea534109ff12c212ac32cfc70282a364f2bfb49328a6358f06cb5474a226655dea568d1e93e2e8edb4e0e122568ca98f1e0b4e5b5284e8d95fa161f

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # ezcater_rubocop
 
+## 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`.

data/README.md

@@ -86,6 +86,7 @@ is updated.
 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>" for example group description.
 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. [RspecRequireGqlErrorHelpers](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_require_gql_error_helpers.rb) - Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly.
 1. [StyleDig](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/style_dig.rb) - Recommend `dig` for deeply nested access.
 
 ## Development

data/config/default.yml

@@ -20,6 +20,10 @@ Ezcater/RspecRequireFeatureFlagMock:
   Include:
     - '**/*_spec.rb'
 
+Ezcater/RspecRequireGqlErrorHelpers:
+  Description: 'Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly.'
+  Enabled: true
+
 Ezcater/StyleDig:
   Description: 'Recommend `dig` for deeply nested access.'
   Enabled: true

data/lib/ezcater_rubocop.rb

@@ -15,5 +15,6 @@ RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
 require "rubocop/cop/ezcater/private_attr"
 require "rubocop/cop/ezcater/rspec_require_browser_mock"
 require "rubocop/cop/ezcater/rspec_require_feature_flag_mock"
+require "rubocop/cop/ezcater/rspec_require_gql_error_helpers"
 require "rubocop/cop/ezcater/rspec_dot_not_self_dot"
 require "rubocop/cop/ezcater/style_dig"

data/lib/ezcater_rubocop/version.rb

@@ -1,3 +1,3 @@
 module EzcaterRubocop
-  VERSION = "0.51.4".freeze
+  VERSION = "0.51.5".freeze
 end

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

@@ -0,0 +1,35 @@
+module RuboCop
+  module Cop
+    module Ezcater
+      # Enforce use of GQLErrors helpers instead of throwing
+      # GraphQL::ExecutionErrors directly
+      #
+      # @example
+      #
+      #   # good
+      #   GQLErrors.summary_error("An error occurred")
+      #   GQLErrors.request_error("You can't access this", 401)
+      #   GQLErrors.field_error("is invalid", :first_name, "First Name")
+      #   GQLErrors.field_errors_for(my_model, context)
+      #   GQLErrors.field_errors_for(my_model, context, summary_error: "An error occurred")
+      #   GQLErrors.field_errors_for(my_model, context, field_mapping: { first: :first_name })
+      #
+      #   # bad
+      #   GraphQL::ExecutionError.new("An error occurred")
+      #   GraphQL::ExecutionError.new("You can't access this", options: { status_code: 401 })
+      class RspecRequireGqlErrorHelpers < Cop
+        MSG = "Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly.".freeze
+
+        def_node_matcher :graphql_const?, <<~PATTERN
+          (const (const _ :GraphQL) :ExecutionError)
+        PATTERN
+
+        def on_const(node)
+          return unless graphql_const?(node)
+
+          add_offense(node, location: :expression, message: MSG)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.51.4
+  version: 0.51.5
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb
 - lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb
 - lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb
+- lib/rubocop/cop/ezcater/rspec_require_gql_error_helpers.rb
 - lib/rubocop/cop/ezcater/style_dig.rb
 - lib/rubocop/rspec/language/each_selector.rb
 homepage: https://github.com/ezcater/ezcater_rubocop
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: ezCater custom cops and shared configuration