html-pipeline 0.3.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 398dde5c696c319791f1591c1df00abde348028b
+  data.tar.gz: 55dc9f47d97a18ab166a5fb6016fb4de28611c13
+SHA512:
+  metadata.gz: c3f317bb8ca4615276a9ea0caf6f5d48e5bb9fd4d92b1dc5073cf65d7601e155d3e8bc55b12339dc4eb30eb8d82defb1fbc6219408987bf2e7ecb2bf55a2e057
+  data.tar.gz: 8b40cc7d0b8d3bae252d565e7ac929b4b194659ad2d284657db7ee09a98bda81c14b300484f81a65395dca1847ebc7c138e9fc2a9d67dbab81350c7badfc3f6f

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 1.0.0
+
+To upgrade to this release, you will need to include separate gems for each of
+the filters. See [this section of the README](/README.md#dependencies) for
+details.
+
+* filter dependencies are no longer included #80 from simeonwillbanks/simple-dependency-management
+* Add link_attr option to Autolink filter #89 from excid3/master
+* Add ActiveSupport back in as dependency for xml-mini #85 from mojavelinux/xml-mini
+
 ## 0.3.1
 
   * Guard against nil node replacement in SyntaxHighlightFilter #84 jbarnette

data/Gemfile

@@ -1,9 +1,24 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in html-pipeline.gemspec
 gemspec
 
 group :development do
-  gem 'bundler'
-  gem 'rake'
+  gem "bundler"
+  gem "rake"
+end
+
+group :test do
+  gem "rinku",            "~> 1.7",   :require => false
+  gem "gemoji",           "~> 1.0",   :require => false
+  gem "RedCloth",         "~> 4.2.9", :require => false
+  gem "escape_utils",     "~> 0.3",   :require => false
+  gem "github-linguist",  "~> 2.6.2", :require => false
+  gem "github-markdown",  "~> 0.5",   :require => false
+
+  if RUBY_VERSION < "1.9.2"
+    gem "sanitize", ">= 2", "< 2.0.4", :require => false
+  else
+    gem "sanitize", "~> 2.0",          :require => false
+  end
 end

data/README.md

@@ -98,18 +98,38 @@ filter.call
 * `TextileFilter` - convert textile to html
 * `TableOfContentsFilter` - anchor headings with name attributes and generate Table of Contents html unordered list linking headings
 
-## Syntax highlighting
+## Dependencies
 
+Filter gem dependencies are not bundled; you must bundle the filter's gem
+dependencies. The below list details filters with dependencies. For example,
 `SyntaxHighlightFilter` uses [github-linguist](https://github.com/github/linguist)
-to detect and highlight languages. It isn't included as a dependency by default
-because it's a large dependency and
-[a hassle to build on heroku](https://github.com/jch/html-pipeline/issues/33).
-To use the filter, add the following to your Gemfile:
+to detect and highlight languages. For example, to use the `SyntaxHighlightFilter`,
+add the following to your Gemfile:
 
 ```ruby
 gem 'github-linguist'
 ```
 
+* `AutolinkFilter` - `rinku`
+* `EmailReplyFilter` - `escape_utils`
+* `EmojiFilter` - `gemoji`
+* `MarkdownFilter` - `github-markdown`
+* `PlainTextInputFilter` - `escape_utils`
+* `SanitizationFilter` - `sanitize`
+* `SyntaxHighlightFilter` - `github-linguist`
+* `TextileFilter` - `RedCloth`
+
+_Note:_ See [Gemfile](/Gemfile) `:test` block for version requirements.
+
+## 3rd Party Extensions
+
+If you have an idea for a filter, propose it as
+[an issue](https://github.com/jch/html-pipeline/issues) first. This allows us discuss
+whether the filter is a common enough use case to belong in this gem, or should be
+built as an external gem.
+
+* [html-pipeline-asciidoc_filter](https://github.com/asciidoctor/html-pipeline-asciidoc_filter) - asciidoc support
+
 ## Examples
 
 We define different pipelines for different parts of our app. Here are a few

data/bin/html-pipeline

@@ -54,8 +54,6 @@ else
     case name
     when "Text"
       raise NameError # Text filter doesn't work, no call method
-    when "Textile"
-      require "RedCloth" # Textile filter doesn't require RedCloth
     end
 
     HTML::Pipeline.const_get("#{name}Filter")
@@ -77,4 +75,4 @@ context = {
   :gfm        => true
 }
 
-puts HTML::Pipeline.new(filters, context).call(ARGF.read)[:output]
+puts HTML::Pipeline.new(filters, context).call(ARGF.read)[:output]

data/html-pipeline.gemspec

@@ -15,13 +15,15 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^test})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "gemoji",          "~> 1.0"
-  gem.add_dependency "nokogiri",        RUBY_VERSION < "1.9.2" ? [">= 1.4", "< 1.6"] : "~> 1.4"
-  gem.add_dependency "github-markdown", "~> 0.5"
-  gem.add_dependency "sanitize",        RUBY_VERSION < "1.9.2" ? [">= 2", "< 2.0.4"] : "~> 2.0"
-  gem.add_dependency "rinku",           "~> 1.7"
-  gem.add_dependency "escape_utils",    "~> 0.3"
+  gem.add_dependency "nokogiri",      RUBY_VERSION < "1.9.2" ? [">= 1.4", "< 1.6"] : "~> 1.4"
+  gem.add_dependency "activesupport", RUBY_VERSION < "1.9.3" ? [">= 2", "< 4"] : ">= 2"
 
-  gem.add_development_dependency "activesupport", RUBY_VERSION < "1.9.3" ? [">= 2", "< 4"] : ">= 2"
-  gem.add_development_dependency "github-linguist", "~> 2.6.2"
+  gem.post_install_message = <<msg
+-------------------------------------------------
+Thank you for installing html-pipeline!
+You must bundle Filter gem dependencies.
+See html-pipeline README.md for more details.
+https://github.com/jch/html-pipeline#dependencies
+-------------------------------------------------
+msg
 end

data/lib/html/pipeline.rb

@@ -1,6 +1,5 @@
 require "nokogiri"
 require "active_support/xml_mini/nokogiri" # convert Documents to hashes
-require "escape_utils"
 
 module HTML
   # GitHub HTML processing filters and utilities. This module includes a small

data/lib/html/pipeline/autolink_filter.rb

@@ -1,4 +1,8 @@
-require 'rinku'
+begin
+  require "rinku"
+rescue LoadError => _
+  abort "Missing dependency 'rinku' for AutolinkFilter. See README.md for details."
+end
 
 module HTML
   class Pipeline
@@ -6,6 +10,7 @@ module HTML
     #
     # Context options:
     #   :autolink  - boolean whether to autolink urls
+    #   :link_attr - HTML attributes for the link that will be generated
     #   :skip_tags - HTML tags inside which autolinking will be skipped.
     #                See Rinku.skip_tags
     #   :flags     - additional Rinku flags. See https://github.com/vmg/rinku
@@ -19,7 +24,7 @@ module HTML
         flags = 0
         flags |= context[:flags] if context[:flags]
 
-        Rinku.auto_link(html, :urls, nil, skip_tags, flags)
+        Rinku.auto_link(html, :urls, context[:link_attr], skip_tags, flags)
       end
     end
   end

data/lib/html/pipeline/email_reply_filter.rb

@@ -1,3 +1,9 @@
+begin
+  require "escape_utils"
+rescue LoadError => _
+  abort "Missing dependency 'escape_utils' for EmailReplyFilter. See README.md for details."
+end
+
 module HTML
   class Pipeline
     # HTML Filter that converts email reply text into an HTML DocumentFragment.
@@ -53,4 +59,4 @@ module HTML
       end
     end
   end
-end
+end

data/lib/html/pipeline/emoji_filter.rb

@@ -1,4 +1,8 @@
-require 'emoji'
+begin
+  require "gemoji"
+rescue LoadError => _
+  abort "Missing dependency 'gemoji' for EmojiFilter. See README.md for details."
+end
 
 module HTML
   class Pipeline
@@ -51,4 +55,4 @@ module HTML
       end
     end
   end
-end
+end

data/lib/html/pipeline/markdown_filter.rb

@@ -1,4 +1,8 @@
-require 'github/markdown'
+begin
+  require "github/markdown"
+rescue LoadError => _
+  abort "Missing dependency 'github-markdown' for MarkdownFilter. See README.md for details."
+end
 
 module HTML
   class Pipeline
@@ -26,4 +30,4 @@ module HTML
       end
     end
   end
-end
+end

data/lib/html/pipeline/plain_text_input_filter.rb

@@ -1,3 +1,9 @@
+begin
+  require "escape_utils"
+rescue LoadError => _
+  abort "Missing dependency 'escape_utils' for PlainTextInputFilter. See README.md for details."
+end
+
 module HTML
   class Pipeline
     # Simple filter for plain text input. HTML escapes the text input and wraps it
@@ -8,4 +14,4 @@ module HTML
       end
     end
   end
-end
+end

data/lib/html/pipeline/sanitization_filter.rb

@@ -1,4 +1,8 @@
-require 'sanitize'
+begin
+  require "sanitize"
+rescue LoadError => _
+  abort "Missing dependency 'sanitize' for SanitizationFilter. See README.md for details."
+end
 
 module HTML
   class Pipeline

data/lib/html/pipeline/syntax_highlight_filter.rb

@@ -1,7 +1,7 @@
 begin
-  require 'linguist'
-rescue LoadError
-  raise LoadError, "You need to install 'github-linguist' before using the SyntaxHighlightFilter. See README.md for details"
+  require "linguist"
+rescue LoadError => _
+  abort "Missing dependency 'github-linguist' for SyntaxHighlightFilter. See README.md for details."
 end
 
 module HTML

data/lib/html/pipeline/textile_filter.rb

@@ -1,3 +1,9 @@
+begin
+  require "redcloth"
+rescue LoadError => _
+  abort "Missing dependency 'RedCloth' for TextileFilter. See README.md for details."
+end
+
 module HTML
   class Pipeline
     # HTML Filter that converts Textile text into HTML and converts into a
@@ -18,4 +24,4 @@ module HTML
       end
     end
   end
-end
+end

data/lib/html/pipeline/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Pipeline
-    VERSION = "0.3.1"
+    VERSION = "1.0.0"
   end
 end

data/test/html/pipeline/autolink_filter_test.rb

@@ -15,6 +15,11 @@ class HTML::Pipeline::AutolinkFilterTest < Test::Unit::TestCase
       AutolinkFilter.to_html('<p>"http://www.github.com"</p>', :autolink => false)
   end
 
+  def test_autolink_link_attr
+    assert_equal '<p>"<a href="http://www.github.com" target="_blank">http://www.github.com</a>"</p>',
+      AutolinkFilter.to_html('<p>"http://www.github.com"</p>', :link_attr => 'target="_blank"')
+  end
+
   def test_autolink_flags
     assert_equal '<p>"<a href="http://github">http://github</a>"</p>',
       AutolinkFilter.to_html('<p>"http://github"</p>', :flags => Rinku::AUTOLINK_SHORT_DOMAINS)

data/test/test_helper.rb

@@ -2,6 +2,7 @@ require 'bundler/setup'
 require 'html/pipeline'
 require 'test/unit'
 
+require 'active_support/core_ext/string'
 require 'active_support/core_ext/object/try'
 
 module TestHelpers
@@ -35,4 +36,4 @@ module TestHelpers
   end
 end
 
-Test::Unit::TestCase.send(:include, TestHelpers)
+Test::Unit::TestCase.send(:include, TestHelpers)

metadata

@@ -1,175 +1,52 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: html-pipeline
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 1
-  version: 0.3.1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Ryan Tomayko
 - Jerry Cheung
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-09-16 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
-  type: :runtime
-  name: gemoji
-  version_requirements: *id001
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        version: "1.4"
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
-  type: :runtime
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  version_requirements: *id002
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 5
-        version: "0.5"
-  type: :runtime
-  name: github-markdown
-  version_requirements: *id003
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        version: "2"
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 0
-        - 4
-        version: 2.0.4
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
-  name: sanitize
-  version_requirements: *id004
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 7
-        version: "1.7"
-  type: :runtime
-  name: rinku
-  version_requirements: *id005
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 3
-        version: "0.3"
-  type: :runtime
-  name: escape_utils
-  version_requirements: *id006
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        version: "2"
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 4
-        version: "4"
-  type: :development
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
   name: activesupport
-  version_requirements: *id007
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 2
-        - 6
-        - 2
-        version: 2.6.2
-  type: :development
-  name: github-linguist
-  version_requirements: *id008
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2'
 description: GitHub HTML processing filters and utilities
-email: 
+email:
 - ryan@github.com
 - jerry@github.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
@@ -212,41 +89,37 @@ files:
 - test/html/pipeline/toc_filter_test.rb
 - test/html/pipeline_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: https://github.com/jch/html-pipeline
-licenses: 
+licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message: |
+  -------------------------------------------------
+  Thank you for installing html-pipeline!
+  You must bundle Filter gem dependencies.
+  See html-pipeline README.md for more details.
+  https://github.com/jch/html-pipeline#dependencies
+  -------------------------------------------------
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+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: 1.6.2
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Helpers for processing content through a chain of filters
-test_files: 
+test_files:
 - test/helpers/mocked_instrumentation_service.rb
 - test/html/pipeline/absolute_source_filter_test.rb
 - test/html/pipeline/autolink_filter_test.rb