html-pipeline 0.0.14 → 0.1.0

data/.travis.yml

@@ -10,4 +10,5 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ree
+  - 2.0.0
+  - ree

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 0.1.0
+
+I realized I wasn't properly following [semver](http://semver.org) for interface
+changes and new features. Starting from this release, semver will be followed.
+
+  * Whitelist table section elements in sanitization filter #55 mojavelinux
+  * Update readme typo #57 envygeeks
+  * TOC unicode characters and anchor names for Ruby > 1.9 #64 jakedouglas/non_english_anchors
+  * Add :skip_tags option for AutolinkFilter #65 pengwynn
+  * Fix CI dependency issues #67 jch
+  * Fix ignored test and add Ruby 2.0 to CI. #71, #72 tricknotes
+
 ## 0.0.14
 
   * Remove unused can_access_repo? method jch

data/README.md

@@ -85,7 +85,7 @@ filter.call
 
 * `MentionFilter` - replace `@user` mentions with links
 * `AbsoluteSourceFilter` - replace relative image urls with fully qualified versions
-* `AutoLinkFilter` - auto_linking urls in HTML
+* `AutolinkFilter` - auto_linking urls in HTML
 * `CamoFilter` - replace http image urls with [camo-fied](https://github.com/atmos/camo) https versions
 * `EmailReplyFilter` - util filter for working with emails
 * `EmojiFilter` - everyone loves [emoji](http://www.emoji-cheat-sheet.com/)!

data/html-pipeline.gemspec

@@ -16,12 +16,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "gemoji",          "~> 1.0"
-  gem.add_dependency "nokogiri",        "~> 1.4"
+  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",        "~> 2.0"
+  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 "activesupport",   ">= 2"
+  gem.add_dependency "activesupport",   RUBY_VERSION < "1.9.3" ? [">= 2", "< 4"] : ">= 2"
 
   gem.add_development_dependency "github-linguist", "~> 2.6.2"
 end

data/lib/html/pipeline/autolink_filter.rb

@@ -5,18 +5,22 @@ module HTML
     # HTML Filter for auto_linking urls in HTML.
     #
     # Context options:
-    #   :autolink - boolean whether to autolink urls
-    #   :flags    - additional Rinku flags. See https://github.com/vmg/rinku
+    #   :autolink  - boolean whether to autolink urls
+    #   :skip_tags - HTML tags inside which autolinking will be skipped.
+    #                See Rinku.skip_tags
+    #   :flags     - additional Rinku flags. See https://github.com/vmg/rinku
     #
     # This filter does not write additional information to the context.
     class AutolinkFilter < Filter
       def call
         return html if context[:autolink] == false
+
+        skip_tags = context[:skip_tags]
         flags = 0
         flags |= context[:flags] if context[:flags]
 
-        Rinku.auto_link(html, :urls, nil, %w[a script kbd pre code], flags)
+        Rinku.auto_link(html, :urls, nil, skip_tags, flags)
       end
     end
   end
-end
+end

data/lib/html/pipeline/sanitization_filter.rb

@@ -25,15 +25,16 @@ module HTML
       # of places we're using tables to contain formatted user content (like pull
       # request review comments).
       TABLE_ITEMS = Set.new(%w(tr td th).freeze)
-      TABLE       = 'table'.freeze
+      TABLE = 'table'.freeze
+      TABLE_SECTIONS = Set.new(%w(thead tbody tfoot).freeze)
 
       # The main sanitization whitelist. Only these elements and attributes are
       # allowed through by default.
       WHITELIST = {
         :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 blockquote dl dt dd
-          kbd q samp var hr ruby rt rp li tr td th
+          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
         ),
         :remove_contents => ['script'],
         :attributes => {
@@ -75,7 +76,7 @@ module HTML
           # Table child elements that are not contained by a <table> are removed.
           lambda { |env|
             name, node = env[:node_name], env[:node]
-            if TABLE_ITEMS.include?(name) && !node.ancestors.any? { |n| n.name == TABLE }
+            if (TABLE_SECTIONS.include?(name) || TABLE_ITEMS.include?(name)) && !node.ancestors.any? { |n| n.name == TABLE }
               node.replace(node.children)
             end
           }
@@ -103,4 +104,4 @@ module HTML
       end
     end
   end
-end
+end

data/lib/html/pipeline/syntax_highlight_filter.rb

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

data/lib/html/pipeline/toc_filter.rb

@@ -7,13 +7,14 @@ module HTML
     # eventually generating the Table of Contents itself, with links
     # to each header
     class TableOfContentsFilter < Filter
+      PUNCTUATION_REGEXP = RUBY_VERSION > "1.9" ? /[^\p{Word}\- ]/u : /[^\w\- ]/
+
       def call
         headers = Hash.new(0)
         doc.css('h1, h2, h3, h4, h5, h6').each do |node|
           name = node.text.downcase
-          name.gsub!(/[^\w\- ]/, '') # remove punctuation
+          name.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
           name.gsub!(' ', '-') # replace spaces with dash
-          name = EscapeUtils.escape_uri(name) # escape extended UTF-8 chars
 
           uniq = (headers[name] > 0) ? "-#{headers[name]}" : ''
           headers[name] += 1
@@ -25,4 +26,4 @@ module HTML
       end
     end
   end
-end
+end

data/lib/html/pipeline/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Pipeline
-    VERSION = "0.0.14"
+    VERSION = "0.1.0"
   end
 end

data/test/html/pipeline/absolute_source_filter_test.rb

@@ -12,14 +12,13 @@ class HTML::Pipeline::AbsoluteSourceFilterTest < Test::Unit::TestCase
     }
   end
 
-  def test_rewrites_root_relative_urls
+  def test_rewrites_root_urls
     orig = %(<p><img src="/img.png"></p>)
-    puts AbsoluteSourceFilter.call(orig, @options).to_s
     assert_equal "<p><img src=\"#{@image_base_url}/img.png\"></p>",
       AbsoluteSourceFilter.call(orig, @options).to_s
   end
 
-  def test_rewrites_root_relative_urls
+  def test_rewrites_relative_urls
     orig = %(<p><img src="post/img.png"></p>)
     assert_equal "<p><img src=\"#{@image_subpage_url}/img.png\"></p>",
       AbsoluteSourceFilter.call(orig, @options).to_s

data/test/html/pipeline/autolink_filter_test.rb

@@ -19,4 +19,12 @@ class HTML::Pipeline::AutolinkFilterTest < Test::Unit::TestCase
     assert_equal '<p>"<a href="http://github">http://github</a>"</p>',
       AutolinkFilter.to_html('<p>"http://github"</p>', :flags => Rinku::AUTOLINK_SHORT_DOMAINS)
   end
+
+  def test_autolink_skip_tags
+    assert_equal '<code>"http://github.com"</code>',
+      AutolinkFilter.to_html('<code>"http://github.com"</code>')
+
+    assert_equal '<code>"<a href="http://github.com">http://github.com</a>"</code>',
+      AutolinkFilter.to_html('<code>"http://github.com"</code>', :skip_tags => %w(kbd script))
+  end
 end

data/test/html/pipeline/sanitization_filter_test.rb

@@ -49,4 +49,23 @@ class HTML::Pipeline::SanitizationFilterTest < Test::Unit::TestCase
     orig = '<script>JavaScript!</script>'
     assert_equal "", SanitizationFilter.call(orig).to_s
   end
+
+  def test_table_rows_and_cells_removed_if_not_in_table
+    orig = %(<tr><td>Foo</td></tr><td>Bar</td>)
+    assert_equal 'FooBar', SanitizationFilter.call(orig).to_s
+  end
+
+  def test_table_sections_removed_if_not_in_table
+    orig = %(<thead><tr><td>Foo</td></tr></thead>)
+    assert_equal 'Foo', SanitizationFilter.call(orig).to_s
+  end
+
+  def test_table_sections_are_not_removed
+    orig = %(<table>
+<thead><tr><th>Column 1</th></tr></thead>
+<tfoot><tr><td>Sum</td></tr></tfoot>
+<tbody><tr><td>1</td></tr></tbody>
+</table>)
+    assert_equal orig, SanitizationFilter.call(orig).to_s
+  end
 end

data/test/html/pipeline/toc_filter_test.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require "test_helper"
 
 class HTML::Pipeline::TableOfContentsFilterTest < Test::Unit::TestCase
@@ -42,6 +43,16 @@ class HTML::Pipeline::TableOfContentsFilterTest < Test::Unit::TestCase
     doc = TocFilter.call(orig)
     assert_equal 6, doc.search('a').size
   end
-end
 
+  def test_anchors_with_utf8_characters
+    orig = %(<h1>日本語</h1>
+             <h1>Русский</h1)
+
+    rendered_h1s = TocFilter.call(orig).search('h1').map(&:to_s)
 
+    assert_equal "<h1>\n<a name=\"%E6%97%A5%E6%9C%AC%E8%AA%9E\" class=\"anchor\" href=\"#%E6%97%A5%E6%9C%AC%E8%AA%9E\"><span class=\"octicon octicon-link\"></span></a>日本語</h1>",
+                 rendered_h1s[0]
+    assert_equal "<h1>\n<a name=\"%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9\" class=\"anchor\" href=\"#%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9\"><span class=\"octicon octicon-link\"></span></a>Русский</h1>",
+                 rendered_h1s[1]
+  end if RUBY_VERSION > "1.9" # not sure how to make this work on 1.8.7
+end

metadata

@@ -1,153 +1,175 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: html-pipeline
-version: !ruby/object:Gem::Version
-  version: 0.0.14
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Ryan Tomayko
 - Jerry Cheung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-07-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: gemoji
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.4'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: github-markdown
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.5'
+    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
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: github-markdown
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: sanitize
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sanitize
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rinku
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
+    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
   type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rinku
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: escape_utils
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.3'
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        version: "1.7"
   type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: escape_utils
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2'
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
   type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: activesupport
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 4
+        version: "4"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: github-linguist
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.6.2
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 6
+        - 2
         version: 2.6.2
+  type: :development
+  version_requirements: *id008
 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
@@ -189,32 +211,41 @@ 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: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 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