vtt2ass 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a864637934d7b15e7f459c532cd5f521e21e3445e0408cea0a0a7b3c966f550
-  data.tar.gz: 5a58b036d877c8529accd0ccc21fe5568d0bdbd686d994ba119ebc894c906e3b
+  metadata.gz: 3047227acbd6bf731e5dc95113a7d70081bed94392e3b00078b760ebbc4440a4
+  data.tar.gz: e9bc514e5b41028d872d9e983cc4dbd4442fc648ab1065e2c3e5a2aca3c9b8fd
 SHA512:
-  metadata.gz: e46d22748e6e8b64ec2d0486ce42cce993bcdb00b88be35db80c234bbcdf0ddad0b869e35f2b880a30a451b0a81ce99f48dfb5d671cfa40ad284b4eece17f1d3
-  data.tar.gz: 3bbe4b767f309e820d4c44bf8c351090cbe0810219069970c4ac131e50453eeb7b593e9f4793987a69dc9596ab8d6f35815d2d9bbc6785afe755551bcec7c49d
+  metadata.gz: 388af342ebe22e69e52e92e4dadf5a04ea48cb6e491398e864ed1e9d5ae3a602601cddc070ae20f7e8edef0b652a87aa3e8a66f8b8128626315dbac0dd421873
+  data.tar.gz: fa2f3b0fa33c3ee1ade343b14837e8f09d2b5145f41e60f68e1cc7236e17e23c67cb7a811f5abf145df7e7121fd651364870073b6ff74679f6c9ddfe375a2ddc

data/.rubocop.yml

@@ -0,0 +1,19 @@
+---
+AllCops:
+  TargetRubyVersion: 2.7.2
+  NewCops: enable
+# Set method line number to 25
+Metrics/MethodLength:
+  Max: 25
+# Set parameter number to 10
+Metrics/ParameterLists:
+  Max: 10
+# Disable checking of ABC metrics (assignment, branch, condition)
+Metrics/AbcSize:
+  Enabled: false
+# Disable method perceived complexity (how it is hard to read a method)
+Metrics/PerceivedComplexity:
+  Enabled: false
+# Disable cyclomatic complexity which is a number of paths through a method
+Metrics/CyclomaticComplexity:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vtt2ass.gemspec

data/README.md

@@ -64,6 +64,10 @@ Options:
   -c, [--css=CSS]                  # Specify a CSS file path for Hidive subs
   -l, [--line-offset=N]            # Specify a line offset for the main dialog (e.g. 50 lowers the text line by 50px of the total height)
                                    # Default: 0
+  -w, [--width=N]                  # Specify the video width
+                                   # Default: 1920
+  -h, [--height=N]                 # Specify the video height
+                                   # Default: 1080
   -q, [--quiet], [--no-quiet]      # Don't output to the console
 
 Run the VTT to ASS conversion for the specified file(s)
@@ -99,7 +103,7 @@ $ gem build vtt2ass.gemspec
 
 To install the gem file:
 ```bash
-$ gem install ./vtt2ass-0.3.3.gem
+$ gem install ./vtt2ass-0.3.5.gem
 ```
 
 ## License

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/vtt2ass

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../lib/vtt2ass'
-MainCommand.start
+MainCommand.start

data/exe/vtt2ass

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'vtt2ass'
-MainCommand.start
+MainCommand.start

data/lib/vtt2ass/application.rb

@@ -1,77 +1,78 @@
-# Relative imports
+# frozen_string_literal: true
+
 require_relative 'vtt_file'
 require_relative 'ass_file'
 
 ##
 # Main application class that manages all the operations.
 class Application
+  ##
+  # Creates a new Application instance.
+  # It receives +options+ that can define the input and output directories.
+  def initialize(input, options)
+    @options = options
+    @input = sanitize_path(input)
+  end
 
-    ##
-    # Creates a new Application instance.
-    # It receives +options+ that can define the input and output directories.
-    def initialize(input, options)
-        @input = input ? input.gsub('\\', '/').delete_suffix('/') : "."
-        @output = options[:output] ? options[:output].gsub('\\', '/').delete_suffix('/') : nil
-        @width = 1920
-        @height = 1080
-        @font_family = options[:font_family] ? options[:font_family] : 'Open Sans Semibold'
-        @font_size = options[:font_size] ? options[:font_size] : 52
-        if options[:title] then
-            @title = options[:title]
-        end
-        @quiet = options[:quiet]
-        if options[:css] then
-            @css = options[:css].gsub('\\', '/').delete_suffix('/')
-        end
-        @line_offset = options[:line_offset]
-    end
+  ##
+  # Replace backslashes from Windows paths to normal slashes.
+  # Deletes the trailing slash if there is one.
+  def sanitize_path(path)
+    path&.gsub('\\', '/')&.delete_suffix('/')
+  end
 
