rubocop-graphql 0.6.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47871bc7644dbf0fb1f5c9b25af8d5f60183a8513d90f5a62d980b0fc865f9ad
-  data.tar.gz: 18177a7497deef3c5342405b5b393eb5e1bae75cbf8e8eee5da636c814b51ea0
+  metadata.gz: 22be8928aa9fbce1700f99d21ccddacd9590ab7bd6c6723e4b7458f974e02f66
+  data.tar.gz: 6e06404047cba621b7493912723fa5eac13c19004d128339e494455758871831
 SHA512:
-  metadata.gz: 7d2f3153652722d359d0ee0d5c6da8f9d03e1cae62c78e1e5f1b9fc577cfc361fd39cdfa0cd0addee6fb6c0e36b8c51bca485cc18f9c15fa3b1495d941668b0d
-  data.tar.gz: bcb8a5d5938abd6b9be712f51a6363c31098d604dafcf725a8da6edff5d737c42532b329ba831d1d09277f78d340da9d105b58c37b0b494d5e526a882eda70b1
+  metadata.gz: 94e9c24116f399d08b0c264e4b1b6c5dc50ac9436833fd8ec9f4916bdae102f5fdd5df5589a31502bca8aa65ccc61448a24b2e57aded363c35e6b0adec1513f6
+  data.tar.gz: '0855eb683b91a3d5bb6e78b89c7c3089df5832813b1c298b26edf56de2e3c4ee71da837d279bad5ce15fd4dbcf9197fe908f81f77967a7b7345c9a1b3fdcb1f2'

data/config/default.yml

@@ -1,7 +1,6 @@
-AllCops:
-  GraphQL:
-    Patterns:
-      - "(?:^|/)graphql/"
+GraphQL:
+  Include:
+    - "**/graphql/**/*"
 
 GraphQL/ArgumentDescription:
   Enabled: true
@@ -74,4 +73,4 @@ GraphQL/ObjectDescription:
   Description: 'Ensures all types have a description'
   Exclude:
     - '**/*_schema.rb'
-    - '**/base_*.rb'
+    - '**/base_*.rb'

data/lib/rubocop-graphql.rb

@@ -7,6 +7,7 @@ require_relative "rubocop/graphql/ext/snake_case"
 require_relative "rubocop/graphql"
 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/argument"

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

@@ -32,7 +32,12 @@ module RuboCop
           if (body = schema_member.body)
             arguments = body.select { |node| argument?(node) }
 
-            add_offense(arguments.last) if arguments.count > cop_config["MaxArguments"]
+            excess_arguments = arguments.count - cop_config["MaxArguments"]
+            return unless excess_arguments.positive?
+
+            arguments.last(excess_arguments).each do |excess_argument|
+              add_offense(excess_argument)
+            end
           end
         end
       end

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

@@ -109,7 +109,7 @@ module RuboCop
             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)
@@ -143,7 +143,7 @@ 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)
 

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

@@ -22,6 +22,7 @@ module RuboCop
       #
       class ObjectDescription < Cop
         include RuboCop::GraphQL::NodePattern
+        include RuboCop::GraphQL::DescriptionMethod
 
         MSG = "Missing type description"
 
