titlekit 1.2.1 → 1.2.2

data/lib/titlekit/parsers/ssa.rb

@@ -31,7 +31,7 @@ module Titlekit
           subtitle = {}
 
           fields = line.text_value.split(',')
-          
+
           subtitle[:id] = elements.index(line) + 1
           subtitle[:start] = SSA.parse_timecode(fields[1])
           subtitle[:end] = SSA.parse_timecode(fields[2])
@@ -40,7 +40,7 @@ module Titlekit
           subtitle
         end
       end
-    end    
+    end
 
     # Parses the supplied string and builds the resulting subtitles array.
     #
@@ -59,8 +59,8 @@ module Titlekit
         failure += "failure_column #{parser.failure_column}\n"
         failure += "failure_reason #{parser.failure_reason}\n"
 
-        raise failure
-      end 
+        fail failure
+      end
     end
 
     # Master the subtitles for best possible usage of the format's features.
@@ -70,8 +70,8 @@ module Titlekit
       tracks = subtitles.map { |subtitle| subtitle[:track] }.uniq
 
       if tracks.length == 1
-  
-        # maybe styling? aside that: nada más!
+
+        # maybe styling? aside that: nothing more!
 
       elsif (2..3).include?(tracks.length)
 
@@ -99,21 +99,23 @@ module Titlekit
 
         frames.each do |frame|
           intersecting = subtitles.select do |subtitle|
-            (subtitle[:end] == frame[:end] || subtitle[:start] == frame[:start] ||
-            (subtitle[:start] < frame[:start] && subtitle[:end] > frame[:end]))
+            subtitle[:end] == frame[:end] ||
+            subtitle[:start] == frame[:start] ||
+            (subtitle[:start] < frame[:start] && subtitle[:end] > frame[:end])
           end
 
           if intersecting.any?
             intersecting.sort_by! { |subtitle| tracks.index(subtitle[:track]) }
             intersecting.each do |subtitle|
-              new_subtitle = {}
-              new_subtitle[:id] = mastered_subtitles.length+1
-              new_subtitle[:start] = frame[:start]
-              new_subtitle[:end] = frame[:end]
+              color = tracks.index(subtitle[:track]) % DEFAULT_PALETTE.length
 
-              color = DEFAULT_PALETTE[tracks.index(subtitle[:track]) % DEFAULT_PALETTE.length]
-              new_subtitle[:style] = color
-              new_subtitle[:lines]  = subtitle[:lines]
+              new_subtitle = {
+                id: mastered_subtitles.length + 1,
+                start: frame[:start],
+                end: frame[:end],
+                style: DEFAULT_PALETTE[color],
+                lines: subtitle[:lines]
+              }
 
               mastered_subtitles << new_subtitle
             end
@@ -137,13 +139,13 @@ module Titlekit
       result << "Style: Default,Arial,16,16777215,16777215,16777215,-2147483640,0,0,1,3,0,2,70,70,40,0,0\n"
       result << "Style: Middle,Arial,16,16777215,16777215,16777215,-2147483640,0,0,1,3,0,10,70,70,40,0,0\n"
       result << "Style: Top,Arial,16,16777215,16777215,16777215,-2147483640,0,0,1,3,0,6,70,70,40,0,0\n"
-      
+
       DEFAULT_PALETTE.each do |color|
         # reordered_color = ""
         # reordered_color << color[4..5]
         # reordered_color << color[2..3]
         # reordered_color << color[0..1]\
-        processed_color = (color[4..5]+color[2..3]+color[0..1]).to_i(16)
+        processed_color = (color[4..5] + color[2..3] + color[0..1]).to_i(16)
         result << "Style: #{color},Arial,16,#{processed_color},#{processed_color},#{processed_color},-2147483640,0,0,1,3,0,2,70,70,40,0,0\n"
       end
 
@@ -160,14 +162,14 @@ module Titlekit
           '0000',  # MarginL
           '0000',  # MarginR
           '0000',  # MarginV
-          '',# Effect
+          '', # Effect
           subtitle[:lines].gsub("\n", '\N')  # Text
         ]
 
         result << (fields.join(',') + "\n")
       end
 
-      return result
+      result
     end
 
     protected
@@ -177,20 +179,20 @@ module Titlekit
     # @param seconds [Float] an amount of seconds
     # @return [String] An SSA-formatted timecode ('h:mm:ss.ms')
     def self.build_timecode(seconds)
-      sprintf("%01d:%02d:%02d.%s",
-              seconds / 3600,
-              (seconds%3600) / 60,
-              seconds % 60,
-              sprintf("%.2f", seconds)[-2, 3])
-    end 
+      format('%01d:%02d:%02d.%s',
+             seconds / 3600,
+             (seconds % 3600) / 60,
+             seconds % 60,
+             format('%.2f', seconds)[-2, 3])
+    end
 
     # Parses an SSA-formatted timecode into a float representing seconds
     #
     # @param timecode [String] An SSA-formatted timecode ('h:mm:ss.ms')
     # @param [Float] an amount of seconds
     def self.parse_timecode(timecode)
-      mres = timecode.match(/(?<h>\d):(?<m>\d{2}):(?<s>\d{2})[:|\.](?<ms>\d+)/)
-      return "#{mres["h"].to_i * 3600 + mres["m"].to_i * 60 + mres["s"].to_i}.#{mres["ms"]}".to_f
-    end 
+      m = timecode.match(/(?<h>\d):(?<m>\d{2}):(?<s>\d{2})[:|\.](?<ms>\d+)/)
+      m['h'].to_i * 3600 + m['m'].to_i * 60 + m['s'].to_i + "0.#{m['ms']}".to_f
+    end
   end
-end
+end

data/lib/titlekit/specification.rb

@@ -12,7 +12,7 @@ module Titlekit
       @subtitles = []
       @track = nil
 
-      return self
+      self
     end
 
     # Specifies the encoding you have or want.
@@ -31,7 +31,7 @@ module Titlekit
     # Specifies the file (path) you have or want.
     #
     # @param [String] A string specifying the path to the file
-    # @return If you omit the argument, it returns the already specified path 
+    # @return If you omit the argument, it returns the already specified path
     def file(*args)
       if args.empty?
         return @file
@@ -44,7 +44,7 @@ module Titlekit
     # Specifies the track the subtitles should be assigned to.
     #
     # @param [String] A string specifying the track identifier
-    # @return If you omit the argument, it returns the already specified track 
+    # @return If you omit the argument, it returns the already specified track
     def track(*args)
       if args.empty?
         return @track
@@ -52,7 +52,7 @@ module Titlekit
         @track = args[0]
         return self
       end
-    end      
+    end
 
     # Specifies the framerate you have or want.
     #
@@ -69,7 +69,7 @@ module Titlekit
 
     # Returns all named references you have specified
     def references
-      return @references
+      @references
     end
 
     # Places a named reference (in the form of a string or a symbol)
@@ -85,7 +85,7 @@ module Titlekit
     #
     # @example Referencing a timecode by hours
     #   have.reference('Earl grey, hot', hours: 0.963)
-    #  
+    #
     # @example Referencing a timecode by seconds
     #   have.reference('In a galaxy ...', seconds: 14.2)
     #
@@ -97,7 +97,7 @@ module Titlekit
     #
     # @example Referencing a timecode by an SSA-style timecode
     #   have.reference('In a galaxy ...', ssa_timecode: '0:00:14,20')
-    #    
+    #
     # @example Symbols can be used as references as well!
     #   have.reference(:narrator_begins, minutes: 9.6)
     #
@@ -107,7 +107,7 @@ module Titlekit
     # @param seconds [Float]
     # @param milliseconds [Float]
     def reference(name,
-                  *args,
+                  *_args,
                   hours: nil,
                   minutes: nil,
                   seconds: nil,
@@ -116,24 +116,25 @@ module Titlekit
                   ssa_timecode: nil,
                   ass_timecode: nil)
 
