Add CLI command for mapping return reasons to categories

- Add add_return_reasons_to_categories_command.rb
- Maps specified return reasons to specified categories
- Validates return reason references
- Auto-sorts alphabetically with Unknown/Other last
- Supports --include-descendants flag for cascade
- Register command in cli.rb

Author: ricardotejedorsanz

dev/lib/product_taxonomy.rb

@@ -59,9 +59,12 @@ def data_path = DATA_PATH
 require_relative "product_taxonomy/commands/dump_categories_command"
 require_relative "product_taxonomy/commands/dump_attributes_command"
 require_relative "product_taxonomy/commands/dump_values_command"
+require_relative "product_taxonomy/commands/dump_return_reasons_command"
 require_relative "product_taxonomy/commands/dump_integration_full_names_command"
 require_relative "product_taxonomy/commands/sync_en_localizations_command"
 require_relative "product_taxonomy/commands/add_category_command"
 require_relative "product_taxonomy/commands/add_attribute_command"
 require_relative "product_taxonomy/commands/add_attributes_to_categories_command"
 require_relative "product_taxonomy/commands/add_value_command"
+require_relative "product_taxonomy/commands/add_return_reason_command"
+require_relative "product_taxonomy/commands/add_return_reasons_to_categories_command"

dev/lib/product_taxonomy/cli.rb

@@ -105,5 +105,12 @@ def add_return_reason(name, description)
     def dump_return_reasons
       DumpReturnReasonsCommand.new(options).run
     end
+
+    desc "add_return_reasons_to_categories RETURN_REASON_FRIENDLY_IDS CATEGORY_IDS",
+      "Add one or more return reasons to one or more categories. RETURN_REASON_FRIENDLY_IDS is a comma-separated list of return reason friendly IDs."
+    option :include_descendants, type: :boolean, desc: "When set, the return reasons will be added to all descendants of the specified categories"
+    def add_return_reasons_to_categories(return_reason_friendly_ids, category_ids)
+      AddReturnReasonsToCategoriesCommand.new(options.merge(return_reason_friendly_ids:, category_ids:)).run
+    end
   end
 end

dev/lib/product_taxonomy/commands/add_return_reason_command.rb

@@ -17,21 +17,13 @@ def execute
     private
 
     def create_return_reason!
-      @return_reason = ReturnReason.new(
+      @return_reason = ReturnReason.create_validate_and_add!(
         id: ReturnReason.next_id,
         name: @name,
         description: @description,
         friendly_id:,
         handle:,
       )
-      
-      begin
-        @return_reason.validate!(:create)
-      rescue ActiveModel::ValidationError => e
-        raise ActiveModel::ValidationError.new(e.model), "Failed to create return reason: #{e.message}"
-      end
-
-      ReturnReason.add(@return_reason)
       logger.info("Created return reason `#{@return_reason.name}` with friendly_id=`#{@return_reason.friendly_id}`")
     end
 
@@ -50,6 +42,3 @@ def handle
     end
   end
 end
-
-
-

dev/lib/product_taxonomy/commands/add_return_reasons_to_categories_command.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  class AddReturnReasonsToCategoriesCommand < Command
+    def initialize(options)
+      super
+      load_taxonomy
+      @return_reason_friendly_ids = options[:return_reason_friendly_ids]
+      @category_ids = options[:category_ids]
+      @include_descendants = options[:include_descendants]
+    end
+
+    def execute
+      add_return_reasons_to_categories!
+      update_data_files!
+    end
+
+    private
+
+    def add_return_reasons_to_categories!
+      @return_reasons = return_reason_friendly_ids.map { |friendly_id| ReturnReason.find_by!(friendly_id:) }
+      @categories = category_ids.map { |id| Category.find_by!(id:) }
+      @categories = @categories.flat_map(&:descendants_and_self) if @include_descendants
+
+      @categories.each do |category|
+        @return_reasons.each do |return_reason|
+          if category.return_reasons.include?(return_reason)
+            logger.info("Category `#{category.name}` already has return reason `#{return_reason.friendly_id}` - skipping")
+          else
+            category.add_return_reason(return_reason)
+          end
+        end
+
+        sort_return_reasons!(category)
+      end
+
+      logger.info("Added #{@return_reasons.size} return reason(s) to #{@categories.size} categories")
+    end
+
+    def sort_return_reasons!(category)
+      special_reasons = category.return_reasons.select { |r| ["unknown", "other"].include?(r.friendly_id) }
+      regular_reasons = category.return_reasons.reject { |r| ["unknown", "other"].include?(r.friendly_id) }
+
+      sorted_friendly_ids = AlphanumericSorter.sort(regular_reasons.map(&:friendly_id))
+      regular_reasons = sorted_friendly_ids.map { |fid| regular_reasons.find { |r| r.friendly_id == fid } }
+
+      # Add special reasons at the end in the correct order
+      unknown = special_reasons.find { |r| r.friendly_id == "unknown" }
+      other = special_reasons.find { |r| r.friendly_id == "other" }
+
+      sorted_reasons = regular_reasons + [unknown, other].compact
+
+      category.return_reasons.replace(sorted_reasons)
+    end
+
+    def update_data_files!
+      roots = @categories.map(&:root).uniq.map(&:id)
+      DumpCategoriesCommand.new(verticals: roots).execute
+      SyncEnLocalizationsCommand.new(targets: "categories").execute
+      GenerateDocsCommand.new({}).execute
+    end
+
+    def return_reason_friendly_ids
+      @return_reason_friendly_ids.split(",").map(&:strip)
+    end
+
+    def category_ids
+      @category_ids.split(",").map(&:strip)
+    end
+  end
+end

dev/lib/product_taxonomy/commands/dump_return_reasons_command.rb

@@ -17,6 +17,3 @@ def execute
     end
   end
 end
-
-
-

dev/lib/product_taxonomy/models/category.rb

@@ -138,6 +138,13 @@ def add_attribute(attribute)
       @attributes << attribute
     end
 
+    # Add a return reason to the category
+    #
+    # @param [ReturnReason] return_reason
+    def add_return_reason(return_reason)
+      @return_reasons << return_reason
+    end
+
     #
     # Information
     #

dev/test/commands/add_return_reason_command_test.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module ProductTaxonomy
+  class AddReturnReasonCommandTest < TestCase
+    setup do
+      @existing_return_reason = ReturnReason.new(
+        id: 1,
+        name: "Defective or Doesn't Work",
+        description: "Item is broken, defective, or doesn't function as expected",
+        friendly_id: "defective_or_doesnt_work",
+        handle: "defective-or-doesnt-work",
+      )
+
+      ReturnReason.add(@existing_return_reason)
+
+      AddReturnReasonCommand.any_instance.stubs(:load_taxonomy)
+      DumpReturnReasonsCommand.any_instance.stubs(:load_taxonomy)
+      SyncEnLocalizationsCommand.any_instance.stubs(:load_taxonomy)
+      GenerateDocsCommand.any_instance.stubs(:load_taxonomy)
+    end
+
+    test "execute successfully adds a new return reason" do
+      DumpReturnReasonsCommand.any_instance.expects(:execute).once
+      SyncEnLocalizationsCommand.expects(:new).with(targets: "return_reasons").returns(stub(execute: true))
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddReturnReasonCommand.new(
+        name: "Wrong Size or Fit",
+        description: "Item doesn't fit properly or is not the expected size",
+      ).execute
+
+      new_return_reason = ReturnReason.find_by(friendly_id: "wrong_size_or_fit")
+      assert_not_nil new_return_reason
+      assert_equal 2, new_return_reason.id # Since id 1 already exists
+      assert_equal "Wrong Size or Fit", new_return_reason.name
+      assert_equal "Item doesn't fit properly or is not the expected size", new_return_reason.description
+      assert_equal "wrong_size_or_fit", new_return_reason.friendly_id
+      assert_equal "wrong-size-or-fit", new_return_reason.handle
+    end
+
+    test "execute generates correct friendly_id and handle from name" do
+      stub_commands
+
+      AddReturnReasonCommand.new(
+        name: "Not As Described",
+        description: "Item received differs from the product description",
+      ).execute
+
+      new_return_reason = ReturnReason.find_by(friendly_id: "not_as_described")
+      assert_not_nil new_return_reason
+      assert_equal "not_as_described", new_return_reason.friendly_id
+      assert_equal "not-as-described", new_return_reason.handle
+    end
+
+    test "execute raises error when return reason with same friendly_id already exists" do
+      stub_commands
+
+      assert_raises(ActiveModel::ValidationError) do
+        AddReturnReasonCommand.new(
+          name: "Defective or Doesn't Work", # This will generate the same friendly_id as @existing_return_reason
+          description: "Another defective description",
+        ).execute
+      end
+    end
+
+    test "execute raises error when name is empty" do
+      stub_commands
+
+      assert_raises(ActiveModel::ValidationError) do
+        AddReturnReasonCommand.new(
+          name: "",
+          description: "Valid description",
+        ).execute
+      end
+    end
+
+    test "execute raises error when description is empty" do
+      stub_commands
+
+      assert_raises(ActiveModel::ValidationError) do
+        AddReturnReasonCommand.new(
+          name: "Valid Name",
+          description: "",
+        ).execute
+      end
+    end
+
+    test "execute updates data files after creating return reason" do
+      DumpReturnReasonsCommand.any_instance.expects(:execute).once
+      SyncEnLocalizationsCommand.expects(:new).with(targets: "return_reasons").returns(stub(execute: true))
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddReturnReasonCommand.new(
+        name: "Changed My Mind",
+        description: "Customer no longer wants the item",
+      ).execute
+    end
+
+    test "execute assigns sequential IDs to multiple return reasons" do
+      stub_commands
+
+      AddReturnReasonCommand.new(
+        name: "First Reason",
+        description: "First description",
+      ).execute
+
+      first_reason = ReturnReason.find_by(friendly_id: "first_reason")
+      assert_equal 2, first_reason.id
+
+      AddReturnReasonCommand.new(
+        name: "Second Reason",
+        description: "Second description",
+      ).execute
+
+      second_reason = ReturnReason.find_by(friendly_id: "second_reason")
+      assert_equal 3, second_reason.id
+    end
+
+    test "execute handles special characters in name properly" do
+      stub_commands
+
+      AddReturnReasonCommand.new(
+        name: "Item's Quality & Appearance (Not Good!)",
+        description: "Quality or appearance issues with the product",
+      ).execute
+
+      new_return_reason = ReturnReason.find_by(friendly_id: "items_quality_appearance_not_good")
+      assert_not_nil new_return_reason
+      assert_equal "Item's Quality & Appearance (Not Good!)", new_return_reason.name
+      assert_equal "items_quality_appearance_not_good", new_return_reason.friendly_id
+      assert_equal "items-quality-appearance-not-good", new_return_reason.handle
+    end
+
+    private
+
+    def stub_commands
+      DumpReturnReasonsCommand.any_instance.stubs(:execute)
+      SyncEnLocalizationsCommand.any_instance.stubs(:execute)
+      GenerateDocsCommand.any_instance.stubs(:execute)
+    end
+  end
+end