rubocop-graphql 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22be8928aa9fbce1700f99d21ccddacd9590ab7bd6c6723e4b7458f974e02f66
-  data.tar.gz: 6e06404047cba621b7493912723fa5eac13c19004d128339e494455758871831
+  metadata.gz: e63911b5c7c77f1d207fc9a1d411c61b874f51b372507bd7fd4c8072addd0663
+  data.tar.gz: 5581dcb49597ece10a23dba6f191b531d80d313e265fb6a61ec6db172691ad75
 SHA512:
-  metadata.gz: 94e9c24116f399d08b0c264e4b1b6c5dc50ac9436833fd8ec9f4916bdae102f5fdd5df5589a31502bca8aa65ccc61448a24b2e57aded363c35e6b0adec1513f6
-  data.tar.gz: '0855eb683b91a3d5bb6e78b89c7c3089df5832813b1c298b26edf56de2e3c4ee71da837d279bad5ce15fd4dbcf9197fe908f81f77967a7b7345c9a1b3fdcb1f2'
+  metadata.gz: ff897f7cfd8f63f3435915d3c9203803b7d81cb4d3997b5ef6e8e3822cb95ae77cc7eb3573bc6c50aa54c630eec59c550b35dca07d12412bcf7a460e00e3290f
+  data.tar.gz: cb02df1ef01c442dd7c3ad1abd89b6e8457bf83aa52391c78ead27e7c8d0793f8794ac4eb7295e234022763081f640115c3adef8a1f42f81600ef714655f6c06

data/config/default.yml

@@ -67,6 +67,11 @@ GraphQL/ExtractType:
     - min
     - max
 
+GraphQL/LegacyDsl:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Checks that types are defined with class-based API'
+
 GraphQL/ObjectDescription:
   Enabled: true
   VersionAdded: '0.80'

data/lib/rubocop-graphql.rb

@@ -9,6 +9,7 @@ require_relative "rubocop/graphql/version"
 require_relative "rubocop/graphql/inject"
 require_relative "rubocop/graphql/description_method"
 require_relative "rubocop/graphql/node_pattern"
+require_relative "rubocop/graphql/swap_range"
 
 require_relative "rubocop/graphql/argument"
 require_relative "rubocop/graphql/argument/block"

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

@@ -18,7 +18,7 @@ module RuboCop
       #     argument :uuid, ID, required: true
       #   end
       #
-      class ArgumentDescription < Cop
+      class ArgumentDescription < Base
         include RuboCop::GraphQL::NodePattern
 
         MSG = "Missing argument description"

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

@@ -18,7 +18,7 @@ module RuboCop
       #     argument :userId, ID, required: true
       #   end
       #
-      class ArgumentName < Cop
+      class ArgumentName < Base
         include RuboCop::GraphQL::NodePattern
 
         using RuboCop::GraphQL::Ext::SnakeCase

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module GraphQL
-      class ExtractInputType < Cop
+      class ExtractInputType < Base
         # This cop checks fields on common prefix groups
         #
         # # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module GraphQL
-      class ExtractType < Cop
+      class ExtractType < Base
         # This cop checks fields on common prefix groups
         #
         # # @example

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

@@ -44,7 +44,8 @@ module RuboCop
       #       object.contact_data.last_name
       #     end
       #   end
-      class FieldDefinitions < Cop
+      class FieldDefinitions < Base
+        extend AutoCorrector
         include ConfigurableEnforcedStyle
         include RuboCop::GraphQL::NodePattern
         include RuboCop::Cop::RangeHelp
@@ -75,17 +76,6 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            case style
-            when :define_resolver_after_definition
-              place_resolver_after_definitions(corrector, node)
-            when :group_definitions
-              group_field_declarations(corrector, node)
-            end
-          end
-        end
-
         private
 
         GROUP_DEFS_MSG = "Group all field definitions together."
