webvtt-ruby 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a60d420e7d42cd04d58877cc991c712883b43bd0
-  data.tar.gz: 229298792a3155b95e55bf367ceecff6777d5a9f
+  metadata.gz: 750601959beae93666af734645757e22a9f8fe2d
+  data.tar.gz: ce85964a436d8459dc409503ff61e8ae12ba33b3
 SHA512:
-  metadata.gz: 6e1664360e303747834f789fe24b7cc23b52ce833ee68f258be9e552ea256196400de0cd6a8631dabae4de812878af1724d52a2dbe3be1798c5f7e3260b4fef6
-  data.tar.gz: 00eacc64841a13c34832de3d869980883c3598084260f3917211aa70a955b5cd9803c5cf637e210356f5f206f9b61247c89de06079a4799530ab10235bce2d03
+  metadata.gz: 9d4c6238c8c843bb83955db872f2b7ad51281e64074e8c1beecb30e9fb1ef930e4f0344d1db7e4243c63f5625b6c575d3d55947d8c8555887a2fcf19ea380081
+  data.tar.gz: f250cac70bf7c1a534f518ca013fe04c8a7d422686d8cb7439ff3621b4410d35b2aab69f7ed3456c2ed7a8db25c8ca2c0e0dd4ce032297e2eedfeddde48680f4

data/Gemfile

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem "minitest", group: :development
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    webvtt-ruby (0.2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  webvtt-ruby!
+
+BUNDLED WITH
+   1.10.2

data/lib/parser.rb

@@ -17,7 +17,7 @@ module WebVTT
     # normalize new line character
     srt.gsub!("\r\n", "\n")
 
-    srt = "WEBVTT\n\n#{srt}"
+    srt = "WEBVTT\n\n#{srt}".strip
     ::File.open(output, "w") {|f| f.write(srt)}
 
     return File.new(output)
@@ -53,7 +53,9 @@ module WebVTT
     def save(output=nil)
       output ||= @path.gsub(".srt", ".vtt")
 
-      File.open(output, "w") {|f| f.write(to_webvtt)}
+      ::File.open(output, "w") do |f|
+        f.write(to_webvtt)
+      end
       return output
     end
 
@@ -107,15 +109,20 @@ module WebVTT
     end
 
     def start_in_sec
-      Cue.timestamp_in_sec(@start)
+      @start.to_f
     end
 
     def end_in_sec
-      Cue.timestamp_in_sec(@end)
+      @end.to_f
     end
 
     def length
-      end_in_sec - start_in_sec
+      @end.to_f - @start.to_f
+    end
+
+    def offset_by( offset_secs )
+      @start += offset_secs
+      @end   += offset_secs
     end
 
     def parse
@@ -130,11 +137,54 @@ module WebVTT
       end
 
       if lines[0].match(/([0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}) -+> ([0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3})(.*)/)
-        @start = $1
-        @end = $2
+        @start = Timestamp.new $1
+        @end = Timestamp.new $2
         @style = Hash[$3.strip.split(" ").map{|s| s.split(":").map(&:strip) }]
       end
       @text = lines[1..-1].join("\n")
     end
   end
-end
+
+  class Timestamp
+    def self.parse_seconds( timestamp )
+      if mres = timestamp.match(/\A([0-9]{2}):([0-9]{2}):([0-9]{2}\.[0-9]{3})\z/)
+        sec = mres[3].to_f # seconds and subseconds
+        sec += mres[2].to_f * 60 # minutes
+        sec += mres[1].to_f * 60 * 60 # hours
+      elsif mres = timestamp.match(/\A([0-9]{2}):([0-9]{2}\.[0-9]{3})\z/)
+        sec = mres[2].to_f # seconds and subseconds
+        sec += mres[1].to_f * 60 # minutes
+      else
+        raise ArgumentError.new("Invalid WebVTT timestamp format: #{timestamp.inspect}")
+      end
+
+      return sec
+    end
+
+    def initialize( time )
+      if time.is_a? Numeric
+        @timestamp = time
+      elsif time.is_a? String
+        @timestamp = Timestamp.parse_seconds( time )
+      else
+        raise ArgumentError.new("time not numeric nor a string")
+      end
+    end
+
+    def to_s
+      hms = [60,60].reduce( [ @timestamp ] ) { |m,o| m.unshift(m.shift.divmod(o)).flatten }
+      hms << (@timestamp.divmod(1).last * 1000).round
+
+      sprintf("%02d:%02d:%02d.%03d", *hms)
+    end
+
+    def to_f
+      @timestamp.to_f
+    end
+
+    def +(other)
+      Timestamp.new self.to_f + other.to_f
+    end
+
+  end
+end

data/tests/parser.rb

@@ -1,29 +1,21 @@
 $LOAD_PATH << "lib/"
-require "test/unit"
+require "minitest/autorun"
 require "webvtt"
 
-class ParserTest < Test::Unit::TestCase
+class ParserTest < Minitest::Test
   def test_can_read_webvtt
-    assert_nothing_raised(WebVTT::InputError) {
-      webvtt = WebVTT.read("tests/subtitles/test.vtt")
-      assert_equal "test.vtt", webvtt.filename
-    }
+    webvtt = WebVTT.read("tests/subtitles/test.vtt")
+    assert_equal "test.vtt", webvtt.filename
   end
 
   def test_cant_read_webvtt
-    assert_raise(WebVTT::InputError) {
+    assert_raises(WebVTT::InputError) {
       webvtt = WebVTT.read("tests/subtitles/test_.vtt")
     }
   end
 
-  def test_is_valid_webvtt
-    assert_nothing_raised(WebVTT::MalformedFile) {
-      webvtt = WebVTT.read("tests/subtitles/test.vtt")
-    }
-  end
-
   def test_is_not_valid_webvtt
-    assert_raise(WebVTT::MalformedFile) {
+    assert_raises(WebVTT::MalformedFile) {
       webvtt = WebVTT.read("tests/subtitles/notvalid.vtt")
     }
   end
@@ -44,8 +36,8 @@ class ParserTest < Test::Unit::TestCase
   def test_cue
     webvtt = WebVTT.read("tests/subtitles/test.vtt")
     cue = webvtt.cues[0]
-    assert_equal "00:00:29.000", cue.start
-    assert_equal "00:00:31.000", cue.end
+    assert_equal "00:00:29.000", cue.start.to_s
+    assert_equal "00:00:31.000", cue.end.to_s
     assert_instance_of Hash, cue.style
     assert_equal "75%", cue.style["line"]
     assert_equal "English subtitle 15 -Forced- (00:00:27.000)\nline:75%", cue.text
@@ -55,8 +47,8 @@ class ParserTest < Test::Unit::TestCase
     webvtt = WebVTT.read("tests/subtitles/test.vtt")
     cue = webvtt.cues[1]
     assert_equal "2", cue.identifier
-    assert_equal "00:00:31.000", cue.start
-    assert_equal "00:00:33.000", cue.end
+    assert_equal "00:00:31.000", cue.start.to_s
+    assert_equal "00:00:33.000", cue.end.to_s
     assert_equal ["align", "line"].sort, cue.style.keys.sort
     assert_equal ["start", "0%"].sort, cue.style.values.sort
     assert_equal "English subtitle 16 -Unforced- (00:00:31.000)\nalign:start line:0%", cue.text
@@ -154,12 +146,53 @@ The text should change)
     webvtt = WebVTT.read("tests/subtitles/no_text.vtt")
     assert_equal 2, webvtt.cues.size
     assert_equal "265", webvtt.cues[0].identifier
-    assert_equal "00:08:57.409", webvtt.cues[0].start
-    assert_equal "00:09:00.592", webvtt.cues[0].end
+    assert_equal "00:08:57.409", webvtt.cues[0].start.to_s
+    assert_equal "00:09:00.592", webvtt.cues[0].end.to_s
     assert_equal "", webvtt.cues[0].text
     assert_equal "266", webvtt.cues[1].identifier
-    assert_equal "00:09:00.593", webvtt.cues[1].start
-    assert_equal "00:09:02.373", webvtt.cues[1].end
+    assert_equal "00:09:00.593", webvtt.cues[1].start.to_s
+    assert_equal "00:09:02.373", webvtt.cues[1].end.to_s
     assert_equal "", webvtt.cues[1].text
   end
-end
+  
+  def test_cue_offset_by
+    cue = WebVTT::Cue.new <<-CUE
+    00:00:01.000 --> 00:00:25.432
+    Test Cue
+    CUE
+    assert_equal 1.0, cue.start.to_f
+    assert_equal 25.432, cue.end.to_f
+    cue.offset_by( 12.0 )
+    assert_equal 13.0, cue.start.to_f
+    assert_equal 37.432, cue.end.to_f
+  end
+
+  def test_timestamp_from_string
+    ts_str = "00:05:31.522"
+    ts = WebVTT::Timestamp.new( ts_str )
+    assert_equal ts_str, ts.to_s
+    assert_equal (5*60 + 31.522), ts.to_f
+  end
+
+  def test_timestamp_from_number
+    ts_f = (7*60 + 12.111)
+    ts = WebVTT::Timestamp.new( ts_f )
+    assert_equal "00:07:12.111", ts.to_s
+    assert_equal ts_f, ts.to_f
+  end
+
+  def test_timestamp_errors_from_unknown_type
+    assert_raises ArgumentError do
+      WebVTT::Timestamp.new( nil )
+    end
+  end
+
+  def test_timestamp_addition
+    ts = WebVTT::Timestamp.new( "01:47:32.004" )
+    ts2 = ts + (4*60 + 30)
+    assert_equal "01:52:02.004", ts2.to_s
+    ts3 = ts + ts2
+    assert_equal "03:39:34.008", ts3.to_s
+  end
+
+end

data/tests/segmenter.rb

@@ -1,9 +1,9 @@
 $LOAD_PATH << "lib/"
-require "test/unit"
+require "minitest/autorun"
 require "webvtt"
 require "fileutils"
 
-class ParserTest < Test::Unit::TestCase
+class ParserTest < Minitest::Test
 
   def test_segment_of_a_given_cue
     webvtt = WebVTT.read("tests/subtitles/test.vtt")
@@ -73,4 +73,4 @@ class ParserTest < Test::Unit::TestCase
       puts "--"
     end
   end
-end
+end

data/tests/subtitles/test.vtt

@@ -50,7 +50,7 @@ align:middle line:100%
 English subtitle 26 -Unforced- (00:00:51.000)
 position:20% size:55%
 
-00:00:53.000 --> 00:00:60.000
+00:00:53.000 --> 00:01:00.000
 English subtitle 27 -Unforced- (00:00:53.000)
 Special Characters
 œ∑´®†¥¨ˆøπ“

data/{webvtt-ruby.gemspecs → webvtt-ruby.gemspec}

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'webvtt-ruby'
-  s.version       = '0.2.5'
+  s.version       = '0.3.0'
   s.summary       = "WebVTT parser and segmenter in ruby"
   s.description   = "WebVTT parser and segmenter in ruby for HTML5 and HTTP Live Streaming (HLS)."
   s.authors       = ["Bruno Celeste"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webvtt-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Bruno Celeste
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies: []
 description: WebVTT parser and segmenter in ruby for HTML5 and HTTP Live Streaming
   (HLS).
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - bin/webvtt-segmenter
@@ -36,7 +37,7 @@ files:
 - tests/subtitles/test_from_srt.srt
 - tests/subtitles/test_from_srt.vtt
 - tests/subtitles/withnote.vtt
-- webvtt-ruby.gemspecs
+- webvtt-ruby.gemspec
 homepage: https://github.com/HeyWatch/webvtt-ruby
 licenses:
 - MIT