jekyll-generator-single-source 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4432d20f3c39addbf05d93c175274b04da965693eb385c60cd4362bebb834d3f
-  data.tar.gz: 97900b313fd897bed71496e3bff3a947b2b9f37a51ce7c5c1c23b9f602f72260
+  metadata.gz: 253e5fa9d7d9bb93a522582300e462ed95aacf538537b75f366227b746324d55
+  data.tar.gz: cab91867c2467dbc009b072d331f17e36485e72e3d37ba43e516051dc9a7936e
 SHA512:
-  metadata.gz: 0ff9f45d193014933d26ea182248239c2de7d432f7163b53bba3aee571a7c74582dec00c4ada25acd77511be5cb2a6875424644cd81b53127e0f12b187d824b9
-  data.tar.gz: 15d2fbb89259724b40ff5876f876b9937df75f85f04b76ed6804e18fd8d7e2ba7bdaa50b131183acadc3330224d75e66e51aab1d3d9a7d48a8949efd33f16a45
+  metadata.gz: c39a9d017eef7e7f15e13cf8b1d0e96e63afcfa10252d4fa1ca4a99adfb6f6e719eda55f90769839a5511e28be3fb9d6dcfc42247f7788ee23a649b7a6e2d0ee
+  data.tar.gz: a447aadeb5a01e7d09331ee0668f449c9e6c4b316e0d9a420dd4560cf375147c532764e2d6eb037a953886b9ce3d772dddbc365f16ffaedbb52e4d04a0ac24bb

data/lib/jekyll/generator-single-source/doc_nav_config.rb

@@ -5,14 +5,15 @@ module Jekyll
     class DocNavConfig
       attr_reader :file_path, :site
 
-      def initialize(file_path, site, versions_from_file)
+      def initialize(file_path, site)
         @file_path = file_path
         @site      = site
-        @versions_from_file  = versions_from_file
       end
 
       def skip_generation?
-        !(config.is_a?(Hash) && config['generate'])
+        # skip if release is not available because it
+        # was skipped using an ENV variable
+        !(config.is_a?(Hash) && config['generate']) || release.nil?
       end
 
       def assume_generated?
@@ -31,11 +32,13 @@ module Jekyll
       end
 
       def release
-        @release ||= config['release']
+        @release ||= edition.releases.detect do |r|
+          r.value == config['release']
+        end
       end
 
       def versions
-        @versions ||= Versions.extract(version)
+        @versions ||= release.versions
       end
 
       def generate_pages
@@ -54,10 +57,8 @@ module Jekyll
 
       private
 
-      def version
-        @version ||= @versions_from_file.detect do |v|
-          v['edition'] == product && v['release'] == release
-        end
+      def edition
+        @edition ||= Product::Edition.new(edition: product, site:)
       end
     end
   end

data/lib/jekyll/generator-single-source/doc_nav_item/src.rb

@@ -28,7 +28,9 @@ module Jekyll
         end
 
         def dest_path
-          if multiple_products?
+          if @item_config['absolute_url']
+            File.join(@item_config['url'], '/')
+          elsif multiple_products?
             File.join(product, release, @item_config['url'], '/')
           else
             File.join(base_dest_path, release, @item_config['url'], '/')

data/lib/jekyll/generator-single-source/doc_nav_item/without_src.rb

@@ -51,7 +51,9 @@ module Jekyll
         end
 
         def product_page?
-          url == "/#{product}/" || url == "/#{product}/#{release}/"
+          url == "/#{product}/" ||
+            url == "/#{product}/#{release}/" ||
+              url == "/#{product}/#{release.value}/"
         end
       end
     end

data/lib/jekyll/generator-single-source/generator.rb

@@ -9,7 +9,7 @@ module Jekyll
         config = GeneratorConfig.new(site)
 
         Dir.glob(File.join(config.docs_nav_folder, 'docs_nav_*.yml')).each do |f|
-          DocNavConfig.new(f, site, config.versions).generate_pages
+          DocNavConfig.new(f, site).generate_pages
         end
       end
     end

data/lib/jekyll/generator-single-source/generator_config.rb

@@ -11,10 +11,10 @@ module Jekyll
         @site = site
       end
 
-      def versions
-        @versions ||= SafeYAML.load(File.read(
+      def editions
+        @editions ||= SafeYAML.load(File.read(
           File.expand_path(versions_file, @site.source)
-        ))
+        )).group_by { |e| e['edition'] }
       end
 
       def layout