@@ -98,7 +88,9 @@ module RuboCop
           fields.each_with_index do |node, idx|
             next if node.sibling_index == first_field.sibling_index + idx
 
-            add_offense(node, message: GROUP_DEFS_MSG)
+            add_offense(node, message: GROUP_DEFS_MSG) do |corrector|
+              group_field_declarations(corrector, node)
+            end
           end
         end
 
@@ -133,7 +125,9 @@ module RuboCop
 
           return if method_definition.sibling_index - field_sibling_index == 1
 
-          add_offense(field.node, message: RESOLVER_AFTER_FIELD_MSG)
+          add_offense(field.node, message: RESOLVER_AFTER_FIELD_MSG) do |corrector|
+            place_resolver_after_definitions(corrector, field.node)
+          end
         end
 
         def place_resolver_after_definitions(corrector, node)

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

@@ -18,7 +18,7 @@ module RuboCop
       #     field :name, String, null: true
       #   end
       #
-      class FieldDescription < Cop
+      class FieldDescription < Base
         include RuboCop::GraphQL::NodePattern
 
         MSG = "Missing field description"

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

@@ -23,7 +23,8 @@ module RuboCop
       #     end
       #   end
       #
-      class FieldHashKey < Cop
+      class FieldHashKey < Base
+        extend AutoCorrector
         include RuboCop::GraphQL::NodePattern
         include RuboCop::Cop::RangeHelp
 
@@ -47,32 +48,32 @@ module RuboCop
           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))
+            add_offense(node, message: message(suggested_hash_key_name)) do |corrector|
+              autocorrect(corrector, node)
+            end
           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)
+        private
 
-            corrector.insert_after(
-              node.loc.expression, ", hash_key: #{suggested_hash_key_name.inspect}"
-            )
+        def message(hash_key)
+          format(MSG, hash_key: hash_key)
+        end
 
-            range = range_with_surrounding_space(
-              range: method_definition.loc.expression, side: :left
-            )
+        def autocorrect(corrector, node)
+          field = RuboCop::GraphQL::Field.new(node)
+          method_definition = resolver_method_definition_for(field)
+          suggested_hash_key_name = hash_key_to_use(method_definition)
 
-            corrector.remove(range)
-          end
-        end
+          corrector.insert_after(
+            node.loc.expression, ", hash_key: #{suggested_hash_key_name.inspect}"
+          )
 
-        private
+          range = range_with_surrounding_space(
+            range: method_definition.loc.expression, side: :left
+          )
 
-        def message(hash_key)
-          format(MSG, hash_key: hash_key)
+          corrector.remove(range)
         end
 
         def resolver_method_definition_for(field)

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

@@ -23,7 +23,8 @@ module RuboCop
       #     end
       #   end
       #
-      class FieldMethod < Cop
+      class FieldMethod < Base
+        extend AutoCorrector
         include RuboCop::GraphQL::NodePattern
         include RuboCop::Cop::RangeHelp
 
@@ -46,22 +47,9 @@ module RuboCop
           method_definition = suggest_method_name_for(field)
 
           if (suggested_method_name = method_to_use(method_definition))
-            add_offense(node, message: message(suggested_method_name))
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            field = RuboCop::GraphQL::Field.new(node)
-            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}")
-
-            range = range_with_surrounding_space(
-              range: method_definition.loc.expression, side: :left
-            )
-            corrector.remove(range)
+            add_offense(node, message: message(suggested_method_name)) do |corrector|
+              autocorrect(corrector, node)
+            end
           end
         end
 
@@ -71,6 +59,19 @@ module RuboCop
           format(MSG, method_name: method_name)
         end
 
+        def autocorrect(corrector, node)
+          field = RuboCop::GraphQL::Field.new(node)
+          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}")
+
+          range = range_with_surrounding_space(
+            range: method_definition.loc.expression, side: :left
+          )
+          corrector.remove(range)
+        end
+
         def suggest_method_name_for(field)
           method_name = field.resolver_method_name
           field.schema_member.find_method_definition(method_name)

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

@@ -18,7 +18,7 @@ module RuboCop
       #     field :firstName, String, null: true
       #   end
       #
-      class FieldName < Cop
+      class FieldName < Base
         include RuboCop::GraphQL::NodePattern
 
         using RuboCop::GraphQL::Ext::SnakeCase

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This cop checks whether type definitions are class-based or legacy.
+    #
+    # @example
+    #   # good
+    #
+    #   class Example < BaseType
+    #     ....
+    #   end
+    #
+    #   # bad
+    #
+    #   Example = GraphQL::ObjectType.define do
+    #     ....
+    #     ....
+    #   end
+    #
+    module GraphQL
+      class LegacyDsl < Base
+        def_node_matcher :legacy_dsl?, <<~PATTERN
+          (block
+            (send
+              (const
+                (const nil? :GraphQL) _) :define)
+            ...
+          )
+        PATTERN
+
+        MSG = "Avoid using legacy based type-based definitions. Use class-based defintions instead."
+
+        def on_send(node)
+          return unless node.parent.type == :block
+
+          add_offense(node.parent) if legacy_dsl?(node.parent)
+        end
+      end
+    end
+  end
+end

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

@@ -20,7 +20,7 @@ module RuboCop
       #     # ...
       #   end
       #
-      class ObjectDescription < Cop
+      class ObjectDescription < Base
         include RuboCop::GraphQL::NodePattern
         include RuboCop::GraphQL::DescriptionMethod
 

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

@@ -48,15 +48,16 @@ module RuboCop
       #     end
       #   end
       #
-      class OrderedArguments < Cop
+      class OrderedArguments < Base
+        extend AutoCorrector
+
+        include RuboCop::GraphQL::SwapRange
+
         MSG = "Arguments 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?
-
-          argument_declarations(processed_source.ast)
-            .each_cons(2) do |previous, current|
+        def on_class(node)
+          argument_declarations(node).each_cons(2) do |previous, current|
             next unless consecutive_lines(previous, current)
             next if argument_name(current) > argument_name(previous)
 
@@ -64,43 +65,18 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          declarations = argument_declarations(processed_source.ast)
-          node_index = declarations.map(&:location).find_index(node.location)
-          previous_declaration = declarations.to_a[node_index - 1]
-
-          current_range = declaration(node)
-          previous_range = declaration(previous_declaration)
-
-          lambda do |corrector|
-            swap_range(corrector, current_range, previous_range)
-          end
-        end
-
         private
 
-        def declaration(node)
-          buffer = processed_source.buffer
-          begin_pos = node.source_range.begin_pos
-          end_line = buffer.line_for_position(node.loc.expression.end_pos)
-          end_pos = buffer.line_range(end_line).end_pos
-          Parser::Source::Range.new(buffer, begin_pos, end_pos)
-        end
-
-        def swap_range(corrector, range1, range2)
-          src1 = range1.source
-          src2 = range2.source
-          corrector.replace(range1, src2)
-          corrector.replace(range2, src1)
-        end
-
         def register_offense(previous, current)
           message = format(
             self.class::MSG,
             previous: argument_name(previous),
             current: argument_name(current)
           )
-          add_offense(current, message: message)
+
+          add_offense(current, message: message) do |corrector|
+            swap_range(corrector, current, previous)
+          end
         end
 
         def argument_name(node)

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

@@ -30,33 +30,21 @@ module RuboCop
       #     field :name, String, null: true
       #   end
       #
-      class OrderedFields < Cop
+      class OrderedFields < Base
+        extend AutoCorrector
+
+        include RuboCop::GraphQL::SwapRange
+
         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
