octopress-video-tag 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 645e8f6db5255d2289f6866db44bf4c2d40d597f
+  data.tar.gz: 8ccc182de25e86c1ac7d5e9f0489b9fc010403c3
+SHA512:
+  metadata.gz: 6a058f9063a78d5da710858e3dd75bbb6b7aad577ae73f913a0c995827a18be8ced928f12651e64043f56fcbc9fc61750aaf49498f5ad2dcce93be7f05be8eae
+  data.tar.gz: cd7eb9f28978b8014e6e654c626d33c75f2b6fe7ec49c6501f60e764350c217dca11d7b613aa5779645807694363dad236e36b72240fc12d35669e8cdf6b51b0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brandon Mathis
+
+MIT License
+
+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/README.md

@@ -0,0 +1,91 @@
+# Octopress Video Tag
+
+Easy HTML5 video tags for Jekyll sites.
+
+[![Build Status](http://img.shields.io/travis/octopress/video-tag.svg)](https://travis-ci.org/octopress/video-tag)
+[![Gem Version](http://img.shields.io/gem/v/octopress-video-tag.svg)](https://rubygems.org/gems/octopress-video-tag)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://octopress.mit-license.org)
+
+## Installation
+
+### Using Bundler
+
+Add this gem to your site's Gemfile in the `:jekyll_plugins` group:
+
+    group :jekyll_plugins do
+      gem 'octopress-video-tag'
+    end
+
+Then install the gem with Bundler
+
+    $ bundle
+
+### Manual Installation
+
+    $ gem install octopress-video-tag
+
+Then add the gem to your Jekyll configuration.
+
+    gems:
+      -octopress-video-tag
+
+## Syntax
+
+Creating a proper HTML5 video tag couldn't be simpler.
+
+    {% video urls [class names] [width height] [preload:auto|metadata|none] %}
+
+### URLs
+
+URLs must include a protocol `http` or `https` or begin with a `/`. URLs for videos should point to mp4, ogv, and/or webm. Adding a url to an image will set that image as the video's poster frame.
+
+### Preload
+
+Preload has three settings:
+
+- `auto` - The Video should start downloading when the page is loaded.
+- `metadata` - Only the videos metadata is downloaded when the page is loaded.
+- `none` - The video will only be downloaded when the viewer clicks.
+
+This plugin defaults to preloading `metadata`. This uses minimal bandwidth while still allowing the video to start playing quickly.
+
+### Click to play
+
+Each video is embedded with a minuscule bit of javascript which plays videos when they are clicked. If you'd prefer to disable this feature, set `click_to_play_video: false` in your site's configuration.
+
+## Examples:
+
+```
+{% video /videos/clouds.mp4 %}
+{% video featured wide /images/clouds.jpg /videos/clouds.mp4 /videos/clouds.webm /videos/clouds.ogv 1080px 608px preload:auto %}
+```
+
+This would output the following HTML
+
+```html
+<video controls poster='' width='' height='' preload='metadata'
+  onclick='(function(el){ if(el.paused) el.play(); else el.pause() })(this)'>
+  <source src='/videos/clouds.mp4' type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'>
+</video>
+
+<video class='featured wide' controls poster='/images/clouds.jpg' width='1080px' height='608px' preload='auto'
+  onclick='(function(el){ if(el.paused) el.play(); else el.pause() })(this)'>
+  <source src='/videos/clouds.mp4' type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'>
+  <source src='/videos/clouds.webm' type='video/webm; codecs="vp8, vorbis"'>
+  <source src='/videos/clouds.ogv' type='video/ogg; codecs="theora, vorbis"'>
+</video>
+```
+
+<video controls poster='http://s3.imathis.com/video/clouds.jpg' width='' height='' preload='metadata' onclick='(function(el){ if(el.paused) el.play(); else el.pause() })(this)'>
+  <source src='http://s3.imathis.com/video/clouds.mp4' type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'>
+  <source src='http://s3.imathis.com/video/clouds.webm' type='video/webm; codecs="vp8, vorbis"'>
+  <source src='http://s3.imathis.com/video/clouds.ogv' type='video/ogg; codecs="theora, vorbis"'>
+</video>
+
+## Contributing
+
+1. Fork it ( https://github.com/octopress/video-tag/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/octopress-video-tag/version.rb

@@ -0,0 +1,7 @@
+module Octopress
+  module Tags
+    module VideoTag
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/octopress-video-tag.rb

@@ -0,0 +1,81 @@
+require "octopress-video-tag/version"
+
+module Octopress
+  module Tags
+    module VideoTag
+      class Tag < Liquid::Tag
+        @video   = nil
+        @poster  = ''
+        @height  = ''
+        @width   = ''
+        Preload  = /(:?preload: *(:?\S+))/i
+        Size     = /\s(auto|\d\S+)\s?(auto|\d\S+)?/i
+        URLs     = /((https?:\/)?\/\S+)/i
+
+        def initialize(tag_name, tag_markup, tokens)
+          @markup = tag_markup
+          markup = tag_markup.dup
+
+          @preload = markup.scan(Preload).flatten.compact.last || "metadata"
+          markup.sub!(Preload, '')
+
+          @sizes = markup.scan(Size).flatten.compact
+          markup.sub!(Size, '')
+
+          urls = markup.scan(URLs).map{ |m| m.first }
+          @videos = urls.select {|u| u.match /mp4|ogv|webm/i}
+          @poster = urls.select {|u| u.match /jpe?g|png|gif/i}.first
+          markup.gsub!(URLs, '')
+
+          if !(@classes = markup.strip).empty?
+            @classes = "class='#{@classes}' "
+          end
+
+          super
+        end
+
+        def render(context)
+
+          output = super
+          type = {
+            'mp4' => "type='video/mp4; codecs=\"avc1.42E01E, mp4a.40.2\"'",
+            'ogv' => "type='video/ogg; codecs=\"theora, vorbis\"'",
+            'webm' => "type='video/webm; codecs=\"vp8, vorbis\"'"
+          }
+
+          if context.environments.first['site']['click_to_play_video'] != false
+            clickToPlay = "onclick='(function(el){ if(el.paused) el.play(); else el.pause() })(this)'"
+          else
+            clickToPlay = ''
+          end
+
+          if @videos && @videos.size > 0
+            video =  "<video #{@classes}controls poster='#{@poster}' width='#{@sizes[0]}' height='#{@sizes[1]}' preload='#{@preload}' #{clickToPlay}>"
+            @videos.each do |v|
+              t = v.match(/([^\.]+)$/)[1]
+              video += "<source src='#{v}' #{type[t]}>"
+            end
+            video += "</video>"
+          else
+            raise "No video mp4, ogv, or webm urls found in {% video #{@markup} %}"
+          end
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('video', Octopress::Tags::VideoTag::Tag)
+
+
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Video Tag",
+    gem:         "octopress-video-tag",
+    version:     Octopress::Tags::VideoTag::VERSION,
+    description: "Easy HTML5 video tags for Jekyll sites",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+    source_url:  "https://github.com/octopress/video-tag",
+  })
+end
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: octopress-video-tag
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: clash
+  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: pry-byebug
+  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: Easy HTML5 video tags for Jekyll sites.
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/octopress-video-tag.rb
+- lib/octopress-video-tag/version.rb
+homepage: https://github.com/octopress/video-tag
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Easy HTML5 video tags for Jekyll sites.
+test_files: []