framecurve 1.0.2 → 2.0.0

data/test/fixtures/framecurves/err-neg-frames.framecurve.txt

@@ -0,0 +1,3 @@
+# http://framecurve.org/specification-v1
+# at_frame	use_frame_of_source
+-1	-123.45

data/test/fixtures/framecurves/err-no-tuples.framecurve.txt

@@ -0,0 +1,2 @@
+# http://framecurve.org/specification-v1
+# at_frame	use_frame_of_source

data/test/fixtures/framecurves/incorrect.extension

@@ -0,0 +1,6 @@
+# http://framecurve.org/specification-v1
+# at_frame	use_frame_of_source
+1	1
+5	12.34
+9	15.678
+15	25.764

data/test/fixtures/framecurves/sample_framecurve1.framecurve.txt

@@ -0,0 +1,6 @@
+# http://framecurve.org/specification-v1
+# at_frame	use_frame_of_source
+1	1
+5	12.34
+9	15.678
+15	25.764

data/test/test_framecurve_from_fcp_xml_binary.rb

@@ -0,0 +1,39 @@
+require 'helper'
+require "fileutils"
+
+class TestFramecurveFromFCPXML < Test::Unit::TestCase
+  BINARY = File.expand_path(File.dirname(__FILE__) + "/../bin/framecurve_from_fcp_xml")
+  FILE_PATH = File.expand_path(File.dirname(__FILE__) + "/fixtures/fcp_xml/CountDOWN.xml")
+  HERE = File.expand_path(File.dirname(__FILE__))
+  
+  # Run the binary under test with passed options, and return [exit_code, stdout_content, stderr_content]
+  def cli(commandline_arguments)
+    CLITest.new(BINARY).run(commandline_arguments)
+  end
+  
+  def teardown
+    Dir.glob(File.dirname(FILE_PATH) + "/*.framecurve.txt").each do | f |
+      File.unlink(f)
+    end
+  end
+  
+  def test_cli_with_valid_file
+    s, o, e = cli(FILE_PATH)
+    
+    assert_equal 0, s
+    assert e.include?("timewarp")
+    
+    curve = Framecurve::Parser.new.parse(HERE + "/fixtures/fcp_xml/CountDOWN.xml.SEQ1-V1-CLIP1.framecurve.txt")
+    
+    assert_equal 11, curve.length
+    assert_match /From FCP XML/, curve[2].text
+    assert_equal "Information from /xmeml/project/children/sequence/media/video/track/clipitem[1]", curve[3].text
+    assert_equal Framecurve::Tuple.new(1, 13.0), curve[4]
+    assert_equal Framecurve::Tuple.new(51, 63.0), curve[-1]
+    
+    curve2 = Framecurve::Parser.new.parse(HERE + "/fixtures/fcp_xml/CountDOWN.xml.SEQ1-V1-CLIP3.framecurve.txt")
+    assert_equal 11, curve.length
+    
+  end
+  
+end

data/test/test_framecurve_serializer.rb

@@ -1,17 +1,35 @@
 require 'helper'
 
 class TestFramecurveSerializer < Test::Unit::TestCase
-  def test_output
+  def test_writes_preamble_if_needed
     f = Framecurve::Curve.new(Framecurve::Tuple.new(10, 123))
     s = StringIO.new
     Framecurve::Serializer.new.serialize(s, f)
     assert_equal "# http://framecurve.org/specification-v1\n# at_frame\tuse_frame_of_source\n10\t123.00000\r\n", s.string
   end
   
-  def test_materializes_frames
+  def test_writes_only_existing_frames
     f = Framecurve::Curve.new(Framecurve::Tuple.new(10, 123), Framecurve::Tuple.new(12, 456))
     s = StringIO.new
+    
     Framecurve::Serializer.new.serialize(s, f)
-    assert_equal "# http://framecurve.org/specification-v1\n# at_frame\tuse_frame_of_source\n10\t123.00000\r\n11\t289.00000\r\n12\t456.00000\r\n", s.string
+    assert_equal "# http://framecurve.org/specification-v1\n# at_frame\tuse_frame_of_source\n10\t123.00000\r\n12\t456.00000\r\n", s.string
   end
+  
+  def test_validate_and_serialize_with_invalid_input
+    f = Framecurve::Curve.new
+    s = StringIO.new
+    assert_raise(Framecurve::Malformed) do
+      Framecurve::Serializer.new.validate_and_serialize(s, f)
+    end
+  end
+  
+  def test_validate_and_serialize_with_valid_input_works_without_errors
+    f = Framecurve::Curve.new(Framecurve::Tuple.new(10, 123))
+    s = StringIO.new
+    
+    assert_nothing_raised { Framecurve::Serializer.new.validate_and_serialize(s, f) }
+    assert_equal "# http://framecurve.org/specification-v1\n# at_frame\tuse_frame_of_source\n10\t123.00000\r\n", s.string
+  end
+  
 end

data/test/test_framecurve_validator.rb

@@ -77,12 +77,47 @@ class TestFramecurveValidator < Test::Unit::TestCase
   end
   
   def test_should_error_out_with_neg_source_and_dest_values
-     c = Framecurve::Curve.new( Framecurve::Tuple.new(-10, 123.4), Framecurve::Tuple.new(1, -345.67) )
-     v = Framecurve::Validator.new
-     v.validate(c)
-     assert v.any_errors?
-     errs = ["The tuple 1 had a negative at_frame value (-10). The spec mandates positive frames.",
-      "The tuple 2 had a negative use_frame_of_source value (-345.67000). The spec mandates positive frames."]
-     assert_equal errs, v.errors
-   end
+    c = Framecurve::Curve.new( Framecurve::Tuple.new(-10, 123.4), Framecurve::Tuple.new(1, -345.67) )
+    v = Framecurve::Validator.new
+    v.validate(c)
+    assert v.any_errors?
+    errs = ["The line 1 had it's at_frame value (-10) below 1. The spec mandates at_frame >= 1.",
+      "The line 2 had a use_frame_of_source value (-345.67000) below 0. The spec mandates use_frame_of_source >= 0."]
+    assert_equal errs, v.errors
+  end
+  
+  def test_parse_from_err_bad_extension
+    v = Framecurve::Validator.new
+    v.parse_and_validate(File.dirname(__FILE__) + "/fixtures/framecurves/incorrect.extension")
+    assert_equal ["The framecurve file has to have the .framecurve.txt double extension, but had \".extension\""], v.errors
+  end
+  
+  def test_parse_from_err_neg_frames
+    v = Framecurve::Validator.new
+    v.parse_and_validate(File.dirname(__FILE__) + "/fixtures/framecurves/err-neg-frames.framecurve.txt")
+    assert_equal ["The line 3 had it's at_frame value (-1) below 1. The spec mandates at_frame >= 1."], v.errors
+  end
+  
+  def test_parse_from_err_no_tuples
+    v = Framecurve::Validator.new
+    v.parse_and_validate(File.dirname(__FILE__) + "/fixtures/framecurves/err-no-tuples.framecurve.txt")
+    assert_equal ["The framecurve did not contain any frame correlation records"], v.errors
+  end
+  
+  def test_should_warn_without_preamble_url
+    c = Framecurve::Curve.new( Framecurve::Tuple.new(10, 123.4))
+    v = Framecurve::Validator.new
+    v.validate(c)
+    assert v.any_warnings?
+    assert_equal "It is recommended that a framecurve starts with a comment with the specification URL", v.warnings[0]
+  end
+  
+  def test_should_warn_without_preamble_headers
+    c = Framecurve::Curve.new( Framecurve::Comment.new("http://framecurve.org/specification-v1"), Framecurve::Tuple.new(10, 123.4))
+    v = Framecurve::Validator.new
+    v.validate(c)
+    assert v.any_warnings?
+    assert_equal "It is recommended for the second comment to provide a column header", v.warnings[0]
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framecurve
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-30 00:00:00.000000000 Z
+date: 2012-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &10767710 !ruby/object:Gem::Requirement
+  requirement: &11839020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10767710
+  version_requirements: *11839020
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &10767420 !ruby/object:Gem::Requirement
+  requirement: &11838780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *10767420
+  version_requirements: *11838780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10767130 !ruby/object:Gem::Requirement
+  requirement: &11838540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10767130
+  version_requirements: *11838540
 - !ruby/object:Gem::Dependency
   name: cli_test
-  requirement: &10766770 !ruby/object:Gem::Requirement
+  requirement: &11838300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,11 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10766770
+  version_requirements: *11838300
 description: ! ' Parser, validation and interpolation'
 email: me@julik.nl
 executables:
+- framecurve_from_fcp_xml
 - framecurve_validator
 extensions: []
 extra_rdoc_files:
@@ -66,21 +67,31 @@ extra_rdoc_files:
 files:
 - .document
 - Gemfile
+- History.txt
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- bin/framecurve_from_fcp_xml
 - bin/framecurve_validator
 - framecurve.gemspec
 - lib/framecurve.rb
 - lib/framecurve/comment.rb
 - lib/framecurve/curve.rb
+- lib/framecurve/extractors/fcp_xml.rb
+- lib/framecurve/extractors/xml_bridge.rb
 - lib/framecurve/parser.rb
 - lib/framecurve/serializer.rb
 - lib/framecurve/tuple.rb
 - lib/framecurve/validator.rb
+- test/fixtures/fcp_xml/CountDOWN.xml
+- test/fixtures/framecurves/err-neg-frames.framecurve.txt
+- test/fixtures/framecurves/err-no-tuples.framecurve.txt
+- test/fixtures/framecurves/incorrect.extension
+- test/fixtures/framecurves/sample_framecurve1.framecurve.txt
 - test/helper.rb
 - test/test_framecurve_comment.rb
 - test/test_framecurve_curve.rb
+- test/test_framecurve_from_fcp_xml_binary.rb
 - test/test_framecurve_parser.rb
 - test/test_framecurve_serializer.rb
 - test/test_framecurve_tuple.rb