Refactor release-archives page to use a custom liquid filter

The `sort_by_semver_key` filter takes a hash and sorts it by the key,
emitting an array of key-value arrays. It can take either a dotty or
underscorey semver key and sort them in descending order. They are
sorted lexicographically by left padding each version component with
zeros, so might need some work to handle SNAPSHOT if we ever want
that involved.

The filter can be configured to sort them ascending with
`sort_by_semver_key: 'asc'`.

Signed-off-by: Robert Young <[email protected]>

Author: robobario

_plugins/sort_hash_by.rb

@@ -0,0 +1,30 @@
+module Jekyll
+  module CustomSortFilters
+    def sort_by_semver_key(hash, direction = 'desc')
+      unless hash.is_a?(Hash)
+        raise ArgumentError, "Filter 'sort_by_semver_key' requires a Hash, but received a #{hash.class.name}."
+      end
+
+      sorted_array = hash.sort_by do |key, value|
+        key_str = key.to_s
+
+        normalized_str = key_str.gsub('.', '_')
+
+        unless normalized_str.match?(/\A\d+_\d+_\d+\z/)
+          raise ArgumentError, "Invalid semver key in 'sort_by_semver_key'. Expected '1.2.3' or '1_2_3', but found '#{key_str}'."
+        end
+
+        normalized_str.split('_').map { |part| part.rjust(5, '0') }.join('.')
+      end
+
+      # controlling this from the filter is convenient because 'sort_by_semver_key | reverse' doesn't work as expected
+      if direction == 'desc'
+        return sorted_array.reverse
+      else
+        return sorted_array
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::CustomSortFilters)

release-archives/index.md

@@ -2,56 +2,29 @@
 layout: default
 title: Release Archives
 ---
+
 {%- comment -%}
-`site.data.release` an object and unordered.
-Liquid lacks any ability to sort it, or convert it to an array for sorting. 
-This following monstrosity is to work around that.
-{%- endcomment -%}
-{%- assign versionsList="" -%}
-{%- for major in (0..999) -%}
-  {%- assign probe1=major | append: "_1_0" -%}
-  {%- if site.data.release[probe1] -%}
-    {%- for minor in (1..999) -%}
-      {%- assign probe2=major | append: "_" | append: minor | append: "_0" -%}
-      {%- if site.data.release[probe2] -%}
-        {%- for micro in (0..999) -%}
-          {%- assign key=major | append: "_" | append: minor | append: "_" | append: micro -%}
-          {%- if site.data.release[key] -%}
-            {%- assign versionsList=versionsList | append: "," | append: key -%}
-          {%- else -%}
-            {%- break -%}
-          {%- endif -%}
-        {%- endfor -%}
-      {%- else -%}
-        {%- break -%}
-      {%- endif -%}
-    {%- endfor -%}
-  {%- else -%}
-    {%- break -%}
-  {%- endif -%}
-{%- endfor -%}
-{%- assign versionsList=versionsList | remove_first: "," | split: "," | reverse -%}
-{%- comment -%}
-endmonstrosity
+`sort_by_semver_key` is a custom filter in _plugins.
 {%- endcomment -%}
+{%- assign sorted_releases = site.data.release | sort_by_semver_key -%}
 
 <div class="row align-items-start justify-content-center my-5">
   <div class="col-lg-3 mb-5" role="complementary" aria-labelledby="page-title">
     <div class="card shadow px-2 mx-2">
       <div class="card-body">
       <h1 id="page-title" class="fs-3">{{ page.title }}</h1>
       <ul>
-{%- for relKey in versionsList -%}
-{%- assign releaseVersion=relKey | replace: '_', '.' -%}
+{% for rel_entry in sorted_releases %}
+{%- assign releaseVersion=rel_entry[0] | replace: '_', '.' -%}
 <li><a href="#{{ releaseVersion }}">{{ releaseVersion }}</a></li>
 {%- endfor -%}
       </ul>
       </div>
     </div>
   </div>
   <div class="col-lg-6" role="main">
-{%- for relKey in versionsList -%}
-{%- assign releaseVersion=relKey | replace: '_', '.' -%}
+{% for rel_entry in sorted_releases %}
+{%- assign releaseVersion=rel_entry[0] | replace: '_', '.' -%}
 {%- assign release=site.data.release | map: relKey -%}
     <div class="card shadow mb-4">
       <div class="card-body mx-3 my-2">