tickly 1.0.0 → 2.0.0

data/Gemfile

@@ -5,9 +5,9 @@ gem "bychar", "~> 1.2"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "rake"
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"
-  gem "bundler"
   gem "jeweler", "~> 1.8.3"
   gem "ruby-prof"
 end

data/Rakefile

@@ -46,3 +46,21 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Profiles the parser"
+task :profile do
+  require 'ruby-prof'
+  p = Tickly::NodeProcessor.new
+  f = File.open(File.dirname(__FILE__) + "/test/test-data/huge_nuke_tcl.tcl")
+
+  RubyProf.start
+  p.parse(f) {|_| }
+  result = RubyProf.stop
+
+  # Print a call graph
+  File.open("profiler_calls.html", "w") do | f |
+    RubyProf::GraphHtmlPrinter.new(result).print(f)
+  end
+  `open profiler_calls.html`
+end
+

data/lib/tickly/evaluator.rb

@@ -49,7 +49,7 @@ module Tickly
     # at the end of the method. This method evaluates one expression at a time
     # (it's more of a pattern matcher really)
     def evaluate(expr)
-      if multiple_atoms?(expr) && has_subcommand?(expr) && has_handler?(expr) 
+      if will_capture?(expr)
         handler_class = @node_handlers.find{|e| unconst_name(e) == expr[0]}
         handler_arguments = expr[1]
         hash_of_args = {}
@@ -68,6 +68,12 @@ module Tickly
       end
     end
     
+    # Tells whether this Evaluator will actually instantiate
+    # anything from the passed expression
+    def will_capture?(expr)
+      multiple_atoms?(expr) && has_subcommand?(expr) && has_handler?(expr) 
+    end
+    
     private
     
     def multiple_atoms?(expr)

data/lib/tickly/node_processor.rb

@@ -0,0 +1,81 @@
+module Tickly
+  # A combination of a Parser and an Evaluator
+  # Evaluates a passed Nuke script without expanding it's inner arguments.
+  # The TCL should look like Nuke's node commands:
+  #
+  #   NodeClass { 
+  #     foo bar
+  #     baz bad
+  #   }
+  #
+  # You have to add the Classes that you want to instantiate for nodes using add_node_handler_class
+  # and every time the parser encounters that node the node will be instantiated
+  # and the node options (actually TCL commands) will be passed to the constructor,
+  # as a Ruby Hash with string keys. 
+  # Every value of the knobs hash will be the AST as returned by the Parser.
+  #
+  #    class Blur
+  #      def initialize(knobs_hash)
+  #         puts knobs_hash.inspect
+  #      end
+  #    end
+  #    
+  #    e = Tickly::NodeProcessor.new
+  #    e.add_node_handler_class Blur
+  #    e.parse(File.open("/path/to/script.nk")) do | blur_node |
+  #      # do whatever you want to the node instance
+  #      end
+  #    end
+  class NodeProcessor
+    def initialize
+      @evaluator = Tickly::Evaluator.new
+      @parser = Ratchet.new
+      @parser.expr_callback = method(:filter_expression)
+    end
+    
+    # Add a Class object that can instantiate node handlers. The last part of the class name
+    # has to match the name of the Nuke node that you want to capture.
+    # For example, to capture Tracker3 nodes a name like this will do:
+    #     Whatever::YourModule::Better::Tracker3
+    def add_node_handler_class(class_object)
+      @evaluator.add_node_handler_class(class_object)
+    end
+    
+    # Parses from the passed IO or string and yields every node
+    # that has been instantiated
+    def parse(io_or_str, &nuke_node_callback)
+      raise LocalJumpError, "NodeProcesssor#parse totally requires a block" unless block_given?
+      @node_handler = nuke_node_callback
+      @parser.parse(io_or_str)
+    end
+    
+    private
+    
+    class Ratchet < Parser #:nodoc: :all
+      attr_accessor :expr_callback
+      def compact_subexpr(expr, at_depth)
+        expr_callback.call(expr, at_depth)
+      end
+    end
+    
+    def filter_expression(expression, at_depth)
+      # Leave all expressions which are deeper than 1
+      # intact
+      return expression if at_depth > 1
+      
+      # Skip all nodes which are not interesting for
+      # the evaluator to do
+      unless @evaluator.will_capture?(expression)
+        return nil # Do not even keep it in memory
+      end
+      
+      # And immediately evaluate
+      # TODO: also yield it!
+      node_instance = @evaluator.evaluate(expression)
+      @node_handler.call(node_instance)
+      
+      # Still return nil
+      return nil
+    end
+  end
+end

data/lib/tickly/parser.rb

@@ -25,9 +25,11 @@ module Tickly
       sub_parse(reader, stop_char = nil, stack_depth = 0, multiple_expressions = true)
     end
     
