nanoc-html-pipeline 0.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+.ruby-version
+.rbenv-version
+.DS_Store
+.rvmrc
+*.gem
+pkg

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    nanoc-html-pipeline (0.2.0)
+      html-pipeline (>= 1.0.0)
+      nanoc (>= 3.1.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    colored (1.2)
+    cri (2.4.0)
+      colored (>= 1.2)
+    gemoji (1.5.0)
+    github-markdown (0.6.3)
+    html-pipeline (1.1.0)
+      activesupport (>= 2)
+      nokogiri (~> 1.4)
+    i18n (0.6.5)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    nanoc (3.6.6)
+      cri (~> 2.3)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    rinku (1.7.3)
+    sanitize (2.0.6)
+      nokogiri (>= 1.4.4)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gemoji (~> 1.5.0)
+  github-markdown (~> 0.6.3)
+  nanoc-html-pipeline!
+  rinku (~> 1.7.3)
+  sanitize (~> 2.0.6)

data/README.md

@@ -0,0 +1,36 @@
+HTML::Pipeline for Nanoc
+========================
+
+An [HTML::Pipeline](https://github.com/jch/html-pipeline) filter for [Nanoc](http://nanoc.stoneship.org/).
+
+Status
+------
+
+Still under development.
+
+Installation
+------------
+
+HTML::Pipeline requires ICU.
+
+```bash
+brew install icu4c
+bundle config build.charlock_holmes --with-icu-dir=/usr/local/opt/icu4c
+```
+
+In the near future, you'll be able to add this your Gemfile:
+
+```ruby
+gem 'nanoc-html-pipeline'
+```
+
+Usage
+-----
+
+In your nanoc Rules file, use an `:html_pipeline` filter to run content through a pipeline.
+
+```ruby
+filter :html_pipeline, 
+  :pipeline => [:mardownfilter, :emojifilter, :syntaxhighlightfilter], 
+  :asset_root => "http://your-domain.com/where/your/emoji/live"
+```

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+$LOAD_PATH.unshift 'lib'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/nanoc-html-pipeline/filter.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'nanoc3'
+require 'html/pipeline'
+
+module NanocHtmlPipeline
+  class Filter < Nanoc::Filter
+
+    def self.filter_key(s)
+      s.to_s.downcase.to_sym
+    end
+
+    def self.is_filter(f)
+      f < HTML::Pipeline::Filter
+    rescue LoadError, ArgumentError
+      false
+    end
+
+    # Runs the content through [HTML::Pipline](https://github.com/jch/html-pipeline).
+    # Takes a `:pipeline` option as well as any additional context options.
+
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      # Get options
+      options = {:pipeline => []}.merge(params)
+
+      filters = options.delete(:pipeline).map do |f|
+        if self.class.is_filter(f)
+          f
+        else
+          key = self.class.filter_key(f)
+          filter = HTML::Pipeline.constants.find { |c| c.downcase == key }
+          HTML::Pipeline.const_get(filter)
+        end
+      end
+
+      HTML::Pipeline.new(filters, options).to_html(content)
+    end
+  end
+
+end
+
+Nanoc::Filter.register 'NanocHtmlPipeline::Filter', :html_pipeline

data/lib/nanoc-html-pipeline/version.rb

@@ -0,0 +1,4 @@
+
+module NanocHtmlPipeline
+  VERSION = '0.2.0'
+end

data/lib/nanoc-html-pipeline.rb

@@ -0,0 +1,2 @@
+require 'nanoc-html-pipeline/version'
+require 'nanoc-html-pipeline/filter'

data/nanoc-html-pipeline.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "nanoc-html-pipeline/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nanoc-html-pipeline"
+  s.version     = NanocHtmlPipeline::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brent Fitzgerlad"]
+  s.email       = ["b@brentfitzgerald.com"]
+  s.summary     = "nanoc filter for html-pipeline"
+  s.description = ""
+
+  s.rubyforge_project = "nanoc-html-pipeline"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency('nanoc', '>= 3.1.6')
+  s.add_runtime_dependency('html-pipeline', '>= 1.0.0')
+
+  s.add_development_dependency('rinku', '~> 1.7.3')
+  s.add_development_dependency('github-markdown', '~> 0.6.3')
+  s.add_development_dependency('gemoji', '~> 1.5.0')
+  s.add_development_dependency('sanitize', '~> 2.0.6')
+end

data/test/nanoc_html_pipeline_test.rb

@@ -0,0 +1,52 @@
+require 'bundler/setup'
+require 'test/unit'
+require 'active_support/core_ext/object/try'
+require "nanoc-html-pipeline"
+
+URL = "http://www.ruby-lang.org/"
+CONTEXT = {
+  :asset_root => "http://foo.com/icons",
+  :base_url   => "http://foo.com"
+}
+
+class NanocHtmlPipelineTest < Test::Unit::TestCase
+
+  def test_single_filter
+    input = "<p>a link is #{URL}</p>"
+    assert_equal HTML::Pipeline::AutolinkFilter.to_html(input),
+      NanocHtmlPipeline::Filter.new.run(input, :pipeline => [:autolinkfilter])
+  end
+
+  def test_filter_class
+    input = "<p>a link is #{URL}</p>"
+    assert_equal NanocHtmlPipeline::Filter.new.run(input, :pipeline => [HTML::Pipeline::AutolinkFilter]),
+      NanocHtmlPipeline::Filter.new.run(input, :pipeline => [:autolinkfilter])
+  end
+
+  def test_params
+    asset_root = "https://a248.e.akamai.net/assets.github.com/images/icons/"
+    expected = "<p>an emoji <img class=\"emoji\" title=\":smile:\" alt=\":smile:\" src=\"#{asset_root}emoji/smile.png\" height=\"20\" width=\"20\" align=\"absmiddle\"></p>"
+    assert_equal expected,
+      NanocHtmlPipeline::Filter.new.run("<p>an emoji :smile:</p>", :pipeline => [:emojifilter], :asset_root => asset_root)
+  end
+
+  def test_multiple_filters
+    assert_equal "<p>a link is <a href=\"#{URL}\">#{URL}</a></p>",
+      NanocHtmlPipeline::Filter.new.run("a link is #{URL}", :pipeline => [:markdownfilter, :autolinkfilter])
+  end
+
+  def test_pipeline
+    input = "a link is #{URL}"
+
+    filters = [
+      HTML::Pipeline::MarkdownFilter,
+      HTML::Pipeline::SanitizationFilter,
+      HTML::Pipeline::ImageMaxWidthFilter,
+      HTML::Pipeline::HttpsFilter,
+      HTML::Pipeline::MentionFilter
+    ]
+    pipeline = HTML::Pipeline.new(filters, CONTEXT.merge(:gfm => true))
+    assert_equal pipeline.to_html(input),
+      NanocHtmlPipeline::Filter.new.run(input, :pipeline => filters)
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-html-pipeline
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Brent Fitzgerlad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rinku
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+description: ''
+email:
+- b@brentfitzgerald.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/nanoc-html-pipeline.rb
+- lib/nanoc-html-pipeline/filter.rb
+- lib/nanoc-html-pipeline/version.rb
+- nanoc-html-pipeline.gemspec
+- test/nanoc_html_pipeline_test.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nanoc-html-pipeline
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: nanoc filter for html-pipeline
+test_files:
+- test/nanoc_html_pipeline_test.rb