html-pipeline 2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81ea1429ab17d2b994718b0332f25cca4587258e
-  data.tar.gz: 1e88eb99b9689beaa37be9f07dd337b587e7f6de
+  metadata.gz: ef883e1a02e6690f3f708437f0750d38be6e26a7
+  data.tar.gz: c821156250cf94cbbf7a5d219bb6d10b3df77dbf
 SHA512:
-  metadata.gz: 53dcb279bc816247b352642d0037dfdf7200622f8ec81e0f4e7e2f16f93dfb1131a159274cac6cd37822b6b9486f4160d20e78ec439a4a3a4731d10da23b60a7
-  data.tar.gz: 435e84847668fac1e7f8ea78e6dac82b7e646885523440ce57dc19e711e69875a1b2b0eca5aade300dbbefe0a5c064f4af66a7dbaa5af1d48a0ad1f9ba5b1d7d
+  metadata.gz: 066dbba5d1a4c96b94a4eab74f0e6e1f81156362e05dec76e1b798489a8bdfb87db150bbe093b4c9e11cddc791a483d1bfbcc3ef2d0e43dec4df6f8d96b57f2c
+  data.tar.gz: 14e260bd46d314003cfd680d87f59660b584911e6646890a437afdfcf5e384f25bc06004d681886d3ae249ef3ff20ed8ddfc377e86ec5bfc0a4a5f585993d17a

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 2.1.0
+
+* Whitelist schemes for longdesc [#221](https://github.com/jch/html-pipeline/pull/221)
+* Extract emoji image tag generation to own method [#195](https://github.com/jch/html-pipeline/pull/195)
+* Update README.md [#211](https://github.com/jch/html-pipeline/pull/211)
+* Add ImageFilter for image url to img tag conversion [#207](https://github.com/jch/html-pipeline/pull/207)
+
 ## 2.0
 
 **New**

data/README.md

@@ -245,6 +245,9 @@ Here are some extensions people have built:
 * [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
+* [html-pipeline-youtube](https://github.com/st0012/html-pipeline-youtube) - An HTML::Pipeline filter for YouTube links
+* [html-pipeline-flickr](https://github.com/st0012/html-pipeline-flickr) - An HTML::Pipeline filter for Flickr links
+* [html-pipeline-vimeo](https://github.com/dlackty/html-pipeline-vimeo) - An HTML::Pipeline filter for Vimeo links
 
 ## Instrumenting
 

data/lib/html/pipeline.rb

@@ -32,6 +32,7 @@ module HTML
     autoload :EmailReplyFilter,      'html/pipeline/email_reply_filter'
     autoload :EmojiFilter,           'html/pipeline/emoji_filter'
     autoload :HttpsFilter,           'html/pipeline/https_filter'
+    autoload :ImageFilter,           'html/pipeline/image_filter'
     autoload :ImageMaxWidthFilter,   'html/pipeline/image_max_width_filter'
     autoload :MarkdownFilter,        'html/pipeline/markdown_filter'
     autoload :MentionFilter,         'html/pipeline/@mention_filter'

data/lib/html/pipeline/emoji_filter.rb

@@ -43,8 +43,7 @@ module HTML
       # Returns a String with :emoji: replaced with images.
       def emoji_image_filter(text)
         text.gsub(emoji_pattern) do |match|
-          name = $1
-          "<img class='emoji' title=':#{name}:' alt=':#{name}:' src='#{emoji_url(name)}' height='20' width='20' align='absmiddle' />"
+          emoji_image_tag($1)
         end
       end
 
@@ -70,6 +69,11 @@ module HTML
 
       private
 
+      # Build an emoji image tag
+      def emoji_image_tag(name)
+        "<img class='emoji' title=':#{name}:' alt=':#{name}:' src='#{emoji_url(name)}' height='20' width='20' align='absmiddle' />"
+      end
+
       def emoji_url(name)
         File.join(asset_root, asset_path(name))
       end

data/lib/html/pipeline/image_filter.rb

@@ -0,0 +1,17 @@
+module HTML
+  class Pipeline
+    # HTML Filter that converts image's url into <img> tag.
+    # For example, it will convert
+    #   http://example.com/test.jpg
+    # into
+    #   <img src="http://example.com/test.jpg" alt=""/>.
+
+    class ImageFilter < TextFilter
+      def call
+        @text.gsub(/(https|http)?:\/\/.+\.(jpg|jpeg|bmp|gif|png)(\?\S+)?/i) do |match|
+        %|<img src="#{match}" alt=""/>|
+        end
+      end
+    end
+  end
+end

data/lib/html/pipeline/sanitization_filter.rb

@@ -50,7 +50,7 @@ module HTML
         :remove_contents => ['script'],
         :attributes => {
           'a' => ['href'],
-          'img' => ['src'],
+          'img' => ['src', 'longdesc'],
           'div' => ['itemscope', 'itemtype'],
           :all  => ['abbr', 'accept', 'accept-charset',
                     'accesskey', 'action', 'align', 'alt', 'axis',
@@ -61,7 +61,7 @@ module HTML
                     'disabled', 'enctype', 'for', 'frame',
                     'headers', 'height', 'hreflang',
                     'hspace', 'ismap', 'label', 'lang',
-                    'longdesc', 'maxlength', 'media', 'method',
+                    'maxlength', 'media', 'method',
                     'multiple', 'name', 'nohref', 'noshade',
                     'nowrap', 'open', 'prompt', 'readonly', 'rel', 'rev',
                     'rows', 'rowspan', 'rules', 'scope',
@@ -72,7 +72,10 @@ module HTML
         },
         :protocols => {
           'a'   => {'href' => ANCHOR_SCHEMES},
-          'img' => {'src'  => ['http', 'https', :relative]}
+          'img' => {
+            'src'      => ['http', 'https', :relative],
+            'longdesc' => ['http', 'https', :relative]
+          }
         },
         :transformers => [
           # Top-level <li> elements are removed because they can break out of

data/lib/html/pipeline/version.rb

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

data/script/changelog

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/bin/bash
 # 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.
@@ -8,23 +8,40 @@
 # Generate a changelog preview from pull requests merged between `base` and
 # `head`.
 #
-# https://github.com/jch/release-scripts
+# https://github.com/jch/release-scripts/blob/master/changelog
 set -e
 
 [ $# -eq 0 ] && set -- --help
+while [[ $# > 1 ]]
+do
+  key="$1"
+  case $key in
+    -r|--repo)
+    repo="$2"
+    shift
+    ;;
+    -b|--base)
+    base="$2"
+    shift
+    ;;
+    -h|--head)
+    head="$2"
+    shift
+    ;;
+    *)
+    ;;
+  esac
+  shift
+done
 
-# 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"
+repo="${repo:-$(git remote -v | grep push | awk '{print $2}' | cut -d'/' -f4- | sed 's/\.git//')}"
+base="${base:-$(git tag -l | sort -t. -k 1,1n -k 2,2n -k 3,3n | tail -n 1)}"
+head="${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)]}"'
+  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)]})"'
 done

data/test/html/pipeline/image_filter_test.rb

@@ -0,0 +1,39 @@
+require "test_helper"
+
+ImageFilter = HTML::Pipeline::ImageFilter
+
+class HTML::Pipeline::ImageFilterTest < Minitest::Test
+  def filter(html)
+    ImageFilter.to_html(html)
+  end
+
+  def test_jpg
+    assert_equal %(<img src="http://example.com/test.jpg" alt=""/>),
+    filter(%(http://example.com/test.jpg))
+  end
+
+  def test_jpeg
+    assert_equal %(<img src="http://example.com/test.jpeg" alt=""/>),
+    filter(%(http://example.com/test.jpeg))
+  end
+
+  def test_bmp
+    assert_equal %(<img src="http://example.com/test.bmp" alt=""/>),
+    filter(%(http://example.com/test.bmp))
+  end
+
+  def test_gif
+    assert_equal %(<img src="http://example.com/test.gif" alt=""/>),
+    filter(%(http://example.com/test.gif))
+  end
+
+  def test_png
+    assert_equal %(<img src="http://example.com/test.png" alt=""/>),
+    filter(%(http://example.com/test.png))
+  end
+
+  def test_https_url
+    assert_equal %(<img src="https://example.com/test.png" alt=""/>),
+    filter(%(https://example.com/test.png))
+  end
+end

data/test/html/pipeline/sanitization_filter_test.rb

@@ -51,6 +51,18 @@ class HTML::Pipeline::SanitizationFilterTest < Minitest::Test
     assert_equal '<a>Wat</a> is this', html
   end
 
+  def test_whitelisted_longdesc_schemes_are_allowed
+    stuff = '<img src="./foo.jpg" longdesc="http://longdesc.com">'
+    html  = SanitizationFilter.call(stuff).to_s
+    assert_equal '<img src="./foo.jpg" longdesc="http://longdesc.com">', html
+  end
+
+  def test_weird_longdesc_schemes_are_removed
+    stuff = '<img src="./foo.jpg" longdesc="javascript:alert(1)">'
+    html  = SanitizationFilter.call(stuff).to_s
+    assert_equal '<img src="./foo.jpg">', html
+  end
+
   def test_standard_schemes_are_removed_if_not_specified_in_anchor_schemes
     stuff  = '<a href="http://www.example.com/">No href for you</a>'
     filter = SanitizationFilter.new(stuff, {:anchor_schemes => []})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: 2.1.0
 platform: ruby
 authors:
 - Ryan Tomayko
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -79,6 +79,7 @@ files:
 - lib/html/pipeline/emoji_filter.rb
 - lib/html/pipeline/filter.rb
 - lib/html/pipeline/https_filter.rb
+- lib/html/pipeline/image_filter.rb
 - lib/html/pipeline/image_max_width_filter.rb
 - lib/html/pipeline/markdown_filter.rb
 - lib/html/pipeline/plain_text_input_filter.rb
@@ -97,6 +98,7 @@ files:
 - test/html/pipeline/camo_filter_test.rb
 - test/html/pipeline/emoji_filter_test.rb
 - test/html/pipeline/https_filter_test.rb
+- test/html/pipeline/image_filter_test.rb
 - test/html/pipeline/image_max_width_filter_test.rb
 - test/html/pipeline/markdown_filter_test.rb
 - test/html/pipeline/mention_filter_test.rb
@@ -132,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Helpers for processing content through a chain of filters
@@ -143,6 +145,7 @@ test_files:
 - test/html/pipeline/camo_filter_test.rb
 - test/html/pipeline/emoji_filter_test.rb
 - test/html/pipeline/https_filter_test.rb
+- test/html/pipeline/image_filter_test.rb
 - test/html/pipeline/image_max_width_filter_test.rb
 - test/html/pipeline/markdown_filter_test.rb
 - test/html/pipeline/mention_filter_test.rb