data/lib/jekyll/generator-single-source/liquid/drops/release.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module Liquid
+      module Drops
+        class Release < ::Liquid::Drop
+          extend Forwardable
+
+          attr_reader :release
+
+          def initialize(release)
+            @release = release
+          end
+
+          def_delegators :@release, :value, :label, :latest?, :to_s, :to_str, :versions
+
+          def hash
+            @hash ||= "#{@release.edition}-#{@release.value}".hash
+          end
+
+          def ==(other)
+            return @release.value == other if other.is_a?(String)
+
+            @release.to_h == other.release.to_h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/generator-single-source/liquid/tags/version_is.rb

@@ -18,34 +18,24 @@ module Jekyll
           def render(context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
             page = context.environments.first['page']
 
-            current_version = to_version(page['kong_version'] || page['version'])
+            current_version = to_version(page['release'].value)
 
             # If there's an exact match, check only that
             if @params.key?(:eq)
               version = to_version(@params[:eq])
-              if Gem::Version.correct?(current_version)
-                return '' unless current_version == version
-              else
-                return '' unless version > to_version(page['latest_released_version'])
-              end
+              return '' unless current_version == version
             end
 
             # If there's a greater than or equal to check, fail if it's lower
             if @params.key?(:gte)
               version = to_version(@params[:gte])
-              if Gem::Version.correct?(current_version)
-                return '' unless current_version >= version
-              end
+              return '' unless current_version >= version
             end
 
             # If there's a less than or equal to heck, fail if it's higher
             if @params.key?(:lte)
               version = to_version(@params[:lte])
-              if Gem::Version.correct?(current_version)
-                return '' unless current_version <= version
-              else
-                return '' unless version > to_version(page['latest_released_version'])
-              end
+              return '' unless current_version <= version
             end
 
             # Don't evaluate the liquid block unconditionally,
@@ -72,11 +62,7 @@ module Jekyll
           end
 
           def to_version(input)
-            if Gem::Version.correct?(input)
-              Gem::Version.new(input.gsub(/\.x$/, '.0'))
-            else
-              input
-            end
+            Gem::Version.new(input.to_s.gsub(/\.x$/, '.0'))
           end
         end
       end

data/lib/jekyll/generator-single-source/product/edition.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module Product
+      class Edition
+
+        def self.all(site:)
+          GeneratorConfig.new(site).editions
+        end
+
+        def initialize(edition:, site:)
+          @edition = edition
+          @site = site
+        end
+
+        def releases
+          @releases ||= releases_data
+            .map { |r| Product::Release.new(r) }
+            .reject do |r|
+              r.label && ENV["SKIP_#{name.upcase.gsub('-','_')}_#{r.label.upcase}"]
+            end
+        end
+
+        def latest_release
+          @latest_release ||= releases.detect(&:latest?)
+        end
+
+        def name
+          @name ||= @edition
+        end
+
+        private
+
+        def releases_data
+          @releases_data ||= self.class.all(site: @site).fetch(@edition, [])
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/generator-single-source/product/release.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module Product
+      class Release
+        attr_reader :release_hash
+
+        def initialize(release_hash)
+          @release_hash = release_hash
+
+          validate!
+        end
+
+        def edition
+          @edition ||= @release_hash.fetch('edition')
+        end
+
+        def value
+          @value ||= @release_hash['release']
+        end
+
+        def latest?
+          @release_hash['latest']
+        end
+
+        def label
+          @label ||= @release_hash['label']
+        end
+
+        def versions
+          @versions ||= begin
+                          if @release_hash.has_key?('version')
+                            { 'default' => @release_hash['version'] }
+                          else
+                            versions_without_suffix
+                          end
+                        end
+        end
+
+        def default_version
+          @default_version ||= versions['default']
+        end
+
+        def to_str
+          if @release_hash.key?('label')
+            label
+          else
+            value
+          end
+        end
+        alias :to_s :to_str
+
+        def to_semver
+          value.gsub('-x', '.x').gsub(/\.x/, '.0')
+        end
+
+        def to_liquid
+          Liquid::Drops::Release.new(self)
+        end
+
+        def to_h
+          @release_hash
+        end
+
+        private
+
+        def validate!
+          if @release_hash.has_key?('version') &&
+              @release_hash.keys.any? { |k| k.end_with?('-version') }
+            raise SyntaxError.new(
+              "Invalid config. `version` and `*-version` present in #{@release_hash}."
+            )
+          end
+        end
+
+        def versions_without_suffix
+          @versions_without_suffix ||= @release_hash.each_with_object({}) do |(k, v), h|
+            if k.end_with?('-version')
+              h[k.sub('-version', '')] = v
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/generator-single-source/single_source_page.rb

@@ -29,16 +29,19 @@ module Jekyll
         @data['is_dir_index'] = nav_item.source.dir?
 
         # Set the current release and concrete version
-        @data['release'] = nav_item.release
-        @data['version'] = nav_item.versions['default']
-        @data['versions'] = nav_item.versions
+        release = nav_item.release
+        @data['release'] = Liquid::Drops::Release.new(release)
+        @data['edition'] = release.edition
+        @data['version'] = release.default_version
+        @data['versions'] = release.versions
+
         @data['nav_items'] = nav_item.config
 
         # Set the layout if it's not already provided
         @data['layout'] ||= GeneratorConfig.new(@site).layout
 
         # Apply any overrides
-        current = to_version(@data['release'])
+        current = to_version(release.value)
         @data['overrides']&.each do |key, entries|
           entries.each do |value, conditions|
             gte = conditions['gte'] ? to_version(conditions['gte']) : nil
@@ -63,12 +66,8 @@ module Jekyll
         @relative_path = nav_item.source.file_path
       end
 
-     def to_version(input)
-       if Gem::Version.correct?(input)
-         Gem::Version.new(input.gsub(/\.x$/, '.0'))
-       else
-         input
-       end
+      def to_version(input)
+        Gem::Version.new(input.to_s.gsub(/\.x$/, '.0'))
       end
     end
   end

data/lib/jekyll/generator-single-source/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GeneratorSingleSource
-    VERSION = '0.0.9'
+    VERSION = '0.0.11'
   end
 end

data/lib/jekyll/generator-single-source.rb

@@ -18,4 +18,6 @@ require_relative 'generator-single-source/generator_config'
 require_relative 'generator-single-source/generator'
 require_relative 'generator-single-source/single_source_page'
 require_relative 'generator-single-source/version'
-require_relative 'generator-single-source/versions'
+require_relative 'generator-single-source/product/release'
+require_relative 'generator-single-source/product/edition'
+require_relative 'generator-single-source/liquid/drops/release'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-generator-single-source
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -93,6 +93,7 @@ files:
 - lib/jekyll/generator-single-source/generator.rb
 - lib/jekyll/generator-single-source/generator_config.rb
 - lib/jekyll/generator-single-source/hooks/version_is.rb
+- lib/jekyll/generator-single-source/liquid/drops/release.rb
 - lib/jekyll/generator-single-source/liquid/tags/version_is.rb
 - lib/jekyll/generator-single-source/nav_config/base.rb
 - lib/jekyll/generator-single-source/nav_config/hash_config.rb
@@ -100,12 +101,13 @@ files:
 - lib/jekyll/generator-single-source/nav_config/patch.rb
 - lib/jekyll/generator-single-source/nav_config/path_rewriter.rb
 - lib/jekyll/generator-single-source/nav_config/trimmer.rb
+- lib/jekyll/generator-single-source/product/edition.rb
+- lib/jekyll/generator-single-source/product/release.rb
 - lib/jekyll/generator-single-source/single_source_page.rb
 - lib/jekyll/generator-single-source/source/base.rb
 - lib/jekyll/generator-single-source/source/dir_source.rb
 - lib/jekyll/generator-single-source/source/file_source.rb
 - lib/jekyll/generator-single-source/version.rb
-- lib/jekyll/generator-single-source/versions.rb
 homepage: https://github.com/kong/jekyll-generator-single-source
 licenses:
 - Apache-2.0
@@ -118,14 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A Jekyll plugin to dynamically generate pages from a single source file

data/lib/jekyll/generator-single-source/versions.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module GeneratorSingleSource
-    class Versions
-      def self.extract(version_hash)
-        new(version_hash).versions
-      end
-
-      def initialize(version)
-        @version = version
-
-        validate!
-      end
-
-      def versions
-        if @version.has_key?('version')
-           { 'default' => @version['version'] }
-        else
-          versions_without_suffix
-        end
-      end
-
-      private
-
-      def validate!
-        if @version.has_key?('version') &&
-            @version.keys.any? { |k| k.end_with?('-version') }
-          raise SyntaxError.new(
-            "Invalid config. `version` and `*-version` present in #{@version}."
-          )
-        end
-      end
-
-      def versions_without_suffix
-        @versions_without_suffix ||= @version.each_with_object({}) do |(k, v), h|
-          if k.end_with?('-version')
-            h[k.sub('-version', '')] = v
-          end
-        end
-      end
-    end
-  end
-end