rubocop-graphql 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97a32c7f3e6a945161380f4d71afe27ad379af7ed6f4657cea6b73d42dae5213
-  data.tar.gz: a039ae1c957f91d596f5b834035401ad031f2cf8723701e708d192f29dfb6784
+  metadata.gz: a3be1c838260c7be6902b6c06cf411ee768c39dab704b078d0204d8d1fa24fc5
+  data.tar.gz: 1061e5a30067f55254d5a89e87ff6a1597ac8df321e6be74b06a937ddd8da1e1
 SHA512:
-  metadata.gz: a17ab56af1141ef437dff2e908845c3c9a7d95b86f7e97c329787f43da0aef67be691a1d4179486d4580f40bb4fdbf423354ef619f7135651c0dcbe683a756b2
-  data.tar.gz: d9fb15417d019a952424942e5d860387da2bb1cd61abbeec1626ca9c7b9c2dec485cbe26b9cba28cec88128a828bb3cd1d776a9f3bc333bfc019d2ef8989b4e6
+  metadata.gz: 32e42d5a360bf522df3408bcfbc906e830eb7dcbc46aef53e967567c73f3634908a9cb6e9fb51967e79d1e64be24074067eca0e2870d45137c97b66f2b6354f4
+  data.tar.gz: 83a9f4756bec98ff082561a1cc1b81e64335a914bd343ba9353ccb865f38714219619594b8c6844b020fa04b3202412b5533a6fb01e2cbfb59b2a352d6465f57

data/README.md

@@ -1,4 +1,4 @@
-# Rubocop::GraphQL
+# RuboCop::GraphQL
 
 [Rubocop](https://github.com/rubocop-hq/rubocop) extension for enforcing [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) best practices.
 
@@ -24,7 +24,7 @@ gem 'rubocop-graphql', require: false
 
 ## Usage
 
-You need to tell RuboCop to load the Rails extension. There are three ways to do this:
+You need to tell RuboCop to load the GraphQL extension. There are three ways to do this:
 
 ### RuboCop configuration file
 
@@ -42,7 +42,7 @@ require:
   - rubocop-graphql
 ```
 
-Now you can run `rubocop` and it will automatically load the RuboCop Rails cops together with the standard cops.
+Now you can run `rubocop` and it will automatically load the RuboCop GraphQL cops together with the standard cops.
 
 ### Command line
 
@@ -62,7 +62,7 @@ end
 
 All cops are located under [`lib/rubocop/cop/graphql`](lib/rubocop/cop/graphql), and contain examples and documentation.
 
-In your `.rubocop.yml`, you may treat the Rails cops just like any other cop. For example:
+In your `.rubocop.yml`, you may treat the GraphQL cops just like any other cop. For example:
 
 ```yaml
 GraphQL/ResolverMethodLength:

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'
@@ -62,3 +67,11 @@ GraphQL/ExtractType:
     - avg
     - min
     - max
+
+GraphQL/ObjectDescription:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Ensures all types have a description'
+  Exclude:
+    - '**/*_schema.rb'
+    - '**/base_*.rb'

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

@@ -9,13 +9,13 @@ module RuboCop
       #   # good
       #
       #   class BanUser < BaseMutation
-      #     argument :uuid, ID, required: true
+      #     argument :uuid, ID, required: true, description: "UUID of the user to ban"
       #   end
       #
       #   # bad
       #
       #   class BanUser < BaseMutation
-      #     argument :uuid, ID, required: true, description: "UUID of the user to ban"
+      #     argument :uuid, ID, required: true
       #   end
       #
       class ArgumentDescription < Cop

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop checks if a type (object, input, interface, scalar, union,
+      #  mutation, subscription, and resolver) has a description.
+      #
+      # @example
+      #   # good
+      #
+      #   class Types::UserType < Types::BaseObject
+      #     description "Represents application user"
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #
+      #   class Types::UserType < Types::BaseObject
+      #     # ...
+      #   end
+      #
+      class ObjectDescription < Cop
+        include RuboCop::GraphQL::NodePattern
+
+        MSG = "Missing type description"
+
+        def_node_matcher :has_i18n_description?, <<~PATTERN
+          (send nil? :description (send (const nil? :I18n) :t ...))
+        PATTERN
+
+        def_node_matcher :has_string_description?, <<~PATTERN
+          (send nil? :description (:str $_))
+        PATTERN
+
+        def_node_matcher :interface?, <<~PATTERN
+          (send nil? :include (const ...))
+        PATTERN
+
+        def on_class(node)
+          return if child_nodes(node).find { |child_node| has_description?(child_node) }
+
+          add_offense(node.identifier)
+        end
+
+        def on_module(node)
+          return if child_nodes(node).none? { |child_node| interface?(child_node) }
+
+          if child_nodes(node).none? { |child_node| has_description?(child_node) }
+            add_offense(node.identifier)
+          end
+        end
+
+        private
+
+        def has_description?(node)
+          has_i18n_description?(node) || has_string_description?(node)
+        end
+
+        def child_nodes(node)
+          if node.body.instance_of? RuboCop::AST::Node
+            node.body.child_nodes
+          else
+            node.child_nodes
+          end
+        end
+      end
+    end
+  end
+end

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,6 +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.rb

@@ -69,7 +69,7 @@ module RuboCop
       end
 
       def root_node?(node)
-        node.parent.nil? || root_with_siblings?(node.parent)
+        node.parent.nil? || node.parent.module_type? || root_with_siblings?(node.parent)
       end
 
       def root_with_siblings?(node)

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

@@ -36,7 +36,7 @@ module RuboCop
         PATTERN
 
         def initialize(field_node)
-          @nodes = field_kwargs(field_node)
+          @nodes = field_kwargs(field_node) || []
         end
 
         def resolver
@@ -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/node_pattern.rb

@@ -6,18 +6,18 @@ module RuboCop
       extend RuboCop::NodePattern::Macros
 
       def_node_matcher :field_definition?, <<~PATTERN
-        (send nil? :field ...)
+        (send nil? :field (:sym _) ...)
       PATTERN
 
       def_node_matcher :field_definition_with_body?, <<~PATTERN
         (block
-          (send nil? :field ...)
+          (send nil? :field (:sym _) ...)
           ...
         )
       PATTERN
 
       def_node_matcher :argument?, <<~PATTERN
-        (send nil? :argument ...)
+        (send nil? :argument (:sym _) ...)
       PATTERN
 
       def field?(node)

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.2.0"
+    VERSION = "0.5.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,33 +39,33 @@ 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: '0.87'
 description: A collection of RuboCop cops to improve GraphQL-related code
 email:
 - dmitry.a.tsepelev@gmail.com
@@ -84,8 +84,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
@@ -115,7 +118,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:
   - - ">="