tickly 2.1.6 → 2.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5507beab7129bc0fab4875bad56c60d27da4613
-  data.tar.gz: 3335803e4bf7621e151838262f4b096bced5bf44
+SHA256:
+  metadata.gz: 79dee9e082c21c3cb365af477c63168331c4576e978c58ebff856daedce3a746
+  data.tar.gz: 8d11fdb50e734105ae5b9dbf82a866252748ce6fe7c2b910b8f833935051164f
 SHA512:
-  metadata.gz: d343db5ed8d576c3c4220724864d908a8ce45f1db9370773563d432108ed251bd600a8d6d7506863a78e4665483aa890b8e6c72e6517c344ff2ac501113ead0c
-  data.tar.gz: 23cb0139524770b959c259f4e19f2cc5d78c17657507037e93b92c1a1d80fc878a864e73f80d1b21b7002357e64d7d68afe50caeb4d0dbcadcb68d616f1711a5
+  metadata.gz: 410ac1d060bf206c34bc58a7a9ad2a324ad32835a283f0120782353ddd37e1b794bc80037cfaa717cc6767f283cb8022b70e747e0ae21c6c7265e97c867c07c7
+  data.tar.gz: c07d44ac24fb4d9fa666d38f95a2fda2e6976ab5e18beba7951fb40bb2b66fee3fc4c2069367aefb644bfbe4bf6f9697867e8a5d16db61c6a2b247dfa8f7cb40

data/.gitignore

@@ -0,0 +1,52 @@
+Gemfile.lock
+profiler_calls.html
+
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.travis.yml

@@ -2,4 +2,8 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - 2.0.0-p247
+  - 2.0.0-p247
+  - 2.1.5
+  - 2.2.2
+cache: bundler
+sudo: false

data/Gemfile

@@ -1,11 +1,3 @@
 source "http://rubygems.org"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rake"
