rubocop-graphql 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30e4dfa482d073cf52c315042d736a54ce725491b3dcf130c9fecd3987bed8d2
-  data.tar.gz: 4e2467eab2c0ae0be138f6acf3b21912ad888c7b3cbcad98c2c7b0da3d9579af
+  metadata.gz: 03b458539789cb0aeaf7e8852d2c7eba08554f7ef1d3621bce63d7cb271899be
+  data.tar.gz: 16da0bb9da9cfdafd6da1d883890d8a96d6387519c7fba8cec883461d5d43130
 SHA512:
-  metadata.gz: 6099e724a272914bac6212d07ad92256316db2874b26edcd2daf9e8155668f5ddb6b394221b740e8ed51273b49eb101cd83cba55c59352a6c2cd178e972afb9b
-  data.tar.gz: 80f3d7cfa9e10f209e3f8d2cbf373ac370dc738da62e05b704f37cb8aaccd41216aed6294f063092d26c606645877b3bc0c2aba77bfabf6b5590b79d31e6928f
+  metadata.gz: 12208cd27b2711fb499331e26e0eead2064115d1f7f47dadcbb0ae218ad8d28fd852a5f4a0f1e3bfcecac6302205612b88f57ae65af89735ab9c454b4e3fbc4f
+  data.tar.gz: d3c8402557eb2b58f1c7a231d5b7a988d9bcfde59a8aa8b23c106f11cfe4ce6a193a1843165b296999bda3fbaa6d6f43560aff0082dd48ca6b18b0a0f5f3641c

data/config/default.yml

@@ -6,7 +6,7 @@ AllCops:
 GraphQL/ResolverMethodLength:
   Enabled: true
   VersionAdded: '0.80'
-  Description: 'Avoid resolver methods longer than 10 lines of code.'
+  Description: 'Checks resolver methods are not too long'
   Max: 10
   CountComments: false
   ExcludedMethods: []
@@ -23,4 +23,9 @@ GraphQL/FieldDefinitions:
 GraphQL/FieldDescription:
   Enabled: true
   VersionAdded: '0.80'
-  Description: 'Missing field description'
+  Description: 'Ensures all fields have a description'
+
+GraphQL/FieldMethod:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Checks :method option is used for appropriate fields'

data/lib/rubocop-graphql.rb

@@ -6,7 +6,10 @@ require_relative "rubocop/graphql"
 require_relative "rubocop/graphql/version"
 require_relative "rubocop/graphql/inject"
 require_relative "rubocop/graphql/node_pattern"
+
 require_relative "rubocop/graphql/field"
+require_relative "rubocop/graphql/field_kwargs"
+require_relative "rubocop/graphql/schema_member"
 
 RuboCop::GraphQL::Inject.defaults!
 

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

@@ -57,10 +57,6 @@ module RuboCop
           )
         PATTERN
 
-        def_node_matcher :class_body, <<~PATTERN
-          (class ... (begin $...))
-        PATTERN
-
         def on_send(node)
           return if !field_definition?(node) || style != :define_resolver_after_definition
 
@@ -71,8 +67,11 @@ module RuboCop
         def on_class(node)
           return if style != :group_definitions
 
-          body = class_body(node)
-          check_grouped_field_declarations(body) if body
+          schema_member = RuboCop::GraphQL::SchemaMember.new(node)
+
+          if (body = schema_member.body)
+            check_grouped_field_declarations(body)
+          end
         end
 
         private
@@ -94,10 +93,9 @@ module RuboCop
         RESOLVER_AFTER_FIELD_MSG = "Define resolver method after field definition."
 
         def check_resolver_is_defined_after_definition(field)
-          return if field.resolver || field.method || field.hash_key
+          return if field.kwargs.resolver || field.kwargs.method || field.kwargs.hash_key
 
-          root = field.ancestors.find { |parent| root_node?(parent) }
-          method_definition = find_method_definition(root, field.resolver_method_name)
+          method_definition = field.schema_member.find_method_definition(field.resolver_method_name)
           return unless method_definition
 
           field_sibling_index = if field_definition_with_body?(field.parent)
@@ -110,18 +108,6 @@ module RuboCop
 
           add_offense(field.node, message: RESOLVER_AFTER_FIELD_MSG)
         end
-
-        def find_method_definition(root, method_name)
-          class_body(root).find { |node| node.def_type? && node.method_name == method_name }
-        end
-
-        def root_node?(node)
-          node.parent.nil? || root_with_siblings?(node.parent)
-        end
-
-        def root_with_siblings?(node)
-          node.begin_type? && node.parent.nil?
-        end
       end
     end
   end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop prevents defining unnecessary resolver methods in cases
+      #  when :method option can be used
+      #
+      # @example
+      #   # good
+      #
+      #   class Types::UserType < Types::BaseObject
+      #     field :phone, String, null: true, method: :home_phone
+      #   end
+      #
+      #   # bad
+      #
+      #   class Types::UserType < Types::BaseObject
+      #     field :phone, String, null: true
+      #
+      #     def phone
+      #       object.home_phone
+      #     end
+      #   end
+      #
+      class FieldMethod < Cop
+        include RuboCop::GraphQL::NodePattern
+
+        def_node_matcher :method_to_use, <<~PATTERN
+          (def
+            _
+            (args)
+            (send
+              (send nil? :object) $_
+            )
+          )
+        PATTERN
+
+        MSG = "Use method: :%<method_name>s"
+
+        def on_send(node)
+          return unless field_definition?(node)
+
+          field = RuboCop::GraphQL::Field.new(node)
+
+          method_name = field.resolver_method_name
+          method_definition = field.schema_member.find_method_definition(method_name)
+
+          if (method_name = method_to_use(method_definition))
+            add_offense(node, message: message(method_name))
+          end
+        end
+
+        private
+
+        def message(method_name)
+          format(MSG, method_name: method_name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/graphql_cops.rb

@@ -4,4 +4,5 @@ require_relative "graphql/cop"
 
 require_relative "graphql/field_definitions"
 require_relative "graphql/field_description"
+require_relative "graphql/field_method"
 require_relative "graphql/resolver_method_length"

data/lib/rubocop/graphql/field.rb

@@ -6,7 +6,7 @@ module RuboCop
       extend Forwardable
       extend RuboCop::NodePattern::Macros
 
-      def_delegators :@node, :sibling_index, :parent, :ancestors
+      def_delegators :@node, :sibling_index, :parent
 
       def_node_matcher :field_kwargs, <<~PATTERN
         (send nil? :field
@@ -18,27 +18,11 @@ module RuboCop
       PATTERN
 
       def_node_matcher :field_name, <<~PATTERN
-        (send nil? :field (:sym $...) ...)
+        (send nil? :field (:sym $_) ...)
       PATTERN
 
       def_node_matcher :field_description, <<~PATTERN
-        (send nil? :field _ _ (:str $...) ...)
-      PATTERN
-
-      def_node_matcher :resolver_kwarg?, <<~PATTERN
-        (pair (sym :resolver) ...)
-      PATTERN
-
-      def_node_matcher :method_kwarg?, <<~PATTERN
-        (pair (sym :method) ...)
-      PATTERN
-
-      def_node_matcher :hash_key_kwarg?, <<~PATTERN
-        (pair (sym :hash_key) ...)
-      PATTERN
-
-      def_node_matcher :resolver_method_option, <<~PATTERN
-        (pair (sym :resolver_method) (sym $...))
+        (send nil? :field _ _ (:str $_) ...)
       PATTERN
 
       attr_reader :node
@@ -48,31 +32,37 @@ module RuboCop
       end
 
       def name
-        @name ||= field_name(@node).first
+        field_name(@node)
       end
 
       def description
-        @name ||= field_description(@node)
+        field_description(@node)
+      end
+
+      def resolver_method_name
+        kwargs.resolver_method_name || name
       end
 
       def kwargs
-        @kwargs ||= field_kwargs(@node) || []
+        @kwargs ||= FieldKwargs.new(field_kwargs(@node))
       end
 
-      def resolver
-        kwargs.find { |kwarg| resolver_kwarg?(kwarg) }
+      def schema_member
+        @schema_member ||= SchemaMember.new(root_node)
       end
 
-      def method
-        kwargs.find { |kwarg| method_kwarg?(kwarg) }
+      private
+
+      def root_node
+        @node.ancestors.find { |parent| root_node?(parent) }
       end
 
-      def hash_key
-        kwargs.find { |kwarg| hash_key_kwarg?(kwarg) }
+      def root_node?(node)
+        node.parent.nil? || root_with_siblings?(node.parent)
       end
 
-      def resolver_method_name
-        @resolver_method_name ||= kwargs.flat_map { |kwarg| resolver_method_option(kwarg) }.compact.first || name
+      def root_with_siblings?(node)
+        node.begin_type? && node.parent.nil?
       end
     end
   end

data/lib/rubocop/graphql/field_kwargs.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class FieldKwargs
+      extend RuboCop::NodePattern::Macros
+
+      def_node_matcher :resolver_kwarg?, <<~PATTERN
+        (pair (sym :resolver) ...)
+      PATTERN
+
+      def_node_matcher :method_kwarg?, <<~PATTERN
+        (pair (sym :method) ...)
+      PATTERN
+
+      def_node_matcher :hash_key_kwarg?, <<~PATTERN
+        (pair (sym :hash_key) ...)
+      PATTERN
+
+      def_node_matcher :resolver_method_option, <<~PATTERN
+        (pair (sym :resolver_method) (sym $...))
+      PATTERN
+
+      def initialize(nodes)
+        @nodes = nodes
+      end
+
+      def resolver
+        @nodes.find { |kwarg| resolver_kwarg?(kwarg) }
+      end
+
+      def method
+        @nodes.find { |kwarg| method_kwarg?(kwarg) }
+      end
+
+      def hash_key
+        @nodes.find { |kwarg| hash_key_kwarg?(kwarg) }
+      end
+
+      def resolver_method_name
+        @resolver_method_name ||= @nodes.flat_map { |kwarg| resolver_method_option(kwarg) }.compact.first
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/schema_member.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class SchemaMember
+      extend RuboCop::NodePattern::Macros
+
+      def_node_matcher :class_contents, <<~PATTERN
+        (class _ _ $_)
+      PATTERN
+
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+
+      def find_method_definition(method_name)
+        body.find { |node| node.def_type? && node.method_name == method_name }
+      end
+
+      def body
+        contents = class_contents(@node)
+
+        if contents.nil?
+          []
+        elsif contents.begin_type?
+          contents.child_nodes
+        else
+          [contents]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,12 +80,15 @@ files:
 - lib/rubocop/cop/graphql/cop.rb
 - lib/rubocop/cop/graphql/field_definitions.rb
 - lib/rubocop/cop/graphql/field_description.rb
+- lib/rubocop/cop/graphql/field_method.rb
 - lib/rubocop/cop/graphql/resolver_method_length.rb
 - lib/rubocop/cop/graphql_cops.rb
 - lib/rubocop/graphql.rb
 - lib/rubocop/graphql/field.rb
+- lib/rubocop/graphql/field_kwargs.rb
 - lib/rubocop/graphql/inject.rb
 - lib/rubocop/graphql/node_pattern.rb
+- lib/rubocop/graphql/schema_member.rb
 - lib/rubocop/graphql/version.rb
 homepage: https://github.com/DmitryTsepelev/rubocop-graphql
 licenses: