rubocop-graphql 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97a32c7f3e6a945161380f4d71afe27ad379af7ed6f4657cea6b73d42dae5213
-  data.tar.gz: a039ae1c957f91d596f5b834035401ad031f2cf8723701e708d192f29dfb6784
+  metadata.gz: 328663a392bcbb8e7a53bfaf2ba8e7323e9382893c8f290fa6b40e965155ebe1
+  data.tar.gz: cb76dad975e6dab191f1fac2ae6c45b677fb06bddbb26f36494a18108e1acf56
 SHA512:
-  metadata.gz: a17ab56af1141ef437dff2e908845c3c9a7d95b86f7e97c329787f43da0aef67be691a1d4179486d4580f40bb4fdbf423354ef619f7135651c0dcbe683a756b2
-  data.tar.gz: d9fb15417d019a952424942e5d860387da2bb1cd61abbeec1626ca9c7b9c2dec485cbe26b9cba28cec88128a828bb3cd1d776a9f3bc333bfc019d2ef8989b4e6
+  metadata.gz: a87c4e9ee55fb176eaf98ba520a7942c7a4ee4af3531b7cc90a0039f739a5e5400ce4e21b0d694e59b00ca0bb2771585f07a50699c55496a8794eec1a38900f3
+  data.tar.gz: cedeb68f255f806a1e12de6776722f3aadce5f82fe7c0e4ace7979593d7f84abc8f27fee1cff5ced953076f88247e4aadf0599f30b02b5a35436d946f976a353

data/README.md

@@ -1,4 +1,4 @@
-# Rubocop::GraphQL
+# RuboCop::GraphQL
 
 [Rubocop](https://github.com/rubocop-hq/rubocop) extension for enforcing [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) best practices.
 
@@ -24,7 +24,7 @@ gem 'rubocop-graphql', require: false
 
 ## Usage
 
-You need to tell RuboCop to load the Rails extension. There are three ways to do this:
+You need to tell RuboCop to load the GraphQL extension. There are three ways to do this:
 
 ### RuboCop configuration file
 
@@ -42,7 +42,7 @@ require:
   - rubocop-graphql
 ```
 
-Now you can run `rubocop` and it will automatically load the RuboCop Rails cops together with the standard cops.
+Now you can run `rubocop` and it will automatically load the RuboCop GraphQL cops together with the standard cops.
 
 ### Command line
 
@@ -62,7 +62,7 @@ end
 
 All cops are located under [`lib/rubocop/cop/graphql`](lib/rubocop/cop/graphql), and contain examples and documentation.
 
-In your `.rubocop.yml`, you may treat the Rails cops just like any other cop. For example:
+In your `.rubocop.yml`, you may treat the GraphQL cops just like any other cop. For example:
 
 ```yaml
 GraphQL/ResolverMethodLength:

data/config/default.yml

@@ -62,3 +62,11 @@ GraphQL/ExtractType:
     - avg
     - min
     - max
+
+GraphQL/ObjectDescription:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Ensures all types have a description'
+  Exclude:
+    - '**/*_schema.rb'
+    - '**/base_*.rb'

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

@@ -9,13 +9,13 @@ module RuboCop
       #   # good
       #
       #   class BanUser < BaseMutation
-      #     argument :uuid, ID, required: true
+      #     argument :uuid, ID, required: true, description: "UUID of the user to ban"
       #   end
       #
       #   # bad
       #
       #   class BanUser < BaseMutation
-      #     argument :uuid, ID, required: true, description: "UUID of the user to ban"
+      #     argument :uuid, ID, required: true
       #   end
       #
       class ArgumentDescription < Cop

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop checks if a type (object, input, interface, scalar, union, mutation, subscription, and resolver) has a description.
+      #
+      # @example
+      #   # good
+      #
+      #   class Types::UserType < Types::BaseObject
+      #     description "Represents application user"
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #
+      #   class Types::UserType < Types::BaseObject
+      #     # ...
+      #   end
+      #
+      class ObjectDescription < Cop
+        include RuboCop::GraphQL::NodePattern
+
+        MSG = "Missing type description"
+
+        def_node_matcher :has_i18n_description?, <<~PATTERN
+          (send nil? :description (send (const nil? :I18n) :t ...))
+        PATTERN
+
+        def_node_matcher :has_string_description?, <<~PATTERN
+          (send nil? :description (:str $_))
+        PATTERN
+
+        def_node_matcher :interface?, <<~PATTERN
+          (send nil? :include (const ...))
+        PATTERN
+
+        def on_class(node)
+          return if child_nodes(node).find { |child_node| has_description?(child_node) }
+
+          add_offense(node.identifier)
+        end
+
+        def on_module(node)
+          return if child_nodes(node).none? { |child_node| interface?(child_node) }
+
+          add_offense(node.identifier) if child_nodes(node).none? { |child_node| has_description?(child_node) }
+        end
+
+        private
+
+        def has_description?(node)
+          has_i18n_description?(node) || has_string_description?(node)
+        end
+
+        def child_nodes(node)
+          if node.body.instance_of? RuboCop::AST::Node
+            node.body.child_nodes
+          else
+            node.child_nodes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/graphql_cops.rb

@@ -11,3 +11,4 @@ require_relative "graphql/field_description"
 require_relative "graphql/field_method"
 require_relative "graphql/field_name"
 require_relative "graphql/resolver_method_length"
+require_relative "graphql/object_description"

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

@@ -36,7 +36,7 @@ module RuboCop
         PATTERN
 
         def initialize(field_node)
-          @nodes = field_kwargs(field_node)
+          @nodes = field_kwargs(field_node) || []
         end
 
         def resolver

data/lib/rubocop/graphql/node_pattern.rb

@@ -6,18 +6,18 @@ module RuboCop
       extend RuboCop::NodePattern::Macros
 
       def_node_matcher :field_definition?, <<~PATTERN
-        (send nil? :field ...)
+        (send nil? :field (:sym _) ...)
       PATTERN
 
       def_node_matcher :field_definition_with_body?, <<~PATTERN
         (block
-          (send nil? :field ...)
+          (send nil? :field (:sym _) ...)
           ...
         )
       PATTERN
 
       def_node_matcher :argument?, <<~PATTERN
-        (send nil? :argument ...)
+        (send nil? :argument (:sym _) ...)
       PATTERN
 
       def field?(node)

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - lib/rubocop/cop/graphql/field_description.rb
 - 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/resolver_method_length.rb
 - lib/rubocop/cop/graphql_cops.rb
 - lib/rubocop/graphql.rb