vtt2ass 0.3.2 → 0.3.5

data/lib/vtt2ass/css_rule.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+##
+# This class defines a CSS rule that is included in the CSS file.
+class CSSRule
+  attr_reader :name, :properties
+
+  def initialize(selector, declarations)
+    @name = reduce_selector(selector)
+    @properties = []
+    declarations.split(/;\s?/).each do |dec|
+      temp = dec.split(/:\s?/)
+      @properties.push(
+        { key: temp.first, value: temp.last }
+      )
+    end
+  end
+
+  def to_s
+    "#{@name} #{@properties}"
+  end
+
+  ##
+  # This method removes the generic selector from a block.
+  def reduce_selector(selector)
+    selector.to_s.gsub(
+      /\.rmp-container>\.rmp-content>\.rmp-cc-area>\.rmp-cc-container>\.rmp-cc-display>\.rmp-cc-cue\s?\.?/, ''
+    )
+  end
+end

data/lib/vtt2ass/validator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+##
+# This class defines validation tools for data.
+class Validator
+  def self.hex?(value)
+    hex = true
+    value.gsub!('#', '')
+    value.chars.each do |digit|
+      hex = false unless digit.match(/\h/)
+    end
+    hex
+  end
+end

data/lib/vtt2ass/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 ##
 # Vtt2ass module to provide the version number
 module Vtt2ass
   ##
   # This is the version of the application.
   # This needs to be changed for each gem release.
-  VERSION = "0.3.2"
+  VERSION = '0.3.5'
 end

data/lib/vtt2ass/vtt_file.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'vtt_line'
+
+##
+# This class defines a VTT subtile file.
+class VTTFile
+  attr_accessor :lines
+
+  ##
+  # Creates a new VTTFile instance and assigns the default values of instance variables.
+  def initialize(file_path, width, height)
+    @title = File.basename(file_path).gsub('.vtt', '')
+    @lines = []
+    separator = determine_line_ending(file_path) ? "\n\n" : "\r\n\r\n"
+    count = 0
+    style_count = 1
+    File.foreach(file_path, separator) do |paragraph|
+      paragraph = paragraph.rstrip.gsub(/[\r\n]/, "\n")
+      unless paragraph.eql? ''
+        vtt_line = VTTLine.new(paragraph, width, height)
+        if vtt_line.style.eql?('Main') &&
+           !vtt_line.params.to_s.empty? &&
+           (!vtt_line.params.to_s.eql?('align:middle') &&
+           !vtt_line.params.to_s.eql?('align:center'))
+          vtt_line.style = "Style#{style_count}"
+          style_count += 1
+        end
+        @lines.push(vtt_line)
+        count += 1
+      end
+    end
+    @lines.shift
+  end
+
+  ##
+  # This method determines the line ending character to use as a separator.
+  def determine_line_ending(file_path)
+    File.open(file_path, 'r') do |file|
+      return file.readline[/\r?\n$/] == "\n"
+    end
+  end
+
+  ##
+  # This method writes the content of the VTTFile 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
+
+  ##
+  # This method concatenates the object data in the right order for a string output.
+  def to_s
+    "WEBVTT\n\n\n#{@lines}"
+  end
+end

data/lib/vtt2ass/vtt_line.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+##
+# This class defines a VTT subtile line.
+class VTTLine
+  attr_accessor :style
+  attr_reader :time_start, :time_end, :params, :text
+
+  ##
+  # This method creates an instance of an VTTLine.
+  #
+  # * Requires +paragraph+, a VTT formatted string as input.
+  def initialize(paragraph, width, height)
+    lines = paragraph.split("\n")
+    rx = /^([\d:.]*) --> ([\d:.]*)\s?(.*?)\s*$/
+    @style = 'Main'
+    @text, @time_start, @time_end, @params = ''
+    count = 0
+
+    lines.each do |line|
+      m = line.match(rx)
+      if !m && count.zero?
+        @style = line
+      elsif m
+        @time_start = m[1]
+        @time_end = m[2]
+        @params = m[3]
+        ass_style = ASSStyleParams.new(@params, width, height)
+        @style = 'MainTop' if @style.eql?('Main') && ass_style.alignment == 8
+      else
+        @text += "#{line}\n"
+      end
+      count += 1
+    end
+
+    @text = @text.lstrip
+  end
+
+  ##
+  # This method assigns the object values and outputs a VTT dialogue line.
+  def to_s
+    "#{@style} \n#{@time_start} --> #{@time_end} #{@params}\n#{@text}"
+  end
+end

