rubocop-graphql 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c659875c5f0ff36b73bb44becbdbf2b0db912979041ff09f090fa3a265dfe9a
-  data.tar.gz: a76e1b6a142e23ec20a0d1936e28dc1e626436691700d2a704c275f1f4d7b134
+  metadata.gz: 5be7099abfc014351e097467d9dfe7c687d4a0323241f7ce592e0abe25f6b0cb
+  data.tar.gz: da4e69f7810f416873d3f3f0742b70758a3c66c343bbd0d2572c223605156c77
 SHA512:
-  metadata.gz: 1ee99d3d6d3876effb01e6f4f67db2a9f1a700dd991957705f95c6608ffde97709069af1a75417baebaefa16f32c83f6fec157a649d469cd3ab9aa4e99554f7a
-  data.tar.gz: 1d2ceb8a083f36bb141addbc43a22b273048dc3abbeacd2891bbb4709d4558ac3f4a524e80fc07bd56609281d734c35f386f3e28c2255868fb9876f0ad95231f
+  metadata.gz: ea0737a86c403dbd57b5777c221ce80ec86e97c6fce499d00f573ef7adeb15f37e2db7b2c8f6275ff7aa58e1a17b12472a748cdf06f26c0411cb9943075386fd
+  data.tar.gz: c0b0235d1035b9b77ffaaac3ee419b4e240c9eb7363033f37f9396a028930e33f6d11d3145f95c708e68a0b2f7566de0e1cf96264619eb1da0c3626e99304a0b

data/config/default.yml

@@ -35,6 +35,11 @@ GraphQL/FieldDescription:
   VersionAdded: '0.80'
   Description: 'Ensures all fields have a description'
 
+GraphQL/FieldHashKey:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Checks :hash_key option is used for appropriate fields'
+
 GraphQL/FieldMethod:
   Enabled: true
   VersionAdded: '0.80'

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop prevents defining unnecessary resolver methods in cases
+      #  when :hash_key option can be used
+      #
+      # @example
+      #   # good
+      #
+      #   class Types::UserType < Types::BaseObject
+      #     field :phone, String, null: true, hash_key: :home_phone
+      #   end
+      #
+      #   # bad
+      #
+      #   class Types::UserType < Types::BaseObject
+      #     field :phone, String, null: true
+      #
+      #     def phone
+      #       object[:home_phone]
+      #     end
+      #   end
+      #
+      class FieldHashKey < Cop
+        include RuboCop::GraphQL::NodePattern
+        include RuboCop::Cop::RangeHelp
+
+        def_node_matcher :hash_key_to_use, <<~PATTERN
+          (def
+            _
+            (args)
+            (send
+              (send nil? :object) :[]
+              (_type $_)
+            )
+          )
+        PATTERN
+
+        MSG = "Use hash_key: %<hash_key>p"
+
+        def on_send(node)
+          return unless field_definition?(node)
+
+          field = RuboCop::GraphQL::Field.new(node)
+          method_definition = resolver_method_definition_for(field)
+
+          if (suggested_hash_key_name = hash_key_to_use(method_definition))
+            add_offense(node, message: message(suggested_hash_key_name))
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            field = RuboCop::GraphQL::Field.new(node)
+            method_definition = resolver_method_definition_for(field)
+            suggested_hash_key_name = hash_key_to_use(method_definition)
+
+            corrector.insert_after(node.loc.expression, ", hash_key: #{suggested_hash_key_name.inspect}")
+
+            range = range_with_surrounding_space(range: method_definition.loc.expression, side: :left)
+            corrector.remove(range)
+          end
+        end
+
+        private
+
+        def message(hash_key)
+          format(MSG, hash_key: hash_key)
+        end
+
+        def resolver_method_definition_for(field)
+          method_name = field.resolver_method_name
+          field.schema_member.find_method_definition(method_name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/graphql_cops.rb

@@ -8,6 +8,7 @@ require_relative "graphql/extract_input_type"
 require_relative "graphql/extract_type"
 require_relative "graphql/field_definitions"
 require_relative "graphql/field_description"
+require_relative "graphql/field_hash_key"
 require_relative "graphql/field_method"
 require_relative "graphql/field_name"
 require_relative "graphql/resolver_method_length"

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - lib/rubocop/cop/graphql/extract_type.rb
 - lib/rubocop/cop/graphql/field_definitions.rb
 - lib/rubocop/cop/graphql/field_description.rb
+- lib/rubocop/cop/graphql/field_hash_key.rb
 - lib/rubocop/cop/graphql/field_method.rb
 - lib/rubocop/cop/graphql/field_name.rb
 - lib/rubocop/cop/graphql/object_description.rb