html-pipeline-trix-video 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5c9bc4198c6a825f0b13fb9d64df6537f196c59
+  data.tar.gz: d98e8a6208525d0d01086d18c28d672368ddaa5f
+SHA512:
+  metadata.gz: 90c2ecb24521555459eef81fe8ae3ced693d6c31bb9c38a53898110017026933bb167ef3e06a6dd0253032a41063b242b59b684ab880eb278c2051cce4a32beb
+  data.tar.gz: 6eacde5c12ae604f69f08dd98b53699bcbd6ee97da91c6e1b6d0dcfe6fcd6d251b03b4a8cc20eb1cf584065128cabb76bd32fa112e00be53df14717e64d1fd29

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html-pipeline-trix-video.gemspec
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+## HTML::Pipeline Trix Video
+
+This project is intended to provide a filter that will take
+[Trix](https://github.com/basecamp/trix)-produced content as input, find
+`<figure>` tags that hold onto image previews taken from YouTube or Vimeo
+videos, and convert those into raw YouTube or Vimeo video URLs.
+
+The intention is that this returned URL can then be filtered through
+[html-pipeline-vimeo](https://github.com/dlackty/html-pipeline-vimeo) and
+[html-pipeline-youtube](https://github.com/st0012/html-pipeline-youtube) in
+order to display embedded videos in Trix-produced content.
+
+This is based off of the work-flow suggested in Trix's [Issue
+206](https://github.com/basecamp/trix/issues/206).
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-pipeline'
+gem 'html-pipeline-trix-video'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install html-pipeline-trix-video
+```
+
+### Usage
+
+You can add `HTML::Pipeline::TrixVideoFilter` into your pipeline like this:
+
+```ruby
+pipeline = HTML::Pipeline.new [
+  HTML::Pipeline::TrixVideoFilter,
+  HTML::Pipeline::VimeoFilter
+]
+
+result = pipeline.call(text)
+```
+
+See [html-pipeline](https://github.com/jch/html-pipeline).

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+require "rubygems"
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "html/pipeline/trix_video"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+require "awesome_print"
+
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/html-pipeline-trix-video.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html/pipeline/trix_video/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "html-pipeline-trix-video"
+  spec.version = HTML::Pipeline::TrixVideo::VERSION
+  spec.authors = ["Wendy Randquist"]
+  spec.email = ["wendybeth010@gmail.com"]
+
+  spec.summary = %q{An HTML::Pipeline filter converting Trix-compliant YouTube or Vimeo preview figures into URLs}
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/wendybeth/html-pipeline-trix-video"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test/features)/}) }
+
+  spec.add_dependency "html-pipeline", "~> 2.0"
+
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/html/pipeline/trix_video.rb

@@ -0,0 +1,5 @@
+require "pry"
+require "awesome_print"
+
+require "html/pipeline/trix_video/version"
+require "html/pipeline/trix_video/trix_video_filter"

data/lib/html/pipeline/trix_video/trix_video_filter.rb

@@ -0,0 +1,52 @@
+require "html/pipeline"
+
+module HTML
+  class Pipeline
+    # HTML Filter for Trix-compliant video preview filters
+    #
+    class TrixVideoFilter < TextFilter
+      def call
+        text_fragment.css("figure").each do |figure|
+          service, id = video_information(figure)
+
+          case service
+          when "youtube"
+            figure.replace "https://youtube.com/watch?v=#{id}"
+          when "vimeo"
+            figure.replace "https://vimeo.com/#{id}"
+          end
+        end
+
+        text_fragment.to_s
+      end
+
+      def video_information(figure)
+        url = figure.css("img").first ? figure.css("img").first["src"] : nil
+
+        if match = valid_id(url, youtube_regex)
+          [ "youtube", match[1] ]
+        elsif match = valid_id(url, vimeo_regex)
+          [ "vimeo",   match[1] ]
+        end
+      end
+
+      def valid_id(url, regex)
+        return unless url
+        url.match(regex)
+      end
+
+      def text_fragment
+        @fragment ||= Nokogiri::HTML::DocumentFragment.parse(@text)
+      end
+
+      def youtube_regex
+        /img.youtube.com\/vi\/(\S*)\/\d.jpg/
+      end
+
+      def vimeo_regex
+        /i.vimeocdn.com\/video\/[0-9]*_[0-9]{3}x[0-9]{3}.jpg\?r=pad\?id=([0-9]*)/
+      end
+
+    end
+  end
+end

data/lib/html/pipeline/trix_video/version.rb

@@ -0,0 +1,7 @@
+module HTML
+  class Pipeline
+    class TrixVideo
+      VERSION = "0.0.1"
+    end
+  end
+end

data/license.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Wendy Randquist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require "bundler/setup"
+require "minitest/autorun"
+
+require "./lib/html/pipeline/trix_video"
+
+module TestHelpers
+
+  def assert_equal_html(expected, actual)
+    assert_equal equalized_html(expected), equalized_html(actual)
+  end
+
+  def equalized_html(html)
+    Nokogiri::HTML::DocumentFragment.parse(html).to_hash
+  end
+
+end
+
+Minitest::Test.send(:include, TestHelpers)

data/test/trix_video_filter_test.rb

@@ -0,0 +1,32 @@
+require "test_helper"
+
+class HTML::Pipeline::TrixVideoFilterTest < Minitest::Test
+  TrixVideoFilter = HTML::Pipeline::TrixVideoFilter
+
+  def test_it_converts_youtube_figures_into_youtube_urls
+    assert_equal_html "https://youtube.com/watch?v=FTfrKOQFPNA", TrixVideoFilter.call(youtube_figure)
+  end
+
+  def test_it_converts_vimeo_figures_into_vimeo_urls
+    assert_equal_html "https://vimeo.com/187229876", TrixVideoFilter.call(vimeo_figure)
+  end
+
+  def test_it_leaves_other_figures_alone
+    assert_equal_html image_figure, TrixVideoFilter.call(image_figure)
+  end
+
+  private
+
+  def youtube_figure
+    "<figure class=\"attachment attachment-preview\" data-trix-attachment=\"{&quot;contentType&quot;:&quot;image&quot;,&quot;height&quot;:360,&quot;url&quot;:&quot;https://img.youtube.com/vi/FTfrKOQFPNA/0.jpg&quot;,&quot;width&quot;:480}\" data-trix-content-type=\"image\"><img src=\"https://img.youtube.com/vi/FTfrKOQFPNA/0.jpg\" width=\"480\" height=\"360\"><figcaption class=\"caption\"></figcaption></figure>"
+  end
+
+  def vimeo_figure
+    "<figure class=\"attachment attachment-preview\" data-trix-attachment=\"{&quot;contentType&quot;:&quot;image&quot;,&quot;height&quot;:150,&quot;url&quot;:&quot;https://i.vimeocdn.com/video/597074452_200x150.jpg?r=pad?id=187229876&quot;,&quot;width&quot;:200}\" data-trix-content-type=\"image\"><img src=\"https://i.vimeocdn.com/video/597074452_200x150.jpg?r=pad?id=187229876\" width=\"200\" height=\"150\"><figcaption class=\"caption\"></figcaption></figure>"
+  end
+
+  def image_figure
+    "<figure class=\"attachment attachment-preview png\" data-trix-attachment=\"{&quot;contentType&quot;:&quot;image/png&quot;,&quot;filename&quot;:&quot;zw.png&quot;,&quot;filesize&quot;:923,&quot;height&quot;:11,&quot;url&quot;:&quot;/uploads/image/filename/113/zw.png&quot;,&quot;width&quot;:16}\" data-trix-content-type=\"image/png\" data-trix-attributes=\"{&quot;caption&quot;:&quot;with a caption!&quot;}\"><img src=\"/uploads/image/filename/113/zw.png\" width=\"16\" height=\"11\"><figcaption class=\"caption caption-edited\">with a caption!</figcaption></figure>"
+  end
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-trix-video
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wendy Randquist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An HTML::Pipeline filter converting Trix-compliant YouTube or Vimeo preview
+  figures into URLs
+email:
+- wendybeth010@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- html-pipeline-trix-video.gemspec
+- lib/html/pipeline/trix_video.rb
+- lib/html/pipeline/trix_video/trix_video_filter.rb
+- lib/html/pipeline/trix_video/version.rb
+- license.txt
+- test/test_helper.rb
+- test/trix_video_filter_test.rb
+homepage: https://github.com/wendybeth/html-pipeline-trix-video
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: An HTML::Pipeline filter converting Trix-compliant YouTube or Vimeo preview
+  figures into URLs
+test_files: []
+has_rdoc: