rubocop-graphql 0.10.2 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7d2dac11533f09319d23f8770fe5b154c9477632a12d61f845a1c583e653635
-  data.tar.gz: 178ae678fdfc54ff8bc46af35160b5b0c0a57d183dff89045e3e790434c01728
+  metadata.gz: fa0ffd49d0fa9883050aa121e7a344afff34060a89b5d995023dcb76437e8923
+  data.tar.gz: f34f5c5ddfedd3fb597b0216c88d56cf554bb124e14633a8632f8045c6e935be
 SHA512:
-  metadata.gz: 0ea0e2358678578a7b6404c320fc836644fb6fd08cf33dfd13937eba0d991b2724fbd69b8ea9ff1f162ddc4c0b09f384c2344cbd4197e6744fef5931ea10a1da
-  data.tar.gz: bf5a8346e275f271c4a5c38cc9ad6c12b5271fa2ff3813853768a2f183530b078e214a7598cc00ebe43edefbfb2b2f79bfcd85a8d71ab664ed3fd43ddc7a87ea
+  metadata.gz: 00efa45967096346f711c41c712d7e1c09cc301e81c713f9dc7359120854d5273312e471de989d80fbaa5a8f3fa1736dd3b3de4e18688c1f06ed3b86b68dcede
+  data.tar.gz: a35bfa43b6a7acf8d2820f7e91f442c0ab04ab9867db0e43d427c90daff711ccf47080b66b62f122fbca416e6c604f69e591f4124c24fdf54304f78f5e1d1dd8

data/config/default.yml

@@ -1,6 +1,9 @@
 GraphQL:
   Include:
     - "**/graphql/**/*"
+  Exclude:
+    - "spec/**/*"
+    - "test/**/*"
 
 GraphQL/ArgumentDescription:
   Enabled: true
@@ -12,6 +15,11 @@ GraphQL/ArgumentName:
   VersionAdded: '0.80'
   Description: 'This cop checks whether argument names are snake_case'
 
+GraphQL/ArgumentUniqueness:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'This cop enforces arguments to be defined once per block'
+
 GraphQL/ResolverMethodLength:
   Enabled: true
   VersionAdded: '0.80'
@@ -50,6 +58,11 @@ GraphQL/FieldName:
   Description: 'This cop checks whether field names are snake_case'
   SafeAutoCorrect: false
 
+GraphQL/FieldUniqueness:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'This cop enforces fields to be defined once'
+
 GraphQL/ExtractInputType:
   Enabled: true
   VersionAdded: '0.80'
@@ -80,3 +93,15 @@ GraphQL/ObjectDescription:
   Exclude:
     - '**/*_schema.rb'
     - '**/base_*.rb'
+
+GraphQL/OrderedArguments:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Arguments should be alphabetically sorted within groups'
+
+GraphQL/OrderedFields:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Fields should be alphabetically sorted within groups'
+
+

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop detects duplicate argument definitions
+      #
+      # @example
+      #   # good
+      #
+      #   class BanUser < BaseMutation
+      #     argument :user_id, ID, required: true
+      #   end
+      #
+      #   # bad
+      #
+      #   class BanUser < BaseMutation
+      #     argument :user_id, ID, required: true
+      #     argument :user_id, ID, required: true
+      #   end
+      #
+      class ArgumentUniqueness < Base
+        MSG = "Argument names should only be defined once per block. "\
+              "Argument `%<current>s` is duplicated%<field_name>s."
+
+        def on_class(node)
+          global_argument_names = Set.new
+          argument_names_by_field = {}
+
+          argument_declarations(node).each do |current|
+            current_field_name = field_name(current)
+            current_argument_name = argument_name(current)
+
+            if current_field_name
+              argument_names_by_field[current_field_name] ||= Set.new
+              argument_names = argument_names_by_field[current_field_name]
+            else
+              argument_names = global_argument_names
+            end
+
+            unless argument_names.include?(current_argument_name)
+              argument_names.add(current_argument_name)
+              next
+            end
+
+            register_offense(current)
+          end
+        end
+
+        private
+
+        def register_offense(current)
+          current_field_name = field_name(current)
+          field_name_message = " in field `#{current_field_name}`" if current_field_name
+
+          message = format(
+            self.class::MSG,
+            current: argument_name(current),
+            field_name: field_name_message
+          )
+
+          add_offense(current, message: message)
+        end
+
+        def argument_name(node)
+          node.first_argument.value.to_s
+        end
+
+        # Find parent field block, if available
+        def field_name(node)
+          return if node.nil?
+
+          is_field_block = node.block_type? &&
+                           node.respond_to?(:method_name) &&
+                           node.method_name == :field
+          return node.send_node.first_argument.value.to_s if is_field_block
+
+          field_name(node.parent)
+        end
+
+        def_node_search :argument_declarations, <<~PATTERN
+          (send nil? :argument (:sym _) ...)
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      # This cop detects duplicate field definitions within
+      # the same type
+      #
+      # @example
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :name, String, null: true
+      #     field :phone, String, null: true do
+      #       argument :something, String, required: false
+      #     end
+      #   end
+      #
+      #   # bad
+      #
+      #   class UserType < BaseType
+      #     field :name, String, null: true
+      #     field :phone, String, null: true
+      #     field :phone, String, null: true do
+      #       argument :something, String, required: false
+      #     end
+      #   end
+      #
+      class FieldUniqueness < Base
+        MSG = "Field names should only be defined once per type. "\
+              "Field `%<current>s` is duplicated."
+
+        def on_class(node)
+          field_names = Set.new
+
+          field_declarations(node).each do |current|
+            current_field_name = field_name(current)
+
+            unless field_names.include?(current_field_name)
+              field_names.add(current_field_name)
+              next
+            end
+
+            register_offense(current)
+          end
+        end
+
+        private
+
+        def register_offense(current)
+          message = format(
+            self.class::MSG,
+            current: field_name(current)
+          )
+
+          add_offense(current, message: message)
+        end
+
+        def field_name(node)
+          node.first_argument.value.to_s
+        end
+
+        def_node_search :field_declarations, <<~PATTERN
+          {
+            (send nil? :field (:sym _) ...)
+          }
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -59,7 +59,7 @@ module RuboCop
         def on_class(node)
           argument_declarations(node).each_cons(2) do |previous, current|
             next unless consecutive_lines(previous, current)
