rubocop-graphql 0.3.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c659875c5f0ff36b73bb44becbdbf2b0db912979041ff09f090fa3a265dfe9a
-  data.tar.gz: a76e1b6a142e23ec20a0d1936e28dc1e626436691700d2a704c275f1f4d7b134
+  metadata.gz: 47871bc7644dbf0fb1f5c9b25af8d5f60183a8513d90f5a62d980b0fc865f9ad
+  data.tar.gz: 18177a7497deef3c5342405b5b393eb5e1bae75cbf8e8eee5da636c814b51ea0
 SHA512:
-  metadata.gz: 1ee99d3d6d3876effb01e6f4f67db2a9f1a700dd991957705f95c6608ffde97709069af1a75417baebaefa16f32c83f6fec157a649d469cd3ab9aa4e99554f7a
-  data.tar.gz: 1d2ceb8a083f36bb141addbc43a22b273048dc3abbeacd2891bbb4709d4558ac3f4a524e80fc07bd56609281d734c35f386f3e28c2255868fb9876f0ad95231f
+  metadata.gz: 7d2f3153652722d359d0ee0d5c6da8f9d03e1cae62c78e1e5f1b9fc577cfc361fd39cdfa0cd0addee6fb6c0e36b8c51bca485cc18f9c15fa3b1495d941668b0d
+  data.tar.gz: bcb8a5d5938abd6b9be712f51a6363c31098d604dafcf725a8da6edff5d737c42532b329ba831d1d09277f78d340da9d105b58c37b0b494d5e526a882eda70b1

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/cop.rb

@@ -12,8 +12,7 @@ module RuboCop
       # class will invoke the inherited hook instead
       class << self
         undef inherited
-        def inherited(*)
-        end
+        def inherited(*); end
       end
 
       # Special case `Module#<` so that the rspec support rubocop exports

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

@@ -45,7 +45,8 @@ module RuboCop
 
         private
 
-        MSG = "Consider moving %<field_names>s to a new type and adding the `%<prefix>s` field instead"
+        MSG = "Consider moving %<field_names>s to a new type and " \
+              "adding the `%<prefix>s` field instead"
 
         def check_fields_prefixes(body)
           sorted_prefixes = fractured(body).sort_by { |k, _| k.size }.reverse

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

@@ -105,9 +105,9 @@ module RuboCop
         def group_field_declarations(corrector, node)
           field = RuboCop::GraphQL::Field.new(node)
 
-          first_field = field.schema_member.body.find { |node|
+          first_field = field.schema_member.body.find do |node|
             field_definition?(node) || field_definition_with_body?(node)
-          }
+          end
 
           source_to_insert = "\n" + indent(node) + node.source
           corrector.insert_after(first_field.loc.expression, source_to_insert)
@@ -124,11 +124,12 @@ module RuboCop
           method_definition = field.schema_member.find_method_definition(field.resolver_method_name)
           return unless method_definition
 
-          field_sibling_index = if field_definition_with_body?(field.parent)
-            field.parent.sibling_index
-          else
-            field.sibling_index
-          end
+          field_sibling_index =
+            if field_definition_with_body?(field.parent)
+              field.parent.sibling_index
+            else
+              field.sibling_index
+            end
 
           return if method_definition.sibling_index - field_sibling_index == 1
 
@@ -146,7 +147,9 @@ module RuboCop
           method_range = range_by_whole_lines(method_definition.loc.expression)
           corrector.insert_before(method_range, source_to_insert)
 
-          range_to_remove = range_with_surrounding_space(range: field_definition.loc.expression, side: :left)
+          range_to_remove = range_with_surrounding_space(
+            range: field_definition.loc.expression, side: :left
+          )
           corrector.remove(range_to_remove)
         end
 

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

@@ -0,0 +1,85 @@
+# 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/field_method.rb

@@ -58,7 +58,9 @@ module RuboCop
 
             corrector.insert_after(node.loc.expression, ", method: :#{suggested_method_name}")
 
-            range = range_with_surrounding_space(range: method_definition.loc.expression, side: :left)
+            range = range_with_surrounding_space(
+              range: method_definition.loc.expression, side: :left
+            )
             corrector.remove(range)
           end
         end

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

@@ -3,7 +3,8 @@
 module RuboCop
   module Cop
     module GraphQL
-      #  This cop checks if a type (object, input, interface, scalar, union, mutation, subscription, and resolver) has a description.
+      #  This cop checks if a type (object, input, interface, scalar, union,
+      #  mutation, subscription, and resolver) has a description.
       #
       # @example
       #   # good
@@ -45,7 +46,9 @@ module RuboCop
         def on_module(node)
           return if child_nodes(node).none? { |child_node| interface?(child_node) }
 
