feat(catalog): enforce a slug-safe code on v2 catalog objects

app/models/catalog_plan.rb

@@ -7,6 +7,7 @@ class CatalogPlan < ApplicationRecord
   include PaperTrailTraceable
   include Currencies
   include Discard::Model
+  include CatalogCodeFormat
 
   self.discard_column = :deleted_at
 

app/models/concerns/catalog_code_format.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Enforces a slug-safe `code` on v2 catalog objects (Product, ProductCategory,
+# ProductFilter, RateCard, RateCardRate, CatalogPlan, RatePhase). Codes are
+# member-route params, so restricting them to a URL-safe charset keeps every
+# code addressable and avoids collisions with nested route segments. The
+# leading negative lookahead rejects an all-dot code (`.`, `..`, …): those are
+# path-segment specials that clients and proxies normalize away, so they are
+# not reliably addressable. allow_blank leaves the empty case to the presence
+# validation.
+module CatalogCodeFormat
+  extend ActiveSupport::Concern
+
+  CODE_FORMAT = /\A(?!\.+\z)[a-zA-Z0-9_\-.]+\z/
+
+  included do
+    validates :code, format: {with: CODE_FORMAT}, allow_blank: true
+  end
+end

app/models/product.rb

@@ -4,6 +4,7 @@ class Product < ApplicationRecord
   include PaperTrailTraceable
   include Discard::Model
   include CatalogAttachable
+  include CatalogCodeFormat
 
   self.discard_column = :deleted_at
 

app/models/product_category.rb

@@ -4,6 +4,7 @@ class ProductCategory < ApplicationRecord
   include PaperTrailTraceable
   include Discard::Model
   include CatalogAttachable
+  include CatalogCodeFormat
 
   self.discard_column = :deleted_at
 

app/models/product_filter.rb

@@ -3,6 +3,7 @@
 class ProductFilter < ApplicationRecord
   include PaperTrailTraceable
   include Discard::Model
+  include CatalogCodeFormat
 
   self.discard_column = :deleted_at
 

app/models/rate_card.rb

@@ -5,6 +5,7 @@ class RateCard < ApplicationRecord
   include Currencies
   include Discard::Model
   include CatalogAttachable
+  include CatalogCodeFormat
 
   self.discard_column = :deleted_at
 

app/models/rate_card_rate.rb

@@ -4,6 +4,7 @@ class RateCardRate < ApplicationRecord
   include PaperTrailTraceable
   include ChargePropertiesValidation
   include Discard::Model
+  include CatalogCodeFormat
 
   self.discard_column = :deleted_at
 

app/models/rate_phase.rb

@@ -3,6 +3,7 @@
 class RatePhase < ApplicationRecord
   include PaperTrailTraceable
   include Discard::Model
+  include CatalogCodeFormat
 
   self.discard_column = :deleted_at
 

spec/models/catalog_plan_spec.rb

@@ -7,6 +7,8 @@
 
   it_behaves_like "paper_trail traceable"
 
+  it_behaves_like "a catalog code", :catalog_plan
+
   describe "associations" do
     it do
       expect(catalog_plan).to belong_to(:organization)

spec/models/product_category_spec.rb

@@ -7,6 +7,8 @@
 
   it_behaves_like "paper_trail traceable"
 
+  it_behaves_like "a catalog code", :product_category
+
   describe "associations" do
     it do
       expect(product_category).to belong_to(:organization)

spec/models/product_filter_spec.rb

@@ -7,6 +7,8 @@
 
   it_behaves_like "paper_trail traceable"
 
+  it_behaves_like "a catalog code", :product_filter
+
   describe "associations" do
     it do
       expect(product_filter).to belong_to(:organization)

spec/models/product_spec.rb

@@ -7,6 +7,8 @@
 
   it_behaves_like "paper_trail traceable"
 
+  it_behaves_like "a catalog code", :product
+
   describe "enums" do
     it do
       expect(product).to define_enum_for(:product_type)

spec/models/rate_card_rate_spec.rb

@@ -7,6 +7,8 @@
 
   it_behaves_like "paper_trail traceable"
 
+  it_behaves_like "a catalog code", :rate_card_rate
+
   describe "enums" do
     it do
       expect(rate_card_rate).to define_enum_for(:rate_model)

spec/models/rate_card_spec.rb

@@ -7,6 +7,8 @@
 
   it_behaves_like "paper_trail traceable"
 
+  it_behaves_like "a catalog code", :rate_card
+
   describe "enums" do
     it do
       expect(rate_card).to define_enum_for(:billing_timing)

spec/models/rate_phase_spec.rb

@@ -7,6 +7,8 @@
 
   it_behaves_like "paper_trail traceable"
 
+  it_behaves_like "a catalog code", :rate_phase
+
   describe "associations" do
     it do
       expect(rate_phase).to belong_to(:organization)

spec/support/shared_examples/catalog_code_format.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Shared validation for the slug-safe `code` on v2 catalog objects.
+# Usage: it_behaves_like "a catalog code", :product
+RSpec.shared_examples "a catalog code" do |factory|
+  describe "code format" do
+    it "allows a slug-safe code" do
+      record = build(factory, code: "valid_code-1.2")
+      record.valid?
+      expect(record.errors.where(:code, :invalid)).to be_empty
+    end
+
+    it "rejects a code containing a slash" do
+      record = build(factory, code: "a/b")
+      record.valid?
+      expect(record.errors.where(:code, :invalid)).to be_present
+    end
+
+    it "rejects a code containing a space" do
+      record = build(factory, code: "a b")
+      record.valid?
+      expect(record.errors.where(:code, :invalid)).to be_present
+    end
+
+    it "rejects the path-segment specials . and .." do
+      %w[. ..].each do |code|
+        record = build(factory, code:)
+        record.valid?
+        expect(record.errors.where(:code, :invalid)).to be_present
+      end
+    end
+  end
+end