rubocop-graphql 0.16.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f884b232227042a66670cda20f99b749f559dfc1429c1803c4545c0335885c
-  data.tar.gz: 4ae6307ab827039a5dacff35d4075e123c2288752542923ea3ca2c7122658242
+  metadata.gz: 80b3609f1de18b1e5db7198fdf29f7deed28cfe0e505c9485203dd38172ff4f9
+  data.tar.gz: 0d894dad1bc37192b76372d235d10fab4181e171574f471091e9bad0033212d2
 SHA512:
-  metadata.gz: 0c00f215519826a44d044a1cf6f87aa6402c179213a7c8650632a73cf45871ee4daf31f0b9c1a6d203448b0e3259687085612521242f314287f683ca51cc5137
-  data.tar.gz: df7fc7edf61e5a66adb94ab131da35625ef4106cdef87cdd3859e1d63604fadda1725b8f0284f80e47bf2f2300395876b91a7637aea746ce83dc191a107961a8
+  metadata.gz: 3c2b2d1bcbae2e53e28567c0f13397f77427cc0b9d87a96171cd27fec5d33649568366a623c6ea7c6960f452709d02081c04e3dae1368b465da4fad304ae9ce5
+  data.tar.gz: b6b5588432b38eaa545bff20b2f52d966859ba1fac6fcad5004f22405fd4d1dab56c04238124f99f3ff1df860b385773e539981221b94d0e8c4c27266d4a7c9e

data/README.md

@@ -1,13 +1,7 @@
-# RuboCop::GraphQL
+# RuboCop::GraphQL ![](https://ruby-gem-downloads-badge.herokuapp.com/rubocop-graphql?type=total)
 
 [Rubocop](https://github.com/rubocop-hq/rubocop) extension for enforcing [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) best practices.
 
-<p align="center">
-  <a href="https://evilmartians.com/?utm_source=graphql-rubocop">
-    <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
-  </a>
-</p>
-
 ## Installation
 
 Install the gem:
@@ -69,6 +63,10 @@ GraphQL/ResolverMethodLength:
   Max: 3
 ```
 
+## Credits
+
+Initially sponsored by [Evil Martians](http://evilmartians.com).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryTsepelev/rubocop-graphql.

data/config/default.yml

@@ -73,6 +73,8 @@ GraphQL/ExtractInputType:
   VersionAdded: '0.80'
   Description: 'Suggests using input type instead of many arguments'
   MaxArguments: 2
+  Include:
+    - '**/graphql/mutations/**/*.rb'
 
 GraphQL/ExtractType:
   Enabled: true
@@ -99,6 +101,7 @@ GraphQL/ObjectDescription:
   Exclude:
     - '**/*_schema.rb'
     - '**/base_*.rb'
+    - '**/graphql/query_context.rb'
 
 GraphQL/OrderedArguments:
   Enabled: true
@@ -113,3 +116,15 @@ GraphQL/OrderedFields:
 GraphQL/UnusedArgument:
   Enabled: true
   Description: 'Arguments should either be listed explicitly or **rest should be in the resolve signature'
+
+GraphQL/UnnecessaryFieldAlias:
+  Enabled: true
+  Description: 'Field aliases should be different than their field names'
+
+GraphQL/UnnecessaryArgumentCamelize:
+  Enabled: true
+  Description: "Camelize isn't necessary if the argument name doesn't contain underscores"
+
+GraphQL/UnnecessaryFieldCamelize:
+  Enabled: true
+  Description: "Camelize isn't necessary if the field name doesn't contain underscores"

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop checks if each argument has an unnecessary camelize.
+      #
+      # @example
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :name, String, "Name of the user", null: true do
+      #       argument :filter, String, required: false, camelize: false
+      #     end
+      #   end
+      #
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     argument :filter, String, required: false, camelize: false
+      #   end
+      #
+      #  # bad
+      #
+      #   class UserType < BaseType
+      #     argument :filter, String, required: false
+      #   end
+      #
+      #  # bad
+      #
+      #   class UserType < BaseType
+      #     field :name, String, "Name of the user", null: true do
+      #       argument :filter, String, required: false
+      #     end
+      #   end
+      #
+      class UnnecessaryArgumentCamelize < Base
+        include RuboCop::GraphQL::NodePattern
+
+        MSG = "Unnecessary argument camelize"
+
+        def on_send(node)
+          return unless argument?(node)
+
+          argument = RuboCop::GraphQL::Argument.new(node)
+
+          if argument.name.to_s.split("_").length < 2 && !argument.kwargs.camelize.nil?
+            add_offense(node)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop checks if a field has an unnecessary alias.
+      #
+      # @example
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :name, String, "Name of the user", null: true, alias: :real_name
+      #   end
+      #
+      #   # bad
+      #
+      #   class UserType < BaseType
+      #     field :name, "Name of the user" String, null: true, alias: :name
+      #   end
+      #
+      class UnnecessaryFieldAlias < Base
+        include RuboCop::GraphQL::NodePattern
+
+        MSG = "Unnecessary field alias"
+
+        def on_send(node)
+          return unless field_definition?(node)
+
+          field = RuboCop::GraphQL::Field.new(node)
+
+          add_offense(node) if field.name == field.kwargs.alias
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop checks if each field has an unnecessary camelize.
+      #
+      # @example
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :name, String, "Name of the user", null: true
+      #   end
+      #
+      #   # bad
+      #
+      #   class UserType < BaseType
+      #     field :name, "Name of the user", String, null: true, camelize: true
+      #   end
+      #
+      class UnnecessaryFieldCamelize < Base
+        include RuboCop::GraphQL::NodePattern
+
+        MSG = "Unnecessary field camelize"
+
+        def on_send(node)
+          return unless field_definition?(node)
+
+          field = RuboCop::GraphQL::Field.new(node)
+
+          add_offense(node) if field.name.to_s.split("_").length < 2 && !field.kwargs.camelize.nil?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/graphql_cops.rb

@@ -18,3 +18,6 @@ require_relative "graphql/object_description"
 require_relative "graphql/ordered_arguments"
 require_relative "graphql/ordered_fields"
 require_relative "graphql/unused_argument"
+require_relative "graphql/unnecessary_argument_camelize"
+require_relative "graphql/unnecessary_field_alias"
+require_relative "graphql/unnecessary_field_camelize"

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

@@ -31,6 +31,11 @@ module RuboCop
           (pair (sym :as) ...)
         PATTERN
 
+        # @!method camelize_kwarg?(node)
+        def_node_matcher :camelize_kwarg?, <<~PATTERN
+          (pair (sym :camelize) ...)
+        PATTERN
+
         def initialize(argument_node)
           @nodes = argument_kwargs(argument_node) || []
         end
@@ -39,6 +44,10 @@ module RuboCop
           @nodes.find { |kwarg| description_kwarg?(kwarg) }
         end
 
+        def camelize
+          @nodes.find { |kwarg| camelize_kwarg?(kwarg) }
+        end
+
         def loads
           @nodes.find { |kwarg| loads_kwarg?(kwarg) }
         end

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

@@ -26,6 +26,11 @@ module RuboCop
           (pair (sym :method) ...)
         PATTERN
 
+        # @!method alias_kwarg(node)
+        def_node_matcher :alias_kwarg, <<~PATTERN
+          (pair (sym :alias) (sym $ _))
+        PATTERN
+
         # @!method hash_key_kwarg?(node)
         def_node_matcher :hash_key_kwarg?, <<~PATTERN
           (pair (sym :hash_key) ...)
@@ -41,6 +46,11 @@ module RuboCop
           (pair (sym :resolver_method) (sym $...))
         PATTERN
 
+        # @!method camelize_kwarg?(node)
+        def_node_matcher :camelize_kwarg?, <<~PATTERN
+          (pair (sym :camelize) ...)
+        PATTERN
+
         def initialize(field_node)
           @nodes = field_kwargs(field_node) || []
         end
@@ -53,6 +63,14 @@ module RuboCop
           @nodes.find { |kwarg| method_kwarg?(kwarg) }
         end
 
+        def alias
+          @alias ||= @nodes.map { |kwarg| alias_kwarg(kwarg) }.compact.first
+        end
+
+        def camelize
+          @nodes.find { |kwarg| camelize_kwarg?(kwarg) }
+        end
+
         def hash_key
           @nodes.find { |kwarg| hash_key_kwarg?(kwarg) }
         end

data/lib/rubocop/graphql/swap_range.rb

@@ -16,11 +16,20 @@ module RuboCop
       def declaration(node)
         buffer = processed_source.buffer
         begin_pos = range_by_whole_lines(node.source_range).begin_pos
-        end_line = buffer.line_for_position(node.loc.expression.end_pos)
+        end_line = buffer.line_for_position(final_end_location(node).end_pos)
         end_pos = range_by_whole_lines(buffer.line_range(end_line),
                                        include_final_newline: true).end_pos
         Parser::Source::Range.new(buffer, begin_pos, end_pos)
       end
+
+      def final_end_location(start_node)
+        heredoc_endings =
+          start_node.each_node(:str, :dstr, :xstr)
+                    .select(&:heredoc?)
+                    .map { |node| node.loc.heredoc_end }
+
+        [start_node.source_range.end, *heredoc_endings].max_by(&:line)
+      end
     end
   end
 end

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.16.0".freeze
+    VERSION = "0.19.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2023-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,9 @@ files:
 - 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/unnecessary_argument_camelize.rb
+- lib/rubocop/cop/graphql/unnecessary_field_alias.rb
+- lib/rubocop/cop/graphql/unnecessary_field_camelize.rb
 - lib/rubocop/cop/graphql/unused_argument.rb
 - lib/rubocop/cop/graphql_cops.rb
 - lib/rubocop/graphql.rb