@@ -29,10 +30,6 @@ module RuboCop
           (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
@@ -54,7 +51,8 @@ module RuboCop
         private
 
         def has_description?(node)
-          has_i18n_description?(node) || has_string_description?(node)
+          has_i18n_description?(node) ||
+            description_kwarg?(node)
         end
 
         def child_nodes(node)

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      # Arguments should be alphabetically sorted within groups.
+      #
+      # @example
+      #   # good
+      #
+      #   class UpdateProfile < BaseMutation
+      #     argument :email, String, required: false
+      #     argument :name, String, required: false
+      #   end
+      #
+      #   # good
+      #
+      #   class UpdateProfile < BaseMutation
+      #     argument :uuid, ID, required: true
+      #
+      #     argument :email, String, required: false
+      #     argument :name, String, required: false
+      #   end
+      #
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :posts, PostType do
+      #       argument :created_after, ISO8601DateTime, required: false
+      #       argument :created_before, ISO8601DateTime, required: false
+      #     end
+      #   end
+      #
+      #   # bad
+      #
+      #   class UpdateProfile < BaseMutation
+      #     argument :uuid, ID, required: true
+      #     argument :name, String, required: false
+      #     argument :email, String, required: false
+      #   end
+      #
+      #   # bad
+      #
+      #   class UserType < BaseType
+      #     field :posts, PostType do
+      #       argument :created_before, ISO8601DateTime, required: false
+      #       argument :created_after, ISO8601DateTime, required: false
+      #     end
+      #   end
+      #
+      class OrderedArguments < Cop
+        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|
+            next unless consecutive_lines(previous, current)
+            next if argument_name(current) > argument_name(previous)
+
+            register_offense(previous, current)
+          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)
+        end
+
+        def argument_name(node)
+          node.first_argument.value.to_s
+        end
+
+        def consecutive_lines(previous, current)
+          previous.source_range.last_line == current.source_range.first_line - 1
+        end
+
+        def_node_search :argument_declarations, <<~PATTERN
+          (send nil? :argument (:sym _) ...)
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -47,6 +47,19 @@ module RuboCop
             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)
+
+          lambda do |corrector|
+            swap_range(corrector, current_range, previous_range)
+          end
+        end
+
         private
 
         def register_offense(previous, current)
@@ -70,6 +83,21 @@ 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_cops.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "graphql/cop"
-
 require_relative "graphql/argument_description"
 require_relative "graphql/argument_name"
 require_relative "graphql/extract_input_type"
@@ -13,4 +11,5 @@ 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_arguments"
 require_relative "graphql/ordered_fields"

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

@@ -5,6 +5,7 @@ module RuboCop
     class Argument
       class Block
         extend RuboCop::NodePattern::Macros
+        include DescriptionMethod
 
         def_node_matcher :argument_block, <<~PATTERN
           (block
@@ -14,16 +15,12 @@ module RuboCop
           )
         PATTERN
 
-        def_node_matcher :description_kwarg?, <<~PATTERN
-          (send nil? :description (str ...))
-        PATTERN
-
         def initialize(argument_node)
           @nodes = argument_block(argument_node) || []
         end
 
         def description
-          @nodes.find { |kwarg| description_kwarg?(kwarg) }
+          find_description_method(@nodes)
         end
       end
     end

data/lib/rubocop/graphql/description_method.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    # Matches a variety of description formats commonly seen in Rails applications
+    #
+    #   description 'blah'
+    #
+    #   description "blah"
+    #
+    #   description <<~EOT
+    #      blah
+    #      bloop
+    #   EOT
+    #
+    #   description <<-EOT.squish
+    #      blah
+    #      bloop
+    #   EOT
+    module DescriptionMethod
+      extend RuboCop::NodePattern::Macros
+
+      def_node_matcher :description_kwarg?, <<~PATTERN
+        (send nil? :description {({str|dstr} ...)|(send ({str|dstr} ...) _)})
+      PATTERN
+
+      def find_description_method(nodes)
+        nodes.find { |kwarg| description_kwarg?(kwarg) }
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ module RuboCop
     class Field
       class Block
         extend RuboCop::NodePattern::Macros
+        include DescriptionMethod
 
         def_node_matcher :field_block, <<~PATTERN
           (block
@@ -14,16 +15,12 @@ module RuboCop
           )
         PATTERN
 
-        def_node_matcher :description_kwarg?, <<~PATTERN
-          (send nil? :description (str ...))
-        PATTERN
-
         def initialize(field_node)
           @nodes = field_block(field_node) || []
         end
 
         def description
-          @nodes.find { |kwarg| description_kwarg?(kwarg) }
+          find_description_method(@nodes)
         end
       end
     end

data/lib/rubocop/graphql/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Dmitry Tsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,7 +85,6 @@ files:
 - lib/rubocop-graphql.rb
 - lib/rubocop/cop/graphql/argument_description.rb
 - lib/rubocop/cop/graphql/argument_name.rb