-            next if argument_name(current) > argument_name(previous)
+            next if argument_name(current) >= argument_name(previous)
 
             register_offense(previous, current)
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module GraphQL
-      # Field should be alphabetically sorted within groups.
+      # Fields should be alphabetically sorted within groups.
       #
       # @example
       #   # good
@@ -42,7 +42,7 @@ module RuboCop
         def on_class(node)
           field_declarations(node).each_cons(2) do |previous, current|
             next unless consecutive_lines(previous, current)
-            next if field_name(current) > field_name(previous)
+            next if field_name(current) >= field_name(previous)
 
             register_offense(previous, current)
           end

data/lib/rubocop/cop/graphql_cops.rb

@@ -2,6 +2,7 @@
 
 require_relative "graphql/argument_description"
 require_relative "graphql/argument_name"
+require_relative "graphql/argument_uniqueness"
 require_relative "graphql/extract_input_type"
 require_relative "graphql/extract_type"
 require_relative "graphql/field_definitions"
@@ -9,6 +10,7 @@ require_relative "graphql/field_description"
 require_relative "graphql/field_hash_key"
 require_relative "graphql/field_method"
 require_relative "graphql/field_name"
+require_relative "graphql/field_uniqueness"
 require_relative "graphql/legacy_dsl"
 require_relative "graphql/resolver_method_length"
 require_relative "graphql/object_description"

data/lib/rubocop/graphql/description_method.rb

@@ -21,7 +21,8 @@ module RuboCop
       extend RuboCop::NodePattern::Macros
 
       def_node_matcher :description_kwarg?, <<~PATTERN
-        (send nil? :description {({str|dstr} ...)|(send ({str|dstr} ...) _)})
+        (send nil? :description
+          {({str|dstr|const} ...)|(send const ...)|(send ({str|dstr} ...) _)})
       PATTERN
 
       def find_description_method(nodes)

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.10.2".freeze
+    VERSION = "0.11.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.2
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - lib/rubocop-graphql.rb
 - lib/rubocop/cop/graphql/argument_description.rb
 - lib/rubocop/cop/graphql/argument_name.rb
+- lib/rubocop/cop/graphql/argument_uniqueness.rb
 - lib/rubocop/cop/graphql/extract_input_type.rb
 - lib/rubocop/cop/graphql/extract_type.rb
 - lib/rubocop/cop/graphql/field_definitions.rb
@@ -93,6 +94,7 @@ files:
 - lib/rubocop/cop/graphql/field_hash_key.rb
 - lib/rubocop/cop/graphql/field_method.rb
 - lib/rubocop/cop/graphql/field_name.rb
+- lib/rubocop/cop/graphql/field_uniqueness.rb
 - lib/rubocop/cop/graphql/legacy_dsl.rb
 - lib/rubocop/cop/graphql/object_description.rb
 - lib/rubocop/cop/graphql/ordered_arguments.rb
@@ -135,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: Automatic performance checking tool for Ruby code.