jekyll-generator-single-source 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d35a6631597a818b3c93d374f7550943ef3d3df2ee06cfbf18ca9cfbf4f694c
-  data.tar.gz: 1f7d48363f58103e6f014ecd685adc435d5f29b6caa0640917eb6fa8b539971f
+  metadata.gz: 5b4f9fdea43b8497d0e68de02c6180367cd80914fd39b01d376f3f3de18034a5
+  data.tar.gz: 47a20d4176618f8ab1fb176d84e08257bc219acd66feb937f6fbeb4174216812
 SHA512:
-  metadata.gz: b5702e971c9711190b1bf9f3338838f5b0f636528bb535590d2935acbe82ccd0fdc7a74403ffa1c581e4728db75f0bce642506f93c8dcad3d148a0a82af3df04
-  data.tar.gz: 4775af4aa98b4729ccde3d21677237ec202ae8fe954de6ee00bb7ff620dcd48388ea46481e216406391e0a5fb4dc8e823ed6b126285b55e51fd2be1176e2ab8a
+  metadata.gz: 11ef1d9c947cd3446fb3057d2ee29dba6540c09a302943a9c8c66384e444762d8f751693d7314abc6cefcb61c683ed4d1d105b4a13efd99d6c06d16d02cb48d4
+  data.tar.gz: 2fc4d5d3fda4efa776ef7228ba81d909a83112f3dd5e74b6c34fd53da8d203594bfb8752ed9e872d9942338886cda82c8b6889a737491e2dc024fb6ee4e22919

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/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/hooks/version_is.rb

@@ -3,9 +3,18 @@
 Jekyll::Hooks.register :pages, :pre_render do |page|
   # Replace double line breaks when using if_version when
   # combined with <pre> blocks. This is usually in code samples
