subconv 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'subconv'
+require 'test_helpers'

data/spec/test_helpers.rb

@@ -0,0 +1,73 @@
+module Subconv
+  module TestHelpers
+    def default_fps
+      25
+    end
+
+    def t1
+      Timecode.new(10, default_fps)
+    end
+
+    def t2
+      Timecode.new(20, default_fps)
+    end
+
+    def t3
+      Timecode.new(30, default_fps)
+    end
+
+    def t1_2
+      Utility::Timespan.new(t1, t2)
+    end
+
+    def t2_3
+      Utility::Timespan.new(t2, t3)
+    end
+
+    def test_grid
+      Scc::Grid.new.insert_text(0, 0, 'Test')
+    end
+
+    def test_content
+      RootNode.new([TextNode.new('Test')])
+    end
+
+    def left_top
+      Position.new(0.2, 0.1)
+    end
+
+    def single_scc_caption_with_grid(grid)
+      [Scc::Caption.new(timecode: t1, grid: grid), Scc::Caption.new(timecode: t2)]
+    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)
+      # Auto-promote the content to an array if necessary
+      content = [content] unless content.instance_of?(Array)
+      [Caption.new(timespan: t1_2, position: left_top, content: RootNode.new(content), align: :start)]
+    end
+
+    def root_with_text(text)
+      RootNode.new([TextNode.new(text)])
+    end
+
+    def caption_all_node_types
+      single_caption_with_content(
+        [
+          ColorNode.new(:blue, [TextNode.new('1')]),
+          FlashNode.new([TextNode.new('2')]),
+          ItalicsNode.new([TextNode.new('3')]),
+          UnderlineNode.new([TextNode.new('4')])
+        ]
+      )
+    end
+
+    def caption_filter_process(options)
+      original = yield
+      processed = yield
+      CaptionFilter.new(options).process!(processed)
+      [original, processed]
+    end
+  end
+end

data/spec/webvtt/writer_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+module Subconv
+  describe WebVtt::Writer do
+    include TestHelpers
+    include Subconv
+
+    let(:header) { "WEBVTT\n\n" }
+    # Header including one cue from t1 to t2 at top left
+    let(:cue_header) { header + "00:00:00.400 --> 00:00:00.800 align:start line:10.000% position:20.000%\n" }
+
+    before(:each) do
+      @writer = WebVtt::Writer.new
+    end
+
+    def write(captions)
+      stringio = StringIO.new
+      @writer.write(stringio, captions)
+      # Strip whitespace from the end of the string since it doesn't particularly matter
+      stringio.string.rstrip
+    end
+
+    it 'should write out a single caption' do
+      expect(write(single_caption_with_content('Test'))).to eq(cue_header + 'Test')
+    end
+
+    it 'should write out multiple captions' do
+      captions = [
+        Caption.new(timespan: t1_2, position: left_top, content: root_with_text('Test 1'), align: :start),
+        Caption.new(timespan: t1_2, position: Position.new(0.2, 0.3), content: root_with_text('Test 2'), align: :start),
+        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
+
+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
+      expect(write(captions)).to eq(expected)
+    end
+
+    it 'support simple positioning and alignment' do
+      captions = [
+        Caption.new(timespan: t1_2, position: :top, content: root_with_text('Test 1'), align: :start),
+        # align:middle should not be output as it is the default
+        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
+
+00:00:00.800 --> 00:00:01.200 line:-1,end
+Test 2
+END
+      expect(write(captions)).to eq(expected)
+    end
+
+    it 'should support italics' do
+      expect(write(single_caption_with_content(ItalicsNode.new([TextNode.new('Test')])))).to eq(cue_header + '<i>Test</i>')
+    end
+
+    it 'should support underline' do
+      expect(write(single_caption_with_content(UnderlineNode.new([TextNode.new('Test')])))).to eq(cue_header + '<u>Test</u>')
+    end
+
+    it 'should support flash' do
+      expect(write(single_caption_with_content(FlashNode.new([TextNode.new('Test')])))).to eq(cue_header + '<c.blink>Test</c>')
+    end
+
+    it 'should support colors' do
+      expect(write(single_caption_with_content(ColorNode.new(:magenta, [TextNode.new('Test')])))).to eq(cue_header + '<c.magenta>Test</c>')
+    end
+
+    it 'should escape special characters' do
+      expect(write(single_caption_with_content('<i>&Test</i>'))).to eq(cue_header + '&lt;i&rt;&amp;Test&lt;/i&rt;')
+    end
+
+    it 'should support complicated combinations of styles' do
+      nodes = [
+        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')
+            ])
+          ])
+        ])
+      ]
+      expect(write(single_caption_with_content(nodes))).to eq(cue_header + 'a<i><c.blue><c.blink>b<u>cde</u></c></c><c.cyan><u>f</u></c></i>')
+    end
+  end
+end

data/subconv.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subconv/version'
+
+Gem::Specification.new do |s|
+  s.name = 'subconv'
+  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.authors = ['Philipp Kerling']
+  s.email = ['pkerling@casix.org']
+  s.homepage = 'https://github.com/pkerling/subconv'
+  s.files = `git ls-files -z`.split("\x0").reject { |elem| elem =~ %r{^scc-data/} }
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  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_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'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: subconv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philipp Kerling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-26 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- pkerling@casix.org
+executables:
+- subconv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/subconv
+- dist/eia608.css
+- lib/subconv.rb
+- lib/subconv/caption.rb
+- lib/subconv/caption_filter.rb
+- lib/subconv/scc/reader.rb
+- lib/subconv/scc/transformer.rb
+- lib/subconv/utility.rb
+- lib/subconv/version.rb
+- lib/subconv/webvtt/writer.rb
+- spec/caption_filter_spec.rb
+- spec/scc/reader_spec.rb
+- spec/scc/transformer_spec.rb
+- spec/spec_helper.rb
+- spec/test_helpers.rb
+- spec/webvtt/writer_spec.rb
+- subconv.gemspec
+homepage: https://github.com/pkerling/subconv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Subtitle conversion (SCC to WebVTT)
+test_files:
+- spec/caption_filter_spec.rb
+- spec/scc/reader_spec.rb
+- spec/scc/transformer_spec.rb
+- spec/spec_helper.rb
+- spec/test_helpers.rb
+- spec/webvtt/writer_spec.rb