voot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f0b1b7d1b82d3b452c84daabe479a407bd86e14
+  data.tar.gz: c89d119e5d1365d2943e597311c567b44f063f82
+SHA512:
+  metadata.gz: e784362950fbe7b40259284438202fffbb250297340e71ebd07ec978dc78f13ee5b22f74c6d4321dc3b398b6f764da59e8fe5b770f203231d70e4f930a5b8f71
+  data.tar.gz: 4e19b0731cb1d9507d6d3e322fdd07c7737ea6a099f71341a5e2e024563f6b0e9854ffa42f8ab60d8ab4e573e994a2f541c3ff853de856497fbce77bf2ef426a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+voot

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p195

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 2.0.0
+script: script/ci.sh

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Doc Ritezel
+
+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,27 @@
+# Voot
+
+[![Build Status](https://travis-ci.org/minifast/voot.png)](https://travis-ci.org/minifast/voot) [![Code Climate](https://codeclimate.com/github/minifast/voot.png)](https://codeclimate.com/github/minifast/voot)
+
+Voot lets you read and write WebVTT files with great ease.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'voot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voot
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/voot.rb

@@ -0,0 +1,5 @@
+require "voot/version"
+require "voot/vtt"
+
+module Voot
+end

data/lib/voot/cue.rb

@@ -0,0 +1,25 @@
+require "voot/cue_timing"
+
+module Voot
+  class Cue
+    attr_reader :identifier, :cue_timing, :payload
+
+    def initialize(options = {})
+      @identifier = options[:identifier]
+      @cue_timing = options.fetch(:cue_timing)
+      @payload = options.fetch(:payload)
+    end
+
+    def has_identifier?
+      !identifier.nil? && identifier.length > 0
+    end
+
+    def to_webvtt
+      if has_identifier?
+        "#{identifier}\n#{cue_timing.to_webvtt}\n#{payload}"
+      else
+        "#{cue_timing.to_webvtt}\n#{payload}"
+      end
+    end
+  end
+end

data/lib/voot/cue_list.rb

@@ -0,0 +1,10 @@
+require "voot/cue"
+
+module Voot
+  class CueList < Array
+
+    def to_webvtt
+      map(&:to_webvtt).join("\n\n")
+    end
+  end
+end

data/lib/voot/cue_timing.rb

@@ -0,0 +1,32 @@
+module Voot
+  class CueTiming
+    attr_reader :start_seconds, :end_seconds
+
+    def initialize(options = {})
+      @start_seconds = options.fetch(:start_seconds)
+      @end_seconds = options.fetch(:end_seconds)
+    end
+
+    def to_webvtt
+      "#{format_timestamp(start_seconds)} --> #{format_timestamp(end_seconds)}"
+    end
+
+    private
+
+    def format_timestamp(seconds)
+      "#{format_minutes(seconds)}:#{format_seconds(seconds)}.#{format_subseconds(seconds)}"
+    end
+
+    def format_minutes(seconds)
+      (seconds.to_i / 60).to_s.rjust(2, "0")
+    end
+
+    def format_seconds(seconds)
+      (seconds.to_i % 60).to_s.rjust(2, "0")
+    end
+
+    def format_subseconds(seconds)
+      ((seconds * 1000).round % 1000).to_s.rjust(3, "0")
+    end
+  end
+end

data/lib/voot/version.rb

@@ -0,0 +1,3 @@
+module Voot
+  VERSION = "0.1.0"
+end

data/lib/voot/vtt.rb

@@ -0,0 +1,40 @@
+require "voot/cue_list"
+
+module Voot
+  class Vtt
+    attr_reader :path
+    attr_accessor :header
+
+    def initialize(options = {})
+      @path = options.fetch(:path)
+      @header = options[:header]
+    end
+
+    def cues
+      @cues ||= Voot::CueList.new
+    end
+
+    def to_webvtt
+      if has_header?
+        "WEBVTT #{header}\n\n#{cues.to_webvtt}"
+      else
+        "WEBVTT\n\n#{cues.to_webvtt}"
+      end
+    end
+
+    def has_header?
+      !header.nil? && header.length > 0
+    end
+
+    def save
+      ensure_destination_directory
+      File.open(path, "w") { |destination| destination.write(to_webvtt) }
+    end
+
+    private
+
+    def ensure_destination_directory
+      FileUtils.mkdir_p(File.dirname(path))
+    end
+  end
+end

data/script/ci.sh

@@ -0,0 +1 @@
+bundle exec rspec

data/spec/lib/voot/cue_list_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Voot::CueList do
+  subject(:cue_list) { Voot::CueList.new }
+
+  describe "#to_webvtt" do
+    context "when the list is empty" do
+      its(:to_webvtt) { should be_empty }
+    end
+
+    context "when the list has an item in it" do
+      before { cue_list << create_cue("reasonably priced", 0, 0) }
+
+      its(:to_webvtt) { should == "00:00.000 --> 00:00.000\nreasonably priced" }
+
+      context "when the list has multiple items" do
+        before { cue_list << create_cue("toiletries", 1, 1) }
+
+        its(:to_webvtt) { should include "00:01.000 --> 00:01.000\ntoiletries" }
+      end
+    end
+  end
+end

data/spec/lib/voot/cue_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe Voot::Cue do
+  let(:identifier) { "taco massacre" }
+  let(:payload) { "tasty" }
+  let(:cue_timing) { Voot::CueTiming.new(start_seconds: 0, end_seconds: 1) }
+
+  subject(:cue) do
+    Voot::Cue.new(
+      identifier: identifier,
+      cue_timing: cue_timing,
+      payload: payload
+    )
+  end
+
+  describe "#has_identifier?" do
+    context "when the identifier is set" do
+      it { should have_identifier }
+    end
+
+    context "when the identifier is nil" do
+      let(:identifier) { nil }
+
+      it { should_not have_identifier }
+    end
+
+    context "when the identifier is an empty string" do
+      let(:identifier) { "" }
+
+      it { should_not have_identifier }
+    end
+  end
+
+  describe "#to_webvtt" do
+    context "when the identifier is set" do
+      its(:to_webvtt) { should == "taco massacre\n00:00.000 --> 00:01.000\ntasty" }
+    end
+
+    context "when the identifier is not set" do
+      let(:identifier) { nil }
+
+      its(:to_webvtt) { should == "00:00.000 --> 00:01.000\ntasty" }
+    end
+  end
+end

data/spec/lib/voot/cue_timing_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Voot::CueTiming do
+  let(:start_seconds) { 1.0001 }
+  let(:end_seconds) { 65.0009 }
+
+  subject(:cue_timing) do
+    Voot::CueTiming.new(
+      start_seconds: start_seconds,
+      end_seconds: end_seconds
+    )
+  end
+
+  its(:to_webvtt) { should == "00:01.000 --> 01:05.001" }
+end

data/spec/lib/voot/vtt_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe Voot::Vtt do
+  let(:vtt_path) { Tempfile.new("voot-file").path }
+
+  subject(:vtt) { Voot::Vtt.new(path: vtt_path) }
+
+  describe "#save" do
+    context "when the file does not exist" do
+      before { FileUtils.rm(vtt_path) }
+
+      it "creates the file" do
+        expect do
+          vtt.save
+        end.to change { File.exist?(vtt_path) }.to(true)
+      end
+    end
+
+    context "when the file exists" do
+      let(:pesky_user_data) { "hey guys tacos are great right" }
+
+      before { File.write(vtt_path, pesky_user_data) }
+
+      it "clobbers the file content" do
+        expect do
+          vtt.save
+        end.to change { File.read(vtt_path) }.from(pesky_user_data)
+      end
+    end
+  end
+
+  describe "#has_header?" do
+    before { vtt.header = header }
+
+    context "when the header is an empty string" do
+      let(:header) { "" }
+
+      it { should_not have_header }
+    end
+
+    context "when the header is nil" do
+      let(:header) { nil }
+
+      it { should_not have_header }
+    end
+
+    context "when the header not empty or nil" do
+      let(:header) { "geese on parade" }
+
+      it { should have_header }
+    end
+  end
+
+  describe "#to_webvtt" do
+    context "when the header is empty" do
+      its(:to_webvtt) { should == "WEBVTT\n\n" }
+    end
+
+    context "when the header has content" do
+      before { vtt.header = "here is a video of abbey the cat" }
+
+      its(:to_webvtt) { should == "WEBVTT here is a video of abbey the cat\n\n" }
+    end
+
+    context "when there is a cue" do
+      before { vtt.cues << create_cue("not the drill!", 0, 2) }
+
+      its(:to_webvtt) { should == "WEBVTT\n\n00:00.000 --> 00:02.000\nnot the drill!" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$:<< File.expand_path("../../lib", __FILE__)
+
+require "voot"
+
+Dir.glob(File.expand_path("../support/**/*.rb", __FILE__)) { |f| require f }
+
+RSpec.configure do |config|
+  config.include CueHelper
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/support/cue_helper.rb

@@ -0,0 +1,6 @@
+module CueHelper
+  def create_cue(payload, start, stop)
+    cue_timing = Voot::CueTiming.new(start_seconds: start, end_seconds: stop)
+    Voot::Cue.new(cue_timing: cue_timing, payload: payload)
+  end
+end

data/voot.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'voot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "voot"
+  spec.version       = Voot::VERSION
+  spec.authors       = ["Doc Ritezel"]
+  spec.email         = ["doc@minifast.co"]
+  spec.description   = %q{WebVTT generation, parsing and manipulation}
+  spec.summary       = %q{Easily create, read and write WebVTT files}
+  spec.homepage      = "https://github.com/minifast/voot"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = `git ls-files -- bin`.split("\n").map { |f| File.basename(f) }
+  spec.test_files    = `git ls-files -- spec`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "gem-release"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: voot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Doc Ritezel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: guard-rspec
+  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: guard-bundler
+  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: gem-release
+  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: WebVTT generation, parsing and manipulation
+email:
+- doc@minifast.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/voot.rb
+- lib/voot/cue.rb
+- lib/voot/cue_list.rb
+- lib/voot/cue_timing.rb
+- lib/voot/version.rb
+- lib/voot/vtt.rb
+- script/ci.sh
+- spec/lib/voot/cue_list_spec.rb
+- spec/lib/voot/cue_spec.rb
+- spec/lib/voot/cue_timing_spec.rb
+- spec/lib/voot/vtt_spec.rb
+- spec/spec_helper.rb
+- spec/support/cue_helper.rb
+- voot.gemspec
+homepage: https://github.com/minifast/voot
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Easily create, read and write WebVTT files
+test_files:
+- spec/lib/voot/cue_list_spec.rb
+- spec/lib/voot/cue_spec.rb
+- spec/lib/voot/cue_timing_spec.rb
+- spec/lib/voot/vtt_spec.rb
+- spec/spec_helper.rb
+- spec/support/cue_helper.rb