caption 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 253b1a76e4bc45787e81d52eefb307bcd9c61335
+  data.tar.gz: 336fbbe7e7050eefdde4f3db158c78a5255e545e
+SHA512:
+  metadata.gz: 02a92d14ce44fb1d7e7572499ffc05f8938376703dd7838b1face3fbe96df6feefd286f62ee9ae7fde904ab8c206bdf146a7b1cd34ed0cc0aaefd7c11bd6ca91
+  data.tar.gz: 8d4835fb353f4b8d189e4fdca33a68f5ff7e5bf9310d2c8814b75d61d6edc994941bb85fd01ab615f645b3bd225073d29fd518f7ea170739ee1b0cdcf7caaf3a

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alan Johnson
+
+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,29 @@
+# Caption
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'caption'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caption
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/caption.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caption/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "caption"
+  spec.version       = Caption::VERSION
+  spec.authors       = ["Alan Johnson"]
+  spec.email         = ["alan@commondream.net"]
+  spec.description   = %q{Parse and work with captions.}
+  spec.summary       = %q{Parse and work with captions. Supports SRT for now.}
+  spec.homepage      = "https://github.com/commondream/caption"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+end

data/lib/caption.rb

@@ -0,0 +1,6 @@
+require_relative 'caption/version'
+require_relative 'caption/caption_block'
+require_relative 'caption/srt_parser'
+
+module Caption
+end

data/lib/caption/caption_block.rb

@@ -0,0 +1,20 @@
+module Caption
+  class CaptionBlock
+    attr_accessor :start_time, :end_time, :content
+
+    # Public: Sets up a new CaptionBlock with the given
+    # start_time, end_time, and content.
+    #
+    # start_time - Offset in milliseconds from the
+    #   beginning of the video to this `CaptionBlock`
+    # end_time - Offset in milliseconds from the
+    #   beginning of the video to the end of this
+    #   `CaptionBlock`
+    # content - The contents of this `CaptionBlock`
+    def initialize(start_time, end_time, content)
+      self.start_time  = start_time
+      self.end_time = end_time
+      self.content = content
+    end
+  end
+end

data/lib/caption/srt_parser.rb

@@ -0,0 +1,64 @@
+module Caption
+  class SrtParser
+    attr_accessor :data
+
+    # Public: Sets up a new parser based on the given
+    # data.
+    def initialize(data)
+      self.data = data
+    end
+
+    # Public: Converts the caption data to a set of
+    # `CaptionBlock` objects.
+    #
+    # Returns an array of `CaptionBlock`s
+    def parse
+      blocks = []
+      block_content = ""
+      data.each_line do |line|
+        if line.strip.empty?
+          blocks << parse_caption_block(block_content) unless block_content.empty?
+          block_content = ""
+        else
+          block_content += line
+        end
+      end
+
+      # Handle any final content
+      blocks << parse_caption_block(block_content) unless block_content.empty?
+
+      blocks
+    end
+
+    # Internal: Converts a caption block in the SRT
+    # data to a `CaptionBlock` object.
+    #
+    # block_content - The text for the content block
+    #   to parse.
+    #
+    # Returns a `CaptionBlock`
+    def parse_caption_block(block_content)
+      lines = block_content.split("\n")
+
+      time_line = lines[1]
+      times = time_line.split("-->")
+      times = times.map { |t| t.strip }
+
+      start_time = subrip_time_to_ms(times[0])
+      end_time = subrip_time_to_ms(times[1])
+      content = lines[2..-1].join("\n")
+
+      CaptionBlock.new(start_time, end_time, content)
+    end
+
+    # Internal: Converts a subrip time code to milliseconds
+    #
+    # subrip_time  - The subrip time string
+    def subrip_time_to_ms(subrip_time)
+      seconds, millis = subrip_time.split(",")
+      hours, minutes, seconds = seconds.split(":")
+
+      millis.to_i + (seconds.to_i * 1000) + (minutes.to_i * 60000) + (hours.to_i * 3600000)
+    end
+  end
+end

data/lib/caption/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/caption'

data/spec/srt_parser_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+module Caption
+  describe SrtParser do
+    describe "#parse" do
+      let(:parser) { SrtParser.new <<EOF
+1
+00:00:00,000 --> 00:00:13,000
+[?Jazzy music playing?]
+
+2
+00:00:14,000 --> 00:00:16,000
+In the previous lesson, we learned how to encode
+
+3
+00:00:16,000 --> 00:00:18,000
+and embed a video into our page.
+
+4
+00:00:18,000 --> 00:00:23,000
+In this lesson, we're going to learn about the JavaScript API for interacting with our videos
+EOF
+      }
+
+      it "returns the correct number of blocks" do
+        expect(parser.parse.length).to eq(4)
+      end
+    end
+
+    describe "#parse_caption_block" do
+      let(:parser) { SrtParser.new("") }
+
+      let(:single_line) { 
+        parser.parse_caption_block <<EOF
+3
+00:00:16,012 --> 00:00:18,293
+and embed a video into our page.
+EOF
+      }
+
+      let(:multi_line) { 
+        parser.parse_caption_block <<EOF
+3
+00:00:16,012 --> 00:00:18,293
+and embed a video into our page
+and then embed another video for kicks.
+EOF
+      }
+
+      it "parses the start_time correctly" do
+        expect(single_line.start_time).to eq(16012)
+      end
+
+      it "parses the end_time correctly" do
+        expect(single_line.end_time).to eq(18293)
+      end
+
+      it "handles single line content correctly" do
+        expect(single_line.content).to eq("and embed a video into our page.")
+      end
+
+      it "handles multi-line content correctly" do
+        expect(multi_line.content).to eq("and embed a video into our page\nand then embed another video for kicks.")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: caption
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alan Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Parse and work with captions.
+email:
+- alan@commondream.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- caption.gemspec
+- lib/caption.rb
+- lib/caption/caption_block.rb
+- lib/caption/srt_parser.rb
+- lib/caption/version.rb
+- spec/spec_helper.rb
+- spec/srt_parser_spec.rb
+homepage: https://github.com/commondream/caption
+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.6
+signing_key: 
+specification_version: 4
+summary: Parse and work with captions. Supports SRT for now.
+test_files:
+- spec/spec_helper.rb
+- spec/srt_parser_spec.rb
+has_rdoc: