rubocop-graphql 0.14.6 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7832bf74fe37877eee6544f83cc7625cfa874df93f6b141c07a2c1a628a927f
-  data.tar.gz: c764f2caaf3cbbb685eb944b1a206c4904a484fe000f39a41c40b33846eecc1b
+  metadata.gz: 07b20077b6c0a6ec0ff0aa58528140efd701a90c3059c2483b213ea9039dfe35
+  data.tar.gz: 7f2e405ea2241a8f6d918577e75bfe523125700ed48441d434a1e671d1a93e56
 SHA512:
-  metadata.gz: 9bdb7f16d1b31c795e8d624030e774c3c92ebb1481e4459f229fe135557eb072dbe2920c1cfc2600bb0d768756b338846da6db1b396def061d95ad4d0628e5b0
-  data.tar.gz: d506eade963151227cfa3bf55f7ddf320b281111083ac784807c7c6aa6534a0899a01474d2c80f35c2460d1817b18f033d05ce880be59f477b5fe75cf85ce0e8
+  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'

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

@@ -63,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
@@ -114,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
@@ -125,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
@@ -157,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/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_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/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.14.6".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.6
+  version: 0.15.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-31 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
@@ -127,7 +128,7 @@ metadata:
   homepage_uri: https://github.com/DmitryTsepelev/rubocop-graphql
   source_code_uri: https://github.com/DmitryTsepelev/rubocop-graphql
   changelog_uri: https://github.com/DmitryTsepelev/rubocop-graphql/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Automatic performance checking tool for Ruby code.
 test_files: []