rubocop-graphql 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bcabdbafaf927896c569183254a11c60352414d91978553dcc12449cc45b46c
-  data.tar.gz: b9edc6b4444b21ecde01fceffbb027489aa59241886ba1f6e09f1488ae73a0f2
+  metadata.gz: 9cdf5152e0106f86e952fbf5a24a38011914f34b0167a19ef0cf53dd810e4d68
+  data.tar.gz: 9ed0ac94bdc4f323543e1085a612dfb3d02f5e60ee55892da6894b202718865e
 SHA512:
-  metadata.gz: 02fbc1b2402f0661737a188a5aa107376210ba30ca52d1461da8e5ba7312ef2c548d3485ea2630194422e4379368f4efd595b0ac2c6affdc4432939344c7f956
-  data.tar.gz: 6472b601c9ba130fe97eac98d556a4f9113884e95290c8c751d321c123d1ff54ac31396d7fc53885001c55a62a3e66941547a4dd5f761af5e72a7a1b46f74a2c
+  metadata.gz: 992563e33d74e91766b4917a541ef9361795156f93eb33a95f0944e4968f87a5845681adff07178a30cd11b10c6b2e10ea002e2688b2a501cc6b9e25bb1bc103
+  data.tar.gz: 2cf037f19ca63a512ea00a06601cf49dcc46ed5bb59deec1ede2e45dcd74acfd875b7febf7f703b36354fa4059dd222ca5f37fb59a11572c7cc8d4ffb97389a9

data/config/default.yml

@@ -119,6 +119,7 @@ GraphQL/NotAuthorizedNodeType:
   Description: 'Detects types that implement Node interface and not have `.authorized?` check'
   Include:
     - '**/graphql/types/**/*'
+  SafeBaseClasses: []
 
 GraphQL/ResolverMethodLength:
   Enabled: true
@@ -141,12 +142,14 @@ GraphQL/OrderedArguments:
   Enabled: true
   VersionAdded: '0.7.0'
   Description: 'Arguments should be alphabetically sorted within groups'
+  Order: null
 
 GraphQL/OrderedFields:
   Enabled: true
   VersionAdded: '0.5.0'
   Description: 'Fields should be alphabetically sorted within groups'
   Groups: true
+  Order: null
 
 GraphQL/UnusedArgument:
   Enabled: true

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

