jekyll-generator-single-source 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e651ab73d6f998179bce7f5e714cb65a3de3395c3cbbd0a2e6537c811f805198
-  data.tar.gz: d31ec800b3b67e11c4f6dd7c54b1ffb2b7aa0a962322e0fbbfaf136142a3eb83
+  metadata.gz: aaa7fc639637793b289f7e6aa4d3789bfabaa63c98fcd60ddfb646c4fe3bd7a3
+  data.tar.gz: d0a69a8d0b809d597af1d7136ab4ea61e2c1201b0be16217fb4669c035ef313f
 SHA512:
-  metadata.gz: 3c824783e55aa654214b2b12762fb6cddd07849c5fd8329336acadab5e95584f4faa26cee513f771efc7cda137203319f3d2ebb4c7f369b5c769ebbedeeb0a3f
-  data.tar.gz: 021f60ea8e4595e6ef4135f921eaa8758f3928005d37e09ec5d7cb38f2e25662ea09034e29c91c8b18985e2b7722f934938e9b6a0f2dd1fab5902958cbcbde12
+  metadata.gz: 5799ee54ea764e6486d6404a815b211dca85fbf37cf07a89c2215e3d622adab62dcb0330619dd21951d8bb47255702808a77709d81c3ed6632bbc74cf05ac27c
+  data.tar.gz: d9b2463ea71fdd0e59f3bdfcd59a58d15de35a98fda8e3767f48f634a8d3879f336a433339806dd872db23a1f58de58baa49ef4b294b9ceb3e041de9ebc0b9bf

data/README.md

@@ -11,13 +11,16 @@ end
 ```
 
 ## Usage
- 
+
+### Projects that have multiple products
 Add these lines to your site's `_config.yml`:
 
 ```yaml
 jekyll-generator-single-source:
   versions_file: '<path_to_versions_file>.yml'
   docs_nav_folder: '<path_to_folder_containing_doc_nav_files'
