rubocop-graphql 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aec3ad39e39612f0b537f18b691a38d2e2a5efc9ec5b284b0fabf0d12521136e
-  data.tar.gz: ba04fef687999fdb042a926c27346d89beff1fa59b827c4936b6f819cf5abe74
+  metadata.gz: 93b15c7311147740481d59f94cab5e62ca4317ada9ec0e21254ec785b5dfd683
+  data.tar.gz: 9157944e4d8a28635389fe2b1472c48361001a5674fb1c81ebd0dec4447b44d0
 SHA512:
-  metadata.gz: f8094f6adb04e83515a0fd6307ddc3a255b17d7fdd8bf432ba84a77f6d4ba1921dbea3ba2739761b3103d8271d8bcab6b807c65f6479617eb8e116717e5861e0
-  data.tar.gz: f9664a1f5fb19d71dcef3976525f955f8c515c0655d4f86203bfa72508baeb9a000576ec3aafc44ee9b61061f0cfc79b978e1cada637335a9d98d0dd0249aea5
+  metadata.gz: 9cd372736e4f994645dfaf72289ce5933a9e739f5ef179096326574b5da79d6c872ee01097232666d2549d8bd5f9c762dc3af0de6b66ce905a2a3d37814a3c9c
+  data.tar.gz: 181fd6b02b1bb4e20fc64f60e39ceb94073ce178be18b6d1bc6177e4d62cf933e2f6bd5ef4e23b4b8aa163a22ccd641ca4727647054f24bcce2882e390bfddd5

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

@@ -220,7 +220,7 @@ module RuboCop
 
         def remove_old_resolver(corrector, resolver_definition)
           range_to_remove = range_with_surrounding_space(
-            range: resolver_definition.loc.expression, side: :left
+            range: resolver_definition.source_range, side: :left
           )
           corrector.remove(range_to_remove)
 
@@ -229,7 +229,7 @@ module RuboCop
           return unless resolver_signature
 
           range_to_remove = range_with_surrounding_space(
-            range: resolver_signature.loc.expression, side: :left
+            range: resolver_signature.source_range, side: :left
           )
           corrector.remove(range_to_remove)
         end

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

@@ -74,11 +74,11 @@ module RuboCop
           suggested_hash_key_name = hash_key_to_use(method_definition)
 
           corrector.insert_after(
-            node.loc.expression, ", hash_key: #{suggested_hash_key_name.inspect}"
+            node.source_range, ", hash_key: #{suggested_hash_key_name.inspect}"
           )
 
           range = range_with_surrounding_space(
-            range: method_definition.loc.expression, side: :left
+            range: method_definition.source_range, side: :left
           )
 
           corrector.remove(range)

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

@@ -68,10 +68,10 @@ module RuboCop
           method_definition = suggest_method_name_for(field)
           suggested_method_name = method_to_use(method_definition)
 
-          corrector.insert_after(node.loc.expression, ", method: :#{suggested_method_name}")
+          corrector.insert_after(node.source_range, ", method: :#{suggested_method_name}")
 
           range = range_with_surrounding_space(
-            range: method_definition.loc.expression, side: :left
+            range: method_definition.source_range, side: :left
           )
           corrector.remove(range)
         end

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

@@ -20,6 +20,20 @@ module RuboCop
       #     end
       #   end
       #
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     implements GraphQL::Types::Relay::Node
+      #
+      #     field :uuid, ID, null: false
+      #
+      #     class << self
+      #       def authorized?(object, context)
+      #         super && object.owner == context[:viewer]
+      #       end
+      #     end
+      #   end
+      #
       #   # bad
       #
       #   class UserType < BaseType
@@ -42,7 +56,7 @@ module RuboCop
 
         # @!method has_authorized_method?(node)
         def_node_matcher :has_authorized_method?, <<~PATTERN
-          `(:defs (:self) :authorized? ...)
+          {`(:defs (:self) :authorized? ...) | `(:sclass (:self) `(:def :authorized? ...))}
         PATTERN
 
         def on_class(node)

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

@@ -3,32 +3,48 @@
 module RuboCop
   module Cop
     module GraphQL
-      #  This cop checks if a field has an unnecessary alias.
+      #  This cop prevents defining an unnecessary alias, method, or resolver_method.
       #
       # @example
       #   # good
       #
-      #   class UserType < BaseType
-      #     field :name, String, "Name of the user", null: true, alias: :real_name
-      #   end
+      #   field :name, String, "Name of the user", null: true, alias: :real_name
+      #   field :name, String, "Name of the user", null: true, method: :real_name
+      #   field :name, String, "Name of the user", null: true, resolver_method: :real_name
+      #   field :name, String, "Name of the user", null: true, hash_key: :real_name
       #
       #   # bad
       #
-      #   class UserType < BaseType
-      #     field :name, "Name of the user" String, null: true, alias: :name
-      #   end
+      #   field :name, "Name of the user" String, null: true, alias: :name
+      #   field :name, String, "Name of the user", null: true, method: :name
+      #   field :name, String, "Name of the user", null: true, resolver_method: :name
+      #   field :name, String, "Name of the user", null: true, hash_key: :name
       #
       class UnnecessaryFieldAlias < Base
         include RuboCop::GraphQL::NodePattern
 
-        MSG = "Unnecessary field alias"
+        MSG = "Unnecessary :%<kwarg>s configured"
 
         def on_send(node)
           return unless field_definition?(node)
 
           field = RuboCop::GraphQL::Field.new(node)
 
-          add_offense(node) if field.name == field.kwargs.alias
+          if (unnecessary_kwarg = validate_kwargs(field))
+            message = format(self.class::MSG, kwarg: unnecessary_kwarg)
+            add_offense(node, message: message)
+          end
+        end
+
+        private
+
+        def validate_kwargs(field) # rubocop:disable Metrics/CyclomaticComplexity
+          case field.name
+          when field.kwargs.alias then "alias"
+          when field.kwargs.method&.value&.value then "method"
+          when field.kwargs.resolver_method_name then "resolver_method"
+          when field.kwargs.hash_key&.value&.value then "hash_key"
+          end
         end
       end
     end

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

@@ -144,7 +144,7 @@ module RuboCop
         end
 
         def arg_end(node)
-          node.loc.expression.end
+          node.source_range.end
         end
 
         def inferred_arg_name(name_as_string)

data/lib/rubocop/graphql/field.rb

@@ -84,7 +84,10 @@ module RuboCop
       end
 
       def root_node?(node)
-        node.parent.nil? || node.class_type? || root_with_siblings?(node.parent)
+        node.parent.nil? ||
+          node.module_type? && node.children.none?(&:module_type?) ||
+          node.class_type? ||
+          root_with_siblings?(node.parent)
       end
 
       def root_with_siblings?(node)

data/lib/rubocop/graphql/heredoc.rb

@@ -13,7 +13,7 @@ module RuboCop
                          heredoc?(kwarg.value)
                        end&.value
 
-        range = node.loc.expression
+        range = node.source_range
         range = range.join(last_heredoc.loc.heredoc_end) if last_heredoc
 
         range_by_whole_lines(range)

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-26 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler