webvtt 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in webvtt.gemspec
+gemspec
+
+gem 'rake'

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :test do
+  watch(%r{^lib/webvtt/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch('test/test_helper.rb')  { "test" }
+  callback(:run_on_changes_begin) { puts "\n", '='*70, "\n" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 North Carolina State University
+
+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,58 @@
+# WEBVTT FILE parser for Ruby
+
+Parse WebVTT files with Ruby.
+The main goal is just to extract the text out with start and end times.
+The parsing does not conform the [WebVTT specification](http://dev.w3.org/html5/webvtt/) at this point.
+
+
+# Story
+
+We were creating WebVTT files to enable closed captions for HTML5 video.
+We wanted to reuse this work to embed the transcript in the video player
+page to increase SEO and allow for jumping to sections of the video.
+
+# Install
+
+```
+git clone
+rake build
+gem install pkg/webvtt.x.x.x.gem
+```
+
+# Usage
+
+Based on this WebVTT:
+
+```
+WEBVTT
+
+1
+00:00:00 --> 00:00:03.000 D:vertical A:start
+I grew up in Eastern North Carolina, <b>Edgecombe</b> County
+
+2
+00:00:03.300 --> 00:00:07.800 A:start
+on a tobacco and dairy farm outside of Tarboro.
+```
+
+You can do the following:
+
+
+```
+require 'webvtt'
+vtt = Webvtt::File.new('path/to/file.vtt')
+vtt.cues.class    #=> Webvtt::Cue
+vtt.cues[0].start #=> '00:00:00'
+vtt.cues[0].end   #=> '00:00:03.000'
+vtt.cues[0].identifier #=> '1'
+vtt.cues[0].settings   #=> 'D:vertical A:start'
+vtt.cues[0].text       #=> 'I grew up in Eastern North Carolina, <b>Edgecombe</b> County'
+```
+
+# Author
+
+Jason Ronallo
+
+# License
+
+See LICENSE

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+ t.libs << 'test'
+ t.test_files = FileList['test/*_test.rb']
+end
+
+desc "Run tests"
+task :default => :test

data/lib/webvtt/cue.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+module Webvtt
+  class Cue
+    attr_accessor :identifier, :start, :end, :settings, :text
+    def initialize(opts={})
+      if !opts.empty?
+        @identifier = opts[:identifier]
+        @text       = opts[:text]
+        cue_parts = opts[:cue_line].split('-->')
+        @start = cue_parts.first.strip
+        remaining_cue_parts = cue_parts.last.split(" ")
+        @end = remaining_cue_parts.shift.strip
+        @settings = remaining_cue_parts.join(' ')
+      end
+
+    end
+  end
+end

data/lib/webvtt/file.rb

@@ -0,0 +1,72 @@
+# -*- encoding : utf-8 -*-
+module Webvtt
+  class File
+
+    attr_accessor :file, :cues
+
+    def initialize(input_file)
+      if input_file.is_a?(String)
+        input_file = input_file.encode('UTF-8')
+        if ::File.exist?(input_file)
+          @file = ::File.read(input_file)
+        else
+          @file = input_file
+        end
+      elsif input_file.is_a?(::File)
+        @file = input_file.read
+      else
+        raise
+      end
+      @cues = []
+      parse
+    end
+
+    def parse
+      remove_bom
+      if !webvtt_line?(file.lines.first)
+        raise Webvtt::MalformedError
+      end
+      collected_lines = []
+      file_lines = file.dup.lines.to_a
+
+      file_lines.each_with_index do |line,index|
+        line.chomp!
+        
+        next if webvtt_line?(line)
+        if line.empty? 
+          add_a_cue(collected_lines) if !collected_lines.empty?
+          collected_lines = []
+        elsif !line.empty? and file_lines.length == (index + 1)
+          collected_lines << line
+          add_a_cue(collected_lines)
+        else
+          collected_lines << line          
+        end  
+      end
+    end
+
+    def webvtt_line?(line)
+      line[0,6] == 'WEBVTT'
+    end
+
+    def remove_bom
+      file.gsub!("\uFEFF", '')
+    end
+
+private
+
+    def add_a_cue(collected_lines)
+      cue_opts = {}
+      if collected_lines.first.include?('-->')
+        cue_opts[:identifier] = nil
+        cue_opts[:cue_line] = collected_lines.first
+      elsif collected_lines[1].include?('-->')
+        cue_opts[:identifier] = collected_lines.first
+        cue_opts[:cue_line] = collected_lines[1]
+      end
+      cue_opts[:text] = collected_lines[2..-1].join('')
+      cues << Cue.new(cue_opts)
+    end
+
+  end
+end

data/lib/webvtt/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+module Webvtt
+  VERSION = "0.0.1"
+end

data/lib/webvtt.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+require "webvtt/version"
+
+module Webvtt
+  # Your code goes here...
+end
+
+require 'webvtt/file'
+require 'webvtt/cue'

data/test/cue_test.rb

@@ -0,0 +1,27 @@
+# -*- encoding : utf-8 -*-
+require 'test_helper'
+
+class WebvttCueTest < Test::Unit::TestCase
+  test "should have a Cue class" do
+    assert Webvtt::Cue
+  end
+
+  test "should respond to identifier, start, end, settings, and text" do
+    cue = Webvtt::Cue.new
+    assert cue.respond_to?(:identifier)
+    assert cue.respond_to?(:start)
+    assert cue.respond_to?(:end)
+    assert cue.respond_to?(:settings)
+    assert cue.respond_to?(:text)
+  end
+
+  test "parses an individual cue" do
+    cue = Webvtt::Cue.new(:identifier => "1", :cue_line => "00:00:00 --> 00:00:03.000 D:vertical A:start", :text => "I grew up in Eastern North Carolina, <b>Edgecombe</b> County")
+    assert_equal '1', cue.identifier
+    assert_equal '00:00:00', cue.start
+    assert_equal '00:00:03.000', cue.end
+    assert_equal 'D:vertical A:start', cue.settings
+    assert_equal 'I grew up in Eastern North Carolina, <b>Edgecombe</b> County', cue.text
+  end  
+
+end

data/test/examples/tolson.vtt

@@ -0,0 +1,10 @@
+WEBVTT
+
+1
+00:00:00 --> 00:00:03.000 D:vertical A:start
+I grew up in Eastern North Carolina, <b>Edgecombe</b> County
+
+2
+00:00:03.300 --> 00:00:07.800 A:start
+on a tobacco and dairy farm outside of 
+Tarboro.

data/test/file_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+class WebvttFileTest < Test::Unit::TestCase
+
+  setup do
+    path = File.expand_path(File.dirname(__FILE__))
+    @file_path = File.join(path, 'examples', 'tolson.vtt')
+    @vtt = Webvtt::File.new(@file_path)
+  end
+
+  test "should have a File class" do
+    assert Webvtt::File
+  end
+
+  test "should create a new File with file path" do
+    assert Webvtt::File.new(@file_path)
+  end
+
+  test "should create a new File with a File object" do
+    file = File.open(@file_path)
+    assert Webvtt::File.new(file)
+  end
+
+  test "should create a new File with a String as the contents of the WEBVTT file" do
+    file = "WEBVTT FILE\n\n1\n00:00:00 --> 00:00:05\nIt was a frightening time but it also was a time of great student intrigue"
+    assert Webvtt::File.new(file)    
+  end
+
+  test "should handle files with a BOM and different line endings" do
+    file = "\uFEFFWEBVTT FILE\r\n\r\n1\r\n00:00:00 --> 00:00:05\r\nIt was a frightening time but it also was a time of great student intrigue"
+    assert Webvtt::File.new(file)    
+  end
+
+  test "should have a file method" do
+    assert @vtt.respond_to?(:file)
+  end
+
+  test "should have a file method with the contents of the original file" do
+    assert @vtt.file.include?('WEBVTT')
+  end
+
+  test "should have a list of cues" do    
+    assert @vtt.respond_to?(:cues)
+    assert @vtt.cues.is_a?(Array)
+  end
+
+  test "should have 2 cues" do
+    assert_equal 2, @vtt.cues.length
+  end
+
+  test "first cue should be correct" do
+    first_cue = @vtt.cues.first
+    assert_equal "1", first_cue.identifier
+    assert_equal "00:00:00", first_cue.start
+    assert_equal "00:00:03.000", first_cue.end
+    assert_equal "D:vertical A:start", first_cue.settings
+    assert_equal "I grew up in Eastern North Carolina, <b>Edgecombe</b> County", first_cue.text
+  end
+
+  test "multiline cue text should be correct" do
+    assert_equal "on a tobacco and dairy farm outside of Tarboro.", @vtt.cues.last.text
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+require 'rubygems'
+require 'test-unit'
+require 'webvtt'
+

data/webvtt.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "webvtt/version"
+
+Gem::Specification.new do |s|
+  s.name        = "webvtt"
+  s.version     = Webvtt::VERSION
+  s.authors     = ["Jason Ronallo"]
+  s.email       = ["jronallo@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{WEBVTT file parser in Ruby}
+  s.description = %q{WEBVTT file parser in Ruby}
+
+  s.rubyforge_project = "webvtt"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency "test-unit", [">= 2.5.0"]
+  s.add_development_dependency "guard-test", [">= 0.5.0"]
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: webvtt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Ronallo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: WEBVTT file parser in Ruby
+email:
+- jronallo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/webvtt.rb
+- lib/webvtt/cue.rb
+- lib/webvtt/file.rb
+- lib/webvtt/version.rb
+- test/cue_test.rb
+- test/examples/tolson.vtt
+- test/file_test.rb
+- test/test_helper.rb
+- webvtt.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: webvtt
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: WEBVTT file parser in Ruby
+test_files: []
+has_rdoc: