Migrate add_attributes_to_categories command to new tool (#586)

Author: danielpgross

dev/lib/product_taxonomy.rb

@@ -54,4 +54,5 @@ def data_path = DATA_PATH
 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"

dev/lib/product_taxonomy/cli.rb

@@ -75,6 +75,13 @@ def add_attribute(name, description)
       AddAttributeCommand.new(options.merge(name:, description:)).run
     end
 
+    desc "add_attributes_to_categories ATTRIBUTE_FRIENDLY_IDS CATEGORY_IDS",
+      "Add one or more attributes to one or more categories. ATTRIBUTE_FRIENDLY_IDS is a comma-separated list of attribute friendly IDs."
+    option :include_descendants, type: :boolean, desc: "When set, the attributes will be added to all descendants of the specified categories"
+    def add_attributes_to_categories(attribute_friendly_ids, category_ids)
+      AddAttributesToCategoriesCommand.new(options.merge(attribute_friendly_ids:, category_ids:)).run
+    end
+
     desc "add_value NAME ATTRIBUTE_FRIENDLY_ID", "Add a new value with NAME to the primary attribute with ATTRIBUTE_FRIENDLY_ID"
     def add_value(name, attribute_friendly_id)
       AddValueCommand.new(options.merge(name:, attribute_friendly_id:)).run

dev/lib/product_taxonomy/commands/add_attributes_to_categories_command.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  class AddAttributesToCategoriesCommand < Command
+    def initialize(options)
+      super
+      load_taxonomy
+      @attribute_friendly_ids = options[:attribute_friendly_ids]
+      @category_ids = options[:category_ids]
+      @include_descendants = options[:include_descendants]
+    end
+
+    def execute
+      add_attributes_to_categories!
+      update_data_files!
+    end
+
+    private
+
+    def add_attributes_to_categories!
+      @attributes = attribute_friendly_ids.map do |friendly_id|
+        attribute = Attribute.find_by(friendly_id:)
+        next attribute if attribute
+
+        raise "Attribute with friendly ID `#{friendly_id}` not found"
+      end
+
+      @categories = category_ids.map do |id|
+        category = Category.find_by(id:)
+        next category if category
+
+        raise "Category with ID `#{id}` not found"
+      end
+
+      @categories = @categories.flat_map(&:descendants_and_self) if @include_descendants
+
+      @categories.each do |category|
+        @attributes.each do |attribute|
+          if category.attributes.include?(attribute)
+            logger.info("Category `#{category.name}` already has attribute `#{attribute.friendly_id}` - skipping")
+          else
+            category.add_attribute(attribute)
+          end
+        end
+      end
+
+      logger.info("Added #{@attributes.size} attribute(s) to #{@categories.size} categories")
+    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 attribute_friendly_ids
+      @attribute_friendly_ids.split(",").map(&:strip)
+    end
+
+    def category_ids
+      @category_ids.split(",").map(&:strip)
+    end
+  end
+end

dev/lib/product_taxonomy/models/category.rb

@@ -124,6 +124,13 @@ def add_secondary_child(child)
       child.secondary_parents << self
     end
 
+    # Add an attribute to the category
+    #
+    # @param [Attribute] attribute
+    def add_attribute(attribute)
+      @attributes << attribute
+    end
+
     #
     # Information
     #

dev/test/commands/add_attributes_to_categories_command_test.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module ProductTaxonomy
+  class AddAttributesToCategoriesCommandTest < TestCase
+    setup do
+      @color_attribute = Attribute.new(
+        id: 1,
+        name: "Color",
+        description: "Defines the primary color or pattern",
+        friendly_id: "color",
+        handle: "color",
+        values: [
+          Value.new(
+            id: 1,
+            name: "Black",
+            friendly_id: "color__black",
+            handle: "color__black",
+          ),
+        ],
+      )
+      @size_attribute = Attribute.new(
+        id: 2,
+        name: "Size",
+        description: "Defines the size of the product",
+        friendly_id: "size",
+        handle: "size",
+        values: [
+          Value.new(
+            id: 2,
+            name: "Small",
+            friendly_id: "size__small",
+            handle: "size__small",
+          ),
+        ],
+      )
+
+      Attribute.add(@color_attribute)
+      Attribute.add(@size_attribute)
+      Value.add(@color_attribute.values.first)
+      Value.add(@size_attribute.values.first)
+
+      @root = Category.new(id: "aa", name: "Apparel & Accessories")
+      @clothing = Category.new(id: "aa-1", name: "Clothing")
+      @shirts = Category.new(id: "aa-1-1", name: "Shirts")
+      @root.add_child(@clothing)
+      @clothing.add_child(@shirts)
+
+      Category.add(@root)
+      Category.add(@clothing)
+      Category.add(@shirts)
+
+      AddAttributesToCategoriesCommand.any_instance.stubs(:load_taxonomy)
+      DumpCategoriesCommand.any_instance.stubs(:load_taxonomy)
+      SyncEnLocalizationsCommand.any_instance.stubs(:load_taxonomy)
+      GenerateDocsCommand.any_instance.stubs(:load_taxonomy)
+    end
+
+    test "execute adds attributes to specified categories" do
+      DumpCategoriesCommand.any_instance.expects(:execute).once
+      SyncEnLocalizationsCommand.any_instance.expects(:execute).once
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddAttributesToCategoriesCommand.new(
+        attribute_friendly_ids: "color,size",
+        category_ids: "aa-1",
+        include_descendants: false
+      ).execute
+
+      assert_equal 2, @clothing.attributes.size
+      assert_includes @clothing.attributes, @color_attribute
+      assert_includes @clothing.attributes, @size_attribute
+
+      assert_empty @root.attributes
+      assert_empty @shirts.attributes
+    end
+
+    test "execute adds attributes to categories and their descendants when include_descendants is true" do
+      DumpCategoriesCommand.any_instance.expects(:execute).once
+      SyncEnLocalizationsCommand.any_instance.expects(:execute).once
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddAttributesToCategoriesCommand.new(
+        attribute_friendly_ids: "color",
+        category_ids: "aa-1",
+        include_descendants: true
+      ).execute
+
+      assert_equal 1, @clothing.attributes.size
+      assert_includes @clothing.attributes, @color_attribute
+
+      assert_equal 1, @shirts.attributes.size
+      assert_includes @shirts.attributes, @color_attribute
+
+      assert_empty @root.attributes
+    end
+
+    test "execute adds attributes to multiple categories" do
+      DumpCategoriesCommand.any_instance.expects(:execute).once
+      SyncEnLocalizationsCommand.any_instance.expects(:execute).once
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddAttributesToCategoriesCommand.new(
+        attribute_friendly_ids: "color",
+        category_ids: "aa,aa-1",
+        include_descendants: false
+      ).execute
+
+      assert_equal 1, @root.attributes.size
+      assert_includes @root.attributes, @color_attribute
+
+      assert_equal 1, @clothing.attributes.size
+      assert_includes @clothing.attributes, @color_attribute
+
+      assert_empty @shirts.attributes
+    end
+
+    test "execute skips adding attributes that are already present" do
+      @clothing.add_attribute(@color_attribute)
+
+      DumpCategoriesCommand.any_instance.expects(:execute).once
+      SyncEnLocalizationsCommand.any_instance.expects(:execute).once
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddAttributesToCategoriesCommand.new(
+        attribute_friendly_ids: "color,size",
+        category_ids: "aa-1",
+        include_descendants: false
+      ).execute
+
+      assert_equal 2, @clothing.attributes.size
+      assert_includes @clothing.attributes, @color_attribute
+      assert_includes @clothing.attributes, @size_attribute
+
+      assert_equal 1, @clothing.attributes.count { |attr| attr == @color_attribute }
+    end
+
+    test "execute raises error when attribute is not found" do
+      assert_raises(RuntimeError) do
+        AddAttributesToCategoriesCommand.new(
+          attribute_friendly_ids: "nonexistent",
+          category_ids: "aa-1",
+          include_descendants: false
+        ).execute
+      end
+    end
+
+    test "execute raises error when category is not found" do
+      assert_raises(RuntimeError) do
+        AddAttributesToCategoriesCommand.new(
+          attribute_friendly_ids: "color",
+          category_ids: "nonexistent",
+          include_descendants: false
+        ).execute
+      end
+    end
+
+    test "execute updates data files for all affected root categories" do
+      # When adding attributes to categories from different verticals,
+      # the command should update data files for all affected root categories
+      @second_root = Category.new(id: "bb", name: "Business & Industrial")
+      @equipment = Category.new(id: "bb-1", name: "Equipment")
+
+      @second_root.add_child(@equipment)
+
+      Category.add(@second_root)
+      Category.add(@equipment)
+
+      dump_command = mock
+      dump_command.expects(:execute).once
+      DumpCategoriesCommand.expects(:new).with(verticals: ["aa", "bb"]).returns(dump_command)
+
+      SyncEnLocalizationsCommand.any_instance.expects(:execute).once
+      GenerateDocsCommand.any_instance.expects(:execute).once
+
+      AddAttributesToCategoriesCommand.new(
+        attribute_friendly_ids: "color",
+        category_ids: "aa-1,bb-1",
+        include_descendants: false
+      ).execute
+
+      assert_equal 1, @clothing.attributes.size
+      assert_includes @clothing.attributes, @color_attribute
+
+      assert_equal 1, @equipment.attributes.size
+      assert_includes @equipment.attributes, @color_attribute
+    end
+  end
+end

dev/test/models/category_test.rb

@@ -31,6 +31,34 @@ class CategoryTest < TestCase
       assert_equal [root, root2], child.secondary_parents
     end
 
+    test "add_attribute adds multiple attributes to category's attributes" do
+      category = Category.new(id: "aa", name: "Root")
+      color_attribute = Attribute.new(
+        id: 1,
+        name: "Color",
+        friendly_id: "color",
+        handle: "color",
+        description: "Defines the primary color",
+        values: []
+      )
+
+      size_attribute = Attribute.new(
+        id: 2,
+        name: "Size",
+        friendly_id: "size",
+        handle: "size",
+        description: "Defines the size",
+        values: []
+      )
+
+      category.add_attribute(color_attribute)
+      category.add_attribute(size_attribute)
+
+      assert_includes category.attributes, color_attribute
+      assert_includes category.attributes, size_attribute
+      assert_equal 2, category.attributes.size
+    end
+
     test "root? is true for root node" do
       assert @root.root?
     end