rubocop-graphql 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5be7099abfc014351e097467d9dfe7c687d4a0323241f7ce592e0abe25f6b0cb
-  data.tar.gz: da4e69f7810f416873d3f3f0742b70758a3c66c343bbd0d2572c223605156c77
+  metadata.gz: 2393f8c4972a479e9618f3ed9f846a819b0efa8bf13e53f319bbc176c50a470b
+  data.tar.gz: 4326de68922f560a042ecbee99f70f421a09c05e0502291e4b4624c90a369233
 SHA512:
-  metadata.gz: ea0737a86c403dbd57b5777c221ce80ec86e97c6fce499d00f573ef7adeb15f37e2db7b2c8f6275ff7aa58e1a17b12472a748cdf06f26c0411cb9943075386fd
-  data.tar.gz: c0b0235d1035b9b77ffaaac3ee419b4e240c9eb7363033f37f9396a028930e33f6d11d3145f95c708e68a0b2f7566de0e1cf96264619eb1da0c3626e99304a0b
+  metadata.gz: 1d65dbf3f6d5a623afbd74524e485ff4c570157ab23eae396e7ca5e343ff3ea2546d8433fc67dff38e2d63985ebc2881de3ba37e58ed5943ef2521fb2be93d36
+  data.tar.gz: 718957be35d17116319a4d18ba707b96236e813e9acd8fa724888623550f6dffafc2c07e774a181f5f576c2e949d92e3c264badc2c30ef4897d440781a3b1c32

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 # rubocop:disable Lint/MissingSuper
       end
 
       # Special case `Module#<` so that the rspec support rubocop exports
@@ -48,7 +47,7 @@ module RuboCop
         )
 
         # Invoke the original inherited hook so our cops are recognized
-        def self.inherited(subclass)
+        def self.inherited(subclass)  # rubocop:disable Lint/MissingSuper
           RuboCop::Cop::Cop.inherited(subclass)
         end
 

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,11 +105,11 @@ 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
+          source_to_insert = "\n#{indent(node)}#{node.source}"
           corrector.insert_after(first_field.loc.expression, source_to_insert)
 
           range = range_with_surrounding_space(range: node.loc.expression, side: :left)
@@ -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
 
@@ -142,11 +143,13 @@ module RuboCop
 
           field_definition = field_definition_with_body?(node.parent) ? node.parent : node
 
-          source_to_insert = indent(method_definition) + field_definition.source + "\n\n"
+          source_to_insert = "#{indent(method_definition)}#{field_definition.source}\n\n"
           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

@@ -57,9 +57,14 @@ module RuboCop
             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}")
+            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
+            )
 
-            range = range_with_surrounding_space(range: method_definition.loc.expression, side: :left)
             corrector.remove(range)
           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
@@ -32,6 +33,10 @@ module RuboCop
           (send nil? :description (:str $_))
         PATTERN
 
+        def_node_matcher :has_multiline_string_description?, <<~PATTERN
+          (send nil? :description (:dstr ...))
+        PATTERN
+
         def_node_matcher :interface?, <<~PATTERN
           (send nil? :include (const ...))
         PATTERN
@@ -45,13 +50,17 @@ 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
 
         def has_description?(node)
-          has_i18n_description?(node) || has_string_description?(node)
+          has_i18n_description?(node) ||
+            has_string_description?(node) ||
+            has_multiline_string_description?(node)
         end
 
         def child_nodes(node)

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

@@ -13,3 +13,4 @@ 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.4.0"
+    VERSION = "0.6.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Dmitry Tsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2021-03-03 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
@@ -88,6 +94,7 @@ files:
 - 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
@@ -109,7 +116,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/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,15 +124,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Automatic performance checking tool for Ruby code.
 test_files: []