-    # Override this to remove any unneeded subexpressions Modify the passed expr
-    # array in-place.
-    def expand_subexpr!(expr, at_depth)
+    # Override this to remove any unneeded subexpressions.
+    # Return the modified expression. If you return nil, the result
+    # will not be added to the expression list
+    def compact_subexpr(expr, at_depth)
+      expr
     end
     
     private
@@ -44,7 +46,6 @@ module Tickly
       return stack unless multiple_expressions
       
       expressions << stack if stack.any?
-      expressions.each { |expr| expand_subexpr!(expr, stack_depth + 1) }
       
       return expressions
     end
@@ -73,8 +74,13 @@ module Tickly
           end
           if TERMINATORS.include?(char) && stack.any? && !last_char_was_linebreak # Introduce a stack separator! This is a new line
             stack << buf if buf.length > 0
-            expressions << stack
+            # Immediately run this expression through the filter
+            filtered_expr = compact_subexpr(stack, stack_depth + 1)
             stack = []
+            
+            # Only preserve the parsed expression if it's not nil
+            expressions << filtered_expr unless filtered_expr.nil?
+            
             last_char_was_linebreak = true
             multiple_expressions = true
             #puts "Next expression! #{expressions.inspect} #{stack.inspect} #{buf.inspect}"

data/lib/tickly.rb

@@ -1,11 +1,10 @@
 require File.dirname(__FILE__) + "/tickly/parser"
-require File.dirname(__FILE__) + "/tickly/node_extractor"
 require File.dirname(__FILE__) + "/tickly/evaluator"
 require File.dirname(__FILE__) + "/tickly/curve"
-require 'forwardable'
+require File.dirname(__FILE__) + "/tickly/node_processor"
 
 module Tickly
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
   
   # Provides the methods for quickly emitting the expression arrays,
   # is used in tests

data/test/test_evaluator.rb

@@ -15,7 +15,7 @@ class TestEvaluator < Test::Unit::TestCase
     end
   end
   
-  should "not send anything to the handler when the expr does not conform to the standard" do
+  def test_does_not_send_anything_when_the_expression_passed_does_not_match_pattern
     stack = e("ShouldNotBeInstantiated")
     e = Tickly::Evaluator.new
     e.add_node_handler_class(ShouldNotBeInstantiated)
@@ -56,5 +56,15 @@ class TestEvaluator < Test::Unit::TestCase
       end
     end
   end
+  
+  def test_will_capture
+    e = Tickly::Evaluator.new
+    e.add_node_handler_class(SomeNode)
+    
+    valid = e("SomeNode", le(e("foo", "bar"), e("baz", "bad")))
+    assert e.will_capture?(valid)
+    assert !e.will_capture?([])
+    assert !e.will_capture?(e("SomeNode"))
+  end
 
 end

data/test/test_node_processor.rb

@@ -0,0 +1,36 @@
+require 'helper'
+
+class TestParserEvaluator < Test::Unit::TestCase
+  include Tickly::Emitter
+  
+  NUKE7_SCRIPT = File.open(File.dirname(__FILE__) + "/test-data/nuke7_tracker_2tracks.nk")
+  
+  class Tracker4
+    attr_reader :knobs
+    def initialize(knobs)
+      @knobs = knobs
+    end
+  end
+  
+  class NodeCaptured < RuntimeError; end
+  
+  def test_processes_nodes
+    pe = Tickly::NodeProcessor.new
+    pe.add_node_handler_class(Tracker4)
+    
+    assert_raise(NodeCaptured) do
+      pe.parse(NUKE7_SCRIPT) do | node |
+        
+        assert_kind_of Tracker4, node
+        assert_equal "Tracker1", node.knobs["name"]
+        
+        raise NodeCaptured
+      end
+    end
+  end
+  
+  def test_raises_without_a_block
+    pe = Tickly::NodeProcessor.new
+    assert_raise(LocalJumpError) { pe.parse(NUKE7_SCRIPT) }
+  end
+end

data/test/test_parser.rb

@@ -91,6 +91,31 @@ class TestParser < Test::Unit::TestCase
     assert_equal blur, p[4]
   end
   
+  class Discarder < Tickly::Parser
+    def compact_subexpr(expr, depth)
+      return :discarded
+    end
+  end
+  
+  class Eater < Tickly::Parser
+    def compact_subexpr(e, d)
+      nil
+    end
+  end
+  
+  def test_passes_expressions_via_compact_subexpr
+    f = File.open(File.dirname(__FILE__) + "/test-data/three_nodes_and_roto.txt")
+    p = Discarder.new.parse(f)
+    assert_equal [:discarded, :discarded, :discarded, :discarded, :discarded], p
+  end
+  
+  def test_removes_all_the_expressions_compacted_into_nil
+    f = File.open(File.dirname(__FILE__) + "/test-data/three_nodes_and_roto.txt")
+    p = Eater.new.parse(f)
+    assert_equal [], p
+  end
+  
+  
   def test_parsing_nuke_script_with_indentations
     f = File.open(File.dirname(__FILE__) + "/test-data/nuke_group.txt")
     p = P.parse(f)

