rubocop-graphql 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cdf5152e0106f86e952fbf5a24a38011914f34b0167a19ef0cf53dd810e4d68
-  data.tar.gz: 9ed0ac94bdc4f323543e1085a612dfb3d02f5e60ee55892da6894b202718865e
+  metadata.gz: b6b8cbd4a0d9dec84fd66e8fd76716d4d23d1a6ce486c713a951cd6c375255dd
+  data.tar.gz: 9f7b85517392c031a54e63d9cbd28280cf41d9afb890f67f8e4054fc0704e553
 SHA512:
-  metadata.gz: 992563e33d74e91766b4917a541ef9361795156f93eb33a95f0944e4968f87a5845681adff07178a30cd11b10c6b2e10ea002e2688b2a501cc6b9e25bb1bc103
-  data.tar.gz: 2cf037f19ca63a512ea00a06601cf49dcc46ed5bb59deec1ede2e45dcd74acfd875b7febf7f703b36354fa4059dd222ca5f37fb59a11572c7cc8d4ffb97389a9
+  metadata.gz: 3474232c9c512d5b86d3c8fd43b790562b01ac458786e96c3c34a1556f530390fff21bd55a7805c382278b43d6c13cb336307b987ce070cbab01788e3c6e5194
+  data.tar.gz: f8c5fba9247ad3ce42131b4bd3ee8dfd7f623eb896ca7cce9fb6e0f6ad29c6d38ce616f877e0a5d92dedc8a7701110cd37334fd9af1cb042bcc130285fa2b7d6

data/config/default.yml

@@ -134,6 +134,8 @@ GraphQL/ObjectDescription:
   VersionAdded: '0.3.0'
   Description: 'Ensures all types have a description'
   Exclude:
+    - "spec/**/*"
+    - "test/**/*"
     - '**/*_schema.rb'
     - '**/base_*.rb'
     - '**/graphql/query_context.rb'

data/lib/rubocop/cop/graphql/argument_description.rb

@@ -22,6 +22,7 @@ module RuboCop
         include RuboCop::GraphQL::NodePattern
 
         MSG = "Missing argument description"
+        RESTRICT_ON_SEND = %i[argument].freeze
 
         def on_send(node)
           return unless argument?(node)

data/lib/rubocop/cop/graphql/argument_name.rb

@@ -20,6 +20,7 @@ module RuboCop
       #
       class ArgumentName < Base
         include RuboCop::GraphQL::NodePattern
+        RESTRICT_ON_SEND = %i[argument].freeze
 
         using RuboCop::GraphQL::Ext::SnakeCase
 

data/lib/rubocop/cop/graphql/field_definitions.rb

@@ -52,6 +52,8 @@ module RuboCop
         include RuboCop::GraphQL::Sorbet
         include RuboCop::GraphQL::Heredoc
 
