Refactor Category to use dedicated dist serializers (#563)

### TL;DR

Follow up to #531: moves category serialization logic into dedicated serializer classes for JSON and TXT formats.

### What changed?

- Created new `JsonSerializer` and `TxtSerializer` classes for category serialization
- Moved JSON serialization methods from `Category` model to `JsonSerializer`
- Moved TXT serialization methods from `Category` model to `TxtSerializer`
- Updated `GenerateDistCommand` to use the new serializer classes
- Added corresponding test files for both serializers

Author: danielpgross

dev/lib/product_taxonomy.rb

@@ -30,6 +30,8 @@ def data_path = DATA_PATH
 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/category/dist/json_serializer"
+require_relative "product_taxonomy/models/serializers/category/dist/txt_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"

dev/lib/product_taxonomy/commands/generate_dist_command.rb

@@ -50,8 +50,8 @@ def generate_dist_files(locale)
 
     def generate_txt_file(locale:, type:)
       txt_data = case type
-      when "categories" then Category.to_txt(version: @version, locale:)
       when "attributes" then Serializers::Attribute::Dist::TxtSerializer.serialize_all(version: @version, locale:)
+      when "categories" then Serializers::Category::Dist::TxtSerializer.serialize_all(version: @version, locale:)
       when "taxonomy" then return
       when "attribute_values" then Serializers::Value::Dist::TxtSerializer.serialize_all(version: @version, locale:)
       end
@@ -62,7 +62,10 @@ def generate_txt_file(locale:, type:)
     def generate_json_file(locale:, type:)
       json_data = case type
       when "categories"
-        @categories_json_by_locale[locale] ||= Category.to_json(version: @version, locale:)
+        @categories_json_by_locale[locale] ||= Serializers::Category::Dist::JsonSerializer.serialize_all(
+          version: @version,
+          locale:,
+        )
       when "attributes"
         @attributes_json_by_locale[locale] ||= Serializers::Attribute::Dist::JsonSerializer.serialize_all(
           version: @version,

dev/lib/product_taxonomy/models/category.rb

@@ -42,41 +42,6 @@ def load_from_source(source_data)
         @verticals.sort_by!(&:name)
       end
 
-      # Get the JSON representation of all verticals.
-      #
-      # @param version [String] The version of the taxonomy.
-      # @param locale [String] The locale to use for localized attributes.
-      # @return [Hash] The JSON representation of all verticals.
-      def to_json(version:, locale: "en")
-        {
-          "version" => version,
-          "verticals" => verticals.map do
-            {
-              "name" => _1.name(locale:),
-              "prefix" => _1.id,
-              "categories" => _1.descendants_and_self.map { |category| category.to_json(locale:) },
-            }
-          end,
-        }
-      end
-
-      # Get the TXT representation of all verticals.
-      #
-      # @param version [String] The version of the taxonomy.
-      # @param locale [String] The locale to use for localized attributes.
-      # @param padding [Integer] The padding to use for the GID. Defaults to the length of the longest GID.
-      # @return [String] The TXT representation of all verticals.
-      def to_txt(version:, locale: "en", padding: longest_gid_length)
-        header = <<~HEADER
-          # Shopify Product Taxonomy - Categories: #{version}
-          # Format: {GID} : {Ancestor name} > ... > {Category name}
-        HEADER
-        [
-          header,
-          *all_depth_first.map { _1.to_txt(padding:, locale:) },
-        ].join("\n")
-      end
-
       # Reset all class-level state
       def reset
         @localizations = nil
@@ -103,10 +68,6 @@ def add_children(type:, item:, parent:)
           end
         end
       end
-
-      def longest_gid_length
-        all.max_by { _1.gid.length }.gid.length
-      end
     end
 
     validates :id, format: { with: /\A[a-z]{2}(-\d+)*\z/ }
@@ -266,45 +227,6 @@ def friendly_name
       "#{id}_#{IdentifierFormatter.format_friendly_id(name)}"
     end
 
-    #
-    # Serialization
-    #
-
-    def to_json(locale: "en")
-      {
-        "id" => gid,
-        "level" => level,
-        "name" => name(locale:),
-        "full_name" => full_name(locale:),
-        "parent_id" => parent&.gid,
-        "attributes" => attributes.map do
-          {
-            "id" => _1.gid,
-            "name" => _1.name(locale:),
-            "handle" => _1.handle,
-            "description" => _1.description(locale:),
-            "extended" => _1.is_a?(ExtendedAttribute),
-          }
-        end,
-        "children" => children.map do
-          {
-            "id" => _1.gid,
-            "name" => _1.name(locale:),
-          }
-        end,
-        "ancestors" => ancestors.map do
-          {
-            "id" => _1.gid,
-            "name" => _1.name(locale:),
-          }
-        end,
-      }
-    end
-
-    def to_txt(padding: 0, locale: "en")
-      "#{gid.ljust(padding)} : #{full_name(locale:)}"
-    end
-
     private
 
     #

dev/lib/product_taxonomy/models/serializers/category/dist/json_serializer.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  module Serializers
+    module Category
+      module Dist
+        module JsonSerializer
+          class << self
+            def serialize_all(version:, locale: "en")
+              {
+                "version" => version,
+                "verticals" => ProductTaxonomy::Category.verticals.map do |vertical|
+                  {
+                    "name" => vertical.name(locale:),
+                    "prefix" => vertical.id,
+                    "categories" => vertical.descendants_and_self.map { |category| serialize(category, locale:) },
+                  }
+                end,
+              }
+            end
+
+            # @param category [Category]
+            # @param locale [String] The locale to use for localization.
+            # @return [Hash]
+            def serialize(category, locale: "en")
+              {
+                "id" => category.gid,
+                "level" => category.level,
+                "name" => category.name(locale:),
+                "full_name" => category.full_name(locale:),
+                "parent_id" => category.parent&.gid,
+                "attributes" => category.attributes.map do |attr|
+                  {
+                    "id" => attr.gid,
+                    "name" => attr.name(locale:),
+                    "handle" => attr.handle,
+                    "description" => attr.description(locale:),
+                    "extended" => attr.is_a?(ExtendedAttribute),
+                  }
+                end,
+                "children" => category.children.map do |child|
+                  {
+                    "id" => child.gid,
+                    "name" => child.name(locale:),
+                  }
+                end,
+                "ancestors" => category.ancestors.map do |ancestor|
+                  {
+                    "id" => ancestor.gid,
+                    "name" => ancestor.name(locale:),
+                  }
+                end,
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

dev/lib/product_taxonomy/models/serializers/category/dist/txt_serializer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ProductTaxonomy
+  module Serializers
+    module Category
+      module Dist
+        module TxtSerializer
+          class << self
+            def serialize_all(version:, locale: "en", padding: longest_gid_length)
+              header = <<~HEADER
+                # Shopify Product Taxonomy - Categories: #{version}
+                # Format: {GID} : {Ancestor name} > ... > {Category name}
+
+              HEADER
+
+              categories_txt = ProductTaxonomy::Category
+                .all_depth_first
+                .map { |category| serialize(category, padding:, locale:) }
+                .join("\n")
+
+              header + categories_txt
+            end
+
+            # @param category [Category]
+            # @param padding [Integer] The padding to use for the GID.
+            # @param locale [String] The locale to use for localization.
+            # @return [String]
+            def serialize(category, padding:, locale: "en")
+              "#{category.gid.ljust(padding)} : #{category.full_name(locale:)}"
+            end
+
+            private
+
+            def longest_gid_length
+              ProductTaxonomy::Category.all.max_by { |c| c.gid.length }.gid.length
+            end
+          end
+        end
+      end
+    end
+  end
+end