Migrate sync_en_localizations command to new tool (#556)

Author: danielpgross

dev/lib/product_taxonomy.rb

@@ -27,14 +27,18 @@ def data_path = DATA_PATH
 require_relative "product_taxonomy/models/mapping_rule"
 require_relative "product_taxonomy/models/integration_version"
 require_relative "product_taxonomy/models/serializers/category/data/data_serializer"
+require_relative "product_taxonomy/models/serializers/category/data/localizations_serializer"
 require_relative "product_taxonomy/models/serializers/category/docs/siblings_serializer"
 require_relative "product_taxonomy/models/serializers/category/docs/search_serializer"
+require_relative "product_taxonomy/models/serializers/attribute/data/localizations_serializer"
 require_relative "product_taxonomy/models/serializers/attribute/docs/base_and_extended_serializer"
 require_relative "product_taxonomy/models/serializers/attribute/docs/reversed_serializer"
 require_relative "product_taxonomy/models/serializers/attribute/docs/search_serializer"
+require_relative "product_taxonomy/models/serializers/value/data/localizations_serializer"
 require_relative "product_taxonomy/commands/command"
 require_relative "product_taxonomy/commands/generate_dist_command"
 require_relative "product_taxonomy/commands/find_unmapped_external_categories_command"
 require_relative "product_taxonomy/commands/generate_docs_command"
 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"

dev/lib/product_taxonomy/cli.rb

@@ -45,5 +45,11 @@ def release
     def dump_categories
       DumpCategoriesCommand.new(options).run
     end
+
+    desc "sync_en_localizations", "Sync English localizations for categories, attributes, and values"
+    option :targets, type: :string, desc: "List of targets to sync. Valid targets are: categories, attributes, values"
+    def sync_en_localizations
+      SyncEnLocalizationsCommand.new(options).run
+    end
   end
 end

dev/lib/product_taxonomy/commands/sync_en_localizations_command.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  class SyncEnLocalizationsCommand < Command
+    PERMITTED_TARGETS = ["categories", "attributes", "values"].freeze
+
+    def initialize(options)
+      super
+      load_taxonomy
+      @targets = options[:targets]&.split(",") || PERMITTED_TARGETS
+      @targets.each do |target|
+        raise "Invalid target: #{target}. Must be one of: #{PERMITTED_TARGETS.join(', ')}" unless PERMITTED_TARGETS.include?(target)
+      end
+    end
+
+    def execute
+      logger.info("Syncing EN localizations")
+
+      sync_categories if @targets.include?("categories")
+      sync_attributes if @targets.include?("attributes")
+      sync_values if @targets.include?("values")
+    end
+
+    private
+
+    def sync_categories
+      logger.info("Syncing categories...")
+      localizations = Serializers::Category::Data::LocalizationsSerializer.serialize_all
+      write_localizations("categories", localizations)
+    end
+
+    def sync_attributes
+      logger.info("Syncing attributes...")
+      localizations = Serializers::Attribute::Data::LocalizationsSerializer.serialize_all
+      write_localizations("attributes", localizations)
+    end
+
+    def sync_values
+      logger.info("Syncing values...")
+      localizations = Serializers::Value::Data::LocalizationsSerializer.serialize_all
+      write_localizations("values", localizations)
+    end
+
+    def write_localizations(type, localizations)
+      file_path = File.expand_path("localizations/#{type}/en.yml", ProductTaxonomy.data_path)
+      File.open(file_path, "w") do |file|
+        file.puts "# This file is auto-generated. Do not edit directly."
+        file.write(YAML.dump(localizations, line_width: -1))
+      end
+      logger.info("Wrote #{type} localizations to #{file_path}")
+    end
+  end
+end

dev/lib/product_taxonomy/models/serializers/attribute/data/localizations_serializer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  module Serializers
+    module Attribute
+      module Data
+        module LocalizationsSerializer
+          class << self
+            def serialize_all
+              attributes = ProductTaxonomy::Attribute.all
+
+              {
+                "en" => {
+                  "attributes" => attributes.sort_by(&:friendly_id).reduce({}) { _1.merge!(serialize(_2)) },
+                },
+              }
+            end
+
+            # @param [Attribute] attribute
+            # @return [Hash]
+            def serialize(attribute)
+              {
+                attribute.friendly_id => {
+                  "name" => attribute.name,
+                  "description" => attribute.description,
+                },
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

dev/lib/product_taxonomy/models/serializers/category/data/localizations_serializer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  module Serializers
+    module Category
+      module Data
+        module LocalizationsSerializer
+          class << self
+            def serialize_all
+              categories = ProductTaxonomy::Category.all_depth_first
+
+              {
+                "en" => {
+                  "categories" => categories.sort_by(&:id_parts).reduce({}) { _1.merge!(serialize(_2)) },
+                },
+              }
+            end
+
+            # @param [Category] category
+            # @return [Hash]
+            def serialize(category)
+              {
+                category.id => {
+                  "name" => category.name,
+                  "context" => category.full_name,
+                },
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

dev/lib/product_taxonomy/models/serializers/value/data/localizations_serializer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  module Serializers
+    module Value
+      module Data
+        module LocalizationsSerializer
+          class << self
+            def serialize_all
+              values = ProductTaxonomy::Value.all
+
+              {
+                "en" => {
+                  "values" => values.sort_by(&:friendly_id).reduce({}) { _1.merge!(serialize(_2)) },
+                },
+              }
+            end
+
+            # @param [Value] value
+            # @return [Hash]
+            def serialize(value)
+              {
+                value.friendly_id => {
+                  "name" => value.name,
+                  "context" => value.primary_attribute.name,
+                },
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

dev/test/commands/sync_en_localizations_command_test.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+
+module ProductTaxonomy
+  class SyncEnLocalizationsCommandTest < TestCase
+    setup do
+      @tmp_base_path = Dir.mktmpdir
+      @real_base_path = File.expand_path("..", ProductTaxonomy.data_path)
+
+      FileUtils.mkdir_p(File.expand_path("data/localizations/categories", @tmp_base_path))
+      FileUtils.mkdir_p(File.expand_path("data/localizations/attributes", @tmp_base_path))
+      FileUtils.mkdir_p(File.expand_path("data/localizations/values", @tmp_base_path))
+      ProductTaxonomy.stubs(:data_path).returns(File.expand_path("data", @tmp_base_path))
+
+      Command.any_instance.stubs(:load_taxonomy)
+    end
+
+    teardown do
+      FileUtils.remove_entry(@tmp_base_path)
+    end
+
+    test "initialize sets targets to all permitted targets when not specified" do
+      command = SyncEnLocalizationsCommand.new({})
+      assert_equal ["categories", "attributes", "values"], command.instance_variable_get(:@targets)
+    end
+
+    test "initialize accepts custom targets" do
+      command = SyncEnLocalizationsCommand.new(targets: "categories,attributes")
+      assert_equal ["categories", "attributes"], command.instance_variable_get(:@targets)
+    end
+
+    test "initialize raises error for invalid target" do
+      assert_raises(RuntimeError) do
+        SyncEnLocalizationsCommand.new(targets: "invalid,categories")
+      end
+    end
+
+    test "execute syncs categories localizations" do
+      mock_localizations = { "test" => "data" }
+      Serializers::Category::Data::LocalizationsSerializer.stubs(:serialize_all)
+        .returns(mock_localizations)
+
+      command = SyncEnLocalizationsCommand.new(targets: "categories")
+      command.execute
+
+      expected_path = File.expand_path("data/localizations/categories/en.yml", @tmp_base_path)
+      assert File.exist?(expected_path)
+      expected_content = "# This file is auto-generated. Do not edit directly.\n---\ntest: data\n"
+      assert_equal expected_content, File.read(expected_path)
+    end
+
+    test "execute syncs attributes localizations" do
+      mock_localizations = { "test" => "attribute_data" }
+      Serializers::Attribute::Data::LocalizationsSerializer.stubs(:serialize_all)
+        .returns(mock_localizations)
+
+      command = SyncEnLocalizationsCommand.new(targets: "attributes")
+      command.execute
+
+      expected_path = File.expand_path("data/localizations/attributes/en.yml", @tmp_base_path)
+      assert File.exist?(expected_path)
+      expected_content = "# This file is auto-generated. Do not edit directly.\n---\ntest: attribute_data\n"
+      assert_equal expected_content, File.read(expected_path)
+    end
+
+    test "execute syncs values localizations" do
+      mock_localizations = { "test" => "value_data" }
+      Serializers::Value::Data::LocalizationsSerializer.stubs(:serialize_all)
+        .returns(mock_localizations)
+
+      command = SyncEnLocalizationsCommand.new(targets: "values")
+      command.execute
+
+      expected_path = File.expand_path("data/localizations/values/en.yml", @tmp_base_path)
+      assert File.exist?(expected_path)
+      expected_content = "# This file is auto-generated. Do not edit directly.\n---\ntest: value_data\n"
+      assert_equal expected_content, File.read(expected_path)
+    end
+
+    test "execute syncs all targets when none specified" do
+      Serializers::Category::Data::LocalizationsSerializer.stubs(:serialize_all)
+        .returns({ "category" => "data" })
+      Serializers::Attribute::Data::LocalizationsSerializer.stubs(:serialize_all)
+        .returns({ "attribute" => "data" })
+      Serializers::Value::Data::LocalizationsSerializer.stubs(:serialize_all)
+        .returns({ "value" => "data" })
+
+      command = SyncEnLocalizationsCommand.new({})
+      command.execute
+
+      categories_path = File.expand_path("data/localizations/categories/en.yml", @tmp_base_path)
+      attributes_path = File.expand_path("data/localizations/attributes/en.yml", @tmp_base_path)
+      values_path = File.expand_path("data/localizations/values/en.yml", @tmp_base_path)
+
+      assert File.exist?(categories_path)
+      assert File.exist?(attributes_path)
+      assert File.exist?(values_path)
+
+      expected_categories = "# This file is auto-generated. Do not edit directly.\n---\ncategory: data\n"
+      expected_attributes = "# This file is auto-generated. Do not edit directly.\n---\nattribute: data\n"
+      expected_values = "# This file is auto-generated. Do not edit directly.\n---\nvalue: data\n"
+
+      assert_equal expected_categories, File.read(categories_path)
+      assert_equal expected_attributes, File.read(attributes_path)
+      assert_equal expected_values, File.read(values_path)
+    end
+  end
+end

dev/test/models/serializers/attribute/data/localizations_serializer_test.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module ProductTaxonomy
+  module Serializers
+    module Attribute
+      module Data
+        class LocalizationsSerializerTest < TestCase
+          setup do
+            @value = ProductTaxonomy::Value.new(
+              id: 1,
+              name: "Black",
+              friendly_id: "black",
+              handle: "black"
+            )
+
+            @attribute = ProductTaxonomy::Attribute.new(
+              id: 1,
+              name: "Color",
+              friendly_id: "color",
+              handle: "color",
+              description: "The color of the item",
+              values: [@value]
+            )
+          end
+
+          test "serialize returns the expected data structure for an attribute" do
+            expected = {
+              "color" => {
+                "name" => "Color",
+                "description" => "The color of the item"
+              }
+            }
+
+            assert_equal expected, LocalizationsSerializer.serialize(@attribute)
+          end
+
+          test "serialize_all returns all attributes in localization format" do
+            ProductTaxonomy::Attribute.stubs(:all).returns([@attribute])
+
+            expected = {
+              "en" => {
+                "attributes" => {
+                  "color" => {
+                    "name" => "Color",
+                    "description" => "The color of the item"
+                  }
+                }
+              }
+            }
+
+            assert_equal expected, LocalizationsSerializer.serialize_all
+          end
+        end
+      end
+    end
+  end
+end