-
-        def autocorrect(node)
-          declarations = field_declarations(processed_source.ast)
-          node_index = declarations.map(&:location).find_index(node.location)
-          previous_declaration = declarations.to_a[node_index - 1]
-
-          current_range = declaration(node)
-          previous_range = declaration(previous_declaration)
+        def on_class(node)
+          field_declarations(node).each_cons(2) do |previous, current|
+            next unless consecutive_lines(previous, current)
+            next if field_name(current) > field_name(previous)
 
-          lambda do |corrector|
-            swap_range(corrector, current_range, previous_range)
+            register_offense(previous, current)
           end
         end
 
@@ -68,7 +56,10 @@ module RuboCop
             previous: field_name(previous),
             current: field_name(current)
           )
-          add_offense(current, message: message)
+
+          add_offense(current, message: message) do |corrector|
+            swap_range(corrector, current, previous)
+          end
         end
 
         def field_name(node)
@@ -83,21 +74,6 @@ module RuboCop
           previous.source_range.last_line == current.source_range.first_line - 1
         end
 
-        def declaration(node)
-          buffer = processed_source.buffer
-          begin_pos = node.source_range.begin_pos
-          end_line = buffer.line_for_position(node.loc.expression.end_pos)
-          end_pos = buffer.line_range(end_line).end_pos
-          Parser::Source::Range.new(buffer, begin_pos, end_pos)
-        end
-
-        def swap_range(corrector, range1, range2)
-          src1 = range1.source
-          src2 = range2.source
-          corrector.replace(range1, src2)
-          corrector.replace(range2, src1)
-        end
-
         def_node_search :field_declarations, <<~PATTERN
           {
             (send nil? :field (:sym _) ...)

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

@@ -7,7 +7,7 @@ module RuboCop
       # Comment lines can optionally be ignored.
       #
       # The maximum allowed length is configurable using the Max option.
-      class ResolverMethodLength < Cop
+      class ResolverMethodLength < Base
         include RuboCop::Cop::ConfigurableMax
         include RuboCop::Cop::CodeLength
 

data/lib/rubocop/cop/graphql_cops.rb

@@ -9,6 +9,7 @@ require_relative "graphql/field_description"
 require_relative "graphql/field_hash_key"
 require_relative "graphql/field_method"
 require_relative "graphql/field_name"
+require_relative "graphql/legacy_dsl"
 require_relative "graphql/resolver_method_length"
 require_relative "graphql/object_description"
 require_relative "graphql/ordered_arguments"

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

@@ -20,7 +20,7 @@ module RuboCop
         PATTERN
 
         def initialize(argument_node)
-          @nodes = argument_kwargs(argument_node)
+          @nodes = argument_kwargs(argument_node) || []
         end
 
         def description

data/lib/rubocop/graphql/swap_range.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    module SwapRange
+      def swap_range(corrector, current, previous)
+        current_range = declaration(current)
+        previous_range = declaration(previous)
+
+        src1 = current_range.source
+        src2 = previous_range.source
+
+        corrector.replace(current_range, src2)
+        corrector.replace(previous_range, src1)
+      end
+
+      def declaration(node)
+        buffer = processed_source.buffer
+        begin_pos = node.source_range.begin_pos
+        end_line = buffer.line_for_position(node.loc.expression.end_pos)
+        end_pos = buffer.line_range(end_line).end_pos
+        Parser::Source::Range.new(buffer, begin_pos, end_pos)
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.8.2".freeze
+    VERSION = "0.9.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - 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/legacy_dsl.rb
 - lib/rubocop/cop/graphql/object_description.rb
 - lib/rubocop/cop/graphql/ordered_arguments.rb
 - lib/rubocop/cop/graphql/ordered_fields.rb
@@ -109,6 +110,7 @@ files:
 - lib/rubocop/graphql/inject.rb
 - lib/rubocop/graphql/node_pattern.rb
 - lib/rubocop/graphql/schema_member.rb
+- lib/rubocop/graphql/swap_range.rb
 - lib/rubocop/graphql/version.rb
 homepage: https://github.com/DmitryTsepelev/rubocop-graphql
 licenses: