tickly 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 178bbaee09a8714a619462a767a15dc86284e039
-  data.tar.gz: 8d5d22b037fb58ad14593b246579a74d3b725d63
+  metadata.gz: dab8e9284b9ac1080b3870bc306b07eff3a27822
+  data.tar.gz: f908bafd3590bdcc34a0fa3a53f7830295cee2cb
 SHA512:
-  metadata.gz: 4c81568f20334cbdfd0265130f15d0420d46d6633fef1baf1c5cdd869bcb492666ce6058da2919e3a5e75600b378c4003002d6c24f070d79914412e36d25b374
-  data.tar.gz: cc2bc355e7c6bac3cb25d93616ccc8c5d9e84643213f1c4368c52c77b3a089799988a0d532cc5451bfa545d6a0d8254a238a4d7060800976e3ac920a41ea387f
+  metadata.gz: f47268cfe9c25315ee58f64c9ebad472db545786df1c63ba6929ad123b6d2a71de90073adc639267598f960ba595c40601cf4891e62f94a71d4da0f57567b553
+  data.tar.gz: 699f16255741459e8e2e574c3230a2c432c6dc682a91fe4dcf759967e81268ac20254945004d57e77b4b80acbd4f4d019deeeed09d17e6c73362bf38c4bf7c50

data/Gemfile

@@ -8,5 +8,6 @@ group :development do
   gem "rake"
   gem "rdoc", "~> 3.12"
   gem "jeweler", "~> 1.8.7"
-  gem "ruby-prof"
+  # Use the older ruby-prof that still supports 1.8.7
+  gem "ruby-prof", '0.13.0'
 end

data/{README.rdoc → README.md}

@@ -1,5 +1,3 @@
-= tickly
-
 A highly simplistic TCL parser and evaluator (primarily designed for parsing Nuke scripts).
 It transforms the passed Nuke scripts into a TCL AST. 
 It also supports some cheap tricks to discard the nodes you are not interested in, since Nuke
@@ -7,7 +5,7 @@ scripts easily grow into tens of megabytes.
 
 The AST format is extremely simple (nested arrays).
 
-== Plain parsing
+## Plain parsing
 
 Create a Parser object and pass TCL expressions/scripts to it. You can pass IO obejcts or strings. Note that parse()
 will always return an Array of expressions, even if you only fed it one expression line. For example:
@@ -30,8 +28,9 @@ will always return an Array of expressions, even if you only fed it one expressi
     p.parse '{exec cmd [fileName]}' #=> [[:c, "exec", "cmd", [:b, "fileName"]]]
 
 The AST is represented by simple arrays. Each TCL expression becomes an array. An array starting 
-with the :c symbol ("c" for "curlies") is a literal expression in curly braces ({}). An array with the
-:b symbol at the beginning is an expression with string interpolations (square brackets).
+with the `:c` symbol ("c" for "curlies") is a literal expression in curly braces (`{}`). 
+An array with the `:b` symbol at the beginning is an expression with string interpolations 
+(square brackets).
 All the other array elements are guaranteed to be strings or innner expressions (arrays).
 
 String literals are expanded to string array elements.
@@ -40,10 +39,10 @@ String literals are expanded to string array elements.
 
 Multiple expressions separated by semicolons or newlines will be accumulated as multiple arrays.
 
-Lots and lots of TCL features are probably not supported - remember that most Nuke scripts are machine-generated and they do not
-use most of the esoteric language features.
+Lots and lots of TCL features are probably not supported - remember that most Nuke scripts are 
+machine-generated and they do not use most of the esoteric language features.
 
-== Evaulating nodes in Nuke scripts
+## Evaulating nodes in Nuke scripts
 
 What you are likely to use Tickly for is parsing Nuke scripts. They got multiple node definitions, which
 are actially arguments for a node constructor written out in TCL. Consider this ubiquitous fragment for a
@@ -58,7 +57,7 @@ hypothetic SomeNode in your script:
       y_pos -10
     }
 
-and so on. You can use a +NodeProcessor+ to capture these node constructors right as they are being parsed.
+and so on. You can use a `NodeProcessor` to capture these node constructors right as they are being parsed.
 The advantage of this workflow is that the processor will discard all the nodes you don't need, saving time
 and memory.
 
@@ -100,12 +99,12 @@ nodes containing tracking data:
     parser.add_node_handler_class(PlanarTracker1_0)
     parser.add_node_handler_class(Tracker4)
 
-== Animation curves
+## Animation curves
 
 You can parse Nuke's animation curves using Tickly::Curve. This will give you a way to iterate over every defined keyframe.
 This currently does not happen automatically for things passing through the parser.
 
-== Contributing to tickly
+## Contributing to tickly
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -115,7 +114,7 @@ This currently does not happen automatically for things passing through the pars
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2013 Julik Tarkhanov. See LICENSE.txt for
 further details.

data/lib/tickly.rb

@@ -4,5 +4,5 @@ require File.dirname(__FILE__) + "/tickly/curve"
 require File.dirname(__FILE__) + "/tickly/node_processor"
 
 module Tickly
-  VERSION = '2.1.4'
+  VERSION = '2.1.5'
 end

data/lib/tickly/curve.rb

@@ -22,10 +22,18 @@ module Tickly
       # Nuke7 sometimes produces curves where the command is a string literal 
       # within quotes, and it contains a trailing space
       cmd = curve_expression[1].to_s.strip
