rubocop-graphql 0.3.0

data/lib/rubocop/graphql/argument.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class Argument
+      extend RuboCop::NodePattern::Macros
+
+      def_node_matcher :argument_description, <<~PATTERN
+        (send nil? :argument _ _ (:str $_) ...)
+      PATTERN
+
+      def_node_matcher :argument_name, <<~PATTERN
+        (send nil? :argument (:sym $_) ...)
+      PATTERN
+
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+
+      def name
+        @name ||= argument_name(@node)
+      end
+
+      def description
+        @description ||= argument_description(@node) || kwargs.description || block.description
+      end
+
+      def kwargs
+        @kwargs ||= Argument::Kwargs.new(@node)
+      end
+
+      def block
+        @block ||= Argument::Block.new(@node.parent)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class Argument
+      class Block
+        extend RuboCop::NodePattern::Macros
+
+        def_node_matcher :argument_block, <<~PATTERN
+          (block
+            (send nil? :argument ...)
+            (args)
+            $...
+          )
+        PATTERN
+
+        def_node_matcher :description_kwarg?, <<~PATTERN
+          (send nil? :description (str ...))
+        PATTERN
+
+        def initialize(argument_node)
+          @nodes = argument_block(argument_node) || []
+        end
+
+        def description
+          @nodes.find { |kwarg| description_kwarg?(kwarg) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class Argument
+      class Kwargs
+        extend RuboCop::NodePattern::Macros
+
+        def_node_matcher :argument_kwargs, <<~PATTERN
+          (send nil? :argument
+            ...
+            (hash
+              $...
+            )
+          )
+        PATTERN
+
+        def_node_matcher :description_kwarg?, <<~PATTERN
+          (pair (sym :description) ...)
+        PATTERN
+
+        def initialize(argument_node)
+          @nodes = argument_kwargs(argument_node)
+        end
+
+        def description
+          @nodes.find { |kwarg| description_kwarg?(kwarg) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/ext/snake_case.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    module Ext
+      module SnakeCase
+        SNAKE_CASE = /^[\da-z_]+[!?=]?$/
+
+        refine Symbol do
+          def snake_case?
+            match?(SNAKE_CASE)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/field.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class Field
+      extend Forwardable
+      extend RuboCop::NodePattern::Macros
+
+      def_delegators :@node, :sibling_index, :parent
+
+      def_node_matcher :field_name, <<~PATTERN
+        (send nil? :field (:sym $_) ...)
+      PATTERN
+
+      def_node_matcher :field_with_body_name, <<~PATTERN
+        (block
+        (send nil? :field (:sym $_) ...)...)
+      PATTERN
+
+      def_node_matcher :field_description, <<~PATTERN
+        (send nil? :field _ _ (:str $_) ...)
+      PATTERN
+
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+
+      def name
+        @name ||= field_name(@node) || field_with_body_name(@node)
+      end
+
+      def underscore_name
+        @underscore_name ||= begin
+          word = name.to_s.dup
+          word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+      end
+
+      def description
+        @description ||= field_description(@node) || kwargs.description || block.description
+      end
+
+      def resolver_method_name
+        kwargs.resolver_method_name || name
+      end
+
+      def kwargs
+        @kwargs ||= Field::Kwargs.new(@node)
+      end
+
+      def block
+        @block ||= Field::Block.new(@node.parent)
+      end
+
+      def schema_member
+        @schema_member ||= SchemaMember.new(root_node)
+      end
+
+      private
+
+      def root_node
+        @node.ancestors.find { |parent| root_node?(parent) }
+      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/graphql/field/block.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class Field
+      class Block
+        extend RuboCop::NodePattern::Macros
+
+        def_node_matcher :field_block, <<~PATTERN
+          (block
+            (send nil? :field ...)
+            (args)
+            $...
+          )
+        PATTERN
+
+        def_node_matcher :description_kwarg?, <<~PATTERN
+          (send nil? :description (str ...))
+        PATTERN
+
+        def initialize(field_node)
+          @nodes = field_block(field_node) || []
+        end
+
+        def description
+          @nodes.find { |kwarg| description_kwarg?(kwarg) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class Field
+      class Kwargs
+        extend RuboCop::NodePattern::Macros
+
+        def_node_matcher :field_kwargs, <<~PATTERN
+          (send nil? :field
+            ...
+            (hash
+              $...
+            )
+          )
+        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 :description_kwarg?, <<~PATTERN
+          (pair (sym :description) ...)
+        PATTERN
+
+        def_node_matcher :resolver_method_option, <<~PATTERN
+          (pair (sym :resolver_method) (sym $...))
+        PATTERN
+
+        def initialize(field_node)
+          @nodes = field_kwargs(field_node) || []
+        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 description
+          @nodes.find { |kwarg| description_kwarg?(kwarg) }
+        end
+
+        def resolver_method_name
+          @resolver_method_name ||= @nodes.flat_map { |kwarg| resolver_method_option(kwarg) }.compact.first
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/inject.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from \#{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/node_pattern.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    module NodePattern
+      extend RuboCop::NodePattern::Macros
+
+      def_node_matcher :field_definition?, <<~PATTERN
+        (send nil? :field (:sym _) ...)
+      PATTERN
+
+      def_node_matcher :field_definition_with_body?, <<~PATTERN
+        (block
+          (send nil? :field (:sym _) ...)
+          ...
+        )
+      PATTERN
+
+      def_node_matcher :argument?, <<~PATTERN
+        (send nil? :argument (:sym _) ...)
+      PATTERN
+
+      def field?(node)
+        field_definition?(node) || field_definition_with_body?(node)
+      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

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-graphql
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Dmitry Tsepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+description: A collection of RuboCop cops to improve GraphQL-related code
+email:
+- dmitry.a.tsepelev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- config/default.yml
+- lib/rubocop-graphql.rb
+- lib/rubocop/cop/graphql/argument_description.rb
+- lib/rubocop/cop/graphql/argument_name.rb
+- lib/rubocop/cop/graphql/cop.rb
+- lib/rubocop/cop/graphql/extract_input_type.rb
+- lib/rubocop/cop/graphql/extract_type.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/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
+- lib/rubocop/graphql/argument.rb
+- lib/rubocop/graphql/argument/block.rb
+- lib/rubocop/graphql/argument/kwargs.rb
+- lib/rubocop/graphql/ext/snake_case.rb
+- lib/rubocop/graphql/field.rb
+- lib/rubocop/graphql/field/block.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:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DmitryTsepelev/rubocop-graphql
+  source_code_uri: https://github.com/DmitryTsepelev/rubocop-graphql
+  changelog_uri: https://github.com/DmitryTsepelev/rubocop-graphql/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Automatic performance checking tool for Ruby code.
+test_files: []