rubocop-graphql 0.14.5 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4b8fdbb39f5e0bea2bbcce54cdd520480f1e412a2b3c5ce549b7c37a5e2cbb
-  data.tar.gz: 5e6065465cad8df870476977d0b9e4ac64869c27a4247570c5d6d6d56bb32577
+  metadata.gz: 07b20077b6c0a6ec0ff0aa58528140efd701a90c3059c2483b213ea9039dfe35
+  data.tar.gz: 7f2e405ea2241a8f6d918577e75bfe523125700ed48441d434a1e671d1a93e56
 SHA512:
-  metadata.gz: 267c257092e56d804772fa9f58e0e657151348758d80b7b453b07c00e0aa33651b61f326424822f2fcc272dacff45a245820c3a9eea8bbe00e344ed6ff17bc83
-  data.tar.gz: badf0bbcdefc806c43cdc60defadf002cfc645dfb6c2f6bf6609b444c18cd9c13bb81b4a4c48eebf3ae25ffbdaf477678d6807349133866098736387d483df90
+  metadata.gz: 4ac7dc1b72346ef4f42d6739b1c0c9a10b35a80ab5b9421c937a3673d755384a15d06f5e358e88f1a4a29e426e7e2eea41e6e54634a76b8cf8dfeb34ea3a84ca
+  data.tar.gz: 68aa6accd90828a337828ba69f7e7d42bd5034644762cf83021a71352cfd3a8c7292934a3da2d30b1522a7055502ee49cd7c6ed7abcf6590a6a7b00062847eb7

data/config/default.yml

@@ -38,6 +38,10 @@ GraphQL/FieldDefinitions:
     - group_definitions
     - define_resolver_after_definition
 
+GraphQL/MultipleFieldDefinitions:
+  Enabled: true
+  Description: 'Ensures that fields with multiple definitions are grouped together'
+
 GraphQL/FieldDescription:
   Enabled: true
   VersionAdded: '0.80'
@@ -109,5 +113,3 @@ GraphQL/OrderedFields:
 GraphQL/UnusedArgument:
   Enabled: true
   Description: 'Arguments should either be listed explicitly or **rest should be in the resolve signature'
-
-

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

@@ -80,7 +80,7 @@ module RuboCop
 
           is_field_block = node.block_type? &&
                            node.respond_to?(:method_name) &&
-                           node.method_name == :field
+                           node.method?(:field)
 
           return field_name(node.parent) unless is_field_block
 
@@ -93,6 +93,7 @@ module RuboCop
           "`#{first_argument.value}`"
         end
 
+        # @!method argument_declarations(node)
         def_node_search :argument_declarations, <<~PATTERN
           (send nil? :argument (:sym _) ...)
         PATTERN

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module GraphQL
       class ExtractInputType < Base
-        # This cop checks fields on common prefix groups
+        # Checks fields on common prefix groups
         #
         # # @example
         #   # good

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module GraphQL
       class ExtractType < Base
-        # This cop checks fields on common prefix groups
+        # Checks fields on common prefix groups
         #
         # # @example
         #   # good

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module GraphQL
-      # This cop checks consistency of field definitions
+      # Checks consistency of field definitions
       #
       # EnforcedStyle supports two modes:
       #
@@ -52,6 +52,7 @@ module RuboCop
         include RuboCop::GraphQL::Sorbet
         include RuboCop::GraphQL::Heredoc
 
+        # @!method field_kwargs(node)
         def_node_matcher :field_kwargs, <<~PATTERN
           (send nil? :field
             ...
@@ -62,8 +63,9 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return if !field_definition?(node) || style != :define_resolver_after_definition
+          return if !field?(node) || style != :define_resolver_after_definition
 
+          node = node.parent if field_definition_with_body?(node.parent)
           field = RuboCop::GraphQL::Field.new(node)
           check_resolver_is_defined_after_definition(field)
         end
@@ -113,7 +115,10 @@ module RuboCop
           "sharing resolver method."
 
         def check_resolver_is_defined_after_definition(field)
-          return if field.kwargs.resolver || field.kwargs.method || field.kwargs.hash_key
+          multiple_definitions = multiple_definitions(field)
+          return if field.node != multiple_definitions.last
+
+          return if field_has_no_resolver_method(field)
 
           method_definition = field.schema_member.find_method_definition(field.resolver_method_name)
           return unless method_definition
@@ -124,11 +129,25 @@ module RuboCop
           return if resolver_defined_after_definition?(field, method_definition)
 
           add_offense(field.node,
-                      message: offense_message(fields_with_same_resolver.one?)) do |corrector|
+                      message: offense_message(
+                        fields_with_same_resolver.one? && multiple_definitions.size == 1
+                      )) do |corrector|
             place_resolver_after_field_definition(corrector, field.node)
           end
         end
 