-      raise InvalidCurveError, "Curve expression should start with a 'curve' command" unless cmd == 'curve'
+      raise InvalidCurveError, "Curve expression should start with a 'curve' command" unless cmd =~ /^curve/
       
+      # Compute the curve increment or decrement. It looks like a modifier:
+      # "curve+5" means we have to add 5 to every value on the curve
+      xformer = lambda { |v| v} # Identity
+      if cmd =~ /^(curve)([+-])([\d\.]+)$/
+        operator = $2[0..1] # Ensure only one character gets through
+        modifier = $3.to_f
+        xformer = lambda{|v| v.send(operator, modifier) }
+      end
       
-      expand_curve(curve_expression)
+      expand_curve(curve_expression, &xformer)
     end
     
     # Returns each defined keyframe as a pair of a frame number and a value
@@ -35,15 +43,17 @@ module Tickly
     
     private
     
-    def expand_curve(curve_expression)
+    def expand_curve(curve_expression, &post_lambda)
       # Replace the closing curly brace with a curly brace with space so that it gets caught by split
       atoms = curve_expression[2..-1] # remove the :c curly designator and the "curve" keyword
       
       @tuples = []
-      # Nuke saves curves very efficiently. x(keyframe_number) means that an uninterrupted sequence of values will start,
-      # after which values follow. When the curve is interrupted in some way a new x(keyframe_number) will signifu that we
-      # skip to that specified keyframe and the curve continues from there, in gap size defined by the last fragment.
-      # That is, x1 1 x3 2 3 4 will place 2, 3 and 4 at 2-frame increments.
+      # Nuke saves curves very efficiently. x(keyframe_number) means that an 
+      # uninterrupted sequence of values will start, after which values follow. 
+      # When the curve is interrupted in some way a new x(keyframe_number) will 
+      # signify that we skip to that specified keyframe and the curve continues
+      # from there, in gap size defined by the last fragment. That is, 
+      # x1 1 x3 2 3 4 will place 2, 3 and 4 at 2-frame increments.
       # Thanks to Michael Lester for explaining this.
       last_processed_keyframe = 1
       intraframe_gap_size = 1
@@ -55,7 +65,7 @@ module Tickly
             intraframe_gap_size = last_processed_keyframe - last_captured_frame
           end
         elsif  atom =~ KEYFRAME
-          @tuples << [last_processed_keyframe, $1.to_f]
+          @tuples << [last_processed_keyframe, yield($1.to_f)]
           last_processed_keyframe += intraframe_gap_size
         end
       end

data/lib/tickly/parser.rb

@@ -45,7 +45,7 @@ module Tickly
     ESC = 92.chr # Backslash (\)
     QUOTES = %w( " ' )
     
-    # TODO: this has to go into Bychar. We should not use exprs for flow control.
+    # TODO: this has to go into Bychar. We should not use exceptions for flow control.
     class R #:nodoc: :all
       def initialize(bychar)
         @bychar = bychar
@@ -157,7 +157,7 @@ module Tickly
         c = io.read_one_char
         if c.nil?
           raise Error, "The IO ran out before the end of a literal string"
-        elsif buf.length > 0 && last_char(buf) == ESC # If this char was escaped
+        elsif buf.length > 0 && buf[-1..-1] == ESC # If this char was escaped
           # Trim the escape character at the end of the buffer
           buf = buf[0..-2] 
           buf << c
@@ -168,9 +168,5 @@ module Tickly
         end
       end
     end
-    
-    def last_char(str)
-      RUBY_VERSION < '1.9' ? str[-1].chr : str[-1]
-    end
   end
 end

data/test/test_curve.rb

@@ -15,6 +15,15 @@ x754 912.0731812 x755 913.7190552 916.0959473 918.1025391 920.0751953 922.189880
     assert_equal 754, result[7][0]
   end
   
+  def test_curve_plus
+    curve = [:c] + %w( curve+5 x1 987 x32 989.5999756 )
+      
+    p = Tickly::Curve.new(curve)
+    result = p.to_a
+    assert_kind_of Array, result
+    assert_equal [[1, 992.0], [32, 994.5999756]], result
+  end
+    
   def test_invalid_curves
     assert_raise Tickly::Curve::InvalidCurveError do
       Tickly::Curve.new([])

data/tickly.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = "tickly"
-  s.version = "2.1.4"
+  s.version = "2.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2013-12-06"
+  s.date = "2014-03-04"
   s.description = "Parses the subset of the TCL grammar needed for Nuke scripts"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "lib/tickly.rb",
     "lib/tickly/curve.rb",
@@ -63,20 +63,20 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_development_dependency(%q<ruby-prof>, [">= 0"])
+      s.add_development_dependency(%q<ruby-prof>, ["= 0.13.0"])
     else
       s.add_dependency(%q<bychar>, ["~> 2"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_dependency(%q<ruby-prof>, [">= 0"])
+      s.add_dependency(%q<ruby-prof>, ["= 0.13.0"])
     end
   else
     s.add_dependency(%q<bychar>, ["~> 2"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-    s.add_dependency(%q<ruby-prof>, [">= 0"])
+    s.add_dependency(%q<ruby-prof>, ["= 0.13.0"])
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tickly
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2014-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bychar
@@ -70,29 +70,29 @@ dependencies:
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
 description: Parses the subset of the TCL grammar needed for Nuke scripts
 email: me@julik.nl
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .travis.yml
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/tickly.rb
 - lib/tickly/curve.rb