caption_crunch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: caf3a7a71c735e100811ff9357ba35b07b0facfb
+  data.tar.gz: 470f3e1ad973f32f94eaf04c59b6b25aedfde7c6
+SHA512:
+  metadata.gz: faa7aaebfb7b28c603edba951aab611446426f926d7dd5410dcb3f2740b817ed9147947205fb35036d9025fb003c8d6b3132a158912165f3030598206dac2652
+  data.tar.gz: edb3692d122205d637c2a4f64e7a6fe7deb44002aee9dde51556b75c52592536073710f8b576795605715b874a9f85b6f7d69f39daa3e31b3750af0c22ce2e89

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kickstarter
+
+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,41 @@
+# CaptionCrunch
+
+Praise @noopkat for the name.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'caption_crunch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caption_crunch
+
+## Usage
+
+```ruby
+require 'caption_crunch'
+track = CaptionCrunch.parse(File.new('sample.vtt')) # returns a CaptionCrunch::Track instance
+# or
+track = CaptionCrunch.parse('WEBVTT')
+
+# track.cues is an array of CaptionCrunch::Cue instances
+track.cues.first.start_time
+track.cues.first.end_time
+track.cues.first.payload
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kickstarter/caption_crunch/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/Rakefile

@@ -0,0 +1,14 @@
+require "rubygems"
+require "bundler/setup"
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.pattern = "spec/*_spec.rb"
+  end
+end
+
+desc 'Run tests'
+task :test => %w[test:units]
+
+task :default => :test

data/caption_crunch.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caption_crunch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "caption_crunch"
+  spec.version       = CaptionCrunch::VERSION
+  spec.authors       = ["David Peter"]
+  spec.email         = ["dpeter@kickstarter.com"]
+  spec.summary       = %q{A collection of parsers for various caption/subtitle files}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.2'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rack-test'
+end

data/lib/caption_crunch/adapters/vtt.rb

@@ -0,0 +1,103 @@
+module CaptionCrunch
+  module Adapters
+    class VTT
+      SIGNATURE_REGEX = /\AWEBVTT\Z|\AWEBVTT[ \t]/.freeze
+      COMMENT_REGEX   = /\ANOTE\Z|\ANOTE[ \t\n]/.freeze
+      ARROW_REGEX     = /-->/.freeze
+      # Format: hour:minute:second.milliseconds
+      #         hour: is optional.
+      #         11:22:33
+      #         00:11:22:333
+      #         102:01:43:204
+      # http://dev.w3.org/html5/webvtt/#dfn-collect-a-webvtt-timestamp
+      TIME_REGEX      = /\A(?:(\d\d+):)?([0-5]\d):([0-5]\d)\.(\d\d\d)\Z/.freeze
+      NEWLINE_REGEX   = /\r\n|\r|\n/.freeze
+
+      class << self
+        # Reads a file (or string) and returns a CaptionCrunch::Track instance.
+        # Raises CaptionCrunch::ParseError if the input is malformed.
+        def parse(file)
+          contents = remove_bom(read_file(file))
+          segments = split_segments(contents)
+          ensure_signature(segments.shift)
+
+          Track.new.tap do |track|
+            segments.each do |segment|
+              next if comment?(segment)
+              track.cues << parse_cue(segment)
+            end
+          end
+        end
+
+        protected
+
+        # Returns a string corresponding to the contents of a File instance.
+        # Alternatively, if the argument is not a File, simply calls `.to_s`.
+        def read_file(file)
+          case file
+          when File then file.read
+          else file.to_s
+          end.strip
+        end
+
+        def remove_bom(string)
+          if string[0] == "\uFEFF"
+            string.slice(1..-1)
+          else
+            string
+          end
+        end
+
+        # The WebVTT spec separates segments by two newlines or more.
+        def split_segments(string)
+          string.split(/#{NEWLINE_REGEX}{2,}/)
+        end
+
+        def ensure_signature(segment)
+          if segment !~ SIGNATURE_REGEX
+            raise ParseError, 'File must start with WEBVTT'
+          end
+        end
+
+        def comment?(segment)
+          segment =~ COMMENT_REGEX
+        end
+
+        # Turns a segment into a new CaptionCrunch::Cue instance.
+        def parse_cue(segment)
+          parts = segment.split(NEWLINE_REGEX)
+          # ignore optional identifier for now
+          parts.shift unless parts[0] =~ ARROW_REGEX
+
+          # parse time and cue settings
+          times = parts.shift.to_s.split(ARROW_REGEX)
+          raise ParseError, "Cue timings missing: #{segment}" if times.size != 2
+          start_time = times.first.strip
+          end_time, settings = times.last.strip.split(/\s+/, 2)
+
+          # parse payload
+          payload = parts.map(&:strip).join("\n")
+
+          Cue.new.tap do |cue|
+            cue.start_time = parse_time(start_time)
+            cue.end_time = parse_time(end_time)
+            cue.payload = payload
+          end
+        end
+
+        # Converts a timestamp into an integer representing the milliseconds.
+        def parse_time(timestamp)
+          match = TIME_REGEX.match(timestamp.strip)
+          raise ParseError, "Invalid timestamp: #{timestamp}" unless match
+          captures = match.captures
+          integer = 0
+          integer += captures.pop.to_i                  # msecs
+          integer += captures.pop.to_i * 1000           # secs
+          integer += captures.pop.to_i * 1000 * 60      # mins
+          integer += captures.pop.to_i * 1000 * 60 * 60 # hours
+          integer
+        end
+      end
+    end
+  end
+end

data/lib/caption_crunch/adapters.rb

@@ -0,0 +1 @@
+require 'caption_crunch/adapters/vtt'

data/lib/caption_crunch/cue.rb

@@ -0,0 +1,5 @@
+module CaptionCrunch
+  class Cue
+    attr_accessor :start_time, :end_time, :payload
+  end
+end

data/lib/caption_crunch/parse_error.rb

@@ -0,0 +1,4 @@
+module CaptionCrunch
+  class ParseError < StandardError
+  end
+end

data/lib/caption_crunch/track.rb

@@ -0,0 +1,9 @@
+module CaptionCrunch
+  class Track
+    attr_reader :cues
+
+    def initialize()
+      @cues = []
+    end
+  end
+end

data/lib/caption_crunch/version.rb

@@ -0,0 +1,3 @@
+module CaptionCrunch
+  VERSION = "0.0.1"
+end

data/lib/caption_crunch.rb

@@ -0,0 +1,13 @@
+module CaptionCrunch
+  # Delegates to Adapters::VTT.parse.
+  # Returns a CaptionCrunch::Track instance
+  def self.parse(file)
+    Adapters::VTT.parse(file)
+  end
+end
+
+require "caption_crunch/version"
+require 'caption_crunch/parse_error'
+require 'caption_crunch/track'
+require 'caption_crunch/cue'
+require 'caption_crunch/adapters'

data/spec/caption_crunch_spec.rb

@@ -0,0 +1,131 @@
+require_relative './spec_helper'
+
+describe 'CaptionCrunch' do
+  describe 'parse' do
+    describe 'parsing entirely wrong signature' do
+      it 'should raise CaptionCrunch::ParseError' do
+        error = ->{
+          CaptionCrunch.parse('SPIDERWEBVTT')
+        }.must_raise CaptionCrunch::ParseError
+        error.message.must_match /File must start with WEBVTT/
+      end
+    end
+
+    describe 'parsing valid signature' do
+      it 'should not raise CaptionCrunch::ParseError' do
+        CaptionCrunch.parse("WEBVTT\t-- here is some stuff")
+      end
+    end
+
+    describe 'parsing signature starting with WEBVTT but no space after' do
+      it 'should raise CaptionCrunch::ParseError' do
+        error = ->{
+          CaptionCrunch.parse('WEBVTTINVALID')
+        }.must_raise CaptionCrunch::ParseError
+        error.message.must_match /File must start with WEBVTT/
+      end
+    end
+
+    describe 'parsing signature starting and ending with WEBVTT' do
+      it 'should not raise CaptionCrunch::ParseError' do
+        CaptionCrunch.parse('WEBVTT')
+      end
+    end
+
+    describe 'parsing signature with a BOM' do
+      it 'should not raise CaptionCrunch::ParseError' do
+        CaptionCrunch.parse("\uFEFFWEBVTT")
+      end
+    end
+
+    describe 'parsing a track with three cues' do
+      subject { CaptionCrunch.parse(fixture('three_cues.vtt')) }
+      it 'should return an object with three cues' do
+        subject.cues.size.must_equal(3)
+      end
+
+      it 'should parse cue start times' do
+        start_time = 1 * 60 * 60 * 1000 + 2 * 60 * 1000 + 25 * 1000 + 500
+        subject.cues.last.start_time.must_equal(start_time)
+      end
+
+      it 'should parse cue end times' do
+        subject.cues.first.end_time.must_equal(2000)
+      end
+
+      it 'should parse cue end times with >=100 hours' do
+        end_time = 201 * 60 * 60 * 1000 + 3 * 60 * 1000 + 15 * 1000
+        subject.cues.last.end_time.must_equal(end_time)
+      end
+
+      it 'should parse cue end times with settings after' do
+        end_time = 15 * 1000
+        subject.cues[1].end_time.must_equal(end_time)
+      end
+
+      it 'should parse cue payloads' do
+        subject.cues.last.payload.must_equal('TTYL.')
+      end
+
+      it 'should support multi-line cue payloads' do
+        subject.cues[1].payload.must_equal(%Q{
+- I don't like shrimp, but I like ramen. All kinds of ramen. Miso ramen, tonkotsu ramen, shoyu ramen, Totto ramen...
+- That's nice.
+        }.strip)
+      end
+    end
+
+    describe 'parsing cue with invalid minutes' do
+      it 'should raise CaptionCrunch::ParseError' do
+        error = ->{
+          CaptionCrunch.parse(%Q{WEBVTT
+
+            00:60:00.000 --> 01:02:00.000
+            I'm invalid!
+          })
+        }.must_raise CaptionCrunch::ParseError
+        error.message.must_match /Invalid timestamp/
+      end
+    end
+
+    describe 'parsing cue without timings' do
+      it 'should raise CaptionCrunch::ParseError' do
+        error = ->{
+          CaptionCrunch.parse(%Q{WEBVTT
+
+            I'm invalid!
+            Woot!
+          })
+        }.must_raise CaptionCrunch::ParseError
+        error.message.must_match /Cue timings missing/
+      end
+    end
+
+    describe 'parsing cue with invalid seconds' do
+      it 'should raise CaptionCrunch::ParseError' do
+        error = ->{
+          CaptionCrunch.parse(%Q{WEBVTT
+
+            00:00:60.000 --> 01:02:00.000
+            I'm invalid!
+          })
+        }.must_raise CaptionCrunch::ParseError
+        error.message.must_match /Invalid timestamp/
+      end
+    end
+
+    describe 'parsing cue with invalid milliseconds' do
+      it 'should raise CaptionCrunch::ParseError' do
+        error = ->{
+          CaptionCrunch.parse(%Q{WEBVTT
+
+            00:00:00.1000 --> 01:02:00.000
+            I'm invalid!
+          })
+        }.must_raise CaptionCrunch::ParseError
+        error.message.must_match /Invalid timestamp/
+      end
+    end
+
+  end
+end

data/spec/fixtures/three_cues.vtt

@@ -0,0 +1,15 @@
+WEBVTT - Lots of ramen
+
+  1
+  00:00:00.000 --> 00:02.000
+  - Here are some things I like.
+  - Uh, I don't really want to know.
+
+  2
+  00:00:02.001 --> 00:00:15.000 align:start line:0 position:50%
+  - I don't like shrimp, but I like ramen. All kinds of ramen. Miso ramen, tonkotsu ramen, shoyu ramen, Totto ramen...
+  - That's nice.
+
+  3
+  01:02:25.500 --> 201:03:15.000
+  TTYL.

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "bundler/setup"
+
+require "minitest/autorun"
+require "minitest/pride"
+require "caption_crunch"
+
+class MiniTest::Spec
+  def fixture(path)
+    path = File.join(File.dirname(__FILE__), 'fixtures', path)
+    File.open(path)
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: caption_crunch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Peter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: 
+email:
+- dpeter@kickstarter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- caption_crunch.gemspec
+- lib/caption_crunch.rb
+- lib/caption_crunch/adapters.rb
+- lib/caption_crunch/adapters/vtt.rb
+- lib/caption_crunch/cue.rb
+- lib/caption_crunch/parse_error.rb
+- lib/caption_crunch/track.rb
+- lib/caption_crunch/version.rb
+- spec/caption_crunch_spec.rb
+- spec/fixtures/three_cues.vtt
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 2.1.2
+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: A collection of parsers for various caption/subtitle files
+test_files:
+- spec/caption_crunch_spec.rb
+- spec/fixtures/three_cues.vtt
+- spec/spec_helper.rb