-      @references[name] = case
-      when hours
-        { timecode: hours * 3600 }
-      when minutes
-        { timecode: minutes * 60 }
-      when seconds
-        { timecode: seconds }
-      when milliseconds
-        { timecode: milliseconds / 1000 }
-      when srt_timecode
-        { timecode: Titlekit::SRT.parse_timecode(srt_timecode) }
-      when ssa_timecode
-        { timecode: Titlekit::SSA.parse_timecode(ssa_timecode) }
-      when ass_timecode
-        { timecode: Titlekit::ASS.parse_timecode(ass_timecode) }
-      end
+      @references[name] =
+        case
+        when hours
+          { timecode: hours * 3600 }
+        when minutes
+          { timecode: minutes * 60 }
+        when seconds
+          { timecode: seconds }
+        when milliseconds
+          { timecode: milliseconds / 1000 }
+        when srt_timecode
+          { timecode: Titlekit::SRT.parse_timecode(srt_timecode) }
+        when ssa_timecode
+          { timecode: Titlekit::SSA.parse_timecode(ssa_timecode) }
+        when ass_timecode
+          { timecode: Titlekit::ASS.parse_timecode(ass_timecode) }
+        end
 
-      return self
-    end   
+      self
+    end
   end
-end
+end

data/lib/titlekit/utilities.rb

@@ -2,5 +2,5 @@ module Titlekit
   # The default palette is used to distinguish simultaneous subtitles
   # by their color (if distinguishing them by different position is either
   # not possible due to the format or not sensible in the specific case)
-  DEFAULT_PALETTE = %w{EDF393 F5E665 FFC472 FFA891 89BABE}
-end
+  DEFAULT_PALETTE = %w(EDF393 F5E665 FFC472 FFA891 89BABE)
+end

data/lib/titlekit/version.rb

@@ -1,4 +1,4 @@
 module Titlekit
   # Versioning follows the semantic versioning scheme: http://semver.org/
-  VERSION = '1.2.1'
-end
+  VERSION = '1.2.2'
+end

data/lib/titlekit/want.rb

@@ -21,4 +21,4 @@ module Titlekit
       end
     end
   end
-end
+end

data/lib/titlekit.rb

@@ -6,4 +6,4 @@ require 'titlekit/specification'
 require 'titlekit/have'
 require 'titlekit/want'
 require 'titlekit/job'
-require 'titlekit/version'
+require 'titlekit/version'

data/spec/ass_spec.rb

@@ -9,7 +9,7 @@ describe Titlekit::ASS do
         Titlekit::ASS.import(File.read('spec/files/ass/simple.ass'))
       end
 
-      it 'parses and builds 3 subtitles' do
+      it 'parses and builds 2 subtitles' do
         expect(subtitles.length).to eq(2)
       end
 
@@ -23,7 +23,7 @@ describe Titlekit::ASS do
       end
 
       it 'parses and builds correct lines' do
-        expect(subtitles[1][:lines]).to eq("Est-ce vraiment Naruto ?")
+        expect(subtitles[1][:lines]).to eq('Est-ce vraiment Naruto ?')
       end
     end
 
@@ -32,7 +32,7 @@ describe Titlekit::ASS do
         Titlekit::ASS.import(File.read('spec/files/ass/hard.ass'))
       end
 
-      it 'parses and builds 3 subtitles' do
+      it 'parses and builds 17 subtitles' do
         expect(subtitles.length).to eq(17)
       end
 
@@ -49,6 +49,29 @@ describe Titlekit::ASS do
         expect(subtitles[1][:lines]).to eq("هل تعمل اللغة العربية؟\n")
       end
     end
+
+    context 'with a file including a BOM' do
+      let(:subtitles) do
+        Titlekit::ASS.import(File.read('spec/files/ass/bom.ass'))
+      end
+
+      it 'parses and builds 2 subtitles' do
+        expect(subtitles.length).to eq(2)
+      end
+
+      it 'parses and builds correct ids' do
+        expect(subtitles[0][:id]).to eq(1)
+      end
+
+      it 'parses and builds correct timecodes' do
+        expect(subtitles[1][:start]).to eq(120.99)
+        expect(subtitles[1][:end]).to eq(122.87)
+      end
+
+      it 'parses and builds correct lines' do
+        expect(subtitles[1][:lines]).to eq('Agreed.')
+      end
+    end
   end
 
   describe '.export' do
@@ -101,13 +124,13 @@ Dialogue: 0,0:00:01.50,0:00:03.70,Default,,0000,0000,0000,,Oh yeah ... 寧為太
 
   describe '.build_timecode' do
     it 'builds an ASS timecode from a float timecode value' do
