ttml 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ttml.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Luca S.G. de Marinis
+
+MIT License
+
+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,36 @@
+# Ttml
+
+Very simple Timed Text Markup Language parsing - I needed to parse a ttml file
+and couldn't find a ruby implementation (probably because you don't really
+need one!), so I wrote one. In the future I may support writing a ttml file
+and/or a better, richer API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ttml'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ttml
+
+## Usage
+
+    tt = Ttml.Document.new('test/sample.xml)
+    # Returns events until 100.0 seconds
+    tt.subtitle_stream(:from => 0.0, :to => 100.0).each { |event|
+      puts event.inspect
+    }
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/ttml/version.rb

@@ -0,0 +1,3 @@
+module Ttml
+  VERSION = "0.0.2"
+end

data/lib/ttml.rb

@@ -0,0 +1,52 @@
+require "ttml/version"
+require "nokogiri"
+
+module Ttml
+  # Minimal Timed Text Markup Language parsing and extraction.
+  #
+  # Example:
+  #   >> doc = Ttml::Document.new('test/sample.xml')
+  #   => [Ttml::Document]
+  #   >> doc.copyright
+  #   => '(c) 2012 loop23'
+  #   >> doc.subtitles
+  #   => [All subtitles]
+  #   >> doc.subtitles(0.0, 100.0)
+  #   => [Subtitles from beginning to 100 seconds]
+  class Document
+
+    attr_reader :doc
+
+    def initialize file_or_stream
+      stream = file_or_stream.is_a?(IO) ? file_or_stream : File.open(file_or_stream)
+      @doc = Nokogiri::XML(stream)
+    end
+
+    # Returns subtitles from "from" to "to" (inclusive) as an array
+    # (or all subtitles if both are missing).
+    # I tried using xpath functions, without success,
+    # as in xmlns:div/xmlns:p[number(@begin)=>746.63] - any ideas?
+    def subtitle_stream from = 0.0, to = 99999999.0
+      doc.xpath("/xmlns:tt/xmlns:body/xmlns:div/xmlns:p").select {|n|
+        # puts "Vedo se #{ n['begin'].to_f } >= #{ from } e se #{ n['end'].to_f } <= #{ to }"
+        (n['begin'].to_f >= from) && (n['end'].to_f <= to)
+      }
+    end
+
+    # Returns document title
+    def title
+      doc.xpath("//ns2:title")[0].children[0].content
+    end
+
+    # Returns document description
+    def description
+      doc.xpath("//ns2:description")[0].children[0].content
+    end
+
+    # Returns document copyright
+    def copyright
+      doc.xpath("//ns2:copyright")[0].children[0].content
+    end
+
+  end
+end

data/test/sample.xml

@@ -0,0 +1,54 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<tt xmlns:ns3="http://www.w3.org/2006/10/ttaf1#style"
+ xmlns:ns2="http://www.w3.org/2006/10/ttaf1#metadata" xmlns="http://www.w3.org/2006/10/ttaf1" xml:lang="">
+ <head>
+  <ns2:title>Timed Text DFPX</ns2:title>
+  <ns2:copyright>2012 (c) loop</ns2:copyright>
+  <styling>
+   <style ns3:textAlign="center" ns3:fontSize="22px" ns3:fontFamily="proportionalSansSerif" ns3:color="yellow"
+    xml:id="s1" />
+   <style ns3:color="yellow" style="s1" xml:id="s2" />
+   <style ns3:textAlign="end" style="s1" xml:id="s1Right" />
+   <style ns3:textAlign="start" style="s2" xml:id="s2Left" />
+  </styling>
+  <layout>
+   <region xml:id="subtitleArea" ns3:padding="5px 3px" ns3:extent="560px 62px" ns3:displayAlign="after"
+    ns3:backgroundColor="black" style="s1" />
+  </layout>
+ </head>
+ <body region="subtitleArea">
+  <div>
+   <p end="362.05s" begin="358.72s"><![CDATA[<p align="left" ><font color="#ffa500">Signori Consiglieri siete pregati di prendere posto</font></p>]]></p>
+   <p end="405.94s" begin="405.81s"><![CDATA[<p align="left" ><font color="#ffa500">e</font></p>]]></p>
+   <p end="463.13s" begin="462.12s"><![CDATA[<p align="left" ><font color="#ffa500">di attivare</font></p>]]></p>
+   <p end="472s" begin="470.44s"><![CDATA[<p align="left" ><font color="#ffa500">la carta.</font></p>]]></p>
+   <p end="474.63s" begin="472s"><![CDATA[<p align="left" ><font color="#ffa500">Il Segretario</font></p>]]></p>
+   <p end="475.92s" begin="474.63s"><![CDATA[<p align="left" ><font color="#ffa500">Generale dia corso all'appello.</font></p>]]></p>
+   <p end="621.21s" begin="618.41s"><![CDATA[<p align="left" ><font color="#ffa500">Avuta la totalita' dei signori Consiglieri,</font></p>]]></p>
+   <p end="624.53s" begin="621.21s"><![CDATA[<p align="left" ><font color="#ffa500">dichiaro aperti i lavori del Consiglio Provinciale,</font></p>]]></p>
+   <p end="627.3s" begin="624.53s"><![CDATA[<p align="left" ><font color="#ffa500">ricordando a tutti i signori Consiglieri, al signor</font></p>]]></p>
+   <p end="630.25s" begin="627.3s"><![CDATA[<p align="left" ><font color="#ffa500">Presidente della Provincia e ai signori Assessori,</font></p>]]></p>
+   <p end="631.98s" begin="630.25s"><![CDATA[<p align="left" ><font color="#ffa500">che i</font></p>]]></p>
+   <p end="633.73s" begin="631.98s"><![CDATA[<p align="left" ><font color="#ffa500"></font></p>]]></p>
+   <p end="635.83s" begin="633.73s"><![CDATA[<p align="left" ><font color="#ffa500">lavori del Consiglio Provinciale sono in</font></p>]]></p>
+   <p end="639.53s" begin="635.83s"><![CDATA[<p align="left" ><font color="#ffa500">trasmissione diretta.</font></p>]]></p>
+   <p end="643.37s" begin="639.53s"><![CDATA[<p align="left" ><font color="#ffa500">Passiamo alla trattazione dell'ordine del giorno, la prima proposta</font></p>]]></p>
+   <p end="647.09s" begin="643.37s"><![CDATA[<p align="left" ><font color="#ffa500">e': 'Approvazione del verbale della seduta del Consiglio Provinciale</font></p>]]></p>
+   <p end="650.46s" begin="647.09s"><![CDATA[<p align="left" ><font color="#ffa500">del 3 dicembre 2009, del 16</font></p>]]></p>
+   <p end="654.02s" begin="650.46s"><![CDATA[<p align="left" ><font color="#ffa500">dicembre 2009 e del 21 dicembre 2009'.</font></p>]]></p>
+   <p end="656.21s" begin="654.02s"><![CDATA[<p align="left" ><font color="#ffa500"></font></p>]]></p>
+   <p end="658.41s" begin="656.21s"><![CDATA[<p align="left" ><font color="#ffa500">Chi avesse delle osservazioni da muovere</font></p>]]></p>
+   <p end="662.19s" begin="658.41s"><![CDATA[<p align="left" ><font color="#ffa500">in ordine al contenuto dei verbali, e' autorizzato.</font></p>]]></p>
+   <p end="664.58s" begin="662.19s"><![CDATA[<p align="left" ><font color="#ffa500"></font></p>]]></p>
+   <p end="669.4s" begin="664.58s"><![CDATA[<p align="left" ><font color="#ffa500">Nessuna questione' Pongo in votazione l'approvazione del verbale</font></p>]]></p>
+   <p end="672.38s" begin="669.4s"><![CDATA[<p align="left" ><font color="#ffa500">del Consiglio Provinciale del 3 dicembre 2009. Prego.</font></p>]]></p>
+   <p end="709.28s" begin="703.82s"><![CDATA[<p align="left" ><font color="#ffa500">37 votanti, 37 favorevoli. Il Consiglio approva.</font></p>]]></p>
+   <p end="713.9s" begin="709.28s"><![CDATA[<p align="left" ><font color="#ffa500">Pongo in votazione il verbale del Consiglio Provinciale</font></p>]]></p>
+   <p end="717.37s" begin="713.9s"><![CDATA[<p align="left" ><font color="#ffa500">del 16 dicembre 2009.</font></p>]]></p>
+   <p end="719.52s" begin="717.37s"><![CDATA[<p align="left" ><font color="#ffa500">I Signori Consiglieri sono pregati di votare.</font></p>]]></p>
+   <p end="744.2s" begin="738.91s"><![CDATA[<p align="left" ><font color="#ffa500">36 votanti, 36 favorevoli. Il Consiglio approva.</font></p>]]></p>
+   <p end="746.63s" begin="744.2s"><![CDATA[<p align="left" ><font color="#ffa500">Pongo in votazione il</font></p>]]></p>
+   <p end="749.38s" begin="746.63s"><![CDATA[<p align="left" ><font color="#ffa500">verbale della seduta del 21 dicembre 2009.</font></p>]]></p>
+  </div>
+ </body>
+</tt>

data/test/test_ttml.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'ttml'
+
+class TtmlTest < Test::Unit::TestCase
+
+  def setup
+    @doc = Ttml::Document.new(File.join(File.dirname(__FILE__), 'sample.xml'))
+  end
+
+  def test_class
+    assert @doc.is_a?(Ttml::Document)
+  end
+
+  def test_copyright
+    assert_equal '2012 (c) loop', @doc.copyright
+  end
+
+  def test_title
+    assert_equal 'Timed Text DFPX', @doc.title
+  end
+
+  def test_subs_no_param
+    assert @doc.subtitle_stream.is_a?(Array), "Not a NodeSet!"
+  end
+
+  def test_subs_start_param
+    assert @doc.subtitle_stream(99999999.0).empty?
+    assert_equal 1, @doc.subtitle_stream(746.0).size
+  end
+
+  def test_subs_end_param
+    assert @doc.subtitle_stream(0.0, 0.0).empty?
+    assert_equal 1, @doc.subtitle_stream(746.63, 749.38).size
+  end
+
+
+end

data/ttml.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ttml/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Luca S.G. de Marinis"]
+  gem.email         = ["loop23@gmail.com"]
+  gem.description   = %q{Parse a ttml file}
+  gem.summary       = %q{Minimal parsing for timed text markup language (http://www.w3.org/TR/ttaf1-dfxp/)}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ttml"
+  gem.require_paths = ["lib"]
+  gem.version       = Ttml::VERSION
+
+  gem.add_runtime_dependency "nokogiri"
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: ttml
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Luca S.G. de Marinis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parse a ttml file
+email:
+- loop23@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ttml.rb
+- lib/ttml/version.rb
+- test/sample.xml
+- test/test_ttml.rb
+- ttml.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Minimal parsing for timed text markup language (http://www.w3.org/TR/ttaf1-dfxp/)
+test_files:
+- test/sample.xml
+- test/test_ttml.rb