jekyll-page_extensions 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a7c866746d558839676fce8db20307e9f6dbd2a
+  data.tar.gz: de7d42fe3008537c499a68670c427600ea3ccc4d
+SHA512:
+  metadata.gz: 825b90f1d6f7cb9a8f3f51098b35aa7b90c7e6573f2ad9b2704f8c4aeb2a5b7e4d1eb1f9d20a1417661000feef1a93be4ec035fcd6d76a50e3804c3a58b15905
+  data.tar.gz: 4a26f05232f9b1250bb3e6883c49c7b50565736c7ef7f9eac2a30e1d4c76573c476dce343bede68f500a41880eff95d68b5d91c05da48b33cf8f4ba1868134c1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Ulf Möhring
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Jekyll Page Extensions
+
+Adds various functionalities to pages in Jekyll:
+* Automatically generates print versions of pages
+* Provides table of contents tag (containing links to child pages): {% toc %}
+* Provides breadcrumbs tag: {% breadcrumbs %}
+* Provides Rails-style link to helper: {% link_to "My Page Title" %}
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jekyll-page_extensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-page_extensions
+
+## TODO
+
+* Avoid file not found warnings when generating print pages
+
+## Contributing
+
+1. Fork it ( https://github.com/paceline/jekyll-page_extensions/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/jekyll-page_extensions.rb

@@ -0,0 +1,228 @@
+# encoding: utf-8
+
+require 'active_support/core_ext/array'
+
+module Jekyll
+
+    # Instantiates sitemap to automatically update sitemap file when site generation is triggered
+    #
+    #
+    class SitemapGenerator < Jekyll::Generator
+      safe true
+      priority :highest
+
+      def generate(site)
+        s = Sitemap.new(site)
+        s.update
+      end
+    end
+
+    # Automatically creates printable one page versions for all pages with children
+    #
+    #
+    class PritablePageGenerator < Jekyll::Generator
+      safe true
+      priority :high
+
+      def generate(site)
+        sitemap = Sitemap.new(site)
+        for page in site.pages
+          page.print(sitemap) unless page.printable?
+        end
+      end
+    end
+
+    # Inserts an automatically generated table of contents based on the site's directory structure
+    #
+    # Syntax {% toc %}
+    #
+    #
+    class TocTag < Liquid::Tag
+
+      # Render table of contents for children
+      def render(context)
+        site = context.registers[:site]
+        sitemap = Sitemap.new(site)
+        page = site.find_page(path: context['page']['path'])
+        page.toc(sitemap)
+      end
+
+    end
+
+    # Provides tag for inserting breadcumbs-sytle navigation path
+    #
+    # Syntax {% breadcrumbs %}
+    #
+    # Will render a breadcrumbs-sytle navigation path
+    #
+    #
+    class BreadcrumbsTag < Liquid::Tag
+
+      # Convert title to url parameter and return link tag, supplementing page path if needed
+      def render(context)
+        site = context.registers[:site]
+        sitemap = Sitemap.new(site)
+        html = ["<a href=\"/\">Home</a>"]
+        for path in sitemap.branch_up(context['page']['path'])
+          page = site.find_page(path: path)
+          html << "<a href=\"#{page.pretty_url}\">#{page.data['title']}</a>"
+        end
+        html.join(" > ")
+      end
+
+    end
+
+    # Creates link to page when given the title
+    #
+    # Syntax {% link_to "My Page Title" %}
+    #
+    # Example:
+    # {% link_to "Meine Wörter" %}
+    #
+    # This will render <a href="/meine-worter">Meine Wörter</a>
+    #
+    #
+    class LinkTag < Liquid::Tag
+
+      # Read title from tag
+      def initialize(tag_name, text, tokens)
+        super
+        @text = text.strip.gsub(/["']/, "")
+      end
+
+      # Convert title to url parameter and return link tag, supplementing page path if needed
+      def render(context)
+        site = context.registers[:site]
+        page = site.find_page(title: @text)
+        page ? "<a href=\"#{page.pretty_url}\">#{@text}</a>" : ""
+      end
+
+    end
+
+    # Reads and updates sitemap (as tree-style hash)
+    #
+    #
+    class Sitemap
+      # Return tree
+      attr_reader :tree
+
+      # Initialize with site data
+      def initialize(site)
+        @file = File.join(site.source, "_sitemap.yml")
+        @sources = site.pages.reject { |page| page.printable? }.collect { |page| page.path.split(File::SEPARATOR) }
+        @tree = File.exists?(@file) ? YAML::load_file(@file) : {}
+      end
+
+      # Return sub paths
+      def branch_down(path)
+        dirs = path.split(File::SEPARATOR)
+        keys = dirs.size <= 1 ? "" : "['#{dirs[0..dirs.size-2].join("']['")}']"
+        eval("@tree#{keys}")
+      end
+
+      # Return parent paths
+      def branch_up(path)
+        dirs = path.split(File::SEPARATOR)
+        ancestors = []
+        if dirs.size > 1
+          ancestors << path
+          (dirs.size-3).downto(0) do |i|
+            eval("@tree['#{dirs[0..i].join("']['")}']").each_value do |v|
+              ancestors << v if v.is_a?(String)
+            end
+          end
+        end
+        return ancestors.reverse
+      end
+
+      # Iterate through source directory and arrange folders/files in tree struture
+      def update(i = 0)
+        @new_tree = {} unless @new_tree
+        cur = @sources.collect { |f| f[0..i] if f.size > i }.uniq.compact.sort
+        for dir in cur
+          val = dir.last =~ /\..*$/ ? "'#{dir.join(File::SEPARATOR)}'" : {}
+          eval("@new_tree['#{dir.join("']['")}'] = #{val}")
+        end
+        update(i+1) unless cur.empty?
+        File.open(@file, 'w') { |f| f.write @new_tree.to_yaml } unless @new_tree == @tree
+      end
+    end
+
+    # Extend Jekyll Site class
+    #
+    #
+    class Site
+
+      # Load page by attribute
+      def find_page(*args)
+        options = args.extract_options!
+        attribute = options.keys.first
+        self.pages.detect { |page| eval("page.#{Page.method_defined?(attribute) ? attribute : "data['#{attribute}']"}") == options[attribute] }
+      end
+
+    end
+
+    # Extend Jekyll Page class
+    #
+    #
+    class Page
+
+      # Wrapper for pretty permalinks
+      def pretty_url
+        self.url.gsub(/\/index\..*$/,"")
+      end
+
+      # Helper to filter out auto-generated print views
+      def printable?
+        self.url =~ /print\.[a-zA-Z0-9]*$/
+      end
+
+      # Compile one-pager fit for printing, including all sub-pages
+      def print(sitemap)
+        branch = sitemap.branch_down(self.path)
+        page = Page.new(self.site, self.site.source, self.pretty_url, "print#{self.ext}")
+
+        html = "---
+layout: print
+title: #{self.data['title']}
+---
+#{self.content}"
+        html = self.build_html_tree(branch, true, html)
+
+        modified = !File.exists?(page.path) || File.read(page.path) != html
+        if modified
+          open(page.path, 'w') { |f| f << html }
+          self.site.pages << page
+        end
+      end
+
+      # Render table of contents based on children
+      def toc(sitemap)
+        branch = sitemap.branch_down(self.path)
+        self.build_html_tree(branch)
+      end
+
+      # Generate html for table of contents
+      def build_html_tree(branch, content = false, html = "", level = 0)
+        index = branch.select { |k,v| v.is_a?(String) }
+        unless index.empty?
+          page = self.site.find_page(path: branch[index.keys.first])
+          if content
+            html += page.content.gsub(/{{\s*page.title\s*}}/, page.data['title']) unless html.include?(page.content)
+          else
+            html += "<h#{level+1}><a href=\"#{page.pretty_url}\">#{page.data['title']}</a></h#{level+1}>\n"
+          end
+          html += "\n"
+        end
+        branch.each_pair do |k,v|
+          html = build_html_tree(v, content, html, level+1) unless v.is_a?(String)
+        end
+        return html
+      end
+
+    end
+end
+
+Liquid::Template.register_tag('toc', Jekyll::TocTag)
+Liquid::Template.register_tag('breadcrumbs', Jekyll::BreadcrumbsTag)
+Liquid::Template.register_tag('link_to', Jekyll::LinkTag)

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-page_extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ulf Möhring
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: A plugin for Jekyll that extends the capabilities of the page class
+email: ulf@moehring.me
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/jekyll-page_extensions.rb
+homepage: https://github.com/paceline/jekyll-page-extensions
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Page extensions for Jekyll
+test_files: []