rubocop-mable 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 402b8f356986fdfa523dcecccf1b2fb74f4a9c6ce34c191db74d1b839f00058b
-  data.tar.gz: 1e671dd68702a88b13eb3b0fe39954a710f5422e3c13d3c331424f2ab5fa9b17
+  metadata.gz: 11f4a0980ecdeb9bd5423be381dd7a644af6c9d6b88588ea3c19142103d07f15
+  data.tar.gz: 9b7b498e693680865f1c195913feb385c6d125cee1ad92869aaa327b1f6d8e69
 SHA512:
-  metadata.gz: c261761ae3726394462842ff37774f47984567e66c3152e7a86a6d960b15c15251a660c5f53e949bb2b4669e76aa1344b4d3eaea82c410d9cc19bbd83a088a19
-  data.tar.gz: 6d07e483bc9da12e4d7875d12673cbf05401ffaaadb76db3cb42d226d467e7f19bf04bd39d77a19e2a206b8733649dedbbd9e77804691db12c6660ad7ec9ed50
+  metadata.gz: 8bd1daf2d6d0e8e11ae71e6a0827c43b3a2e4f2600ad37e5fad6836189eb0ad23bd11db73872a52a07035b944d0cded9bd1d1159bf5bfac9b3fdcfec3a12cc06
+  data.tar.gz: 765c60614e41af4a95e45c2136ab5464b68d2ecb5d21ebebab6e3b0dfa2f93737756f659db49893eee21c0bedd35e722fd97350ac853db6373ffff58bc144be0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-mable (0.1.3)
+    rubocop-mable (0.1.4)
       rubocop
 
 GEM
@@ -56,6 +56,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  ruby
 
 DEPENDENCIES
   pry

data/README.md

@@ -5,20 +5,32 @@ Mable's custom Rubocop cops
 ## Cops
 
 ```
+
+Mable/NoPostInGraphQL:
+Description: "Use graphQL helper method instead of use rails/rack request stack"
+Enabled: true
+VersionAdded: "0.1.4"
+ReplacePostWith: "make_graphql_request"
+SafeAutoCorrect: false
+AllowedGraphQLPaths:
+  - "/graphql"
+  - " graphql_path"
+
 Mable/NoSafetyAssured:
-  Description: 'An extra check to ensure that the safety_assured is required'
-  Enabled: true
-  VersionAdded: '0.1.3'
+Description: 'An extra check to ensure that the safety_assured is required'
+Enabled: true
+VersionAdded: '0.1.3'
 
 Mable/GraphQLHelperSpecs:
-  Description: 'Avoid hardcoding GraphQl path use helper instead.'
-  Enabled: true
-  VersionAdded: '0.1.2'
+Description: 'Avoid hardcoding GraphQl path use helper instead.'
+Enabled: true
+VersionAdded: '0.1.2'
 
 Mable/HardcodedDatabaseFactoryBotId:
-  Enabled: true
-  Description: 'Avoid hardcoding factory bot database IDs, instead, dynamically test for the ID'
-  VersionAdded: '0.1.1'
+Enabled: true
+Description: 'Avoid hardcoding factory bot database IDs, instead, dynamically test for the ID'
+VersionAdded: '0.1.1'
+
 ```
 
 ## Installation

data/config/default.yml

@@ -1,14 +1,24 @@
 Mable/GraphQLHelperSpecs:
-  Description: 'Avoid hardcoding GraphQl path use helper instead.'
+  Description: "Avoid hardcoding GraphQl path use helper instead."
   Enabled: true
-  VersionAdded: '0.1.2'
+  VersionAdded: "0.1.2"
 
 Mable/HardcodedDatabaseFactoryBotId:
   Enabled: true
-  Description: 'Avoid hardcoding factory bot database IDs, instead, dynamically test for the ID'
-  VersionAdded: '0.1.1'
+  Description: "Avoid hardcoding factory bot database IDs, instead, dynamically test for the ID"
+  VersionAdded: "0.1.1"
 
 Mable/NoSafetyAssured:
