rubocop-grape 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c384295c459e02395aee22afb61dce8fe77a11603b72c57188ea65761bc981c2
-  data.tar.gz: ff1aff8360ad4014f513af0a5312e5647f866e602e513580509854577dff21be
+  metadata.gz: 3f369f405421b61d6ad373deee22453343db7c7d661953a3f9a8b3860b561f93
+  data.tar.gz: db25749738766747e43c629bb9fe392759e5605adbb489a99120c217c4b5eb72
 SHA512:
-  metadata.gz: 4f8488742a3f79cfdd660154d4ed29db6f8f6797356f945d7761815a53bda297f459fd8d5a77b81928814da124679cc4c38232b089ff5d0a95304d1db3a1bb58
-  data.tar.gz: 17561aee4d974b9b8642a0ca6e40be8c289e4b6ac942971fe61a022daa69224970f2bff7677be52788332e127a5cdabd4b4d5b07a17c9ac8e21ca64ce59b80e2
+  metadata.gz: 17a713bd89ecad8ed274fbdb64e8564c5661815cd15cb3d3199a0c846912f67a7beb4f041e5830fc70bb481e73a7303c0902abe8f7743a77211184586dcea7ef
+  data.tar.gz: 8ee60612e5c0b86046496110477e5bcdf598a20954bdb912de5c28ec3c8a1f9bb88fed2fb5d86e35391f83b6420bfe0834b4a9adbaa0b3d1b646e1514088a831

data/config/default.yml

@@ -2,3 +2,8 @@ Grape/RouteParamType:
   Enabled: true
   Safe: false
   VersionAdded: '0.1'
+
+Grape/ParamsPosition:
+  Enabled: true
+  Safe: false
+  VersionAdded: '0.1'

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      #
+      # @example
+      #   # bad
+      #   get do
+      #     params do
+      #       requires :user_id, Integer, desc: 'User ID'
+      #     end
+      #   end
+      #
+      #   # good
+      #   params do
+      #     requires :user_id, Integer, desc: 'User ID'
+      #   end
+      #   get do
+      #   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
+
+        def_node_matcher :http_method_node?, <<~PATTERN
+          (block (send _ :get) ...)
+        PATTERN
+
+        def on_block(node)
+          return unless http_method_node?(node)
+
+          collect_violationg_nodes(node).each(&method(:add_offense))
+        end
+
+        def collect_violationg_nodes(node, collector = [])
+          collector.push(node) if node.type == :block && params_block?(node)
+
+          node.children.each do |descendant|
+            collect_violationg_nodes(descendant, collector) if descendant.is_a?(Parser::AST::Node)
+          end
+
+          collector
+        end
+      end
+    end
+  end
+end

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

@@ -18,13 +18,13 @@ module RuboCop
       class RouteParamType < Base
         MSG = 'Define Parameter Type'
 
-        def_node_matcher :route_param?, <<~RUBY
+        def_node_matcher :route_param?, <<~PATTERN
           (send _ :route_param ({sym str} _) ...)
-        RUBY
+        PATTERN
 
-        def_node_matcher :include_key_type?, <<~RUBY
+        def_node_matcher :include_key_type?, <<~PATTERN
           (pair (sym :type) _)
-        RUBY
+        PATTERN
 
         def on_send(node)
           return unless route_param?(node)

data/lib/rubocop/cop/grape_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative 'grape/params_position'
 require_relative 'grape/route_param_type'

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-grape
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Akito Hikasa
@@ -44,6 +44,7 @@ files:
 - bin/console
 - config/default.yml
 - lib/rubocop-grape.rb
+- lib/rubocop/cop/grape/params_position.rb
 - lib/rubocop/cop/grape/route_param_type.rb
 - lib/rubocop/cop/grape_cops.rb
 - lib/rubocop/grape.rb