-  gem "rdoc", "~> 3.12"
-  gem "jeweler", "~> 1.8.7"
-  # Use the older ruby-prof that still supports 1.8.7
-  gem "ruby-prof", '0.13.0'
-end
+gemspec

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/julik/tickly.svg?branch=master)](https://travis-ci.org/julik/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
@@ -64,10 +66,10 @@ and memory.
 To match nodes you create Ruby classes matching the node classes by name. It doesn't matter if your
 custom node handler is inside a module since the processor will only use the last part of the name.
 
-For example, to capture every +SomeNode+ in your script:
+For example, to capture every `Blur` node in your script:
     
     # Remember, only the last part of the class name matters
-    class MyAwesomeDirtyScript::SomeNode
+    class MyAwesomeDirtyScript::Blur
       attr_reader :knobs
       def initialize(string_keyed_knobs_hash)
         @knobs = string_keyed_knobs_hash
@@ -83,10 +85,10 @@ For example, to capture every +SomeNode+ in your script:
     # Open the ginormous Nuke script
     file = File.open("/mnt/raid/nuke/scripts/HugeShot_123.nk")
     
-    e.parse(file) do | every_some_node |
-      # Everytime a SomeNode is found in the script it will be instantiated,
+    e.parse(file) do | blur_node |
+      # Everytime a Blur node is found in the script it will be instantiated,
       # and the knobs of the node will be passed to the constructor that you define
-      x_position = every_some_node.knobs["x_pos"]
+      kernel_size = blur_node.knobs["radius"]
       ...
     end
 
@@ -99,11 +101,41 @@ nodes containing tracking data:
     parser.add_node_handler_class(PlanarTracker1_0)
     parser.add_node_handler_class(Tracker4)
 
+Then you will need to handle switching between node types during parsing
+
+    e.parse(file) do | detected_node |
+      if detected_node.is_a?(Tracker3)
+	    ...
+	  else
+	    ...
+	  end
+    end
+
+Node clones are not supported.
+
 ## Animation curves
 
-You can parse Nuke's animation curves using Tickly::Curve. This will give you a way to iterate over every defined keyframe.
+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.
 
+## Tip: Speeding up parsing
+
+Normally, Tickly will accept strings and IO objects as sources. However if you want a little performance boost
+when parsing actual _files_ (or long IO objects that can be prebuffered) you should use it together
+with [bychar](http://rubygems.org/gems/bychar), version 3 or newer - like so:
+
+    p = Tickly::Parser.new
+    File.open("/mnt/raid/comps/s023_v23.nk", "r") do | f |
+	  expressions = p.parse(Bychar.wrap(f))
+	  ...
+	end
+	
+This way some of the IO will be prebuffered for you and give you improved reading performance when parsing.
+
+Tracksperanto does the bychar wrapping thing automatically, so no need to worry about that.
+
+
+
 ## Contributing to tickly
 
 Just like tracksperanto Tickly no longer ships with test data in gem format (since the test data amounts to

data/Rakefile

@@ -1,36 +1,5 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-require File.dirname(__FILE__) + "/lib/tickly"
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.version = Tickly::VERSION
-  gem.name = "tickly"
-  gem.homepage = "http://github.com/julik/tickly"
-  gem.license = "MIT"
-  gem.summary = %Q{Assists in parsing Nuke scripts in TCL}
-  gem.description = %Q{Parses the subset of the TCL grammar needed for Nuke scripts}
-  gem.email = "me@julik.nl"
-  gem.authors = ["Julik Tarkhanov"]
-  # dependencies defined in Gemfile
-  
-  # Do not package test data
-  gem.files.exclude "test/test-data/*.*"
-end
-
-Jeweler::RubygemsDotOrgTasks.new
+require "bundler/gem_tasks"
+require 'rake/testtask'
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -39,8 +8,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :default => :test
-
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
@@ -51,20 +18,26 @@ Rake::RDocTask.new do |rdoc|
   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")
+desc "Benchmarks the parser"
+task :bench do
+  require File.dirname(__FILE__) + "/lib/tickly"
+  require 'benchmark'
 
-  RubyProf.start
-  p.parse(f) {|_| }
-  result = RubyProf.stop
+  class Tracker3
+    def initialize(n); end
+  end
 
-  # Print a call graph
-  File.open("profiler_calls.html", "w") do | f |
-    RubyProf::GraphHtmlPrinter.new(result).print(f)
+  pe = Tickly::NodeProcessor.new
+  pe.add_node_handler_class(Tracker3)
+  
+  HUGE_SCRIPT = File.open(File.dirname(__FILE__) + "/test/test-data/huge_nuke_tcl.tcl", "rb")
+  Benchmark.bm do | runner |
+    runner.report("Parsing a huge Nuke script:") do
+      counter = 0
+      pe.parse(HUGE_SCRIPT) { counter += 1 }
+      HUGE_SCRIPT.rewind
+    end
   end
-  `open profiler_calls.html`
 end
 
+task :default => [:test, :bench]

data/lib/tickly.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + "/tickly/parser"
 require File.dirname(__FILE__) + "/tickly/evaluator"
 require File.dirname(__FILE__) + "/tickly/curve"
 require File.dirname(__FILE__) + "/tickly/node_processor"
+require File.dirname(__FILE__) + "/tickly/version"
 
 module Tickly
-  VERSION = '2.1.6'
 end

data/lib/tickly/version.rb

@@ -0,0 +1,3 @@
+module Tickly
+  VERSION = "2.1.7"
+end

data/test/test_benchmark.rb

@@ -3,19 +3,5 @@ require 'benchmark'
 
 class TestParserEvaluator < Test::Unit::TestCase
   
-  class Tracker3
-    def initialize(n); end
-  end
-
-  def test_parses_huge
-    pe = Tickly::NodeProcessor.new
-    pe.add_node_handler_class(Tracker3)
-    
-    Benchmark.bm do | runner |
-      runner.report("Parsing a huge Nuke script:") do
-        counter = 0
-        pe.parse(HUGE_SCRIPT) { counter += 1 }
-      end
-    end
-  end
+  
 end

data/test/test_emitter.rb

@@ -13,7 +13,7 @@ class TestEmitter < Test::Unit::TestCase
     assert_equal [:b, "2", "2"], se("2", "2")
   end
   
-  def test_emitter_be
+  def test_emitter_be_with_subexpression
     assert_equal [:b, [:c,"2", "2"]], se(le("2", "2"))
   end
   

data/tickly.gemspec

@@ -1,68 +1,30 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: tickly 2.1.6 ruby lib
+require File.dirname(__FILE__) + '/lib/tickly/version'
 
 Gem::Specification.new do |s|
   s.name = "tickly"
-  s.version = "2.1.6"
+  s.version = Tickly::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2014-12-10"
+  s.date = Time.now.utc.strftime("%Y-%m-%d")
   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.md"
   ]
-  s.files = [
-    ".document",
-    ".travis.yml",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "lib/tickly.rb",
-    "lib/tickly/curve.rb",
-    "lib/tickly/evaluator.rb",
-    "lib/tickly/node_processor.rb",
-    "lib/tickly/parser.rb",
-    "test/helper.rb",
-    "test/test_benchmark.rb",
-    "test/test_curve.rb",
-    "test/test_emitter.rb",
-    "test/test_evaluator.rb",
-    "test/test_node_processor.rb",
-    "test/test_parser.rb",
-    "tickly.gemspec"
-  ]
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.start_with? "test/test-data/"
+  end
   s.homepage = "http://github.com/julik/tickly"
   s.licenses = ["MIT"]
   s.rubygems_version = "2.2.2"
   s.summary = "Assists in parsing Nuke scripts in TCL"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      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.13.0"])
-    else
-      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.13.0"])
-    end
-  else
-    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.13.0"])
-  end
+  s.specification_version = 4
+  s.add_development_dependency("rake", [">= 0"])
+  s.add_development_dependency("rdoc", ["~> 3.12"])
+  s.add_development_dependency("ruby-prof")
+  s.add_development_dependency("test-unit")
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tickly
 version: !ruby/object:Gem::Version
-  version: 2.1.6
+  version: 2.1.7
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-prof
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0'
 description: Parses the subset of the TCL grammar needed for Nuke scripts
 email: me@julik.nl
 executables: []
@@ -75,6 +75,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".gitignore"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -85,6 +86,7 @@ files:
 - lib/tickly/evaluator.rb
 - lib/tickly/node_processor.rb
 - lib/tickly/parser.rb
+- lib/tickly/version.rb
 - test/helper.rb
 - test/test_benchmark.rb
 - test/test_curve.rb
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Assists in parsing Nuke scripts in TCL