rubocop-grape 0.4.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1ddcfa8ca8f07c8b82d051f1b962d106b7e9390f505bce166901deb3d9421c4
-  data.tar.gz: c7de3f5ff9600b83a730d347278e52d0f3f4553389c184b2c04be425193079b3
+  metadata.gz: 0a10e156b9a117d1d9bd4eb1e3d0c559268669f410d80c786d5c4b38ca79d508
+  data.tar.gz: '0287d909c47e61e540fcc98edf2303b97f43ebad7a6fc244fa14444661dbc77f'
 SHA512:
-  metadata.gz: 204e3c444825e10ab0c90bdfbb3dac71db90d5aeb56a718a6124ef1b19a3883e93e5815131aefbc8bcc8ba5c20d46c2bdf987f145914167299a33f7cbf95fd44
-  data.tar.gz: 02ebbff3326f417c71983683ed98aa7a414e9a2d3456b671b4a5fe7f19ae4cb84ccb42723f47ee1ed5085f359d6fb70557b1703045f053430e4726c32417f80a
+  metadata.gz: f01ca9109f953bc9f7f74bebad5a468004fb9db4b738b4d9e01ef0d9265325159e4d6397d16ca35453b3ae5784df27523e7ceea01413de9f030358b4101d9f4e
+  data.tar.gz: e1acec347d818fe04be34f01a012ebd7961730091b00cc370aa720e6097a783eb59b5de54bb2aada39f2f21d7b393b1e26e696d56298ce762ba43243fff3d3a3

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
@@ -28,3 +32,9 @@ Grape/ParamsPosition:
   Enabled: true
   Safe: false
   VersionAdded: '0.1'
+
+Grape/PresentWith:
+  Enabled: true
+  Safe: false
+  SafeAutoCorrect: false
+  VersionAdded: '0.4.2'

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

@@ -9,15 +9,12 @@ module RuboCop
       # and https://en.wikipedia.org/wiki/ABC_Software_Metric.
       class AbcSize < Base
         extend ExcludeLimit
+        include EndpointHelper
 
         exclude_limit 'Max'
 
         MSG = 'Assignment Branch Condition size is too high. [%<abc_vector>s %<complexity>d/%<max>d]'
 
-        def_node_matcher :http_method_node?, <<~PATTERN
-          (block (send _ {:get :post :put :patch :delete} ...) ...)
-        PATTERN
-
         def on_block(node)
           return unless http_method_node?(node)
 

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

@@ -31,20 +31,16 @@ module RuboCop
       #
       class FieldName < Base
         include ConfigurableNaming
-        include RangeHelp
+        include EndpointHelper
 
         MSG = 'Use %<style>s for field names.'
 
-        def_node_matcher :params_block?, <<~PATTERN
-          (block (send _ :params) _ $_)
-        PATTERN
-
         def_node_matcher :field_name, <<~PATTERN
           (send _ {:requires :optional} (sym $_) ...)
         PATTERN
 
         def on_block(node)
-          return unless (body = params_block?(node))
+          return unless (body = params_node?(node))
 
           find_field_node(body)
         end

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

@@ -20,15 +20,9 @@ module RuboCop
       #   end
       #
       class ParamsPosition < Base
-        MSG = "It's no sense to define params in HTTP method's scope"
-
-        def_node_matcher :params_block?, <<~PATTERN
-          (block (send _ :params) ...)
-        PATTERN
+        include EndpointHelper
 
-        def_node_matcher :http_method_node?, <<~PATTERN
-          (block (send _ {:get :post :put :patch :delete} ...) ...)
-        PATTERN
+        MSG = "It's no sense to define params in HTTP method's scope"
 
         def on_block(node)
           return unless http_method_node?(node)
@@ -37,7 +31,7 @@ module RuboCop
         end
 
         def collect_violating_nodes(node, collector = [])
-          collector.push(node) if node.type == :block && params_block?(node)
+          collector.push(node) if node.type == :block && params_node?(node)
 
           node.children.each do |descendant|
             collect_violating_nodes(descendant, collector) if descendant.is_a?(Parser::AST::Node)

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # @example
+      #
+      #   # bad
+      #   get do
+      #     present users: users, with: API::Entities::User
+      #   end
+      #
+      #   # good
+      #   get do
+      #     present :users, users, with: API::Entities::User
+      #   end
+      #
+      class PresentWith < Base
+        extend AutoCorrector
+        include EndpointHelper
+
+        MSG_TEMPLATE = 'Maybe you mistyped "`%<current>s`", it should be "`%<correct>s`"'
+
+        def_node_matcher :one_hash_arg_with_key_name_with?, <<~PATTERN
+          (send _ :present
+            (hash
+              (pair (sym $_key)
+                {(send _ $_val) (lvar $_val)})
+              (pair (sym :with) _)))
+        PATTERN
+
+        def on_send(present_node)
+          one_hash_arg_with_key_name_with?(present_node) do |key, val|
+            kwarg = present_node.children.last
+
+            add_offense(kwarg.children.first, message: message(key, val)) do |corrector|
+              corrector.remove(kwarg.children.first)
+              corrector.insert_before(kwarg, ":#{key}, #{val}")
+            end
+          end
+        end
+
+        def message(key, val)
+          format(MSG_TEMPLATE, current: "#{key}: #{val}", correct: ":#{key}, #{val}")
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require_relative 'mixin/endpoint_helper'
+
 require_relative 'grape/abc_size'
 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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # EndpointHelper is a set of AST definitions for endpoint definition by Grape DSL
+    module EndpointHelper
+      extend NodePattern::Macros
+
+      def_node_matcher :http_method_node?, <<~PATTERN
+        (block $(send _ {:get :post :put :patch :delete} ...) ...)
+      PATTERN
+
+      def_node_matcher :params_node?, <<~PATTERN
+        (block (send _ :params) _ $_)
+      PATTERN
+    end
+  end
+end

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.4.0'
+    VERSION = '0.4.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-grape
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-29 00:00:00.000000000 Z
+date: 2024-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -48,8 +48,11 @@ files:
 - lib/rubocop/cop/grape/field_name.rb
 - 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
@@ -77,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Automatice Grape code style checking tool.