vtt2ass 0.3.4 → 0.3.6

data/lib/vtt2ass/ass_style.rb

@@ -1,4 +1,5 @@
-# Relative imports
+# frozen_string_literal: true
+
 require_relative 'ass_style_params'
 require_relative 'validator'
 require 'redgreenblue'
@@ -6,43 +7,46 @@ require 'redgreenblue'
 ##
 # This class defines an ASS style that can be applied on a subtitle line.
 class ASSStyle
-    attr_reader :style_name
+  attr_reader :style_name
 
-    ##
-    # This method creates and instance of an ASSStyle.
-    #
-    # * Requires +style_name+, a string name for the style as input.
-    # * Requires +params+, a string of VTT styling as input.
-    # * Requires a video +width+ as input.
-    # * Requires a video +height+ as input. 
-    def initialize(style_name, params, font_family, font_size, font_color, is_bold, is_italic, line_offset, width, height)
-        @width = width
-        @height = height
-        @font_family = font_family
-        @font_size = font_size
-        @font_color = font_color
-        @style_name = style_name
-        @s_params = ASSStyleParams.new(params, width, height)
-        if style_name.eql? 'MainTop' then
-            @s_params.vertical_margin = 50
-        end
-        if style_name.include? 'Subtitle' then
-            @s_params.vertical_margin -= line_offset
-        end
-        @is_italic = is_italic
-        @is_bold = is_bold
-    end
+  ##
+  # This method creates and instance of an ASSStyle.
+  #
+  # * Requires +style_name+, a string name for the style as input.
+  # * Requires +params+, a string of VTT styling as input.
+  # * Requires a video +width+ as input.
+  # * Requires a video +height+ as input.
+  def initialize(style_name, params, font_family, font_size, font_color, is_bold, is_italic, offset, width, height)
+    @width = width
+    @height = height
+    @font_family = font_family
+    @font_size = font_size
+    @font_color = font_color
+    @style_name = style_name
+    @s_params = ASSStyleParams.new(params, width, height)
+    @s_params.vertical_margin = 50 if style_name.eql? 'MainTop'
+    @s_params.vertical_margin -= offset[:line] if style_name.include?('Subtitle') || style_name.eql?('Main')
+    @s_params.vertical_margin += offset[:caption] if style_name.include?('Caption') || style_name.eql?('MainTop')
+    @is_italic = is_italic
+    @is_bold = is_bold
+  end
 
-    ##
-    # This method assigns the object values to an ASS style line and outputs it.
-    def to_s
-        # Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
-        return "Style: #{@style_name},#{@font_family},#{@font_size},#{@font_color},&H000000FF,&H00020713,&H00000000,#{@is_bold ? '-1' : '0'},#{@is_italic ? '-1' : '0'},0,0,100,100,0,0,1,2.0,2.0,#{@s_params.alignment},#{@s_params.horizontal_margin},0,#{@s_params.vertical_margin},1"
-    end
+  ##
+  # This method assigns the object values to an ASS style line and outputs it.
+  def to_s
+    # Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour,
+    # Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment,
+    # MarginL, MarginR, MarginV, Encoding
+    "Style: #{@style_name},#{@font_family},#{@font_size},#{@font_color},&H000000FF,&H00020713,&H00000000,"\
+      "#{@is_bold ? '-1' : '0'},#{@is_italic ? '-1' : '0'},0,0,100,100,0,0,1,2.0,2.0,#{@s_params.alignment},"\
+      "#{@s_params.horizontal_margin},0,#{@s_params.vertical_margin},1"
+  end
 
-    def self.convert_color(color_value)
-        color_value.gsub!('#', '')
-        color = Validator.hex?(color_value) ? RGB.hex(color_value) : RGB.css(color_value)
-        return ("&H00%02x%02x%02x" % [color.b, color.g, color.r]).upcase
-    end
-end
+  ##
+  # This method returns a ASS formated color value based on hex or color name value
+  def self.convert_color(color_value)
+    color_value.gsub!('#', '')
+    color = Validator.hex?(color_value) ? RGB.hex(color_value) : RGB.css(color_value)
+    format('&H00%<blue>02x%<green>02x%<red>02x', blue: color.b, green: color.g, red: color.r).upcase
+  end
+end

data/lib/vtt2ass/ass_style_params.rb

