rubocop-graphql 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f884b232227042a66670cda20f99b749f559dfc1429c1803c4545c0335885c
-  data.tar.gz: 4ae6307ab827039a5dacff35d4075e123c2288752542923ea3ca2c7122658242
+  metadata.gz: fb4e28828d5aa07e959ad98fd9da04872c4832d1c8b1d168d440d1ad7c80762c
+  data.tar.gz: eaf5932cba816bfb478fac0cec298bb0e3db98b506b4f7112851503712e77068
 SHA512:
-  metadata.gz: 0c00f215519826a44d044a1cf6f87aa6402c179213a7c8650632a73cf45871ee4daf31f0b9c1a6d203448b0e3259687085612521242f314287f683ca51cc5137
-  data.tar.gz: df7fc7edf61e5a66adb94ab131da35625ef4106cdef87cdd3859e1d63604fadda1725b8f0284f80e47bf2f2300395876b91a7637aea746ce83dc191a107961a8
+  metadata.gz: cf88847a0b7a49cd1274b30fcff4e4e5ecb47b16f11a7d5e3fddcbcd7985a8d43bb8911080064a23e8d444daab330327f8908355a2ad75b2a94b14f2f4a4b2c8
+  data.tar.gz: a10cf2b637bc06a65338af84928c53ced64c78e634470a7fe988e4bf7a7037cfcd3035895914b99056fa11abc272c328d9be40da6ee608f33c900490dea0504d

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, camelize: false
+      #   end
+      #
+      #  # bad
+      #
+      #   class UserType < BaseType
+      #     field :name, String, "Name of the user", null: true do
+      #       argument :filter, String, required: false, camelize: true
+      #     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/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.16.0".freeze
+    VERSION = "0.18.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.18.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-10-30 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