rubocop-graphql 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2393f8c4972a479e9618f3ed9f846a819b0efa8bf13e53f319bbc176c50a470b
-  data.tar.gz: 4326de68922f560a042ecbee99f70f421a09c05e0502291e4b4624c90a369233
+  metadata.gz: 99b9cc340e883dfe2dd4d0662a04383fde0a0b648cd1716f8aaec8eef8aab486
+  data.tar.gz: 928eee0593772d1614c6527ebefeb11753b3797408a98bdd84ae6c6fa46ca8da
 SHA512:
-  metadata.gz: 1d65dbf3f6d5a623afbd74524e485ff4c570157ab23eae396e7ca5e343ff3ea2546d8433fc67dff38e2d63985ebc2881de3ba37e58ed5943ef2521fb2be93d36
-  data.tar.gz: 718957be35d17116319a4d18ba707b96236e813e9acd8fa724888623550f6dffafc2c07e774a181f5f576c2e949d92e3c264badc2c30ef4897d440781a3b1c32
+  metadata.gz: 736f86f09bc7123fd0c5227ce35f771a83d75532d9231becd4a444b725fbddac7494fadcbffe929ddfcb0609e6ff80d53510d379792141e12d5d7c3fb08f4056
+  data.tar.gz: 2603c7d27cccd23e904c9345b9b1728a16bf99a1c03162ff93281a0a64f7f1621f5f8ad874af950671275be4a8f743dbbae71e8439d0f369b8ae4c9b5586e26e

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

@@ -13,4 +13,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/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.6.2".freeze
+    VERSION = "0.7.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,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_arguments.rb
 - lib/rubocop/cop/graphql/ordered_fields.rb
 - lib/rubocop/cop/graphql/resolver_method_length.rb
 - lib/rubocop/cop/graphql_cops.rb