+  layout: 'docs-v2' # default value
+  multiple_products: true # default value
 ```
 
 The paths are relative to the site's  `source`.
@@ -28,4 +31,28 @@ Example configuration:
 jekyll-generator-single-source:
   versions_file: '_data/versions.yml'
   docs_nav_folder: '_data'
-```
+```
+
+### Projects with a single product
+
+Add these lines to your site's `_config.yml`:
+
+``` yaml
+jekyll-generator-single-source:
+  versions_file: '<path_to_versions_file>.yml'
+  docs_nav_folder: '<path_to_folder_containing_doc_nav_files'
+  layout: 'page'
+  multiple_products: false
+  base_dest_path: '<path_to_dest_folder_within_dist>'
+```
+
+Example configuration:
+
+``` yaml
+jekyll-generator-single-source:
+  versions_file: '_data/versions.yml'
+  docs_nav_folder: '_data'
+  layout: 'page'
+  multiple_products: false
+  base_dest_path: 'docs'
+```

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

@@ -62,6 +62,14 @@ module Jekyll
 
         private
 
+        def multiple_products?
+          GeneratorConfig.new(site).multiple_products?
+        end
+
+        def base_dest_path
+          GeneratorConfig.new(site).base_dest_path
+        end
+
         def source_path
           raise NotImplementedError.new('implement this in subclass')
         end

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

@@ -19,12 +19,20 @@ module Jekyll
           if src.start_with?('/')
             src
           else
-            [product, src].join('/')
+            if multiple_products?
+              [product, src].join('/')
+            else
+              src
+            end
           end
         end
 
         def dest_path
-          File.join(product, release, @item_config['url'], '/')
+          if multiple_products?
+            File.join(product, release, @item_config['url'], '/')
+          else
+            File.join(base_dest_path, release, @item_config['url'], '/')
+          end
         end
 
         def src

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

@@ -19,18 +19,34 @@ module Jekyll
         private
 
         def source_path
-          if product_page?
-            product
+          if multiple_products?
+            if product_page?
+              product
+            else
+              File.join(product, url.delete_prefix('/'))
+            end
           else
-            File.join(product, url.delete_prefix('/'))
+            if product_page?
+              'index'
+            else
+              File.join(url.delete_prefix('/'))
+            end
           end
         end
 
         def dest_path
-          if product_page?
-            File.join(product, release, '/')
+          if multiple_products?
+            if product_page?
+              File.join(product, release, '/')
+            else
+              File.join(product, release, url, '/')
+            end
           else
-            File.join(product, release, url, '/')
+            if product_page?
+              File.join(base_dest_path, release, '/')
+            else
+              File.join(base_dest_path, release, url, '/')
+            end
           end
         end
 

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

@@ -5,26 +5,12 @@ module Jekyll
     class Generator < Jekyll::Generator
       priority :highest
 
-      attr_reader :config, :versions
-
-      def initialize(config = {})
-        @config = config.fetch('jekyll-generator-single-source', {})
-      end
-
       def generate(site)
-        Dir.glob(File.join(docs_nav_folder(site), 'docs_nav_*.yml')).each do |f|
-          DocNavConfig.new(f, site, versions(site)).generate_pages
-        end
-      end
-
-      def docs_nav_folder(site)
-        File.expand_path(@config.fetch('docs_nav_folder'), site.source)
-      end
+        config = GeneratorConfig.new(site)
 
-      def versions(site)
-        @versions ||= SafeYAML.load(
-          File.read(File.expand_path @config.fetch('versions_file'), site.source)
-        )
+        Dir.glob(File.join(config.docs_nav_folder, 'docs_nav_*.yml')).each do |f|
+          DocNavConfig.new(f, site, config.versions).generate_pages
+        end
       end
     end
   end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    class GeneratorConfig
+      CONFIG_KEY = 'jekyll-generator-single-source'
+
+      attr_reader :site
+
+      def initialize(site)
+        @site = site
+      end
+
+      def versions
+        @versions ||= SafeYAML.load(File.read(
+          File.expand_path(versions_file, @site.source)
+        ))
+      end
+
+      def layout
+        config['layout'] || 'docs-v2'
+      end
+
+      def versions_file
+        config['versions_file']
+      end
+
+      def docs_nav_folder
+        File.expand_path(config.fetch('docs_nav_folder'), @site.source)
+      end
+
+      def multiple_products?
+        !!config.fetch('multiple_products', true)
+      end
+
+      def base_dest_path
+        config['base_dest_path']
+      end
+
+      private
+
+      def config
+        @config ||= @site.config.fetch(CONFIG_KEY, {})
+      end
+    end
+  end
+end

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

@@ -26,7 +26,6 @@ module Jekyll
         @data['edit_link'] = nav_item.source.file_path
 
         # Make it clear that this content comes from a generated file
-        @data['path'] = "GENERATED:nav=#{nav_item.nav}:src=#{nav_item.source.file_path}:#{@dir}"
         @data['is_dir_index'] = nav_item.source.dir?
 
         # Set the current release and concrete version
@@ -35,29 +34,33 @@ module Jekyll
         @data['versions'] = nav_item.versions
 
         # Set the layout if it's not already provided
-        @data['layout'] ||= 'docs-v2'
+        @data['layout'] ||= GeneratorConfig.new(@site).layout
 
+        # Apply any overrides
+        current = to_version(@data['release'])
+        @data['overrides']&.each do |key, entries|
+          entries.each do |value, conditions|
+            gte = conditions['gte'] ? to_version(conditions['gte']) : nil
+            lte = conditions['lte'] ? to_version(conditions['lte']) : nil
+            eq = conditions['eq'] ? to_version(conditions['eq']) : nil
 
-       # Apply any overrides
-       current = to_version(@data['release'])
-       @data['overrides']&.each do |key, entries|
-         entries.each do |value, conditions|
-           gte = conditions['gte'] ? to_version(conditions['gte']) : nil
-           lte = conditions['lte'] ? to_version(conditions['lte']) : nil
-           eq = conditions['eq'] ? to_version(conditions['eq']) : nil
+            if gte && lte
+              @data[key] = value if current >= gte && current <= lte
+            elsif gte
+              @data[key] = value if current >= gte
+            elsif lte
+              @data[key] = value if current <= lte
+            elsif eq
+              @data[key] = value if current == eq
+            end
+          end
+        end
 
-           if gte && lte
-             @data[key] = value if current >= gte && current <= lte
-           elsif gte
-             @data[key] = value if current >= gte
-           elsif lte
-             @data[key] = value if current <= lte
-           elsif eq
-             @data[key] = value if current == eq
-           end
-         end
-       end
-     end
+        # Needed so that regeneration works for single sourced pages
+        # It must be set to the source file
+        # Also, @path MUST NOT be set, it falls back to @relative_path
+        @relative_path = nav_item.source.file_path
+      end
 
      def to_version(input)
        Gem::Version.new(input.gsub(/\.x$/, '.0'))

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

@@ -4,7 +4,7 @@ module Jekyll
   module GeneratorSingleSource
     module Source
       class Base
-        PATH = 'src'
+        PATH = '_src'
 
         def self.make_for(path:, site:)
           # Normalize path
@@ -13,7 +13,7 @@ module Jekyll
             path.delete_prefix('/').delete_suffix('/')
           )
 
-          src_dir = File.expand_path('..', site.source)
+          src_dir = File.expand_path(site.source)
 
           # Read the source file, either `<src>.md or <src>/index.md`
           if File.exist?(File.join(src_dir, "#{file_path}.md"))

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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GeneratorSingleSource
-    VERSION = '0.0.2'
+    VERSION = '0.0.4'
   end
 end

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

@@ -8,6 +8,7 @@ require_relative 'generator-single-source/source/base'
 require_relative 'generator-single-source/source/dir_source'
 require_relative 'generator-single-source/source/file_source'
 require_relative 'generator-single-source/doc_nav_config'
+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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-generator-single-source
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Fabian Rodriguez
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
-description:
+description: 
 email:
 - fabian.rodriguez@konghq.com
 executables: []
@@ -91,6 +91,7 @@ files:
 - lib/jekyll/generator-single-source/doc_nav_item/without_src.rb
 - lib/jekyll/generator-single-source/doc_nav_item/without_src_and_url.rb
 - 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/tags/version_is.rb
 - lib/jekyll/generator-single-source/single_source_page.rb
@@ -103,7 +104,7 @@ homepage: https://github.com/kong/jekyll-generator-single-source
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -118,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to dynamically generate pages from a single source file
 test_files: []