ezcater_rubocop 0.49.3 → 0.49.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 287e541c5f186427bfc57b726752e5d4408aa824
-  data.tar.gz: 9bc958aef437ee556c7647a8f8d147cc2787cc35
+  metadata.gz: b1eebe376c776e260d533d0ed1df2af63fea9bd3
+  data.tar.gz: 8152ea09ee64ece4592a5bd03f8e03c45530de30
 SHA512:
-  metadata.gz: 20ab3901dd6dc56de4371de61a42107df8f7a8eb4ce0ebc647dd6722f5f2e5e35667b8e8a711b0c40158f2e51a23ba4667db32626669054efbe308ae2c73435c
-  data.tar.gz: 9f39db662304bf6b2fae9b2155708dd5b76b1528b0c9abaf8c09b639a4704fcda80ee1a474a5c3e6837598d1c95d8eb37977ccad091ff6d69af85a3c60adf5bf
+  metadata.gz: 07b710a2d92db3db77b6eb9bdc2fd5c1b615f97d4356ee2af26ab0e176e93770db146efb3ae08e0cf532e08cd4355d7c1619179b580658fcc8f5b8baaff8dfd6
+  data.tar.gz: 93047bd242a44230b4d30e78dcb27ac32580eafcd767b9c6b1128500a620b8a5f008c28012f5ffea2726121ff903251d96d4cf851a7456d9f06d53c55f2542af

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # ezcater_rubocop
 
+# v0.49.4
+- Add `Ezcater/RspecRequireGqlErrorHelpers` cop.
+
 # v0.49.3
 - Do not apply `Ezcater/StyleDig` to access using a range.
 

data/README.md

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

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

@@ -14,5 +14,6 @@ RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
 
 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.49.3".freeze
+  VERSION = "0.49.4".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, :expression, 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.49.3
+  version: 0.49.4
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,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
@@ -159,7 +160,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