additional-markdown-filter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f796edafe0ca71d0b60b6713eb917577dd0547d3
+  data.tar.gz: 7612af6d1cf4619380cf1290ba931f83c031243e
+SHA512:
+  metadata.gz: 1da5f13f44dd6e6102eec5d29189e0aa60ecaceb92b94c6ba20ea58ed46de201c043fa246a7d796fe972676decf9e4afbf86dc115023276bf35da4d6d24d852c
+  data.tar.gz: ad784c1a6acb8e55e4ca8afad1a7c159cc12e1144d5a6cdb513cc3a7693e7cef30c9663b7957814516483b6fa60a88d0455f956c9976e943c494b27cd03d44bf

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 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,30 @@
+additional-markdown-filter
+====================
+
+Additional Markdown filters for the [HTML::Pipeline](https://github.com/jch/html-pipeline).
+
+[![Build Status](https://travis-ci.org/gjtorikian/additional-markdown-filter.svg)](https://travis-ci.org/gjtorikian/additional-markdown-filter)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'additional-markdown-filter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install additional-markdown-filter
+
+## Usage
+
+The simplest way to do this is
+
+``` ruby
+require 'additional-markdown-filter'
+```
+
+Then just use the pipeline normally.

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/additional-markdown-filter.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name          = "additional-markdown-filter"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Garen Torikian"]
+  spec.email         = ["gjtorikian@gmail.com"]
+  spec.summary       = %q{Add additional markup syntax to the HTML::Pipeline}
+  spec.description   = %q{This is a custom Markdown processor to be used with GitHub's HTML::Pipeline. }
+  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 'html-pipeline', "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.4"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'minitest', "~> 5.0"
+  spec.add_development_dependency 'github-markdown', "~> 0.6.3"
+end

data/lib/additional_markdown_filter.rb

@@ -0,0 +1,69 @@
+require "html/pipeline"
+
+class AdditionalMarkdownFilter < HTML::Pipeline::MarkdownFilter
+ def initialize(text, context = nil, result = nil)
+    # do preprocessing, then call HTML::Pipeline::Markdown
+    format_command_line!    text
+    format_helper!          text
+
+    super text, context, result
+  end
+
+  def call
+    # initialize HTML::Pipeline::Markdown, then do post-processing
+    html = super
+
+    format_intro!           html
+    format_os_blocks!       html
+    format_admonition!      html
+
+    html
+  end
+
+  def format_command_line!(text)
+    text.gsub! /\n?``` command-line(.+?)```/m do |block|
+      block.gsub! /^``` command-line/, '<pre class="command-line">'
+      block.gsub! /^```$/, "</pre>\n"
+      block.gsub!(/^\$ (.+)$/) { %Q|<span class="command">#{$1.rstrip}</span>| }
+      block.gsub!(/^(\# .+)$/) { %Q|<span class="comment">#{$1.rstrip}</span>| }
+      block.gsub!(/^> (.+)$/) { %Q|<span class="output"><span># </span>#{$1.rstrip}</span>| }
+
+      block
+    end
+  end
+
+  def format_helper!(text)
+    text.gsub! /\n?``` helper(.+?)```/m do |block|
+      block.gsub! /^``` helper\s*/, ''
+      block.gsub! /^```$/, ''
+
+      header = ''
+      block.gsub! /^#### (.+?)$/ do
+        header = $1.strip
+        ''
+      end
+
+      content = block.strip
+      content = "<p>#{content}</p>" unless content =~ /^<p/
+      content = "<div class='helper'><h4 class='header'><a href='#'>#{header}</a></h4><div class='content'>#{content}</div></div>"
+    end
+  end
+
+  def format_intro!(html)
+    html.gsub!(/<p>{{#intro}}<\/p>/,    '<div class="intro">')
+    html.gsub!(/<p>{{\/intro}}<\/p>/,   '</div>')
+  end
+
+  def format_os_blocks!(html)
+    html.gsub!(/<p>{{#mac}}<\/p>/,     '<div class="platform-mac">')
+    html.gsub!(/<p>{{#windows}}<\/p>/, '<div class="platform-windows">')
+    html.gsub!(/<p>{{#linux}}<\/p>/,   '<div class="platform-linux">')
+    html.gsub!(/<p>{{#all}}<\/p>/,     '<div class="platform-all">')
+    html.gsub!(/<p>{{\/(mac|windows|linux|all)}}<\/p>/, '</div>')
+  end
+
+  def format_admonition!(html)
+    html.gsub!(/<p>{{#(tip|warning|error)}}<\/p>/,  '<div class="alert \1">')
+    html.gsub!(/<p>{{\/(tip|warning|error)}}<\/p>/, '</div>')
+  end
+end

data/test/fixtures/admonition.md

@@ -0,0 +1,20 @@
+{{#tip}}
+
+Here's a hot tip: **line one**
+Here's a hot tip: line two
+
+{{/tip}}
+
+{{#warning}}
+
+Yo, check this out: line one
+Yo, check this out: line two
+
+{{/warning}}
+
+{{#error}}
+
+Sheeeeit, this is a problem: ~~line one~~
+Sheeeeit, this is a problem: line two
+
+{{/error}}

data/test/fixtures/command_line.md

@@ -0,0 +1,5 @@
+``` command-line
+$ git remote add origin https://github.com/<em>user</em>/<em>repo</em>.git
+# Set a new remote
+> origin  https://github.com/user/repo.git
+```

data/test/fixtures/helper.md

@@ -0,0 +1,8 @@
+
+``` helper
+#### A note about Sync in GitHub for Mac
+
+Those that are already familiar with Git may notice that there are no "Push" or "Pull" buttons in GitHub for Mac.
+
+Instead of bringing in new changes from the remote copy with one command and pushing your unpublished commits with another, GitHub for Mac uses a single "Sync" button that quickly completes both operations at the same. Behind the scenes, we do the equivalent of a `git pull --rebase` (but make sure to never rewrite merges).
+```

data/test/fixtures/intro.md

@@ -0,0 +1,5 @@
+{{#intro}}
+
+[Gists](https://gist.github.com) are a great way to share your work. You can share single files, parts of files, or full applications.
+
+{{/intro}}

data/test/fixtures/os_blocks.md

@@ -0,0 +1,23 @@
+{{#mac}}
+
+1. [Create a new repository](/articles/creating-a-new-repository).
+
+{{/mac}}
+
+{{#windows}}
+
+1. [Try to create a new repository](/articles/creating-a-new-repository).
+
+{{/windows}}
+
+{{#linux}}
+
+1. You *already* know what you're doing.
+
+{{/linux}}
+
+{{#all}}
+
+What?
+
+{{/all}}

data/test/test_additional_markdown_filter.rb

@@ -0,0 +1,70 @@
+require "test_helper"
+
+class HTML::Pipeline::AdditionalMarkdownFilterTest < Minitest::Test
+  def fixture(name)
+    File.open(File.join("#{File.expand_path(File.dirname(__FILE__))}", "fixtures", name)).read
+  end
+
+  def test_command_line
+    doc = AdditionalMarkdownFilter.to_document(fixture("command_line.md"), {})
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+
+    assert_equal 1, doc.css('pre').size
+    assert_equal 1, doc.css('span.command').size
+    assert_equal 1, doc.css('span.comment').size
+    assert_equal 2, doc.css('em').size
+    assert_equal 1, doc.css('span.output').size
+  end
+
+  def test_helper
+    doc = AdditionalMarkdownFilter.to_document(fixture("helper.md"), {})
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+
+    assert_equal 1, doc.css('div.helper').size
+    assert_equal 1, doc.css('h4.header').size
+    assert_equal 1, doc.css('a').size
+    assert_equal 1, doc.css('div.content').size
+  end
+
+  def test_intro
+    doc = AdditionalMarkdownFilter.to_document(fixture("intro.md"), {})
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+
+    assert_equal 1, doc.css('div.intro').size
+    assert_equal 1, doc.css('a').size # the inner Markdown converted!
+  end
+
+  def test_intro
+    doc = AdditionalMarkdownFilter.to_document(fixture("intro.md"), {})
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+
+    assert_equal 1, doc.css('div.intro').size
+    assert_equal 1, doc.css('a').size # the inner Markdown converted!
+  end
+
+  def test_os_blocks
+    doc = AdditionalMarkdownFilter.to_document(fixture("os_blocks.md"), {})
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+
+    assert_equal 1, doc.css('div.platform-mac').size
+    assert_equal 1, doc.css('div.platform-windows').size
+    assert_equal 1, doc.css('div.platform-linux').size
+    assert_equal 1, doc.css('div.platform-all').size
+    # the inner Markdown converted!
+    assert_equal 3, doc.css('ol').size
+    assert_equal 2, doc.css('a').size
+    assert_equal 1, doc.css('em').size
+  end
+
+  def test_admonition
+    doc = AdditionalMarkdownFilter.to_document(fixture("admonition.md"), {})
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+
+    assert_equal 1, doc.css('div.tip').size
+    assert_equal 1, doc.css('div.warning').size
+    assert_equal 1, doc.css('div.error').size
+    # the inner Markdown converted!
+    assert_equal 1, doc.css('strong').size
+    assert_equal 1, doc.css('del').size
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "rubygems"
+
+require 'minitest/autorun'
+
+require "additional_markdown_filter"

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: additional-markdown-filter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-01 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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
+description: 'This is a custom Markdown processor to be used with GitHub''s HTML::Pipeline. '
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- additional-markdown-filter.gemspec
+- lib/additional_markdown_filter.rb
+- test/fixtures/admonition.md
+- test/fixtures/command_line.md
+- test/fixtures/helper.md
+- test/fixtures/intro.md
+- test/fixtures/os_blocks.md
+- test/test_additional_markdown_filter.rb
+- test/test_helper.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: Add additional markup syntax to the HTML::Pipeline
+test_files:
+- test/fixtures/admonition.md
+- test/fixtures/command_line.md
+- test/fixtures/helper.md
+- test/fixtures/intro.md
+- test/fixtures/os_blocks.md
+- test/test_additional_markdown_filter.rb
+- test/test_helper.rb