srt 0.0.9 → 0.0.9.2

data/README.md

@@ -1,4 +1,4 @@
-# SRT [![Build Status](https://travis-ci.org/cpetersen/srt.png?branch=master)](https://travis-ci.org/cpetersen/srt)
+# SRT [![Build Status](https://travis-ci.org/cpetersen/srt.png?branch=master)](https://travis-ci.org/cpetersen/srt) [![Code Climate](https://codeclimate.com/github/cpetersen/srt.png)](https://codeclimate.com/github/cpetersen/srt)
 
 SRT stands for SubRip text file format, which is a file for storing subtitles; This is a Ruby library for manipulating SRT files.
 Current functionality includes **parsing**, **appending**, **splitting** and **timeshifting** (constant, progressive and framerate-based).
@@ -60,8 +60,22 @@ The method `split` splits your subtitles at one (or more) points and returns an
 By default, the timecodes of the split parts are relatively shifted towards their beginnings (to line up with correspondingly split multi-part video);
 By additionally passing `:timeshift => false` you can prevent that behaviour and retain the original timecodes for each split part.
 
+Pass  the option `:renumber => false` to prevent the line sequence number from being reset for a segment.
+
+```ruby
+  parts = file.split( :at => "01:09:24,000", :renumber => false ) # Split the file in two at 01:09:24 but do not reset the sequence number on the second part
+```
+
 Example options for a multi-split: `{ :at => ["00:19:24,500", "01:32:09,120", ...] }`
 
+
+Optionally, for multi-splitting, you can pass a ":every" option to split the subtitles at a fixed interval.
+
+```ruby
+  parts = file.split( :every => "00:01:00,000" ) # Split the file every 1 minute
+```
+Note that the options :at and :every are mutually exclusive, and :at takes precedence.
+
 #### Timeshifting
 
 The method `timeshift` takes a hash and supports three different modes of timecode processing:
@@ -118,3 +132,4 @@ This is usually only useful if you have some background information about the de
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+

data/lib/srt/file.rb

@@ -1,6 +1,7 @@
 module SRT
   class File
-    def self.parse(input)
+    def self.parse(input, options = {})
+      @debug = options.fetch(:debug, false)
       if input.is_a?(String)
         parse_string(input)
       elsif input.is_a?(::File)
@@ -31,12 +32,12 @@ module SRT
 
                 if (line.start_time = SRT::File.parse_timecode(mres["start_timecode"])) == nil
                   line.error = "#{index}, Invalid formatting of start timecode, [#{mres["start_timecode"]}]"
-                  $stderr.puts line.error
+                  $stderr.puts line.error if @debug
                 end
 
                 if (line.end_time = SRT::File.parse_timecode(mres["end_timecode"])) == nil
                   line.error = "#{index}, Invalid formatting of end timecode, [#{mres["end_timecode"]}]"
-                  $stderr.puts line.error
+                  $stderr.puts line.error if @debug
                 end
 
                 if mres["display_coordinates"]
@@ -44,7 +45,7 @@ module SRT
                 end
               else
                 line.error = "#{index}, Invalid Time Line formatting, [#{str}]"
-                $stderr.puts line.error
+                $stderr.puts line.error if @debug
               end
             else
               line.text << str.strip
@@ -53,7 +54,7 @@ module SRT
           end
         rescue
           line.error = "#{index}, General Error, [#{str}]"
-          $stderr.puts line.error
+          $stderr.puts line.error if @debug
         end
       end
       result
@@ -91,9 +92,19 @@ module SRT
     end
 
     def split(options)
-      options = { :timeshift => true }.merge(options)
-      if options[:at]
+      options = { :timeshift => true, :renumber => true }.merge(options)
+
+      split_points = []
+
+      if (options[:at])
         split_points = [options[:at]].flatten.map{ |timecode| SRT::File.parse_timecode(timecode) }.sort
+      elsif (options[:every])
+        interval = SRT::File.parse_timecode(options[:every])
+        max = lines.last.end_time
+        (interval..max).step(interval){ |t| split_points << t }
+      end
+
+      if (split_points.count > 0)
         split_offsprings = [SRT::File.new]
 
         reshift = 0
@@ -102,7 +113,7 @@ module SRT
         lines.each do |line|
           if split_points.empty? || line.end_time <= split_points.first
             cloned_line = line.clone
-            cloned_line.sequence -= renumber
+            cloned_line.sequence -= renumber if options[:renumber]
             if options[:timeshift]
               cloned_line.start_time -= reshift
               cloned_line.end_time -= reshift
@@ -110,7 +121,7 @@ module SRT
             split_offsprings.last.lines << cloned_line
           elsif line.start_time < split_points.first
             cloned_line = line.clone
-            cloned_line.sequence -= renumber
+            cloned_line.sequence -= renumber if options[:renumber]
             if options[:timeshift]
               cloned_line.start_time -= reshift
               cloned_line.end_time = split_points.first - reshift
@@ -123,7 +134,7 @@ module SRT
 
             split_offsprings << SRT::File.new
             cloned_line = line.clone
-            cloned_line.sequence -= renumber
+            cloned_line.sequence -= renumber if options[:renumber]
             if options[:timeshift]
               cloned_line.start_time = 0
               cloned_line.end_time -= reshift
@@ -136,7 +147,7 @@ module SRT
 
             split_offsprings << SRT::File.new
             cloned_line = line.clone
-            cloned_line.sequence -= renumber
+            cloned_line.sequence -= renumber if options[:renumber]
             if options[:timeshift]
               cloned_line.start_time -= reshift
               cloned_line.end_time -= reshift
@@ -198,8 +209,17 @@ module SRT
       end
     end
 
-    def to_s
-      lines.map { |l| [l.sequence, (l.display_coordinates ? l.time_str + l.display_coordinates : l.time_str), l.text, ""] }.flatten.join("\n")
+    def to_s(time_str_function=:time_str)
+      lines.map { |l| [l.sequence, (l.display_coordinates ? l.send(time_str_function) + l.display_coordinates : l.send(time_str_function)), l.text, ""] }.flatten.join("\n")
+    end
+
+    def to_webvtt
+      header = <<eos
+WEBVTT
+X-TIMESTAMP-MAP=MPEGTS:0,LOCAL:00:00:00.000
+
+eos
+      header + to_s(:webvtt_time_str)
     end
 
     attr_writer :lines

data/lib/srt/line.rb

@@ -32,8 +32,12 @@ module SRT
       sequence.nil? && start_time.nil? && end_time.nil? && text.empty?
     end
 
-    def time_str
-      [@start_time, @end_time].map { |t| sprintf("%02d:%02d:%02d,%s", t / 3600, (t % 3600) / 60, t % 60, sprintf("%.3f", t)[-3, 3]) }.join(" --> ")
+    def time_str(subframe_separator=",")
+      [@start_time, @end_time].map { |t| sprintf("%02d:%02d:%02d#{subframe_separator}%s", t / 3600, (t % 3600) / 60, t % 60, sprintf("%.3f", t)[-3, 3]) }.join(" --> ")
+    end
+
+    def webvtt_time_str
+      time_str(".")
     end
   end
 end

data/lib/srt/version.rb

@@ -1,3 +1,3 @@
 module SRT
-  VERSION = "0.0.9"
+  VERSION = "0.0.9.2"
 end

data/spec/invalid.srt

@@ -0,0 +1,4 @@
+A
+00:00:51,413111 ===* 00:00:53,3102222
+=== Era uma vez,
+

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'coveralls'
+Coveralls.wear!

data/spec/srt_spec.rb

@@ -1,4 +1,5 @@
 require 'srt'
+require 'spec_helper'
 
 describe SRT do
 
@@ -26,6 +27,20 @@ describe SRT do
   end
 
   describe SRT::File do
+    describe '#parse' do
+      context "parsing with debug true" do
+        it "should be verbose when failing" do
+          $stderr.should_receive(:puts).once
+          SRT::File.parse(File.open("./spec/invalid.srt"), debug: true).errors.should_not be_empty
+        end
+      end
+      context "parsing with debug false" do
+        it "should raise exception silently" do
+          $stderr.should_not_receive(:puts)
+          SRT::File.parse(File.open("./spec/invalid.srt")).errors.should_not be_empty
+        end
+      end
+    end
 
     describe ".parse_id" do
       it "should convert the id string (#[id]) to an int representing the sequence number" do
@@ -281,6 +296,71 @@ describe SRT do
             result[2].lines.last.sequence.should eq(212)
           end         
         end
