motion-html-pipeline 0.1

data/lib/motion-html-pipeline/pipeline/https_filter.rb

@@ -0,0 +1,27 @@
+module MotionHTMLPipeline
+  class Pipeline
+    # HTML Filter for replacing http references to :http_url with https versions.
+    # Subdomain references are not rewritten.
+    #
+    # Context options:
+    #   :http_url - The HTTP url to force HTTPS. Falls back to :base_url
+    class HttpsFilter < Filter
+      def call
+        doc.css(%(a[href^="#{http_url}"])).each do |element|
+          element['href'] = element['href'].sub(/^http:/, 'https:')
+        end
+        doc
+      end
+
+      # HTTP url to replace. Falls back to :base_url
+      def http_url
+        context[:http_url] || context[:base_url]
+      end
+
+      # Raise error if :http_url undefined
+      def validate
+        needs :http_url unless http_url
+      end
+    end
+  end
+end

data/lib/motion-html-pipeline/pipeline/image_filter.rb

@@ -0,0 +1,17 @@
+module MotionHTMLPipeline
+  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/motion-html-pipeline/pipeline/image_max_width_filter.rb

@@ -0,0 +1,37 @@
+module MotionHTMLPipeline
+  class Pipeline
+    # This filter rewrites image tags with a max-width inline style and also wraps
+    # the image in an <a> tag that causes the full size image to be opened in a
+    # new tab.
+    #
+    # The max-width inline styles are especially useful in HTML email which
+    # don't use a global stylesheets.
+    class ImageMaxWidthFilter < Filter
+      def call
+        doc.css('img').each do |element|
+          # Skip if there's already a style attribute. Not sure how this
+          # would happen but we can reconsider it in the future.
+          next if element['style']
+
+          # Bail out if src doesn't look like a valid http url. trying to avoid weird
+          # js injection via javascript: urls.
+          next if element['src'].to_s.strip =~ /\Ajavascript/i
+
+          element['style'] = 'max-width:100%;'
+
+          link_image element unless has_ancestor?(element, %w[a])
+        end
+
+        doc
+      end
+
+      def link_image(element)
+        link = HTMLElement.alloc.initWithTagName('a', attributes: { href: element['src'], target: '_blank' })
+        link.appendNode(element.cloneNodeDeep(true))
+
+        parent = element.parentNode
+        parent.replaceChildNode(element, withNode: link)
+      end
+    end
+  end
+end

data/lib/motion-html-pipeline/pipeline/text_filter.rb

@@ -0,0 +1,14 @@
+module MotionHTMLPipeline
+  class Pipeline
+    class TextFilter < Filter
+      attr_reader :text
+
+      def initialize(text, context = nil, result = nil)
+        raise TypeError, 'text cannot be HTML' if text.is_a?(DocumentFragment)
+        # Ensure that this is always a string
+        @text = text.respond_to?(:to_str) ? text.to_str : text.to_s
+        super nil, context, result
+      end
+    end
+  end
+end

data/lib/motion-html-pipeline/pipeline/version.rb

@@ -0,0 +1,5 @@
+module MotionHTMLPipeline
+  class Pipeline
+    VERSION = '0.1'.freeze
+  end
+end

data/spec/motion-html-pipeline/_helpers/mock_instumentation_service.rb

@@ -0,0 +1,19 @@
+class MockedInstrumentationService
+  attr_reader :events
+  def initialize(event = nil, events = [])
+    @events = events
+    subscribe event
+  end
+
+  def instrument(event, payload = nil)
+    payload ||= {}
+    res = yield payload
+    events << [event, payload, res] if @subscribe == event
+    res
+  end
+
+  def subscribe(event)
+    @subscribe = event
+    @events
+  end
+end

data/spec/motion-html-pipeline/pipeline/absolute_source_filter_spec.rb

@@ -0,0 +1,47 @@
+describe 'MotionHTMLPipeline::Pipeline::AbsoluteSourceFilterTest' do
+  AbsoluteSourceFilter = MotionHTMLPipeline::Pipeline::AbsoluteSourceFilter
+
+  before do
+    @image_base_url = 'http://assets.example.com'
+    @image_subpage_url = 'http://blog.example.com/a/post'
+    @options = {
+      image_base_url: @image_base_url,
+      image_subpage_url: @image_subpage_url
+    }
+  end
+
+  it 'test_rewrites_root_urls' do
+    orig = %(<p><img src="/img.png"></p>)
+
+    expect("<p><img src=\"#{@image_base_url}/img.png\"></p>")
+      .to eq AbsoluteSourceFilter.call(orig, @options).to_s
+  end
+
+  it 'test_rewrites_relative_urls' do
+    orig = %(<p><img src="post/img.png"></p>)
+
+    expect("<p><img src=\"#{@image_subpage_url}/img.png\"></p>")
+      .to eq AbsoluteSourceFilter.call(orig, @options).to_s
+  end
+
+  it 'test_does_not_rewrite_absolute_urls' do
+    orig = %(<p><img src="http://other.example.com/img.png"></p>)
+    result = AbsoluteSourceFilter.call(orig, @options).to_s
+
+    expect(result).not_to match(/@image_base_url/)
+    expect(result).not_to match(/@@image_subpage_url/)
+  end
+
+  it 'test_fails_when_context_is_missing' do
+    expect{ AbsoluteSourceFilter.call('<img src="img.png">', {}) }.to raise_error(RuntimeError)
+    expect{ AbsoluteSourceFilter.call('<img src="/img.png">', {}) }.to raise_error(RuntimeError)
+  end
+
+  it 'test_tells_you_where_context_is_required' do
+    expect{ AbsoluteSourceFilter.call('<img src="img.png">', {}) }
+      .to raise_error(RuntimeError, 'MotionHTMLPipeline::Pipeline::AbsoluteSourceFilter')
+
+    expect{ AbsoluteSourceFilter.call('<img src="/img.png">', {}) }
+      .to raise_error(RuntimeError, 'MotionHTMLPipeline::Pipeline::AbsoluteSourceFilter')
+  end
+end

data/spec/motion-html-pipeline/pipeline/disabled/auto_link_filter_spec.rb

@@ -0,0 +1,33 @@
+# describe 'MotionHTMLPipeline::Pipeline::AutolinkFilterTest' do
+#   AutolinkFilter = MotionHTMLPipeline::Pipeline::AutolinkFilter
+#
+#   it '#test_uses_rinku_for_autolinking' do
+#     # just try to parse a complicated piece of HTML
+#     # that Rails auto_link cannot handle
+#     expect('<p>"<a href="http://www.github.com">http://www.github.com</a>"</p>')
+#       .to eq AutolinkFilter.to_html('<p>"http://www.github.com"</p>')
+#   end
+#
+#   def test_autolink_option
+#     assert_equal '<p>"http://www.github.com"</p>',
+#                  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)
+#   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/spec/motion-html-pipeline/pipeline/disabled/camo_filter_spec.rb

@@ -0,0 +1,75 @@
+# describe 'MotionHTMLPipeline::Pipeline::CamoFilterTest' do
+#   CamoFilter = MotionHTMLPipeline::Pipeline::CamoFilter
+#
+#   def setup
+#     @asset_proxy_url        = 'https//assets.example.org'
+#     @asset_proxy_secret_key = 'ssssh-secret'
+#     @options = {
+#       asset_proxy: @asset_proxy_url,
+#       asset_proxy_secret_key: @asset_proxy_secret_key,
+#       asset_proxy_whitelist: [/(^|\.)github\.com$/]
+#     }
+#   end
+#
+#   def test_asset_proxy_disabled
+#     orig = %(<p><img src="http://twitter.com/img.png"></p>)
+#     assert_equal orig,
+#                  CamoFilter.call(orig, @options.merge(disable_asset_proxy: true)).to_s
+#   end
+#
+#   def test_camouflaging_http_image_urls
+#     orig = %(<p><img src="http://twitter.com/img.png"></p>)
+#     assert_equal %(<p><img src="https//assets.example.org/a5ad43494e343b20d745586282be61ff530e6fa0/687474703a2f2f747769747465722e636f6d2f696d672e706e67" data-canonical-src="http://twitter.com/img.png"></p>),
+#                  CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_doesnt_rewrite_dotcom_image_urls
+#     orig = %(<p><img src="https://github.com/img.png"></p>)
+#     assert_equal orig, CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_doesnt_rewrite_dotcom_subdomain_image_urls
+#     orig = %(<p><img src="https://raw.github.com/img.png"></p>)
+#     assert_equal orig, CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_doesnt_rewrite_dotcom_subsubdomain_image_urls
+#     orig = %(<p><img src="https://f.assets.github.com/img.png"></p>)
+#     assert_equal orig, CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_camouflaging_github_prefixed_image_urls
+#     orig = %(<p><img src="https://notgithub.com/img.png"></p>)
+#     assert_equal %(<p><img src="https//assets.example.org/5d4a96c69713f850520538e04cb9661035cfb534/68747470733a2f2f6e6f746769746875622e636f6d2f696d672e706e67" data-canonical-src="https://notgithub.com/img.png"></p>),
+#                  CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_doesnt_rewrite_absolute_image_urls
+#     orig = %(<p><img src="/img.png"></p>)
+#     assert_equal orig, CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_doesnt_rewrite_relative_image_urls
+#     orig = %(<p><img src="img.png"></p>)
+#     assert_equal orig, CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_camouflaging_https_image_urls
+#     orig = %(<p><img src="https://foo.com/img.png"></p>)
+#     assert_equal %(<p><img src="https//assets.example.org/3c5c6dc74fd6592d2596209dfcb8b7e5461383c8/68747470733a2f2f666f6f2e636f6d2f696d672e706e67" data-canonical-src="https://foo.com/img.png"></p>),
+#                  CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_handling_images_with_no_src_attribute
+#     orig = %(<p><img></p>)
+#     assert_equal orig, CamoFilter.call(orig, @options).to_s
+#   end
+#
+#   def test_required_context_validation
+#     exception = assert_raises(ArgumentError) do
+#       CamoFilter.call('', {})
+#     end
+#     assert_match /:asset_proxy[^_]/, exception.message
+#     assert_match /:asset_proxy_secret_key/, exception.message
+#   end
+# end

data/spec/motion-html-pipeline/pipeline/disabled/email_reply_filter_spec.rb

@@ -0,0 +1,64 @@
+# describe 'MotionHTMLPipeline::Pipeline::EmailReplyFilterTest' do
+#   EmailReplyFilter = MotionHTMLPipeline::Pipeline::EmailReplyFilter
+#
+#   def setup
+#     @body = <<-EMAIL
+# Hey, don't send email addresses in comments. They aren't filtered.
+#
+# > On Mar 5, 2016, at 08:05, Boaty McBoatface <boatymcboatface@example.com> wrote:
+# >
+# > Sup. alreadyleaked@example.com
+# >
+# > —
+# > Reply to this email directly or view it on GitHub.
+# EMAIL
+#   end
+#
+#   def test_doesnt_hide_by_default
+#     filter = EmailReplyFilter.new(@body)
+#     doc = filter.call.to_s
+#     assert_match /alreadyleaked@example.com/, doc
+#     assert_match /boatymcboatface@example.com/, doc
+#   end
+#
+#   def test_hides_email_addresses_when_configured
+#     filter = EmailReplyFilter.new(@body, hide_quoted_email_addresses: true)
+#     doc = filter.call.to_s
+#     refute_match /boatymcboatface@example.com/, doc
+#     refute_match /alreadyleaked@example.com/, doc
+#   end
+#
+#   def test_preserves_non_email_content_while_filtering
+#     str = <<-EMAIL
+# > Thank you! I have some thoughts on this pull request.
+# >
+# >  *  acme provides cmake and a wrapper for it. Please use '$(TARGET)-cmake' instead of cmake -DCMAKE_TOOLCHAIN_FILE='$(CMAKE_TOOLCHAIN_FILE)' -DCMAKE_BUILD_TYPE=Release.
+#
+# Okay -- I'm afraid I just blindly copied the eigen3.mk file, since that's a library I'm familiar with :-)
+#
+# >  *  Do you need -DCMAKE_SYSTEM_PROCESSOR=x86?
+#
+# Yes, this is a bit dumb, but vc checks for that (or amd) to determine that it's not being built on ARM.
+#
+# --
+# Boaty McBoatface | http://example.org
+# EMAIL
+#
+#     filter = EmailReplyFilter.new(str, hide_quoted_email_addresses: true)
+#     doc = filter.call.to_s
+#
+#     expected = <<-EXPECTED
+# <div class="email-quoted-reply"> Thank you! I have some thoughts on this pull request.
+#
+#   *  acme provides cmake and a wrapper for it. Please use &#39;$(TARGET)-cmake&#39; instead of cmake -DCMAKE_TOOLCHAIN_FILE=&#39;$(CMAKE_TOOLCHAIN_FILE)&#39; -DCMAKE_BUILD_TYPE=Release.</div>
+# <div class="email-fragment">Okay -- I&#39;m afraid I just blindly copied the eigen3.mk file, since that&#39;s a library I&#39;m familiar with :-)</div>
+# <div class="email-quoted-reply">  *  Do you need -DCMAKE_SYSTEM_PROCESSOR=x86?</div>
+# <div class="email-fragment">Yes, this is a bit dumb, but vc checks for that (or amd) to determine that it&#39;s not being built on ARM.</div>
+# <span class="email-hidden-toggle"><a href="#">&hellip;</a></span><div class="email-hidden-reply" style="display:none"><div class="email-signature-reply">--
+# Boaty McBoatface | http:&#47;&#47;example.org</div>
+# </div>
+# EXPECTED
+#
+#     assert_equal(expected.chomp, doc)
+#   end
+# end