-       expect(Titlekit::ASS.build_timecode(35.9678)).to eq('0:00:35.97')
+      expect(Titlekit::ASS.build_timecode(35.9678)).to eq('0:00:35.97')
     end
   end
 
   describe '.parse_timecode' do
     it 'obtains a float timecode value from an ASS timecode' do
-       expect(Titlekit::ASS.parse_timecode('0:00:35.96')).to eq(35.96)
+      expect(Titlekit::ASS.parse_timecode('0:00:35.96')).to eq(35.96)
     end
-  end   
-end
+  end
+end

data/spec/automatic_grouping/automatic_grouping_spec.rb

@@ -3,10 +3,10 @@ require File.join(File.expand_path(__dir__), '../spec_helper')
 describe Titlekit::Job do
 
   describe 'Automatic grouping' do
-    
+
     context 'with an implicit single track' do
       before(:all) do
-        @ins = %w{one two}.map do |file|
+        @ins = %w(one two).map do |file|
           File.join(__dir__, 'single_track', "#{file}.srt")
         end
         @out = File.join(__dir__, 'single_track', 'out.srt')
@@ -19,7 +19,7 @@ describe Titlekit::Job do
         job = Titlekit::Job.new
         @ins.each { |file| job.have.file(file).encoding('UTF-8') }
         job.want.file(@out)
-        
+
         expect(job.run).to be true
       end
 
@@ -28,9 +28,9 @@ describe Titlekit::Job do
       end
     end
 
-   context 'with implicit dual tracks' do
+    context 'with implicit dual tracks' do
       before(:all) do
-        @ins = %w{one two}.map do |file|
+        @ins = %w(one two).map do |file|
           File.join(__dir__, 'dual_tracks', "#{file}.srt")
         end
         @out = File.join(__dir__, 'dual_tracks', 'out.srt')
@@ -43,13 +43,13 @@ describe Titlekit::Job do
         job = Titlekit::Job.new
         @ins.each { |file| job.have.file(file).encoding('UTF-8') }
         job.want.file(@out)
-        
+
         expect(job.run).to be true
       end
 
       it 'delivers the expected output' do
         expect(FileUtils.compare_file(@out, @expected)).to be true
       end
-    end    
+    end
   end
-end
+end

data/spec/encoding_detection/encoding_detection_spec.rb

@@ -18,14 +18,14 @@ describe Titlekit::Job do
 
         have = job.have
         have.file(@in)
-        
+
         want = job.want
         want.file(@out)
-        
+
         job.run
 
         expect(job.report.join).to include('detected')
-      end     
+      end
     end
 
     context 'with exhibit B' do
@@ -43,12 +43,12 @@ describe Titlekit::Job do
 
         have = job.have
         have.file(@in)
-        
+
         want = job.want
         want.file(@out)
 
         job.run
-        
+
         expect(job.report.join).to include('detected')
       end
     end
@@ -68,14 +68,14 @@ describe Titlekit::Job do
 
         have = job.have
         have.file(@in)
-        
+
         want = job.want
         want.file(@out)
-        
+
         job.run
-        
+
         expect(job.report.join).to include('detected')
       end
     end
   end
-end
+end

data/spec/files/ass/bom.ass

@@ -0,0 +1,17 @@
+[Script Info]
+; Script generated by Aegisub 3.2.2$
+; http://www.aegisub.org/$
+Title: Default Aegisub file$
+ScriptType: v4.00+$
+WrapStyle: 0$
+ScaledBorderAndShadow: yes$
+YCbCr Matrix: None$
+
+[V4+ Styles]
+Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
+Style: Default,Tahoma,16,&H00000000,&H00ffffff,&H00ffffff,&H00c0c0c0,-1,0,0,0,100,100,0,0.00,1,2,3,2,20,20,20,1
+
+[Events]
+Format: Layer, Start, End, Style, Actor, MarginL, MarginR, MarginV, Effect, Text
+Dialogue: 0,0:01:41.70,0:01:46.84,Default,,0000,0000,0000,,Nevermind us, we are mostly only interested in whether the BOM at the start of the file is handled ok.
+Dialogue: 0,0:02:00.99,0:02:02.87,Default,,0000,0000,0000,,Agreed.

data/spec/format_conversion/format_conversion_spec.rb