+        RESTRICT_ON_SEND = %i[field].freeze
+
         # @!method field_kwargs(node)
         def_node_matcher :field_kwargs, <<~PATTERN
           (send nil? :field

data/lib/rubocop/cop/graphql/field_description.rb

@@ -22,6 +22,7 @@ module RuboCop
         include RuboCop::GraphQL::NodePattern
 
         MSG = "Missing field description"
+        RESTRICT_ON_SEND = %i[field].freeze
 
         def on_send(node)
           return unless field_definition?(node)

data/lib/rubocop/cop/graphql/field_hash_key.rb

@@ -41,6 +41,7 @@ module RuboCop
         PATTERN
 
         MSG = "Use hash_key: %<hash_key>p"
+        RESTRICT_ON_SEND = %i[field].freeze
 
         def on_send(node)
           return unless field_definition?(node)

data/lib/rubocop/cop/graphql/field_method.rb

@@ -40,6 +40,7 @@ module RuboCop
         PATTERN
 
         MSG = "Use method: :%<method_name>s"
+        RESTRICT_ON_SEND = %i[field].freeze
 
         def on_send(node)
           return unless field_definition?(node)

data/lib/rubocop/cop/graphql/field_name.rb

@@ -29,6 +29,7 @@ module RuboCop
         using RuboCop::GraphQL::Ext::SnakeCase
 
         MSG = "Use snake_case for field names"
+        RESTRICT_ON_SEND = %i[field].freeze
 
         def on_send(node)
           return unless field_definition?(node)

data/lib/rubocop/cop/graphql/field_uniqueness.rb

@@ -63,9 +63,16 @@ module RuboCop
         end
 
         def field_name(node)
-          node.first_argument.value.to_s
+          field = RuboCop::GraphQL::Field.new(node)
+
+          "#{field.name}#{':non-camelized' if false_value?(field.kwargs.camelize)}"
         end
 
+        # @!method false_value?(node)
+        def_node_matcher :false_value?, <<~PATTERN
+          (pair ... false)
+        PATTERN
+
         # @!method field_declarations(node)
         def_node_search :field_declarations, <<~PATTERN
           {

data/lib/rubocop/cop/graphql/legacy_dsl.rb

@@ -32,6 +32,7 @@ module RuboCop
 
         MSG = "Avoid using legacy based type-based definitions. " \
               "Use class-based definitions instead."
+        RESTRICT_ON_SEND = %i[define].freeze
 
         def on_send(node)
           return unless node.parent.block_type?

data/lib/rubocop/cop/graphql/multiple_field_definitions.rb

@@ -32,6 +32,8 @@ module RuboCop
         include RuboCop::Cop::RangeHelp
         include RuboCop::GraphQL::Heredoc
 
+        RESTRICT_ON_SEND = %i[field].freeze
+
         def on_send(node)
           return unless field?(node)
 

data/lib/rubocop/cop/graphql/not_authorized_node_type.rb

@@ -10,6 +10,9 @@ module RuboCop
       # If `.authorized?` is defined in a parent class, you can add parent to the "SafeBaseClasses"
       # to avoid offenses in children.
       #
+      # This cop also checks the `can_can_action` or `pundit_role` methods that
+      # can be used as part of the Ruby GraphQL Pro.
+      #
       # @example
       #   # good
       #
@@ -37,6 +40,26 @@ module RuboCop
       #     end
       #   end
       #
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     implements GraphQL::Types::Relay::Node
+      #
+      #     pundit_role :staff
+      #
+      #     field :uuid, ID, null: false
+      #   end
+      #
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     implements GraphQL::Types::Relay::Node
+      #
+      #     can_can_action :staff
+      #
+      #     field :uuid, ID, null: false
+      #   end
+      #
       #   # bad
       #
       #   class UserType < BaseType
@@ -48,11 +71,6 @@ module RuboCop
       class NotAuthorizedNodeType < Base
         MSG = ".authorized? should be defined for types implementing Node interface."
 
-        # @!method class_name(node)
-        def_node_matcher :class_name, <<~PATTERN
-          (const nil? $_)
-        PATTERN
-
         # @!method implements_node_type?(node)
         def_node_matcher :implements_node_type?, <<~PATTERN
           `(send nil? :implements
@@ -62,25 +80,53 @@ module RuboCop
                   (const nil? :GraphQL) :Types) :Relay) :Node))
         PATTERN
 
+        # @!method has_can_can_action?(node)
+        def_node_matcher :has_can_can_action?, <<~PATTERN
+          `(send nil? :can_can_action {nil_type? sym_type?})
+        PATTERN
+
+        # @!method has_pundit_role?(node)
+        def_node_matcher :has_pundit_role?, <<~PATTERN
+          `(send nil? :pundit_role {nil_type? sym_type?})
+        PATTERN
+
         # @!method has_authorized_method?(node)
         def_node_matcher :has_authorized_method?, <<~PATTERN
           {`(:defs (:self) :authorized? ...) | `(:sclass (:self) `(:def :authorized? ...))}
         PATTERN
 
+        def on_module(node)
+          @parent_modules ||= []
+          @parent_modules << node.child_nodes[0].const_name
+        end
+
         def on_class(node)