@@ -1,87 +1,109 @@
+# frozen_string_literal: true
+
 ##
 # This class defines the ASS style parameters from VTT cue settings.
 class ASSStyleParams
-    attr_accessor :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]
-            when 'position'
-                @position = p[1].gsub(/%/, '').to_i
-            when 'line'
-                @line = p[1].gsub(/%/, '').to_i
-                @line = @line == -1 ? 100 : @line;
-            when 'align'
-                @align = p[1].chomp
-            end
-        end
-        create_alignment()
-        create_horizontal_margin(width)
-        create_vertical_margin(height)
+  ##
+  # 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)
+    @align = nil
+    split_params(params)
+    create_alignment
+    create_horizontal_margin(width)
+    create_vertical_margin(height)
+  end
+
+  def split_params(params)
+    (params.split.map { |p| p.split(':') }).each do |p|
+      case p[0]
+      when 'position'
+        @position = p[1].gsub(/%/, '').to_i
+      when 'line'
+        @line = p[1].gsub(/%/, '').to_i
+        @line = @line == -1 ? 100 : @line
+      when 'align'
+        @align = p[1].chomp
+      end
     end
+  end
 
-    ##
-    # This method decides the alignement value in a 9 position grid based of the
-    # values in cue settings "align" and "line".
-    def create_alignment()
-        if (defined?(@line) and not defined?(@position)) then
-            if (defined?(@align)) then
-                case @align
-                when 'left', 'start'
-                    @alignment = @line >= 50 ? 1 : 7
-                when 'right', 'end'
-                    @alignment = @line >= 50 ? 3 : 9
-                when 'center', 'middle'
-                    @alignment = @line >= 50 ? 2 : 8
-                end
-            else
-                @alignment = @line >= 50 ? 2 : 8 # If position is higher than 50% align to bottom center, else align to top center
-            end
-        elsif (defined?(@line) and defined?(@position)) then
-            @alignment = 1
-        else
-            case @align
-            when 'left', 'start'
-                @alignment = 1
-            when 'right', 'end'
-                @alignment = 3
-            when 'center', 'middle'
-                @alignment = 2
-            else
-                @alignment = 2
-            end
-        end
+  ##
+  # This method decides the alignement value in a 9 position grid based of the
+  # values in cue settings "align" and "line".
+  def create_alignment
+    @alignment =
+      if defined?(@line) && !defined?(@position)
+        find_alignment(@align)
+      elsif defined?(@line) && defined?(@position)
+        1 # bottom left
+      else
+        find_default_alignment(@align)
+      end
+  end
+
+  ##
+  # This method returns alignment when "line" value is specified but not "position"
+  def find_alignment(align)
+    if align.nil?
+      # If position is higher than 50% align to bottom center, else align to top center
+      @line >= 50 ? 2 : 8
+    else
+      case align
+      when 'left', 'start'
+        @line >= 50 ? 1 : 7
+      when 'right', 'end'
+        @line >= 50 ? 3 : 9
+      when 'center', 'middle'
+        @line >= 50 ? 2 : 8
+      end
     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 create_horizontal_margin(width)
-        steps = (width / 100).to_i
-        if defined?(@position) then
-            @horizontal_margin = @position * steps
-        else
-            @horizontal_margin = 0
-        end
+  ##
+  # This method returns alignment when "line" and "position" values are not specified
+  def find_default_alignment(align)
+    case align
+    when 'left', 'start'
+      1
+    when 'right', 'end'
+      3
+    # when 'center', 'middle'
+    else
+      2
     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 create_vertical_margin(height)
-        steps = (height / 100).to_i
-        if defined?(@line) then
-            if (@alignment == 1) then
-                @vertical_margin = (100 - @line) * steps
-            else
-                @vertical_margin = @line >= 50 ? (100 - @line) * steps : @line * steps
-            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 create_horizontal_margin(width)
+    steps = (width / 100).to_i
+    @horizontal_margin =
+      if defined?(@position)
+        @position * steps
+      else
+        0
+      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 create_vertical_margin(height)
+    steps = (height / 100).to_i
+    @vertical_margin =
+      if defined?(@line)
+        if @alignment == 1
+          (100 - @line) * steps
         else
-            @vertical_margin = 50
+          @line >= 50 ? (100 - @line) * steps : @line * steps
         end
-    end
-end
+      else
+        50
+      end
+  end
+end

data/lib/vtt2ass/css_file.rb

@@ -1,36 +1,38 @@
+# frozen_string_literal: true
+
 require 'css_parser'
 require_relative 'css_rule'
 
+##
+# This class defines a CSS file for subtitles.
 class CSSFile
-    attr_reader :rules
-    include CssParser
+  attr_reader :rules
 
-    def initialize(file_path)
-        @file_path = file_path
-        parser = CssParser::Parser.new
-        parser.load_file!(file_path)
-        @rules = []
-        parser.each_selector do |selector, declarations, specificity|
-            css_obj = CSSRule.new(selector, declarations)
-            if not css_obj.name.empty? then
-                @rules.push(css_obj)
-            end
-        end
-    end
+  include CssParser
 
-    def find_rule(value)
-        return_rule = nil
-        @rules.each do |rule|
-            if rule.name == value then
-                return_rule = rule
-                break
-            end
-        end
-        return return_rule
+  def initialize(file_path)
+    @file_path = file_path
+    parser = CssParser::Parser.new
+    parser.load_file!(file_path)
+    @rules = []
+    parser.each_selector do |selector, declarations, _specificity|
+      css_obj = CSSRule.new(selector, declarations)
+      @rules.push(css_obj) unless css_obj.name.empty?
     end
+  end
 
-    def to_s
-        return @file_path
+  def find_rule(value)
+    return_rule = nil
+    @rules.each do |rule|
+      if rule.name == value
+        return_rule = rule
+        break
+      end
     end
+    return_rule
+  end
 
-end
+  def to_s
+    @file_path
+  end
+end

data/lib/vtt2ass/css_rule.rb

@@ -1,22 +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
+  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
+  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
-        return "#{@name} #{@properties}"
-    end
+  def to_s
+    "#{@name} #{@properties}"
+  end
 
-    def reduce_selector(selector)
-        return selector.to_s.gsub(/\.rmp-container>\.rmp-content>\.rmp-cc-area>\.rmp-cc-container>\.rmp-cc-display>\.rmp-cc-cue\s?\.?/, '')
-    end
-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

@@ -1,10 +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
-        return hex
+  def self.hex?(value)
+    hex = true
+    value.gsub!('#', '')
+    value.chars.each do |digit|
+      hex = false unless digit.match(/\h/)
     end
-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.4"
+  VERSION = '0.3.6'
 end

data/lib/vtt2ass/vtt_file.rb

@@ -1,58 +1,58 @@
-# Relative imports
+# frozen_string_literal: true
+
 require_relative 'vtt_line'
 
 ##
 # This class defines a VTT subtile file.
 class VTTFile
-    attr_accessor :lines
+  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")
-            if not paragraph.eql? "" then
-                vtt_line = VTTLine.new(paragraph, width, height)
-                if vtt_line.style.eql? 'Main' and
-                    not vtt_line.params.to_s.empty? and
-                    (not vtt_line.params.to_s.eql? 'align:middle' and
-                    not vtt_line.params.to_s.eql? 'align:center') then
-                    vtt_line.style = "Style#{style_count}"
-                    style_count += 1
-                end
-                @lines.push(vtt_line)
-                count += 1
-            end
+  ##
+  # 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.shift
+        @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 self.to_s
-        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 concatenates the object data in the right order for a string output.
-    def to_s
-        return "WEBVTT\n\n\n" + @lines 
+  ##
+  # 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
 
-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

@@ -1,44 +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
+  attr_accessor :style
+  attr_reader :time_start, :time_end, :params, :text
 
-        lines.each do |line|
-            m = line.match(rx)
-            if not m and count == 0 then
-                @style = line
-            elsif m then
-                @time_start = m[1]
-                @time_end = m[2]
-                @params = m[3]
-                ass_style = ASSStyleParams.new(@params, width, height)
-                if @style.eql? 'Main' and ass_style.alignment == 8 then
-                    @style = 'MainTop'
-                end
-            else
-                @text += line + "\n"
-            end
-            count += 1;
-        end
+  ##
+  # 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
 
-        @text = @text.lstrip
+    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
 
-    ##
-    # This method assigns the object values and outputs a VTT dialogue line.
-    def to_s
-        return "#{@style} \n#{@time_start} --> #{@time_end} #{@params}\n#{@text}"
-    end
-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