Migrate add_category command to new tool (#565)

Author: danielpgross

dev/lib/product_taxonomy.rb

@@ -48,3 +48,4 @@ def data_path = DATA_PATH
 require_relative "product_taxonomy/commands/generate_release_command"
 require_relative "product_taxonomy/commands/dump_categories_command"
 require_relative "product_taxonomy/commands/sync_en_localizations_command"
+require_relative "product_taxonomy/commands/add_category_command"

dev/lib/product_taxonomy/cli.rb

@@ -51,5 +51,11 @@ def dump_categories
     def sync_en_localizations
       SyncEnLocalizationsCommand.new(options).run
     end
+
+    desc "add_category NAME PARENT_ID", "Add a new category to the taxonomy with NAME, as a child of PARENT_ID"
+    option :id, type: :string, desc: "Override the created category's ID"
+    def add_category(name, parent_id)
+      AddCategoryCommand.new(options.merge(name:, parent_id:)).run
+    end
   end
 end

dev/lib/product_taxonomy/commands/add_category_command.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  class AddCategoryCommand < Command
+    def initialize(options)
+      super
+      load_taxonomy
+      @name = options[:name]
+      @parent_id = options[:parent_id]
+      @id = options[:id]
+    end
+
+    def execute
+      create_category!
+      update_data_files!
+    end
+
+    private
+
+    def create_category!
+      parent = Category.find_by(id: @parent_id)
+      raise "Parent category `#{@parent_id}` not found" if parent.nil?
+
+      @new_category = Category.new(id: @id || parent.next_child_id, name: @name, parent:)
+      raise "Failed to create category: #{@new_category.errors.full_messages.to_sentence}" unless @new_category.valid?
+
+      parent.add_child(@new_category)
+      Category.add(@new_category)
+      logger.info("Created category `#{@new_category.name}` with id=`#{@new_category.id}`")
+    end
+
+    def update_data_files!
+      DumpCategoriesCommand.new(verticals: [@new_category.root.id]).execute
+      SyncEnLocalizationsCommand.new(targets: "categories").execute
+      GenerateDocsCommand.new({}).execute
+    end
+  end
+end

dev/lib/product_taxonomy/models/category.rb

@@ -227,6 +227,15 @@ def friendly_name
       "#{id}_#{IdentifierFormatter.format_friendly_id(name)}"
     end
 
+    # The next child ID for the category
+    #
+    # @return [String]
+    def next_child_id
+      largest_child_id = children.map { _1.id.split("-").last.to_i }.max || 0
+
+      "#{id}-#{largest_child_id + 1}"
+    end
+
     private
 
     #

dev/test/commands/add_category_command_test.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module ProductTaxonomy
+  class AddCategoryCommandTest < TestCase
+    setup do
+      @root_category = Category.new(id: "aa", name: "Root Category")
+      @child_category = Category.new(id: "aa-1", name: "Child Category", parent: @root_category)
+      @root_category.add_child(@child_category)
+
+      Category.add(@root_category)
+      Category.add(@child_category)
+    end
+
+    test "execute successfully adds a new category" do
+      DumpCategoriesCommand.any_instance.expects(:execute).once
+      SyncEnLocalizationsCommand.any_instance.expects(:execute).once
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddCategoryCommand.new(name: "New Category", parent_id: "aa").execute
+
+      new_category = @root_category.children.find { |c| c.name == "New Category" }
+      assert_not_nil new_category
+      assert_equal "aa-2", new_category.id  # Since aa-1 already exists
+      assert_equal "New Category", new_category.name
+      assert_equal @root_category, new_category.parent
+      assert_not_nil Category.find_by(id: "aa-2")
+    end
+
+    test "execute successfully adds a category with custom numeric ID" do
+      DumpCategoriesCommand.any_instance.expects(:execute).once
+      SyncEnLocalizationsCommand.any_instance.expects(:execute).once
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddCategoryCommand.new(name: "Custom ID Category", parent_id: "aa", id: "aa-5").execute
+
+      new_category = @root_category.children.find { |c| c.name == "Custom ID Category" }
+      assert_not_nil new_category
+      assert_equal "aa-5", new_category.id
+      assert_equal "Custom ID Category", new_category.name
+      assert_equal @root_category, new_category.parent
+      assert_not_nil Category.find_by(id: "aa-5")
+    end
+
+    test "execute raises error when parent category not found" do
+      assert_raises(RuntimeError) do
+        AddCategoryCommand.new(name: "New Category", parent_id: "nonexistent").execute
+      end
+    end
+
+    test "execute raises error when category ID already exists" do
+      assert_raises(RuntimeError) do
+        AddCategoryCommand.new(name: "Duplicate ID", parent_id: "aa", id: "aa-1").execute
+      end
+    end
+
+    test "execute raises error when category ID format is invalid" do
+      assert_raises(RuntimeError) do
+        AddCategoryCommand.new(name: "Invalid ID", parent_id: "aa", id: "aa-custom").execute
+      end
+    end
+
+    test "execute raises error when category name is invalid" do
+      assert_raises(RuntimeError) do
+        AddCategoryCommand.new(name: "", parent_id: "aa").execute
+      end
+    end
+
+    test "execute updates correct vertical based on parent category" do
+      DumpCategoriesCommand.expects(:new).with(verticals: ["aa"]).returns(stub(execute: true))
+      SyncEnLocalizationsCommand.any_instance.stubs(:execute)
+      GenerateDocsCommand.any_instance.stubs(:execute)
+
+      AddCategoryCommand.new(name: "New Category", parent_id: "aa").execute
+
+      new_category = @root_category.children.find { |c| c.name == "New Category" }
+      assert_not_nil new_category
+      assert_equal @root_category, new_category.parent
+      assert_not_nil Category.find_by(id: "aa-2")
+    end
+
+    test "execute generates sequential IDs correctly" do
+      DumpCategoriesCommand.any_instance.stubs(:execute)
+      SyncEnLocalizationsCommand.any_instance.stubs(:execute)
+      GenerateDocsCommand.any_instance.stubs(:execute)
+
+      AddCategoryCommand.new(name: "First New", parent_id: "aa").execute
+      AddCategoryCommand.new(name: "Second New", parent_id: "aa").execute
+
+      new_categories = @root_category.children.select { |c| c.name.include?("New") }.sort_by(&:id)
+      assert_equal 2, new_categories.size
+      assert_equal "aa-2", new_categories[0].id
+      assert_equal "aa-3", new_categories[1].id
+      assert_equal "First New", new_categories[0].name
+      assert_equal "Second New", new_categories[1].name
+      assert_not_nil Category.find_by(id: "aa-2")
+      assert_not_nil Category.find_by(id: "aa-3")
+    end
+  end
+end

dev/test/models/category_test.rb

@@ -403,6 +403,34 @@ class CategoryTest < TestCase
       assert_equal ["aa", 1, 1], @grandchild.id_parts
     end
 
+    test "next_child_id returns id-1 for category with no children" do
+      category = Category.new(id: "aa", name: "Root")
+
+      assert_equal "aa-1", category.next_child_id
+    end
+
+    test "next_child_id returns next sequential id based on largest child id" do
+      root = Category.new(id: "aa", name: "Root")
+      child1 = Category.new(id: "aa-1", name: "Child 1")
+      child2 = Category.new(id: "aa-2", name: "Child 2")
+      child3 = Category.new(id: "aa-5", name: "Child 3") # Note gap in sequence
+      root.add_child(child1)
+      root.add_child(child2)
+      root.add_child(child3)
+
+      assert_equal "aa-6", root.next_child_id
+    end
+
+    test "next_child_id ignores secondary children when determining next id" do
+      root = Category.new(id: "aa", name: "Root")
+      child = Category.new(id: "aa-1", name: "Child")
+      secondary = Category.new(id: "bb-5", name: "Secondary")
+      root.add_child(child)
+      root.add_secondary_child(secondary)
+
+      assert_equal "aa-2", root.next_child_id
+    end
+
     private
 
     def stub_localizations