html-pipeline-asciidoc_filter 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af95f8d219ae792a1c9ac10c42cb06e4ea858c15
+  data.tar.gz: bf0693e903da2b4d8536858844fb9d0eda32b8f4
+SHA512:
+  metadata.gz: e303cd5b06a8c7bf183e8be579e9d8a6bd5aabb18674cf38fbc6f6855a256c2c7a8502a5967194eacbda9be6c6b2f286fbbeac6f0fcd19ae5a12b3725ed84379
+  data.tar.gz: ee80dc7c686ac08e5733898674d2e02108c8a5eb4425ae74ee3621932b80091cb26f533ffd8582ae7a4995f5293528fe89179bfbff303e4840a03898351746b9

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (C) 2013 Dan Allen
+
+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.adoc

@@ -0,0 +1,90 @@
+= AsciiDoc filter for html-pipeline
+Dan Allen
+ifndef::safe-mode-name[]
+
+[float]
+= AsciiDoc filter for html-pipeline
+endif::safe-mode-name[]
+
+https://rubygems.org/gems/html-pipeline-asciidoc_filter[html-pipeline-asciidoc_filter] is an AsciiDoc processing filter for https://github.com/jch/html-pipeline[html-pipeline] based on https://asciidoctor.org[Asciidoctor].
+
+This filter is used to render AsciiDoc files in GitHub repositories, among other uses.
+Keep in mind that an HTML sanitization filter is run after this filter, so not all elements in the AsciiDoc document render correctly.
+We need to improve the output generated by this filter to get better results.
+
+== Example Usage
+
+[source,ruby]
+----
+require 'html/pipeline'
+require 'html/pipeline/asciidoc_filter'
+
+filters = [
+  HTML::Pipeline::AsciiDocFilter,
+  HTML::Pipeline::SanitizationFilter,
+  HTML::Pipeline::ImageMaxWidthFilter,
+  HTML::Pipeline::EmojiFilter,
+  HTML::Pipeline::MentionFilter,
+  HTML::Pipeline::AutolinkFilter,
+  HTML::Pipeline::TableOfContentsFilter,
+  HTML::Pipeline::SyntaxHighlightFilter
+]
+
+context = {
+  :asset_root => 'https://github.global.ssl.fastly.net/images/icons/emoji'
+}
+
+pipeline = HTML::Pipeline.new filters, context
+pipeline.setup_instrumentation
+
+input = <<-EOS
+= Sample Document
+Author Name
+
+Preamble paragraph.
+
+== Sample Section
+
+Section content.
+
+.GitHub usernames
+- @jch
+- @rtomayko
+- @mojavelinux
+
+[source,ruby]
+--
+require 'asciidoctor'
+
+puts Asciidoctor.render('This filter brought to you by http://asciidoctor.org[Asciidoctor].')
+--
+
+:shipit: 
+EOS
+
+puts pipeline.call(input)[:output]
+----
+
+== Note about dependencies
+
+You'll need the following two dependencies which aren't declared by +html-pipeline+ or this filter.
+
+[source,ruby]
+----
+gem 'activesupport', '>= 2'
+gem 'github-linguist', '~> 1.2.6'
+----
+
+== TODO
+
+* remove `<p>` from text-only list items by defining custom block_paragraph template
+* preserve ToC (likely through subsequent filter)
+* retain checklist items in list (perhaps using text-based checkmarks)
+* enable font-based icons
+
+== Copyright and License
+
+Copyright (C) 2013 Dan Allen
+Free use of this software is granted under the terms of the MIT License.
+
+See the {license}[LICENSE] file for details.

data/html-pipeline-asciidoc_filter.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path '../lib/html/pipeline/asciidoc_filter/version', __FILE__
+
+Gem::Specification.new do |gem|
+  # named according to http://guides.rubygems.org/name-your-gem
+  gem.name          = 'html-pipeline-asciidoc_filter'
+  gem.version       = HTML_Pipeline::AsciiDocFilter::VERSION
+  gem.authors       = ['Dan Allen']
+  gem.email         = ['dan.j.allen@gmail.com']
+  gem.summary       = %(An AsciiDoc filter for html-pipeline based on Asciidoctor)
+  gem.description   = %(An AsciiDoc filter for html-pipeline based on Asciidoctor)
+  gem.homepage      = 'https://github.com/asciidoctor/html-pipeline-asciidoc_filter'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files -z -- */* {README,LICENSE}* *.gemspec`.split("\0")
+  gem.executables   = gem.files.grep(%r"^bin/") { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r"^test/")
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'html-pipeline', '~> 0.3'
+  gem.add_dependency 'asciidoctor', '= 0.1.4'
+
+  # activesupport should be a dependency of html-pipeline; cannot it load html-pipeline without it
+  gem.add_development_dependency 'activesupport', RUBY_VERSION < '1.9.3' ? ['>= 2', '< 4'] : '>= 2'
+
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'github-linguist', '~> 2.6.2'
+end

data/lib/html/pipeline/asciidoc_filter.rb

@@ -0,0 +1,75 @@
+require 'asciidoctor'
+require 'html/pipeline/filter'
+require 'html/pipeline/text_filter'
+
+class HTML::Pipeline
+
+  # HTML Filter that converts AsciiDoc text into HTML.
+  #
+  # This filter is different from most in that it can take a non-HTML as
+  # input. It must be used as the first filter in a pipeline.
+  #
+  # This filter does not write any additional information to the context hash.
+  #
+  # Examples
+  #
+  #   require 'html/pipeline'
+  #   require 'html/pipeline/asciidoc_filter'
+  #
+  #   filters = [
+  #     HTML::PipelineExt::AsciiDocFilter,
+  #     HTML::Pipeline::SanitizationFilter,
+  #     HTML::Pipeline::ImageMaxWidthFilter,
+  #     HTML::Pipeline::EmojiFilter,
+  #     HTML::Pipeline::MentionFilter,
+  #     HTML::Pipeline::AutolinkFilter,
+  #     HTML::Pipeline::TableOfContentsFilter,
+  #     HTML::Pipeline::SyntaxHighlightFilter
+  #   ]
+  #
+  #   context = {
+  #     :asset_root => 'https://github.global.ssl.fastly.net/images/icons/emoji'
+  #   }
+  #
+  #   pipeline = HTML::Pipeline.new filters, context
+  #   pipeline.setup_instrumentation
+  #
+  #   input = <<EOS
+  #   = Sample Document
+  #   Author Name
+  #
+  #   Preamble paragraph.
+  #
+  #   == Sample Section
+  #
+  #   Section content.
+  #
+  #   .GitHub usernames
+  #   - @jch
+  #   - @jm
+  #   - @mojavelinux
+  #
+  #   [source,ruby]
+  #   --
+  #   require 'asciidoctor'
+  #   puts Asciidoctor.render('This filter brought to you by http://asciidoctor.org[Asciidoctor].')
+  #   --
+  #
+  #   :shipit: 
+  #   EOS
+  #
+  #   puts pipeline.call(input)[:output]
+  #
+  class AsciiDocFilter < TextFilter
+    def initialize(text, context = nil, result = nil)
+      super text, context, result
+    end
+  
+    # Convert AsciiDoc to HTML using Asciidoctor
+    def call
+      Asciidoctor.render @text, :attributes => 'showtitle idprefix idseparator=- env=github env-github source-highlighter=html-pipeline'
+    end
+
+  end
+
+end

data/lib/html/pipeline/asciidoc_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 AsciiDocFilter
+  VERSION = '0.1.4'
+end
+end

data/test/asciidoc_filter_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+require 'html/pipeline/asciidoc_filter'
+
+class HTML::Pipeline::AsciiDocFilterTest < Test::Unit::TestCase
+
+  AsciiDocFilter = HTML::Pipeline::AsciiDocFilter
+
+  def setup
+    @doctitle_example = <<-EOS
+= Sample Document
+Author Name
+
+Paragraph in preamble
+
+== Sample Section
+
+Paragraph in section
+    EOS
+
+    @source_code_example = <<-EOS
+```ruby
+def hello()
+  'world'
+end
+```
+    EOS
+  end
+
+  def test_for_document_title
+    doc = AsciiDocFilter.to_document(@doctitle_example)
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+    assert_equal 1, doc.css('h1').size
+    assert_equal 1, doc.css('#preamble p').size
+    assert_equal 1, doc.css('h2#sample-section').size
+  end
+
+  def test_for_lang_attribute_on_source_code_block
+    doc = AsciiDocFilter.to_document(@source_code_example)
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+    assert_equal 1, doc.search('pre').size
+    assert_equal 'ruby', doc.search('pre').first['lang']
+  end
+  
+  AsciiDocPipeline =
+    HTML::Pipeline.new [
+      HTML::Pipeline::AsciiDocFilter,
+      HTML::Pipeline::SanitizationFilter,
+      HTML::Pipeline::SyntaxHighlightFilter
+    ]
+  AsciiDocPipeline.setup_instrumentation
+
+  def test_syntax_highlighting
+    result = {}
+    AsciiDocPipeline.call(@source_code_example, {}, result)
+    assert_equal_html %(<div>
+<div>
+<div class="highlight highlight-ruby">
+<pre><span class="k">def</span> <span class="nf">hello</span><span class="p">()</span>
+  <span class="s1">'world'</span>
+<span class="k">end</span></pre>
+</div>
+</div>
+</div>), result[:output].to_s
+  end
+
+  def test_for_document_structure
+    result = {}
+    AsciiDocPipeline.call(@doctitle_example, {}, result)
+    output = result[:output]
+    assert_equal 1, output.css('h1').size
+    assert_equal 1, output.css('h2').size
+    assert_equal 2, output.css('p').size
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+require 'html/pipeline'
+require 'test/unit'
+require 'active_support/core_ext/object/try'
+
+module TestHelpers
+  # Asserts that `needle` is not a member of `haystack`, where
+  # `haystack` is any object that responds to `include?`.
+  def assert_doesnt_include(needle, haystack, message = nil)
+    error = '<?> included in <?>'
+    message = build_message(message, error, needle.to_s, Array(haystack).map(&:to_s))
+
+    assert_block message do
+      !haystack.include?(needle)
+    end
+  end
+
+  # Asserts that `needle` is a member of `haystack`, where
+  # `haystack` is any object that responds to `include?`.
+  def assert_includes(needle, haystack, message = nil)
+    error = '<?> not included in <?>'
+    message = build_message(message, error, needle.to_s, Array(haystack).map(&:to_s))
+
+    assert_block message do
+      haystack.include?(needle)
+    end
+  end
+
+  # Asserts that two html fragments are equivalent. Attribute order
+  # will be ignored.
+  def assert_equal_html(expected, actual)
+    assert_equal Nokogiri::HTML::DocumentFragment.parse(expected).to_hash,
+                 Nokogiri::HTML::DocumentFragment.parse(actual).to_hash
+  end
+end
+
+Test::Unit::TestCase.send(:include, TestHelpers)

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-asciidoc_filter
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Dan Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-17 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.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: github-linguist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+description: An AsciiDoc filter for html-pipeline based on Asciidoctor
+email:
+- dan.j.allen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- html-pipeline-asciidoc_filter.gemspec
+- lib/html/pipeline/asciidoc_filter.rb
+- lib/html/pipeline/asciidoc_filter/version.rb
+- test/asciidoc_filter_test.rb
+- test/test_helper.rb
+homepage: https://github.com/asciidoctor/html-pipeline-asciidoc_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.0.3
+signing_key: 
+specification_version: 4
+summary: An AsciiDoc filter for html-pipeline based on Asciidoctor
+test_files:
+- test/asciidoc_filter_test.rb
+- test/test_helper.rb