vtt2an 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d4e6633e56935f6c5f212ceb604a0cc0841b95e
+  data.tar.gz: 979fa966902bb0bed9da8e5e8e133fc121e0b928
+SHA512:
+  metadata.gz: a5b446814967b4070b1bff0360322e5b8b0d4daef210e1bcf3cb3ae1a74a3d81fddc008d61991c4e8535f65a4f4b6439049af7fcc0c75827f218db2e80c7d765
+  data.tar.gz: 0fb9a3e3eeac3ca07af6ebaf6bc72e58ce7ee5457947ce061be75370e5bf6432d2a32d67c3bcb26ed517bb9a7b96c658b42942b734e9ad320b40b9cd9ca328b3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.12.5
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Lm+6OZVuwMjtu3n1XiluIlvgLjgN1itJ59JVLoBC+XsMkUXPzYVi5XJA1SGp1RMtYoHauOsii5Mp3zJux828sUc/BulBB5OYqmYVA3+mFSsYH8yQnSDbBosbea4bgpnThBGk4l5kjbfk+yw+u8Z4YP2FOYLJgoDzYqKtSDSIE8D2rtRK96yp95oWCeN0XZE/5P8QrvEC6reEtdCPzybPfwP4jk3SGdYzxWF6CCS5Bv0CKihhfCVo+8eE9KQgO0mvlo5fdlFvLc5/xv9obrlJ5YSbEw9ujf1Nx+YFFWa+jfnWHLN7q0ubpGyu8wyM8Foo+BuQohP4ID18GdbZkm6Yf47Zz2nJP9cZY1DxFMIxXqClX1vURy4+DFHhsbG7n57FHjt/qAMOgCQrYfsBxRFHsfc9YyTHbcBiR7F3lTwXLZhnJYXNx/sgZQ+HpDKISXzDtyrRxzf2QBHCKJ2BCit0UDRLYUfO+Iz9+lDuXi3OIEBLHicuLiQAuyUGwuJtFqG3JgQg0qiWBl0ExonfNqkh9vOqroxNdmOXtTQszxBCLYlCWSslhGDybRsW3mEywF4LNFUsRGAO1dKnSOGMQWl4iHCqKD9rIy3+dNERhYQ/HtKrEIkQdH1T6ILSiERkDEJU++4yU8HFJAQ9UqXjfcChTzDqLViQkSlPF/gl7ngToOU=
+  gem: vtt2an
+  on:
+    tags: true
+    repo: Floppy/vtt2an

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at james@floppy.org.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 James Smith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# vtt2an
+
+[![Build Status](http://img.shields.io/travis/Floppy/vtt2an.svg?style=flat-square)](https://travis-ci.org/Floppy/vtt2an)
+[![Dependency Status](http://img.shields.io/gemnasium/github.com/Floppy/vtt2an.svg?style=flat-square)](https://gemnasium.com/github.com/Floppy/vtt2an)
+[![Coverage Status](http://img.shields.io/coveralls/Floppy/vtt2an.svg?style=flat-square)](https://coveralls.io/r/Floppy/vtt2an)
+[![Code Climate](http://img.shields.io/codeclimate/github/Floppy/vtt2an.svg?style=flat-square)](https://codeclimate.com/github/Floppy/vtt2an)
+[![Gem Version](http://img.shields.io/gem/v/vtt2an.svg?style=flat-square)](https://rubygems.org/gems/vtt2an)
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://Floppy.mit-license.org)
+
+Convert WebVTT subtitles files into Akoma Ntoso transcripts.
+
+## Installation
+
+Ruby 2.3.1 recommended, then:
+
+`gem install vtt2an`
+
+or add to your Gemfile:
+
+`gem "vtt2an"`
+
+and then
+
+`bundle`
+
+## Usage
+
+### Ruby
+
+Load a WebVTT file using [webvtt-ruby](https://github.com/opencoconut/webvtt-ruby), then convert it using `Vtt2An::Converter` to a `REXML::Document` in Akoma Ntoso format:
+
+```
+webvtt = WebVTT.read "in.wtt"
+converter = Vtt2An::Converter.new webvtt
+output = converter.convert
+File.open("out.an", "w") do |f|
+  output.write f
+end
+```
+
+### Command line
+
+If you just want to convert files, you can use the handy command-line tool:
+
+`bundle exec exe/vtt2an.rb /path/to/file.vtt /path/to/output.an`

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/exe/vtt2an.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vtt2an'
+
+# Read the subtitle file
+webvtt = WebVTT.read(ARGV[0])
+# Convert
+converter = Vtt2An::Converter.new(webvtt)
+output = converter.convert
+# Write output to file
+File.open(ARGV[1], "w") do |f|
+  output.write(f, 1)
+end

data/lib/vtt2an.rb

@@ -0,0 +1,9 @@
+require "webvtt"
+
+# Monkeypatch WebVTT
+# We'll push this upstream at some point
+require "vtt2an/webvtt/file"
+require "vtt2an/webvtt/cue"
+
+# require vtt2an files
+require "vtt2an/converter"

data/lib/vtt2an/converter.rb

@@ -0,0 +1,48 @@
+require 'active_support/inflector'
+require 'rexml/document'
+
+module Vtt2An
+
+  class Converter
+    
+    attr_accessor :webvtt
+    
+    def initialize(webvtt)
+      @webvtt = webvtt
+    end
+    
+    def convert
+      
+      output = REXML::Document.new
+      an = output.add_element("akomaNtoso")
+      debate = an.add_element("debate")
+      meta = debate.add_element("meta")
+      references = meta.add_element("references")
+            
+      webvtt.speakers.each do |speaker|
+        references.add_element("TLCPerson", 
+          "href" => "", 
+          "id" => speaker.parameterize,
+          "showAs" => speaker
+        )
+      end
+
+      body = debate.add_element("debateBody")
+      section = body.add_element("debateSection")
+      heading = section.add_element("heading")
+      heading.add_text "Title"
+
+      webvtt.merged_cues.each do |cue|
+        speech = section.add_element("speech",
+          "by" => "##{cue.speaker.parameterize}"
+        )
+        p = speech.add_element("p")
+        p.add_text cue.text
+      end
+    
+      output
+    end
+    
+  end
+  
+end

data/lib/vtt2an/version.rb

@@ -0,0 +1,3 @@
+module Vtt2An
+  VERSION = "0.1.0"
+end

data/lib/vtt2an/webvtt/cue.rb

@@ -0,0 +1,26 @@
+class WebVTT::Cue
+
+  VOICE_SPAN_REGEX = /<v\.?([\w\.]*?) (.*?)\>(.*)/
+  
+  def speaker 
+    raw_text =~ VOICE_SPAN_REGEX
+    $2 || "Speaker"
+  end
+  
+  alias_method :raw_text, :text
+  
+  def text
+    raw_text =~ VOICE_SPAN_REGEX
+    $3 || raw_text
+  end
+  
+  def voice_span
+    raw_text =~ VOICE_SPAN_REGEX
+    if $1
+      $1.split(".")
+    else
+      []
+    end
+  end
+  
+end

data/lib/vtt2an/webvtt/file.rb

@@ -0,0 +1,23 @@
+class WebVTT::File
+
+  def speakers
+    cues.map{|x|x.speaker}.uniq
+  end
+  
+  def merged_cues
+    merged = []
+    last_speaker = nil
+    cues.each do |input_cue|
+      if input_cue.speaker != last_speaker
+        merged.last.parse unless merged.empty?
+        merged << WebVTT::Cue.new(input_cue.instance_variable_get(:@content))
+      else
+        merged.last.instance_variable_set(:@content, "#{merged.last.instance_variable_get(:@content)} #{input_cue.text}")
+      end
+      last_speaker = input_cue.speaker
+    end
+    merged.last.parse unless merged.empty?
+    merged
+  end
+  
+end

data/vtt2an.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vtt2an/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vtt2an"
+  spec.version       = Vtt2An::VERSION
+  spec.authors       = ["James Smith"]
+  spec.email         = ["james@floppy.org.uk"]
+
+  spec.summary       = %q{Convert WebVTT subtitles to Akoma Ntoso transcripts}
+  spec.homepage      = "https://github.com/Floppy/vtt2an"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_dependency "webvtt-ruby", "~> 0.3"
+  spec.add_dependency "activesupport", "~> 5.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: vtt2an
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: webvtt-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- james@floppy.org.uk
+executables:
+- vtt2an.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- exe/vtt2an.rb
+- lib/vtt2an.rb
+- lib/vtt2an/converter.rb
+- lib/vtt2an/version.rb
+- lib/vtt2an/webvtt/cue.rb
+- lib/vtt2an/webvtt/file.rb
+- vtt2an.gemspec
+homepage: https://github.com/Floppy/vtt2an
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Convert WebVTT subtitles to Akoma Ntoso transcripts
+test_files: []