captions 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc2fd7159d9f46c3251b271226828af0370c6c72
-  data.tar.gz: b87491508efc86cc0b403d76ce98aebaf91aaa2f
+  metadata.gz: aabb7f8d8e05f0bdd97f11c7d3d6ad2272daa4a8
+  data.tar.gz: 2487803e670a82b5280cbe710d8b1f53aeb7ad7d
 SHA512:
-  metadata.gz: 6cd1fa878ad14fa718323d7191da8cb82f44b99feb15aa67987fdb55a8d25136fe2d4bf1a316109011bfec7b4260ce28906e1c2129f667d7e3ff8f5eb093325f
-  data.tar.gz: e4e09a6c34efcfe00892c956decd8c803b786f7afde0f0764c23976d01826871b47d82fe540cfee44181ebb93cacb66cb5bdca91aa8fa83adb8e949ee708986c
+  metadata.gz: 247cbaedb31a2c5afc6d987b9521a62ef11e7c40460d1a5831093e00f1308ef682e86ee68832695110f85452dd3365fbdf3ea1d76219147b18838b0dd8812d22
+  data.tar.gz: ad8c0e97e9fb83e97facabfd17058427368672aa5ac2aa79f9f3b5908b5cf2c9e1e23c9a84c5e2ac8e3369e4e527144c6ab557e82126f15eb5cca828657cbe59

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "captions"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "captions"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/captions.gemspec

@@ -1,27 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'captions/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "captions"
-  spec.version       = Captions::VERSION
-  spec.authors       = ["navin"]
-  spec.email         = ["navin@amagi.com"]
-
-  spec.summary       = %q{Subtitle Editor and Converter written in Ruby}
-  spec.description   = %q{Subtitle Editor and Converter written in Ruby. Captions can read/modify/export subtitles from one format to another }
-  spec.homepage      = "https://github.com/navinre/captions"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'captions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "captions"
+  spec.version       = Captions::VERSION
+  spec.authors       = ["navin"]
+  spec.email         = ["navin@amagi.com"]
+
+  spec.summary       = %q{Subtitle Editor and Converter written in Ruby}
+  spec.description   = %q{Subtitle Editor and Converter written in Ruby. Captions can read/modify/export subtitles from one format to another }
+  spec.homepage      = "https://github.com/navinre/captions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/captions/base.rb

@@ -170,9 +170,9 @@ module Captions
     # block is passed, it returns the entire cuelist.
     def fetch_result(&block)
       if block_given?
-        @cue_list.select(&block)
+        return @cue_list.select(&block)
       else
-        @cue_list
+        return @cue_list
       end
     end
   end

data/lib/captions/cue.rb