-    ##
-    # This method starts the application process.
-    # It sends the file_paths of VTT files in the input directory to convertFileToASS method
-    # and outputs the resulting ASS format to a new file.
-    def start
-        if File.directory?(@input) then
-            Dir["#{@input}/*.vtt"].each do |file_path|
-                convert(file_path)
-            end
-        elsif File.file?(@input) then
-            convert(@input)
-        else
-            puts 'Error: input file or directory does not exist.'
-        end
+  ##
+  # This method starts the application process.
+  # It sends the file_paths of VTT files in the input directory to convertFileToASS method
+  # and outputs the resulting ASS format to a new file.
+  def start
+    if File.directory?(@input)
+      Dir["#{@input}/*.vtt"].each do |file_path|
+        convert(file_path)
+      end
+    elsif File.file?(@input)
+      convert(@input)
+    else
+      raise StandardError, 'ERROR: Input file or directory does not exist.'
     end
+  rescue SystemExit, Interrupt
+    puts 'ERROR: The application stopped unexpectedly. The conversion may not have been completed.'
+  rescue StandardError => e
+    puts e.message
+  end
 
-    def convert(input_path)
-        ass_file = vtt_to_ass(input_path)
-        if (not @output.nil?) then
-            ass_file.write_to_file(@output + '/' + File.basename(input_path).gsub('.vtt', '.ass'))
-        end
-        puts ass_file.to_s unless @quiet
-    end
+  ##
+  # This method launches the conversion process on the specified input file.
+  def convert(input_path)
+    output = sanitize_path(@options[:output])
+    raise StandardError, 'ERROR: Output directory does not exist.' unless File.directory?(output)
 
-    ##
-    # This method creates a new VTTFile object from the file path provided and convert its content
-    # inside a new ASSFile object.
-    def vtt_to_ass(file_path)
-        base_file_name = File.basename(file_path).gsub('.vtt', '')
-        css_file = nil
-        if defined?(@css) and File.directory?(@css) then
-            css_file = "#{@css}/#{base_file_name}.css"
-        elsif File.file?("#{file_path.gsub('.vtt', '')}.css") then
-            css_file = "#{file_path.gsub('.vtt', '')}.css"
-        else
-            css_file = @css
-        end
-        vtt_file = VTTFile.new(file_path, @width, @height)
-        ass_file = ASSFile.new(
-            (defined?(@title) ? @title : base_file_name),
-            @width,
-            @height,
-            css_file
-        )
-        ass_file.convert_vtt_to_ass(vtt_file, @font_family, @font_size, @line_offset)
-        return ass_file
-    end
+    ass_file = vtt_to_ass(input_path)
+    ass_file.write_to_file("#{output}/#{File.basename(input_path).gsub('.vtt', '.ass')}") unless output.nil?
+    puts ass_file.to_s unless @options[:quiet]
+  end
 
-end
+  ##
+  # This method creates a new VTTFile object from the file path provided and convert its content
+  # inside a new ASSFile object.
+  def vtt_to_ass(file_path)
+    base_file_name = File.basename(file_path).gsub('.vtt', '')
+    css_file =
+      if !@options[:css].nil? && File.directory?(@options[:css])
+        "#{sanitize_path(@options[:css])}/#{base_file_name}.css"
+      elsif File.file?("#{file_path.gsub('.vtt', '')}.css")
+        "#{file_path.gsub('.vtt', '')}.css"
+      else
+        @options[:css]
+      end
+    vtt_file = VTTFile.new(file_path, @options[:width], @options[:height])
+    ass_file = ASSFile.new(
+      (@options[:title].nil? ? base_file_name : @options[:title]),
+      @options[:width],
+      @options[:height],
+      css_file
+    )
+    ass_file.convert_vtt_to_ass(vtt_file, @options[:font_family], @options[:font_size], @options[:line_offset])
+    ass_file
+  end
+end

data/lib/vtt2ass/ass_file.rb

@@ -1,4 +1,5 @@
-# Relative imports
+# frozen_string_literal: true
+
 require_relative 'ass_line'
 require_relative 'ass_style'
 require_relative 'css_file'
@@ -7,104 +8,99 @@ require_relative 'css_rule'
 ##
 # This class defines an ASS subtitle file.
 class ASSFile
-    attr_reader :title, :width, :height
-    attr_accessor :ass_styles, :ass_lines
+  attr_reader :title, :width, :height
+  attr_accessor :ass_styles, :ass_lines
 