-          add_offense(node.identifier) if child_nodes(node).none? { |child_node| has_description?(child_node) }
+          if child_nodes(node).none? { |child_node| has_description?(child_node) }
+            add_offense(node.identifier)
+          end
         end
 
         private

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      # Field should be alphabetically sorted within groups.
+      #
+      # @example
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :name, String, null: true
+      #     field :phone, String, null: true do
+      #       argument :something, String, required: false
+      #     end
+      #   end
+      #
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :phone, String, null: true
+      #
+      #     field :name, String, null: true
+      #   end
+      #
+      #   # bad
+      #
+      #   class UserType < BaseType
+      #     field :phone, String, null: true
+      #     field :name, String, null: true
+      #   end
+      #
+      class OrderedFields < Cop
+        MSG = "Fields should be sorted in an alphabetical order within their "\
+              "section. "\
+              "Field `%<current>s` should appear before `%<previous>s`."
+
+        def investigate(processed_source)
+          return if processed_source.blank?
+
+          field_declarations(processed_source.ast)
+            .each_cons(2) do |previous, current|
+              next unless consecutive_lines(previous, current)
+              next if field_name(current) > field_name(previous)
+
+              register_offense(previous, current)
+            end
+        end
+
+        private
+
+        def register_offense(previous, current)
+          message = format(
+            self.class::MSG,
+            previous: field_name(previous),
+            current: field_name(current)
+          )
+          add_offense(current, message: message)
+        end
+
+        def field_name(node)
+          if node.block_type?
+            field_name(node.send_node)
+          else
+            node.first_argument.value.to_s
+          end
+        end
+
+        def consecutive_lines(previous, current)
+          previous.source_range.last_line == current.source_range.first_line - 1
+        end
+
+        def_node_search :field_declarations, <<~PATTERN
+          {
+            (send nil? :field (:sym _) ...)
+            (block
+              (send nil? :field (:sym _) ...) ...)
+          }
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -9,9 +9,9 @@ module RuboCop
       # The maximum allowed length is configurable using the Max option.
       class ResolverMethodLength < Cop
         include RuboCop::Cop::ConfigurableMax
-        include RuboCop::Cop::TooManyLines
+        include RuboCop::Cop::CodeLength
 
-        LABEL = "ResolverMethod"
+        MSG = "ResolverMethod has too many lines. [%<total>d/%<max>d]"
 
         def_node_matcher :field_definition, <<~PATTERN
           (send nil? :field (sym $...) ...)
@@ -21,18 +21,31 @@ module RuboCop
           excluded_methods = cop_config["ExcludedMethods"]
           return if excluded_methods.include?(String(node.method_name))
 
-          check_code_length(node) if field_is_defined?(node)
+          if field_is_defined?(node)
+            length = code_length(node)
+
+            return unless length > max_length
+
+            add_offense(node, message: message(length))
+          end
         end
         alias on_defs on_def
 
         private
 
+        def code_length(node)
+          node.source.lines[1..-2].count { |line| !irrelevant_line(line) }
+        end
+
         def field_is_defined?(node)
-          node.parent.children.flat_map { |child| field_definition(child) }.include?(node.method_name)
+          node.parent
+              .children
+              .flat_map { |child| field_definition(child) }
+              .include?(node.method_name)
         end
 
-        def cop_label
-          LABEL
+        def message(length)
+          format(MSG, total: length, max: max_length)
         end
       end
     end

data/lib/rubocop/cop/graphql_cops.rb

@@ -8,7 +8,9 @@ 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"
 require_relative "graphql/object_description"
+require_relative "graphql/ordered_fields"

data/lib/rubocop/graphql/ext/snake_case.rb

@@ -4,7 +4,7 @@ module RuboCop
   module GraphQL
     module Ext
       module SnakeCase
-        SNAKE_CASE = /^[\da-z_]+[!?=]?$/
+        SNAKE_CASE = /^[\da-z_]+[!?=]?$/.freeze
 
         refine Symbol do
           def snake_case?

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

@@ -56,7 +56,8 @@ module RuboCop
         end
 
         def resolver_method_name
-          @resolver_method_name ||= @nodes.flat_map { |kwarg| resolver_method_option(kwarg) }.compact.first
+          @resolver_method_name ||=
+            @nodes.flat_map { |kwarg| resolver_method_option(kwarg) }.compact.first
         end
       end
     end

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.3.1"
+    VERSION = "0.6.1".freeze
   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.6.1
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,33 +39,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: '0.87'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: '0.87'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 description: A collection of RuboCop cops to improve GraphQL-related code
 email:
 - dmitry.a.tsepelev@gmail.com
@@ -84,9 +90,11 @@ 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
+- lib/rubocop/cop/graphql/ordered_fields.rb
 - lib/rubocop/cop/graphql/resolver_method_length.rb
 - lib/rubocop/cop/graphql_cops.rb
 - lib/rubocop/graphql.rb
@@ -116,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="