jekyll-viewsource 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfe5b3a8492efe8b96f105d0fae4520e30a61c6d
+  data.tar.gz: d7706594cecfbcdce75868c3bba4fb05f9338aac
+SHA512:
+  metadata.gz: eeabd3bc6482ef6c6799f36a13b350a49e0fd035a872ac0523219ae18acf15bd50b0569b4315eecd3fed4b2915d29db608a2c47da783e33f0d0c2b808c7c3034
+  data.tar.gz: 6c5b099a1edf932c4157d5f5fc7e61349b3158c2b9467e3523178a2d8fbe5493697492790f4d90da5267cbe13f14c68184609800169a0b25015e23eb6b396861

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+Session.vim
+
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jekyll@ibrado.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll-viewsource.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,163 @@
+# Jekyll::ViewSource
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-viewsource.svg)](https://badge.fury.io/rb/jekyll-viewsource)
+
+*Jekyll:ViewSource* is a plugin for [Jekyll](https://jekyllrb.com/) that generates plain or pretty Markdown and HTML source code pages from your content.
+
+## Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  # other plugins here
+  gem 'jekyll-viewsource'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself:
+
+    $ gem install jekyll-viewsource
+
+## Configuration
+
+No configuration is required to run *Jekyll::ViewSource*. If you want to tweak its behavior, you may set the following options in `_config.yml`:
+
+```yaml
+viewsource:
+  #enabled: false                    # Default: true
+  debug: true                        # Show additional messages during run; default: false
+  #collection: pages, "articles"     # Which collections to paginate; default: pages and posts
+  collections:                       # Ditto, just a different way of writing it
+    - pages                          # Quotes are optional if collection names are obviously strings
+    - posts
+    - articles
+  options: pretty                    # Options that normally go in a doc's front matter
+```
+
+## Usage
+
+Just add a `viewsource: true` entry to the front-matter of the content for you want to create source files:
+
+### Plain Markdown
+
+```yaml
+---
+viewsource: true
+---
+```
+
+(or `viewsource: md` or `viewsource: markdown`)
+
+### Plain HTML
+
+```yaml
+viewsource: html
+```
+
+### Plain Markdown and HTML
+
+```yaml
+viewsource: markdown, html
+```
+
+### Prettified
+
+Add <code>pretty[="<rouge_template|css_path>"]</code>, e.g.
+
+```yaml
+viewsource: markdown, html, pretty
+```
+
+```yaml
+viewsource: markdown, html, pretty="thankful_eyes"
+```
+
+```yaml
+viewsource: markdown, html, pretty="/url/path/to/syntax.css"
+```
+
+You may show the themes currently supported by Rouge via the command line:
+
+    $ rougify help style
+
+As of this writing, these are:
+
+  * base16, base16.dark, base16.light
+  * base16.monokai, base16.monokai.dark, base16.monokai.light
+  * base16.solarized, base16.solarized.dark, base16.solarized.light
+  * colorful
+  * github
+  * gruvbox, gruvbox.dark, gruvbox.light
+  * igorpro
+  * molokai
+  * monokai, monokai.sublime
+  * thankful_eyes
+  * tulip
+
+The default is `github`
+
+### Source file links
+
+To link to your source files, use the following:
+
+`{{ page.source_url }}`
+: The plain or pretty Markdown source URL
+
+`{{ page.html_source_url }}`
+: The plain or pretty HTML source URL
+
+e.g. 
+
+```liquid
+[View Markdown source]({{ page.source_url }})
+[View HTML source]({{ page.html_source_url }})
+```
+
+### Demo
+
+[View Markdown source](https://ibrado.org/jvs.md-src.html)
+
+[View HTML source](https://ibrado.org/jvs/index.html-src.html)
+
+## Cache
+
+*ViewSource* maintains a cache in a hidden folder inside your site source: `.plugins/jekyll-viewsource`. If you encounter problems that you think may be related to the cache, you may remove this.
+
+## Contributing
+
+1. Fork this project: [https://github.com/ibrado/jekyll-viewsource/fork](https://github.com/ibrado/jekyll-viewsource/fork)
+1. Clone it (`git clone git://github.com/your_user_name/jekyll-viewsource.git`)
+1. `cd jekyll-viewsource`
+1. Create a new branch (e.g. `git checkout -b my-bug-fix`)
+1. Make your changes
+1. Commit your changes (`git commit -m "Bug fix"`)
+1. Build it (`gem build jekyll-viewsource.gemspec`)
+1. Install and test it (`gem install ./jekyll-viewsource-*.gem`)
+1. Repeat from step 5 as necessary
+1. Push the branch (`git push -u origin my-bug-fix`)
+1. Create a Pull Request, making sure to select the proper branch, e.g. `my-bug-fix` (via https://github.com/your_user_name/jekyll-viewsource)
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/ibrado/jekyll-viewsource](https://github.com/ibrado/jekyll-viewsource). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jekyll::ViewSource project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-viewsource/blob/master/CODE_OF_CONDUCT.md).
+
+## Also by the Author
+
+[Jekyll Stickyposts Plugin](https://github.com/ibrado/jekyll-stickyposts) - Move/pin posts tagged `sticky: true` before all others. Sorting on custom fields supported; collection and paginator friendly.
+
+[Jekyll Tweetsert Plugin](https://github.com/ibrado/jekyll-tweetsert) - Turn tweets into Jekyll posts. Multiple timelines, filters, hashtags, automatic category/tags, and more!
+
+[Jekyll::Paginate::Content](https://github.com/ibrado/jekyll-tweetsert) - Split your Jekyll pages, posts, etc. into multiple pages automatically. Single-page view, pager, SEO support, self-adjusting links, multipage-aware Table Of Contents.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/viewsource"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-viewsource.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll/viewsource/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-viewsource"
+  spec.version       = Jekyll::ViewSource::VERSION
+  spec.required_ruby_version = '>= 2.1.0'
+  spec.authors       = ["Alex Ibrado"]
+  spec.email         = ["alex@ibrado.org"]
+
+  spec.summary       = %q{View plain or pretty Markdown and/or HTML source code}
+  spec.description   = %q{This Jekyll plugin generates pretty or plain Markdown and/or HTML source code pages for your Markdown docs, which you can easily link to for viewing.}
+  spec.homepage      = "https://github.com/ibrado/jekyll-viewsource"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll", "~> 3.0"
+  spec.add_runtime_dependency "htmlbeautifier", "~> 1.3"
+  rouge_versions = ENV["ROUGE_VERSION"] ? ["~> #{ENV["ROUGE_VERSION"]}"] : [">= 1.7", "< 3"]
+  spec.add_runtime_dependency("rouge", *rouge_versions)
+  spec.add_development_dependency "bundler", "~> 2.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jekyll/viewsource.rb

@@ -0,0 +1,117 @@
+require 'jekyll/viewsource/constants'
+require 'jekyll/viewsource/cache'
+require 'jekyll/viewsource/renderer'
+
+module Jekyll
+  module ViewSource
+
+    def self.debug_state(debug)
+      @debug ||= debug
+    end
+
+    def self.warn(msg)
+      Jekyll.logger.warn VIEWSOURCE_LOG, msg
+    end
+
+    def self.debug(item, msg)
+      if @debug 
+        info = item ? 
+          (item.respond_to?(:path) ? File.basename(item.path) :
+            item)
+          : 'main'.freeze
+         
+        msg = "[#{info}] #{msg}"
+
+        Jekyll.logger.warn VIEWSOURCE_LOG, msg
+      end
+    end
+
+    def self.site(s = nil)
+      @site ||= s
+    end
+
+    class Generator < Jekyll::Generator
+      priority :low
+
+      def generate(site)
+        ViewSource.site(site)
+
+        config = site.config[VIEWSOURCE] || {}
+        return unless config["enabled"].nil? || config["enabled"]
+
+        config['options'] ||= ''
+
+        @debug = config["debug"]
+        ViewSource.debug_state @debug
+        Cache.setup(site, config['cache'].nil? || config['cache'])
+
+        config['collection'] = config['collection'].split(/,\s*/) if config['collection'].is_a?(String)
+
+        collections = [ config['collection'], config["collections"] ].flatten.compact.uniq
+
+        collections = [ "posts", "pages" ] if collections.empty?
+
+        collections.each do |collection|
+          if collection == "pages"
+            items = site.pages
+          else
+            next if !site.collections.has_key?(collection)
+            items = site.collections[collection].docs
+          end
+
+          process = items.select { |item| item.data[VIEWSOURCE]}
+
+          process.each do |item|
+            vs_opts = item.data[VIEWSOURCE].to_s + ' ' + config['options']
+
+            if m = /pretty\s*=?\s*(['"](.*?)['"]|)/.match(vs_opts)
+              pretty = m[2] || DEFAULT_CSS
+            end
+
+            if m = /linkback\s*=?\s*(['"](.*?)['"]|)/.match(vs_opts)
+              linkback = m[2] || 'Back'
+            end
+
+            view_md = (vs_opts =~ /\b(md|markdown)\b/i)
+            view_pr = (vs_opts =~ /\b(prerender)\b/i)
+            view_html = (vs_opts =~ /\bhtml\b/i)
+
+            view_md ||= !view_html
+
+            suffix = (pretty ? INFIXED_HTML : INFIXED_TXT)
+
+            # Enqueue for post site render
+            if view_md || view_pr
+              dest_folder = Pathname(item.url).dirname
+              dest_folder = '' if dest_folder.to_s == '/'
+              filename = File.basename(item.path)
+              item.data[MD_FILE_PROP] = "#{dest_folder}/#{filename}"
+              if view_md
+                item.data[MD_SOURCE_URL] = item.data[MD_FILE_PROP] + suffix
+              end
+
+              if view_pr
+                item.data[PR_SOURCE_URL] = item.data[MD_FILE_PROP] + suffix
+              end
+            end
+
+            if view_html
+              item.data[HTML_FILE_PROP] = "#{item.destination('')}".sub!(site.dest, '')
+              item.data[HTML_SOURCE_URL] = item.data[HTML_FILE_PROP] + suffix
+            end
+
+            item.data[PRETTY_PROP] = pretty
+            item.data[LINKBACK_PROP] = "#{item.url}|$|#{linkback}" if linkback
+            if view_md || view_html
+              Renderer.enqueue(item)
+            elsif view_pr
+              Renderer.enqueue(item, PR)
+            end
+
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/jekyll/viewsource/cache.rb

@@ -0,0 +1,67 @@
+require 'jekyll/viewsource/renderer'
+
+module Jekyll
+  module ViewSource
+
+    class Cache
+      DEFAULT_CACHE = ".plugins/jekyll-viewsource/cache".freeze
+
+      def self.setup(site, cache)
+        @site = site
+
+        if cache
+          @cache_dir = File.join(@site.source,
+            (cache.is_a?(String) ? cache : DEFAULT_CACHE))
+
+          ViewSource.debug 'startup', "Setting up cache at #{@cache_dir}" if Renderer.first_run
+
+          FileUtils.mkdir_p File.join(@cache_dir)
+        end
+      end
+
+      def self.location(uri, dest)
+        return if !@cache_dir
+
+        subdir = Digest::SHA256.hexdigest(uri)
+
+        filename = File.basename(dest)
+        #filepath = Pathname(uri).dirname
+
+        #File.join(cache_path, subdir, filepath, filename)
+        File.join(@cache_dir, subdir, filename)
+      end
+
+      def self.contents(uri, dest, content = nil)
+        filepath = self.location(uri, dest)
+        return if !filepath
+
+        if content
+          FileUtils.mkdir_p Pathname(filepath).dirname
+          File.write(filepath, content)
+        else
+          if File.exist?(filepath)
+            content = File.read filepath
+          end
+        end
+
+        content
+      end
+
+      def self.modified?(source, dest, expiry = nil)
+        cache_path = self.location(source, dest)
+        if source =~ %r[://]
+          mod = Utils.modified?(nil, cache_path, expiry)
+        else
+          mod = Utils.modified?(source, cache_path, expiry)
+        end
+        mod
+      end
+
+      def self.valid?(source, dest, expiry = nil)
+        ! self.modified?(source, dest, expiry)
+      end
+
+    end
+
+  end
+end

data/lib/jekyll/viewsource/constants.rb

@@ -0,0 +1,32 @@
+module Jekyll
+  module ViewSource
+
+    VIEWSOURCE = 'viewsource'.freeze
+    VIEWSOURCE_LOG = 'ViewSource:'.freeze
+
+    HTML = 'html'.freeze
+    TXT = 'txt'.freeze
+    MARKDOWN = 'markdown'.freeze
+    MD = 'md'.freeze
+
+    PR = 'pr'.freeze
+
+    INFIX = '-src'.freeze
+    INFIXED_HTML = "#{INFIX}.#{HTML}".freeze
+    INFIXED_TXT = "#{INFIX}.#{TXT}".freeze
+
+    MD_SOURCE_URL = 'source_url'.freeze
+    PR_SOURCE_URL = 'prerender_source_url'.freeze
+    HTML_SOURCE_URL = 'html_source_url'.freeze
+
+    MD_FILE_PROP = "#{VIEWSOURCE}_file_md".freeze
+    HTML_FILE_PROP = "#{VIEWSOURCE}_file_html".freeze
+
+    PRETTY_PROP = "#{VIEWSOURCE}_pretty".freeze
+    LINKBACK_PROP = "#{VIEWSOURCE}_linkback".freeze
+
+    DEFAULT_CSS = 'github'.freeze
+    CSS_SCOPE = '.highlight'.freeze
+
+  end
+end

data/lib/jekyll/viewsource/lexer.rb

@@ -0,0 +1,32 @@
+require 'rouge'
+
+module Rouge
+  module Lexers
+    class ViewSource < Markdown
+      tag 'viewsource'
+
+      def liquid
+        @liquid ||= Liquid.new(options)
+      end
+
+      def javascript
+        @javascript ||= Javascript.new(options)
+      end
+
+      def html
+        @html ||= HTML.new(options)
+      end
+
+      prepend :root do
+        rule(%r[\s*(?<!:)//.*?$]) { delegate javascript }
+        rule(%r(\s*/[*].*?[*]/\s*)m) { delegate javascript }
+
+        rule(%r(.*?%}.?)) { delegate liquid }
+        rule(%r(.*{{.*?}}.?)) { delegate liquid }
+
+        rule(%r(\s*<!--.*?-->\s*)m) { delegate html }
+      end
+
+    end
+  end
+end

data/lib/jekyll/viewsource/renderer.rb

@@ -0,0 +1,165 @@
+require 'htmlbeautifier'
+
+module Jekyll
+  module ViewSource
+
+    module Renderer
+      require_relative 'constants'
+      require_relative 'utils'
+      require_relative 'lexer'
+
+      # We have to run this after the site is written
+      # i.e. the HTML files exist
+      Jekyll::Hooks.register :site, :post_write do |site|
+        render_items(site)
+      end
+
+      @render_queue  = []
+      @first_run = true
+
+      PRETTY = 'Pretty'.freeze
+      PLAIN = 'Plain'.freeze
+
+      DEFAULT_BG = '#808080'.freeze
+
+      CACHED = ' (cached)'.freeze
+
+      def self.first_run
+        @first_run
+      end
+
+      def self.enqueue(item)
+        @render_queue << item
+      end
+
+      def self.render_items(site)
+        @render_queue.each do |item|
+          pretty = item.data.delete(PRETTY_PROP)
+          linkback = item.data.delete(LINKBACK_PROP)
+
+          if md_file = item.data.delete(MD_FILE_PROP)
+            render_source(site, item, md_file, MD, pretty, linkback)
+          end
+
+          if html_file = item.data.delete(HTML_FILE_PROP)
+            render_source(site, item, html_file, HTML, pretty, linkback)
+          end
+
+          if @first_run
+            ViewSource.debug item, "Set CSS to #{pretty}" if pretty
+            ViewSource.debug item, "Set linkback text to #{linkback}" if linkback
+          end
+        end
+
+        @render_queue.clear
+        @first_run = false
+      end
+
+      def self.render_source(site, item, file_url, ext, pretty = nil, linkback = nil)
+        return unless file_url
+
+        source_link = file_url +
+          ( pretty ? INFIXED_HTML : INFIXED_TXT)
+
+        dest_file = File.join(site.dest, source_link)
+        source_md = Utils.source_file(item)
+
+        source_file = (ext == MD ? source_md :
+          File.join(site.dest, file_url))
+
+        if Cache.modified?(source_md, dest_file)
+          FileUtils.mkdir_p Pathname(dest_file).dirname
+
+          if pretty
+            File.write(dest_file, prettify(source_file, ext, pretty, linkback))
+          else
+            if ext == MD
+              FileUtils.cp source_file, dest_file
+            else
+              # Prettify it as text a bit, anyway
+              source_code = HtmlBeautifier.beautify File.read(source_file)
+              File.write(dest_file, source_code)
+            end
+          end
+
+          Cache.contents(source_md, dest_file, File.read(dest_file))
+
+        else
+          cached = CACHED
+          File.write(dest_file, Cache.contents(source_md, dest_file))
+        end
+
+        if @first_run || !cached
+          ViewSource.debug item, (pretty ? PRETTY : PLAIN) +
+            " #{ext}: #{source_link}#{cached}"
+       end
+
+      end
+
+      def self.prettify(source_file, type, user_css, linkback = nil)
+        source_code = File.read(source_file)
+        title = File.basename(source_file)
+
+        if type == HTML
+          source_code = HtmlBeautifier.beautify source_code
+        end
+
+        formatter = Rouge::Formatters::HTML.new
+        if type == MD
+          lexer = Rouge::Lexers::ViewSource.new
+        else
+          lexer = Rouge::Lexers::HTML.new
+        end
+
+        formatted = formatter.format(lexer.lex(source_code))
+
+        body = "<pre>#{formatted}</pre>"
+
+        if user_css
+          if user_css =~ /^\//
+            source_css = File.join(site.dest, user_css)
+            css = File.read(source_css) if File.exist?(source_css)
+          else
+            unless theme = Rouge::Theme.find(user_css)
+              theme = Rouge::Theme.find(DEFAULT_CSS)
+            end
+            css = theme.render(scope: CSS_SCOPE)
+          end
+        end
+
+        if m = css.match(/^\.highlight {.*?background-color:\s*(.*?);/m)
+          body_bg = m[1];
+        else
+          body_bg = DEFAULT_BG
+        end
+
+        if linkback
+          (lb_url, lb_text) = linkback.split('|$|', 2)
+          linkback = %Q(<div style="background-color: #fff; color: #000; padding: 5px;" class="viewsource-linkback">&laquo; <a href=").freeze + %Q(#{lb_url}">#{lb_text}) + '</a></div>'.freeze
+
+        end
+
+        # TODO: External template file
+        <<-HTML
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>#{title}</title>
+    <style>
+    #{css}
+    </style>
+  </head>
+  <body style="background-color: #{body_bg};" class="viewsource-body">
+   <div class="highlight">
+#{body}
+#{linkback}
+   </div>
+  </body>
+</html>
+HTML
+
+      end
+
+    end
+  end
+end

data/lib/jekyll/viewsource/utils.rb

@@ -0,0 +1,28 @@
+require 'net/http'
+
+module Jekyll
+  module ViewSource
+
+   module Utils
+      @touched = {}
+      @cache = {}
+
+      CACHE_EXPIRY = 600 # seconds
+
+      def self.source_file(item)
+        source_prefix = item.is_a?(Jekyll::Page) ? ViewSource.site.source : ''
+        File.join(source_prefix, item.path)
+      end
+
+      def self.modified?(source, dest, expiry = nil)
+        dest && !dest.empty? &&
+          (!File.exist?(dest) ||
+            (source && (File.mtime(source) > File.mtime(dest))) ||
+            (expiry && ((File.mtime(dest) + expiry) <= Time.now ))
+          )
+      end
+
+    end
+  end
+end
+

data/lib/jekyll/viewsource/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module ViewSource
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-viewsource
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Ibrado
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This Jekyll plugin generates pretty or plain Markdown and/or HTML source
+  code pages for your Markdown docs, which you can easily link to for viewing.
+email:
+- alex@ibrado.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-viewsource.gemspec
+- lib/jekyll/viewsource.rb
+- lib/jekyll/viewsource/cache.rb
+- lib/jekyll/viewsource/constants.rb
+- lib/jekyll/viewsource/lexer.rb
+- lib/jekyll/viewsource/renderer.rb
+- lib/jekyll/viewsource/utils.rb
+- lib/jekyll/viewsource/version.rb
+homepage: https://github.com/ibrado/jekyll-viewsource
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: View plain or pretty Markdown and/or HTML source code
+test_files: []