titlekit 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0712580169800d43e8659c12cbff9e28cd2a26a1
-  data.tar.gz: 299896ab06f51dfd0b923285dabfd433cf428eb9
+  metadata.gz: 7b9b35e1b03b4b9643a8c75982aec3d425fb5b84
+  data.tar.gz: 40794f1843dd4cfbc18895dd5bffbd0a8bde6546
 SHA512:
-  metadata.gz: 99604a85977b71bcf1a5d78b604a7b96f90984ab74fece142a78bab8c035a2bcde426d61d4d9812e3a46d7e22016c7da6b22cf6284e1efdcabac3ebfe2beeb16
-  data.tar.gz: c28344d352367d68646fe3aa9cbede0c803f52385b163fff49bf224c072e3fa7e84454fa3bafa09b64191fe3649203f8d74ed952b9d677588e693b8a443f6a98
+  metadata.gz: 325f6862335038d5a8ecc03454ec35559b28aa113cdbef9b2183d5d84723e4b83cb6d15abcbee9cfa4541f1e35ab545b3a0a64fb4ef3640dee764d006ea53480
+  data.tar.gz: d300e60449e00888d1799d2e1e3c127bb4975f32c9f502869d609e1b62f5b9e98935800bcbdbfef1f6e9debb3a32edfc047457a627c9070d5a0f0ec3298f9c89

data/.gitignore

@@ -7,6 +7,7 @@
 .rspec
 *.sublime-project
 *.sublime-workspace
+.tags*
 .yardoc
 Gemfile.lock
 doc/

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.2.0
+  - 2.2.2

data/Rakefile

@@ -1,8 +1,8 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new(:spec)
 
-task :test => :spec
-task :default => :spec
+task test: :spec
+task default: :spec

data/bin/titlekit

@@ -7,7 +7,7 @@ if ARGV.length > 0 && (ARGV[0] == 'template' || ARGV[0] == 'templates')
   filenames += Dir.glob('**/*.ssa')
   filenames += Dir.glob('**/*.ass')
   filenames += ['generic.srt'] if filenames.empty?
-  
+
   filenames.each do |filename|
 
     content = <<HERETEMPLATE

data/lib/titlekit/have.rb

@@ -14,7 +14,7 @@ module Titlekit
     #   :rchardet19 or :charlock_holmes if you have installed an additional
     #   detection library and want to specifically use one or the other.
     #
-    # @return If you omit the argument, it returns the already specified encoding
+    # @return If you omit the argument it returns the already specified encoding
     def encoding(*args)
       if args.empty?
         return @encoding
@@ -37,7 +37,7 @@ module Titlekit
     #
     # @example Referencing a subtitle index (ZERO-INDEXED! First subtitle is 0)
     #   have.reference('Earl grey, hot', subtitle: 645)
-    #  
+    #
     # @example Referencing a timecode by seconds
     #   have.reference('In a galaxy ...', seconds: 14.2)
     #
@@ -60,7 +60,7 @@ module Titlekit
     # @param seconds [Float]
     # @param milliseconds [Float]
     def reference(name,
-                  *args,
+                  *_args,
                   subtitle: nil,
                   hours: nil,
                   minutes: nil,
@@ -83,7 +83,7 @@ module Titlekit
               ass_timecode: ass_timecode)
       end
 
-      return self
+      self
     end
   end
-end
+end

data/lib/titlekit/job.rb

@@ -18,7 +18,7 @@ module Titlekit
     # and any other unusual events that occur on the job. (regardless if it
     # failed or succeeded)
     #
-    # @return [Array<String>] All reported messages 
+    # @return [Array<String>] All reported messages
     attr_reader :report
 
     # Starts a new job.
@@ -39,7 +39,7 @@ module Titlekit
           require 'charlock_holmes'
         end
       rescue Gem::LoadError
-      end  
+      end
     end
 
     # Runs the job.
@@ -74,14 +74,14 @@ module Titlekit
     #     file('path/to/my/input.srt')
     #     fps(25)
     #   end
-    #   
+    #
     # @example Using a block and providing a variable
     #   job.have do |have|
     #     have.encoding('utf-8')
     #     have.file('path/to/my/input.srt')
     #     have.fps(25)
     #   end
-    #   
+    #
     # @example Catching the reference and assigning things at any later point
     #   have = job.have
     #   have.encoding('utf-8')
@@ -93,10 +93,10 @@ module Titlekit
     #   have2.encoding('ISO-8859-1')
     #   have2.file('path/to/my/input2.srt')
     #
-    # @param template [Have] optionally you can specify another {Have} as a 
+    # @param template [Have] optionally you can specify another {Have} as a
     #   template, from which all properties but the file path are cloned
     # @return [Have] a reference to the newly assigned {Have}
-    def have(*args, template: nil, &block)
+    def have(*_args, template: nil, &block)
       specification = Have.new
 
       if template
@@ -114,7 +114,7 @@ module Titlekit
 
       @haves << specification
 
-      return specification
+      specification
     end
 
     # Adds a new {Want} specification to your job.
@@ -125,14 +125,14 @@ module Titlekit
     #     file('path/to/my/output.srt')
     #     fps(23.976)
     #   end
-    #   
+    #
     # @example Using a block and providing a variable
     #   job.want do |want|
     #     want.encoding('utf-8')
     #     want.file('path/to/my/output.srt')
     #     want.fps((23.976)
     #   end
-    #   
+    #
     # @example Catching the reference and assigning things at any later point
     #   want = job.want
     #   want.encoding('utf-8')
@@ -144,7 +144,7 @@ module Titlekit
     #   want2.encoding('ISO-8859-1')
     #   want2.file('path/to/my/output.ass')
     #
-    # @param template [Want] optionally you can specify another {Want} as a 
+    # @param template [Want] optionally you can specify another {Want} as a
     #   template, from which all properties but the file path are cloned
     # @return [Want] a reference to the newly assigned {Want}
     def want(*args, template: nil, &block)
@@ -165,7 +165,7 @@ module Titlekit
 
       @wants << specification
 
-      return specification
+      specification
     end
 
     private
@@ -188,7 +188,7 @@ module Titlekit
           data.force_encoding(detection[:encoding])
         elsif [:detect, :rchardet19].include?(have.encoding) && defined?(CharDet)
           detection = CharDet.detect(data)
-          @report << "Assuming #{detection.encoding} for #{have.file} (detected by rchardet19 with #{(detection.confidence*100).to_i}% confidence)"
+          @report << "Assuming #{detection.encoding} for #{have.file} (detected by rchardet19 with #{(detection.confidence * 100).to_i}% confidence)"
           data.force_encoding(detection.encoding)
         else
           @report << "Assuming #{have.encoding} for #{have.file} (user-supplied)"
@@ -207,18 +207,19 @@ module Titlekit
       end
 
       begin
-        have.subtitles = case File.extname(have.file)
-        when '.ass'
-          ASS.import(data)
-        when '.ssa'
-          SSA.import(data)
-        when '.srt'
-          SRT.import(data)
-        when '.yt'
-          YT.import(data)        
-        else
-          raise 'Not supported'
-        end
+        have.subtitles =
+          case File.extname(have.file)
+          when '.ass'
+            ASS.import(data)
+          when '.ssa'
+            SSA.import(data)
+          when '.srt'
+            SRT.import(data)
+          when '.yt'
+            YT.import(data)
+          else
+            fail 'Not supported'
+          end
       rescue
         @report << "Failure while importing #{File.extname(have.file)[1..3].upcase} from #{have.file}"
         raise AbortJob
@@ -240,13 +241,13 @@ module Titlekit
       end
 
       case matching_references.length
-      when 3..(infinity = 1.0/0)
+      when 3..(_infinity = 1.0 / 0)
         # "synchronization jitter" correction by interpolating ? Consider !
       when  2
         retime_by_double_reference(have,
-                                     want,
-                                     matching_references[0],
-                                     matching_references[1])
+                                   want,
+                                   matching_references[0],
+                                   matching_references[1])
       when 1
         if have.fps && want.fps
           retime_by_framerate_plus_reference(have, want, matching_references[0])
@@ -254,15 +255,13 @@ module Titlekit
           retime_by_single_reference(have, want, matching_references[0])
         end
       when 0
-        if have.fps && want.fps
-          retime_by_framerate(have, want)
-        end
+        retime_by_framerate(have, want) if have.fps && want.fps
       end
     end
 
     # Cleans out subtitles that fell out of the usable time range
     #
-    # @params have [Have] What we {Have}   
+    # @params have [Have] What we {Have}
     def cull(have)
       have.subtitles.reject! { |subtitle| subtitle[:end] < 0 }
       have.subtitles.each do |subtitle|
@@ -273,7 +272,7 @@ module Titlekit
     # Assigns track identification fields for distinguishing
     # between continuous/simultaneous subtitles
     #
-    # @params have [Have] What we {Have} 
+    # @params have [Have] What we {Have}
     def group(have)
       if have.track
         # Assign a custom track identifier if one was supplied
@@ -332,9 +331,9 @@ module Titlekit
       # Glue subtitles ends
       want.subtitles.sort_by! { |subtitle| subtitle[:end] }
       want.subtitles.each_cons(2) do |pair|
-        if pair[1][:end]-pair[0][:end] < want.glue_treshold
-          pair[0][:end] += (pair[1][:end]-pair[0][:end]) / 2
-          pair[1][:end] -= (pair[1][:end]-pair[0][:end]) / 2
+        if pair[1][:end] - pair[0][:end] < want.glue_treshold
+          pair[0][:end] += (pair[1][:end] - pair[0][:end]) / 2
+          pair[1][:end] -= (pair[1][:end] - pair[0][:end]) / 2
         end
       end
     end
@@ -344,22 +343,23 @@ module Titlekit
     # @param want [Want] What we {Want}
     def export(want)
       begin
-        data = case File.extname(want.file)
-        when '.ass'
-          ASS.master(want.subtitles)
-          ASS.export(want.subtitles)
-        when '.ssa'
-          SSA.master(want.subtitles)
-          SSA.export(want.subtitles)
-        when '.srt'
-          SRT.master(want.subtitles)
-          SRT.export(want.subtitles)
-        when '.yt'
-          YT.master(want.subtitles)
-          YT.export(want.subtitles)         
-        else
-          raise 'Not supported'
-        end
+        data =
+          case File.extname(want.file)
+          when '.ass'
+            ASS.master(want.subtitles)
+            ASS.export(want.subtitles)
+          when '.ssa'
+            SSA.master(want.subtitles)
+            SSA.export(want.subtitles)
+          when '.srt'
+            SRT.master(want.subtitles)
+            SRT.export(want.subtitles)
+          when '.yt'
+            YT.master(want.subtitles)
+            YT.export(want.subtitles)
+          else
+            fail 'Not supported'
+          end
       rescue
         @report << "Failure while exporting #{File.extname(want.file)[1..3].upcase} for #{want.file}"
         raise AbortJob
@@ -389,7 +389,7 @@ module Titlekit
     #
     # @param have [Have] the subtitles we {Have}
     # @param want [Want] the subtitles we {Want}
-    # @param reference [Symbol, String] the key of the reference 
+    # @param reference [Symbol, String] the key of the reference
     def retime_by_single_reference(have, want, reference)
       amount = want.references[reference][:timecode] -
                have.references[reference][:timecode]
@@ -420,7 +420,7 @@ module Titlekit
       have.subtitles.each do |subtitle|
         subtitle[:start] += amount
         subtitle[:end] += amount
-      end      
+      end
     end
 
     # Applies a progressive timeshift on the subtitles we {Have}
@@ -435,11 +435,15 @@ module Titlekit
     # @param [Array<Float>] targets the two amounts of time by which to shift
     #   either of the two points that shall be shifted
     def retime_by_double_reference(have, want, reference_a, reference_b)
-      origins = [ have.references[reference_a][:timecode],
-                  have.references[reference_b][:timecode] ]
+      origins = [
+        have.references[reference_a][:timecode],
+        have.references[reference_b][:timecode]
+      ]
 
-      targets = [ want.references[reference_a][:timecode],
-                  want.references[reference_b][:timecode] ]
+      targets = [
+        want.references[reference_a][:timecode],
+        want.references[reference_b][:timecode]
+      ]
 
       rescale_factor = (targets[1] - targets[0]) / (origins[1] - origins[0])
       rebase_shift = targets[0] - origins[0] * rescale_factor
@@ -462,4 +466,4 @@ module Titlekit
       end
     end
   end
-end
+end

data/lib/titlekit/parsers/ass.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])
@@ -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 tracks.length == 2 || tracks.length == 3
 
@@ -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
@@ -143,9 +145,9 @@ module Titlekit
       end
 
       result << "\n" # Close styles section
-      
+
       result << "[Events]\nFormat: Layer, Start, End, Style, Actor, MarginL, MarginR, MarginV, Effect, Text\n"
-      
+
       subtitles.each do |subtitle|
         fields = [
           'Dialogue: 0',  # Format: Marked
@@ -156,14 +158,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
@@ -173,11 +175,11 @@ module Titlekit
     # @param seconds [Float] an amount of seconds
     # @return [String] An ASS-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])
+      format('%01d:%02d:%02d.%s',
+             seconds / 3600,
+             (seconds % 3600) / 60,
+             seconds % 60,
+             format('%.2f', seconds)[-2, 3])
     end
 
     # Parses an ASS-formatted timecode into a float representing seconds
@@ -185,8 +187,8 @@ module Titlekit
     # @param timecode [String] An ASS-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/parsers/ass.treetop

@@ -1,5 +1,6 @@
 grammar ASS
   rule subtitles
+    utf8_bom?
     info?
     styles?
     event_section
@@ -10,6 +11,10 @@ grammar ASS
     <Titlekit::ASS::Subtitles>
   end
 
+  rule utf8_bom
+    "\xEF\xBB\xBF"
+  end
+
   rule info
     '[Script Info]' end_of_line lines* end_of_section <Titlekit::ASS::ScriptInfo>
   end
@@ -49,7 +54,7 @@ grammar ASS
   rule end_of_section
     end_of_line+ / end_of_file
   end
-  
+
   rule end_of_line
     "\r\n" / "\n" / "\r"
   end
@@ -61,7 +66,7 @@ grammar ASS
   rule end_of_file
     !.
   end
-  
+
   rule number
     [0-9]+
   end
@@ -69,4 +74,4 @@ grammar ASS
   rule string
     (!end_of_line .)+
   end
-end
+end

data/lib/titlekit/parsers/srt.rb

@@ -6,7 +6,7 @@ module Titlekit
     # Internal intermediate class used for parsing with treetop
     class Subtitles < Treetop::Runtime::SyntaxNode
       def build
-        elements.map { |subtitle| subtitle.build }
+        elements.map(&:build)
       end
     end
 
@@ -51,8 +51,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.
@@ -62,8 +62,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 tracks.length >= 2
 
@@ -86,7 +86,7 @@ module Titlekit
             intersecting.sort_by! { |subtitle| tracks.index(subtitle[:track]) }
 
             subtitle = {}
-            subtitle[:id] = mastered_subtitles.length+1
+            subtitle[:id] = mastered_subtitles.length + 1
             subtitle[:start] = frame[:start]
             subtitle[:end] = frame[:end]
 
@@ -116,7 +116,7 @@ module Titlekit
       result = ''
 
       subtitles.each_with_index do |subtitle, index|
-        result << (index+1).to_s
+        result << (index + 1).to_s
         result << "\n"
         result << SRT.build_timecode(subtitle[:start])
         result << ' --> '
@@ -126,7 +126,7 @@ module Titlekit
         result << "\n\n"
       end
 
-      return result
+      result
     end
 
     protected
@@ -136,11 +136,11 @@ module Titlekit
     # @param seconds [Float] an amount of seconds
     # @return [String] An SRT-formatted timecode ('hh:mm:ss,ms')
     def self.build_timecode(seconds)
-      sprintf("%02d:%02d:%02d,%s",
-              seconds / 3600,
-              (seconds%3600) / 60,
-              seconds % 60,
-              sprintf("%.3f", seconds)[-3, 3])
+      format('%02d:%02d:%02d,%s',
+             seconds / 3600,
+             (seconds % 3600) / 60,
+             seconds % 60,
+             format('%.3f', seconds)[-3, 3])
     end
 
     # Parses an SRT-formatted timecode into a float representing seconds
@@ -149,7 +149,7 @@ module Titlekit
     # @param [Float] an amount of seconds
     def self.parse_timecode(timecode)
       mres = timecode.match(/(?<h>\d+):(?<m>\d+):(?<s>\d+),(?<ms>\d+)/)
-      "#{mres["h"].to_i * 3600 + mres["m"].to_i * 60 + mres["s"].to_i}.#{mres["ms"]}".to_f
+      "#{mres['h'].to_i * 3600 + mres['m'].to_i * 60 + mres['s'].to_i}.#{mres['ms']}".to_f
     end
   end
-end
+end