rubocop-graphql 0.4.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67638fefeb268ea870db034bc46363245b644ec8df5f620878e8e1c90b681975
-  data.tar.gz: b378c1830557ccbf00b7be144b6ac6141c7246e60b848d91b14a5cc8eee86a2a
+  metadata.gz: 99b9cc340e883dfe2dd4d0662a04383fde0a0b648cd1716f8aaec8eef8aab486
+  data.tar.gz: 928eee0593772d1614c6527ebefeb11753b3797408a98bdd84ae6c6fa46ca8da
 SHA512:
-  metadata.gz: e9dbfcab7cdb4820b9ab7d1a9425bb1378bcc279aebb82116058398f9b66b97d90c6af5edf38dd0c94d079f57395ffc7055936e00d89ec98c72e606b4c4d955a
-  data.tar.gz: 0dd262d908e7de3cbb2fc8b57aab421a7e32214f42322c1bdeab03f43b96072e349e2d0165158df123e78cf0700b9bebc95acb4876a7b5ba655c0fa44eb566f6
+  metadata.gz: 736f86f09bc7123fd0c5227ce35f771a83d75532d9231becd4a444b725fbddac7494fadcbffe929ddfcb0609e6ff80d53510d379792141e12d5d7c3fb08f4056
+  data.tar.gz: 2603c7d27cccd23e904c9345b9b1728a16bf99a1c03162ff93281a0a64f7f1621f5f8ad874af950671275be4a8f743dbbae71e8439d0f369b8ae4c9b5586e26e

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

@@ -12,7 +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
@@ -47,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/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

@@ -33,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
@@ -54,7 +58,9 @@ module RuboCop
         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_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

@@ -0,0 +1,111 @@
+# 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
+
+        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)
+          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 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 _) ...)
+            (block
+              (send nil? :field (:sym _) ...) ...)
+          }
+        PATTERN
+      end
+    end
+  end
+end

data/lib/rubocop/cop/graphql_cops.rb

@@ -13,3 +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.4.1".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.4.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,22 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         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.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,8 @@ 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
 - lib/rubocop/graphql.rb
@@ -109,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,8 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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: []