Migrate dump_values command to new tool (#575)

Author: danielpgross

dev/lib/product_taxonomy.rb

@@ -39,6 +39,7 @@ def data_path = DATA_PATH
 require_relative "product_taxonomy/models/serializers/attribute/docs/search_serializer"
 require_relative "product_taxonomy/models/serializers/attribute/dist/json_serializer"
 require_relative "product_taxonomy/models/serializers/attribute/dist/txt_serializer"
+require_relative "product_taxonomy/models/serializers/value/data/data_serializer"
 require_relative "product_taxonomy/models/serializers/value/data/localizations_serializer"
 require_relative "product_taxonomy/models/serializers/value/dist/json_serializer"
 require_relative "product_taxonomy/models/serializers/value/dist/txt_serializer"
@@ -49,5 +50,6 @@ 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/dump_attributes_command"
+require_relative "product_taxonomy/commands/dump_values_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,6 +51,11 @@ def dump_attributes
       DumpAttributesCommand.new(options).run
     end
 
+    desc "dump_values", "Dump values to YAML file"
+    def dump_values
+      DumpValuesCommand.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

dev/lib/product_taxonomy/commands/dump_values_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  class DumpValuesCommand < Command
+    def execute
+      logger.info("Dumping values...")
+
+      load_taxonomy
+
+      path = File.expand_path("values.yml", ProductTaxonomy.data_path)
+      FileUtils.mkdir_p(File.dirname(path))
+
+      data = Serializers::Value::Data::DataSerializer.serialize_all
+      File.write(path, YAML.dump(data, line_width: -1))
+
+      logger.info("Updated `#{path}`")
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  module Serializers
+    module Value
+      module Data
+        module DataSerializer
+          class << self
+            def serialize_all
+              ProductTaxonomy::Value.all.sort_by(&:id).map { serialize(_1) }
+            end
+
+            # @param [Value] value
+            # @return [Hash]
+            def serialize(value)
+              {
+                "id" => value.id,
+                "name" => value.name,
+                "friendly_id" => value.friendly_id,
+                "handle" => value.handle,
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

dev/test/commands/dump_values_command_test.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+
+module ProductTaxonomy
+  class DumpValuesCommandTest < TestCase
+    setup do
+      @tmp_base_path = Dir.mktmpdir
+      @real_base_path = File.expand_path("..", ProductTaxonomy.data_path)
+
+      FileUtils.mkdir_p(File.expand_path("data", @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 "execute dumps values to YAML file" do
+      mock_data = [{ "id" => 1, "name" => "Test Value", "friendly_id" => "test__value", "handle" => "test__value" }]
+      Serializers::Value::Data::DataSerializer.stubs(:serialize_all)
+        .returns(mock_data)
+
+      command = DumpValuesCommand.new({})
+      command.execute
+
+      expected_path = File.expand_path("data/values.yml", @tmp_base_path)
+      expected_content = "---\n- id: 1\n  name: Test Value\n  friendly_id: test__value\n  handle: test__value\n"
+      assert File.exist?(expected_path)
+      assert_equal expected_content, File.read(expected_path)
+    end
+  end
+end

dev/test/models/serializers/value/data/data_serializer_test.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module ProductTaxonomy
+  module Serializers
+    module Value
+      module Data
+        class DataSerializerTest < TestCase
+          setup do
+            @value1 = ProductTaxonomy::Value.new(
+              id: 1,
+              name: "Black",
+              friendly_id: "color__black",
+              handle: "color__black"
+            )
+            @value2 = ProductTaxonomy::Value.new(
+              id: 2,
+              name: "Red",
+              friendly_id: "color__red",
+              handle: "color__red"
+            )
+            @value3 = ProductTaxonomy::Value.new(
+              id: 3,
+              name: "Blue",
+              friendly_id: "color__blue",
+              handle: "color__blue"
+            )
+
+            ProductTaxonomy::Value.add(@value1)
+            ProductTaxonomy::Value.add(@value2)
+            ProductTaxonomy::Value.add(@value3)
+          end
+
+          test "serialize returns the expected data structure for a value" do
+            expected = {
+              "id" => 1,
+              "name" => "Black",
+              "friendly_id" => "color__black",
+              "handle" => "color__black"
+            }
+
+            assert_equal expected, DataSerializer.serialize(@value1)
+          end
+
+          test "serialize_all returns all values in data format" do
+            expected = [
+              {
+                "id" => 1,
+                "name" => "Black",
+                "friendly_id" => "color__black",
+                "handle" => "color__black"
+              },
+              {
+                "id" => 2,
+                "name" => "Red",
+                "friendly_id" => "color__red",
+                "handle" => "color__red"
+              },
+              {
+                "id" => 3,
+                "name" => "Blue",
+                "friendly_id" => "color__blue",
+                "handle" => "color__blue"
+              }
+            ]
+
+            assert_equal expected, DataSerializer.serialize_all
+          end
+
+          test "serialize_all sorts values by ID" do
+            # Add values in random order to ensure sorting is by ID
+            ProductTaxonomy::Value.reset
+            ProductTaxonomy::Value.add(@value3)
+            ProductTaxonomy::Value.add(@value1)
+            ProductTaxonomy::Value.add(@value2)
+
+            result = DataSerializer.serialize_all
+
+            assert_equal 3, result.length
+            assert_equal "color__black", result[0]["friendly_id"]
+            assert_equal "color__red", result[1]["friendly_id"]
+            assert_equal "color__blue", result[2]["friendly_id"]
+          end
+        end
+      end
+    end
+  end
+end