+
+        context "when passing { :at => \"00:19:24,500\", :every => \"00:00:01,000\" }" do
+          let(:result) { file.split( :at => "00:19:24,500", :every => "00:00:01,000" ) }
+
+          it "should return an array containing two SRT::File instances, ignoring :every" do
+            result.length.should eq(2)
+            result[0].class.should eq(SRT::File)
+            result[1].class.should eq(SRT::File)
+          end
+        end
+
+        context "when passing { :every => \"00:05:00,000\" }" do
+          let(:result) { file.split( :every => "00:05:00,000" ) }
+
+          it "should return an array containing nine SRT::File instances" do
+            result.length.should eq(9)
+            (0...result.count).each do |n|
+              result[n].class.should eq(SRT::File)
+            end
+          end
+        end
+
+        context "when passing { :at => \"00:19:24,500\", :renumber => false }" do
+          let(:result) { file.split( :at => "00:19:24,500", :renumber => false ) }
+
+          it "sequence for the last line of first part should be the sequence for the first line of second part" do
+            result[0].lines.last.text.should == result[1].lines.first.text
+            result[0].lines.last.sequence.should == result[1].lines.first.sequence
+          end
+        end
+
+        context "when passing { :at => \"00:19:24,500\", :renumber => true }" do
+          let(:result) { file.split( :at => "00:19:24,500", :renumber => true ) }
+
+          it "first line of second part's number should be one" do
+            result[1].lines.first.sequence.should == 1
+          end
+
+          it "sequence for the last line of first part should have different number than the sequence for the first line of second part" do
+            result[0].lines.last.text.should == result[1].lines.first.text
+            result[0].lines.last.sequence.should_not == result[1].lines.first.sequence
+          end
+        end
+
+        context "when passing { :at => \"00:19:24,500\", :timeshift => false }" do
+          let(:result) { file.split( :at => "00:19:24,500", :timeshift => false ) }
+
+          it "time for last line of first part should be the time for first line of second part" do
+            result[0].lines.last.text.should == result[1].lines.first.text
+            result[0].lines.last.time_str.should == result[1].lines.first.time_str
+          end
+        end
+
+        context "when passing { :at => \"00:19:24,500\", :timeshift => true }" do
+          let(:result) { file.split( :at => "00:19:24,500", :timeshift => true ) }
+
+          it "start_time of first line in second part should be 0" do
+            result[1].lines.first.start_time.should == 0
+          end
+
+          it "time for last line of first part should not be the time for first line of second part" do
+            result[0].lines.last.text.should == result[1].lines.first.text
+            result[0].lines.last.time_str.should_not == result[1].lines.first.time_str
+          end
+        end
       end
     end
 
@@ -383,6 +463,37 @@ END
           end
         end
       end
+
+      describe "#to_webvtt" do
+        context "when calling it on a short SRT file" do
+          let(:file) { SRT::File.parse(File.open("./spec/bsg-s01e01.srt")) }
+
+          before { file.lines = file.lines[0..2] }
+
+          it "should produce the exactly correct output" do
+            OUTPUT_WEBVTT =<<END
+WEBVTT
+X-TIMESTAMP-MAP=MPEGTS:0,LOCAL:00:00:00.000
+
+1
+00:00:02.110 --> 00:00:04.578
+<i>(male narrator) Previously
+on Battlestar Galactica.</i>
+
+2
+00:00:05.313 --> 00:00:06.871
+Now you're telling me
+you're a machine.
+
+3
+00:00:07.014 --> 00:00:08.003
+The robot.
+END
+            file.to_webvtt.should eq(OUTPUT_WEBVTT)
+          end
+        end
+      end
+
     end
   end
 end

data/srt.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rspec')
+  gem.add_development_dependency('coveralls')
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: srt
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby gem for parsing srt (subtitle) files. SRT stands for SubRip text
   file format, which is a file for storing subtitles.
 email:
@@ -65,6 +81,8 @@ files:
 - spec/blackswan-part2.srt
 - spec/bsg-s01e01.srt
 - spec/coordinates-dummy.srt
+- spec/invalid.srt
+- spec/spec_helper.rb
 - spec/srt_spec.rb
 - spec/wotw-dubious.srt
 - srt.gemspec
@@ -82,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -455267047337616811
+      hash: 3664658785611759133
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -91,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -455267047337616811
+      hash: 3664658785611759133
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -103,5 +121,7 @@ test_files:
 - spec/blackswan-part2.srt
 - spec/bsg-s01e01.srt
 - spec/coordinates-dummy.srt
+- spec/invalid.srt
+- spec/spec_helper.rb
 - spec/srt_spec.rb
 - spec/wotw-dubious.srt