-          return if ignored_class?(parent_class(node))
+          @parent_modules ||= []
+          return if possible_parent_classes(node).any? { |klass| ignored_class?(klass) }
+
+          @parent_modules << node.child_nodes[0].const_name
 
-          add_offense(node) if implements_node_type?(node) && !has_authorized_method?(node)
+          add_offense(node) if implements_node_type?(node) && !implements_authorization?(node)
         end
 
         private
 
-        def parent_class(node)
-          node.child_nodes[1]
+        def implements_authorization?(node)
+          has_authorized_method?(node) || has_can_can_action?(node) || has_pundit_role?(node)
+        end
+
+        def possible_parent_classes(node)
+          klass = node.child_nodes[1].const_name
+
+          return [] if klass.nil?
+          return [klass] if node.child_nodes[1].absolute?
+
+          parent_module = "#{@parent_modules.join('::')}::"
+          [klass, parent_module + klass]
         end
 
-        def ignored_class?(node)
-          cop_config["SafeBaseClasses"].include?(String(class_name(node)))
+        def ignored_class?(klass)
+          cop_config["SafeBaseClasses"].include?(klass)
         end
       end
     end

data/lib/rubocop/cop/graphql/prepare_method.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GraphQL
+      # Checks that GraphQL Argument definitions prepare arguments use String or constants
+      # instead of `prepare: CONST_REF`
+      # This allows better Sorbet typing.
+      #
+      # Preference is given to an input object declaring a `def prepare(...); end` method
+      #
+      # @example
+      #   # bad
+      #   PREPARE = ->(input, context) { ... }
+      #
+      #   argument :input, prepare: PREPARE
+      #
+      #   # good
+      #   def input_prepare(input); ...; end
+      #
+      #   argument :input, prepare: :input_prepare
+      #
+      class PrepareMethod < RuboCop::Cop::Base
+        extend AutoCorrector
+        GENERAL_MSG = "Avoid using prepare lambdas, use prepare: :method_name or "\
+          "prepare: \"method_name\" instead."
+        STRING_MSG = "Avoid using prepare lambdas, use prepare: \"method_name\" instead."
+        PREFER_STRING_MSG = "Avoid using prepare symbols, use prepare: \"%s\" instead."
+        SYMBOL_MSG = "Avoid using prepare lambdas, use prepare: :method_name instead."
+        PREFER_SYMBOL_MSG = "Avoid using prepare string, use prepare: :%s instead."
+
+        ARGUMENT_METHODS = Set[:argument, :public_argument].freeze
+
+        # @!method graphql_argument_with_prepare_block?(node)
+        def_node_matcher :graphql_argument_with_prepare_block?, <<~PATTERN
+          (send nil? ARGUMENT_METHODS ... (hash ... (pair (sym :prepare) $({ const | block } ...) )))
+        PATTERN
+
+        # @!method prepare_method_string_name?(node)
+        def_node_matcher :prepare_method_string_name?, <<~PATTERN
+          (send nil? ARGUMENT_METHODS ... (hash ... (pair (sym :prepare) $(str ...) )))
+        PATTERN
+
+        # @!method prepare_method_symbol_name?(node)
+        def_node_matcher :prepare_method_symbol_name?, <<~PATTERN
+          (send nil? ARGUMENT_METHODS ... (hash ... (pair (sym :prepare) $(sym ...) )))
+        PATTERN
+
+        def on_send(node)
+          type = cop_config["EnforcedStyle"]
+
+          message = case type
+                    when "symbol"
+                      SYMBOL_MSG
+                    when "string"
+                      STRING_MSG
+                    else
+                      GENERAL_MSG
+                    end
+          graphql_argument_with_prepare_block?(node) do |prepare_definition|
+            add_offense(prepare_definition, message: message)
+          end
+
+          if type == "symbol"
+            prepare_method_string_name?(node) do |prepare_definition|
+              method_name = prepare_definition.value
+              add_offense(prepare_definition,
+                          message: format(PREFER_SYMBOL_MSG, method_name)) do |corrector|
+                autocorrect(corrector, node, "\"#{method_name}\"", ":#{method_name}")
+              end
+            end
+          elsif type == "string"
+            prepare_method_symbol_name?(node) do |prepare_definition|
+              method_name = prepare_definition.value
+              add_offense(prepare_definition,
+                          message: format(PREFER_STRING_MSG, method_name)) do |corrector|
+                autocorrect(corrector, node, ":#{method_name}", "\"#{method_name}\"")
+              end
+            end
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node, original_method_name, new_method_name)
+          new_source = node.source.sub("prepare: #{original_method_name}",
+                                       "prepare: #{new_method_name}")
+          corrector.replace(node, new_source)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/graphql/unnecessary_argument_camelize.rb

