boxt_rubocop 0.0.46 → 0.0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa5d1260e94c7453988486a997b27b365683b5d3d7882790a16ed1e2f01379dd
-  data.tar.gz: 16d46fc9f195a2202aee79dfa07843646becc222b5f149708cda9c7bed7be360
+  metadata.gz: 231009180ee1b9b0868430b15b773ca50a8101ffb8a66a1398e5b1bb78f366fb
+  data.tar.gz: bdc82cf8a6f8bf3a928c088bd260b22bafbc4ed26db8e2a43b4b6fef3acbadde
 SHA512:
-  metadata.gz: 44f9204e8bc18bf304f0fd1ac76838a112ee77deed65352cde3a621abc15b61a7a7480e84cb41616cd28e3f0b7859ed04a1179207153f98d6a362965e560ddd8
-  data.tar.gz: '085b6047775c0413aefbf1fba1d118bb9ac063ac2e9d0c91915d04462700c2d0b374a974b4e1b4ce8c12b60801531cd813087a824af0e348efcd28fd58faba28'
+  metadata.gz: ffc8ad1b40e20af26e8075a98e8bea4dec62c049d7bf2fe5af26df988748a710ebcd4ca121ad698a95a2b61e0c312161296c8a500fc1e2a75c4ad9f4e8047ebc
+  data.tar.gz: 87b2a5ef84b0c422310df7b798b7a436b130869f80ff4588ec649c3808b22c18cac971bfc4e67b81a0286a8f827397bfbb3034aee947c06b47996c23ea675dc8

data/VERSION

@@ -1 +1 @@
-0.0.46
+0.0.47

data/default.yml

@@ -1,3 +1,6 @@
+require:
+  - ./lib/rubocop/cop/boxt/api_path_format.rb
+
 AllCops:
   Exclude:
     - "**/*/schema.rb"

data/lib/boxt_rubocop.rb

@@ -2,6 +2,9 @@
 
 require "boxt_rubocop/version"
 
+# Require all custom cops defined in rubocop/cop/**/*.rb
+Dir[File.join(__dir__, "rubocop", "cop", "**", "*.rb")].sort.each { |file| require file }
+
 module BoxtRubocop
   module_function
 

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Boxt
+      # Clients expect to interface with our API using kebab-case.
+      #
+      # This cop ensures that our API paths are formatted using the correct case.
+      #
+      # Underscores are acceptable in path variables (e.g. "/path/:path_id/update")
+      #
+      # API style guide: https://github.com/boxt/boxt-docs/blob/main/coding-styles/api.md#camel-cased-endpoints
+      #
+      # @example
+      #   # bad
+      #   post "/admin/orders/:order_id/contact_details/update"
+      #   get  "/installation_days"
+      #   namespace "password_resets"
+      #   namespace :password_resets
+      #
+      #   # good
+      #   post "/admin/orders/:order_id/contact-details/update"
+      #   get  "/installation-days"
+      #   namespace "password-resets"
+      #
+      class ApiPathFormat < ::RuboCop::Cop::Base
+        def_node_matcher :path_defining_method_with_string_path, <<~PATTERN
+          (send nil? {:post | :get | :namespace} (:str $_))
+        PATTERN
+
+        def_node_matcher :namespace_with_symbol, <<~PATTERN
+          (send nil? :namespace (:sym $_))
+        PATTERN
+
+        MSG = "Use kebab-case for the API path"
+
+        def on_send(node)
+          path_defining_method_with_string_path(node) do |path|
+            add_offense(node) if path_name_does_not_follow_kebab_case?(path)
+          end
+
+          namespace_with_symbol(node) do |path|
+            add_offense(node) if path.to_s.include?("_")
+          end
+        end
+
+        private
+
+        def path_name_does_not_follow_kebab_case?(path)
+          path.split("/").any? { |split| !split.start_with?(":") && split.include?("_") }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxt_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.0.46
+  version: 0.0.47
 platform: ruby
 authors:
 - Boxt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -108,6 +108,7 @@ files:
 - default.yml
 - lib/boxt_rubocop.rb
 - lib/boxt_rubocop/version.rb
+- lib/rubocop/cop/boxt/api_path_format.rb
 - rails.yml
 - rspec.yml
 homepage: https://github.com/boxt/boxt_rubocop