-  Description: 'An extra check to ensure that the safety_assured is required'
+  Description: "An extra check to ensure that the safety_assured is required"
   Enabled: true
-  VersionAdded: '0.1.3'
+  VersionAdded: "0.1.3"
+
+Mable/NoPostInGraphQL:
+  Description: "Use graphQL helper method instead of use rails/rack request stack"
+  Enabled: true
+  VersionAdded: "0.1.4"
+  ReplacePostWith: "make_graphql_request"
+  SafeAutoCorrect: false
+  AllowedGraphQLPaths:
+    - "/graphql"
+    - "graphql_path"

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Mable
+      # Enforces using a direct helper method over `post` for executing GraphQL queries,
+      # incorporating user authentication context when applicable.
+      #
+      # @safety
+      #   The cop is unsafe as user might not exist or not be called user.
+      #
+      # @example
+      #
+      #   # bad
+      #   post graphql_path, params: { query: my_query, variables: my_variables }, as: :json
+      #
+      #   # good
+      #   execute_graphql(query: my_query, variables: my_variables, user: current_user)
+      #
+      class NoPostInGraphQL < Base
+        extend AutoCorrector
+
+        MSG = "Use 'ReplacePostWith' default: `make_graphql_request` directly instead of `post` for GraphQL requests, incorporating user context."
+
+        RESTRICT_ON_SEND = %i[post].freeze
+
+        def_node_matcher :post_graphql?, <<~PATTERN
+          (send nil? :post
+            ({str | send nil?} $_)        # Optional first argument (string path)
+            (hash
+              (pair
+                (sym :params)
+                (hash
+                  (pair (sym :query) _)
+                  (pair (sym :variables) _)? # Optional :variables pair
+                )
+              )
+            )
+          )
+        PATTERN
+
+        def_node_search :rspec_block?, <<~PATTERN
+          (block (send (const nil? :RSpec) {:describe :context :it} ...) ...)
+        PATTERN
+
+        def on_send(node)
+          post_graphql?(node) do |path|
+            handle_post_graphql(node) if graphql_path_allowed?(path)
+          end
+        end
+
+        private
+
+        def graphql_path_allowed?(path)
+          allowed_paths = cop_config['AllowedGraphQLPaths'] || []
+          allowed_paths.include?(path.to_s)
+        end
+
+        def handle_post_graphql(node)
+          return unless within_rspec_block?(node)
+
+          # Check if the method is `post` and it includes `params:`
+          params_pair = node.arguments.find do |arg|
+            arg.hash_type? && arg.pairs.any? { |pair| pair.key.sym_type? && pair.key.value == :params }
+          end
+
+          return unless params_pair
+
+          # Access pairs directly from params_pair
+          params_hash = params_pair.pairs.find { |pair| pair.key.value == :params }.value
+
+          return unless params_hash.hash_type?
+
+          query_pair = params_hash.pairs.find { |p| p.key.value == :query }
+          variables_pair = params_hash.pairs.find { |p| p.key.value == :variables }
+
+          query = query_pair&.value&.source
+          variables = variables_pair&.value&.source
+
+          replacement = cop_config['ReplacePostWith']
+          execute_call = "#{replacement}(query: #{query}"
+          execute_call += ', user: user'
+          execute_call += ", variables: #{variables}" if variables
+          execute_call += ')'
+
+          add_offense(node) do |corrector|
+            corrector.replace(node.loc.expression, execute_call)
+          end
+        end
+
+        def within_rspec_block?(node)
+          node.each_ancestor.any? { |ancestor| rspec_block?(ancestor) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mable_cops.rb

@@ -2,4 +2,5 @@
 
 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'

data/lib/rubocop/mable/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-mable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Mable Engineers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -59,6 +59,7 @@ files:
 - lib/rubocop-mable.rb
 - lib/rubocop/cop/mable/graph_ql_helper_specs.rb
 - 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_cops.rb
 - lib/rubocop/mable.rb
@@ -73,7 +74,7 @@ metadata:
   homepage_uri: https://github.com/rubocop-mable
   source_code_uri: https://github.com/bettercaring/rubocop-mable
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Mable's custom rubocop cops
 test_files: []