jekyll-generator-single-source 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48cda7ea8aab0b172ac8a43d6e1f994d9dbf00cbba8489ad4d886d11c752675a
-  data.tar.gz: 1725101cef6faad0f034db3bb0c4f4feb427905f8bf1aac58510a279031ee997
+  metadata.gz: 6417de38be88c7bc196b618d92f9e1cd22ede431636f801d037ae8d9370d90b9
+  data.tar.gz: 1584dc91a34618375f740b22b68ee3e4f297bb0d004eb47a94076063f36ba5fc
 SHA512:
-  metadata.gz: dd24705318c18e46b31f632dff3577f94ec8e74a10c02895304df31d030ae67b70dd85d114101d24c908cbbe217c527bde70abf5d3f4706dc700f17f4eff68a6
-  data.tar.gz: 2a8aab8f8ca538c99287fcd936ef98f885a136da3a920f0f70bb608b6c06fd06fc5c6c70bd49be44125029f6248676176e5139c4a5db23e320ef0e84477905e0
+  metadata.gz: 117c7d2fe0b1edf16e19ecaf941e48cf215ce801d2acc5b7ebbf004a3b2a5a114d336f14d524f7d9c367b40db32415441fa5d79b66fa829851c8b34281cd7a9b
+  data.tar.gz: 68d4f7f238f240ba854a97c8861c2da3ba446da7bac0ee86f23b7e07c355bc8e3acf3f5a540bb3e9bb3b5fd41b56e4719eab640760ee02ad1622539ed0cabb5a

data/README.md

@@ -56,3 +56,108 @@ jekyll-generator-single-source:
   multiple_products: false
   base_dest_path: 'docs'
 ```
+
+### Inheriting configuration
+
+It is sometimes useful to inherit documentation from else where.
+
+To do this you can set in your config:
+
+```yaml
+inherit:
+  path: /.repos/_src/
+  nav: ../_src/.repos/_data/docs_nav_kuma_2.0.x.yml
+  patches: [] # Array of modifications on your existing nav applied sequentially
+```
+
+patches identify the section of the docs with an array `path` which lists the title in the doc tree.
+For example if I have a doc:
+
+```yaml
+items:
+  - title: foo
+    items:
+      - text: bar
+      - text: foo
+```
+I can use the path: `[foo, bar]` to modify this subsection of the docs.
+
+There are currently 4 types of patches:
+
+#### delete
+
+Here's a patch to delete that `bar` subsection of the docs.
+```yaml
+action: delete
+path: [foo]
+entries: [bar] # list of subsection to delete
+```
+
+The docs would look like:
+
+```yaml
+items:
+  - title: foo
+    items:
+      - text: foo
+```
+
+#### modify
+
+Here's a patch to modify the `foo` section by changing the title.
+```yaml
+action: modify
+path: [foo]
+title: foo2
+```
+
+The docs would look like:
+
+```yaml
+items:
+  - title: foo2
+    items:
+      - text: bar
+      - text: foo
+```
+
+### append
+
+Add a subsection to the doc
+```yaml
+action: append
+path: [foo]
+title: foo2
+```
+
+The docs would look like:
+
+```yaml
+items:
+  - title: foo
+    items:
+      - text: bar
+      - text: foo
+  - title: foo2
+```
+
+### insert
+
+Add a subsection to the doc
+```yaml
+action: insert
+path: [foo]
+index: 1 # where to insert the entry (if negative inserts from the end)
+text: foo2
+```
+
+The docs would look like:
+
+```yaml
+items:
+  - title: foo
+    items:
+      - text: bar
+      - text: foo2
+      - text: foo
+```

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

@@ -45,8 +45,12 @@ module Jekyll
         items.map(&:generate_pages)
       end
 
-      def nav
-        @nav ||= file_path
+      def config
+        @config ||= begin
+                      config = NavConfig::Base.process(@file_path)
+                      Jekyll.logger.debug("generated config: #{config.to_json}")
+                      config
+                    end
       end
 
       private
@@ -56,11 +60,6 @@ module Jekyll
           v['edition'] == product && v['release'] == release
         end
       end
-
-      def config
-        @config ||= SafeYAML.load(File.read(@file_path))
-      end
-
     end
   end
 end

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

@@ -17,7 +17,7 @@ module Jekyll
           end
         end
 
-        def_delegators :@top_level_config, :site, :nav, :product,
+        def_delegators :@top_level_config, :site, :config, :product,
                        :versions, :assume_generated?, :release
 
         def initialize(item_config, top_level_config)
@@ -71,11 +71,11 @@ module Jekyll
         end
 
         def source_path
-          raise NotImplementedError.new('implement this in subclass')
+          raise NotImplementedError.new("implement this in subclass #{self.class}")
         end
 
         def dest_path
-          raise NotImplementedError.new('implement this in subclass')
+          raise NotImplementedError.new("implement this in subclass #{self.class}")
         end
       end
     end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module NavConfig
+      class Base
+        def self.process(file_path)
+          new(file_path).process
+        end
+
+        def initialize(file_path)
+          @file_path = file_path
+        end
+
+        def process
+          if config.is_a?(Array)
+            config
+          else
+            HashConfig.new(file_path: @file_path, config: config).process
+          end
+        end
+
+        private
+
+        def config
+          @config = SafeYAML.load(File.read(@file_path))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module NavConfig
+      class HashConfig
+        REGEXP = /docs_nav_(?<product>.+)_(?<release>.+).ya?ml/
+
+        def initialize(file_path:, config:)
+          @file_path = file_path
+          @config = config
+        end
+
+        def process
+          @config['product'] = product
+          @config['release'] = release
+
+          inherit!
+          trim_config!
+
+          @config
+        end
+
+        private
+
+        def product
+          @product ||= @config.fetch('product') do |_|
+            REGEXP.match(File.basename(@file_path))[:product]
+          end
+        end
+
+        def release
+          @release ||= @config.fetch('release') do |_|
+            REGEXP.match(File.basename(@file_path))[:release]
+          end
+        end
+
+        def inherit?
+          @config.fetch('inherit', false)
+        end
+
+        def inherit!
+          return unless inherit?
+
+          InheritedConfig.new(
+            base_config: @config,
+            file_path: @file_path
+          ).inherit!
+        end
+
+        def trim_config!
+          if @config.key?('max_depth')
+            Trimmer.new(@config).trim!
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module NavConfig
+      class InheritedConfig
+        def initialize(base_config:, file_path:)
+          @base_config = base_config
+          @file_path = file_path
+        end
+
+        def inherit!
+          rewrite_paths!
+          rewrite_items!
+          apply_patches!
+
+          @base_config.delete('inherit')
+
+          @base_config
+        end
+
+        private
+
+        def inherited_nav
+          # Load the base config as a relative path to the current config
+          @inherited_nav ||= SafeYAML.load(
+            File.read(
+              File.join(File.dirname(@file_path), @base_config['inherit']['nav'])
+            )
+          )
+        end
+
+        def inherit_path
+          @inherit_path ||= @base_config['inherit']['path']
+        end
+
+        def rewrite_paths!
+          inherited_nav['items'].map do |entry|
+            PathRewriter.new(new_path: inherit_path, entry: entry).rewrite!
+          end
+        end
+
+        def rewrite_items!
+          @base_config['items'] = inherited_nav['items']
+        end
+
+        def apply_patches!
+          @base_config['inherit']['patches']&.each do |patch|
+            Patch.new(patch, @base_config).apply
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module NavConfig
+      class Patch
+        ACTIONS = ['append', 'delete', 'modify', 'insert'].freeze
+
+        def initialize(patch, items)
+          @path = patch.fetch('path', [])
+          @action = patch.fetch('action', 'append')
+          @idx = patch.fetch('index', nil)
+          @entries = patch.fetch('entries', nil)
+          @items = items
+
+          unless ACTIONS.include? @action
+            raise ArgumentError.new("action can only be #{ACTIONS.join(', ')} got `#{@action}` for patch #{patch.inspect}")
+          end
+
+          if @action == 'insert' && @idx == nil
+            raise ArgumentError.new("when using insert action you must set 'index' for patch #{patch.inspect}")
+          end
+
+          if @action == 'delete' && @entries == nil
+            raise ArgumentError.new("when using delete action you must set 'entries' for patch #{patch.inspect}")
+          end
+
+          raise ArgumentError.new("path must be an array for patch #{patch.inspect}") unless @path.is_a?(Array)
+
+          @patch = patch.except('action', 'path', 'index')
+        end
+
+        def apply
+          @path.each do |p|
+            all = @items.fetch('items', []).select do |i|
+              (i.fetch('title') {|_| i.fetch('text')}) == p
+            end
+            @items = all.fetch(0) { raise "Couldn't find docs section with title or text '#{p}' to apply delete patch #{self.inspect}" }
+          end
+
+          if @action == "delete"
+            @entries.each do |entry|
+              idx = @items['items'].index {|item| (item.fetch('title') {|_| item.fetch('text')}) == entry}
+              raise "Couldn't find docs section with title or text '#{entry}' to apply delete patch #{self.inspect}" unless idx != nil
+              @items['items'].delete_at(idx)
+            end
+          elsif @action == "modify"
+            @items.merge!(@patch)
+          elsif @action == "insert"
+            @items['items'].insert(@idx, @patch)
+          elsif @action == "append"
+            @items['items'].push(@patch)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module NavConfig
+      class PathRewriter
+        def initialize(new_path:, entry:)
+          @new_path = new_path
+          @entry = entry
+        end
+
+        def rewrite_rec(entry)
+          entry['items'].map do |v|
+            next if v['absolute_url']
+            if v.has_key?('src')
+              original = v['src']
+              v['src'] = File.join(@new_path, original)
+              Jekyll.logger.debug("rewrote #{original} to #{v['src']}")
+            elsif v.has_key?('url')
+              original = v['url']
+              parts = v['url'].split('#', 2)
+              v['src'] = File.join(@new_path, parts[0])
+              Jekyll.logger.debug("rewrote #{original} to #{v['src']}")
+            end
+            rewrite_rec(v) if v.has_key?('items')
+          end
+        end
+
+        def rewrite!
+            rewrite_rec(@entry)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    module NavConfig
+      class Trimmer
+        def initialize(config)
+          @config = config
+        end
+
+        def trim!
+          trim_depth(@config, max_depth)
+        end
+
+        private
+
+        def max_depth
+          @max_depth ||= @config.fetch('max_depth')
+        end
+
+        def trim_depth(entry, left)
+          if left == 0
+            entry.delete('items')
+          end
+          if entry['items']
+            entry['items'].each { |x| trim_depth(x, left - 1) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,6 +32,7 @@ module Jekyll
         @data['release'] = nav_item.release
         @data['version'] = nav_item.versions['default']
         @data['versions'] = nav_item.versions
+        @data['nav_items'] = nav_item.config
 
         # Set the layout if it's not already provided
         @data['layout'] ||= GeneratorConfig.new(@site).layout

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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GeneratorSingleSource
-    VERSION = '0.0.5'
+    VERSION = '0.0.6'
   end
 end

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

@@ -8,6 +8,12 @@ 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/nav_config/base'
+require_relative 'generator-single-source/nav_config/hash_config'
+require_relative 'generator-single-source/nav_config/inherited_config'
+require_relative 'generator-single-source/nav_config/patch'
+require_relative 'generator-single-source/nav_config/path_rewriter'
+require_relative 'generator-single-source/nav_config/trimmer'
 require_relative 'generator-single-source/generator_config'
 require_relative 'generator-single-source/generator'
 require_relative 'generator-single-source/single_source_page'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-generator-single-source
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -94,6 +94,12 @@ files:
 - 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/nav_config/base.rb
+- lib/jekyll/generator-single-source/nav_config/hash_config.rb
+- lib/jekyll/generator-single-source/nav_config/inherited_config.rb
+- 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/single_source_page.rb
 - lib/jekyll/generator-single-source/source/base.rb
 - lib/jekyll/generator-single-source/source/dir_source.rb