-  page.content = page.content.gsub(/\n(\s*{% if_version)/, '\1')
-  page.content = page.content.gsub("{% endif_version %}\n\n", "{% endif_version %}\n")
+  # TODO: comment this for now, I need to double-check if we need it
+  # page.content = page.content.gsub(/\n(\s*{% if_version)/, '\1')
+  # page.content = page.content.gsub("{% endif_version %}\n\n", "{% endif_version %}\n")
 
   # Also allow for a newline after endif_version when in a table
-  page.content = page.content.gsub("{% endif_version %}\n|", '{% endif_version %}|')
+  # strip extra new lines
+  page.content = page.content.gsub(/\|\s*\n\n\s*{% if_version /, "|\n{% if_version ")
+  page.content = page.content.gsub(/\|\s*\n{% endif_version %}\n+\|/, "|\n{% endif_version -%}\n\|")
+  page.content = page.content.gsub(/\|\s*\n{% endif_version %}\n+\s*{% if_version (.*) %}\n/) do |_match|
+    "|\n{% endif_version -%}\n{% if_version #{$1} -%}\n"
+  end
+  page.content = page.content.gsub(/\|\s*\n+{% if_version (.*) %}\n/) do |_match|
+    "|\n{% if_version #{$1} -%}\n"
+  end
 end

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

@@ -5,83 +5,126 @@ module Jekyll
     module Liquid
       module Tags
         class VersionIs < ::Liquid::Block
-          def initialize(tag_name, markup, tokens)
-            @tag = markup
+          attr_reader :blocks
 
-            @params = {}
-            markup.scan(::Liquid::TagAttributes) do |key, value|
-              @params[key.to_sym] = value
-            end
+          def initialize(tag_name, markup, options)
             super
+            @blocks = []
+            push_block('if_version'.freeze, markup)
           end
 
-          def render(context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-            page = context.environments.first['page']
+          def nodelist
+            @blocks.map(&:attachment)
+          end
 
-            current_version = to_version(page['kong_version'] || page['version'])
+          def parse(tokens)
+            while parse_body(@blocks.last.attachment, tokens)
+            end
+          end
 
-            # 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
+          def unknown_tag(tag, markup, tokens)
+            if 'else'.freeze == tag
+              push_block(tag, markup)
+            else
+              super
             end
+          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
+          def render(context)
+            context.stack do
+              @blocks.each do |block|
+                if block.evaluate(context)
+                  return block.attachment.render(context)
+                end
               end
+              ''.freeze
             end
+          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
+          private
+
+          def push_block(tag, markup)
+            block = if tag == 'else'.freeze
+                      ::Liquid::ElseCondition.new
+                    else
+                      parse_with_selected_parser(markup)
+                    end
+
+            @blocks.push(block)
+            block.attach(::Liquid::BlockBody.new)
+          end
+
+          def lax_parse(markup)
+            parse_condition(markup)
+          end
+
+          def strict_parse(markup)
+            parse_condition(markup)
+          end
+
+          def parse_condition(markup)
+            IfVersionCondition.new(markup)
+          end
+
+          class IfVersionCondition < ::Liquid::Condition
+            # Extracted from:
+            # https://github.com/Shopify/liquid/blob/ae3057e94b7c4d657e6bc02e1d50398e34cc6ed7/lib/liquid.rb#L37
+            # and modified to support comma-separated values
+            TAG_ATTRIBUTES = /(\w+)\s*\:\s*((?-mix:(?-mix:"[^"]*"|'[^']*')|(?:[^\s\|'"]|(?-mix:"[^"]*"|'[^']*'))+))/o
+
+            def else?
+              false
             end
 
-            # Don't evaluate the liquid block unconditionally,
-            # only evaluate it if the version matches
-            contents = super
+            def evaluate(context)
+              params = {}
+              @left.scan(TAG_ATTRIBUTES) do |key, value|
+                params[key.to_sym] = value
+              end
 
-            # Table rows (starts newline then |, ends with | then newline) need
-            # special handline
-            is_table_row = /^\n\s*\|/.match(contents) && /\|\s*\n$/.match(contents)
+              page = context.environments.first['page']
 
-            # Remove the leading whitespace and return
-            # We can't use .strip as that removes all leading whitespace,
-            # including indentation
-            contents = contents.sub(/^\n/, '')
+              current_version = to_version(page['release'].value)
 
-            # Remove the trailing whitespace
-            # But ONLY if it's not a table row
-            contents = contents.sub(/\n$/, '') unless is_table_row
+              if params.key? :eq
+                # If there's an exact match, check only that
+                versions = params[:eq].split(',').map { |v| to_version(v) }
+                return false unless versions.any? { |v| v == current_version }
+              end
+              if params.key? :gte
+                # If there's a greater than or equal to check, fail if it's lower
+                version = to_version(params[:gte])
+                return false unless current_version >= version
+              end
+              if params.key? :lte
+                # If there's a less than or equal to check, fail if it's higher
+                version = to_version(params[:lte])
+                return false unless current_version <= version
+              end
+              if params.key? :neq
+                # If there's a not-equal to check, fail if they are equal
+                version = to_version(params[:neq])
+                return false if current_version == version
+              end
 
-            # If it's not a table row, put the \n that we removed in pre_render back
-            contents = "\n#{contents}\n" unless is_table_row || @params[:inline]
+              true
+            end
 
-            contents
+            def to_version(input)
+              Gem::Version.new(input.to_s.gsub(/\.x$/, '.0'))
+            end
           end
 
-          def to_version(input)
-            if Gem::Version.correct?(input)
-              Gem::Version.new(input.gsub(/\.x$/, '.0'))
-            else
-              input
+          class ParseTreeVisitor < ::Liquid::ParseTreeVisitor
+            def children
+              @node.blocks
             end
           end
         end
+
       end
     end
   end
 end
 
-Liquid::Template.register_tag('if_version', Jekyll::GeneratorSingleSource::Liquid::Tags::VersionIs)
+::Liquid::Template.register_tag('if_version'.freeze, Jekyll::GeneratorSingleSource::Liquid::Tags::VersionIs)

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.10'
+    VERSION = '0.0.12'
   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.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2024-04-15 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