data/lib/vtt2ass.rb

@@ -1,30 +1,60 @@
-# Imports
+# frozen_string_literal: true
+
 require 'thor'
 
-# Relative imports
 require_relative 'vtt2ass/version'
-require_relative 'vtt2ass/Application'
+require_relative 'vtt2ass/application'
 
+##
+# This is the main command line Class that manages the provided CLI arguments.
 class MainCommand < Thor
-    def self.exit_on_failure?
-        true
-    end
+  def self.exit_on_failure?
+    true
+  end
 
-    desc 'convert INPUT', 'Run the VTT to ASS conversion for the specified file(s)'
-    method_option :output,      :aliases => '-o', :desc => 'Output directory of the converted file' , :lazy_default => './', :type => :string
-    method_option :title,       :aliases => '-t', :desc => 'Specify a title for you file. If the input is a directory, all files will share the same title.', :type => :string
-    method_option :font_size,   :aliases => '-s', :desc => 'Specify a font size for the subtitles', :default => 52, :type => :numeric
-    method_option :font_family, :aliases => '-f', :desc => 'Specify a font family for the subtitles', :default => 'Open Sans Semibold', :type => :string
-    method_option :css,         :aliases => '-c', :desc => 'Specify a CSS file path for Hidive subs', :type => :string
-    method_option :line_offset, :aliases => '-l', :desc => 'Specify a line offset for the main dialog (e.g. 50 lowers the text line by 50px of the total height)', :default => 0, :type => :numeric
-    method_option :quiet,       :aliases => '-q', :desc => 'Don\'t output to the console', :type => :boolean
-    def convert(input)
-        app = Application.new(input, options)
-        app.start
-    end
+  desc 'convert INPUT', 'Run the VTT to ASS conversion for the specified file(s)'
+  method_option :output,      aliases: '-o',
+                              desc: 'Output directory of the converted file',
+                              lazy_default: './',
+                              type: :string
+  method_option :title,       aliases: '-t',
+                              desc: 'Specify a title for you file. If the input is a directory, '\
+                                    'all files will share the same title.',
+                              type: :string
+  method_option :font_size,   aliases: '-s',
+                              desc: 'Specify a font size for the subtitles',
+                              default: 52,
+                              type: :numeric
+  method_option :font_family, aliases: '-f',
+                              desc: 'Specify a font family for the subtitles',
+                              default: 'Open Sans Semibold',
+                              type: :string
+  method_option :css,         aliases: '-c',
+                              desc: 'Specify a CSS file path for Hidive subs',
+                              type: :string
+  method_option :line_offset, aliases: '-l',
+                              desc: 'Specify a line offset for the main dialog (e.g. 50 lowers the '\
+                                    'text line by 50px of the total height)',
+                              default: 0,
+                              type: :numeric
+  method_option :width,       aliases: '-w',
+                              desc: 'Specify the video width',
+                              default: 1920,
+                              type: :numeric
+  method_option :height,      aliases: '-h',
+                              desc: 'Specify the video height',
+                              default: 1080,
+                              type: :numeric
+  method_option :quiet,       aliases: '-q',
+                              desc: 'Don\'t output to the console',
+                              type: :boolean
+  def convert(input)
+    app = Application.new(input, options)
+    app.start
+  end
 
-    desc 'version', 'Show version'
-    def version
-        puts Vtt2ass::VERSION
-    end
+  desc 'version', 'Show version'
+  def version
+    puts Vtt2ass::VERSION
+  end
 end

data/vtt2ass.gemspec

@@ -1,36 +1,39 @@
+# frozen_string_literal: true
+
 require_relative 'lib/vtt2ass/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "vtt2ass"
+  spec.name          = 'vtt2ass'
   spec.version       = Vtt2ass::VERSION
-  spec.authors       = ["Louis-Philippe Fortin"]
-  spec.email         = ["timemaster.lpf@gmail.com"]
+  spec.authors       = ['Louis-Philippe Fortin']
+  spec.email         = ['timemaster.lpf@gmail.com']
 
