html-pipeline-rouge_filter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fbe6d6bed5f26e774cbec97e4c4f3daf0f8fb78
+  data.tar.gz: 4ef0190ac74ee92841a5ff7a07ec37aac417e6ba
+SHA512:
+  metadata.gz: 3ed19d6d77dbffa08f7a4ce7a3d25a17e9def14172379b9c6bba8fd25c0f681fc1bf866195de8371cc358ff882e73d5aa77eaebdb29029a132d5403f409268b8
+  data.tar.gz: 0107b840f5c002b3e802aee73a02e6eb8c35cab95868f9f7f7e623291ab306aaced04f4f7e416de3b918af0afb7c2f0eeee07ee63e7aa22593bb9a985e4d9b95

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## Unreleased
+
+## 1.0.0 - 2015.02.08
+
+- RougeFilter (Implementation reference: [SyntaxHighlightFilter](https://github.com/jch/html-pipeline/blob/956be5bf3d3b0dbe47dd9215b85b56773f23efb1/lib/html/pipeline/syntax_highlight_filter.rb)).

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twemoji.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "bundler"
+  gem "pry"
+end
+
+group :test do
+  gem "minitest", ">= 5.5"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Juanito Fatas
+
+MIT License
+
+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,60 @@
+# HTML::Pipeline::RougeFilter
+
+[Rouge](https://github.com/jneen/rouge) integration for [HTML::Pipeline](https://github.com/jch/html-pipeline).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-pipeline-rouge_filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html-pipeline-rouge_filter
+
+## Usage
+
+```ruby
+pipeline = HTML::Pipeline.new [
+  HTML::Pipeline::MarkdownFilter,
+  HTML::Pipeline::RougeFilter
+]
+
+result = pipeline.call <<-CODE
+```ruby
+def foo
+  puts "foo"
+end
+```
+CODE
+
+result[:output].to_s
+```
+
+Prints
+
+```html
+<pre class="highlight highlight-ruby">
+  <code>
+    <span class="k">def</span>
+    <span class="nf">foo</span>
+    <span class="nb">puts</span>
+    <span class="s2">"foo"</span>
+    <span class="k">end</span>
+  </code>
+</pre>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/html-pipeline-rouge_filter/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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/html-pipeline-rouge_filter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html/pipeline/rouge_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html-pipeline-rouge_filter"
+  spec.version       = HTML_Pipeline::RougeFilter::VERSION
+  spec.authors       = ["Juanito Fatas"]
+  spec.email         = ["katehuang0320@gmail.com"]
+  spec.summary       = %q{Rouge integration with html-pipeline.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/juanitofatas/html-pipeline-rouge_filter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "html-pipeline", "~> 1.11"
+  spec.add_dependency "rouge", "~> 1.8"
+  spec.add_dependency "activesupport"
+end

data/lib/html/pipeline/rouge_filter.rb

@@ -0,0 +1,53 @@
+require "html/pipeline/rouge_filter/version"
+require "html/pipeline/filter"
+
+require "rouge"
+
+require "active_support/core_ext/string/inflections"
+
+module HTML
+  class Pipeline
+    class RougeFilter < Filter
+      def call
+        doc.search("pre").each do |node|
+          default   = must_str(context[:highlight])
+          next unless lang = node["lang"] || default
+          next unless lexer = lexer_for(lang)
+          text = node.inner_text
+          html = highlight_with(lexer, text)
+          next if html.nil?
+
+          if (node = node.replace(html).first)
+            klass = node["class"]
+            klass = [klass, "#{default_css_class}-#{lang}"].compact.join(" ")
+            node["class"] = klass
+          end
+        end
+
+        doc
+      end
+
+      def must_str(text)
+        text && text.to_s
+      end
+
+      def highlight_with(lexer, text)
+        formatter.format(lexer.lex(text))
+      end
+
+      def default_css_class
+        must_str(context[:css_class]) || "highlight"
+      end
+
+      def formatter(css_class: default_css_class)
+        Rouge::Formatters::HTML.new(css_class: css_class)
+      end
+
+      def lexer_for(lang)
+        lexer = "Rouge::Lexers::#{lang.camelize}".constantize
+        lexer.new(parent: lang)
+      end
+    end
+  end
+end
+

data/lib/html/pipeline/rouge_filter/version.rb

@@ -0,0 +1,7 @@
+# NOTE use HTML_Pipeline since HTML::Pipeline is a class
+# and we don't want to define it here inadvertently
+module HTML_Pipeline
+  class RougeFilter
+    VERSION = "1.0.0"
+  end
+end

data/test/rouge_filter_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+require "html/pipeline/rouge_filter"
+
+class HTML::Pipeline::RougeFilterTest < Minitest::Test
+  RougeFilter = HTML::Pipeline::RougeFilter
+
+  def setup
+  end
+
+  def test_highlight_default
+    filter = RougeFilter.new \
+      "<pre>hello</pre>", highlight: "coffeescript"
+
+    doc = filter.call
+    assert !doc.css(".highlight-coffeescript").empty?
+  end
+
+  def test_highlight_default_will_not_override
+    filter = RougeFilter.new \
+      "<pre lang='ruby'>hello</pre>", highlight: "coffeescript"
+
+    doc = filter.call
+    assert doc.css(".highlight-coffeescript").empty?
+    assert !doc.css(".highlight-ruby").empty?
+  end
+
+  def test_version
+    assert_equal HTML_Pipeline::RougeFilter::VERSION, "0.0.1"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "bundler/setup"
+require "html/pipeline"
+require "minitest/autorun"
+
+module TestHelpers
+end
+
+Minitest::Test.send(:include, TestHelpers)

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-rouge_filter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juanito Fatas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+description: Rouge integration with html-pipeline.
+email:
+- katehuang0320@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- html-pipeline-rouge_filter.gemspec
+- lib/html/pipeline/rouge_filter.rb
+- lib/html/pipeline/rouge_filter/version.rb
+- test/rouge_filter_test.rb
+- test/test_helper.rb
+homepage: https://github.com/juanitofatas/html-pipeline-rouge_filter
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Rouge integration with html-pipeline.
+test_files: []
+has_rdoc: