rubocop-graphql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44b2a5447e5631dde2523566cca0f2e8e5f38a5d2a0e874c06e0febf9afa8661
+  data.tar.gz: db95fd1b174deb832d715a9e72d45864c9c3883e828d07768d7b2ad2b13ed606
+SHA512:
+  metadata.gz: fc9381482049b6de23c6790f94a0828e49fe1f13a55922d8cbc1e565288ed3453f12b4fe6961620504b9bfaed6c9e996b3477725985e88dd32529317988b776c
+  data.tar.gz: bd246b919704fd783e58578793dba6f8f00e79de20fff9eb313ce5dd2b1c15bb6ad4b21e877a694b7d2f6f4016b2d768ed0975b293d6d405b3571682e798ba71

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 DmitryTsepelev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Rubocop::GraphQL
+
+[Rubocop](https://github.com/rubocop-hq/rubocop) extension for enforcing [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) best practices.
+
+<p align="center">
+  <a href="https://evilmartians.com/?utm_source=graphql-rubocop">
+    <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+  </a>
+</p>
+
+## Installation
+
+Install the gem:
+
+```bash
+gem install rubocop-graphql
+```
+
+If you use bundler put this in your Gemfile:
+
+```ruby
+gem 'rubocop-graphql', require: false
+```
+
+## Usage
+
+You need to tell RuboCop to load the Rails extension. There are three ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-graphql
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-graphql
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Rails cops together with the standard cops.
+
+### Command line
+
+```sh
+rubocop --require rubocop-graphql
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-graphql'
+end
+```
+
+## The Cops
+
+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:
+
+```yaml
+GraphQL/ResolverMethodLength:
+  Max: 3
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryTsepelev/rubocop-graphql.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/default.yml

@@ -0,0 +1,26 @@
+AllCops:
+  GraphQL:
+    Patterns:
+      - "(?:^|/)graphql/"
+
+GraphQL/ResolverMethodLength:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Avoid resolver methods longer than 10 lines of code.'
+  Max: 10
+  CountComments: false
+  ExcludedMethods: []
+
+GraphQL/FieldDefinitions:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Checks consistency of field definitions'
+  EnforcedStyle: group_definitions
+  SupportedStyles:
+    - group_definitions
+    - define_resolver_after_definition
+
+GraphQL/FieldDescription:
+  Enabled: true
+  VersionAdded: '0.80'
+  Description: 'Missing field description'

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      # This cop checks consistency of field definitions
+      #
+      # EnforcedStyle supports two modes:
+      #
+      # `group_definitions` : all field definitions should be grouped together.
+      #
+      # `define_resolver_after_definition` : if resolver method exists it should
+      # be defined right after the field definition.
+      #
+      # @example EnforcedStyle: group_definitions (default)
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :first_name, String, null: true
+      #     field :last_name, String, null: true
+      #
+      #     def first_name
+      #       object.contact_data.first_name
+      #     end
+      #
+      #     def last_name
+      #       object.contact_data.last_name
+      #     end
+      #   end
+      #
+      # @example EnforcedStyle: define_resolver_after_definition
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :first_name, String, null: true
+      #
+      #     def first_name
+      #       object.contact_data.first_name
+      #     end
+      #
+      #     field :last_name, String, null: true
+      #
+      #     def last_name
+      #       object.contact_data.last_name
+      #     end
+      #   end
+      class FieldDefinitions < Cop
+        include ConfigurableEnforcedStyle
+        include RuboCop::GraphQL::NodePattern
+
+        def_node_matcher :field_kwargs, <<~PATTERN
+          (send nil? :field
+            ...
+            (hash
+              $...
+            )
+          )
+        PATTERN
+
+        def_node_matcher :resolver_method_option, <<~PATTERN
+          (pair (sym :resolver_method) (sym $...))
+        PATTERN
+
+        def on_send(node)
+          return unless field_definition?(node)
+
+          case style
+          when :group_definitions
+            check_grouped_field_declarations(node.parent)
+          when :define_resolver_after_definition
+            field = RuboCop::GraphQL::Field.new(node)
+            check_resolver_is_defined_after_definition(field)
+          end
+        end
+
+        private
+
+        GROUP_DEFS_MSG = "Group all field definitions together."
+
+        def check_grouped_field_declarations(node)
+          fields = node.each_child_node.select { |node| field_definition?(node) }
+
+          first_field = fields.first
+          fields.each_with_index do |node, idx|
+            next if node.sibling_index == first_field.sibling_index + idx
+
+            add_offense(node, message: GROUP_DEFS_MSG)
+          end
+        end
+
+        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
+
+          resolver_method = field.kwargs.flat_map { |kwarg| resolver_method_option(kwarg) }.compact.first
+
+          method_name = resolver_method || field.name
+          method_definition = field.parent.each_child_node.find { |node|
+            node.def_type? && node.method_name == method_name
+          }
+
+          if method_definition.sibling_index - field.sibling_index > 1
+            add_offense(field.node, message: RESOLVER_AFTER_FIELD_MSG)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      #  This cop checks if each field has a description.
+      #
+      # @example
+      #   # good
+      #
+      #   class UserType < BaseType
+      #     field :name, String, "Name of the user", null: true
+      #   end
+      #
+      #   # bad
+      #
+      #   class UserType < BaseType
+      #     field :name, String, null: true
+      #   end
+      #
+      class FieldDescription < Cop
+        include RuboCop::GraphQL::NodePattern
+
+        MSG = "Missing field description"
+
+        def on_send(node)
+          return unless field_definition?(node)
+
+          field = RuboCop::GraphQL::Field.new(node)
+
+          add_offense(node) unless field.description
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      # This cop checks if the length of a resolver method exceeds some maximum value.
+      # Comment lines can optionally be ignored.
+      #
+      # The maximum allowed length is configurable using the Max option.
+      class ResolverMethodLength < Cop
+        include RuboCop::Cop::ConfigurableMax
+        include RuboCop::Cop::TooManyLines
+
+        LABEL = "ResolverMethod"
+
+        def_node_matcher :field_definition, <<~PATTERN
+          (send nil? :field (sym $...) ...)
+        PATTERN
+
+        def on_def(node)
+          excluded_methods = cop_config["ExcludedMethods"]
+          return if excluded_methods.include?(String(node.method_name))
+
+          check_code_length(node) if field_is_defined?(node)
+        end
+        alias on_defs on_def
+
+        private
+
+        def field_is_defined?(node)
+          node.parent.children.flat_map { |child| field_definition(child) }.include?(node.method_name)
+        end
+
+        def cop_label
+          LABEL
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/graphql_cops.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "graphql/field_definitions"
+require_relative "graphql/field_description"
+require_relative "graphql/resolver_method_length"

data/lib/rubocop/graphql/field.rb

@@ -0,0 +1,71 @@
+# 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_kwargs, <<~PATTERN
+        (send nil? :field
+          ...
+          (hash
+            $...
+          )
+        )
+      PATTERN
+
+      def_node_matcher :field_name, <<~PATTERN
+        (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
+
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+
+      def name
+        @name ||= field_name(@node).first
+      end
+
+      def description
+        @name ||= field_description(@node)
+      end
+
+      def kwargs
+        @kwargs ||= field_kwargs(@node) || []
+      end
+
+      def resolver
+        kwargs.find { |kwarg| resolver_kwarg?(kwarg) }
+      end
+
+      def method
+        kwargs.find { |kwarg| method_kwarg?(kwarg) }
+      end
+
+      def hash_key
+        kwargs.find { |kwarg| hash_key_kwarg?(kwarg) }
+      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,13 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    module NodePattern
+      extend RuboCop::NodePattern::Macros
+
+      def_node_matcher :field_definition?, <<~PATTERN
+        (send nil? :field ...)
+      PATTERN
+    end
+  end
+end

data/lib/rubocop/graphql/version.rb

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

data/lib/rubocop/graphql.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # RuboCop GraphQL project namespace
+  module GraphQL
+    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-graphql.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+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"
+
+RuboCop::GraphQL::Inject.defaults!
+
+require_relative "rubocop/cop/graphql_cops"

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-graphql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Tsepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-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/field_definitions.rb
+- lib/rubocop/cop/graphql/field_description.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/inject.rb
+- lib/rubocop/graphql/node_pattern.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: []