subconv 0.1.0 → 1.0.0

data/spec/scc/transformer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Subconv
@@ -79,15 +81,15 @@ module Subconv
       # (which may change in the future)
       # Perhaps it would be better to compare independent of the exact order of the nodes
       expect(transform_test_style(style)).to eq(single_caption_with_content(
-                                                  ColorNode.new(:magenta, [
-                                                    UnderlineNode.new([
-                                                      ItalicsNode.new([
-                                                        FlashNode.new([
-                                                          TextNode.new('Test')
-                                                        ])
-                                                      ])
-                                                    ])
-                                                  ])
+        ColorNode.new(:magenta, [
+          UnderlineNode.new([
+            ItalicsNode.new([
+              FlashNode.new([
+                TextNode.new('Test')
+              ])
+            ])
+          ])
+        ])
       ))
     end
 
@@ -106,26 +108,25 @@ module Subconv
       grid.insert_text(0, 5, 'f', style.dup)
       transformed = @transformer.transform(single_scc_caption_with_grid(grid))
       expect(transformed).to eq(single_caption_with_content(
-                                  [
-                                    TextNode.new('a'),
-                                    ItalicsNode.new([
-                                      ColorNode.new(:blue, [
-                                        FlashNode.new([
-                                          TextNode.new('b'),
-                                          UnderlineNode.new([
-                                            TextNode.new('cde')
-                                          ])
-                                        ])
-                                      ]),
-                                      ColorNode.new(:cyan, [
-                                        UnderlineNode.new([
-                                          TextNode.new('f')
-                                        ])
-                                      ])
-                                    ])
-                                  ]
-      )
-                               )
+        [
+          TextNode.new('a'),
+          ItalicsNode.new([
+            ColorNode.new(:blue, [
+              FlashNode.new([
+                TextNode.new('b'),
+                UnderlineNode.new([
+                  TextNode.new('cde')
+                ])
+              ])
+            ]),
+            ColorNode.new(:cyan, [
+              UnderlineNode.new([
+                TextNode.new('f')
+              ])
+            ])
+          ])
+        ]
+      ))
     end
 
     it 'should handle this other complicated combination of styles and text' do
@@ -143,25 +144,144 @@ module Subconv
       grid.insert_text(0, 6, 'jkl', style.dup)
       transformed = @transformer.transform(single_scc_caption_with_grid(grid))
       expect(transformed).to eq(single_caption_with_content(
-                                  [
-                                    ColorNode.new(:red, [
-                                      ItalicsNode.new([
-                                        TextNode.new('xyz'),
-                                        UnderlineNode.new([
-                                          FlashNode.new([
-                                            TextNode.new('abc')
-                                          ])
-                                        ])
-                                      ])
-                                    ]),
-                                    ColorNode.new(:yellow, [
-                                      UnderlineNode.new([
-                                        TextNode.new('jkl')
-                                      ])
-                                    ])
-                                  ]
-      )
-                               )
+        [
+          ColorNode.new(:red, [
+            ItalicsNode.new([
+              TextNode.new('xyz'),
+              UnderlineNode.new([
+                FlashNode.new([
+                  TextNode.new('abc')
+                ])
+              ])
+            ])
+          ]),
+          ColorNode.new(:yellow, [
+            UnderlineNode.new([
+              TextNode.new('jkl')
+            ])
+          ])
+        ]
+      ))
+    end
+
+    context 'when combining paint-on captions' do
+      it 'should not eat single paint-on captions' do
+        expect(@transformer.combine_paint_on_captions(grids_to_captions(:paint_on, 1 => 'Test'))).to eq(grids_to_captions(:pop_on, 1 => 'Test'))
+      end
+
+      it 'should correctly combine simple paint-on captions into one' do
+        expect(@transformer.combine_paint_on_captions(
+          grids_to_captions(:paint_on, 1 => 'Te', 2 => 'Test', 3 => 'TestTe', 4 => 'TestText')
+        )).to eq(
+          grids_to_captions(1 => 'TestText')
+        )
+      end
+
+      it 'should produce combined paint-on captions when an empty grid is encountered' do
+        expect(@transformer.combine_paint_on_captions(
+          grids_to_captions(:paint_on, 1 => 'Te', 2 => 'Test', 3 => nil)
+        )).to eq(
+          grids_to_captions(1 => 'Test', 3 => nil)
+        )
+      end
+
+      it 'should not combine paint-on captions with an empty grid' do
+        expect(@transformer.combine_paint_on_captions(
+          grids_to_captions(:paint_on, 1 => 'Te', 2 => 'Test', 3 => nil, 4 => 'Text')
+        )).to eq(
+          grids_to_captions(1 => 'Test', 3 => nil, 4 => 'Text')
+        )
+      end
+
+      it 'should not start a new caption segment when a character is replaced with an extended one' do
+        expect(@transformer.combine_paint_on_captions([
+          Scc::Caption.new(timecode: Timecode.new(1, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Te'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(2, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Të'), mode: :paint_on, char_replacement: true),
+          Scc::Caption.new(timecode: Timecode.new(3, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Tëst'), mode: :paint_on)
+        ])).to eq(
+          grids_to_captions(1 => 'Tëst')
+        )
+      end
+
+      it 'should start a new caption segment when paint-on captions disappear' do
+        expect(@transformer.combine_paint_on_captions(
+          grids_to_captions(:paint_on, 1 => 'Te', 2 => 'Test', 3 => 'Tes', 4 => 'Te', 5 => 'Text')
+        )).to eq(
+          grids_to_captions(1 => 'Test', 3 => 'Tes', 4 => 'Text')
+        )
+      end
+
+      it 'should insert a new caption when paint-on captions change' do
+        expect(@transformer.combine_paint_on_captions(
+          grids_to_captions(:paint_on, 1 => 'Te', 2 => 'Test', 5 => 'Text')
+        )).to eq(
+          grids_to_captions(1 => 'Test', 5 => 'Text')
+        )
+      end
+
+      it 'should start a new caption segment when paint-on captions change' do
+        expect(@transformer.combine_paint_on_captions(
+          grids_to_captions(:paint_on, 1 => 'Te', 2 => 'Test', 5 => 'Text', 7 => 'TextTest')
+        )).to eq(
+          grids_to_captions(1 => 'Test', 5 => 'TextTest')
+        )
+      end
+
+      it 'should flush single paint-on captions when switching to pop-on captions momentarily' do
+        expect(@transformer.combine_paint_on_captions([
+          Scc::Caption.new(timecode: Timecode.new(1, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(2, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Text'), mode: :pop_on)
+        ])).to eq(
+          grids_to_captions(1 => 'Test', 2 => 'Text')
+        )
+      end
+
+      it 'should flush combined paint-on captions when switching to pop-on captions momentarily' do
+        expect(@transformer.combine_paint_on_captions([
+          Scc::Caption.new(timecode: Timecode.new(1, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(2, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'TestText'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(3, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'asdf'), mode: :pop_on)
+        ])).to eq(
+          grids_to_captions(1 => 'TestText', 3 => 'asdf')
+        )
+      end
+
+      it 'should flush combined paint-on captions when switching to pop-on captions after an empty paint-on caption' do
+        expect(@transformer.combine_paint_on_captions([
+          Scc::Caption.new(timecode: Timecode.new(1, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(2, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'TestText'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(3, default_fps), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(4, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'asdf'), mode: :pop_on)
+        ])).to eq(
+          grids_to_captions(1 => 'TestText', 3 => nil, 4 => 'asdf')
+        )
+      end
+
+      it 'should flush combined paint-on captions when switching to pop-on captions after an empty pop-on caption' do
+        expect(@transformer.combine_paint_on_captions([
+          Scc::Caption.new(timecode: Timecode.new(1, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(2, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'TestText'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(3, default_fps), mode: :pop_on),
+          Scc::Caption.new(timecode: Timecode.new(4, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'asdf'), mode: :pop_on)
+        ])).to eq(
+          grids_to_captions(1 => 'TestText', 3 => nil, 4 => 'asdf')
+        )
+      end
+
+      it 'should handle combinations of pop-on and paint-on captions' do
+        expect(@transformer.combine_paint_on_captions([
+          Scc::Caption.new(timecode: Timecode.new(1, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test1'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(2, default_fps), mode: :pop_on),
+          Scc::Caption.new(timecode: Timecode.new(3, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test2'), mode: :pop_on),
+          Scc::Caption.new(timecode: Timecode.new(4, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test3'), mode: :pop_on),
+          Scc::Caption.new(timecode: Timecode.new(5, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test4'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(6, default_fps), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(7, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test'), mode: :paint_on),
+          Scc::Caption.new(timecode: Timecode.new(8, default_fps), grid: Scc::Grid.new.insert_text(0, 0, 'Test5'), mode: :paint_on)
+        ])).to eq(
+          grids_to_captions(1 => 'Test1', 2 => nil, 3 => 'Test2', 4 => 'Test3', 5 => 'Test4', 6 => nil, 7 => 'Test5')
+        )
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
-require 'coveralls'
-Coveralls.wear!
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov-console'
+
+SimpleCov.formatter = SimpleCov::Formatter::Console
+
+SimpleCov.start
 
 require 'subconv'
 require 'test_helpers'

data/spec/test_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Subconv
   module TestHelpers
     def default_fps
@@ -40,6 +42,22 @@ module Subconv
       [Scc::Caption.new(timecode: t1, grid: grid), Scc::Caption.new(timecode: t2)]
     end
 
+    # Convert a map of frame indices to grids to a caption array
+    # First argument is default caption type
+    def grids_to_captions(*args)
+      # Default to pop-on mode
+      mode = args.first.is_a?(Symbol) ? args.shift : :pop_on
+      grids = args.shift
+
+      grids.sort.map do |frame, grid|
+        if !grid.nil? && !grid.instance_of?(Scc::Grid)
+          # Auto-create grid from text or similar
+          grid = Scc::Grid.new.insert_text(0, 0, grid.to_s)
+        end
+        Scc::Caption.new(timecode: Timecode.new(frame, default_fps), grid: grid, mode: mode)
+      end
+    end
+
     def single_caption_with_content(content)
       # Auto-promote the content to a TextNode if necessary
       content = TextNode.new(content) if content.instance_of?(String)

data/spec/webvtt/writer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Subconv
@@ -31,16 +33,16 @@ module Subconv
         Caption.new(timespan: Utility::Timespan.new(Timecode.new(25, default_fps), Timecode.new(35, default_fps)), position: left_top, content: root_with_text('Test 3'), align: :start)
       ]
 
-      expected = header + <<"END".rstrip
-00:00:00.400 --> 00:00:00.800 align:start line:10.000% position:20.000%
-Test 1
+      expected = header + <<~"VTT".rstrip
+        00:00:00.400 --> 00:00:00.800 align:start line:10.000% position:20.000%
+        Test 1
 
-00:00:00.400 --> 00:00:00.800 align:start line:30.000% position:20.000%
-Test 2
+        00:00:00.400 --> 00:00:00.800 align:start line:30.000% position:20.000%
+        Test 2
 
-00:00:01.000 --> 00:00:01.400 align:start line:10.000% position:20.000%
-Test 3
-END
+        00:00:01.000 --> 00:00:01.400 align:start line:10.000% position:20.000%
+        Test 3
+      VTT
       expect(write(captions)).to eq(expected)
     end
 
@@ -51,13 +53,13 @@ END
         Caption.new(timespan: t2_3, position: :bottom, content: root_with_text('Test 2'), align: :middle)
       ]
 
-      expected = header + <<"END".rstrip
-00:00:00.400 --> 00:00:00.800 align:start line:5%
-Test 1
+      expected = header + <<~"VTT".rstrip
+        00:00:00.400 --> 00:00:00.800 align:start line:5%
+        Test 1
 
-00:00:00.800 --> 00:00:01.200 line:-1,end
-Test 2
-END
+        00:00:00.800 --> 00:00:01.200 line:-1,end
+        Test 2
+      VTT
       expect(write(captions)).to eq(expected)
     end
 

data/subconv.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'subconv/version'
 
@@ -8,7 +9,7 @@ Gem::Specification.new do |s|
   s.version = Subconv::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = '>= 2.0'
+  s.required_ruby_version = '>= 2.4'
   s.authors = ['Philipp Kerling']
   s.email = ['pkerling@casix.org']
   s.homepage = 'https://github.com/pkerling/subconv'
@@ -19,16 +20,15 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
 
   s.rdoc_options = ['--charset=UTF-8']
-  s.require_paths = ['lib']
 
   s.rubygems_version = '1.3.7'
   s.summary = 'Subtitle conversion (SCC to WebVTT)'
-  s.add_dependency 'solid-struct'
-  s.add_dependency 'timecode'
+  s.add_dependency 'solid-struct', '~> 0.1'
+  s.add_dependency 'timecode', '~> 2.2'
   s.add_development_dependency 'bundler', '~> 1.7'
-  s.add_development_dependency 'rspec', '~> 3.4.0'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'json'
-  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rake', '~> 12.3'
+  s.add_development_dependency 'rspec', '~> 3.8.0'
+  s.add_development_dependency 'rubocop', '~> 0.72'
+  s.add_development_dependency 'simplecov', '~> 0.17'
+  s.add_development_dependency 'simplecov-console', '~> 0.5'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: subconv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Philipp Kerling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2019-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solid-struct
   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: timecode
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,75 +53,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.72'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.72'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 description: 
 email:
 - pkerling@casix.org
@@ -131,9 +131,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -147,6 +149,7 @@ files:
 - lib/subconv/utility.rb
 - lib/subconv/version.rb
 - lib/subconv/webvtt/writer.rb
+- spec/.rubocop.yml
 - spec/caption_filter_spec.rb
 - spec/scc/reader_spec.rb
 - spec/scc/transformer_spec.rb
@@ -167,19 +170,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Subtitle conversion (SCC to WebVTT)
 test_files:
+- spec/.rubocop.yml
 - spec/caption_filter_spec.rb
 - spec/scc/reader_spec.rb
 - spec/scc/transformer_spec.rb