@@ -3,7 +3,7 @@ require File.join(File.expand_path(__dir__), '../spec_helper')
 describe Titlekit::Job do
 
   describe 'Format conversion' do
-    
+
     context 'From ASS to SRT' do
       before(:all) do
         @in = File.join(__dir__, 'ass_srt', 'in.ass')
@@ -18,10 +18,10 @@ describe Titlekit::Job do
 
         have = job.have
         have.file(@in)
-        
+
         want = job.want
         want.file(@out)
-        
+
         expect(job.run).to be true
       end
 
@@ -44,10 +44,10 @@ describe Titlekit::Job do
 
         have = job.have
         have.file(@in)
-        
+
         want = job.want
         want.file(@out)
-        
+
         expect(job.run).to be true
       end
 
@@ -70,7 +70,7 @@ describe Titlekit::Job do
 
         have = job.have
         have.file(@in)
-        
+
         want = job.want
         want.file(@out)
 
@@ -79,10 +79,10 @@ describe Titlekit::Job do
 
       it 'delivers the expected output' do
         expect(FileUtils.compare_file(@out, @expected)).to be true
-      end      
-    end    
+      end
+    end
 
-   context 'From SSA to SRT' do
+    context 'From SSA to SRT' do
       before(:all) do
         @in = File.join(__dir__, 'ssa_srt', 'in.ssa')
         @out = File.join(__dir__, 'ssa_srt', 'out.srt')
@@ -91,22 +91,21 @@ describe Titlekit::Job do
         File.delete(@out) if File.exist?(@out)
       end
 
-      it 'runs the job' do 
+      it 'runs the job' do
         job = Titlekit::Job.new
 
         have = job.have
         have.file(@in)
-        
+
         want = job.want
         want.file(@out)
-        
+
         expect(job.run).to be true
       end
 
       it 'delivers the expected output' do
         expect(FileUtils.compare_file(@out, @expected)).to be true
-      end      
+      end
     end
-
   end
-end
+end

data/spec/job_spec.rb

@@ -16,7 +16,7 @@ describe Titlekit::Job do
 
       it 'returns an instance of Have' do
         expect(have).to be_a_kind_of(Titlekit::Have)
-      end    
+      end
     end
 
     context 'with a block, passing no variable' do
@@ -36,7 +36,7 @@ describe Titlekit::Job do
         expect(have.encoding).to eq('utf-8')
         expect(have.file).to be
         expect(have.fps).to eq(25)
-      end      
+      end
     end
 
     context 'with a block, passing a variable' do
@@ -108,7 +108,7 @@ describe Titlekit::Job do
         expect(want.encoding).to eq('utf-8')
         expect(want.file).to eq('out.srt')
         expect(want.fps).to eq(23.976)
-      end      
+      end
     end
   end
 
@@ -119,7 +119,7 @@ describe Titlekit::Job do
         job = Titlekit::Job.new
         job.have { file('something/that/without/doubt/wont/exist.srt') }
         job.want { file('something/that/does/not/matter/anyway.ass') }
-        
+
         expect(job.run).to be false
         expect(job.report.join).to include('Failure while reading')
       end
@@ -130,7 +130,7 @@ describe Titlekit::Job do
         job = Titlekit::Job.new
         job.have { file('spec/files/srt/simple.srt') }
         job.want { file('!@#$%^&*()|?/\\.ass') }
-        
+
         expect(job.run).to be false
         expect(job.report.join).to include('Failure while writing')
       end
@@ -141,22 +141,21 @@ describe Titlekit::Job do
         job = Titlekit::Job.new
         job.have { file('spec/files/try/unsupported.try') }
         job.want { file('!@#$%^&*()|?/\.ass') }
-        
+
         expect(job.run).to be false
         expect(job.report.join).to include('Failure while importing TRY')
       end
-    end 
+    end
 
     context 'with an output format that is not supported' do
       it 'gracefully aborts the job' do
         job = Titlekit::Job.new
         job.have { file('spec/files/srt/simple.srt') }
         job.want { file('spec/files/try/unsupported-output.try') }
-        
+
         expect(job.run).to be false
         expect(job.report.join).to include('Failure while exporting TRY')
       end
     end
-
   end
-end
+end