vtt2ass 0.2.8 → 0.2.13

data/doc/top-level-namespace.html

@@ -86,7 +86,7 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ASSFile.html" title="ASSFile (class)">ASSFile</a></span>, <span class='object_link'><a href="ASSStyle.html" title="ASSStyle (class)">ASSStyle</a></span>, <span class='object_link'><a href="ASSSubtitle.html" title="ASSSubtitle (class)">ASSSubtitle</a></span>, <span class='object_link'><a href="Application.html" title="Application (class)">Application</a></span>, <span class='object_link'><a href="VTTSubtitle.html" title="VTTSubtitle (class)">VTTSubtitle</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ASSFile.html" title="ASSFile (class)">ASSFile</a></span>, <span class='object_link'><a href="ASSLine.html" title="ASSLine (class)">ASSLine</a></span>, <span class='object_link'><a href="ASSStyle.html" title="ASSStyle (class)">ASSStyle</a></span>, <span class='object_link'><a href="ASSStyleParams.html" title="ASSStyleParams (class)">ASSStyleParams</a></span>, <span class='object_link'><a href="Application.html" title="Application (class)">Application</a></span>, <span class='object_link'><a href="VTTFile.html" title="VTTFile (class)">VTTFile</a></span>, <span class='object_link'><a href="VTTLine.html" title="VTTLine (class)">VTTLine</a></span>
     
   
 </p>
@@ -102,9 +102,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jan 14 00:31:16 2021 by
+  Generated on Tue Mar 23 21:07:02 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.2).
+  0.9.26 (ruby-3.0.0).
 </div>
 
     </div>

data/lib/vtt2ass.rb

@@ -1,42 +1,109 @@
 # Imports
-require 'optparse'
+require 'tty-option'
 
 # Relative imports
 require_relative 'vtt2ass/version'
 require_relative 'vtt2ass/Application'
 
+class Command
+    include TTY::Option
+
+    usage do
+        header 'VTT2ASS'
+        program 'vtt2ass'
+        command ''
+        desc 'Convert VTT subtitles to ASS subtitles'
+        example "Convert files in a specific directory",
+                "  $ vtt2ass ./path/to/file_input ./path/to/file_output"
+    end
+
+    # ------------------------------
+    # Arguments
+    # ------------------------------
+
+    argument :input do
+        optional
+        desc "Input directory or file (default: current directory)"
+    end
+
+    argument :output do
+        optional
+        desc "Output directory (default: console output)"
+    end
+
+    # ------------------------------
+    # Flags
+    # ------------------------------
+
+    flag :help do
+        short "-h"
+        long "--help"
+        desc "Print usage"
+    end
+
+    flag :version do
+        short "-v"
+        long "--version"
+        desc "Show version"
+    end
+
+    flag :quiet do
+        short "-q"
+        long "--quiet"
+        desc "Prevent the command from outputing to the console"
+    end
+
+    flag :noout do
+        short "-x"
+        long "--noout"
+        desc "Prevents the command from writing the resulting file(s) to the output folder"
+    end
+
+    # ------------------------------
+    # Options
+    # ------------------------------
+
+    option :title do
+        optional
+        short "-t STRING"
+        long "--title STRING"
+        desc "Specify a title for you file. If the input is a directory, all files will share the same title."
+    end
+
+    option :font_size do
+        optional
+        short "-s INTEGER"
+        long "--font-size INTEGER"
+        desc "Specify a font size for the subtitles (default: 52)"
+    end
+
+    option :font_family do
+        optional
+        short "-f STRING"
+        long "--font-family STRING"
+        desc "Specify a font family for the subtitles (default: 'Open Sans Semibold')"
+    end
+
+    def run
+        if params[:help] then
+            print help
+            exit
+        elsif params[:version] then
+            puts Vtt2ass::VERSION
+            exit
+        else
+            runner = Application.new(params)
+            # pp params.to_h
+            runner.start
+        end
+    end
+end
+
 module Vtt2ass
-    ##
-    # This function creates a new application instance and starts the process.
-    #
-    # It also defines the arguments that can be provided from the CLI.
     def main
-        options = {}
-
-        OptionParser.new do |opts|
-            opts.banner = "Usage: vtt2ass [options]"
-            opts.separator ""
-            opts.separator "Specific options:"
-            opts.on("-i", "--input PATH", "Specify a custom input file or directory (default: './')") do |file_path|
-                options[:input] = file_path
-            end
-            opts.on("-o", "--output PATH", "Specify a custom output directory (default: './')") do |file_path|
-                options[:output] = file_path
-            end
-            opts.on("-f", "--font-family FONT", String, "Specify a font family for the subtitles (default: 'Open Sans Semibold')") do |font_family|
-                options[:font_family] = font_family
-            end
-            opts.on("-s", "--font-size SIZE", Integer, "Specify a font size for the subtitles (default: 52)") do |font_size|
-                options[:font_size] = font_size
-            end
-            opts.on("-v", "--version", "Show version") do
-                puts Vtt2ass::VERSION
-                exit
-            end
-        end.parse!
-
-        app = Application.new(options)
-        app.start
+        app = Command.new
+        app.parse
+        app.run
     end
 
     module_function :main

data/lib/vtt2ass/ASSFile.rb

@@ -8,6 +8,8 @@ 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)
         @width = width
         @height = height
@@ -34,12 +36,16 @@ class ASSFile
         @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)
         vtt_file.lines.each do |line|
             @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 == line.style) then
+                if (style.style_name.eql? line.style) then
                     style_exists = true
                     break
                 end
@@ -50,6 +56,8 @@ class ASSFile
         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"

data/lib/vtt2ass/ASSLine.rb

@@ -83,7 +83,7 @@ class ASSLine
     end
     
     ##
-    # The method pads text so that time numbers are a fixed number of digit.
+    # This method pads text so that time numbers are a fixed number of digit.
     #
     # * Requires +sep+, a string separator.
     # * Requires +input+, an integer.

data/lib/vtt2ass/ASSStyle.rb

@@ -20,6 +20,9 @@ class ASSStyle
         @font_size = font_size
         @style_name = style_name
         @s_params = ASSStyleParams.new(params, width, height)
+        if style_name.eql? 'MainTop' then
+            @s_params.vertical_margin = 50
+        end
     end
 
     ##

data/lib/vtt2ass/ASSStyleParams.rb

@@ -1,8 +1,12 @@
 ##
 # This class defines the ASS style parameters from VTT cue settings.
 class ASSStyleParams
-    attr_reader :horizontal_margin, :vertical_margin, :alignment, :align
+    attr_accessor :horizontal_margin, :vertical_margin, :alignment, :align
 
+    ##
+    # Creates an instance of ASSStyleParams
+    # It takes VTT style arguments and assign them to their respectful instance variable.
+    # It calls methods to create ASS values from the VTT cue settings.
     def initialize(params, width, height)
         (params.split(' ').map { |p| p.split(':') }).each do |p|
             case p[0]
@@ -20,6 +24,9 @@ class ASSStyleParams
         createVerticalMargin(height)
     end
 
+    ##
+    # This method decides the alignement value in a 9 position grid based of the
+    # values in cue settings "align" and "line".
     def createAlignment()
         if (defined?(@line) and not defined?(@position)) then
             if (defined?(@align)) then
@@ -50,6 +57,9 @@ class ASSStyleParams
         end
     end
 
+    ##
+    # This method calculates the horizontal margin in px between the alignement position and
+    # and the content displayed by using the "position" cue setting.
     def createHorizontalMargin(width)
         steps = (width / 100).to_i
         if defined?(@position) then
@@ -59,6 +69,9 @@ class ASSStyleParams
         end
     end
 
+    ##
+    # This method calculates the vertical margin in px between the alignement position and
+    # and the content displayed by using the "line" cue setting.
     def createVerticalMargin(height)
         steps = (height / 100).to_i
         if defined?(@line) then

data/lib/vtt2ass/Application.rb

@@ -1,6 +1,3 @@
-# Imports
-require 'os'
-
 # Relative imports
 require_relative 'VTTFile'
 require_relative 'ASSFile'
@@ -13,12 +10,17 @@ class Application
     # Creates a new Application instance.
     # It receives +options+ that can define the input and output directories.
     def initialize(options)
-        @input = options[:input] ? options[:input].gsub('\\', '/') : "./"
-        @output = options[:output] ? options[:output].gsub('\\', '/') : "./"
+        @input = options[:input] ? options[:input].gsub('\\', '/').delete_suffix('/') : "."
+        @output = options[:output] ? options[:output].gsub('\\', '/').delete_suffix('/') : "."
         @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]
+        @noout = options[:noout]
     end
 
     ##
@@ -28,18 +30,31 @@ class Application
     def start
         if File.directory?(@input) then
             Dir["#{@input}/*.vtt"].each do |file_path|
-                vtt_to_ass(file_path).writeToFile(File.basename(file_path).gsub('.vtt', '.ass'))
+                convert(file_path)
             end
         elsif File.file?(@input) then
-            vtt_to_ass(@input).writeToFile(@output + File.basename(@input).gsub('.vtt', '.ass'))
+            convert(@input)
         else
             puts 'Error: input file or directory does not exist.'
         end
     end
 
+    def convert(input_path)
+        ass_file = vtt_to_ass(input_path)
+        ass_file.writeToFile(@output + '/' + File.basename(input_path).gsub('.vtt', '.ass')) unless @noout
+        puts ass_file.to_s unless @quiet
+    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)
-        vtt_file = VTTFile.new(file_path)
-        ass_file = ASSFile.new(File.basename(file_path).gsub('.vtt', ''), @width, @height)
+        vtt_file = VTTFile.new(file_path, @width, @height)
+        ass_file = ASSFile.new(
+            (defined?(@title) ? @title : File.basename(file_path).gsub('.vtt', '')),
+            @width,
+            @height
+        )
         ass_file.convertVTTtoASS(vtt_file, @font_family, @font_size)
         return ass_file
     end

data/lib/vtt2ass/VTTFile.rb

@@ -1,6 +1,3 @@
-# Imports
-require 'os'
-
 # Relative imports
 require_relative 'VTTLine'
 
@@ -9,19 +6,32 @@ require_relative 'VTTLine'
 class VTTFile
     attr_accessor :lines
 
-    def initialize(file_path)
+    ##
+    # 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 = OS.posix? ? "\r\n\r\n": "\n\n"
+        separator = determine_line_ending(file_path) ? "\n\n" : "\r\n\r\n"
+        count = 0
         File.foreach(file_path, separator) do |paragraph|
-            paragraph = paragraph.rstrip.gsub(/\r\n/, "\n")
+            paragraph = paragraph.rstrip.gsub(/[\r\n]/, "\n")
             if not paragraph.eql? "" then
-                @lines.push(VTTLine.new(paragraph))
+                vtt_line = VTTLine.new(paragraph, width, height)
+                @lines.push(vtt_line)
+                count += 1
             end
         end
         @lines.shift
     end
 
+    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 writeToFile(file_path)
         File.open(file_path, 'w') do |line|
             line.print "\ufeff"
@@ -29,6 +39,8 @@ class VTTFile
         end
     end
 
+    ##
+    # This method concatenates the object data in the right order for a string output.
     def to_s
         return "WEBVTT\n\n\n" + @lines 
     end

data/lib/vtt2ass/VTTLine.rb

@@ -7,7 +7,7 @@ class VTTLine
     # This method creates an instance of an VTTLine.
     #
     # * Requires +paragraph+, a VTT formatted string as input.
-    def initialize(paragraph)
+    def initialize(paragraph, width, height)
         lines = paragraph.split("\n")
         rx = /^([\d:.]*) --> ([\d:.]*)\s?(.*?)\s*$/
         @style = "Main"
@@ -22,7 +22,8 @@ class VTTLine
                 @time_start = m[1]
                 @time_end = m[2]
                 @params = m[3]
-                if @params.include? "align:middle line:7%" then
+                ass_style = ASSStyleParams.new(@params, width, height)
+                if @style.eql? 'Main' and ass_style.alignment == 8 then
                     @style = "MainTop"
                 end
             else
@@ -30,6 +31,8 @@ class VTTLine
             end
             count += 1;
         end
+
+        @text = @text.lstrip
     end
 
     ##

data/lib/vtt2ass/version.rb

@@ -1,3 +1,8 @@
+##
+# Vtt2ass module to provide the version number
 module Vtt2ass
-  VERSION = "0.2.8"
+  ##
+  # This is the version of the application.
+  # This needs to be changed for each gem release.
+  VERSION = "0.2.13"
 end

data/vtt2ass.gemspec

@@ -25,10 +25,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'os'
-  spec.add_dependency 'htmlentities'
+  spec.add_dependency 'htmlentities', '~> 4.3'
+  spec.add_dependency 'tty-option', '~> 0.1'
 
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: vtt2ass
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.13
 platform: ruby
 authors:
 - Louis-Philippe Fortin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-21 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: os
+  name: htmlentities
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
-  name: htmlentities
+  name: tty-option
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: 
 email:
 - timemaster.lpf@gmail.com
@@ -97,9 +97,13 @@ files:
 - bin/run
 - bin/setup
 - doc/ASSFile.html
+- doc/ASSLine.html
 - doc/ASSStyle.html
+- doc/ASSStyleParams.html
 - doc/ASSSubtitle.html
 - doc/Application.html
+- doc/VTTFile.html
+- doc/VTTLine.html
 - doc/VTTSubtitle.html
 - doc/Vtt2ass.html
 - doc/Vtt2ass/Error.html