data/spec/motion-html-pipeline/pipeline/disabled/emoji_filter_spec.rb

@@ -0,0 +1,92 @@
+# describe 'MotionHTMLPipeline::Pipeline::EmojiFilterTest' do
+#   EmojiFilter = MotionHTMLPipeline::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_uri_encoding
+#     filter = EmojiFilter.new('<p>:+1:</p>', asset_root: 'https://foo.com')
+#     doc = filter.call
+#     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) do
+#       EmojiFilter.call('', {})
+#     end
+#     assert_match /:asset_root/, exception.message
+#   end
+#
+#   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/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
+#
+#   def test_img_tag_attributes
+#     body = ':shipit:'
+#     filter = EmojiFilter.new(body, asset_root: 'https://foo.com')
+#     doc = filter.call
+#     assert_equal %(<img class="emoji" title=":shipit:" alt=":shipit:" src="https://foo.com/emoji/shipit.png" height="20" width="20" align="absmiddle">), doc.to_html
+#   end
+#
+#   def test_img_tag_attributes_can_be_customized
+#     body = ':shipit:'
+#     filter = EmojiFilter.new(body, asset_root: 'https://foo.com', img_attrs: Hash('draggable' => 'false', 'height' => nil, 'width' => nil, 'align' => nil))
+#     doc = filter.call
+#     assert_equal %(<img class="emoji" title=":shipit:" alt=":shipit:" src="https://foo.com/emoji/shipit.png" draggable="false">), doc.to_html
+#   end
+#
+#   def test_img_attrs_value_can_accept_proclike_object
+#     remove_colons = ->(name) { name.delete(':') }
+#     body = ':shipit:'
+#     filter = EmojiFilter.new(body, asset_root: 'https://foo.com', img_attrs: Hash('title' => remove_colons))
+#     doc = filter.call
+#     assert_equal %(<img class="emoji" title="shipit" alt=":shipit:" src="https://foo.com/emoji/shipit.png" height="20" width="20" align="absmiddle">), doc.to_html
+#   end
+#
+#   def test_img_attrs_can_accept_symbolized_keys
+#     body = ':shipit:'
+#     filter = EmojiFilter.new(body, asset_root: 'https://foo.com', img_attrs: Hash(draggable: false, height: nil, width: nil, align: nil))
+#     doc = filter.call
+#     assert_equal %(<img class="emoji" title=":shipit:" alt=":shipit:" src="https://foo.com/emoji/shipit.png" draggable="false">), doc.to_html
+#   end
+# end