tc 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in tc.gemspec
+gemspec
+gem 'rspec', "~>2.0"
+# gem 'rcov'

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Chris Beer
+
+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,23 @@
+# Tc
+
+Timecode parser (based on Parslet) for parsing arbitrary timecode formats into a standardized format
+
+## Usage
+
+```ruby
+  parser = Tc::Duration.new
+
+  parser.parse('00:12:43;23') 
+  # => { :hours => '00', :minutes => '12', :seconds => '43', :frames => '23', :ndf => ';'}
+
+  parser.parse('123m') 
+  # => { :minutes => '123' }
+
+  parser.parse('approx. 54s')
+  # => { :seconds => '54', :approximate => 'approx.' }
+
+```
+
+See ```spec/lib/tc_duration.rb``` for additional examples.
+
+Given an ambiguously formatted input (e.g. ```01:34```), Tc will prefer ```hh:mm``` for small values of ```hh``` (<= 2 hours), but ```mm:ss``` in all other cases.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+require 'rake'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/lib/tc/duration.rb

@@ -0,0 +1,100 @@
+require 'parslet'
+
+class Tc::Duration < Parslet::Parser
+  def stri(str)
+    key_chars = str.split(//)
+    key_chars.
+      collect! { |char| match["#{char.upcase}#{char.downcase}"] }.
+      reduce(:>>)
+  end
+
+
+  # base units
+  rule(:integer) { match('[0-9]') }
+  rule(:space) { match('\s').repeat(1) }
+  rule(:space?) { space.maybe }
+
+  rule(:arbitrary_length_integer) { integer.repeat(1) }
+  rule(:one_or_two_digit_integer) { integer.repeat(1,2) }
+  rule(:zero_zero_to_fifty_nine) { (match('[0-5]') >> match('[0-9]') | match('[0-9]')) }
+  rule(:zero_zero_to_twenty_nine) { (match('[0-2]') >> match('[0-9]') | match('[0-9]')) }
+
+  #separators
+  rule(:separator) { match(':') }
+  rule(:ndf_separator) { match(':').as(:ndf) }
+  rule(:df_separator) { match(';').as(:df) }
+
+  # unit strings
+  rule(:s_seconds) { ((space? >> stri('s') >> (stri('ec') >> stri('s').maybe).maybe >> (str('.') | stri('ond')).maybe >> stri('s').maybe) | str('"'))}
+  rule(:s_minutes) { ((space? >> stri('m') >> stri('in').maybe >> (str('.') | (stri('ute') >> stri('s')).maybe).maybe) | str("'"))}
+  rule(:s_hours) { (space? >> stri('h') >> ((stri('r') >> stri('s').maybe >> str('.').maybe) | (stri('our').maybe >> stri('s').maybe )).maybe) }
+
+  # unit values
+  
+  # idealized
+  rule(:ff) { zero_zero_to_twenty_nine >> integer.absnt? }
+  rule(:ss) { zero_zero_to_fifty_nine }
+  rule(:mm) { zero_zero_to_fifty_nine >> integer.absnt? }
+  rule(:hh) { arbitrary_length_integer }
+
+  # seconds
+  rule(:sec) { arbitrary_length_integer }
+  rule(:fraction) { str('.') >> arbitrary_length_integer }
+  rule(:frame) { zero_zero_to_fifty_nine >> integer.absnt? }
+
+  # minutes
+  rule(:min) { arbitrary_length_integer }
+
+  # hours
+  rule(:small_h) { str('0').maybe >> match('[0-2]') >> integer.absnt? }
+
+  # unit matchers
+  rule(:frames) { (ndf_separator | df_separator) >> (ff | frame).as(:frames) }
+  rule(:seconds_f) { ((sec >> fraction).as(:seconds) | ( sec.as(:seconds) >> frames )) }
+  rule(:seconds) { (seconds_f | sec.as(:seconds) ) }
+  rule(:minutes) { (mm | min).as(:minutes) >> (integer | str('.')).absnt? }
+  rule(:hours) { hh.as(:hours) }
+
+  rule(:s) { seconds  >> s_seconds.maybe }
+  rule(:h) { hours >> s_hours.maybe }
+  rule(:m) { minutes >> s_minutes.maybe }
+
+  # timecode matchers
+  rule(:smpte) { hh.as(:hours) >> separator >> mm.as(:minutes) >> separator >> ss.as(:seconds) >> frames } 
+  rule(:h_m) { hours >> separator >> minutes >> s_minutes.maybe }
+  rule(:h_m_s) { hours >> separator >> minutes >> separator >> seconds >> s_seconds.maybe }
+  rule(:small_h_m_s) { small_h.as(:hours) >> separator >> minutes >> separator >> seconds >> s_seconds.maybe } 
+  rule(:m_s) { minutes >> separator >> seconds >> (s_minutes | s_seconds).maybe }
+  rule(:m_s_f) { minutes >> separator >> seconds_f >> s_seconds.maybe }
+
+  rule(:hr_min) { hours >> s_hours >> space? >> (minutes >> s_minutes.maybe).maybe }
+  rule(:hr_min_sec) { hours >> s_hours >> space? >> minutes >> s_minutes.maybe >> space? >> seconds >> s_seconds.maybe }
+  rule(:min_sec) {  minutes >> s_minutes >> space? >> (seconds >> s_seconds.maybe).maybe }
+
+  rule(:unambiguous) { smpte | small_h_m_s | hr_min | hr_min_sec | min_sec }
+  rule(:ambiguous) { m_s_f | h_m_s | m_s | h_m | m | s }
+  rule(:exact) { unambiguous | ambiguous }
+
+  # approximate indicators
+  rule(:q) { str('?') }
+  rule(:ca) { str('c') >> str('a').maybe >> (str('.') | str(',')).maybe }
+  rule(:gt) { str('>').as(:gt) }
+  rule(:lt) { str('<').as(:lt) }
+  rule(:ish) { str('ish') }
+  rule(:s_approx) { str('approx') >> str('.').maybe }
+
+  # full matchers
+  rule(:approx) { space? >> (s_approx | q | ca | gt |lt | ish).as(:approximate) >> space?}
+  rule(:approximate_head) { approx >> exact }
+  rule(:approximate_tail) { exact >> approx }
+  rule(:approximate) { approximate_head | approximate_tail }
+  rule(:timecode) { approximate | exact }
+
+  # header tokens
+  rule(:trt) { str('TRT').as(:trt) >> space? }
+  rule(:colon_prefix) { str(':') }
+
+  rule(:duration) { (trt | colon_prefix).maybe >> timecode } 
+
+  root :duration
+end

data/lib/tc/version.rb

@@ -0,0 +1,3 @@
+module Tc
+  VERSION = "0.0.1"
+end

data/lib/tc.rb

@@ -0,0 +1,5 @@
+require "tc/version"
+
+module Tc
+  autoload :Duration, 'tc/duration'
+end

data/spec/lib/tc_duration_spec.rb

@@ -0,0 +1,492 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'parslet/rig/rspec'
+
+describe Tc::Duration do
+  let(:parser) { Tc::Duration.new }
+
+  context "integer" do
+    it "should consume '0'" do
+      parser.integer.should parse('0')
+    end
+  end
+
+  context "mm" do
+    it "should consume '00'" do
+      parser.mm.should parse('00')
+    end
+
+    it "should consume '32'" do
+      parser.mm.should parse('32')
+    end
+
+    it "should consume '59'" do
+      parser.mm.should parse('59')
+    end
+
+    it "should not consume '63'" do
+      parser.mm.should_not parse('63')
+    end
+
+    it "should not consume '123'" do
+      parser.mm.should_not parse('123')
+    end
+  end
+
+  context "min" do
+    it "should consume '00'" do
+      parser.min.should parse('00')
+    end
+
+    it "should consume '63'" do
+      parser.min.should parse('63')
+    end
+
+    it "should consume '123'" do
+      parser.min.should parse('123')
+    end
+  end
+
+  context "minutes" do
+  end
+
+  context "s_minutes" do
+    it "should consume 'm'" do
+      parser.s_minutes.should parse('m')
+    end
+
+    it "should consume 'Min'" do
+      parser.s_minutes.should parse('Min')
+    end
+
+    it "should consume 'min.'" do
+      parser.s_minutes.should parse(' min.')
+    end
+
+    it "should consume 'minutes'" do
+      parser.s_minutes.should parse(' minutes')
+    end
+  end
+
+  context "m" do
+    it "should consume '53m'" do
+      parser.m.should parse('53m')
+    end
+
+    it "should consume '32 min." do
+      parser.m.should parse('32 min.')
+    end
+
+    it "should consume '120 minutes'" do
+      parser.m.should parse('120 minutes')
+    end
+
+    it "should consume '42 Minutes'" do
+      parser.m.should parse('42 Minutes')
+    end
+
+    it "should consume '58\''" do
+      parser.m.should parse('58\'')
+    end
+  end
+
+  context "hh" do
+  end
+
+  context "small_h" do
+    it "should consume '01'" do
+      parser.small_h.should parse('01')
+    end
+
+    it "should consume '2'" do
+      parser.small_h.should parse('2')
+    end
+
+    it "should not consume '12'" do
+      parser.small_h.should_not parse('12')
+    end
+  end
+
+  context "small_h_m_s" do
+    it "should consume '01:09:26 s'" do
+      parser.small_h_m_s.should parse('01:09:26 s')
+    end
+    
+    it "should not consume '275:00:00'" do
+      parser.small_h_m_s.should_not parse('275:00:00')
+    end
+
+    it "should not consume '4:52:12'" do
+      parser.small_h_m_s.should_not parse('4:52:12')
+    end
+  end
+
+  context 's_hours' do
+    it "should consume 'h'" do
+      parser.s_hours.should parse('h')
+    end
+    it "should consume 'hr'" do
+      parser.s_hours.should parse('hr')
+    end
+
+    it "should consume 'H'" do
+      parser.s_hours.should parse('H')
+    end
+
+    it "should consume 'hours'" do
+      parser.s_hours.should parse('hours')
+    end
+
+    it "should consume 'hrs.'" do
+      parser.s_hours.should parse('hrs.')
+    end
+  end
+
+  context "ss" do
+    it "should consume '00'" do
+      parser.ss.should parse('00')
+    end
+
+    it "should consume '47'" do
+      parser.ss.should parse('47')
+    end
+
+    it "should not consume '94'" do
+      parser.ss.should_not parse('94')
+    end
+  end
+
+  context 's_seconds' do
+    it "should consume 's'" do
+      parser.s_seconds.should parse('s')
+    end
+
+    it "should consume 'seconds'" do
+      parser.s_seconds.should parse('seconds')
+    end
+
+    it "should consume 'sec'" do
+      parser.s_seconds.should parse('sec')
+    end
+
+    it "should consume 'secs'" do
+      parser.s_seconds.should parse('secs')
+    end
+
+    it "should consume 's.'" do
+      parser.s_seconds.should parse('s.')
+    end
+  end
+
+  context "seconds" do
+    it "should consume '45'" do
+      parser.seconds.should parse('45')
+    end
+
+    it "should consume '36.234'" do
+      parser.seconds.should parse('36.234')
+    end
+    
+    it "should consume '23:09'" do
+      parser.seconds.should parse('23:09')
+    end
+
+    it "should consume '13;28'" do
+      parser.seconds.should parse('13;28')
+    end
+
+    it "should consume '0.26875'" do
+      parser.seconds.should parse('0.26875')
+    end
+  end
+
+  context 'frames' do
+    it "should consume ';29'" do
+      parser.frames.should parse(';29')
+    end
+
+    it "should consume ':12'" do
+      parser.frames.should parse(':12')
+    end
+  end
+
+  context 'smpte' do
+    it "should consume '01:02:03:04'" do
+      parser.smpte.should parse('01:02:03:04')
+    end
+
+    it "should consume '01:08:59:29'" do
+      parser.smpte.should parse('01:08:59:29')
+    end
+
+    it "should consume '00:56:57;00'" do
+      parser.smpte.should parse('00:56:57;00')
+    end
+  end
+
+  context "h_m" do
+    it "should consume '1:23'" do
+      parser.h_m.should parse('1:23')
+    end
+
+    it "should consume '04:32'" do
+      parser.h_m.should parse('04:32')
+    end
+  end
+
+  context "m_s" do
+    it "should consume '03:53'" do
+      parser.m_s.should parse('03:53')
+    end
+
+    it "should consume '6:33'" do
+      parser.m_s.should parse('6:33')
+    end
+
+    it "should consume '12:22:23'" do
+      parser.m_s.should parse('12:22:23')
+    end
+
+    it "should consume '43:01;12'" do
+      parser.m_s.should parse('43:01;12')
+    end
+
+    it "should consume '00:01.111'" do
+      parser.m_s.should parse('00:01.111')
+    end
+
+    it "should consume '01:2.693'" do
+      parser.m_s.should parse('01:2.693')
+    end
+  end
+
+  context "m_s_f" do
+    it "should not consume '03:53'" do
+      parser.m_s_f.should_not parse('03:53')
+    end
+  end
+
+  context "hr_min" do
+    it "should consume '4h'" do
+      parser.hr_min.should parse('4h')
+    end
+
+    it "should consume '1hr 34min'" do
+      parser.hr_min.should parse('1hr 34min')
+    end
+
+    it "should not consume '1m 34sec'" do
+      parser.hr_min.should_not parse('1m 34sec')
+    end
+  end
+
+  context "min_sec" do
+    it "should consume '2m34s'" do
+      parser.min_sec.should parse('2m34s')
+    end
+
+    it "should consume '22m 11s'" do
+      parser.min_sec.should parse('22m 11s')
+    end
+
+    it "should consume '94m'" do
+      parser.min_sec.should parse('94m')
+    end
+  end
+
+  context "s" do
+    it "should consume '60s'" do
+      parser.s.should parse('60s')
+    end
+  end
+
+
+  context "exact" do
+    it "should parse '00:01'" do
+      parser.exact.should parse('00:01')
+      parsed = parser.exact.parse('00:01')
+      parsed[:minutes].should == '00'
+      parsed[:seconds].should == '01'
+    end
+
+    it "should parse '00:01:02.043'" do
+      parser.exact.should parse('00:01:02.043')
+      parsed = parser.exact.parse('00:01:02.042')
+
+      parsed[:hours].should == '00'
+      parsed[:minutes].should == '01'
+      parsed[:seconds].should == '02.042'
+    end
+
+    it "should parse '0.26875'" do
+      parser.exact.should parse('0.26875')
+      parsed = parser.exact.parse('0.26875')
+
+      parsed[:seconds].should == '0.26875'
+    end
+
+    it "should parse '00:56:57;00'" do
+      parser.exact.should parse('00:56:57;00')
+      parsed = parser.exact.parse('00:56:57;00')
+
+      parsed[:hours].should == '00'
+      parsed[:minutes].should == '56'
+      parsed[:seconds].should == '57'
+      parsed.should include(:df)
+      parsed[:frames].should == '00'
+    end
+
+    it "should parse '01:2.693'" do
+      parser.exact.should parse('01:2.693')
+      parsed = parser.exact.parse('01:2.693')
+
+      parsed[:minutes].should == '01'
+      parsed[:seconds].should == '2.693' 
+    end
+
+    it "should parse '20:00m'" do
+      parser.exact.should parse('20:00m')
+      parsed = parser.exact.parse('20:00m')
+
+      parsed[:minutes].should == '20'
+      parsed[:seconds].should == '00'
+    end
+
+    it "should parse '21:44.450'" do
+      parser.exact.should parse('21:44.450')
+      parsed = parser.exact.parse('21:44.450')
+
+      parsed[:minutes].should == '21'
+      parsed[:seconds].should == '44.450'
+    end
+
+    it "should parse '227min.'" do
+      parser.exact.should parse('227min.')
+      parsed = parser.exact.parse('227min.')
+
+      parsed[:minutes].should == '227'
+    end
+
+    it "should parse '229:00'" do
+      parser.exact.should parse('229:00')
+      parsed = parser.exact.parse('229:00')
+      parsed[:minutes].should == '229'
+      parsed[:seconds].should == '00'
+    end
+
+    it "should parse '22m 11s'" do
+      parser.exact.should parse('22m 11s')
+      parsed = parser.exact.parse('22m 11s')
+      parsed[:minutes].should == '22'
+      parsed[:seconds].should == '11'
+    end
+
+    it "should parse '25:04:00'" do
+      parser.exact.should parse('25:04:00')
+      parsed = parser.exact.parse('25:04:00')
+
+      parsed[:minutes].should == '25'
+      parsed[:seconds].should == '04'
+      parsed[:frames].should == '00'
+    end
+
+    it "should parse '29:28'" do
+      parser.exact.should parse('29:28')
+      parsed = parser.exact.parse('29:28')
+      parsed[:minutes].should == '29'
+      parsed[:seconds].should == '28'
+    end
+
+    it "should parse '5100.0'" do
+      parser.exact.should parse('5100.0')
+      parsed = parser.exact.parse('5100.0')
+
+      parsed[:seconds].should == '5100.0'
+    end
+
+    it "should parse '120'" do
+      parser.exact.should parse('120')
+      parsed = parser.exact.parse('120')
+      parsed[:minutes].should == '120'
+    end
+
+    it "should parse '58\''" do
+      parser.exact.should parse("58'")
+      parsed = parser.exact.parse("58'")
+
+      parsed[:minutes].should == "58"
+    end
+
+    it "should parse 4h" do
+      parser.exact.should parse('4h')
+      parsed = parser.exact.parse('4h')
+
+      parsed[:hours].should == '4'
+    end
+
+    it "should parse '01:09:26 s'" do
+      parser.exact.should parse('01:09:26 s')
+      parsed = parser.exact.parse('01:09:26 s')
+
+      parsed[:hours].should == '01'
+      parsed[:minutes].should == '09'
+      parsed[:seconds].should == '26'
+    end
+  end
+
+  context "approximate" do
+    it "should consume '00:00:00?'" do
+      parser.approximate.should parse('00:00:00?')
+    end
+
+    it "should consume '8ish'" do 
+      parser.approximate.should parse('8ish')
+    end
+    
+    it "should consume '<1hr'" do
+      parser.approximate.should parse('<1hr')
+
+      parsed = parser.approximate.parse('<1hr')
+      parsed.should include(:approximate)
+      parsed[:approximate].should include(:lt)
+    end
+
+    it "should consume 'ca. 77m'" do
+      parser.approximate.should parse('ca. 77m')
+    end
+
+    it "should consume 'approx. 32min'" do
+      parser.approximate.should parse('approx. 32min')
+    end
+  end
+
+  context "timecode" do
+    it "should parse '01:09:26 s'" do
+      parser.timecode.should parse('01:09:26 s')
+      parsed = parser.timecode.parse('01:09:26 s')
+
+      parsed[:hours].should == '01'
+      parsed[:minutes].should == '09'
+      parsed[:seconds].should == '26'
+    end
+
+    it "should parse '22:11?'" do
+      parser.timecode.should parse('22:11?')
+      parsed = parser.timecode.parse('22:11?')
+
+      parsed[:minutes].should == '22'
+      parsed[:seconds].should == '11'
+      parsed.should include(:approximate)
+    end
+  end
+
+  context "duration" do
+    it "should consume 'TRT 25:57'" do
+      parser.duration.should parse('TRT 25:57')
+    end
+
+    it "should consume ':00:26:30'" do
+      parser.duration.should parse(':00:26:30')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'tc'
+
+RSpec.configure do |config|
+
+end

data/tc.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tc/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tc"
+  s.version     = Tc::VERSION
+  s.authors     = ["Chris Beer"]
+  s.email       = ["chris_beer@wgbh.org"]
+  s.homepage    = ""
+  s.summary     = %q{Timecode parsing}
+  s.description = %q{Timecode parsing}
+
+  s.rubyforge_project = "tc"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "parslet"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: tc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-10 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: &2161225380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161225380
+description: Timecode parsing
+email:
+- chris_beer@wgbh.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tc.rb
+- lib/tc/duration.rb
+- lib/tc/version.rb
+- spec/lib/tc_duration_spec.rb
+- spec/spec_helper.rb
+- tc.gemspec
+has_rdoc: true
+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: tc
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Timecode parsing
+test_files:
+- spec/lib/tc_duration_spec.rb
+- spec/spec_helper.rb