@@ -74,7 +74,7 @@ module RuboCop
           suggested_hash_key_name = hash_key_to_use(method_definition)
 
           corrector.insert_after(
-            node.source_range, ", hash_key: #{suggested_hash_key_name.inspect}"
+            node, ", hash_key: #{suggested_hash_key_name.inspect}"
           )
 
           range = range_with_surrounding_space(

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

@@ -51,6 +51,7 @@ module RuboCop
 
           return if suggested_method_name.nil?
           return if RuboCop::GraphQL::Field::CONFLICT_FIELD_NAMES.include?(suggested_method_name)
+          return if method_kwarg_set?(field)
 
           add_offense(node, message: message(suggested_method_name)) do |corrector|
             autocorrect(corrector, node)
@@ -68,7 +69,7 @@ module RuboCop
           method_definition = suggest_method_name_for(field)
           suggested_method_name = method_to_use(method_definition)
 
-          corrector.insert_after(node.source_range, ", method: :#{suggested_method_name}")
+          corrector.insert_after(node, ", method: :#{suggested_method_name}")
 
           range = range_with_surrounding_space(
             range: method_definition.source_range, side: :left
@@ -80,6 +81,10 @@ module RuboCop
           method_name = field.resolver_method_name
           field.schema_member.find_method_definition(method_name)
         end
+
+        def method_kwarg_set?(field)
+          field.kwargs.method != nil
+        end
       end
     end
   end

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

@@ -7,6 +7,9 @@ module RuboCop
       # Such types can be fetched by ID and therefore should have type level check to
       # avoid accidental information exposure.
       #
+      # If `.authorized?` is defined in a parent class, you can add parent to the "SafeBaseClasses"
+      # to avoid offenses in children.
+      #
       # @example
       #   # good
       #
@@ -45,6 +48,11 @@ module RuboCop
       class NotAuthorizedNodeType < Base
         MSG = ".authorized? should be defined for types implementing Node interface."
 
+        # @!method class_name(node)
+        def_node_matcher :class_name, <<~PATTERN
+          (const nil? $_)
+        PATTERN
+
         # @!method implements_node_type?(node)
         def_node_matcher :implements_node_type?, <<~PATTERN
           `(send nil? :implements
@@ -60,8 +68,20 @@ module RuboCop
         PATTERN
 
         def on_class(node)
+          return if ignored_class?(parent_class(node))
+
           add_offense(node) if implements_node_type?(node) && !has_authorized_method?(node)
         end
+
+        private
+
+        def parent_class(node)
+          node.child_nodes[1]
+        end
+
+        def ignored_class?(node)
+          cop_config["SafeBaseClasses"].include?(String(class_name(node)))
+        end
       end
     end
   end

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

@@ -52,6 +52,7 @@ module RuboCop
         extend AutoCorrector
 
         include RuboCop::GraphQL::SwapRange
+        include RuboCop::GraphQL::CompareOrder
 
         MSG = "Arguments should be sorted in an alphabetical order within their section. " \
               "Field `%<current>s` should appear before `%<previous>s`."
@@ -71,7 +72,7 @@ module RuboCop
 
           argument_declarations.each_cons(2) do |previous, current|
             next unless consecutive_lines(previous, current)
-            next if argument_name(current) >= argument_name(previous)
+            next if correct_order?(argument_name(previous), argument_name(current))
 
             register_offense(previous, current)
           end

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

@@ -34,6 +34,7 @@ module RuboCop
         extend AutoCorrector
 
         include RuboCop::GraphQL::SwapRange
+        include RuboCop::GraphQL::CompareOrder
 
         MSG = "Fields should be sorted in an alphabetical order within their "\
               "section. "\
@@ -51,7 +52,7 @@ module RuboCop
         def on_class(node)
           field_declarations(node).each_cons(2) do |previous, current|
             next unless consecutive_fields(previous, current)
-            next if field_name(current) >= field_name(previous)
+            next if correct_order?(field_name(previous), field_name(current))
 
             register_offense(previous, current)
           end

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

@@ -10,27 +10,33 @@ module RuboCop
       #
       #   class UserType < BaseType
       #     field :name, String, "Name of the user", null: true do
-      #       argument :filter, String, required: false, camelize: false
+      #       argument :filter, String, required: false
       #     end
       #   end
       #
       #   # good
       #
       #   class UserType < BaseType
-      #     argument :filter, String, required: false, camelize: false
+      #     argument :filter, String, required: false
+      #   end
+      #
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     argument :email_filter, String, required: false, camelize: true
       #   end
       #
       #  # bad
       #
       #   class UserType < BaseType
-      #     argument :filter, String, required: false
+      #     argument :filter, String, required: false, camelize: false
       #   end
       #
       #  # bad
       #
       #   class UserType < BaseType
       #     field :name, String, "Name of the user", null: true do
-      #       argument :filter, String, required: false
+      #       argument :filter, String, required: false, camelize: false
       #     end
       #   end
       #

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

@@ -21,6 +21,7 @@ module RuboCop
       #   field :name, String, "Name of the user", null: true, hash_key: :name
       #
       class UnnecessaryFieldAlias < Base
+        extend AutoCorrector
         include RuboCop::GraphQL::NodePattern
 
         MSG = "Unnecessary :%<kwarg>s configured"
@@ -32,7 +33,13 @@ module RuboCop
 
           if (unnecessary_kwarg = validate_kwargs(field))
             message = format(self.class::MSG, kwarg: unnecessary_kwarg)
-            add_offense(node, message: message)
+            add_offense(node, message: message) do |corrector|
+              kwarg_node = node.arguments.last.pairs.find do |pair|
+                pair.key.value == unnecessary_kwarg.to_sym
+              end
+              corrector.remove_preceding(kwarg_node, 2)
+              corrector.remove(kwarg_node)
+            end
           end
         end
 

data/lib/rubocop/graphql/compare_order.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    module CompareOrder
+      def correct_order?(previous, current)
+        # If Order config is provided, we should use it to determine the order
+        # Else, we should use alphabetical order
+        # e.g. "Order" => [
+        #   "id",
+        #   "/^id_.*$/",
+        #   "/^.*_id$/",
+        #   "everything-else",
+        #   "/^(created|updated)_at$/"
+        # ]
+        if (order = cop_config["Order"])
+          # For each of previous and current, we should find the first matching order,
+          # checking 'everything-else' last
+          # If the order is the same, we should use alphabetical order
+          # If the order is different, we should use the order
+          previous_order = order_index(previous, order)
+          current_order = order_index(current, order)
+
+          if previous_order == current_order
+            previous <= current
+          else
+            previous_order < current_order
+          end
+        else
+          previous <= current
+        end
+      end
+
+      def order_index(field, order)
+        everything_else_index = order.length
+
+        order.each_with_index do |order_item, index|
+          if order_item == "everything-else"
+            everything_else_index = index
+          elsif order_item.start_with?("/") && order_item.end_with?("/") # is regex-like?
+            return index if field.match?(order_item[1..-2])
+          elsif field == order_item
+            return index
+          end
+        end
+
+        everything_else_index
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/ext/snake_case.rb

@@ -4,7 +4,7 @@ module RuboCop
   module GraphQL
     module Ext
       module SnakeCase
-        SNAKE_CASE = /^[\da-z_]+[!?=]?$/.freeze
+        SNAKE_CASE = /^[\da-z_]+[!?=]?$/
 
         refine Symbol do
           def snake_case?

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "1.1.1".freeze
+    VERSION = "1.3.0".freeze
   end
 end

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/compare_order"
 require_relative "rubocop/graphql/description_method"
 require_relative "rubocop/graphql/heredoc"
 require_relative "rubocop/graphql/node_pattern"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/rubocop/graphql/argument/block.rb
 - lib/rubocop/graphql/argument/kwargs.rb
 - lib/rubocop/graphql/class.rb
+- lib/rubocop/graphql/compare_order.rb
 - lib/rubocop/graphql/description_method.rb
 - lib/rubocop/graphql/ext/snake_case.rb
 - lib/rubocop/graphql/field.rb
@@ -143,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="