jekyll-html-pipeline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79b3b2da5b06f5577b46805ae5db216d0c0b68dd
+  data.tar.gz: 58961e54bff495fe738d057a8d7ba4e103473021
+SHA512:
+  metadata.gz: e75a188072a3f649dc68915d7d9e6102582ea0583076f0e5937c4b0c6e46226c3c5309c5630e0998b74cf34d848d2ea52b508dce319350128a030e99a23e7fe3
+  data.tar.gz: 731abf81870e6bf86d126587a628e8148a48e0d115e4be8a89634d50b9a2facee80a5ed4b50ef25e4c9e5f7a9d106e67496d07087fb22f23ac3790feec328892

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-html-pipeline.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Garen Torikian
+
+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,62 @@
+[![Build Status](https://travis-ci.org/gjtorikian/jekyll-html-pipeline.svg?branch=master)](https://travis-ci.org/gjtorikian/jekyll-html-pipeline)
+
+jekyll-html-pipeline
+====================
+
+An [HTML::Pipeline](https://github.com/jch/html-pipeline), for Jekyll.
+
+
+## Installation
+
+In your *_config.yml* file, add this gem:
+
+``` yaml
+gems:
+  - jekyll-html-pipeline
+```
+
+## Configuration
+
+You'll need to be running a Jekyll version after 2.0.0, which is when custom
+Markdown filters were introduced. In your *_config.yml* file, indicate that you
+want to use `html_pipeline`:
+
+``` yaml
+markdown: HTMLPipeline
+```
+
+Next, create an `html_pipeline` key, and indicate which filters you want to include:
+
+``` yaml
+markdown: HTMLPipeline
+html_pipeline:
+  filters:
+    - "markdownfilter"
+    - "sanitizationfilter"
+    - "emojifilter"
+    - "mentionfilter"
+```
+
+Finally, some filters require a context object. You can define these next:
+
+``` yaml
+markdown: HTMLPipeline
+html_pipeline:
+  filters:
+    - "markdownfilter"
+    - "sanitizationfilter"
+    - "emojifilter"
+    - "mentionfilter"
+  context:
+    asset_root: "http://foo.com/icons"
+    base_url:   "https://github.com/"
+```
+
+Keep in mind that [filter dependencies are not bundled](https://github.com/jch/html-pipeline#dependencies),
+so you'll need to add these in yourself.
+
+## Custom filters
+
+Custom filters can be designed [the same as in HTML::Pipeline](https://github.com/jch/html-pipeline#extending).
+
+Check out [the test filter](./test/support/new_pipeline.rb) for an example.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+task :default => [:test]
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/jekyll-html-pipeline.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-html-pipeline"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Garen Torikian"]
+  spec.email         = ["gjtorikian@gmail.com"]
+  spec.summary       = %q{Use GitHub's HTML::Pipeline, in Jekyll!}
+  spec.description   = %q{This is a custom Markdown processor for Jekyll 2.0 and above. It allows you to use GitHub's HTML::Pipeline in your Jekyll projects. }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll",    "~> 2.0.0.alpha.1 "
+  spec.add_dependency('html-pipeline', "~> 1.0.0")
+
+  spec.add_development_dependency "bundler", "~> 1.4"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('shoulda', "~> 3.5")
+  spec.add_development_dependency('github-markdown', "~> 0.6.3")
+  spec.add_development_dependency('sanitize', "~> 2.0.6")
+  spec.add_development_dependency('gemoji', "~> 1.5.0")
+  spec.add_development_dependency "rouge"
+end

data/lib/jekyll-html-pipeline.rb

@@ -0,0 +1,76 @@
+module Jekyll
+  module Converters
+    class Markdown::HTMLPipeline
+      def initialize(config)
+        require 'html/pipeline'
+        @config = config
+        @errors = []
+      end
+
+      def filter_key(s)
+        s.to_s.downcase.to_sym
+      end
+
+      def is_filter?(f)
+        f < HTML::Pipeline::Filter
+      rescue LoadError, ArgumentError
+        false
+      end
+
+      def symbolize_keys(hash)
+        hash.inject({}){|result, (key, value)|
+          new_key = case key
+                    when String then key.to_sym
+                    else key
+                    end
+          new_value = case value
+                      when Hash then symbolize_keys(value)
+                      else value
+                      end
+          result[new_key] = new_value
+          result
+        }
+      end
+
+      def ensure_default_opts
+        @config['html_pipeline']['filters'] ||= ['markdownfilter']
+        @config['html_pipeline']['context'] ||= {'gfm' => true}
+        # symbolize strings as keys, which is what HTML::Pipeline wants
+        @config['html_pipeline']['context'] = symbolize_keys(@config['html_pipeline']['context'])
+      end
+
+      def setup
+        unless @setup
+          ensure_default_opts
+
+          filters = @config['html_pipeline']['filters'].map do |f|
+            if is_filter?(f)
+              f
+            else
+              key = filter_key(f)
+              begin
+                filter = HTML::Pipeline.constants.find { |c| c.downcase == key }
+                # probably a custom filter
+                if filter.nil?
+                  Jekyll::Converters.const_get(f)
+                else
+                  HTML::Pipeline.const_get(filter)
+                end
+              rescue Exception => e
+                raise LoadError.new(e)
+              end
+            end
+          end
+
+          @parser = HTML::Pipeline.new(filters, @config['html_pipeline']['context'])
+          @setup = true
+        end
+      end
+
+      def convert(content)
+        setup
+        @parser.to_html(content)
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,48 @@
+require "rubygems"
+
+require "jekyll"
+require "liquid"
+
+require 'test/unit'
+require 'shoulda'
+
+require "html/pipeline"
+
+require "jekyll-html-pipeline"
+
+# Send STDERR into the void to suppress program output messages
+# STDERR.reopen(test(?e, '/dev/null') ? '/dev/null' : 'NUL:')
+
+class Test::Unit::TestCase
+  def dest_dir(*subdirs)
+    test_dir('dest', *subdirs)
+  end
+
+  def source_dir(*subdirs)
+    test_dir('source', *subdirs)
+  end
+
+  def clear_dest
+    FileUtils.rm_rf(dest_dir)
+  end
+
+  def test_dir(*subdirs)
+    File.join(File.dirname(__FILE__), *subdirs)
+  end
+
+  def directory_with_contents(path)
+    FileUtils.rm_rf(path)
+    FileUtils.mkdir(path)
+    File.open("#{path}/index.html", "w"){ |f| f.write("I was previously generated.") }
+  end
+
+  def capture_stdout
+    $old_stdout = $stdout
+    $stdout = StringIO.new
+    yield
+    $stdout.rewind
+    return $stdout.string
+  ensure
+    $stdout = $old_stdout
+  end
+end

data/test/support/new_pipeline.rb

@@ -0,0 +1,15 @@
+require "html/pipeline"
+
+class HelpMarkdownFilter < HTML::Pipeline::MarkdownFilter
+
+  def call
+    html = super
+
+    format_callout!(html)
+  end
+
+  def format_callout!(html)
+    html.gsub!(/(?:<p>)?{{#(tip|warning|error)}}(?:<\/p>)?/,  '<div class="alert \1">')
+    html.gsub!(/(?:<p>)?{{\/(tip|warning|error)}}(?:<\/p>)?/, '</div>')
+  end
+end

data/test/test_jekyll_html_pipeline.rb

@@ -0,0 +1,50 @@
+require "helper"
+
+class HTMLPipeline < Test::Unit::TestCase
+  context "html_pipeline" do
+    setup do
+      @config = {
+        'html_pipeline' => {
+          'filters' => ['markdownfilter', 'sanitizationfilter', 'emojifilter', 'mentionfilter'],
+          'context' => { 'asset_root' => "http://foo.com/icons", 'base_url' => "https://github.com/"}},
+        'markdown' => 'HTMLPipeline'
+      }
+      @markdown = Jekyll::Converters::Markdown.new @config
+    end
+
+    should "pass regular options" do
+      assert_equal "<h1>Some Header</h1>", @markdown.convert('# Some Header #').strip
+    end
+
+    should "pass rendering emoji" do
+      assert_equal "<p><img class=\"emoji\" title=\":trollface:\" alt=\":trollface:\" src=\"http://foo.com/icons/emoji/trollface.png\" height=\"20\" width=\"20\" align=\"absmiddle\"></p>", @markdown.convert(':trollface:').strip
+    end
+
+    should "pass rendering mentions" do
+      assert_equal "<p><strong>Hey, <a href=\"https://github.com/mojombo\" class=\"user-mention\">@mojombo</a></strong>!</p>", @markdown.convert('**Hey, @mojombo**!').strip
+    end
+
+    should "fail when a library dependency is not met" do
+      override = @config.dup
+      override['html_pipeline']['filters'] << 'AutolinkFilter'
+      markdown = Jekyll::Converters::Markdown.new override
+      assert_raise(LoadError) { markdown.convert('http://www.github.com') }
+    end
+
+    should "fail when a context dependency is not met" do
+      override = @config.dup
+      override['html_pipeline'].delete 'context'
+      markdown = Jekyll::Converters::Markdown.new override
+      assert_raise(ArgumentError) { markdown.convert(':trollface:') }
+    end
+
+    should "work for custom filters" do
+      require 'support/new_pipeline'
+      override = @config.dup
+      override['html_pipeline']['filters'] = ['HelpMarkdownFilter']
+      markdown = Jekyll::Converters::Markdown.new override
+      text = "\n {{#tip}}\n **Tip**: Wow! \n {{/tip}}"
+      assert_equal "<div class=\"alert tip\"><br>\n <strong>Tip</strong>: Wow! <br>\n </div>", markdown.convert(text)
+    end
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-html-pipeline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha.1
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rouge
+  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: 'This is a custom Markdown processor for Jekyll 2.0 and above. It allows
+  you to use GitHub''s HTML::Pipeline in your Jekyll projects. '
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-html-pipeline.gemspec
+- lib/jekyll-html-pipeline.rb
+- test/helper.rb
+- test/support/new_pipeline.rb
+- test/test_jekyll_html_pipeline.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Use GitHub's HTML::Pipeline, in Jekyll!
+test_files:
+- test/helper.rb
+- test/support/new_pipeline.rb
+- test/test_jekyll_html_pipeline.rb