captive 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf5006d6ac1443e871a8d081974beaa6eabbf72546a25e2fa7aadefd6b9c50f7
-  data.tar.gz: 0f4eadcf1a9cb07883cdf46f79ad371095339b8e2182ae842fbe0ffb1c833a47
+  metadata.gz: 79a71dcf3548d49781cc44f2d7141d53db3268b22e535ce6d3871a560b2ff416
+  data.tar.gz: b5e44c915d7c0d16e0cf24a62c053f0526f765c5f7a6aff061e2bbd2666fa848
 SHA512:
-  metadata.gz: a3e7f5db587122c189bf7253e02ed79b0e4df13039aa3689d1b0a8c9062b16308bae85d5480b2b1574fb105688274c5dc0abaf8864416a14e8886ac02b4c36f2
-  data.tar.gz: 6622b6df7e11103bea6a511b2cf53e918023955e6e6fbb1fa3cbb7d6f81373f4896cb6504754eeaf0bff717f5608f64360dc050ae1f0e750c0aa6577da4a9c85
+  metadata.gz: d407c301e9d7f617bd99fae21c3b45dfd0753a11afb1993a1be500e9f95fab1cdcc8606aef69c826c3cf7c5c981df600933773cb30c9f36f5de84dea0453d6c2
+  data.tar.gz: 36906e52e3acb139114be27ba7ffd35dd2a0f494580325b10c1fbec3f271b741da32f277ef607080e531449c9c02f6203c61df13e161f73fa0deccca99b8cb1a

data/lib/captive/base.rb

@@ -14,6 +14,14 @@ module Captive
       def from_blob(blob:)
         new(cue_list: parse(blob: blob))
       end
+
+      def from_json(json:)
+        json = JSON.parse(json) if json.is_a?(String)
+        raise InvalidJsonInput unless json.key?('cues') && json['cues'].is_a?(Array)
+
+        cues = json['cues'].map { |cue_json| Cue.from_json(json: cue_json) }
+        new(cue_list: cues)
+      end
     end
 
     def self.included(base)
@@ -21,10 +29,10 @@ module Captive
       base.include(Util)
     end
 
-    attr_accessor(:cue_list)
+    attr_accessor(:cues)
 
     def initialize(cue_list: nil)
-      @cue_list = cue_list || []
+      @cues = cue_list || []
     end
 
     def save_as(filename:)
@@ -36,7 +44,7 @@ module Captive
     def as_json(**args)
       results = {
         'version' => VERSION,
-        'cues' => @cue_list.map(&:as_json),
+        'cues' => cues.map(&:as_json),
       }
       if results.respond_to?(:as_json)
         results.as_json(**args)
@@ -83,7 +91,7 @@ module Captive
         if self.class.to_s.split('::').last == format
           self
         else
-          base_klass.const_get(format).new(cue_list: cue_list)
+          base_klass.const_get(format).new(cue_list: cues)
         end
       end
     end

data/lib/captive/cue.rb

@@ -12,18 +12,35 @@ module Captive
     # List of Text Properties
     TEXT_PROPERTIES = [ALIGNMENT, COLOR, POSITION].freeze
 
-    attr_accessor :number, :text, :properties
+    attr_accessor :text, :properties
     attr_reader :start_time, :end_time
 
     # Creates a new Cue class denoting a subtitle.
-    def initialize(text: nil, start_time: nil, end_time: nil, cue_number: nil, properties: {})
+    def initialize(text: nil, start_time: nil, end_time: nil, properties: {})
       self.text = text
       self.start_time = start_time
       self.end_time = end_time
-      self.number = cue_number
       self.properties = properties || {}
     end
 
+    def self.from_json(json:, mapping: {})
+      schema = {}
+      %i[text! start_time! end_time! properties].each do |field|
+        field_name = field.to_s.delete('!')
+        schema[field] = mapping[field_name] || mapping[field_name.to_sym] || field_name.to_sym
+      end
+      data = {}
+      schema.each do |mask, mapper|
+        key = mask[-1] == '!' ? mask.to_s[0...-1].to_sym : mask
+        if key.to_s != mask.to_s && !(json.key?(mapper.to_s) || json.key?(mapper.to_sym))
+          raise InvalidJsonInput, "Cue missing field: #{mapper}"
+        end
+
+        data[key] = json[mapper.to_s] || json[mapper.to_sym]
+      end
+      new(**data)
+    end
+
     def start_time=(time)
       set_time(:start_time, time)
     end
