rubocop-grape 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e2ad9ec7a76a877cde28f025cccbff00e561a5ce9678892cb36d84583f4cdb7
-  data.tar.gz: 0ddb3542ef0b046ff88328c2813626c19749541b5b760161d6df6d3c985fece3
+  metadata.gz: 92c8005ffcb25101074781a0e8ef2dde2eec522fe78d8c8a56c2b4bc19f0ecec
+  data.tar.gz: 91e7e2fa44a245223f72235c9655a9d124232f09ecb27eb32bae8a7d01725294
 SHA512:
-  metadata.gz: 0cc9262ee02e74a134f7e0917ef9ba6fea99fe09c397b65ebb9d8c94c1f138a1cc44aef6d6995aee82689f791faca506c54f53a414618494298adb684b837252
-  data.tar.gz: 3d997bee7403959125be792b5e496d7280fdfad2273aafa5f55c3ce2e0554841aeac5e6de7841a6f88bcddcb44b574ad85e73dc8d507038a4c92ccf37bfd4588
+  metadata.gz: 6becb4f74dcfaa3c922a5c4aab58f4b540286f412c2d4c697aea3bfe69ce16d32ce795b0944b7e1401fd8ed98aa0f779a95d54ce7a1e51b053084cf4bafcd8d9
+  data.tar.gz: 507a763177ce9a01c1b50fbe067a37c40673c673a469daea3d3c6180dedeac16671e87bbbb3c2b64c625be599dcc020ebacd964804dad6d26f6206915038a864

data/config/default.yml

@@ -1,3 +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,69 @@
+# 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))
+
+          if body.type == :begin
+            body.children.each(&method(:check_field_name))
+          else
+            check_field_name(body)
+          end
+        end
+
+        private
+
+        def check_field_name(node)
+          field = node.children[2]
+          check_name(node, field_name(node), field.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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # This is a monkey patch for RuboCop
+      # which makes rubocop-grape cops adapted only for grape files.
+      module GrapeFile
+        DEFAULT_GRAPE_DIR = 'app/api'
+
+        def grape_dir
+          @grape_dir ||= load_grape_file_from_config || DEFAULT_GRAPE_DIR
+        end
+
+        def grape_files
+          @grape_files ||= Dir.glob('**/*.rb', base: grape_dir).map do |relative_path|
+            File.absolute_path(relative_path, grape_dir)
+          end
+        end
+
+        Team.prepend self
+
+        private
+
+        def load_grape_file_from_config
+          @config.for_all_cops['GrapeDir']
+        end
+
+        def roundup_relevant_cops(filename)
+          super.select do |cop|
+            next true unless cop.class.name.match?(/RuboCop::Cop::Grape::.+$/)
+
+            grape_files.include?(filename)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.2.0'
+    VERSION = '0.2.2'
   end
 end

data/lib/rubocop-grape.rb

@@ -8,4 +8,6 @@ require_relative 'rubocop/grape/inject'
 
 RuboCop::Grape::Inject.defaults!
 
+require_relative 'rubocop/grape/grape_files'
+
 require_relative 'rubocop/cop/grape_cops'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-grape
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
+date: 2023-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,11 +44,13 @@ 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
 - lib/rubocop/cop/grape_cops.rb
 - lib/rubocop/grape.rb
+- lib/rubocop/grape/grape_files.rb
 - lib/rubocop/grape/inject.rb
 - lib/rubocop/grape/version.rb
 homepage: https://github.com/kakubin/rubocop-grape
@@ -74,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.