framecurve 2.0.0 → 2.1.0

data/History.txt

@@ -1,3 +1,7 @@
+2.1.0
+
+* Adds Validator#ok?
+
 2.0.0
 
 * Added a FinalCut extractor, plus some bugfixes

data/bin/framecurve_validator

@@ -18,7 +18,7 @@ ARGV.each do | arg |
   validator = Framecurve::Validator.new
   validator.parse_and_validate(arg)
   
-  unless validator.any_errors? || validator.any_warnings?
+  if validator.ok?
     puts Color.green { "Framecurve file %s TOTALLY OK! Good job!" % arg }
   else
     $stderr.puts Color.bold{ arg }

data/framecurve.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "framecurve"
-  s.version = "2.0.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik"]
-  s.date = "2012-01-08"
+  s.date = "2012-01-10"
   s.description = " Parser, validation and interpolation"
   s.email = "me@julik.nl"
   s.executables = ["framecurve_from_fcp_xml", "framecurve_validator"]

data/lib/framecurve.rb

@@ -1,5 +1,5 @@
 module Framecurve
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
   
   # Is raised when a malformed framecurve bit has occurred in the system
   class Malformed < RuntimeError

data/lib/framecurve/validator.rb

@@ -7,7 +7,7 @@ class Framecurve::Validator
   attr_reader :warnings, :errors
   
   def initialize
-    @warnings, @errors = [], []
+    @warnings, @errors, @performed = [], [], false
   end
   
   # Tells whether this validator instance has any errors
@@ -35,6 +35,12 @@ class Framecurve::Validator
     methods_matching(/^(verify|recommend)/).each do | method_name |
       method(method_name).call(curve)
     end
+    @performed = true
+  end
+  
+  # Returns true if validation has been performed and there are no warnings and no errors
+  def ok?
+    @performed && !any_errors? && !any_warnings?
   end
   
   private

data/test/test_framecurve_validator.rb

@@ -72,6 +72,7 @@ class TestFramecurveValidator < Test::Unit::TestCase
     c = Framecurve::Curve.new( Framecurve::Tuple.new(10, 123.4), Framecurve::Tuple.new(1, 123.4) )
     v = Framecurve::Validator.new
     v.validate(c)
+    assert !v.ok?
     assert v.any_errors?
     assert_equal ["The frame sequencing is out of order (expected [1, 10] but got [10, 1]). The framecurve spec mandates that frames are recorded sequentially"], v.errors
   end
@@ -83,24 +84,28 @@ class TestFramecurveValidator < Test::Unit::TestCase
     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 !v.ok?
     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 !v.ok?
     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 !v.ok?
     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 !v.ok?
     assert_equal ["The framecurve did not contain any frame correlation records"], v.errors
   end
   
@@ -109,6 +114,7 @@ class TestFramecurveValidator < Test::Unit::TestCase
     v = Framecurve::Validator.new
     v.validate(c)
     assert v.any_warnings?
+    assert !v.ok?
     assert_equal "It is recommended that a framecurve starts with a comment with the specification URL", v.warnings[0]
   end
   
@@ -116,8 +122,19 @@ class TestFramecurveValidator < Test::Unit::TestCase
     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.ok?
     assert v.any_warnings?
     assert_equal "It is recommended for the second comment to provide a column header", v.warnings[0]
   end
   
+  def test_should_parse_well
+    c = Framecurve::Curve.new( 
+      Framecurve::Comment.new("http://framecurve.org/specification-v1"), 
+      Framecurve::Comment.new("at_frame\tuse_frame_of_source"), 
+      Framecurve::Tuple.new(10, 123.4)
+    )
+    v = Framecurve::Validator.new
+    v.validate(c)
+    assert v.ok?
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framecurve
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-08 00:00:00.000000000 Z
+date: 2012-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &11839020 !ruby/object:Gem::Requirement
+  requirement: &12017030 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11839020
+  version_requirements: *12017030
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &11838780 !ruby/object:Gem::Requirement
+  requirement: &12016790 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *11838780
+  version_requirements: *12016790
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &11838540 !ruby/object:Gem::Requirement
+  requirement: &12016550 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11838540
+  version_requirements: *12016550
 - !ruby/object:Gem::Dependency
   name: cli_test
-  requirement: &11838300 !ruby/object:Gem::Requirement
+  requirement: &12016310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11838300
+  version_requirements: *12016310
 description: ! ' Parser, validation and interpolation'
 email: me@julik.nl
 executables: