flame_channel_parser 2.1.2 → 2.2.1

data/History.txt

@@ -1,3 +1,11 @@
+=== 2.2.1 / 2011-31-07
+
+* Fix keyframe indices in the progress reports
+
+=== 2.2.0 / 2011-31-07
+
+* Output progress reports from the parser
+
 === 2.1.2 / 2011-29-06
 
 * Fixed automatic length detection in setups that do not specify their length

data/lib/flame_channel_parser.rb

@@ -1,7 +1,7 @@
 module FlameChannelParser
-  VERSION = '2.1.2'
+  VERSION = '2.2.1'
   
-  # Parse a Flame setup into an array of Channel
+  # Parse a Flame setup into an array of Channel objects
   def self.parse(io)
     Parser.new.parse(io)
   end

data/lib/parser.rb

@@ -3,8 +3,14 @@ require "forwardable"
 # Basic parser used for setups from versions up to 2011
 module FlameChannelParser
   class Parser
+    
+    # Here you can assign a logger proc or a lambda that will be call'ed with progress reports
+    attr_accessor :logger_proc
+    
     # Parses the setup passed in the IO
     def parse(io)
+      @do_logs = (@logger_proc.respond_to?(:call))
+      
       channels = []
       node_name, node_type = nil, nil
       
@@ -15,13 +21,21 @@ module FlameChannelParser
         elsif line =~ NODE_NAME_MATCHER
           node_name = $1
         elsif line =~ CHANNEL_MATCHER && channel_is_useful?($1)
-          channels << parse_channel(io, $1, node_type, node_name)
+          log("Parsing channel #{$1.inspect}")
+          channel = parse_channel(io, $1, node_type, node_name)
+          channels << channel
         end
       end
       
       channels
     end
-  
+    
+    # This method will be called internally with information on items being processed.
+    # The implementation just calls the logger_proc instance variable
+    def log(message)
+      @logger_proc.call(message) if @do_logs
+    end
+    
     # Override this method to skip some channels, this will speedup
     # your code alot
     def channel_is_useful?(channel_name)
@@ -74,7 +88,11 @@ module FlameChannelParser
         end
       
         if line =~ KF_COUNT_MATCHER
-          $1.to_i.times { c.push(extract_key_from(io)) }
+          num_keyframes = $1.to_i
+          num_keyframes.times do | idx |
+            log("Extracting keyframe %d of %d" % [idx + 1, num_keyframes])
+            c.push(extract_key_from(io))
+          end
         elsif line =~ BASE_VALUE_MATCHER# && empty?
           c.base_value = $1.to_f
         elsif line =~ EXTRAP_MATCHER

data/test/test_flame_channel_parser.rb

@@ -19,6 +19,19 @@ class TestFlameChannelParser < Test::Unit::TestCase
     assert_equal 12, chans[0].length
   end
   
+  def test_parsing_kronos_with_reports
+    logging_console = ""
+    data = File.open(File.dirname(__FILE__) + "/snaps/TW_TEST.F_Kronos")
+    parser = FlameChannelParser::Parser.new
+    parser.logger_proc = lambda do | log_message |
+      logging_console << log_message
+    end
+    
+    parser.parse(data)
+    assert_match /Extracting keyframe 1 of 12/, logging_console
+    assert_no_match /Extracting keyframe 0 of 12/, logging_console, "Keyframe indices should not start at zero"
+  end
+  
   def test_parsing
     data = File.open(File.dirname(__FILE__) + "/sample_channel.dat")
     channels = FlameChannelParser.parse(data)

metadata

@@ -2,7 +2,7 @@
 name: flame_channel_parser
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.2
+  version: 2.2.1
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-29 00:00:00 Z
+date: 2011-07-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: update_hints
@@ -40,9 +40,9 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.9.4
+        version: "2.10"
   type: :development
   version_requirements: *id003
 description: |-