rubocop-mable 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11f4a0980ecdeb9bd5423be381dd7a644af6c9d6b88588ea3c19142103d07f15
-  data.tar.gz: 9b7b498e693680865f1c195913feb385c6d125cee1ad92869aaa327b1f6d8e69
+  metadata.gz: 4b59a5fc99bec56362c41b540f37058dabfc1e16b3ac9bb6db72c64f5f16495f
+  data.tar.gz: 60135942aab111fa27f46225f839edbcca834e97e37737cc303774496c1febfc
 SHA512:
-  metadata.gz: 8bd1daf2d6d0e8e11ae71e6a0827c43b3a2e4f2600ad37e5fad6836189eb0ad23bd11db73872a52a07035b944d0cded9bd1d1159bf5bfac9b3fdcfec3a12cc06
-  data.tar.gz: 765c60614e41af4a95e45c2136ab5464b68d2ecb5d21ebebab6e3b0dfa2f93737756f659db49893eee21c0bedd35e722fd97350ac853db6373ffff58bc144be0
+  metadata.gz: 97a1ae86f7a089288e6444b50ac1eccfb5e04457c4155b5bab6f34c0a8388ff36528e9f0dba95130c574525af2eca8d0cf8a72ab09c7b249d7054b05985a2ce4
+  data.tar.gz: f527513322bef9827c28b64100e3eae9c413ec559b77b049579cc4683923b54a4ed2756159cdb289d2370c49957bc144d78efc06c9964f6acc628c28035ca581

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-mable (0.1.4)
+    rubocop-mable (0.1.5)
       rubocop
 
 GEM

data/README.md

@@ -6,6 +6,12 @@ Mable's custom Rubocop cops
 
 ```
 
+Mable/NoWardenInGraphQL:
+  Description: "No Warden in graphQL use helper method instead see - Mable/NoPostInGraphQL"
+  Enabled: true
+  SafeAutoCorrect: false
+  VersionAdded: "0.1.5"
+
 Mable/NoPostInGraphQL:
 Description: "Use graphQL helper method instead of use rails/rack request stack"
 Enabled: true

data/config/default.yml

@@ -22,3 +22,9 @@ Mable/NoPostInGraphQL:
   AllowedGraphQLPaths:
     - "/graphql"
     - "graphql_path"
+
+Mable/NoWardenInGraphQL:
+  Description: "No Warden in graphQL use helper method instead see - Mable/NoPostInGraphQL"
+  Enabled: true
+  SafeAutoCorrect: false
+  VersionAdded: "0.1.5"

data/lib/rubocop/cop/mable/no_warden_in_graph_ql.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Mable
+      # This cop checks for the usage of Warden::Test::Helpers and related
+      # methods within GraphQL specs. It disallows the use of Warden.test_mode!,
+      # login_as, and user.reload.
+      #
+      # @safety
+      #   Unsafe as requires graphql helper method to replace
+      #
+      # @example
+      #   # bad
+      #   Warden.test_mode!
+      #   login_as(user)
+      #   user.reload
+      #   include Warden::Test::Helpers
+      #
+      #   # good
+      #   # Use graphql helper method
+      class NoWardenInGraphQL < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Do not use `%<method>s` in GraphQL specs. Use graphql helper method instead.'
+
+        RESTRICT_ON_SEND = %i[test_mode! login_as reload].freeze
+        RESTRICT_ON_INCLUDE = %i[Warden::Test::Helpers].freeze
+
+        def_node_search :rspec_describe_graphql?, <<~PATTERN
+          (block
+            (send (const nil? :RSpec) :describe
+              (const { (const nil? {:Graphql :Queries :Mutations}) } _)
+              ...)
+            ...)
+        PATTERN
+
+        def_node_matcher :user_reload?, <<~PATTERN
+          (send
+            (send _ :user) :reload)
+        PATTERN
+
+        def on_send(node)
+          return unless in_graphql?(node) && bad_method?(node)
+
+          method_name = node.method_name
+          add_offense(node, message: format(MSG, method: method_name)) do |corrector|
+            correct_offense(corrector, node)
+          end
+        end
+
+        def on_const(node)
+          return unless in_graphql?(node) && bad_include?(node)
+
+          add_offense(node, message: format(MSG, method: 'include Warden::Test::Helpers')) do |corrector|
+            correct_offense(corrector, node)
+          end
+        end
+
+        private
+
+        def in_graphql?(node)
+          node.each_ancestor(:block).any? do |ancestor|
+            rspec_describe_graphql?(ancestor)
+          end
+        end
+
+        def bad_method?(node)
+          if node.method_name == :reload
+            user_reload?(node)
+          else
+            RESTRICT_ON_SEND.include?(node.method_name)
+          end
+        end
+
+        def bad_include?(node)
+          RESTRICT_ON_INCLUDE.include?(node.const_name.to_sym)
+        end
+
+        def correct_offense(corrector, node)
+          if node.send_type? && bad_method?(node)
+            corrector.remove(range_with_comments_and_lines(node))
+          elsif node.const_type? && node.const_name == 'Warden::Test::Helpers'
+            corrector.remove(range_with_comments_and_lines(node.parent))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mable_cops.rb

@@ -4,3 +4,4 @@ require_relative 'mable/graph_ql_helper_specs'
 require_relative 'mable/hardcoded_database_factory_bot_id'
 require_relative 'mable/no_post_in_graph_ql'
 require_relative 'mable/no_safety_assured'
+require_relative 'mable/no_warden_in_graph_ql'

data/lib/rubocop/mable/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Mable
-    VERSION = '0.1.4'
+    VERSION = '0.1.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-mable
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mable Engineers
@@ -61,6 +61,7 @@ files:
 - lib/rubocop/cop/mable/hardcoded_database_factory_bot_id.rb
 - lib/rubocop/cop/mable/no_post_in_graph_ql.rb
 - lib/rubocop/cop/mable/no_safety_assured.rb
+- lib/rubocop/cop/mable/no_warden_in_graph_ql.rb
 - lib/rubocop/cop/mable_cops.rb
 - lib/rubocop/mable.rb
 - lib/rubocop/mable/inject.rb