vtt2ass 0.2.9 → 0.2.10

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/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,6 +36,10 @@ 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))
@@ -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/ASSStyleParams.rb

@@ -3,6 +3,10 @@
 class ASSStyleParams
     attr_reader :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

@@ -13,8 +13,8 @@ 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'
@@ -31,15 +31,18 @@ class Application
     def start
         if File.directory?(@input) then
             Dir["#{@input}/*.vtt"].each do |file_path|
-                vtt_to_ass(file_path).writeToFile(@output + File.basename(file_path).gsub('.vtt', '.ass'))
+                vtt_to_ass(file_path).writeToFile(@output + '/' + File.basename(file_path).gsub('.vtt', '.ass'))
             end
         elsif File.file?(@input) then
-            vtt_to_ass(@input).writeToFile(@output + File.basename(@input).gsub('.vtt', '.ass'))
+            vtt_to_ass(@input).writeToFile(@output + '/' + File.basename(@input).gsub('.vtt', '.ass'))
         else
             puts 'Error: input file or directory does not exist.'
         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)
         vtt_file = VTTFile.new(file_path)
         ass_file = ASSFile.new(

data/lib/vtt2ass/VTTFile.rb

@@ -9,6 +9,8 @@ require_relative 'VTTLine'
 class VTTFile
     attr_accessor :lines
 
+    ##
+    # Creates a new VTTFile instance and assigns the default values of instance variables.
     def initialize(file_path)
         @title = File.basename(file_path).gsub('.vtt', '')
         @lines = []
@@ -22,6 +24,8 @@ class VTTFile
         @lines.shift
     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 +33,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vtt2ass
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Louis-Philippe Fortin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-21 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -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