html-pipeline 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d66ab39f5d7421758fc4599939bdbb364a50b3da
-  data.tar.gz: 7f0ff92ba9e248534ce6bf8579d86e1b965f2901
+  metadata.gz: a78d7a993503d1652b0143b5c5cc5314251a1b1e
+  data.tar.gz: 1d5e8f1286c4dbb564b42824d8b950f296a18652
 SHA512:
-  metadata.gz: 6f26ca78fe3a9549c5023601919593f0f3265bab16865efac85cfe187ec2588f217f1c4e5d92e10fcef4d8417fa64eb20dc256945a7ed7cf1d1931706f790bc1
-  data.tar.gz: fbd6e5c3ce3174f467515e8ce8bdb685ef2c56878920d2c600ed7b5bf38a3b6bcfbec2cb62cc07a1e8c6ece21b223f20addccfce65100089d59b8a972d609b06
+  metadata.gz: a41f0686fe77ab68a026926840865f5ac81a3065657919724a4df3c6fe5f906125dbcd5e8b91949d8d4a666954566272cff512de81cacf5998cb61ed5970b3d1
+  data.tar.gz: 66e61ab2aba3d69f442fd537477c1350d7d1c6b2eb65aa6814c38276918162b8bb120b3a0e5c08777d08d9d23a2838734651a71600c339fbb161c0c4618e2534

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 1.10.0
+
+  * Anchor TOCFilter with id's instead of name's #140 bkeepers
+  * Add `details` to sanitization whitelist #139 tansaku
+  * Fix README spelling #137 Razer6
+  * Remove ActiveSupport `try` dependency #132 simeonwillbanks
+
 ## 1.9.0
 
   * Generalize https filter with :base_url #124 #131 rymohr

data/README.md

@@ -88,8 +88,8 @@ To generate CSS for HTML formatted code, use the [pygments.rb](https://github.co
 
 Some filters take an optional **context** and/or **result** hash. These are
 used to pass around arguments and metadata between filters in a pipeline. For
-example, if you want don't want to use GitHub formatted Markdown, you can
-pass an option in the context hash:
+example, if you don't want to use GitHub formatted Markdown, you can pass an
+option in the context hash:
 
 ```ruby
 filter = HTML::Pipeline::MarkdownFilter.new("Hi **world**!", :gfm => false)

data/lib/html/pipeline/sanitization_filter.rb

@@ -57,7 +57,7 @@ module HTML
                     'border', 'cellpadding', 'cellspacing', 'char',
                     'charoff', 'charset', 'checked', 'cite',
                     'clear', 'cols', 'colspan', 'color',
-                    'compact', 'coords', 'datetime', 'dir',
+                    'compact', 'coords', 'datetime', 'details', 'dir',
                     'disabled', 'enctype', 'for', 'frame',
                     'headers', 'height', 'hreflang',
                     'hspace', 'ismap', 'label', 'lang',

data/lib/html/pipeline/toc_filter.rb

@@ -1,6 +1,6 @@
 module HTML
   class Pipeline
-    # HTML filter that adds a 'name' attribute to all headers
+    # HTML filter that adds an 'id' attribute to all headers
     # in a document, so they can be accessed from a table of contents.
     #
     # Generates the Table of Contents, with links to each header.
@@ -21,7 +21,7 @@ module HTML
     #  result[:toc]
     #  # => "<ul class=\"section-nav\">\n<li><a href=\"#ice-cube\">...</li><ul>"
     #  result[:output].to_s
-    #  # => "<h1>\n<a name=\"ice-cube\" class=\"anchor\" href=\"#ice-cube\">..."
+    #  # => "<h1>\n<a id=\"ice-cube\" class=\"anchor\" href=\"#ice-cube\">..."
     class TableOfContentsFilter < Filter
       PUNCTUATION_REGEXP = RUBY_VERSION > "1.9" ? /[^\p{Word}\- ]/u : /[^\w\- ]/
 
@@ -31,15 +31,15 @@ module HTML
         headers = Hash.new(0)
         doc.css('h1, h2, h3, h4, h5, h6').each do |node|
           text = node.text
-          name = text.downcase
-          name.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
-          name.gsub!(' ', '-') # replace spaces with dash
+          id = text.downcase
+          id.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
+          id.gsub!(' ', '-') # replace spaces with dash
 
-          uniq = (headers[name] > 0) ? "-#{headers[name]}" : ''
-          headers[name] += 1
+          uniq = (headers[id] > 0) ? "-#{headers[id]}" : ''
+          headers[id] += 1
           if header_content = node.children.first
-            result[:toc] << %Q{<li><a href="##{name}#{uniq}">#{text}</a></li>\n}
-            header_content.add_previous_sibling(%Q{<a name="#{name}#{uniq}" class="anchor" href="##{name}#{uniq}"><span class="octicon octicon-link"></span></a>})
+            result[:toc] << %Q{<li><a href="##{id}#{uniq}">#{text}</a></li>\n}
+            header_content.add_previous_sibling(%Q{<a id="#{id}#{uniq}" class="anchor" href="##{id}#{uniq}" aria-hidden="true"><span class="octicon octicon-link"></span></a>})
           end
         end
         result[:toc] = %Q{<ul class="section-nav">\n#{result[:toc]}</ul>} unless result[:toc].empty?

data/lib/html/pipeline/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Pipeline
-    VERSION = "1.9.0"
+    VERSION = "1.10.0"
   end
 end

data/test/html/pipeline/toc_filter_test.rb

@@ -17,7 +17,7 @@ class HTML::Pipeline::TableOfContentsFilterTest < Minitest::Test
 
   def test_anchors_are_added_properly
     orig = %(<h1>Ice cube</h1><p>Will swarm on any motherfucker in a blue uniform</p>)
-    assert_includes TocFilter.call(orig).to_s, '<a name='
+    assert_includes TocFilter.call(orig).to_s, '<a id='
   end
 
   def test_toc_list_added_properly
@@ -35,6 +35,12 @@ class HTML::Pipeline::TableOfContentsFilterTest < Minitest::Test
     assert_includes result, '"mc-ren"'
   end
 
+  def test_anchors_have_aria_hidden
+    orig = "<h1>Straight Outta Compton</h1>"
+    result = TocFilter.call(orig).to_s
+    assert_includes result, 'aria-hidden="true"'
+  end
+
   def test_toc_hrefs_have_sane_values
     @orig = %(<h1>Dr Dre</h1><h1>Ice Cube</h1><h1>Eazy-E</h1><h1>MC Ren</h1>)
     assert_includes toc, '"#dr-dre"'
@@ -101,9 +107,9 @@ class HTML::Pipeline::TableOfContentsFilterTest < Minitest::Test
 
       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>",
+      assert_equal "<h1>\n<a id=\"日本語\" class=\"anchor\" href=\"#%E6%97%A5%E6%9C%AC%E8%AA%9E\" aria-hidden=\"true\"><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>",
+      assert_equal "<h1>\n<a id=\"Русский\" class=\"anchor\" href=\"#%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9\" aria-hidden=\"true\"><span class=\"octicon octicon-link\"></span></a>Русский</h1>",
                    rendered_h1s[1]
     end
 

data/test/test_helper.rb

@@ -3,7 +3,6 @@ require 'html/pipeline'
 require 'minitest/autorun'
 
 require 'active_support/core_ext/string'
-require 'active_support/core_ext/object/try'
 
 module TestHelpers
   # Asserts that two html fragments are equivalent. Attribute order

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Ryan Tomayko
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri