webvtt 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33346cca4ae0f29174876b0c91317cc90dc0276acfe13f1cd864ed337aceacee
+  data.tar.gz: 2f8f94c67ef2975a1a81411fee61566bae61fe783c49dbb2277222be44bbdb8e
+SHA512:
+  metadata.gz: 2edea0396a20e84836eba4a68f30f97c8bd4f535cc0fcd5dc5b7f9d04501c61136e0ae2e4e0c3b445df0e67c42ebe9e0487f4192ea6fe4d40a9dcaed95d40771
+  data.tar.gz: 58ab94b4e640f4b2dd7ec7dedc52e8fadb7f7b0665e8af708d9fb7314f34dafcdf22f2fc273d4c800bff0cb35bbe3d818ad91176c1a68c1e6dc862d98514f5fd

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.byebug*

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.10"
+  - "2.2.10"
+  - "2.3.8"
+  - "2.4.9"
+  - "2.5.7"
+  - "2.6.5"
+  - "2.7.0"
+
+# uncomment this line if your project needs to run something other than `rake`:
+script: rake test

data/README.md

@@ -4,6 +4,7 @@ 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.
 
+[![Build Status](https://travis-ci.org/jronallo/webvtt.png)](https://travis-ci.org/jronallo/webvtt)
 
 # Story
 
@@ -25,7 +26,7 @@ Based on this WebVTT:
 WEBVTT
 
 1
-00:00:00 --> 00:00:03.000 D:vertical A:start
+00:00:00.000 --> 00:00:03.000 D:vertical A:start
 I grew up in Eastern North Carolina, <b>Edgecombe</b> County
 
 2
@@ -40,7 +41,7 @@ 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].start #=> '00:00:00.000'
 vtt.cues[0].end   #=> '00:00:03.000'
 vtt.cues[0].identifier #=> '1'
 vtt.cues[0].settings   #=> 'D:vertical A:start'

data/lib/webvtt/file.rb

@@ -2,7 +2,7 @@
 module Webvtt
   class File
 
-    attr_accessor :file, :cues
+    attr_accessor :file, :cues, :header_lines
 
     def initialize(input_file)
       if input_file.is_a?(String)
@@ -18,6 +18,7 @@ module Webvtt
         raise
       end
       @cues = []
+      @header_lines = []
       parse
     end
 
@@ -26,24 +27,34 @@ module Webvtt
       if !webvtt_line?(file.lines.first)
         raise Webvtt::MalformedError
       end
+      in_header = true
       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 webvtt_line?(line)
+          next
+        end
         if line.empty?
-          if !collected_lines.empty? and !notes?(collected_lines)
-            add_a_cue(collected_lines) 
+          # If the line is empty then we can't be in the header anymore.
+          if in_header
+            in_header = false
+          else
+            if !collected_lines.empty? and !notes?(collected_lines)
+              add_a_cue(collected_lines)
+            end
+            collected_lines = []
           end
-          collected_lines = []
-        elsif !line.empty? and file_lines.length == (index + 1)
+        elsif !line.empty? and file_lines.length == (index + 1) # add our last cue
           collected_lines << line
           add_a_cue(collected_lines)
+        elsif in_header
+          header_lines << line
         else
-          collected_lines << line          
-        end  
+          collected_lines << line
+        end
       end
     end
 
@@ -62,16 +73,17 @@ private
       if collected_lines.first.include?('-->')
         cue_opts[:identifier] = nil
         cue_opts[:cue_line] = collected_lines.first
+        cue_opts[:text] = collected_lines[1..-1].join("\n")
       elsif collected_lines[1].include?('-->')
         cue_opts[:identifier] = collected_lines.first
         cue_opts[:cue_line] = collected_lines[1]
+        cue_opts[:text] = collected_lines[2..-1].join("\n")
       end
-      cue_opts[:text] = collected_lines[2..-1].join('')
       cues << Cue.new(cue_opts)
     end
 
     def notes?(collected_lines)
-      if collected_lines.first.match(/^NOTES/)
+      if collected_lines.first.match(/^NOTE/)
         true
       else
         false

data/lib/webvtt/version.rb

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

data/test/cue_test.rb

@@ -16,12 +16,12 @@ class WebvttCueTest < Test::Unit::TestCase
   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")
+    cue = Webvtt::Cue.new(:identifier => "1", :cue_line => "00:00:00.000 --> 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:00.000', 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
 
 end

data/test/examples/no-identifier.vtt

@@ -0,0 +1,15 @@
+WEBVTT
+editor: Brian Dietz
+
+NOTE This is a note.
+
+00:00:00.000 --> 00:00:03.000 D:vertical A:start
+I grew up in Eastern North Carolina, <b>Edgecombe</b> County
+
+NOTE
+This is also
+a note.
+
+00:00:03.300 --> 00:00:07.800
+on a tobacco and dairy farm outside of
+Tarboro.

data/test/examples/tolson.vtt

@@ -1,16 +1,17 @@
 WEBVTT
+editor: Brian Dietz
 
-NOTES This is a note.
+NOTE This is a note.
 
 1
-00:00:00 --> 00:00:03.000 D:vertical A:start
+00:00:00.000 --> 00:00:03.000 D:vertical A:start
 I grew up in Eastern North Carolina, <b>Edgecombe</b> County
 
-NOTES
+NOTE
 This is also
 a note.
 
 2
 00:00:03.300 --> 00:00:07.800 A:start
-on a tobacco and dairy farm outside of 
-Tarboro.
+on a tobacco and dairy farm outside of
+Tarboro.

data/test/file_test.rb

@@ -23,12 +23,12 @@ class WebvttFileTest < Test::Unit::TestCase
 
   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)    
+    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)    
+    assert Webvtt::File.new(file)
   end
 
   test "should have a file method" do
@@ -39,7 +39,7 @@ class WebvttFileTest < Test::Unit::TestCase
     assert @vtt.file.include?('WEBVTT')
   end
 
-  test "should have a list of cues" do    
+  test "should have a list of cues" do
     assert @vtt.respond_to?(:cues)
     assert @vtt.cues.is_a?(Array)
   end
@@ -51,14 +51,14 @@ class WebvttFileTest < Test::Unit::TestCase
   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:00.000", 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
+    assert_equal "on a tobacco and dairy farm outside of\nTarboro.", @vtt.cues.last.text
   end
 
-end
+end

data/test/no_identifier_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class WebvttNoIdentifierFileTest < Test::Unit::TestCase
+
+  setup do
+    path = File.expand_path(File.dirname(__FILE__))
+    @file_path = File.join(path, 'examples', 'no-identifier.vtt')
+    @vtt = Webvtt::File.new(@file_path)
+  end
+
+  test "first cue with no identifier should be correct" do
+    first_cue = @vtt.cues.first
+    assert_equal nil, first_cue.identifier
+    assert_equal "00:00:00.000", 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 "second cue with no identifier and no settings should be correct" do
+    last_cue = @vtt.cues.last
+    assert_equal nil, last_cue.identifier
+    assert_equal "00:00:03.300", last_cue.start
+    assert_equal "00:00:07.800", last_cue.end
+    assert_equal "", last_cue.settings
+    assert_equal "on a tobacco and dairy farm outside of\nTarboro.", last_cue.text
+  end
+
+end

data/test/test_helper.rb

@@ -2,4 +2,4 @@
 require 'rubygems'
 require 'test-unit'
 require 'webvtt'
-
+require 'byebug'

data/webvtt.gemspec

@@ -5,9 +5,10 @@ require "webvtt/version"
 Gem::Specification.new do |s|
   s.name        = "webvtt"
   s.version     = Webvtt::VERSION
+  s.licenses    = ['MIT']
   s.authors     = ["Jason Ronallo"]
   s.email       = ["jronallo@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/jronallo/webvtt"
   s.summary     = %q{WEBVTT file parser in Ruby}
   s.description = %q{WEBVTT file parser in Ruby}
 
@@ -19,4 +20,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_development_dependency "test-unit", [">= 2.5.0"]
   s.add_development_dependency "guard-test", [">= 0.5.0"]
+  s.add_development_dependency "byebug"
 end

metadata

@@ -1,48 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: webvtt
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Jason Ronallo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-17 00:00:00.000000000 Z
+date: 2021-04-21 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
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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 file parser in Ruby
 email:
 - jronallo@gmail.com
@@ -50,7 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -61,38 +71,33 @@ files:
 - lib/webvtt/file.rb
 - lib/webvtt/version.rb
 - test/cue_test.rb
+- test/examples/no-identifier.vtt
 - test/examples/tolson.vtt
 - test/file_test.rb
+- test/no_identifier_test.rb
 - test/test_helper.rb
 - webvtt.gemspec
-homepage: ''
-licenses: []
+homepage: https://github.com/jronallo/webvtt
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3014810322973854166
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3014810322973854166
 requirements: []
-rubyforge_project: webvtt
-rubygems_version: 1.8.24
+rubygems_version: 3.0.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: WEBVTT file parser in Ruby
 test_files: []