@@ -68,11 +85,15 @@ module Captive
     end
 
     def as_json(**args)
-      if respond_to?(:instance_values) && instance_values.respond_to?(:as_json)
-        instance_values.as_json(**args)
-      else
-        instance_variables.each_with_object({}) { |key, hash| hash[key[1..-1]] = instance_variable_get(key) }
-      end
+      options = args.delete(:options) || {}
+      format = options['format'] || {}
+      obj = {
+        'start_time' => format[:time] == :timecode ? milliseconds_to_timecode(start_time) : start_time,
+        'end_time' => format[:time] == :timecode ? milliseconds_to_timecode(end_time) : end_time,
+        'text' => text,
+        'properties' => properties,
+      }
+      obj.respond_to?(:as_json) ? obj.as_json(**args) : obj
     end
 
     private

data/lib/captive/error.rb

@@ -16,4 +16,7 @@ module Captive
   # Error denoting incorrect input to a method.
   class InvalidInput < CaptiveError
   end
+
+  class InvalidJsonInput < CaptiveError
+  end
 end

data/lib/captive/formats/srt.rb

@@ -19,13 +19,12 @@ module Captive
 
           raise InvalidSubtitle, "Invalid Cue Number at line #{count}" if /^\d+$/.match(line).nil?
 
-          cue = Cue.new(cue_number: line.to_i)
           state = :time
         when :time
           raise InvalidSubtitle, "Invalid Time Format at line #{count}" unless timecode?(line)
 
           start_time, end_time = line.split('-->').map(&:strip)
-          cue.set_times(
+          cue = Cue.new(
             start_time: format_time(start_time),
             end_time: format_time(end_time)
           )
@@ -51,8 +50,8 @@ module Captive
 
     def to_s
       string = String.new
-      @cue_list.each do |cue|
-        string << cue.number.to_s
+      cues.each_with_index do |cue, index|
+        string << (index + 1).to_s
         string << "\n"
         string << milliseconds_to_timecode(cue.start_time).gsub!('.', ',')
         string << ' --> '

data/lib/captive/formats/vtt.rb

@@ -14,7 +14,6 @@ module Captive
     def self.parse(blob:)
       cue_list = []
       lines = blob.split("\n")
-      cue_count = 1
       state = :new_cue
       cue = nil
       raise InvalidSubtitle, 'Invalid VTT Signature' unless validate_header(lines.shift)
@@ -31,14 +30,18 @@ module Captive
             next
           end
 
-          # If its not metadata, and its not an empty line, it should be a timestamp
-          raise InvalidSubtitle, "Invalid Time Format at line #{index}" unless time?(line)
+          # If its not metadata, and its not an empty line, it should be a timestamp or an identifier
+          unless time?(line)
+            # If this line is an identifier the next line should be a timecode
+            next if time?(lines[index + 1])
+
+            raise InvalidSubtitle, "Invalid Time Format at line #{index + 1}" unless time?(line)
+          end
 
           elements = line.split
           start_time = elements[0]
           end_time = elements[2]
-          cue = Cue.new(cue_number: cue_count, start_time: start_time, end_time: end_time)
-          cue_count += 1
+          cue = Cue.new(start_time: start_time, end_time: end_time)
           state = :text
         when :text
           if line.empty?
@@ -68,7 +71,7 @@ module Captive
     def to_s
       string = VTT_HEADER.dup
       string << "\n\n"
-      @cue_list.each do |cue|
+      cues.each do |cue|
         string << milliseconds_to_timecode(cue.start_time)
         string << ' --> '
         string << milliseconds_to_timecode(cue.end_time)
@@ -81,7 +84,8 @@ module Captive
 
     # VTT Header tag matcher
     def self.validate_header(line)
-      !!line.strip.match(/^#{VTT_HEADER}/)
+      # Make sure BOM does not interfere with header detection
+      !!line.force_encoding('UTF-8').delete("\xEF\xBB\xBF").strip.match(/^#{VTT_HEADER}/)
     end
 
     # VTT Metadata tag matcher

data/lib/captive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Captive
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: captive
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - mserran2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="