jekyll-site-tree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2ccb902abceef0ee4301c9294bdcf6b5f74d3a4dc2007ff5540aa56bd0702bf
+  data.tar.gz: cd6548e901ca669f9b0a476033c8bef354702bb9d017e9e80f3c89ad882fe612
+SHA512:
+  metadata.gz: ecb13b35782ce2aa96a91e9afcef6c7ece0118811eeac6f79d27fee3815616588ac34ecc9ff0c17d890e264c67b83525490e10e4006671db30378356f148926f
+  data.tar.gz: 0f2dba3b28b7fbb5fc01bee25a26465a7e8bce1d67a2aad6fbec854ca9455707e5cbe10aae0824b3909e0312fc199588e9f02533f0351ab45839d946b8026af2

data/lib/jekyll-site-tree.rb

@@ -0,0 +1,153 @@
+require 'jekyll'
+require 'natural_sort'
+
+module Jekyll
+    class SiteTreeGenerator < Jekyll::Generator
+        def generate(site)
+            @site = site
+
+            unless site_tree_file
+                Jekyll.logger.warn("SiteTree:", "skipped because no 'site-tree' file specified in config")
+                return
+            end
+
+            page = @site.pages.find { |page| page.dir.slice(1, page.dir.length) + page.name == site_tree_file }
+
+            if page.nil?
+                Jekyll.logger.error("SiteTree:", "unable to find 'site-tree' file: " + site_tree_file)
+                return
+            end
+
+            Jekyll.logger.info("SiteTree:", "building site tree")
+            # page.data['site_tree_permalinks'] = permalinks
+            page.data['site_tree']            = site_tree
+        end
+
+        def permalinks
+            pages  = @site.pages
+            pages += @site.static_files
+            pages += @site.collections.map do |tuple|
+                name, collection = tuple
+                (collection.write?) ? collection.docs : []
+            end.flatten
+
+            pages.map { |pg| pg.url }.select do |page|
+                !excludes.any? { |rx| rx.match? page }
+            end.uniq.sort(&NaturalSort)
+        end
+
+        private
+
+        def config
+            @site.config["site_tree"] || Hash.new
+        end
+
+        def site_tree_file
+            config["file"]
+        end
+
+        def include_extension?
+            !!config["extension"]
+        end
+
+        def excludes
+            if @excludes.nil?
+                @excludes = (config["exclude"] || []).map do |exclude|
+                    # if exclude begins with a slash, the expression references
+                    # an absolute path, otherwise any match is considered valid
+                    Regexp.new(exclude[0] == '/' ? '^' + exclude : exclude)
+                end
+            end
+            @excludes
+        end
+
+        def substitutions
+            if @substitutions.nil?
+                @substitutions = (config["substitute"] || []).each do |subs|
+                    subs["expr"] = Regexp.new(subs["expr"])
+                end
+            end
+            @substitutions
+        end
+
+        def permalink_tuples
+            subs = substitutions
+
+            permalinks.map do |link|
+                sub = subs.find { |sub| sub["expr"].match?(link) }
+                new = (sub.nil?) ? link : link.gsub(sub["expr"], sub["name"])
+
+                unless include_extension?
+                    new = File.join(File.dirname(new), File.basename(new, '.*'))
+                end
+
+                { :path => new, :link => link }
+            end
+        end
+
+        # kind of an ugly solution, nests each path in the sites permalinks
+        # into a series of hashes (each hash connects to the next hash) which
+        # constructs a sort of tree. The path & link for the current entry is
+        # found through the :path & :link fields.
+        def permalink_tree
+            tree = Hash.new
+
+            permalink_tuples.each do |tuple|
+                branch = tree
+                branch_path = tuple[:path].split('/')
+
+                branch_path.slice(1, branch_path.length-2).each do |path|
+                    branch = (branch[path] ||= Hash.new)
+                end
+
+                branch[branch_path.last] = tuple
+            end
+
+            tree
+        end
+
+        # converts a permalink_tree into an XML structure
+        def site_tree
+            def recursive_construct_tree(name, tree)
+                result = '<li>'
+
+                current_path = tree.delete(:path)
+                current_link = tree.delete(:link)
+
+                if current_path
+                    result += "<a href=\"%s\">%s</a>" % [
+                        current_link, name].map { |s| html_coder.encode(s) }
+                end
+
+                unless tree.empty?
+                    if tree.length == 1 && !current_path then
+                        child_name = tree.keys[0]
+
+                        return recursive_construct_tree(
+                            name + '/' + child_name, tree[child_name])
+                    else
+                        result += html_coder.encode(name) if !current_path
+
+                        result += '<ul>'
+                        tree.each do |name, subtree|
+                            result += recursive_construct_tree(name, subtree)
+                        end
+                        result += '</ul>'
+                    end
+                end
+
+                result += '</li>'
+            end
+
+            result = '<ul>'
+            permalink_tree.each do |name, tree|
+                result += recursive_construct_tree(name, tree)
+            end
+            result += '</ul>'
+        end
+
+        def html_coder
+            @@html_coder ||= HTMLEntities.new
+        end
+    end
+end

data/lib/utils/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+    module SiteTree
+        VERSION = "0.0.1"
+    end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-site-tree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mohkale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: natural_sort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  A jekyll generator which creates a site-tree consisting of all the files in the output (built) path of a jekyll website.
+
+  For a site with a structure like:
+    - /foo.md
+    - /bar.html
+    - /posts/2019/15/10/hello-world.md
+    - /posts/2019/15/10/lo-and-behold.md
+    - /assets/styles/main.scss
+
+  You'll recieve an XML unordered list like:
+    - foo
+    - bar
+    - posts/2019/15/10
+      - hello-world
+      - lo-and-behold
+    - assets/styles
+      - main
+email: mohkalsin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-site-tree.rb
+- lib/utils/version.rb
+homepage: 
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: create a site tree from a jekyll page
+test_files: []