-    ##
-    # Creates a new ASSFile instance and assigns the default values of instance variables.
-    def initialize(title, width, height, css_file_path = nil)
-        @width = width
-        @height = height
-        if not css_file_path.nil? then
-            @css_file = CSSFile.new(css_file_path)
-        end
-        @header = [
-            '[Script Info]',
-            "Title: #{title}",
-            'ScriptType: v4.00+',
-            'Collisions: Normal',
-            'PlayDepth: 0',
-            "PlayResX: #{@width}",
-            "PlayResY: #{@height}",
-            'WrapStyle: 0',
-            'ScaledBorderAndShadow: yes',
-            '',
-            '[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'
-        ]
-        @events = [
-            '',
-            '[Events]',
-            'Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text'
-        ]
-        @ass_styles = []
-        @ass_lines = []
-    end
+  ##
+  # Creates a new ASSFile instance and assigns the default values of instance variables.
+  def initialize(title, width, height, css_file_path = nil)
+    @width = width
+    @height = height
+    @css_file = CSSFile.new(css_file_path) unless css_file_path.nil?
+    @header = <<~HEADER
+      [Script Info]
+      Title: #{title}
+      ScriptType: v4.00+
+      Collisions: Normal
+      PlayDepth: 0
+      PlayResX: #{@width}
+      PlayResY: #{@height}
+      WrapStyle: 0
+      ScaledBorderAndShadow: yes
+
+      [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
+    HEADER
+    @events = <<~EVENTS
 
-    ##
-    # This method receives a VTTFile object and font arguments creates new ASSLine with the params of 
-    # each VTTLine. All those ASSLine are stored in an array. It also creates an array of ASSStyle that
-    # will be used in the ASS style list.
-    def convert_vtt_to_ass(vtt_file, font_family, font_size, line_offset = 0)
-        fs = font_size
-        vtt_file.lines.each do |line|
-            font_color = '&H00FFFFFF'
-            is_italic = false
-            is_bold = false
-            @ass_lines.push(ASSLine.new(line.style, line.time_start, line.time_end, line.text))
-            style_exists = false
-            @ass_styles.each do |style|
-                if (style.style_name.eql? line.style) then
-                    style_exists = true
-                    break
-                end
-            end
-            if not style_exists then
-                if defined?(@css_file) then
-                    css_rule = @css_file.find_rule(line.style)
-                    if not css_rule.nil? then
-                        css_rule.properties.each do |property|
-                            case property[:key]
-                            when 'font-family'
-                                font_family = property[:value].gsub('"', '').split(' ,').last
-                            when 'font-size'
-                                em_size = 1
-                                #em_size = property[:value][0].eql? '.' ? "0#{property[:value]}" : property[:value]
-                                if property[:value][0].eql? '.' then
-                                    em_size = "0#{property[:value]}".gsub('em', '').to_f
-                                end
-                                font_size = (fs * em_size).to_i
-                            when 'color'
-                                font_color = ASSStyle.convert_color(property[:value])
-                            when 'font-weight'
-                                if property[:value].eql? 'bold' then
-                                    is_bold = true
-                                end
-                            when 'font-style'
-                                if property[:value].eql? 'italic' then
-                                    is_italic = true
-                                end
-                            end
-                        end
-                    end
-                end
-                @ass_styles.push(ASSStyle.new(line.style, line.params, font_family, font_size, font_color, is_bold, is_italic, line_offset, @width, @height))
-            end
+      [Events]
+      Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
+    EVENTS
+    @ass_styles = []
+    @ass_lines = []
+  end
+
+  ##
+  # This method receives a VTTFile object and font arguments creates new ASSLine with the params of
+  # each VTTLine. All those ASSLine are stored in an array. It also creates an array of ASSStyle that
+  # will be used in the ASS style list.
+  def convert_vtt_to_ass(vtt_file, font_family, font_size, line_offset = 0) # rubocop:disable Metrics/MethodLength
+    fs = font_size
+    vtt_file.lines.each do |line| # rubocop:disable Metrics/BlockLength
+      font_color = '&H00FFFFFF'
+      is_italic = false
+      is_bold = false
+      @ass_lines.push(ASSLine.new(line.style, line.time_start, line.time_end, line.text))
+      style_exists = false
+      @ass_styles.each do |style|
+        if style.style_name.eql? line.style
+          style_exists = true
+          break
         end
-    end
+      end
+      next if style_exists
 
-    ##
-    # This method writes the content of the ASSFile object into a file path that is provided.
-    def write_to_file(file_path)
-        File.open(file_path, 'w') do |line|
-            line.print "\ufeff"
-            line.puts self.to_s
+      unless @css_file.nil?
+        css_rule = @css_file.find_rule(line.style)
+        css_rule&.properties&.each do |property|
+          case property[:key]
+          when 'font-family'
+            font_family = property[:value].gsub('"', '').split(' ,').last
+          when 'font-size'
+            em_size = 1
+            em_size = "0#{property[:value]}".gsub('em', '').to_f if property[:value][0].eql? '.'
+            font_size = (fs * em_size).to_i
+          when 'color'
+            font_color = ASSStyle.convert_color(property[:value])
+          when 'font-weight'
+            is_bold = true if property[:value].eql? 'bold'
+          when 'font-style'
+            is_italic = true if property[:value].eql? 'italic'
+          end
         end
+      end
+      @ass_styles.push(
+        ASSStyle.new(
+          line.style, line.params,
+          font_family, font_size, font_color, is_bold, is_italic,
+          line_offset, @width, @height
+        )
+      )
     end
+  end
 
-    ##
-    # This method concatenates the object data in the right order for a string output.
-    def to_s
-        return @header + @ass_styles + @events + @ass_lines
+  ##
+  # This method writes the content of the ASSFile object into a file path that is provided.
+  def write_to_file(file_path)
+    File.open(file_path, 'w') do |line|
+      line.print "\ufeff"
+      line.puts to_s
     end
-end
+  end
+
+  ##
+  # This method concatenates the object data in the right order for a string output.
+  def to_s
+    "#{@header}#{@ass_styles.join("\n")}#{@events}#{@ass_lines.join("\n")}"
+  end
+end

data/lib/vtt2ass/ass_line.rb

@@ -1,94 +1,97 @@
+# frozen_string_literal: true
+
 require 'htmlentities'
 
 ##
 # This class defines an ASS subtile line.
 class ASSLine
-    attr_reader :style, :time_start, :time_end, :text
-    
-    ##
-    # This method creates an instance of an ASSLine.
-    #
-    # * Requires a +style+ name as input.
-    # * Requires +time_start+, a VTT formatted timestamp as input.
-    # * Requires +time_start+, a VTT formatted timestamp as input.
-    # * Requires +text+, a VTT formatted string as input.
-    def initialize(style, time_start, time_end, text)
-        @style = style
-        @time_start = convert_time(time_start)
-        @time_end = convert_time(time_end)
-        @text = convert_to_ass_text(text)
-    end
+  attr_reader :style, :time_start, :time_end, :text
+
+  ##
+  # This method creates an instance of an ASSLine.
+  #
+  # * Requires a +style+ name as input.
+  # * Requires +time_start+, a VTT formatted timestamp as input.
+  # * Requires +time_start+, a VTT formatted timestamp as input.
+  # * Requires +text+, a VTT formatted string as input.
+  def initialize(style, time_start, time_end, text)
+    @style = style
+    @time_start = convert_time(time_start)
+    @time_end = convert_time(time_end)
+    @text = convert_to_ass_text(text)
+  end
+
+  ##
+  # This method assigns the object values and outputs an ASS dialogue line.
+  def to_s
+    "Dialogue: 0,#{@time_start},#{@time_end},#{@style},,0,0,0,,#{@text}"
+  end
+
+  ##
+  # This method replaces characters and tags to ASS compatible characters and tags.
+  #
+  # * Requires +text+, a string of VTT formated text as input.
+  def convert_to_ass_text(text)
+    decoder = HTMLEntities.new
+    text =
+      text
+      .gsub(/\r/, '')
+      .gsub(/\n/, '\\N')
+      .gsub(/\\n/, '\\N')
+      .gsub(/\\N +/, '\\N')
+      .gsub(/ +\\N/, '\\N')
+      .gsub(/(\\N)+/, '\\N')
+      .gsub(%r{<b[^>]*>([^<]*)</b>}) { |_s| "{\\b1}#{Regexp.last_match(1)}{\\b0}" }
+      .gsub(%r{<i[^>]*>([^<]*)</i>}) { |_s| "{\\i1}#{Regexp.last_match(1)}{\\i0}" }
+      .gsub(%r{<u[^>]*>([^<]*)</u>}) { |_s| "{\\u1}#{Regexp.last_match(1)}{\\u0}" }
+      .gsub(%r{<c[^>]*>([^<]*)</c>}) { |_s| Regexp.last_match(1) }
+      .gsub(/<[^>]>/, '')
+      .gsub(/\\N$/, '')
+      .gsub(/ +$/, '')
+    decoder.decode(text)
+  end
+
+  ##
+  # This method validates the time format and sends the matching time to be converted
+  #
+  # * Requires +str+, a VTT formatted time string.
+  def convert_time(time)
+    matched_time = time.match(/([\d:]*)\.?(\d*)/)
+    to_subs_time(matched_time[0])
+  end
+
+  ##
+  # This method converts time from VTT format to the ASS format.
+  #
+  # * Requires +str+, a VTT formatted time string.
+  def to_subs_time(str)
+    n = []
+    x = str.split(/[:.]/).map(&:to_i)
+
+    ms_len = 2
+    h_len = 1
+
+    x[3] = "0.#{x[3].to_s.rjust(3, '0')}"
+    sx = (x[0] * 60 * 60) + (x[1] * 60) + x[2] + x[3].to_f
+    sx = format('%.2f', sx).split('.')
+
+    n.unshift(pad_time_num('.', sx[1], ms_len))
+    sx = sx[0].to_f
 
-    ##
-    # This method assigns the object values and outputs an ASS dialogue line.
-    def to_s
-        return "Dialogue: 0,#{@time_start},#{@time_end},#{@style},,0,0,0,,#{@text}"
-    end
+    n.unshift(pad_time_num(':', (sx % 60).to_i, 2))
+    n.unshift(pad_time_num(':', (sx / 60).floor % 60, 2))
+    n.unshift(pad_time_num('',  (sx / 3600).floor % 60, h_len))
 
-    ##
-    # This method replaces characters and tags to ASS compatible characters and tags.
-    #
-    # * Requires +text+, a string of VTT formated text as input.  
-    def convert_to_ass_text(text)
-        decoder = HTMLEntities.new()
-        text = text
-            .gsub(/\r/, '')
-            .gsub(/\n/, '\\N')
-            .gsub(/\\n/, '\\N')
-            .gsub(/\\N +/, '\\N')
-            .gsub(/ +\\N/, '\\N')
-            .gsub(/(\\N)+/, '\\N')
-            .gsub(/<b[^>]*>([^<]*)<\/b>/) { |s| "{\\b1}#{$1}{\\b0}" }
-            .gsub(/<i[^>]*>([^<]*)<\/i>/) { |s| "{\\i1}#{$1}{\\i0}" }
-            .gsub(/<u[^>]*>([^<]*)<\/u>/) { |s| "{\\u1}#{$1}{\\u0}" }
-            .gsub(/<c[^>]*>([^<]*)<\/c>/) { |s| $1 }
-            .gsub(/<[^>]>/, '')
-            .gsub(/\\N$/, '')
-            .gsub(/ +$/, '')
-        return decoder.decode(text)
-    end
+    n.join
+  end
 
-    ##
-    # This method validates the time format and sends the matching time to be converted
-    #
-    # * Requires +str+, a VTT formatted time string.
-    def convert_time(time)
-        mTime = time.match(/([\d:]*)\.?(\d*)/)
-        return to_subs_time(mTime[0])
-    end
-    
-    ##
-    # This method converts time from VTT format to the ASS format.
-    #
-    # * Requires +str+, a VTT formatted time string.
-    def to_subs_time(str)
-        n = []
-        x = str.split(/[:.]/).map { |x| x.to_i }
-        
-        msLen = 2
-        hLen = 1
-        
-        x[3] = '0.' + (x[3].to_s).rjust(3, '0')
-        sx = x[0]*60*60 + x[1]*60 + x[2] + x[3].to_f
-        sx = ("%.2f" % sx).split('.')
-    
-        n.unshift(pad_time_num('.', sx[1], msLen))
-        sx = sx[0].to_f
-    
-        n.unshift(pad_time_num(':', (sx % 60).to_i, 2))
-        n.unshift(pad_time_num(':', (sx / 60).floor % 60, 2))
-        n.unshift(pad_time_num('',  (sx / 3600).floor % 60, hLen))
-    
-        return n.join('')
-    end
-    
-    ##
-    # This method pads text so that time numbers are a fixed number of digit.
-    #
-    # * Requires +sep+, a string separator.
-    # * Requires +input+, an integer.
-    # * Requires +pad+, an integer for the number of digits to be padded. 
-    def pad_time_num(sep, input, pad)
-        return sep + (input.to_s).rjust(pad, '0')
-    end
-end
+  ##
+  # This method pads text so that time numbers are a fixed number of digit.
+  #
+  # * Requires +sep+, a string separator.
+  # * Requires +input+, an integer.
+  # * Requires +pad+, an integer for the number of digits to be padded.
+  def pad_time_num(sep, input, pad)
+    sep + input.to_s.rjust(pad, '0')
+  end
+end