Generates a page per version.

Signed-off-by: Sam Barker <[email protected]>

Author: SamBarker

Gemfile.lock

@@ -58,8 +58,6 @@ GEM
       jekyll (>= 3.0.0)
     jekyll-feed (0.17.0)
       jekyll (>= 3.7, < 5.0)
-    jekyll-redirect-from (0.16.0)
-      jekyll (>= 3.3, < 5.0)
     jekyll-sass-converter (3.1.0)
       sass-embedded (~> 1.75)
     jekyll-seo-tag (2.8.0)
@@ -98,6 +96,7 @@ GEM
       google-protobuf (~> 4.31)
     sass-embedded (1.89.2-x86_64-linux-gnu)
       google-protobuf (~> 4.31)
+    semver-string (1.0.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     unicode-display_width (2.6.0)
@@ -112,10 +111,10 @@ DEPENDENCIES
   jekyll (~> 4.4.1)
   jekyll-asciidoc (~> 3.0.1)
   jekyll-feed (~> 0.12)
-  jekyll-redirect-from
   jekyll-sass-converter (~> 3.1.0)
   jekyll-seo-tag (~> 2.8.0)
   jekyll-toc (~> 0.19.0)
+  semver-string (~> 1)
 
 BUNDLED WITH
    2.4.22

_data/redirects/errors.yaml

@@ -6,6 +6,7 @@ mappings:
 
 - name: test
   fromVersion: 0.10.0
+  toVersion: 0.12.0
   path: /html/kroxylicious-proxy/#con-configuring-client-connections-proxy
 
 

_plugins/redirector.rb

@@ -4,48 +4,131 @@ class RedirectPageGenerator < Jekyll::Generator
 
     def generate(site)
       config = site.data['redirects']
-      config.each { |redirectConfig|
-        Jekyll.logger.info "generating redoirects for #{redirectConfig[0]}"
-        redirectConfig[1]['mappings'].each do |mapping|
-          Jekyll.logger.info "generating redoirect for #{redirectConfig[0]}/#{mapping['name']}"
-          site.pages << RedirectPage.new(site, redirectConfig[0], redirectConfig[1], mapping)
+      latest_release = Version.parse(site.data['kroxylicious']['latestRelease'])
+      releases = known_releases(site)
+      config.each { |redirect_config|
+        Jekyll.logger.info "generating redirects for #{redirect_config[0]}"
+        redirect_config[1]['mappings'].each do |mapping|
+          to_version = Version.parse(mapping['toVersion'] ||= latest_release)
+          from_version = Version.parse(mapping['fromVersion'] ||= latest_release)
+          versions = releases.select { |rel| rel.between?(from_version, to_version) }
+          versions.each { |version|
+            mapping['version'] = version
+            site.pages << RedirectPage.new(site, redirect_config[0], redirect_config[1], mapping)
+          }
         end
-        Jekyll.logger.info "loaded redirect pages #{redirectConfig[0]}"
+        Jekyll.logger.info "Generated redirects #{redirect_config[0]}"
       }
-    Jekyll.logger.info "finished generating redirects"
+    end
+
+    private
+
+    def known_releases(site)
+      releases = []
+      site.data['release'].sort.each do |release|
+        releases << Version.parse(release[0])
+      end
+      releases.sort_by { |version| [version.major, version.minor, version.patch] }
     end
   end
 
   # Subclass of `Jekyll::Page` with custom method definitions.
   class RedirectPage < Jekyll::Page
     def initialize(site, group, redirectConfig, mapping)
 
-        @site = site             # the current site instance.
-        @base = site.source      # path to the source directory.
-        @dir  = "/redirect/#{group}/"         # the directory the page will reside in.
+      @site = site # the current site instance.
+      @base = site.source # path to the source directory.
+      @dir = "/redirect/#{group}/#{mapping['version']}/" # the directory the page will reside in.
 
-          # All pages have the same filename, so define attributes straight away.
-        @basename = mapping['name']      # filename without the extension.
-        @ext      = '.html'      # the extension.
-        @name     = basename + ext # basically @basename + @ext.
-        @layout  = 'redirect.html'
+      # All pages have the same filename, so define attributes straight away.
+      @basename = mapping['name'] # filename without the extension.
+      @ext = '.html' # the extension.
+      @name = basename + ext # basically @basename + @ext.
+      @layout = 'redirect.html'
 
-        @data = {
-          'target' => redirectConfig['baseUrl'] + mapping['fromVersion'] + mapping['path'],
-          'layout' => 'redirect'
-        }
+      @data = {
+        'target' => "#{redirectConfig['baseUrl']}#{mapping['version']}#{mapping['path']}",
+        'layout' => 'redirect'
+      }
 
-        Jekyll.logger.info "generated redirect page #{@dir}#{@basename}"
+      Jekyll.logger.info "generated redirect from #{@dir}#{@basename} to #{data['target']}"
     end
 
     # Placeholders that are used in constructing page URL.
     def url_placeholders
       {
-        :path       => @dir,
-        :category   => @dir,
-        :basename   => basename,
+        :path => @dir,
+        :category => @dir,
+        :basename => basename,
         :output_ext => output_ext,
       }
     end
   end
+
+  class Version
+    include Comparable
+
+    # @return [Integer]
+    attr_reader :major
+
+    # @return [Integer]
+    attr_reader :minor
+
+    # @return [Integer]
+    attr_reader :patch
+
+    def self.parse(version_string)
+      if version_string.is_a? Version
+        return version_string
+      end
+      if version_string.include? '_'
+        parts = version_string.split('_').map { |x| x.to_i }
+      elsif version_string.include? '.'
+        parts = version_string.split('.').map { |x| x.to_i }
+      else
+        raise "Invalid version string: #{version_string}"
+      end
+      instance = allocate
+      instance.send(:initialize, parts[0], parts[1], parts[2])
+      instance
+    end
+
+    # @param [Integer] major
+    # @param [Integer] minor
+    # @param [Integer] patch
+    def initialize(
+      major,
+      minor,
+      patch
+    )
+      @major = major.to_i
+      @minor = minor.to_i
+      @patch = patch.to_i
+    end
+
+    # @return [String]
+    def to_s
+      "#{major}.#{minor}.#{patch}"
+    end
+
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    # See section #11 of https://semver.org/spec/v2.0.0.html
+    # @return [Integer, nil] Returns -1, 0, or 1. or Nil if other is unsortable
+    def <=>(other)
+      if other.is_a? Version
+        [major, minor, patch] <=> [other.major, other.minor, other.patch]
+      else
+        nil
+      end
+    end
+
+    def between?(min, max)
+      if (min.is_a? Version) && (max.is_a? Version)
+        self >= min && self <= max
+      end
+    end
+  end
 end