julik-timecode 0.1.6 → 0.1.7

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.6 / 2009-01-31
+
+* Simplified parsing code, more safeguards and needless exceptions removed
+
 === 0.1.6 / 2009-01-28
 
 * Fixed RDoc linkage

data/SPECS.txt

@@ -1,8 +1,19 @@
 
-== Timecode on instantiation should
-* be instantable from int
+== Timecode.new() should
+* instantiate from int
 * always coerce FPS to float
 * create a zero TC with no arguments
+* accept full string SMPTE timecode as well
+
+== Timecode.at() should
+* disallow more than 99 hrs
+* disallow more than 59 minutes
+* disallow more than 59 seconds
+* disallow more frames than what the framerate permits
+* propery accept usable values
+
+== A new Timecode object should
+* be frozen
 
 == An existing Timecode should
 * report that the framerates are in delta
@@ -13,11 +24,13 @@
 * support seconds
 * support frames
 * report frame_interval as a float
+* be comparable
+* raise on comparison of incompatible timecodes
 
 == A Timecode of zero should
 * properly respond to zero?
 
-== An existing TImecode on inspection should
+== An existing Timecode on inspection should
 * properly present himself via inspect
 * properly print itself
 
@@ -37,26 +50,19 @@
 * raise when subtracting a Timecode with a different framerate
 * support multiplication
 * raise when the resultig Timecode is negative
-* yield a Timecode when divided by an Integer
-* yield a number when divided by another Timecode
+* return a Timecode when divided by an Integer
+* return a number when divided by another Timecode
 
 == A Timecode used with fractional number of seconds
 * should properly return fractional seconds
 * properly translate to frames when instantiated from fractional seconds
 
-== Timecode.at() should
-* disallow more than 99 hrs
-* disallow more than 59 minutes
-* disallow more than 59 seconds
-* disallow more frames than what the framerate permits
-* propery accept usable values
-
 == A custom Timecode descendant should
 * properly classify on parse
 * properly classify on at
 * properly  classify on calculations
 
-== Timecode.parse() should
+== Timecode.parse should
 * handle complete SMPTE timecode
 * handle complete SMPTE timecode via new
 * refuse to handle timecode that is out of range for the framerate
@@ -66,7 +72,11 @@
 * parse a number with m suffix as minutes
 * parse a number with h suffix as hours
 * parse different suffixes as a sum of elements
+* parse a number of digits as timecode
+* truncate a large number to the parseable length
+* left-pad a large number to give proper TC
 * parse timecode with fractional second instead of frames
+* raise when trying to parse DF timecode
 * raise on improper format
 
 == Timecode.soft_parse should
@@ -77,4 +87,4 @@
 * parse from a 4x4bits packed 32bit unsigned int
 * properly convert itself back to 4x4 bits 32bit unsigned int
 
-52 specifications (87 requirements), 0 failures
+60 specifications (101 requirements), 0 failures

data/lib/timecode.rb

@@ -12,7 +12,7 @@
 #     :mapping => [%w(source_tc_frames total), %w(tape_fps fps)]
 
 class Timecode
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 
   include Comparable
   
@@ -33,9 +33,6 @@ class Timecode
   # All Timecode lib errors inherit from this
   class Error < RuntimeError; end
   
-  # Will be raised for functions that are not supported
-  class TimecodeLibError < Error; end
-
   # Gets raised if timecode is out of range (like 100 hours long)
   class RangeError < Error; end
 
@@ -81,18 +78,19 @@ class Timecode
     # * 00:00:00:00 - will be parsed as zero TC
     def parse(input, with_fps = DEFAULT_FPS)
       # Drop frame goodbye
-      raise Error, "We do not support drop frame" if (input =~ /\;/)
+      raise Error, "We do not support drop frame" if (input =~ DF_TC_RE)
       
       hrs, mins, secs, frames = 0,0,0,0
       atoms = []
       
       # 00:00:00:00
       if (input =~ COMPLETE_TC_RE)
-        atoms = input.scan(COMPLETE_TC_RE).to_a.flatten
+        atoms_and_fps = input.scan(COMPLETE_TC_RE).to_a.flatten.map{|e| Integer(e)} + [with_fps]
+        return at(*atoms_and_fps)
       # 00:00:00.0
       elsif input =~ FRACTIONAL_TC_RE
         parse_with_fractional_seconds(input, with_fps)
-      # 10h 20m 10s 1f
+      # 10h 20m 10s 1f 00:00:00:01 - space separated is a sum of parts
       elsif input =~ /\s/
         return input.split.map{|part|  parse(part, with_fps) }.inject { |sum, p| sum + p.total }
       # 10s
@@ -107,24 +105,16 @@ class Timecode
       # 60f - 60 frames, or 2 seconds and 10 frames
       elsif input =~ /^(\d+)f$/i
         return new(input.to_i, with_fps)
-      # A bunch of integers
+      # Only a bunch of digits, treat 12345 as 00:01:23:45
       elsif (input =~ /^(\d+)$/)
-        ints = input.split(//)
-        atoms.unshift [ints.pop, ints.pop].reverse.join.to_i
-        atoms.unshift [ints.pop, ints.pop].reverse.join.to_i
-        atoms.unshift [ints.pop, ints.pop].reverse.join.to_i
-        atoms.unshift [ints.pop, ints.pop].reverse.join.to_i
-      else
-        raise CannotParse, "Cannot parse #{input} into timecode, no match"
-      end
-      
-      if atoms.any?
-        hrs, mins, secs, frames = atoms.map{|e| e.to_i}
+        atoms_len = 2 * 4
+        # left-pad input AND truncate if needed
+        padded = input[0..atoms_len].rjust(8, "0")
+        atoms = padded.scan(/(\d{2})/).flatten.map{|e| e.to_i } + [with_fps]
+        return at(*atoms)
       else
-        raise CannotParse, "Cannot parse #{input} into timecode, atoms were empty"
+        raise CannotParse, "Cannot parse #{input} into timecode, unknown format"
       end
-      
-      at(hrs, mins, secs, frames, with_fps)
     end
     
     # Initialize a Timecode object at this specfic timecode
@@ -290,10 +280,10 @@ class Timecode
   
   # Timecodes can be compared to each other
   def <=>(other_tc)
-    if other_tc.is_a?(Timecode) && framerate_in_delta(fps, other_tc.fps)
+    if framerate_in_delta(fps, other_tc.fps)
       self.total <=> other_tc.total
-    else
-      self.total <=> other_tc
+    else 
+      raise WrongFramerate, "Cannot compare timecodes with different framerates"
     end
   end
   

data/test/test_timecode.rb

@@ -5,9 +5,9 @@ require 'test/spec'
 require File.dirname(__FILE__) + '/../lib/timecode'
 
 
-context "Timecode on instantiation should" do
+context "Timecode.new() should" do
   
-  specify "be instantable from int" do
+  specify "instantiate from int" do
     tc = Timecode.new(10)
     tc.should.be.kind_of Timecode
     tc.total.should.equal 10
@@ -21,6 +21,41 @@ context "Timecode on instantiation should" do
   specify "create a zero TC with no arguments" do
     Timecode.new(nil).should.be.zero?
   end
+  
+  specify "accept full string SMPTE timecode as well" do
+    Timecode.new("00:25:30:10", 25).should.equal Timecode.parse("00:25:30:10")
+  end
+end
+
+context "Timecode.at() should" do 
+  
+  specify "disallow more than 99 hrs" do
+    lambda{ Timecode.at(99,0,0,0) }.should.not.raise
+    lambda{ Timecode.at(100,0,0,0) }.should.raise(Timecode::RangeError)
+  end
+  
+  specify "disallow more than 59 minutes" do
+    lambda{ Timecode.at(1,60,0,0) }.should.raise(Timecode::RangeError)
+  end
+
+  specify "disallow more than 59 seconds" do
+    lambda{ Timecode.at(1,0,60,0) }.should.raise(Timecode::RangeError)
+  end
+  
+  specify "disallow more frames than what the framerate permits" do
+    lambda{ Timecode.at(1,0,60,25, 25) }.should.raise(Timecode::RangeError)
+    lambda{ Timecode.at(1,0,60,32, 30) }.should.raise(Timecode::RangeError)
+  end
+  
+  specify "propery accept usable values" do
+    Timecode.at(20, 20, 10, 5).to_s.should.equal "20:20:10:05"
+  end
+end
+
+context "A new Timecode object should" do
+  specify "be frozen" do
+    Timecode.new(10).should.be.frozen
+  end
 end
 
 context "An existing Timecode should" do
@@ -31,7 +66,6 @@ context "An existing Timecode should" do
     @film_tc = Timecode.new(@one_and_a_half_film, 24)
   end
   
-  
   specify "report that the framerates are in delta" do
     tc = Timecode.new(1)
     tc.framerate_in_delta(25.0000000000000001, 25.0000000000000003).should.equal(true)
@@ -77,6 +111,15 @@ context "An existing Timecode should" do
     tc.frame_interval.should.be.close 0.03333, 0.0001
   end
   
+  specify "be comparable" do
+    (Timecode.new(10) < Timecode.new(9)).should.equal false
+    (Timecode.new(9) < Timecode.new(10)).should.equal true
+    Timecode.new(9).should.equal Timecode.new(9)
+  end
+  
+  specify "raise on comparison of incompatible timecodes" do
+    lambda { Timecode.new(10, 10) < Timecode.new(10, 20)}.should.raise(Timecode::WrongFramerate)
+  end
 end
 
 context "A Timecode of zero should" do
@@ -87,9 +130,10 @@ context "A Timecode of zero should" do
   end
 end
 
-context "An existing TImecode on inspection should" do
+context "An existing Timecode on inspection should" do
   specify "properly present himself via inspect" do
     Timecode.new(10, 25).inspect.should.equal "#<Timecode:00:00:00:10 (10F@25.00)>"
+    Timecode.new(10, 12).inspect.should.equal "#<Timecode:00:00:00:10 (10F@12.00)>"
   end
   
   specify "properly print itself" do
@@ -100,7 +144,7 @@ end
 context "An existing Timecode used within ranges should" do
   specify "properly provide successive value that is one frame up" do
     Timecode.new(10).succ.total.should.equal 11
-    Timecode.new(22).succ.should.equal Timecode.new(23) 
+    Timecode.new(22, 45).succ.should.equal Timecode.new(23, 45) 
   end
   
   specify "work as a range member" do
@@ -155,13 +199,13 @@ context "A Timecode on calculations should" do
     lambda { Timecode.new(10) * -200 }.should.raise(Timecode::RangeError)
   end
   
-  specify "yield a Timecode when divided by an Integer" do
+  specify "return a Timecode when divided by an Integer" do
     v = Timecode.new(200) / 20
     v.should.be.kind_of(Timecode)
     v.should.equal Timecode.new(10)
   end
   
-  specify "yield a number when divided by another Timecode" do
+  specify "return a number when divided by another Timecode" do
     v = Timecode.new(200) / Timecode.new(20)
     v.should.be.kind_of(Numeric)
     v.should.equal 10
@@ -194,31 +238,6 @@ context "A Timecode used with fractional number of seconds" do
 
 end
 
-context "Timecode.at() should" do 
-  
-  specify "disallow more than 99 hrs" do
-    lambda{ Timecode.at(99,0,0,0) }.should.not.raise
-    lambda{ Timecode.at(100,0,0,0) }.should.raise(Timecode::RangeError)
-  end
-  
-  specify "disallow more than 59 minutes" do
-    lambda{ Timecode.at(1,60,0,0) }.should.raise(Timecode::RangeError)
-  end
-
-  specify "disallow more than 59 seconds" do
-    lambda{ Timecode.at(1,0,60,0) }.should.raise(Timecode::RangeError)
-  end
-  
-  specify "disallow more frames than what the framerate permits" do
-    lambda{ Timecode.at(1,0,60,25, 25) }.should.raise(Timecode::RangeError)
-    lambda{ Timecode.at(1,0,60,32, 30) }.should.raise(Timecode::RangeError)
-  end
-  
-  specify "propery accept usable values" do
-    Timecode.at(20, 20, 10, 5).to_s.should.equal "20:20:10:05"
-  end
-end
-
 context "A custom Timecode descendant should" do
   class CustomTC < Timecode; end
   
@@ -246,7 +265,7 @@ context "A custom Timecode descendant should" do
 
 end
 
-context "Timecode.parse() should" do
+context "Timecode.parse should" do
   
   specify "handle complete SMPTE timecode" do
     simple_tc = "00:10:34:10"
@@ -290,6 +309,21 @@ context "Timecode.parse() should" do
     Timecode.parse("1h 4f").to_s.should.equal '01:00:00:04'
     Timecode.parse("4f 1h").to_s.should.equal '01:00:00:04'
     Timecode.parse("29f 1h").to_s.should.equal '01:00:01:04'
+    Timecode.parse("29f \n\n\n\n\n\    1h").to_s.should.equal '01:00:01:04'
+  end
+  
+  specify "parse a number of digits as timecode" do
+    Timecode.parse("00000001").to_s.should.equal "00:00:00:01"
+    Timecode.parse("1").to_s.should.equal "00:00:00:01"
+    Timecode.parse("10").to_s.should.equal "00:00:00:10"
+  end
+  
+  specify "truncate a large number to the parseable length" do
+    Timecode.parse("1000000000000000001").to_s.should.equal "10:00:00:00"
+  end
+
+  specify "left-pad a large number to give proper TC" do
+    Timecode.parse("123456", 57).to_s.should.equal "00:12:34:56"
   end
   
   specify "parse timecode with fractional second instead of frames" do
@@ -310,6 +344,11 @@ context "Timecode.parse() should" do
     tc.to_s.should.equal "00:00:07:02"
   end
   
+  specify "raise when trying to parse DF timecode" do
+    df_tc = "00:00:00;01"
+    lambda { Timecode.parse(df_tc)}.should.raise(Timecode::Error)
+  end
+  
   specify "raise on improper format" do
     lambda { Timecode.parse("Meaningless nonsense", 25) }.should.raise Timecode::CannotParse
     lambda { Timecode.parse("", 25) }.should.raise Timecode::CannotParse

data/timecode.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{timecode}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: julik-timecode
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Julik