data/tickly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "tickly"
-  s.version = "1.0.0"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2013-03-17"
+  s.date = "2013-03-21"
   s.description = "Parses the subset of the TCL grammar needed for Nuke scripts"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
     "lib/tickly.rb",
     "lib/tickly/curve.rb",
     "lib/tickly/evaluator.rb",
-    "lib/tickly/node_extractor.rb",
+    "lib/tickly/node_processor.rb",
     "lib/tickly/parser.rb",
     "test/helper.rb",
     "test/test-data/huge_nuke_tcl.tcl",
@@ -41,9 +41,8 @@ Gem::Specification.new do |s|
     "test/test-data/tracker_with_repeating_gaps.nk",
     "test/test_curve.rb",
     "test/test_evaluator.rb",
-    "test/test_node_extractor.rb",
+    "test/test_node_processor.rb",
     "test/test_parser.rb",
-    "test/test_profile.rb",
     "tickly.gemspec"
   ]
   s.homepage = "http://github.com/julik/tickly"
@@ -57,24 +56,24 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<bychar>, ["~> 1.2"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<ruby-prof>, [">= 0"])
     else
       s.add_dependency(%q<bychar>, ["~> 1.2"])
+      s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_dependency(%q<ruby-prof>, [">= 0"])
     end
   else
     s.add_dependency(%q<bychar>, ["~> 1.2"])
+    s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     s.add_dependency(%q<ruby-prof>, [">= 0"])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tickly
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-17 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bychar
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -44,37 +44,37 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: shoulda
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +124,7 @@ files:
 - lib/tickly.rb
 - lib/tickly/curve.rb
 - lib/tickly/evaluator.rb
-- lib/tickly/node_extractor.rb
+- lib/tickly/node_processor.rb
 - lib/tickly/parser.rb
 - test/helper.rb
 - test/test-data/huge_nuke_tcl.tcl
@@ -139,9 +139,8 @@ files:
 - test/test-data/tracker_with_repeating_gaps.nk
 - test/test_curve.rb
 - test/test_evaluator.rb
-- test/test_node_extractor.rb
+- test/test_node_processor.rb
 - test/test_parser.rb
-- test/test_profile.rb
 - tickly.gemspec
 homepage: http://github.com/julik/tickly
 licenses:
@@ -158,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 748629881843892716
+      hash: 4279008670880210764
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/tickly/node_extractor.rb

@@ -1,22 +0,0 @@
-module Tickly
-  # A more refined version of the Parser class that can scope itself to the passed Nuke node
-  # classnames. It will toss all of the node data that is not relevant, keeping only nodes that are
-  # required.
-  class NodeExtractor < Parser
-    def initialize(*interesting_node_class_names)
-      @nodes = interesting_node_class_names
-    end
-    
-    # Override this to remove any unneeded subexpressions
-    def expand_subexpr!(expr, at_depth)
-      if is_node_constructor?(expr, at_depth)
-        node_class_name = expr[0]
-        expr.replace([:discarded]) unless @nodes.include?(node_class_name)
-      end
-    end
-    
-    def is_node_constructor?(expr, depth)
-      depth == 1 && expr[0].is_a?(String) && expr.length == 2 && expr[1][0] == :c
-    end
-  end
-end

data/test/test_node_extractor.rb

@@ -1,30 +0,0 @@
-require 'helper'
-
-class TestNodeExtractor < Test::Unit::TestCase
-  
-  include Tickly::Emitter
-  
-  def test_parsing_nuke_script_with_indentations
-    f = File.open(File.dirname(__FILE__) + "/test-data/nuke_group.txt")
-    x = Tickly::NodeExtractor.new("Group")
-    
-    p = x.parse(f)
-    grp = e(
-      e("set", "cut_paste_input", se("stack", "0")),
-      e("version", "6.3", "v4"),
-      e("Group",
-        le(
-          e("inputs", "0"),
-          e("name", "Group1"),
-          e("selected", "true")
-          )
-        ),
-      e(:discarded),
-      e(:discarded),
-      e(:discarded),
-      e("end_group")
-    )
-    assert_equal grp, p
-  end
-  
-end

data/test/test_profile.rb

@@ -1,27 +0,0 @@
-require 'helper'
-
-if ENV['USER'] == 'julik'
-
-  require 'ruby-prof'
-
-  class TestProfile < Test::Unit::TestCase
-    P = Tickly::Parser.new
-  
-  
-    def test_huge_tcl
-      f = File.open(File.dirname(__FILE__) + "/test-data/huge_nuke_tcl.tcl")
-    
-      RubyProf.start
-      P.parse(f)
-      result = RubyProf.stop
-    
-      # Print a call graph
-      File.open("profiler_calls.html", "w") do | f |
-        RubyProf::GraphHtmlPrinter.new(result).print(f)
-      end
-      `open profiler_calls.html`
-    end
-  
-  end
-
-end