boxt_rubocop 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53fbb5f4de20cff58d51ab86564d09b454e510592e5cfce2d113e62833459140
-  data.tar.gz: f8d793d8ce433d629e79b374cb9e0ee11c3875bed04a3abeba8bc34db0bfe2a2
+  metadata.gz: 5088d5c0f8a597d082572e25832ca5f401a3e6487b8d944b606fd7162a612f90
+  data.tar.gz: 4791d465fddfc8c8a363a4fa9078cac6bf20655ec356c5f3ff8c075e96a9b51c
 SHA512:
-  metadata.gz: dfbb25c1d4919cf0d135afc1b250b145c030c2200ce1dd6834736b9b5542d1adffa25492949230e2dd9a1286a0939a808ef628db5e0b704e13e40f7442b51e1b
-  data.tar.gz: f4eef4fc7bb2f091a8a90a561cbf29fa3602314a852a21c194b16a1620c8af6fc6aaef39a32bb0df2318f3d3bc9cade74bea2b76711da1d0e3e0e3d362bc36db
+  metadata.gz: 434b1a3bd1911a39bfc0a5eb54ecb553fcd437ddb50d5892745f272e9fe241402a01d9e9a6de927b720bfa280364d30dc3392200bdcaea3be77c66c2c3e1b662
+  data.tar.gz: df1a0a656f781d196bd0cae1900bc5224cf8dea75af518cde5b3fcb4721f1fdbd16b0bda2898125ae1bb4e0682c052d7a2c9cb9a6349608970b3b58f2a8c8659

data/VERSION

@@ -1 +1 @@
-2.7.0
+2.8.0

data/config/default.yml

@@ -11,6 +11,10 @@ Boxt/ApiPathFormat:
   Description: 'Ensure that the API path uses kebab case'
   Enabled: false
 
+Boxt/ApiTypeParameters:
+  Description: 'Ensure that API parameters are typed'
+  Enabled: false
+
 Layout/ClassStructure:
   Enabled: true
 

data/lib/rubocop/cop/boxt/api_type_parameters.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Boxt
+      # This cop ensures that each parameter in a Grape API has a type specified.
+      #
+      # @example
+      #   # bad
+      #   requires :name
+      #   optional :age
+      #
+      #   # good
+      #   requires :name, type: String
+      #   optional :age, type: Integer
+      #
+      class ApiTypeParameters < Cop
+        API_MESSAGE = "Ensure each parameter has a type specified, e.g., `type: String`."
+        ENTITY_MESSAGE = "Ensure each parameter has a type specified, e.g., `documentation: { type: String }`."
+
+        def_node_matcher :param_declaration, <<-PATTERN
+          (send nil? {:optional :requires :expose} _ $...)
+        PATTERN
+
+        def_node_search :param_with_type, <<-PATTERN
+          (send nil? {:optional :requires} _ (hash <(pair (sym :type) $_)>))
+        PATTERN
+
+        def_node_search :entity_with_type_documentation, <<-PATTERN
+          (send nil? :expose _ (hash <(pair (sym :documentation) (hash <(pair (sym :type) $_)>)) ...>))
+        PATTERN
+
+        def on_send(node)
+          param_declaration(node) do
+            next unless grape_api_class?(node) || grape_entity_class?(node)
+
+            if grape_api_class?(node) && param_with_type(node).none?
+              add_offense(node, message: API_MESSAGE)
+            elsif grape_entity_class?(node) && entity_with_type_documentation(node).none?
+              add_offense(node, message: ENTITY_MESSAGE)
+            end
+          end
+        end
+
+        private
+
+        def grape_api_class?(node)
+          grape_parent_class?(node, "Grape::API")
+        end
+
+        def grape_entity_class?(node)
+          grape_parent_class?(node, "Grape::Entity")
+        end
+
+        def grape_parent_class?(node, class_name)
+          node.each_ancestor(:class).any? do |ancestor|
+            ancestor.children.any? do |child|
+              child&.source == class_name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/boxt_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative "boxt/api_path_format"
+require_relative "boxt/api_type_parameters"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxt_rubocop
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Boxt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.30.0
+        version: 2.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.30.0
+        version: 2.31.0
 description: Base Rubocop settings for all Boxt Ruby projects
 email:
 - developers@boxt.co.uk
@@ -111,6 +111,7 @@ files:
 - lib/rubocop/boxt/inject.rb
 - lib/rubocop/boxt/version.rb
 - lib/rubocop/cop/boxt/api_path_format.rb
+- lib/rubocop/cop/boxt/api_type_parameters.rb
 - lib/rubocop/cop/boxt_cops.rb
 - rails.yml
 - rspec.yml
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Base Rubocop settings for all Boxt Ruby projects