+        def field_has_no_resolver_method(field)
+          field.kwargs.resolver || field.kwargs.method || field.kwargs.hash_key
+        end
+
+        def multiple_definitions(field)
+          field.schema_member.body.select { |node| field?(node) && field_name(node) == field.name }
+        end
+
+        def field_name(node)
+          RuboCop::GraphQL::Field.new(node).name
+        end
+
         def offense_message(single_field_using_resolver)
           single_field_using_resolver ? RESOLVER_AFTER_FIELD_MSG : RESOLVER_AFTER_LAST_FIELD_MSG
         end
@@ -156,10 +175,7 @@ module RuboCop
         def fields_with_same_resolver(field, resolver)
           fields = field.schema_member.body
                         .select { |node| field?(node) }
-                        .map do |node|
-                          field = field_definition_with_body?(node) ? node.children.first : node
-                          RuboCop::GraphQL::Field.new(field)
-                        end
+                        .map { |node| RuboCop::GraphQL::Field.new(node) }
 
           [].tap do |fields_with_same_resolver|
             fields.each do |field|

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

@@ -28,6 +28,7 @@ module RuboCop
         include RuboCop::GraphQL::NodePattern
         include RuboCop::Cop::RangeHelp
 
+        # @!method hash_key_to_use(node)
         def_node_matcher :hash_key_to_use, <<~PATTERN
           (def
             _
@@ -50,7 +51,7 @@ module RuboCop
           suggested_hash_key_name = hash_key_to_use(method_definition)
 
           return if suggested_hash_key_name.nil?
-          return if RuboCop::GraphQL::Field::CONFLICT_FIELD_NAMES.include?(suggested_hash_key_name)
+          return if conflict?(suggested_hash_key_name)
 
           add_offense(node, message: message(suggested_hash_key_name)) do |corrector|
             autocorrect(corrector, node)
@@ -59,6 +60,10 @@ module RuboCop
 
         private
 
+        def conflict?(suggested_hash_key_name)
+          RuboCop::GraphQL::Field::CONFLICT_FIELD_NAMES.include?(suggested_hash_key_name.to_sym)
+        end
+
         def message(hash_key)
           format(MSG, hash_key: hash_key)
         end

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

@@ -28,6 +28,7 @@ module RuboCop
         include RuboCop::GraphQL::NodePattern
         include RuboCop::Cop::RangeHelp
 
+        # @!method method_to_use(node)
         def_node_matcher :method_to_use, <<~PATTERN
           (def
             _

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module GraphQL
-      # This cop detects duplicate field definitions within
+      # Detects duplicate field definitions within
       # the same type
       #
       # @example
@@ -66,6 +66,7 @@ module RuboCop
           node.first_argument.value.to_s
         end
 
+        # @!method field_declarations(node)
         def_node_search :field_declarations, <<~PATTERN
           {
             (send nil? :field (:sym _) ...)

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

@@ -20,6 +20,7 @@ module RuboCop
     #
     module GraphQL
       class LegacyDsl < Base
+        # @!method legacy_dsl?(node)
         def_node_matcher :legacy_dsl?, <<~PATTERN
           (block
             (send
@@ -33,7 +34,7 @@ module RuboCop
               "Use class-based definitions instead."
 
         def on_send(node)
-          return unless node.parent.type == :block
+          return unless node.parent.block_type?
 
           add_offense(node.parent) if legacy_dsl?(node.parent)
         end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      # Checks whether fields with multiple definitions are grouped together.
+      # @example
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :first_name, String, null: true
+      #     field :first_name, Name, null: true
+      #
+      #     def first_name
+      #       object.contact_data.first_name
+      #     end
+      #   end
+      #
+      #   # bad
+      #
+      #   class UserType < BaseType
+      #     field :first_name, String, null: true
+      #
+      #     def first_name
+      #       object.contact_data.first_name
+      #     end
+      #     field :first_name, Name, null: true
+      #   end
+      class MultipleFieldDefinitions < Base
+        extend AutoCorrector
+        include RuboCop::GraphQL::NodePattern
+        include RuboCop::Cop::RangeHelp
+        include RuboCop::GraphQL::Heredoc
+
+        def on_send(node)
+          return unless field?(node)
+
+          node = node.parent if field_definition_with_body?(node.parent)
+
+          field = RuboCop::GraphQL::Field.new(node)
+
+          multiple_definitions = multiple_definitions(field)
+
+          return if multiple_definitions.size == 1 || node != multiple_definitions.last
+
+          if has_ungrouped_definitions?(multiple_definitions)
+            add_offense(node, message: MULTIPLE_DEFINITIONS_MSG) do |corrector|
+              group_multiple_definitions(corrector, multiple_definitions)
+            end
+          end
+        end
+
+        private
+
+        MULTIPLE_DEFINITIONS_MSG = "Group multiple field definitions together."
+
+        def multiple_definitions(field)
+          field.schema_member.body.select { |node| field?(node) && field_name(node) == field.name }
+        end
+
+        def field_name(node)
+          RuboCop::GraphQL::Field.new(node).name
+        end
+
+        def group_multiple_definitions(corrector, multiple_definitions)
+          multiple_definitions.each_cons(2) do |first, second|
+            next unless field_sibling_index(second) - field_sibling_index(first) > 1
+
+            insert_new_field(corrector, first, second)
+            remove_old_field(corrector, second)
+          end
+        end
+
+        def insert_new_field(corrector, first, second)
+          source_to_insert = "\n#{range_including_heredoc(second).source}"
+          field_definition_range = range_including_heredoc(first)
+          corrector.insert_after(field_definition_range, source_to_insert)
+        end
+
+        def remove_old_field(corrector, second)
+          range_to_remove = range_with_surrounding_space(
+            range: range_including_heredoc(second), side: :left
+          )
+          corrector.remove(range_to_remove)
+        end
+
+        def has_ungrouped_definitions?(multiple_definitions)
+          sibling_indices = multiple_definitions.map do |field|
+            field_sibling_index(field)
+          end
+
+          sibling_indices.each_cons(2).any? { |index1, index2| index2 - index1 > 1 }
+        end
+
+        def field_sibling_index(field)
+          if field_definition_with_body?(field.parent)
+            field.parent.sibling_index
+          else
+            field.sibling_index
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -26,10 +26,12 @@ module RuboCop
 
         MSG = "Missing type description"
 
+        # @!method has_i18n_description?(node)
         def_node_matcher :has_i18n_description?, <<~PATTERN
           (send nil? :description (send (const nil? :I18n) :t ...))
         PATTERN
 
+        # @!method interface?(node)
         def_node_matcher :interface?, <<~PATTERN
           (send nil? :include (const ...))
         PATTERN

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

@@ -101,10 +101,12 @@ module RuboCop
           previous.source_range.last_line == current.source_range.first_line - 1
         end
 
+        # @!method argument_declarations_without_blocks(node)
         def_node_search :argument_declarations_without_blocks, <<~PATTERN
           (send nil? :argument (:sym _) ...)
         PATTERN
 
+        # @!method argument_declarations_with_blocks(node)
         def_node_search :argument_declarations_with_blocks, <<~PATTERN
           (block
             (send nil? :argument

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

@@ -74,6 +74,7 @@ module RuboCop
           previous.source_range.last_line == current.source_range.first_line - 1
         end
 
+        # @!method field_declarations(node)
         def_node_search :field_declarations, <<~PATTERN
           {
             (send nil? :field (:sym _) ...)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module GraphQL
-      # This cop checks if the length of a resolver method exceeds some maximum value.
+      # Checks if the length of a resolver method exceeds some maximum value.
       # Comment lines can optionally be ignored.
       #
       # The maximum allowed length is configurable using the Max option.
@@ -13,6 +13,7 @@ module RuboCop
 
         MSG = "ResolverMethod has too many lines. [%<total>d/%<max>d]"
 
+        # @!method field_definition(node)
         def_node_matcher :field_definition, <<~PATTERN
           (send nil? :field (sym $...) ...)
         PATTERN

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

@@ -175,10 +175,12 @@ module RuboCop
           node.block_type? || node.lambda_type?
         end
 
+        # @!method argument_declaration?(node)
         def_node_matcher :argument_declaration?, <<~PATTERN
           (send nil? :argument (:sym _) ...)
         PATTERN
 
+        # @!method resolve_method_definition(node)
         def_node_search :resolve_method_definition, <<~PATTERN
           (def :resolve
             (args ...) ...)

data/lib/rubocop/cop/graphql_cops.rb

@@ -12,6 +12,7 @@ require_relative "graphql/field_method"
 require_relative "graphql/field_name"
 require_relative "graphql/field_uniqueness"
 require_relative "graphql/legacy_dsl"
+require_relative "graphql/multiple_field_definitions"
 require_relative "graphql/resolver_method_length"
 require_relative "graphql/object_description"
 require_relative "graphql/ordered_arguments"

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

@@ -7,6 +7,7 @@ module RuboCop
         extend RuboCop::NodePattern::Macros
         include DescriptionMethod
 
+        # @!method argument_block(node)
         def_node_matcher :argument_block, <<~PATTERN
           (block
             (send nil? :argument ...)

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

@@ -6,6 +6,7 @@ module RuboCop
       class Kwargs
         extend RuboCop::NodePattern::Macros
 
+        # @!method argument_kwargs(node)
         def_node_matcher :argument_kwargs, <<~PATTERN
           (send nil? :argument
             ...
@@ -15,14 +16,17 @@ module RuboCop
           )
         PATTERN
 
+        # @!method description_kwarg?(node)
         def_node_matcher :description_kwarg?, <<~PATTERN
           (pair (sym :description) ...)
         PATTERN
 
+        # @!method loads_kwarg?(node)
         def_node_matcher :loads_kwarg?, <<~PATTERN
           (pair (sym :loads) ...)
         PATTERN
 
+        # @!method as_kwarg?(node)
         def_node_matcher :as_kwarg?, <<~PATTERN
           (pair (sym :as) ...)
         PATTERN

data/lib/rubocop/graphql/argument.rb

@@ -5,14 +5,17 @@ module RuboCop
     class Argument
       extend RuboCop::NodePattern::Macros
 
+      # @!method argument_description(node)
       def_node_matcher :argument_description, <<~PATTERN
         (send nil? :argument _ _ (:str $_) ...)
       PATTERN
 
+      # @!method argument_name(node)
       def_node_matcher :argument_name, <<~PATTERN
         (send nil? :argument (:sym $_) ...)
       PATTERN
 
+      # @!method argument_as(node)
       def_node_matcher :argument_as, <<~PATTERN
         (pair (sym :as) (sym $_))
       PATTERN

data/lib/rubocop/graphql/description_method.rb

@@ -22,10 +22,12 @@ module RuboCop
 
       DESCRIPTION_STRING = "{({str|dstr|const} ...)|(send const ...)|(send ({str|dstr} ...) _)}"
 
+      # @!method description_method_call?(node)
       def_node_matcher :description_method_call?, <<~PATTERN
         (send nil? :description #{DESCRIPTION_STRING})
       PATTERN
 
+      # @!method description_with_block_arg?(node)
       def_node_matcher :description_with_block_arg?, <<~PATTERN
         (send (lvar _) {:description= :description} #{DESCRIPTION_STRING})
       PATTERN

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

@@ -7,6 +7,7 @@ module RuboCop
         extend RuboCop::NodePattern::Macros
         include DescriptionMethod
 
+        # @!method field_block(node)
         def_node_matcher :field_block, <<~PATTERN
           (block
             (send nil? :field ...)

data/lib/rubocop/graphql/field/kwargs.rb

@@ -6,6 +6,7 @@ module RuboCop
       class Kwargs
         extend RuboCop::NodePattern::Macros
 
+        # @!method field_kwargs(node)
         def_node_matcher :field_kwargs, <<~PATTERN
           (send nil? :field
             ...
@@ -15,22 +16,27 @@ module RuboCop
           )
         PATTERN
 
+        # @!method resolver_kwarg?(node)
         def_node_matcher :resolver_kwarg?, <<~PATTERN
           (pair (sym :resolver) ...)
         PATTERN
 
+        # @!method method_kwarg?(node)
         def_node_matcher :method_kwarg?, <<~PATTERN
           (pair (sym :method) ...)
         PATTERN
 
+        # @!method hash_key_kwarg?(node)
         def_node_matcher :hash_key_kwarg?, <<~PATTERN
           (pair (sym :hash_key) ...)
         PATTERN
 
+        # @!method description_kwarg?(node)
         def_node_matcher :description_kwarg?, <<~PATTERN
           (pair (sym :description) ...)
         PATTERN
 
+        # @!method resolver_method_option(node)
         def_node_matcher :resolver_method_option, <<~PATTERN
           (pair (sym :resolver_method) (sym $...))
         PATTERN

data/lib/rubocop/graphql/field.rb

@@ -20,15 +20,18 @@ module RuboCop
 
       def_delegators :@node, :sibling_index, :parent
 
+      # @!method field_name(node)
       def_node_matcher :field_name, <<~PATTERN
         (send nil? :field (:sym $_) ...)
       PATTERN
 
+      # @!method field_with_body_name(node)
       def_node_matcher :field_with_body_name, <<~PATTERN
         (block
         (send nil? :field (:sym $_) ...)...)
       PATTERN
 
+      # @!method field_description(node)
       def_node_matcher :field_description, <<~PATTERN
         (send nil? :field _ _ (:str $_) ...)
       PATTERN

data/lib/rubocop/graphql/node_pattern.rb

@@ -5,10 +5,12 @@ module RuboCop
     module NodePattern
       extend RuboCop::NodePattern::Macros
 
+      # @!method field_definition?(node)
       def_node_matcher :field_definition?, <<~PATTERN
         (send nil? :field (:sym _) ...)
       PATTERN
 
+      # @!method field_definition_with_body?(node)
       def_node_matcher :field_definition_with_body?, <<~PATTERN
         (block
           (send nil? :field (:sym _) ...)
@@ -16,6 +18,7 @@ module RuboCop
         )
       PATTERN
 
+      # @!method argument?(node)
       def_node_matcher :argument?, <<~PATTERN
         (send nil? :argument (:sym _) ...)
       PATTERN

data/lib/rubocop/graphql/schema_member.rb

@@ -5,6 +5,7 @@ module RuboCop
     class SchemaMember
       extend RuboCop::NodePattern::Macros
 
+      # @!method class_contents(node)
       def_node_matcher :class_contents, <<~PATTERN
         (class _ _ $_)
       PATTERN
@@ -16,7 +17,7 @@ module RuboCop
       end
 
       def find_method_definition(method_name)
-        body.find { |node| node.def_type? && node.method_name == method_name }
+        body.find { |node| node.def_type? && node.method?(method_name) }
       end
 
       def body

data/lib/rubocop/graphql/sorbet.rb

@@ -5,6 +5,7 @@ module RuboCop
     module Sorbet
       extend RuboCop::NodePattern::Macros
 
+      # @!method sorbet_signature(node)
       def_node_matcher(:sorbet_signature, <<~PATTERN)
         (block (send nil? :sig) (args) ...)
       PATTERN

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.14.5".freeze
+    VERSION = "0.15.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.14.5
+  version: 0.15.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,7 @@ files:
 - lib/rubocop/cop/graphql/field_name.rb
 - lib/rubocop/cop/graphql/field_uniqueness.rb
 - lib/rubocop/cop/graphql/legacy_dsl.rb
+- lib/rubocop/cop/graphql/multiple_field_definitions.rb
 - lib/rubocop/cop/graphql/object_description.rb
 - lib/rubocop/cop/graphql/ordered_arguments.rb
 - lib/rubocop/cop/graphql/ordered_fields.rb
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Automatic performance checking tool for Ruby code.