rubocop-grape 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02479172353db2e2fea8b532d01cf2dde616c7751e0d81a4a550227789128fc7'
-  data.tar.gz: 83cc6fcfe0f01e021e4bedd257a5e2162f4a20c4f35aad28e5dcf04f2364706d
+  metadata.gz: f4f465c44799edf9ecb17a837d1e85bde5b628c29cb15aad03131878f9c46760
+  data.tar.gz: 8b788b780a6503f2ee4fd540271221c88d644a3616d8f21f0c3033a151a80e2e
 SHA512:
-  metadata.gz: 46c7d251b5e0882e72a76d1aa77271f04386141a172a5b4d054ff079957b4a43f2ffe1cfdba7d993ed83aa868bcaac6366db9cbfb2882c6b01acbe6f9631ba49
-  data.tar.gz: bd9bb8ca47a1c2cca8eaf6b08ec39ea9d80d69e59ecb32225909b1da83ee38a516c1cf8e65e7a14d2c8e322ea5a8b0a356a5bad2a1243623263b40c4381b070a
+  metadata.gz: c17941eb7ca48f32fbc0d3f53654a8917c847b00df6b1145aab1093ef86be29e628bec85c3d35400208ebc7c19374dc15f8649568506564d9749202875232539
+  data.tar.gz: 0f2163c4f45959cce98ce8682ddc4f188ff642559e62085bcd09fd0b32b764f2d983e1830aae338e1cb510e83923349886d7185e6cf5cb1b0edd61b0b23265e6

data/config/default.yml

@@ -1,6 +1,12 @@
 AllCops:
   GrapeDir: 'app/api'
 
+Grape/FieldName:
+  EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
+
 Grape/RouteParamType:
   Enabled: true
   Safe: false

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # @example EnforcedStyle: snake_case (default)
+      #   # bad
+      #   params do
+      #     requires :userName
+      #     optional :phoneNumber
+      #   end
+      #
+      #   # good
+      #   params do
+      #     requires :user_name
+      #     optional :phone_number
+      #   end
+      #
+      # @example EnforcedStyle: camelCase
+      #   # bad
+      #   params do
+      #     requires :user_name
+      #     optional :phone_number
+      #   end
+      #
+      #   # good
+      #   params do
+      #     requires :userName
+      #     optional :phoneNumber
+      #   end
+      #
+      class FieldName < Base
+        include ConfigurableNaming
+        include RangeHelp
+
+        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))
+
+          find_field_node(body)
+        end
+
+        private
+
+        def find_field_node(node)
+          case node.type
+          when :begin
+            node.each_child_node(&method(:find_field_node))
+          when :block
+            find_field_node(node.send_node)
+            find_field_node(node.body)
+          else
+            check_field_name(node)
+          end
+        end
+
+        def check_field_name(node)
+          return unless (field_name = field_name(node))
+
+          check_name(node, field_name, node.first_argument.source_range)
+        end
+
+        def message(style)
+          format(MSG, style: style)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/grape_cops.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'grape/field_name'
 require_relative 'grape/ivar'
 require_relative 'grape/params_position'
 require_relative 'grape/route_param_type'

data/lib/rubocop/grape/grape_files.rb

@@ -26,11 +26,11 @@ module RuboCop
           @config.for_all_cops['GrapeDir']
         end
 
-        def roundup_relevant_cops(filename)
+        def roundup_relevant_cops(processed_source)
           super.select do |cop|
             next true unless cop.class.name.match?(/RuboCop::Cop::Grape::.+$/)
 
-            grape_files.include?(filename)
+            grape_files.include?(processed_source.path)
           end
         end
       end

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-grape
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,6 +44,7 @@ files:
 - bin/console
 - config/default.yml
 - lib/rubocop-grape.rb
+- lib/rubocop/cop/grape/field_name.rb
 - lib/rubocop/cop/grape/ivar.rb
 - lib/rubocop/cop/grape/params_position.rb
 - lib/rubocop/cop/grape/route_param_type.rb
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Automatice Grape code style checking tool.