@@ -44,6 +44,7 @@ module RuboCop
         include RuboCop::GraphQL::NodePattern
 
         MSG = "Unnecessary argument camelize"
+        RESTRICT_ON_SEND = %i[argument].freeze
 
         def on_send(node)
           return unless argument?(node)

data/lib/rubocop/cop/graphql/unnecessary_field_alias.rb

@@ -25,6 +25,7 @@ module RuboCop
         include RuboCop::GraphQL::NodePattern
 
         MSG = "Unnecessary :%<kwarg>s configured"
+        RESTRICT_ON_SEND = %i[field].freeze
 
         def on_send(node)
           return unless field_definition?(node)
@@ -34,7 +35,7 @@ module RuboCop
           if (unnecessary_kwarg = validate_kwargs(field))
             message = format(self.class::MSG, kwarg: unnecessary_kwarg)
             add_offense(node, message: message) do |corrector|
-              kwarg_node = node.arguments.last.pairs.find do |pair|
+              kwarg_node = node.last_argument.pairs.find do |pair|
                 pair.key.value == unnecessary_kwarg.to_sym
               end
               corrector.remove_preceding(kwarg_node, 2)

data/lib/rubocop/cop/graphql/unnecessary_field_camelize.rb

@@ -22,6 +22,7 @@ module RuboCop
         include RuboCop::GraphQL::NodePattern
 
         MSG = "Unnecessary field camelize"
+        RESTRICT_ON_SEND = %i[field].freeze
 
         def on_send(node)
           return unless field_definition?(node)

data/lib/rubocop/cop/graphql/unused_argument.rb

@@ -132,7 +132,7 @@ module RuboCop
 
           add_offense(node, message: message) do |corrector|
             if node.arguments?
-              corrector.insert_after(arg_end(node.arguments.last), ", #{unresolved_args_source}")
+              corrector.insert_after(arg_end(node.last_argument), ", #{unresolved_args_source}")
             else
               corrector.insert_after(method_name(node), "(#{unresolved_args_source})")
             end

data/lib/rubocop/cop/graphql_cops.rb

@@ -21,6 +21,7 @@ require_relative "graphql/resolver_method_length"
 require_relative "graphql/object_description"
 require_relative "graphql/ordered_arguments"
 require_relative "graphql/ordered_fields"
+require_relative "graphql/prepare_method"
 require_relative "graphql/unused_argument"
 require_relative "graphql/unnecessary_argument_camelize"
 require_relative "graphql/unnecessary_field_alias"

data/lib/rubocop/graphql/argument/block.rb

@@ -12,7 +12,7 @@ module RuboCop
           (block
             (send nil? :argument ...)
             (args ...)
-            $...
+            {(begin $...)|$...}
           )
         PATTERN
 

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "1.3.0".freeze
+    VERSION = "1.5.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.87'
+        version: '0.90'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -68,7 +68,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.87'
+        version: '0.90'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -104,6 +104,7 @@ files:
 - lib/rubocop/cop/graphql/object_description.rb
 - lib/rubocop/cop/graphql/ordered_arguments.rb
 - lib/rubocop/cop/graphql/ordered_fields.rb
+- lib/rubocop/cop/graphql/prepare_method.rb
 - lib/rubocop/cop/graphql/resolver_method_length.rb
 - lib/rubocop/cop/graphql/unnecessary_argument_camelize.rb
 - lib/rubocop/cop/graphql/unnecessary_field_alias.rb