-  spec.summary       = "Convert VTT subtitles to ASS subtitles"
-  spec.homepage      = "https://gitlab.com/dkb-weeblets/vtt2ass"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.2")
+  spec.summary       = 'Convert VTT subtitles to ASS subtitles'
+  spec.homepage      = 'https://gitlab.com/dkb-weeblets/vtt2ass'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.2')
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'htmlentities', '~> 4.3'
-  spec.add_dependency 'thor', '~> 1.1'
   spec.add_dependency 'css_parser', '~> 1.10'
+  spec.add_dependency 'htmlentities', '~> 4.3'
   spec.add_dependency 'redgreenblue', '~> 0.15'
+  spec.add_dependency 'thor', '~> 1.1'
 
-  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'yard', '~> 0.9'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: vtt2ass
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.5
 platform: ruby
 authors:
 - Louis-Philippe Fortin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-30 00:00:00.000000000 Z
+date: 2022-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: htmlentities
+  name: css_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: htmlentities
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
-  name: css_parser
+  name: redgreenblue
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: redgreenblue
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +118,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -153,17 +154,17 @@ files:
 - doc/top-level-namespace.html
 - exe/vtt2ass
 - lib/vtt2ass.rb
-- lib/vtt2ass/ASSFile.rb
-- lib/vtt2ass/ASSLine.rb
-- lib/vtt2ass/ASSStyle.rb
-- lib/vtt2ass/ASSStyleParams.rb
-- lib/vtt2ass/Application.rb
-- lib/vtt2ass/CSSFile.rb
-- lib/vtt2ass/CSSRule.rb
-- lib/vtt2ass/VTTFile.rb
-- lib/vtt2ass/VTTLine.rb
-- lib/vtt2ass/Validator.rb
+- lib/vtt2ass/application.rb
+- lib/vtt2ass/ass_file.rb
+- lib/vtt2ass/ass_line.rb
+- lib/vtt2ass/ass_style.rb
+- lib/vtt2ass/ass_style_params.rb
+- lib/vtt2ass/css_file.rb
+- lib/vtt2ass/css_rule.rb
+- lib/vtt2ass/validator.rb
 - lib/vtt2ass/version.rb
+- lib/vtt2ass/vtt_file.rb
+- lib/vtt2ass/vtt_line.rb
 - vtt2ass.gemspec
 homepage: https://gitlab.com/dkb-weeblets/vtt2ass
 licenses:
@@ -172,6 +173,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://gitlab.com/dkb-weeblets/vtt2ass
   source_code_uri: https://gitlab.com/dkb-weeblets/vtt2ass
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/vtt2ass/ASSFile.rb

@@ -1,110 +0,0 @@
-# Relative imports
-require_relative 'ASSLine'
-require_relative 'ASSStyle'
-require_relative 'CSSFile'
-require_relative 'CSSRule'
-
-##
-# This class defines an ASS subtitle file.
-class ASSFile
-    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
-
-    ##
-    # 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 convertVTTtoASS(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
-        end
-    end
-
-    ##
-    # This method writes the content of the ASSFile object into a file path that is provided.
-    def writeToFile(file_path)
-        File.open(file_path, 'w') do |line|
-            line.print "\ufeff"
-            line.puts self.to_s
-        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
-    end
-end

data/lib/vtt2ass/ASSLine.rb

@@ -1,94 +0,0 @@
-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 = convertTime(time_start)
-        @time_end = convertTime(time_end)
-        @text = convertToAssText(text)
-    end
-
-    ##
-    # 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
-
-    ##
-    # This method replaces characters and tags to ASS compatible characters and tags.
-    #
-    # * Requires +text+, a string of VTT formated text as input.  
-    def convertToAssText(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
-
-    ##
-    # This method validates the time format and sends the matching time to be converted
-    #
-    # * Requires +str+, a VTT formatted time string.
-    def convertTime(time)
-        mTime = time.match(/([\d:]*)\.?(\d*)/)
-        return toSubsTime(mTime[0])
-    end
-    
-    ##
-    # This method converts time from VTT format to the ASS format.
-    #
-    # * Requires +str+, a VTT formatted time string.
-    def toSubsTime(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(padTimeNum('.', sx[1], msLen))
-        sx = sx[0].to_f
-    
-        n.unshift(padTimeNum(':', (sx % 60).to_i, 2))
-        n.unshift(padTimeNum(':', (sx / 60).floor % 60, 2))
-        n.unshift(padTimeNum('',  (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 padTimeNum(sep, input, pad)
-        return sep + (input.to_s).rjust(pad, '0')
-    end
-end