markdown-highlight-extended-filter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e88313f99954a78e53e1f65616998b2e3792e22e
+  data.tar.gz: a7415ff36c3382cd06e25a668dd71292c7b7ea17
+SHA512:
+  metadata.gz: 537a2d2c1e3138716b9b046e289d005252427179fe0da4177f038f0efa48c59806db871178b14cbc4496dbfade8bd771ccb07289d285f4948152916700a0c195
+  data.tar.gz: eaee3434f304cf1325b7c35d3a431d5e9054801f602868a07d98d4a5137b0a3a0392b3f1e064e77096ac2cecac646949e3048628bdc0166e166b0916842db2ef

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in markdown-highlight-extended-filter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yu-Cheng Chuang
+
+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,88 @@
+# Markdown Highlight Extended Filter for HTML::Pipeline
+
+An HTML::Pipeline filter to convert Octopress-flavored syntax highlighting, like this:
+
+    ``` [language] [title] [url] [link text]
+    code snippet
+    ```
+
+See: http://octopress.org/docs/blogging/code/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'markdown-highlight-extended-filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it without Gemfile (like, Jekyll project):
+
+    $ gem install markdown-highlight-extended-filter
+
+## Usage
+
+```ruby
+pipeline = HTML::Pipeline.new [
+  MarkdownHighlightExtendedFilter,
+  HTML::Pipeline::MarkdownFilter
+]
+
+pipeline.call(File.read("example.md"))[:output]
+```
+
+example.md:
+
+    Here is a sample:
+
+    ```ruby test.rb
+    def abc
+      123
+    end
+    ```
+
+### Jekyll site usage
+
+This filter is for HTML::Pipeline, so you must use HTML::Pipeline to
+generate your content from Markdown. See [gjtorikian/jekyll-html-pipeline](https://github.com/gjtorikian/jekyll-html-pipeline) for more details.
+
+Edit `_config.yml` and configure the pieline like this:
+
+```yml
+gems:
+- jekyll-html-pipeline
+- markdown-highlight-extended-filter
+
+markdown: HTMLPipeline
+
+html_pipeline:
+  filters:
+    - "MarkdownHighlightExtendedFilter" # Must put before markdownfilter
+    - "markdownfilter"
+```
+
+## Known Issues
+
+Unsupported features:
+
+* Line Numbers
+* Line Highlights
+
+These were defined in [Octopress's document](http://octopress.org/docs/blogging/code/) as additional options. (PR welcome!)
+
+## Special Thanks
+
+The code to convert complex syntax highlighting was stolen from [Octopress Project](https://github.com/imathis/octopress/).
+See [imathis/octopress:plugins/backtick_code_block.rb@73e5404](https://github.com/imathis/octopress/blob/73e540409ceb8bc18048b6a96a4b815fc303ea28/plugins/backtick_code_block.rb) for the original source code. Also thanks contributers: @imathis, @fhemberger and @liangsun. I hope you don't mind :D
+
+## Contributing
+
+1. Fork it ( https://github.com/chitsaou/markdown-highlight-extended-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,2 @@
+require "bundler/gem_tasks"
+

data/lib/markdown-highlight-extended-filter.rb

@@ -0,0 +1,53 @@
+require "html/pipeline"
+require "pygments.rb"
+
+# Stolen from https://github.com/imathis/octopress/blob/master/plugins/backtick_code_block.rb
+# (MIT License)
+class MarkdownHighlightExtendedFilter < HTML::Pipeline::TextFilter
+  AllOptions = /([^\s]+)\s+(.+?)\s+(https?:\/\/\S+|\/\S+)\s*(.+)?/i
+  LangCaption = /([^\s]+)\s*(.+)?/i
+
+  PIPELINE = HTML::Pipeline.new [
+    HTML::Pipeline::SyntaxHighlightFilter
+  ]
+
+  def call
+    format_syntax(@text)
+  end
+
+  def format_syntax(text)
+    text.gsub(/^`{3} *([^\n]+)?\n(.+?)\n`{3}/m) do
+      options = $1 || ''
+      str = $2
+
+      if options =~ AllOptions
+        lang = $1
+        caption = "<figcaption><span>#{$2}</span><a href='#{$3}'>#{$4 || 'link'}</a></figcaption>"
+      elsif options =~ LangCaption
+        lang = $1
+        caption = "<figcaption><span>#{$2}</span></figcaption>"
+      end
+
+      if str.match(/\A( {4}|\t)/)
+        str = str.gsub(/^( {4}|\t)/, '')
+      end
+      if lang.nil? || lang == 'plain'
+        code = highlight_code(str.gsub('<','&lt;').gsub('>','&gt;'), "plain")
+        "<figure class='code'>#{caption}#{code}</figure>"
+      else
+        if lang.include? "-raw"
+          raw = "``` #{options.sub('-raw', '')}\n"
+          raw += str
+          raw += "\n```\n"
+        else
+          code = highlight_code(str, lang)
+          "<figure class='code'>#{caption}#{code}</figure>"
+        end
+      end
+    end
+  end
+
+  def highlight_code(code, lang)
+    PIPELINE.call("<pre lang='#{lang}'>#{code}</pre>")[:output].to_s
+  end
+end

data/markdown-highlight-extended-filter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "markdown-highlight-extended-filter"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Yu-Cheng Chuang"]
+  spec.email         = ["ducksteven@gmail.com"]
+  spec.summary       = %q{HTML::Pipeline filter for Octopress-flavored syntax highlighting}
+  spec.description   = %q{HTML::Pipeline filter for Octopress-flavored syntax highlighting}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "html-pipeline"
+  spec.add_dependency "pygments.rb"
+  spec.add_dependency "github-linguist"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+end

data/spec/markdown-highlight-extended-filter_spec.rb

@@ -0,0 +1,110 @@
+require 'markdown-highlight-extended-filter'
+
+RSpec.describe "MarkdownHighlightExtendedFilter" do
+  let(:pipeline) {
+    HTML::Pipeline.new [MarkdownHighlightExtendedFilter]
+  }
+
+  let(:rendered) {
+    pipeline.call(text)[:output]
+  }
+
+  describe "no args" do
+    let(:text) { <<-TEXT
+```
+def abc
+  123
+end
+```
+TEXT
+    }
+
+    it "renders correctly" do
+      expect(rendered).to eq <<-HTML
+<figure class='code'><pre lang="plain">def abc
+  123
+end</pre></figure>
+HTML
+    end
+  end
+
+  describe "lang arg only" do
+    let(:text) { <<-TEXT
+```ruby
+def abc
+  123
+end
+```
+TEXT
+    }
+
+    it "renders correctly" do
+      expect(rendered).to eq <<-HTML
+<figure class='code'><figcaption><span></span></figcaption><div class="highlight highlight-ruby"><pre><span class="k">def</span> <span class="nf">abc</span>
+  <span class="mi">123</span>
+<span class="k">end</span>
+</pre></div></figure>
+HTML
+    end
+  end
+
+  describe "lang and title args" do
+    let(:text) { <<-TEXT
+```ruby Hello World
+def abc
+  123
+end
+```
+TEXT
+    }
+
+    it "renders correctly" do
+      expect(rendered).to eq <<-HTML
+<figure class='code'><figcaption><span>Hello World</span></figcaption><div class="highlight highlight-ruby"><pre><span class="k">def</span> <span class="nf">abc</span>
+  <span class="mi">123</span>
+<span class="k">end</span>
+</pre></div></figure>
+HTML
+    end
+  end
+
+  describe "lang, title, url args" do
+    let(:text) { <<-TEXT
+```ruby Hello World http://www.example.com
+def abc
+  123
+end
+```
+TEXT
+    }
+
+    it "renders correctly" do
+      expect(rendered).to eq <<-HTML
+<figure class='code'><figcaption><span>Hello World</span><a href='http://www.example.com'>link</a></figcaption><div class="highlight highlight-ruby"><pre><span class="k">def</span> <span class="nf">abc</span>
+  <span class="mi">123</span>
+<span class="k">end</span>
+</pre></div></figure>
+HTML
+    end
+  end
+
+  describe "lang, title, url, link-title args" do
+    let(:text) { <<-TEXT
+```ruby Hello World http://www.example.com Example
+def abc
+  123
+end
+```
+TEXT
+    }
+
+    it "renders correctly" do
+      expect(rendered).to eq <<-HTML
+<figure class='code'><figcaption><span>Hello World</span><a href='http://www.example.com'>Example</a></figcaption><div class="highlight highlight-ruby"><pre><span class="k">def</span> <span class="nf">abc</span>
+  <span class="mi">123</span>
+<span class="k">end</span>
+</pre></div></figure>
+HTML
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: markdown-highlight-extended-filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yu-Cheng Chuang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  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'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  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'
+- !ruby/object:Gem::Dependency
+  name: github-linguist
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: HTML::Pipeline filter for Octopress-flavored syntax highlighting
+email:
+- ducksteven@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/markdown-highlight-extended-filter.rb
+- markdown-highlight-extended-filter.gemspec
+- spec/markdown-highlight-extended-filter_spec.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.2.2
+signing_key: 
+specification_version: 4
+summary: HTML::Pipeline filter for Octopress-flavored syntax highlighting
+test_files:
+- spec/markdown-highlight-extended-filter_spec.rb