@@ -1,66 +1,93 @@
-module Captions
-  class Cue
-    include Util
-
-    attr_accessor :number, :start_time, :end_time, :duration, :text, :property
-
-    # Creates a new Cue class
-    # Each cue denotes a subtitle.
-    def initialize
-      self.text = nil
-      self.start_time = nil
-      self.end_time = nil
-      self.duration = nil
-      self.number = nil
-      self.property = {}
-    end
-
-    # Sets the time for the cue. Both start-time and
-    # end-time can be passed together. This just assigns
-    # the value passed.
-    def set_time(start_time, end_time, duration = nil)
-      self.start_time = start_time
-      self.end_time = end_time
-      self.duration = duration
-    end
-
-    # Serializes the values set for the cue.
-    # Converts start-time, end-time and duration to milliseconds
-    # If duration is not found, it will be calculated based on
-    # start-time and end-time.
-    def serialize(fps)
-      raise InvalidSubtitle, "Subtitle should have start time" if self.start_time.nil?
-      raise InvalidSubtitle, "Subtitle shold have end time" if self.end_time.nil?
-
-      begin
-        ms_per_frame = (1000.0 / fps)
-        self.start_time = convert_to_msec(self.start_time, ms_per_frame)
-        self.end_time = convert_to_msec(self.end_time, ms_per_frame)
-        if duration.nil?
-          self.duration = self.end_time - self.start_time
-        else
-          self.duration = convert_to_msec(self.duration, ms_per_frame)
-        end
-      rescue
-        raise InvalidSubtitle, "Cannot calculate start-time or end-time"
-      end
-    end
-
-    # Changes start-time, end-time and duration based on new frame-rate
-    def change_frame_rate(old_rate, new_rate)
-      self.start_time = convert_frame_rate(self.start_time, old_rate, new_rate)
-      self.end_time = convert_frame_rate(self.end_time, old_rate, new_rate)
-      self.duration = convert_frame_rate(self.duration, old_rate, new_rate)
-    end
-
-    # Adds text. If text is already found, new-line is appended.
-    def add_text(text)
-      if self.text.nil?
-        self.text = text
-      else
-        self.text += "\n" + text
-      end
-    end
-
-  end
-end
+module Captions
+  class Cue
+    include Util
+
+    # Text Properties supported
+    ALIGNMENT    = "alignment"
+    COLOR        = "color"
+    POSITION     = "position"
+
+    # List of Text Properties
+    TEXT_PROPERTIES = [ALIGNMENT, COLOR, POSITION]
+
+    attr_accessor :number, :start_time, :end_time, :duration, :text, :properties
+
+    # Creates a new Cue class
+    # Each cue denotes a subtitle.
+    def initialize
+      self.text = nil
+      self.start_time = nil
+      self.end_time = nil
+      self.duration = nil
+      self.number = nil
+      self.properties = {}
+    end
+
+    # Sets the time for the cue. Both start-time and
+    # end-time can be passed together. This just assigns
+    # the value passed.
+    def set_time(start_time, end_time, duration = nil)
+      self.start_time = start_time
+      self.end_time = end_time
+      self.duration = duration
+    end
+
+    # Getter and Setter methods for Text Properties
+    # These are pre-defined properties. This is just to assign
+    # or access the properties of that text.
+    TEXT_PROPERTIES.each do |setting|
+      define_method :"#{setting}" do
+        if self.properties[setting].present?
+          return self.properties[setting]
+        end
+        return nil
+      end
+
+      define_method :"#{setting}=" do |value|
+        self.properties[setting] = value
+      end
+    end
+
+    # Serializes the values set for the cue.
+    # Converts start-time, end-time and duration to milliseconds
+    # If duration is not found, it will be calculated based on
+    # start-time and end-time.
+    def serialize(fps)
+      raise InvalidSubtitle, "Subtitle should have start time" if self.start_time.nil?
+      raise InvalidSubtitle, "Subtitle shold have end time" if self.end_time.nil?
+
+      begin
+        ms_per_frame = (1000.0 / fps)
+        self.start_time = convert_to_msec(self.start_time, ms_per_frame)
+        self.end_time = convert_to_msec(self.end_time, ms_per_frame)
+        if duration.nil?
+          self.duration = self.end_time - self.start_time
+        else
+          self.duration = convert_to_msec(self.duration, ms_per_frame)
+        end
+      rescue
+        raise InvalidSubtitle, "Cannot calculate start-time or end-time"
+      end
+    end
+
+    # Changes start-time, end-time and duration based on new frame-rate
+    def change_frame_rate(old_rate, new_rate)
+      self.start_time = convert_frame_rate(self.start_time, old_rate, new_rate)
+      self.end_time = convert_frame_rate(self.end_time, old_rate, new_rate)
+      self.duration = convert_frame_rate(self.duration, old_rate, new_rate)
+    end
+
+    # Adds text. If text is already found, new-line is appended.
+    def add_text(text)
+      if self.text.nil?
+        self.text = text
+      else
+        self.text += "\n" + text
+      end
+    end
+
+    def <=>(other_cue)
+      self.start_time <=> other_cue.start_time
+    end
+  end
+end

data/lib/captions/formats/vtt.rb

