html-pipeline-asciidoc_filter 0.1.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af95f8d219ae792a1c9ac10c42cb06e4ea858c15
-  data.tar.gz: bf0693e903da2b4d8536858844fb9d0eda32b8f4
+  metadata.gz: 5901d9931bfbdf81b3bab66bd246019233e70fc0
+  data.tar.gz: 9aa593c80be0c7b19be53afd38be83af70f522a9
 SHA512:
-  metadata.gz: e303cd5b06a8c7bf183e8be579e9d8a6bd5aabb18674cf38fbc6f6855a256c2c7a8502a5967194eacbda9be6c6b2f286fbbeac6f0fcd19ae5a12b3725ed84379
-  data.tar.gz: ee80dc7c686ac08e5733898674d2e02108c8a5eb4425ae74ee3621932b80091cb26f533ffd8582ae7a4995f5293528fe89179bfbff303e4840a03898351746b9
+  metadata.gz: 623ab2f5ada3e0ce8de5b96c87f0c11a6ebe436954163beca85029991b72b15da0a0eec5ce42945431bcecbd4644f669f83b4b4be336a68be2c917df85d4cc92
+  data.tar.gz: 403757cdfdc92971bff5d9839f5f51d961fcd2271c0dc1d81a252d8fc1de5052afced57bdd1d4df044c20806efeb00b3fe789a88373724fcdfc6f7016d92811d

data/README.adoc

@@ -1,10 +1,5 @@
 = 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].
 
@@ -67,12 +62,20 @@ 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.
+You'll need the following dependencies in your Gemfile which aren't declared by +html-pipeline+ or this filter.
 
+.Gemfile
 [source,ruby]
 ----
-gem 'activesupport', '>= 2'
-gem 'github-linguist', '~> 1.2.6'
+gem 'html-pipeline-asciidoc_filter'
+# gemoji needed for EmojiFilter
+gem 'gemoji', '~> 1.0'
+# rinku needed for AutolinkFilter
+gem 'rinku', '~> 1.7'
+# sanitize needed for Sanitization Filter
+gem 'sanitize', '~> 2.0'
+# github-linguist needed for SyntaxHighlightFilter
+gem 'github-linguist', (RUBY_VERSION < '2.1.0' ? '~> 2.6.2', '~> 2.10')
 ----
 
 == TODO
@@ -84,7 +87,7 @@ gem 'github-linguist', '~> 1.2.6'
 
 == Copyright and License
 
-Copyright (C) 2013 Dan Allen
+Copyright (C) 2014 Dan Allen
 Free use of this software is granted under the terms of the MIT License.
 
 See the {license}[LICENSE] file for details.

data/examples/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'html-pipeline', '1.9.0'
+gem 'asciidoctor', '0.1.4'
+gem 'gemoji', '~> 1.0'
+gem 'rinku', '~> 1.7'
+gem 'sanitize', '~> 2.0'
+if RUBY_VERSION < '2.1.0'
+  gem 'github-linguist', '~> 2.6.2'
+else
+  gem 'github-linguist', '~> 2.10'
+end

data/examples/example.rb

@@ -0,0 +1,47 @@
+require 'html/pipeline'
+require_relative '../lib/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]

data/html-pipeline-asciidoc_filter.gemspec

@@ -7,23 +7,16 @@ Gem::Specification.new do |gem|
   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.summary       = 'An AsciiDoc processing filter for html-pipeline powered by Asciidoctor'
+  gem.description   = 'An AsciiDoc processing filter for html-pipeline powered by 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.executables   = gem.files.grep(/^bin\//) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(/^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'
+  gem.add_dependency 'html-pipeline', '~> 1.9.0'
+  gem.add_dependency 'asciidoctor', '~> 1.5.0'
 end

data/lib/html/pipeline/asciidoc_filter.rb

@@ -3,7 +3,6 @@ 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
@@ -52,7 +51,7 @@ class HTML::Pipeline
   #   [source,ruby]
   #   --
   #   require 'asciidoctor'
-  #   puts Asciidoctor.render('This filter brought to you by http://asciidoctor.org[Asciidoctor].')
+  #   puts Asciidoctor.convert('This filter brought to you by http://asciidoctor.org[Asciidoctor].')
   #   --
   #
   #   :shipit: 
@@ -67,9 +66,7 @@ class HTML::Pipeline
   
     # Convert AsciiDoc to HTML using Asciidoctor
     def call
-      Asciidoctor.render @text, :attributes => 'showtitle idprefix idseparator=- env=github env-github source-highlighter=html-pipeline'
+      Asciidoctor.convert @text, :safe => :secure, :attributes => %w(showtitle=@ idprefix= idseparator=- env=github env-github source-highlighter=html-pipeline)
     end
-
   end
-
 end

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

@@ -2,6 +2,6 @@
 # and we don't want to define it here inadvertently
 module HTML_Pipeline
 class AsciiDocFilter
-  VERSION = '0.1.4'
+  VERSION = '1.5.0'
 end
 end

data/test/asciidoc_filter_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'html/pipeline/asciidoc_filter'
 
-class HTML::Pipeline::AsciiDocFilterTest < Test::Unit::TestCase
+class HTML::Pipeline::AsciiDocFilterTest < Minitest::Test
 
   AsciiDocFilter = HTML::Pipeline::AsciiDocFilter
 
@@ -17,6 +17,14 @@ Paragraph in preamble
 Paragraph in section
     EOS
 
+    @hidden_doctitle_example = <<-EOS
+= Sample Document
+Author Name
+:showtitle!:
+
+Paragraph content
+    EOS
+
     @source_code_example = <<-EOS
 ```ruby
 def hello()
@@ -34,6 +42,13 @@ end
     assert_equal 1, doc.css('h2#sample-section').size
   end
 
+  def test_for_hidden_document_title
+    doc = AsciiDocFilter.to_document(@hidden_doctitle_example)
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+    assert_equal 0, doc.css('h1').size
+    assert_equal 1, doc.css('.paragraph p').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)

data/test/test_helper.rb

@@ -1,30 +1,8 @@
 require 'html/pipeline'
-require 'test/unit'
+require 'minitest/autorun'
 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)
@@ -33,4 +11,4 @@ module TestHelpers
   end
 end
 
-Test::Unit::TestCase.send(:include, TestHelpers)
+Minitest::Test.send(:include, TestHelpers)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline-asciidoc_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2014-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -16,85 +16,29 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 1.9.0
 - !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
+        version: 1.5.0
+  type: :runtime
   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
+        version: 1.5.0
+description: An AsciiDoc processing filter for html-pipeline powered by Asciidoctor
 email:
 - dan.j.allen@gmail.com
 executables: []
@@ -103,6 +47,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.adoc
+- examples/Gemfile
+- examples/example.rb
 - html-pipeline-asciidoc_filter.gemspec
 - lib/html/pipeline/asciidoc_filter.rb
 - lib/html/pipeline/asciidoc_filter/version.rb
@@ -128,10 +74,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: An AsciiDoc filter for html-pipeline based on Asciidoctor
+summary: An AsciiDoc processing filter for html-pipeline powered by Asciidoctor
 test_files:
 - test/asciidoc_filter_test.rb
 - test/test_helper.rb