html-pipeline 1.11.0 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e02d528270e77bac532de323b85833d8cd1e291f
-  data.tar.gz: 34b71d6b7e4cc37953be770f478f4c8a61406494
+  metadata.gz: 81ea1429ab17d2b994718b0332f25cca4587258e
+  data.tar.gz: 1e88eb99b9689beaa37be9f07dd337b587e7f6de
 SHA512:
-  metadata.gz: bce2524133b63fd81edb803e16e4f33be361a02bbec16c1be5d81bb045b0fc85df90e380e0a1b36b9ae37beb06b2f08302f8ed964bd6ff2138fee1d798992db0
-  data.tar.gz: 0dd07655ca6e4efd6bfe74be9282722c52add045543f34b26c4fdb5a4cec7d32687d7d43d03854e0477c3db1479adbdf27b33b6860334f52bffbf78931665743
+  metadata.gz: 53dcb279bc816247b352642d0037dfdf7200622f8ec81e0f4e7e2f16f93dfb1131a159274cac6cd37822b6b9486f4160d20e78ec439a4a3a4731d10da23b60a7
+  data.tar.gz: 435e84847668fac1e7f8ea78e6dac82b7e646885523440ce57dc19e711e69875a1b2b0eca5aade300dbbefe0a5c064f4af66a7dbaa5af1d48a0ad1f9ba5b1d7d

data/.travis.yml

@@ -7,13 +7,12 @@ before_install:
 script: "bundle exec rake"
 
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - ree
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
 
 matrix:
   fast_finish: true
   allow_failures:
-    - rvm: ree
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -1,9 +1,30 @@
 # CHANGELOG
 
+## 2.0
+
+**New**
+
+* Implement new EmojiFilter context option: ignored_ancestor_tags to accept more ignored tags. [#170](https://github.com/jch/html-pipeline/pull/170) @JuanitoFatas
+* Add GitHub flavor Markdown Task List extension [#162](https://github.com/jch/html-pipeline/pull/162) @simeonwillbanks
+* @mention allow for custom regex to identify usernames. [#157](https://github.com/jch/html-pipeline/pull/157) @brittballard
+* EmojiFilter now requires gemoji ~> 2. [#159](https://github.com/jch/html-pipeline/pull/159) @jch
+
+**Changes**
+
+* Restrict nokogiri to >= 1.4, <= 1.6.5 [#176](https://github.com/jch/html-pipeline/pull/176) @simeonwillbanks
+* MentionFilter#link_to_mentioned_user: Replace String introspection with Regexp match [#172](https://github.com/jch/html-pipeline/pull/172) @simeonwillbanks
+* Whitelist summary and details element. [#171](https://github.com/jch/html-pipeline/pull/171) @JuanitoFatas
+* Support ~login for MentionFilter. [#167](https://github.com/jch/html-pipeline/pull/167) @JuanitoFatas
+* Revert "Search for text nodes on DocumentFragments without root tags" [#158](https://github.com/jch/html-pipeline/pull/158) @jch
+* Drop support for ruby ree, 1.9.2, 1.9.3 [#156](https://github.com/jch/html-pipeline/pull/156) @jch
+* Skip EmojiFilter in `<tt>` tags [#147](https://github.com/jch/html-pipeline/pull/147) @moskvax
+* Use Linguist lexers [#153](https://github.com/jch/html-pipeline/pull/153) @pchaigno
+* Constrain Active Support >= 2, < 5 [#180](https://github.com/jch/html-pipeline/pull/180) @jch
+
 ## 1.11.0
 
   * Search for text nodes on DocumentFragments without root tags #146 Razer6
-  * Don't filter @mentions in <style> tags #145 jch
+  * Don't filter @mentions in `<style>` tags #145 jch
   * Prefer `http_url` in HttpsFilter. `base_url` still works. #142 bkeepers
   * Remove duplicate check in EmojiFilter #141 Razer6
 

data/Gemfile

@@ -11,10 +11,11 @@ end
 group :test do
   gem "minitest",           "~> 5.3"
   gem "rinku",              "~> 1.7",   :require => false
-  gem "gemoji",             "~> 1.0",   :require => false
+  gem "gemoji",             "~> 2.0",   :require => false
   gem "RedCloth",           "~> 4.2.9", :require => false
   gem "github-markdown",    "~> 0.5",   :require => false
   gem "email_reply_parser", "~> 0.5",   :require => false
+  gem "sanitize",           "~> 2.0",   :require => false
 
   if RUBY_VERSION < "2.1.0"
     gem "escape_utils",     "~> 0.3",   :require => false
@@ -24,13 +25,6 @@ group :test do
     gem "github-linguist",  "~> 2.10",  :require => false
   end
 
-  if RUBY_VERSION < "1.9.2"
-    gem "sanitize", ">= 2", "< 2.0.4", :require => false
-    gem "nokogiri", ">= 1.4", "< 1.6"
-  else
-    gem "sanitize", "~> 2.0",          :require => false
-  end
-
   if RUBY_VERSION < "1.9.3"
     gem "activesupport", ">= 2", "< 4"
   end

data/README.md

@@ -1,4 +1,4 @@
-# HTML::Pipeline [![Build Status](https://secure.travis-ci.org/jch/html-pipeline.png)](http://travis-ci.org/jch/html-pipeline)
+# HTML::Pipeline [![Build Status](https://travis-ci.org/jch/html-pipeline.svg?branch=master)](https://travis-ci.org/jch/html-pipeline)
 
 GitHub HTML processing filters and utilities. This module includes a small
 framework for defining DOM based content filters and applying them to user
@@ -78,10 +78,8 @@ Prints:
 ```html
 <p>This is <em>great</em>:</p>
 
-<div class="highlight">
-<pre><span class="n">some_code</span><span class="p">(</span><span class="ss">:first</span><span class="p">)</span>
-</pre>
-</div>
+<pre><code>some_code(:first)
+</code></pre>
 ```
 
 To generate CSS for HTML formatted code, use the [pygments.rb](https://github.com/tmm1/pygments.rb#usage) `#css` method. `pygments.rb` is a dependency of the `SyntaxHighlightFilter`.
@@ -141,6 +139,7 @@ NonGFMMarkdownPipeline = Pipeline.new(MarkdownPipeline.filters,
 # Pipelines aren't limited to the web. You can use them for email
 # processing also.
 HtmlEmailPipeline = Pipeline.new [
+  PlainTextInputFilter,
   ImageMaxWidthFilter
 ], {}
 
@@ -233,7 +232,19 @@ If you have an idea for a filter, propose it as
 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
+Here are some extensions people have built:
+
+* [html-pipeline-asciidoc_filter](https://github.com/asciidoctor/html-pipeline-asciidoc_filter)
+* [jekyll-html-pipeline](https://github.com/gjtorikian/jekyll-html-pipeline)
+* [nanoc-html-pipeline](https://github.com/burnto/nanoc-html-pipeline)
+* [html-pipeline-bity](https://github.com/dewski/html-pipeline-bitly)
+* [html-pipeline-cite](https://github.com/lifted-studios/html-pipeline-cite)
+* [tilt-html-pipeline](https://github.com/bradgessler/tilt-html-pipeline)
+* [html-pipeline-wiki-link'](https://github.com/lifted-studios/html-pipeline-wiki-link) - WikiMedia-style wiki links
+* [task_list](https://github.com/github/task_list) - GitHub flavor Markdown Task List
+* [html-pipeline-rouge_filter](https://github.com/JuanitoFatas/html-pipeline-rouge_filter) - Syntax highlight with [Rouge](https://github.com/jneen/rouge/)
+* [html-pipeline-nico_link](https://github.com/rutan/html-pipeline-nico_link) - An HTML::Pipeline filter for [niconico](http://www.nicovideo.jp) description links
+* [html-pipeline-gitlab](https://gitlab.com/gitlab-org/html-pipeline-gitlab) - This gem implements various filters for html-pipeline used by GitLab
 
 ## Instrumenting
 
@@ -285,6 +296,36 @@ service.subscribe "call_pipeline.html_pipeline" do |event, start, ending, transa
 end
 ```
 
+## FAQ
+
+### 1. Why doesn't my pipeline work when there's no root element in the document?
+
+To make a pipeline work on a plain text document, put the `PlainTextInputFilter`
+at the beginning of your pipeline. This will wrap the content in a `div` so the
+filters have a root element to work with. If you're passing in an HTML fragment,
+but it doesn't have a root element, you can wrap the content in a `div`
+yourself. For example:
+
+```ruby
+EmojiPipeline = Pipeline.new [
+  PlainTextInputFilter,  # <- Wraps input in a div and escapes html tags
+  EmojiFilter
+], context
+
+plain_text = "Gutentag! :wave:"
+EmojiPipeline.call(plain_text)
+
+html_fragment = "This is outside of an html element, but <strong>this isn't. :+1:</strong>"
+EmojiPipeline.call("<div>#{html_fragment}</div>") # <- Wrap your own html fragments to avoid escaping
+```
+
+### 2. How do I customize a whitelist for `SanitizationFilter`s?
+
+`SanitizationFilter::WHITELIST` is the default whitelist used if no `:whitelist`
+argument is given in the context. The default is a good starting template for
+you to add additional elements. You can either modify the constant's value, or
+re-define your own constant and pass that in via the context.
+
 ## Contributing
 
 Please review the [Contributing Guide](https://github.com/jch/html-pipeline/blob/master/CONTRIBUTING.md).
@@ -307,6 +348,9 @@ Project is a member of the [OSS Manifesto](http://ossmanifesto.org/).
 
 This section is for gem maintainers to cut a new version of the gem.
 
-* update lib/html/pipeline/version.rb to next version number X.X.X following [semver](http://semver.org).
-* update CHANGELOG.md. Get latest changes with `git log --oneline vLAST_RELEASE..HEAD | grep Merge`
+* create a new branch named `release-x.y.z` where `x.y.z` follows [semver](http://semver.org)
+* update lib/html/pipeline/version.rb to next version number X.X.X
+* update CHANGELOG.md. Prepare a draft with `script/changelog`
+* push branch and create a new pull request
+* after tests are green, merge to master
 * on the master branch, run `script/release`

data/html-pipeline.gemspec

@@ -15,8 +15,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^test})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "nokogiri", "~> 1.4"
-  gem.add_dependency "activesupport", ">= 2"
+  gem.add_dependency "nokogiri", [">= 1.4", "<= 1.6.5"]
+  gem.add_dependency "activesupport", [">= 2", "< 5"]
 
   gem.post_install_message = <<msg
 -------------------------------------------------

data/lib/html/pipeline/@mention_filter.rb

@@ -11,6 +11,8 @@ module HTML
     #               mention.
     #   :info_url - Used to link to "more info" when someone mentions @mention
     #               or @mentioned.
+    #   :username_pattern - Used to provide a custom regular expression to
+    #                       identify usernames
     #
     class MentionFilter < Filter
       # Public: Find user @mentions in text.  See
@@ -27,25 +29,31 @@ module HTML
       # the original text.
       #
       # Returns a String replaced with the return of the block.
-      def self.mentioned_logins_in(text)
-        text.gsub MentionPattern do |match|
+      def self.mentioned_logins_in(text, username_pattern=UsernamePattern)
+        text.gsub MentionPatterns[username_pattern] do |match|
           login = $1
           yield match, login, MentionLogins.include?(login.downcase)
         end
       end
 
-      # Pattern used to extract @mentions from text.
-      MentionPattern = /
-        (?:^|\W)                   # beginning of string or non-word char
-        @((?>[a-z0-9][a-z0-9-]*))  # @username
-        (?!\/)                     # without a trailing slash
-        (?=
-          \.+[ \t\W]|              # dots followed by space or non-word character
-          \.+$|                    # dots at end of line
-          [^0-9a-zA-Z_.]|          # non-word character except dot
-          $                        # end of line
-        )
-      /ix
+      # Hash that contains all of the mention patterns used by the pipeline
+      MentionPatterns = Hash.new do |hash, key|
+        hash[key] = /
+          (?:^|\W)                    # beginning of string or non-word char
+          @((?>#{key}))  # @username
+          (?!\/)                      # without a trailing slash
+          (?=
+            \.+[ \t\W]|               # dots followed by space or non-word character
+            \.+$|                     # dots at end of line
+            [^0-9a-zA-Z_.]|           # non-word character except dot
+            $                         # end of line
+          )
+        /ix
+      end
+
+      # Default pattern used to extract usernames from text. The value can be
+      # overriden by providing the username_pattern variable in the context.
+      UsernamePattern = /[a-z0-9][a-z0-9-]*/
 
       # List of username logins that, when mentioned, link to the blog post
       # about @mentions instead of triggering a real mention.
@@ -62,11 +70,11 @@ module HTML
       def call
         result[:mentioned_usernames] ||= []
 
-        search_text_nodes(doc).each do |node|
+        doc.search('text()').each do |node|
           content = node.to_html
           next if !content.include?('@')
           next if has_ancestor?(node, IGNORE_PARENTS)
-          html = mention_link_filter(content, base_url, info_url)
+          html = mention_link_filter(content, base_url, info_url, username_pattern)
           next if html == content
           node.replace(html)
         end
@@ -79,6 +87,10 @@ module HTML
         context[:info_url] || nil
       end
 
+      def username_pattern
+        context[:username_pattern] || UsernamePattern
+      end
+
       # Replace user @mentions in text with links to the mentioned user's
       # profile page.
       #
@@ -86,11 +98,13 @@ module HTML
       # base_url  - The base URL used to construct user profile URLs.
       # info_url  - The "more info" URL used to link to more info on @mentions.
       #             If nil we don't link @mention or @mentioned.
+      # username_pattern  - Regular expression used to identify usernames in
+      #                     text
       #
       # Returns a string with @mentions replaced with links. All links have a
       # 'user-mention' class name attached for styling.
-      def mention_link_filter(text, base_url='/', info_url=nil)
-        self.class.mentioned_logins_in(text) do |match, login, is_mentioned|
+      def mention_link_filter(text, base_url='/', info_url=nil, username_pattern)
+        self.class.mentioned_logins_in(text, username_pattern) do |match, login, is_mentioned|
           link =
             if is_mentioned
               link_to_mention_info(login, info_url)
@@ -111,8 +125,11 @@ module HTML
 
       def link_to_mentioned_user(login)
         result[:mentioned_usernames] |= [login]
-        url = File.join(base_url, login)
-        "<a href='#{url}' class='user-mention'>" +
+
+        url = base_url.dup
+        url << "/" unless url =~ /[\/~]\z/
+
+        "<a href='#{url << login}' class='user-mention'>" +
         "@#{login}" +
         "</a>"
       end

data/lib/html/pipeline/emoji_filter.rb

@@ -13,19 +13,23 @@ module HTML
     # Context:
     #   :asset_root (required) - base url to link to emoji sprite
     #   :asset_path (optional) - url path to link to emoji sprite. :file_name can be used as a placeholder for the sprite file name. If no asset_path is set "emoji/:file_name" is used.
+    #   :ignored_ancestor_tags (optional) - Tags to stop the emojification. Node has matched ancestor HTML tags will not be emojified. Default to pre, code, and tt tags. Extra tags please pass in the form of array, e.g., %w(blockquote summary).
     class EmojiFilter < Filter
+
+      DEFAULT_IGNORED_ANCESTOR_TAGS = %w(pre code tt).freeze
+
       def call
-        search_text_nodes(doc).each do |node|
+        doc.search('text()').each do |node|
           content = node.to_html
           next unless content.include?(':')
-          next if has_ancestor?(node, %w(pre code))
+          next if has_ancestor?(node, ignored_ancestor_tags)
           html = emoji_image_filter(content)
           next if html == content
           node.replace(html)
         end
         doc
       end
-      
+
       # Implementation of validate hook.
       # Errors should raise exceptions or use an existing validator.
       def validate
@@ -79,23 +83,22 @@ module HTML
         self.class.emoji_pattern
       end
 
-      # Detect gemoji v2 which has a new API
-      # https://github.com/jch/html-pipeline/pull/129
-      if Emoji.respond_to?(:all)
-        def self.emoji_names
-          Emoji.all.map(&:aliases).flatten.sort
-        end
+      def self.emoji_names
+        Emoji.all.map(&:aliases).flatten.sort
+      end
 
-        def emoji_filename(name)
-          Emoji.find_by_alias(name).image_filename
-        end
-      else
-        def self.emoji_names
-          Emoji.names
-        end
+      def emoji_filename(name)
+        Emoji.find_by_alias(name).image_filename
+      end
 
-        def emoji_filename(name)
-          "#{::CGI.escape(name)}.png"
+      # Return ancestor tags to stop the emojification.
+      #
+      # @return [Array<String>] Ancestor tags.
+      def ignored_ancestor_tags
+        if context[:ignored_ancestor_tags]
+          DEFAULT_IGNORED_ANCESTOR_TAGS | context[:ignored_ancestor_tags]
+        else
+          DEFAULT_IGNORED_ANCESTOR_TAGS
         end
       end
     end

data/lib/html/pipeline/filter.rb

@@ -59,13 +59,6 @@ module HTML
         @doc ||= parse_html(html)
       end
 
-      # Searches a Nokogiri::HTML::DocumentFragment for text nodes. If no elements
-      # are found, a second search without root tags is invoked.
-      def search_text_nodes(doc)
-        nodes = doc.xpath('.//text()')
-        nodes.empty? ? doc.xpath('text()') : nodes
-      end
-
       # The String representation of the document. If a DocumentFragment was
       # provided to the Filter, it is serialized into a String when this method is
       # called.

data/lib/html/pipeline/sanitization_filter.rb

@@ -45,7 +45,7 @@ module HTML
         :elements => %w(
           h1 h2 h3 h4 h5 h6 h7 h8 br b i strong em a pre code img tt
           div ins del sup sub p ol ul table thead tbody tfoot blockquote
-          dl dt dd kbd q samp var hr ruby rt rp li tr td th s strike
+          dl dt dd kbd q samp var hr ruby rt rp li tr td th s strike summary details
         ),
         :remove_contents => ['script'],
         :attributes => {
@@ -57,13 +57,13 @@ module HTML
                     'border', 'cellpadding', 'cellspacing', 'char',
                     'charoff', 'charset', 'checked', 'cite',
                     'clear', 'cols', 'colspan', 'color',
-                    'compact', 'coords', 'datetime', 'details', 'dir',
+                    'compact', 'coords', 'datetime', 'dir',
                     'disabled', 'enctype', 'for', 'frame',
                     'headers', 'height', 'hreflang',
                     'hspace', 'ismap', 'label', 'lang',
                     'longdesc', 'maxlength', 'media', 'method',
                     'multiple', 'name', 'nohref', 'noshade',
-                    'nowrap', 'prompt', 'readonly', 'rel', 'rev',
+                    'nowrap', 'open', 'prompt', 'readonly', 'rel', 'rev',
                     'rows', 'rowspan', 'rules', 'scope',
                     'selected', 'shape', 'size', 'span',
                     'start', 'summary', 'tabindex', 'target',

data/lib/html/pipeline/syntax_highlight_filter.rb

@@ -13,7 +13,7 @@ module HTML
         doc.search('pre').each do |node|
           default = context[:highlight] && context[:highlight].to_s
           next unless lang = node['lang'] || default
-          next unless lexer = Pygments::Lexer[lang]
+          next unless lexer = lexer_for(lang)
           text = node.inner_text
 
           html = highlight_with_timeout_handling(lexer, text)
@@ -34,6 +34,10 @@ module HTML
       rescue Timeout::Error => boom
         nil
       end
+
+      def lexer_for(lang)
+        (Linguist::Language[lang] && Linguist::Language[lang].lexer) || Pygments::Lexer[lang]
+      end
     end
   end
 end

data/lib/html/pipeline/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Pipeline
-    VERSION = "1.11.0"
+    VERSION = "2.0"
   end
 end

data/script/changelog

@@ -0,0 +1,30 @@
+#!/usr/bin/env sh
+# Usage: script/changelog [-r <repo>] [-b <base>] [-h <head>]
+#
+#  repo: base string of GitHub repository url. e.g. "user_or_org/repository". Defaults to git remote url.
+#  base: git ref to compare from. e.g. "v1.3.1". Defaults to latest git tag.
+#  head: git ref to compare to. Defaults to "HEAD".
+#
+# Generate a changelog preview from pull requests merged between `base` and
+# `head`.
+#
+# https://github.com/jch/release-scripts
+set -e
+
+[ $# -eq 0 ] && set -- --help
+
+# parse args
+repo='jch/html-pipeline'
+base=$(git tag -l | sort -t. -k 1,1n -k 2,2n -k 3,3n | tail -n 1)
+head="HEAD"
+api_url="https://api.github.com"
+
+echo "# $repo $base..$head"
+echo
+
+# get merged PR's. Better way is to query the API for these, but this is easier
+for pr in $(git log --oneline $base..$head | grep "Merge pull request" | awk '{gsub("#",""); print $5}')
+do
+  # frustrated with trying to pull out the right values, fell back to ruby
+  curl -s "$api_url/repos/$repo/pulls/$pr" | ruby -rjson -e 'pr=JSON.parse(STDIN.read); puts "* #{pr[%q(title)]} [##{pr[%q(number)]}](#{pr[%q(html_url)]}) @#{pr[%q(user)][%q(login)]}"'
+done

data/test/html/pipeline/emoji_filter_test.rb

@@ -2,28 +2,22 @@ require 'test_helper'
 
 class HTML::Pipeline::EmojiFilterTest < Minitest::Test
   EmojiFilter = HTML::Pipeline::EmojiFilter
-  
+
   def test_emojify
     filter = EmojiFilter.new("<p>:shipit:</p>", {:asset_root => 'https://foo.com'})
     doc = filter.call
     assert_match "https://foo.com/emoji/shipit.png", doc.search('img').attr('src').value
   end
 
-  def test_emojify_on_string
-    filter = EmojiFilter.new(":shipit:", {:asset_root => 'https://foo.com'})
-    doc = filter.call
-    assert_match "https://foo.com/emoji/shipit.png", doc.search('img').attr('src').value
-  end
-  
   def test_uri_encoding
     filter = EmojiFilter.new("<p>:+1:</p>", {:asset_root => 'https://foo.com'})
     doc = filter.call
-    assert_match "https://foo.com/emoji/%2B1.png", doc.search('img').attr('src').value
+    assert_match "https://foo.com/emoji/unicode/1f44d.png", doc.search('img').attr('src').value
   end
-  
+
   def test_required_context_validation
-    exception = assert_raises(ArgumentError) { 
-      EmojiFilter.call("", {}) 
+    exception = assert_raises(ArgumentError) {
+      EmojiFilter.call("", {})
     }
     assert_match /:asset_root/, exception.message
   end
@@ -31,6 +25,41 @@ class HTML::Pipeline::EmojiFilterTest < Minitest::Test
   def test_custom_asset_path
     filter = EmojiFilter.new("<p>:+1:</p>", {:asset_path => ':file_name', :asset_root => 'https://foo.com'})
     doc = filter.call
-    assert_match "https://foo.com/%2B1.png", doc.search('img').attr('src').value
+    assert_match "https://foo.com/unicode/1f44d.png", doc.search('img').attr('src').value
+  end
+
+  def test_not_emojify_in_code_tags
+    body = "<code>:shipit:</code>"
+    filter = EmojiFilter.new(body, {:asset_root => 'https://foo.com'})
+    doc = filter.call
+    assert_equal body, doc.to_html
+  end
+
+  def test_not_emojify_in_tt_tags
+    body = "<tt>:shipit:</tt>"
+    filter = EmojiFilter.new(body, {:asset_root => 'https://foo.com'})
+    doc = filter.call
+    assert_equal body, doc.to_html
+  end
+
+  def test_not_emojify_in_pre_tags
+    body = "<pre>:shipit:</pre>"
+    filter = EmojiFilter.new(body, {:asset_root => 'https://foo.com'})
+    doc = filter.call
+    assert_equal body, doc.to_html
+  end
+
+  def test_not_emojify_in_custom_single_tag_foo
+    body = "<foo>:shipit:</foo>"
+    filter = EmojiFilter.new(body, {:asset_root => 'https://foo.com', ignored_ancestor_tags: %w(foo)})
+    doc = filter.call
+    assert_equal body, doc.to_html
+  end
+
+  def test_not_emojify_in_custom_multiple_tags_foo_and_bar
+    body = "<bar>:shipit:</bar>"
+    filter = EmojiFilter.new(body, {:asset_root => 'https://foo.com', ignored_ancestor_tags: %w(foo bar)})
+    doc = filter.call
+    assert_equal body, doc.to_html
   end
 end

data/test/html/pipeline/mention_filter_test.rb

@@ -1,8 +1,8 @@
 require "test_helper"
 
 class HTML::Pipeline::MentionFilterTest < Minitest::Test
-  def filter(html, base_url='/', info_url=nil)
-    HTML::Pipeline::MentionFilter.call(html, :base_url => base_url, :info_url => info_url)
+  def filter(html, base_url='/', info_url=nil, username_pattern=nil)
+    HTML::Pipeline::MentionFilter.call(html, :base_url => base_url, :info_url => info_url, :username_pattern => username_pattern)
   end
 
   def test_filtering_a_documentfragment
@@ -72,6 +72,27 @@ class HTML::Pipeline::MentionFilterTest < Minitest::Test
       filter(body, '/', 'https://github.com/blog/821').to_html
   end
 
+  def test_base_url_slash
+    body = "<p>Hi, @jch!</p>"
+    link = "<a href=\"/jch\" class=\"user-mention\">@jch</a>"
+    assert_equal "<p>Hi, #{link}!</p>",
+      filter(body, '/').to_html
+  end
+
+  def test_base_url_under_custom_route
+    body = "<p>Hi, @jch!</p>"
+    link = "<a href=\"/userprofile/jch\" class=\"user-mention\">@jch</a>"
+    assert_equal "<p>Hi, #{link}!</p>",
+      filter(body, '/userprofile').to_html
+  end
+
+  def test_base_url_slash_with_tilde
+    body = "<p>Hi, @jch!</p>"
+    link = "<a href=\"/~jch\" class=\"user-mention\">@jch</a>"
+    assert_equal "<p>Hi, #{link}!</p>",
+      filter(body, '/~').to_html
+  end
+
   MarkdownPipeline =
     HTML::Pipeline.new [
       HTML::Pipeline::MarkdownFilter,
@@ -158,4 +179,28 @@ class HTML::Pipeline::MentionFilterTest < Minitest::Test
     @body = "(We're talking 'bout @ymendel.)"
     assert_equal %w[ymendel], mentioned_usernames
   end
+
+  def test_username_pattern_can_be_customized
+    body = "<p>@_abc: test.</p>"
+    doc  = Nokogiri::HTML::DocumentFragment.parse(body)
+
+    res  = filter(doc, '/', nil, /(_[a-z]{3})/)
+
+    link = "<a href=\"/_abc\" class=\"user-mention\">@_abc</a>"
+    assert_equal "<p>#{link}: test.</p>",
+      res.to_html
+  end
+
+  def test_filter_does_not_create_a_new_object_for_default_username_pattern
+    body = "<div>@test</div>"
+    doc = Nokogiri::HTML::DocumentFragment.parse(body)
+
+    filter(doc.clone, '/', nil)
+    pattern_count = HTML::Pipeline::MentionFilter::MentionPatterns.length
+    filter(doc.clone, '/', nil)
+
+    assert_equal pattern_count, HTML::Pipeline::MentionFilter::MentionPatterns.length
+    filter(doc.clone, '/', nil, /test/)
+    assert_equal pattern_count + 1, HTML::Pipeline::MentionFilter::MentionPatterns.length
+  end
 end

data/test/html/pipeline/sanitization_filter_test.rb

@@ -127,4 +127,28 @@ class HTML::Pipeline::SanitizationFilterTest < Minitest::Test
 </table>)
     assert_equal orig, SanitizationFilter.call(orig).to_s
   end
+
+  def test_summary_tag_are_not_removed
+    orig = %(<summary>Foo</summary>)
+    assert_equal orig, SanitizationFilter.call(orig).to_s
+  end
+
+  def test_details_tag_and_open_attribute_are_not_removed
+    orig = %(<details open>Foo</details>)
+    assert_equal orig, SanitizationFilter.call(orig).to_s
+  end
+
+  def test_nested_details_tag_are_not_removed
+    orig = <<-NESTED
+      <details>
+        <summary>Foo</summary>
+        <details>
+          Bar
+          <summary>Baz</summary>
+        </details>
+        Qux
+      </details>
+    NESTED
+    assert_equal orig, SanitizationFilter.call(orig).to_s
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: '2.0'
 platform: ruby
 authors:
 - Ryan Tomayko
@@ -9,36 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: GitHub HTML processing filters and utilities
 email:
 - ryan@github.com
@@ -47,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -76,6 +88,7 @@ files:
 - lib/html/pipeline/textile_filter.rb
 - lib/html/pipeline/toc_filter.rb
 - lib/html/pipeline/version.rb
+- script/changelog
 - script/package
 - script/release
 - test/helpers/mocked_instrumentation_service.rb
@@ -109,12 +122,12 @@ 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: []