@@ -1,75 +1,121 @@
-module Captions
-  class VTT < Base
-
-    # Header used for all VTT files
-    VTT_HEADER = "WEBVTT"
-
-    # VTT file comments/style section
-    VTT_METADATA = /^NOTE|^STYLE/
-
-    # Parse VTT file and update CueList
-    def parse
-      base_parser do
-        count = 1
-        cue_count = 0
-        meta_data_section = false
-        cue = nil
-        raise InvalidSubtitle, "Invalid VTT Signature" unless validate_header(@file.gets)
-        while(line = @file.gets) do
-          line = line.strip
-          if line.empty?
-            meta_data_section = false
-          elsif is_meta_data?(line)
-            meta_data_section = true
-          elsif is_time?(line)
-            @cue_list.append(cue) if cue
-            cue_count += 1
-            cue = Cue.new
-            cue.number = cue_count
-            line = line.split
-            cue.set_time(line[0], line[2])
-          elsif !meta_data_section and is_text?(line)
-            cue.add_text(line)
-          end
-        end
-        @cue_list.append(cue) if cue
-      end
-    end
-
-    # Export CueList to VTT file
-    def dump(file)
-      base_dump(file) do |file|
-        file.write(VTT_HEADER)
-        @cue_list.each do |cue|
-          file.write("\n\n")
-          file.write(msec_to_timecode(cue.start_time))
-          file.write(" --> ")
-          file.write(msec_to_timecode(cue.end_time))
-          file.write("\n")
-          file.write(cue.text)
-        end
-      end
-    end
-
-    # Check whether its a VTT_HEADER or not
-    def validate_header(line)
-      !!line.strip.match(/^#{VTT_HEADER}/)
-    end
-
-    # Check whether its a meta-data or not
-    def is_meta_data?(text)
-      !!text.match(VTT_METADATA)
-    end
-
-    # Timecode format used in VTT file
-    def is_time?(text)
-      !!text.match(/^(\d{2}:)?\d{2}:\d{2}.\d{3}.*(\d{2}:)?\d{2}:\d{2}.\d{3}/)
-    end
-
-    # Check whether if its subtilte text or not
-    def is_text?(text)
-      !text.empty? and text.is_a?(String) and text != VTT_HEADER
-    end
-
-  end
-end
+module Captions
+  class VTT < Base
+
+    # Header used for all VTT files
+    VTT_HEADER = "WEBVTT"
+
+    # VTT file comments/style section
+    VTT_METADATA = /^NOTE|^STYLE/
+
+    # Auto Keyword used in Alignment
+    AUTO_KEYWORD = "auto"
+
+    # Alignment Data
+    ALIGNMENT_VALUES = {
+      "middle" => "middle",
+      "left"   => "left",
+      "right"  => "right",
+      "start"  => "start",
+      "end"    => "end",
+    }
+
+    # Parse VTT file and update CueList
+    def parse
+      base_parser do
+        count = 1
+        cue_count = 0
+        meta_data_section = false
+        cue = nil
+        raise InvalidSubtitle, "Invalid VTT Signature" unless validate_header(@file.gets)
+        while(line = @file.gets) do
+          line = line.strip
+          if line.empty?
+            meta_data_section = false
+          elsif is_meta_data?(line)
+            meta_data_section = true
+          elsif is_time?(line)
+            @cue_list.append(cue) if cue
+            cue_count += 1
+            cue = Cue.new
+            cue.number = cue_count
+            line = line.split
+            cue.set_time(line[0], line[2])
+            set_properties(cue, line[3..-1])
+          elsif !meta_data_section and is_text?(line)
+            cue.add_text(line)
+          end
+        end
+        @cue_list.append(cue) if cue
+      end
+    end
+
+    # Export CueList to VTT file
+    def dump(file)
+      base_dump(file) do |file|
+        file.write(VTT_HEADER)
+        @cue_list.each do |cue|
+          file.write("\n\n")
+          file.write(msec_to_timecode(cue.start_time))
+          file.write(" --> ")
+          file.write(msec_to_timecode(cue.end_time))
+          file.write("\n")
+          file.write(cue.text)
+        end
+      end
+    end
+
+    # Check whether its a VTT_HEADER or not
+    def validate_header(line)
+      !!line.strip.match(/^#{VTT_HEADER}/)
+    end
+
+    # Check whether its a meta-data or not
+    def is_meta_data?(text)
+      !!text.match(VTT_METADATA)
+    end
+
+    # Timecode format used in VTT file
+    def is_time?(text)
+      !!text.match(/^(\d{2}:)?\d{2}:\d{2}.\d{3}.*(\d{2}:)?\d{2}:\d{2}.\d{3}/)
+    end
+
+    # Check whether if its subtilte text or not
+    def is_text?(text)
+      !text.empty? and text.is_a?(String) and text != VTT_HEADER
+    end
+
+    def set_properties(cue, properties)
+      properties.each do |prop|
+        prop, value = prop.split(":")
+        value.gsub!("%","")
+        case prop
+        when "align"
+          cue.alignment = get_alignment(value)
+        when "line"
+          value = value.split(",")[0]
+          cue.position = get_line(value)
+        end
+      end
+    end
+
+    def get_alignment(value)
+      raise InvalidSubtitle, "Invalid VTT Alignment Property" unless ALIGNMENT_VALUES[value]
+      return ALIGNMENT_VALUES[value]
+    end
+
+    def get_line(value)
+      raise InvalidSubtitle, "VTT Line property should be a valid number" if !is_integer?(value) and value != AUTO_KEYWORD
+      return value.to_i
+    end
+
+    def get_position(value)
+      raise InvalidSubtitle, "VTT Position should be a valid number" if !is_integer?(value)
+      raise InvalidSubtitle, "VTT Position should be a number between 0 to 100" if (value.to_i < 0) or (value.to_i > 100)
+      return value.to_i
+    end
+
+    def is_integer?(val)
+      val.to_i.to_s == val
+    end
+  end
+end

data/lib/captions/list.rb

@@ -13,6 +13,11 @@ module Captions
       @fps
     end
 
+    # Returns the parsed subtitles
+    def entries
+      @list
+    end
+
     # Hide all cues when inspecting CueList
     # Show only necessary info rather than printing everything
     def inspect
@@ -36,7 +41,13 @@ module Captions
 
     # Iterate through CueList
     def each
+      return to_enum(:each) unless block_given?
       @list.each { |c| yield(c) }
     end
+
+    # Array based enumerables for cuelist
+    def [](index)
+      @list[index]
+    end
   end
 end

data/lib/captions/version.rb

@@ -1,3 +1,3 @@
 module Captions
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: captions
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - navin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-21 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec