webvtt-ruby 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 378a27bdabf62c13b0446de29e0aefc7267ac38f67401f1bab668f1ea673edab
-  data.tar.gz: 9b68d17e5435a1ef088bc06ec1c5346cc3526dc3af5b56578c14afca6c922656
+  metadata.gz: dbbc04b66c5f332c450a62d17b3729774c89ddcc1b6bf7b20f5a694316640b18
+  data.tar.gz: f6c00383830d0715036c276e5b22d349616f60f6b736ad071097708ad68324c5
 SHA512:
-  metadata.gz: 5b7e76f6306f2df4fcc2f45a194583eb288b4822f2f414723fb6b1675023adbc9ba088be5bbf6b0e6062ef13c3d649dcd0794ab5ff0bca4bbb87012f01c318e6
-  data.tar.gz: ea5a3ea7d52dc8f61bc1ee66fe495e1721f11c4430a1eda17a73b54fd279758eb861b716e2fda1ad5a2e1154400dde4694f83aefe8669995fee3cb0574c528d2
+  metadata.gz: bd7899626ea01d17e7137652c5cc08c9b86b153df31ee2b631dcd3d7991e759fa7a3d4e73f25b6e919942c6d685555a779e56dade82bb5a93d6e4087dd222deb
+  data.tar.gz: 37713680a2fe91450ca63198f48423eb7cb6805d66ebe02963457ec4ebfbf928c04632f3c4526473317652839961f1f1d96667dcafa1902a317f8b3defce77b7

data/README.md

@@ -1,6 +1,6 @@
 # WebVTT Ruby parser and segmenter
 
-The [WebVTT format](http://dev.w3.org/html5/webvtt/) is a standard captionning format used for HTML5 videos and HTTP Live Streaming (HLS).
+The [WebVTT format](https://www.w3.org/TR/webvtt1/) is a standard captionning format used for HTML5 videos and HTTP Live Streaming (HLS).
 
 ## Installation
 
@@ -30,6 +30,7 @@ webvtt.cues.each do |cue|
   puts "End: #{cue.end}"
   puts "Style: #{cue.style.inspect}"
   puts "Text: #{cue.text}"
+  puts "Plain text: #{cue.plain_text}" # text without style tags if any
   puts "--"
 end
 ```

data/lib/webvtt/parser.rb

@@ -104,7 +104,7 @@ module WebVTT
   end
 
   class Cue
-    attr_accessor :identifier, :start, :end, :style, :text
+    attr_accessor :identifier, :start, :end, :style, :text, :plain_text
 
     def initialize(cue = nil)
       @content = cue
@@ -156,8 +156,8 @@ module WebVTT
     def parse
       lines = @content.split("\n").map(&:strip)
 
-      # it's a note, ignore
-      return if lines[0] =~ /NOTE/
+      # it's a note or style section, ignore
+      return if lines[0] =~ /NOTE|STYLE/
 
       if !lines[0].include?("-->")
         @identifier = lines[0]
@@ -175,7 +175,10 @@ module WebVTT
       else
         raise WebVTT::MalformedFile
       end
+
+
       @text = lines[1..-1].join("\n")
+      @plain_text = @text.gsub(/<.+?>/, '').strip # remove style tags from text
     end
   end
 

data/tests/parser.rb

@@ -82,6 +82,15 @@ class ParserTest < Minitest::Test
     assert_equal "1", webvtt.cues[0].identifier
   end
 
+  def test_ignore_style_and_remove_style_tag_from_cue_text
+    webvtt = WebVTT.read("tests/subtitles/withstyle.vtt")
+    assert_equal 1, webvtt.cues.size
+    # ignoring the first cue which is a NOTE
+    assert_equal "hello", webvtt.cues[0].identifier
+    assert_equal "Hello world.", webvtt.cues[0].plain_text
+    assert_equal "Hello <b>world</b>.", webvtt.cues[0].text
+  end
+
   def test_timestamp_in_sec
     assert_equal 60.0, WebVTT::Cue.timestamp_in_sec("00:01:00.000")
     assert_equal 126.23, WebVTT::Cue.timestamp_in_sec("00:02:06.230")
@@ -250,10 +259,4 @@ The text should change)
     assert_instance_of WebVTT::Cue, webvtt.cues[0]
     assert_equal 15, webvtt.cues.size
   end
-
-  def test_invalid_vtt_without_milliseconds
-    assert_raises WebVTT::MalformedFile do
-      vtt = WebVTT::File.new('tests/subtitles/no_milliseconds.vtt')
-    end
-  end
 end

data/tests/subtitles/withstyle.vtt

@@ -0,0 +1,20 @@
+WEBVTT
+
+NOTE This example is from https://www.w3.org/TR/webvtt1/#styling
+
+STYLE
+::cue {
+  background-image: linear-gradient(to bottom, dimgray, lightgray);
+  color: papayawhip;
+}
+
+NOTE comment blocks can be used between style blocks.
+
+STYLE
+::cue(b) {
+  color: peachpuff;
+}
+
+hello
+00:00:00.000 --> 00:00:10.000
+Hello <b>world</b>.

data/webvtt-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'webvtt-ruby'
-  s.version       = '0.4.2'
+  s.version       = '0.4.3'
   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.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Bruno Celeste
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies: []
 description: WebVTT parser and segmenter in ruby for HTML5 and HTTP Live Streaming
   (HLS).
@@ -45,6 +45,7 @@ files:
 - tests/subtitles/weird_format.vtt
 - tests/subtitles/weird_format_corrected.vtt
 - tests/subtitles/withnote.vtt
+- tests/subtitles/withstyle.vtt
 - webvtt-ruby.gemspec
 homepage: https://github.com/HeyWatch/webvtt-ruby
 licenses: