Merge pull request #200 from ruby-i18n/movermeyer/sort_component_output

movermeyer · web-flow · commit 9bb5b6a41dae · 2022-09-19T10:41:17.000-04:00
Sort output at component level
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,6 +40,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Inherit currency symbol from ancestor locale instead of using other versions, [#137](https://github.com/ruby-i18n/ruby-cldr/pull/137)
 - Export region validity data, [#179](https://github.com/ruby-i18n/ruby-cldr/pull/179)
 - `Layout` component no longer exports files unless they contain data, [#183](https://github.com/ruby-i18n/ruby-cldr/pull/183)
+- Sort the data at the component level, allowing components to specify their own sort orders, [#200](https://github.com/ruby-i18n/ruby-cldr/pull/200)
 
 ---
 
diff --git a/lib/cldr/export/data/aliases.rb b/lib/cldr/export/data/aliases.rb
@@ -10,6 +10,7 @@ class Aliases < Base
         def initialize
           super(nil)
           update(aliases: aliases)
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/calendars/gregorian.rb b/lib/cldr/export/data/calendars/gregorian.rb
@@ -8,18 +8,18 @@ class Gregorian < Base
           def initialize(locale)
             super
             update(
-              months: contexts("month"),
+              additional_formats: additional_formats,
               days: contexts("day"),
-              eras: eras,
-              quarters: contexts("quarter"),
-              periods: contexts("dayPeriod", group: "alt"),
-              fields: fields,
+              eras: eras.deep_sort,
+              fields: fields.deep_sort,
               formats: {
                 date: formats("date"),
-                time: formats("time"),
                 datetime: formats("dateTime"),
+                time: formats("time"),
               },
-              additional_formats: additional_formats,
+              months: contexts("month"),
+              periods: contexts("dayPeriod", group: "alt").deep_sort,
+              quarters: contexts("quarter"),
             )
           end
 
@@ -52,8 +52,8 @@ def elements(node, kind, context, width, options = {})
                 key = key =~ /^\d*$/ ? key.to_i : key.to_sym
 
                 if options[:group] && (found_group = node.attribute(options[:group]))
-                  result[found_group.value] ||= {}
-                  result[found_group.value][key] = node.content
+                  result[found_group.value.to_sym] ||= {}
+                  result[found_group.value.to_sym][key] = node.content
                 else
                   result[key] = node.content
                 end
diff --git a/lib/cldr/export/data/country_codes.rb b/lib/cldr/export/data/country_codes.rb
@@ -7,6 +7,7 @@ class CountryCodes < Base
         def initialize
           super(nil)
           update(country_codes: country_codes)
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/currencies.rb b/lib/cldr/export/data/currencies.rb
@@ -7,6 +7,7 @@ class Currencies < Base
         def initialize(locale)
           super
           update(currencies: currencies)
+          deep_sort!
         end
 
         private
@@ -29,11 +30,12 @@ def currency(node)
           end
 
           symbols = select(node, "symbol")
-          symbol = symbols.select { |child_node| child_node.attribute("alt").nil? }.first
           narrow_symbol = symbols.select { |child_node| child_node.attribute("alt")&.value == ("narrow") }.first
-          data[:symbol] = symbol.content unless symbol.nil?
           data[:narrow_symbol] = narrow_symbol.content unless narrow_symbol.nil?
 
+          symbol = symbols.select { |child_node| child_node.attribute("alt").nil? }.first
+          data[:symbol] = symbol.content unless symbol.nil?
+
           data
         end
       end
diff --git a/lib/cldr/export/data/currency_digits_and_rounding.rb b/lib/cldr/export/data/currency_digits_and_rounding.rb
@@ -16,6 +16,8 @@ def initialize
 
             self[code.upcase.to_sym] = { digits: digits, rounding: rounding }
           end
+
+          deep_sort!
         end
       end
     end
diff --git a/lib/cldr/export/data/fields.rb b/lib/cldr/export/data/fields.rb
@@ -7,6 +7,7 @@ class Fields < Base
         def initialize(locale)
           super
           update(fields: fields)
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/likely_subtags.rb b/lib/cldr/export/data/likely_subtags.rb
@@ -7,6 +7,7 @@ class LikelySubtags < Base
         def initialize
           super(nil)
           update(subtags: subtags)
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/lists.rb b/lib/cldr/export/data/lists.rb
@@ -7,6 +7,7 @@ class Lists < Base
         def initialize(locale)
           super
           update(lists: lists)
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/metazones.rb b/lib/cldr/export/data/metazones.rb
@@ -21,6 +21,8 @@ def initialize
             territory = node.attr("iso3166").to_sym
             result[territory] = node.content
           end
+
+          deep_sort!
         end
 
         protected
diff --git a/lib/cldr/export/data/numbering_systems.rb b/lib/cldr/export/data/numbering_systems.rb
@@ -8,13 +8,14 @@ class NumberingSystems < Base
         def initialize(*args)
           super(nil)
           update(numbering_systems: numbering_systems)
+          deep_sort!
         end
 
         private
 
         def numbering_systems
           doc.xpath("supplementalData/numberingSystems/numberingSystem").each_with_object({}) do |numbering, ret|
-            system_name = numbering.attribute("id").value
+            system_name = numbering.attribute("id").value.to_sym
             type = numbering.attribute("type").value
 
             param = case type
@@ -26,7 +27,7 @@ def numbering_systems
 
             ret[system_name] = {
               :type => type,
-              param => numbering.attribute(param).value,
+              param.to_sym => numbering.attribute(param).value,
             }
           end
         end
diff --git a/lib/cldr/export/data/numbers.rb b/lib/cldr/export/data/numbers.rb
@@ -8,28 +8,29 @@ def initialize(locale)
           super
           update(
             numbers: {
-              symbols: symbols,
               formats: {
+                currency: {
+                  number_system: number_system("currency"),
+                  patterns: format("currency"),
+                  unit: unit,
+                },
                 decimal: {
                   number_system: number_system("decimal"),
                   patterns: format("decimal"),
                 },
-                scientific: {
-                  number_system: number_system("scientific"),
-                  patterns: format("scientific"),
-                },
                 percent: {
                   number_system: number_system("percent"),
                   patterns: format("percent"),
                 },
-                currency: {
-                  number_system: number_system("currency"),
-                  patterns: format("currency"),
-                  unit: unit,
+                scientific: {
+                  number_system: number_system("scientific"),
+                  patterns: format("scientific"),
                 },
               },
+              symbols: symbols,
             },
           )
+          deep_sort!
         end
 
         private
@@ -51,7 +52,7 @@ def format(type)
             format_nodes = select(format_length_node, "#{type}Format")
 
             format_key = format_length_node.attribute("type")
-            format_key = format_key ? format_key.value : :default
+            format_key = format_key ? format_key.value.to_sym : :default
 
             if !format_nodes.empty?
               format_nodes.each do |format_node|
@@ -60,10 +61,10 @@ def format(type)
 
                   pattern_count_node = pattern_node.attribute("count")
 
-                  pattern_key = pattern_key_node ? pattern_key_node.value : :default
+                  pattern_key = pattern_key_node ? pattern_key_node.value.to_sym : :default
 
                   if pattern_count_node
-                    pattern_count = pattern_count_node.value
+                    pattern_count = pattern_count_node.value.to_sym
 
                     if pattern_result[pattern_key].nil?
                       pattern_result[pattern_key] ||= {}
@@ -108,7 +109,7 @@ def number_system(type)
 
         def unit
           @unit ||= select("numbers/currencyFormats/unitPattern").each_with_object({}) do |node, result|
-            count = node.attribute("count").value
+            count = node.attribute("count").value.to_sym
             result[count] = node.content
           end
         end
diff --git a/lib/cldr/export/data/parent_locales.rb b/lib/cldr/export/data/parent_locales.rb
@@ -17,6 +17,8 @@ def initialize
               self[locale] = parent
             end
           end
+
+          deep_sort!
         end
 
         def to_h
diff --git a/lib/cldr/export/data/plural_rules.rb b/lib/cldr/export/data/plural_rules.rb
@@ -16,6 +16,8 @@ def initialize(locale)
               ret[rule.attributes["count"].text] = rule.text
             end
           end
+
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/region_currencies.rb b/lib/cldr/export/data/region_currencies.rb
@@ -7,6 +7,7 @@ class RegionCurrencies < Base
         def initialize
           super(nil)
           update(region_currencies: currencies)
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/region_validity.rb b/lib/cldr/export/data/region_validity.rb
@@ -7,6 +7,7 @@ class RegionValidity < Base
         def initialize
           super(nil)
           update(validity: { regions: regions })
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/segments_root.rb b/lib/cldr/export/data/segments_root.rb
@@ -7,6 +7,7 @@ class SegmentsRoot < Base
         def initialize
           super(:root)
           update(segments: segmentations)
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/subdivisions.rb b/lib/cldr/export/data/subdivisions.rb
@@ -7,6 +7,7 @@ class Subdivisions < Base
         def initialize(locale)
           super
           update(subdivisions: subdivisions)
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/territories_containment.rb b/lib/cldr/export/data/territories_containment.rb
@@ -7,6 +7,7 @@ class TerritoriesContainment < Base
         def initialize(*)
           super(nil)
           update(territories: territories)
+          deep_sort!
         end
 
         def territories
diff --git a/lib/cldr/export/data/timezones.rb b/lib/cldr/export/data/timezones.rb
@@ -11,9 +11,10 @@ def initialize(locale)
 
           update(
             formats: formats,
-            timezones: timezones,
             metazones: metazones,
+            timezones: timezones,
           )
+          deep_sort!
         end
 
         private
@@ -31,12 +32,12 @@ def timezones
           @timezones ||= select("dates/timeZoneNames/zone").each_with_object({}) do |zone, result|
             type = zone.attr("type").to_sym
             result[type] = {}
+            city = select_single(zone, "exemplarCity[not(@alt)]")
+            result[type][:city] = city.content if city
             long = nodes_to_hash(zone.xpath("long/*"))
             result[type][:long] = long unless long.empty?
             short = nodes_to_hash(zone.xpath("short/*"))
             result[type][:short] = short unless short.empty?
-            city = select_single(zone, "exemplarCity[not(@alt)]")
-            result[type][:city] = city.content if city
           end
         end
 
diff --git a/lib/cldr/export/data/units.rb b/lib/cldr/export/data/units.rb
@@ -8,10 +8,11 @@ def initialize(locale)
           super
           update(
             units: {
-              unitLength: unit_length,
               durationUnit: duration_unit,
+              unitLength: unit_length,
             },
           )
+          deep_sort!
         end
 
         private
diff --git a/lib/cldr/export/data/windows_zones.rb b/lib/cldr/export/data/windows_zones.rb
@@ -17,6 +17,8 @@ def initialize
             result[zone] ||= {}
             result[zone][territory] = timezones
           end
+
+          deep_sort!
         end
       end
     end
diff --git a/lib/cldr/export/yaml.rb b/lib/cldr/export/yaml.rb
@@ -7,7 +7,7 @@ module Export
     class Yaml
       def export(locale, component, options = {})
         data = Export.data(component, locale, options).to_h
-        data = format(data, locale)
+        data = format(data, locale, component)
         unless data.empty?
           path = Export.path(locale, component, "yml")
           Export.write(path, data.to_yaml)
@@ -18,11 +18,17 @@ def export(locale, component, options = {})
 
       private
 
-      def format(data, locale)
+      UNSORTED_COMPONENTS = [:Calendars, :Delimiters, :Lists].freeze
+
+      def format(data, locale, component)
         data.deep_prune!
         unless data.empty?
           data = data.deep_stringify_keys if data.respond_to?(:deep_stringify_keys)
-          data = data.deep_sort if data.respond_to?(:deep_sort)
+          if data.respond_to?(:deep_sort)
+            sorted_data = data.deep_sort
+            raise "#{component} data for #{locale} is not sorted." unless sorted_data.to_s == data.to_s || UNSORTED_COMPONENTS.include?(component)
+          end
+
           data = { locale.to_s => data } unless locale.nil?
         end
         data
diff --git a/test/export/data/numbers_test.rb b/test/export/data/numbers_test.rb
diff --git a/test/export/yaml_test.rb b/test/export/yaml_test.rb