-- lib/rubocop/cop/graphql/cop.rb
 - lib/rubocop/cop/graphql/extract_input_type.rb
 - lib/rubocop/cop/graphql/extract_type.rb
 - lib/rubocop/cop/graphql/field_definitions.rb
@@ -94,6 +93,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_arguments.rb
 - lib/rubocop/cop/graphql/ordered_fields.rb
 - lib/rubocop/cop/graphql/resolver_method_length.rb
 - lib/rubocop/cop/graphql_cops.rb
@@ -101,6 +101,7 @@ files:
 - lib/rubocop/graphql/argument.rb
 - lib/rubocop/graphql/argument/block.rb
 - lib/rubocop/graphql/argument/kwargs.rb
+- lib/rubocop/graphql/description_method.rb
 - lib/rubocop/graphql/ext/snake_case.rb
 - lib/rubocop/graphql/field.rb
 - lib/rubocop/graphql/field/block.rb
@@ -116,7 +117,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
@@ -124,15 +125,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 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: []

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

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  # Inspied by https://github.com/rubocop-hq/rubocop-rspec/blob/3a2088f79737e2e8e0e21482783f7d61411bf021/lib/rubocop/cop/rspec/cop.rb
-  module Cop
-    WorkaroundGraphqlCop = Cop.dup
-
-    # Clone of the the normal RuboCop::Cop::Cop class so we can rewrite
-    # the inherited method without breaking functionality
-    class WorkaroundGraphqlCop
-      # Remove the Cop.inherited method to be a noop. Our RSpec::Cop
-      # class will invoke the inherited hook instead
-      class << self
-        undef inherited
-        def inherited(*); end
-      end
-
-      # Special case `Module#<` so that the rspec support rubocop exports
-      # is compatible with our subclass
-      def self.<(other)
-        other.equal?(RuboCop::Cop::Cop) || super
-      end
-    end
-    private_constant(:WorkaroundGraphqlCop)
-
-    module GraphQL
-      # @abstract parent class to graphql-ruby cops
-      #
-      # The criteria for whether rubocop-rspec analyzes a certain ruby file
-      # is configured via `AllCops/GraphQL`. For example, if you want to
-      # customize your project to scan all files within a `graph/` directory
-      # then you could add this to your configuration:
-      #
-      # @example configuring analyzed paths
-      #
-      #   AllCops:
-      #     GraphQL:
-      #       Patterns:
-      #       - '(?:^|/)graph/'
-      class Cop < WorkaroundGraphqlCop
-        DEFAULT_CONFIGURATION =
-          RuboCop::GraphQL::CONFIG.fetch("AllCops").fetch("GraphQL")
-
-        DEFAULT_PATTERN_RE = Regexp.union(
-          DEFAULT_CONFIGURATION.fetch("Patterns")
-                               .map(&Regexp.public_method(:new))
-        )
-
-        # Invoke the original inherited hook so our cops are recognized
-        def self.inherited(subclass)
-          RuboCop::Cop::Cop.inherited(subclass)
-        end
-
-        def relevant_file?(file)
-          relevant_rubocop_graphql_file?(file) && super
-        end
-
-        private
-
-        def relevant_rubocop_graphql_file?(file)
-          graphql_pattern =~ file
-        end
-
-        def graphql_pattern
-          if rspec_graphql_config?
-            Regexp.union(rspec_graphql_config.map(&Regexp.public_method(:new)))
-          else
-            DEFAULT_PATTERN_RE
-          end
-        end
-
-        def all_cops_config
-          config
-            .for_all_cops
-        end
-
-        def rspec_graphql_config?
-          return unless all_cops_config.key?("GraphQL")
-
-          all_cops_config.fetch("GraphQL").key?("Patterns")
-        end
-
-        def rspec_graphql_config
-          all_cops_config
-            .fetch("GraphQL", DEFAULT_CONFIGURATION)
-            .fetch("Patterns")
-        end
-      end
-    end
-  end
-end