rubocop-grape 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 590df7af3dec0374453d4f8ba4282b6d2981492c4e25d0ea537dd9e7b1de8eca
-  data.tar.gz: d52f772ffb08ba797df64f30298362ce04872477b36544614430e7dd157540d4
+  metadata.gz: 8c25d3c6a6082d6b275b0e1d9b42ea3e563d268b093ee71f14d778286759e675
+  data.tar.gz: 379dc3a6046ce4365fbf5547e969bb121e98d44fb5020f5bcddafc444b116214
 SHA512:
-  metadata.gz: 32c44eac0eee98cee4c97de9e3ff829c7f7d65ef532ee5066985804cc430aff642c93402712240023b430a5a02578806f9a2864e1550147dbc6e9a12e56dbf0c
-  data.tar.gz: 6692df01c1c324431ba0625d5f2042447afb7b882977dd36fa3f556a9bf448f79cf5e9884240a66f9af1263d04b31e70ec8a1fd212975b6e0758816e9d899b29
+  metadata.gz: 5de198f343ab30657b1441c0ee038a4685d79435e0f0f6cd13e6c4d946e57e282ecf37f6614a5048bbdae0e4d4a5bf5a24842240bcf121e7e79f52defd0fb09b
+  data.tar.gz: 0fc7c0b5e700e381d9e9d8c2d2895f468bc1c3f2f593d4ccec09400e6e8c068d1b335c5093c8763fe1d64ec22e23a91b4f052ae3fdd0c5a20e7748124554c967

data/README.md

@@ -26,13 +26,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-grape
+plugins: rubocop-grape
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-grape
 ```
@@ -40,6 +40,9 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop Grape
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kakubin/rubocop-grape.

data/config/default.yml

@@ -19,6 +19,10 @@ Grape/FieldName:
     - snake_case
     - camelCase
 
+Grape/RouteParamGrouping:
+  Enabled: true
+  VersionAdded: '0.4.3'
+
 Grape/RouteParamType:
   Enabled: true
   Safe: false

data/lib/rubocop/cop/grape/route_param_grouping.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      #
+      # @example
+      #
+      #   # bad
+      #   get ':id' do
+      #   end
+      #
+      #   # good
+      #   route_param :id, type: Integer do
+      #     get do
+      #     end
+      #   end
+      #
+      class RouteParamGrouping < Base
+        include EndpointHelper
+
+        MSG = 'Use route_param for route parameter'
+
+        def on_block(node)
+          return unless (method_send_node = http_method_node?(node))
+          return unless (first_argument_node = method_send_node.arguments.first)
+          return unless first_argument_node.value.match?(/:\w/)
+
+          add_offense(first_argument_node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/grape_cops.rb

@@ -7,4 +7,5 @@ require_relative 'grape/field_name'
 require_relative 'grape/ivar'
 require_relative 'grape/params_position'
 require_relative 'grape/present_with'
+require_relative 'grape/route_param_grouping'
 require_relative 'grape/route_param_type'

data/lib/rubocop/cop/mixin/endpoint_helper.rb

@@ -7,7 +7,7 @@ module RuboCop
       extend NodePattern::Macros
 
       def_node_matcher :http_method_node?, <<~PATTERN
-        (block (send _ {:get :post :put :patch :delete} ...) ...)
+        (block $(send _ {:get :post :put :patch :delete} ...) ...)
       PATTERN
 
       def_node_matcher :params_node?, <<~PATTERN

data/lib/rubocop/grape/plugin.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Grape
+    # A plugin that integrates RuboCop Grape with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      # :nocov:
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-grape',
+          version: VERSION,
+          homepage: 'https://github.com/kakubin/rubocop-grape',
+          description: 'Code style checking for Grape files.'
+        )
+      end
+
+      # :nocov:
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: project_root.join('config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.4.2'
+    VERSION = '0.5.0'
   end
 end

data/lib/rubocop/grape.rb

@@ -5,10 +5,5 @@ require_relative 'grape/version'
 module RuboCop
   # RuboCop Grape project namespace
   module Grape
-    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-grape.rb

@@ -4,9 +4,7 @@ require 'rubocop'
 
 require_relative 'rubocop/grape'
 require_relative 'rubocop/grape/version'
-require_relative 'rubocop/grape/inject'
-
-RuboCop::Grape::Inject.defaults!
+require_relative 'rubocop/grape/plugin'
 
 require_relative 'rubocop/grape/grape_files'
 

metadata

@@ -1,35 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-grape
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Akito Hikasa
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.72.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.72.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
 description: |
   Automatic Grape code style checking tool.
   A RuboCop extension focused on enforcing Grape best practices and coding conventions.
@@ -49,12 +62,13 @@ files:
 - lib/rubocop/cop/grape/ivar.rb
 - lib/rubocop/cop/grape/params_position.rb
 - lib/rubocop/cop/grape/present_with.rb
+- lib/rubocop/cop/grape/route_param_grouping.rb
 - lib/rubocop/cop/grape/route_param_type.rb
 - lib/rubocop/cop/grape_cops.rb
 - lib/rubocop/cop/mixin/endpoint_helper.rb
 - lib/rubocop/grape.rb
 - lib/rubocop/grape/grape_files.rb
-- lib/rubocop/grape/inject.rb
+- lib/rubocop/grape/plugin.rb
 - lib/rubocop/grape/version.rb
 homepage: https://github.com/kakubin/rubocop-grape
 licenses:
@@ -64,7 +78,7 @@ metadata:
   homepage_uri: https://github.com/kakubin/rubocop-grape
   source_code_uri: https://github.com/kakubin/rubocop-grape
   changelog_uri: https://github.com/kakubin/rubocop-grape/blob/master/CHANGELOG.md
-post_install_message:
+  default_lint_roller_plugin: RuboCop::Grape::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -72,15 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Automatice Grape code style checking tool.
 test_files: []

data/lib/rubocop/grape/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Grape
-    # 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