flame_channel_parser 4.1.1 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ea2d0b36c71708aed053a7e899fe45a90144f09a76a539bfde0fa75cebdbba
-  data.tar.gz: a28e90fce5c379defb431679b1593f5e9b1a02e1a69ac492b8312066bc1eb86e
+  metadata.gz: 5310312580c16476d46b962fedb4517abefcffa77462be460e8a5368b277941a
+  data.tar.gz: 25b0cb4de7e741fb58589ef030e38c7cea6bb811784b33993b8a9e82604acbc2
 SHA512:
-  metadata.gz: 7b6359fb57c03a67a048c2679efddff22d1ced66ec00bc93a34fc8a0965a17eb0af749baa3b66423542775e6442d1cf61d509f784c69b8ea46303acbea9cbb95
-  data.tar.gz: caf1e909f3f2f8078218c230e6fc3f882fc2df70fb64b0f8f3e9ce8550314b67b12c401e68c4da541547af01b29e1b56aaef90e260c00f9397474554f42ccfc6
+  metadata.gz: 00acdb63e9791ef57d05023fb1235dcaabe7c6fdf15f0e1f82182e03cbdbf9579fe24a1c3e08a57480abcf20fba600399b3c206262591f3381c738534bb4520a
+  data.tar.gz: e9908c6a1cb2d07e40ee9a1539bc9463d03ee0870f2ebe66330bf075adc0a63de5099e9891b2fd20bd949492464fe033b392d4c0817de7d49ac73e6437307d28

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.6'
+          - '4.0'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test

data/History.txt

@@ -1,3 +1,16 @@
+=== 4.2.1 / 2026-10-02
+
+* Work with frozen string literals, add frozen_string_literal magic comments to all library files
+* Fix the Regexp flags in the Batch timewarp writer (an Array of flags was taken as "ignore case")
+
+=== 4.2.0 / 2026-10-02
+
+* Make parsing, interpolation and Builder usable from within Ractors (Ruby 4.0+)
+* Fix `FlameChannelParser.parse`, `XMLParser#parse` and the framecurve writers on Ruby 3+
+  (`Proc.new` without a block)
+* Declare the dependencies on `matrix` and `rexml`, which are no longer default gems
+* Require framecurve 2.2.4+
+
 === 4.1.0 / 2014-10-20
 
 * Adds `flame_channel_inspect` for examining Flame setups

data/flame_channel_parser.gemspec

@@ -4,12 +4,12 @@ Gem::Specification.new do |s|
   s.name = "flame_channel_parser"
   s.version = FlameChannelParser::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = ">= 2.6"
   s.authors = ["Julik Tarkhanov"]
   s.date = Time.now.utc.strftime("%Y-%m-%d")
   s.description = "Reads and interpolates animation channels in IFFS setups"
   s.email = "me@julik.nl"
-  s.executables = ["bake_flame_channel", "framecurve_from_flame", "framecurve_to_flame"]
+  s.executables = Dir["bin/*"].map { |f| File.basename(f) }
   s.extra_rdoc_files = [
     "README.md"
   ]
@@ -17,12 +17,12 @@ Gem::Specification.new do |s|
   s.homepage = "http://guerilla-di.org/flame-channel-parser/"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
   s.summary = "A parser/interpolator for Flame/Smoke animation curves"
 
-  s.specification_version = 3
   s.add_runtime_dependency("update_hints", ["~> 1.0"])
-  s.add_runtime_dependency("framecurve", ["~> 2"])
+  s.add_runtime_dependency("framecurve", ["~> 2", ">= 2.2.4"])
+  s.add_runtime_dependency("matrix")
+  s.add_runtime_dependency("rexml")
   s.add_development_dependency("rake", [">= 0"])
   s.add_development_dependency("cli_test", ["~> 1.0"])
   s.add_development_dependency("test-unit")

data/lib/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 # A Builder-like class for exporting Flame setups
 class FlameChannelParser::Builder #< BasicObject
   INDENT = "\t"
@@ -67,8 +69,8 @@ class FlameChannelParser::Builder #< BasicObject
   end
   
   def __camelize(s)
-    @@camelizations ||= {}
-    @@camelizations[s] ||= s.to_s.gsub(/(^|_)(.)/) { $2.upcase }
+    @camelizations ||= {}
+    @camelizations[s] ||= s.to_s.gsub(/(^|_)(.)/) { $2.upcase }
   end
   
   def __flameize(v)

data/lib/channel.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "forwardable"
 
 module FlameChannelParser

data/lib/extractor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 # Extracts and bakes a specific animation channel to a given buffer, one string per frame
 class FlameChannelParser::Extractor
   
@@ -27,7 +29,7 @@ class FlameChannelParser::Extractor
   end
   
   def extract(path, options)
-    options = DEFAULTS.dup.merge(options)
+    options = DEFAULTS.merge(:destination => $stdout).merge(options)
     File.open(path) do |f|
       
       # Then parse
@@ -47,7 +49,6 @@ class FlameChannelParser::Extractor
   
   DEFAULT_START_FRAME = 1
   DEFAULTS = {
-    :destination => $stdout,
     :start_frame => nil,
     :end_frame => nil,
     :channel => DEFAULT_CHANNEL_TO_EXTRACT,
@@ -105,8 +106,7 @@ class FlameChannelParser::Extractor
   end
   
   def compose_channel_not_found_message(for_channel, other_channels)
-    message = "Channel #{for_channel.inspect} not found in this setup (set the channel with the :channel option). Found other channels though:" 
-    message << "\n"
+    message = "Channel #{for_channel.inspect} not found in this setup (set the channel with the :channel option). Found other channels though:\n"
     message += other_channels.map{|c| "\t%s\n" % c.path }.join
   end
   

data/lib/flame_channel_parser/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module FlameChannelParser
-  VERSION = '4.1.1'
+  VERSION = '4.2.1'
 end

data/lib/flame_channel_parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/flame_channel_parser/version'
 
 module FlameChannelParser
@@ -7,13 +8,8 @@ module FlameChannelParser
   # Parse a Flame setup into an array of Channel objects.
   # If a block is given to the method it will yield Channel
   # objects one by one instead of accumulating them into an array (useful for big setups)
-  def self.parse(io)
-    c = get_parser_class(io)
-    if block_given?
-      c.new.parse(io, &Proc.new)
-    else
-      c.new.parse(io)
-    end
+  def self.parse(io, &blk)
+    get_parser_class(io).new.parse(io, &blk)
   end
   
   # Parse a Flame setup at passed path. Will return the channels instead of yielding them

data/lib/framecurve_writers/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Writes out a framecurve setup
 class FlameChannelParser::FramecurveWriters::Base
   class KeyWriter
@@ -12,14 +13,16 @@ class FlameChannelParser::FramecurveWriters::Base
     
   end
   
+  # Kept as a frozen array in a class-level ivar so that it can be read from non-main Ractors
   def self.inherited(by)
-    @@writers ||= []
-    @@writers.push(by)
+    writers = FlameChannelParser::FramecurveWriters::Base.instance_variable_get(:@writers) || []
+    FlameChannelParser::FramecurveWriters::Base.instance_variable_set(:@writers, (writers + [by]).freeze)
+    super
   end
   
   # Yields each defined writer class to the block
-  def self.with_each_writer
-    @@writers.each(&Proc.new)
+  def self.with_each_writer(&blk)
+    FlameChannelParser::FramecurveWriters::Base.instance_variable_get(:@writers).each(&blk)
   end
   
   # Should return the desired extension for the exported file

data/lib/framecurve_writers/batch_timewarp.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 # Writes out a Batch timewarp node setup
 class FlameChannelParser::FramecurveWriters::BatchTimewarp < FlameChannelParser::FramecurveWriters::SoftfxTimewarp
   
-  TEMPLATE = File.dirname(__FILE__) + "/templates/BatchTW.xml"
-  TEMPLATE_KEY = File.dirname(__FILE__) + "/templates/key.xml"
+  TEMPLATE = (File.dirname(__FILE__) + "/templates/BatchTW.xml").freeze
+  TEMPLATE_KEY = (File.dirname(__FILE__) + "/templates/key.xml").freeze
   
   def self.extension
     '.timewarp_node'
@@ -13,7 +15,7 @@ class FlameChannelParser::FramecurveWriters::BatchTimewarp < FlameChannelParser:
     yield(w)
     keys = w.keys
     
-    keys_data = ''
+    keys_data = +''
     keys.each_with_index do | k, idx |
       keys_data << templatize(TEMPLATE_KEY, :frame => k[0].to_i, :value => k[1].to_f, :idx => idx)
     end
@@ -31,7 +33,7 @@ class FlameChannelParser::FramecurveWriters::BatchTimewarp < FlameChannelParser:
     t = File.read(file)
     hash.each_pair do | pattern, value |
       p = Regexp.escape('$%s' % pattern)
-      handle = Regexp.new(p, [Regexp::MULTILINE, Regexp::EXTENDED])
+      handle = Regexp.new(p, Regexp::MULTILINE | Regexp::EXTENDED)
       t.gsub!(handle, value.to_s)
     end
     raise "Not all substitutions done" if t.include?('$')

data/lib/framecurve_writers/kronos.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 # Writes out a framecurve setup
 class FlameChannelParser::FramecurveWriters::Kronos < FlameChannelParser::FramecurveWriters::SoftfxTimewarp
-  TOKEN = Regexp.new('__INSERT_FRAME_ANIM__')
-  TEMPLATE = File.dirname(__FILE__) + "/templates/SampleKronos.F_Kronos"
+  TOKEN = Regexp.new('__INSERT_FRAME_ANIM__').freeze
+  TEMPLATE = (File.dirname(__FILE__) + "/templates/SampleKronos.F_Kronos").freeze
   
   def self.extension
     '.F_Kronos'

data/lib/framecurve_writers/softfx_timewarp.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 # Writes out a framecurve setup
 class FlameChannelParser::FramecurveWriters::SoftfxTimewarp < FlameChannelParser::FramecurveWriters::Base
   DATETIME_FORMAT = '%a %b %d %H:%M:%S %Y'
-  TIME = Time.local(2011,12,28,14,50,05)
+  TIME = Time.local(2011,12,28,14,50,05).freeze
   
   def self.extension
     '.timewarp'

data/lib/inspector.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Prints out a viewable tree of channel metadata. Useful when you need to inspect comparable setups
 # for small differentces in channel ordering and animation.
 class FlameChannelParser::Inspector

data/lib/interpolator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 require File.expand_path(File.dirname(__FILE__)) + "/segments"
 
 # Used to sample Flame animation curves. Pass a Channel

data/lib/key.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Represents a keyframe
 class FlameChannelParser::Key
   

data/lib/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 module FlameChannelParser
   # Comnplete parser class for all Flame/Smoke versions
   class Parser

data/lib/segments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 require "matrix"
 
 module FlameChannelParser::Segments #:nodoc:
@@ -52,7 +54,7 @@ module FlameChannelParser::Segments #:nodoc:
       [-2,  3,   0,  0],
       [1,   -2,  1,  0],
       [1,   -1,  0,  0]
-    ].transpose
+    ].transpose.freeze
   
     def initialize(from_frame, to_frame, value1, value2, tangent1, tangent2)
       

data/lib/timewarp_extractor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+# shareable_constant_value: literal
 require "framecurve"
 
 module FlameChannelParser

data/lib/xml_parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rexml/document'
 require "rexml/streamlistener"
 
@@ -73,17 +74,13 @@ class FlameChannelParser::XMLParser < FlameChannelParser::Parser
   
   # Parses the setup passed in the IO. If a block is given to the method it will yield Channel
   # objects one by one instead of accumulating them into an array (useful for big setups)
-  def parse(io)
+  def parse(io, &blk)
     # Ok this is gothic BUT needed. What we do is we transform the XML setup into the OLD
     # setup format, after which we run it through the OLD parser all the same.
     # I am almost sure that ADSK does the same.
     t = Tempfile.new("bx")
     REXML::Document.parse_stream(io, XMLToSetup.new(t))
     t.rewind
-    if block_given?
-      super(t, &Proc.new)
-    else
-      super(t)
-    end
+    super(t, &blk)
   end
 end

data/test/test_batch_timewarp_writer.rb

@@ -10,8 +10,6 @@ class TestBatchTimewarpWriter < Test::Unit::TestCase
       key_writer.key(19, 102)
     end
     
-    File.open(File.dirname(__FILE__) + "/timewarp_export_samples/BatchTW.timewarp_node", "wb"){|f| f.write(buf.string) }
-    
     assert_same_buffer File.open(File.dirname(__FILE__) + "/timewarp_export_samples/BatchTW.timewarp_node"), buf
   end
   

data/test/test_flame_builder.rb

@@ -3,7 +3,7 @@ require "helper"
 
 class FlameBuilderTest < Test::Unit::TestCase
   def setup
-    @s = ""
+    @s = +""
     @b = FlameChannelParser::Builder.new(StringIO.new(@s))
   end
   

data/test/test_flame_channel_parser.rb

@@ -29,7 +29,7 @@ class TestFlameChannelParser < Test::Unit::TestCase
   end
   
   def test_parsing_kronos_with_reports
-    logging_console = ""
+    logging_console = +""
     data = File.open(File.dirname(__FILE__) + "/snaps/TW_TEST.F_Kronos")
     parser = FlameChannelParser::Parser.new
     parser.logger_proc = lambda do | log_message |

data/test/test_inspector.rb

@@ -12,7 +12,7 @@ class TestInspector < Test::Unit::TestCase
     channels = FlameChannelParser.parse(data)
     
     inspector = FlameChannelParser::Inspector.new(channels)
-    output = ''
+    output = +''
     
     inspector.pretty_print(StringIO.new(output))
     
@@ -27,7 +27,7 @@ class TestInspector < Test::Unit::TestCase
     channels = FlameChannelParser.parse(data)
     
     inspector = FlameChannelParser::Inspector.new(channels)
-    output = ''
+    output = +''
     
     inspector.pretty_print(StringIO.new(output))
     

data/test/test_ractor.rb

@@ -0,0 +1,30 @@
+require "helper"
+
+class TestRactor < Test::Unit::TestCase
+  def test_parses_interpolates_and_builds_inside_a_ractor
+    omit "Needs Ruby 4.0+ Ractors" unless defined?(Ractor) && Ractor.method_defined?(:value)
+
+    path = File.dirname(__FILE__) + "/snaps/FLEM_curves_example.action"
+    expected = run_conversion(path)
+
+    experimental_warnings, Warning[:experimental] = Warning[:experimental], false
+    begin
+      from_ractor = Ractor.new(path) { |p| TestRactor.new("ractor").run_conversion(p) }.value
+      assert_equal expected, from_ractor
+    ensure
+      Warning[:experimental] = experimental_warnings
+    end
+  end
+
+  def run_conversion(path)
+    channels = File.open(path, "rb") { |f| FlameChannelParser.parse(f) }
+    values = channels.reject(&:empty?).map do |channel|
+      interpolator = FlameChannelParser::Interpolator.new(channel)
+      (1..20).map { |frame| interpolator.sample_at(frame) }
+    end
+
+    out = StringIO.new
+    FlameChannelParser::Builder.new(out).write_block!("Channel", "foo") { |b| b.some_value 1.0 }
+    [values, out.string]
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flame_channel_parser
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.1
 platform: ruby
 authors:
 - Julik Tarkhanov
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2026-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: update_hints
@@ -31,6 +30,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +40,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,15 +117,15 @@ description: Reads and interpolates animation channels in IFFS setups
 email: me@julik.nl
 executables:
 - bake_flame_channel
+- flame_channel_inspect
 - framecurve_from_flame
 - framecurve_to_flame
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".autotest"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - History.txt
 - README.md
@@ -163,6 +196,7 @@ files:
 - test/test_interpolator.rb
 - test/test_key.rb
 - test/test_kronos_timewarp_writer.rb
+- test/test_ractor.rb
 - test/test_segments.rb
 - test/test_softfx_timewarp_writer.rb
 - test/test_timewarp_extractor.rb
@@ -182,7 +216,6 @@ homepage: http://guerilla-di.org/flame-channel-parser/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -190,16 +223,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
-specification_version: 3
+rubygems_version: 4.0.3
+specification_version: 4
 summary: A parser/interpolator for Flame/Smoke animation curves
 test_files: []

data/.autotest

@@ -1,23 +0,0 @@
-# -*- ruby -*-
-
-require 'autotest/restart'
-
-# Autotest.add_hook :initialize do |at|
-#   at.extra_files << "../some/external/dependency.rb"
-#
-#   at.libs << ":../some/external"
-#
-#   at.add_exception 'vendor'
-#
-#   at.add_mapping(/dependency.rb/) do |f, _|
-#     at.files_matching(/test_.*rb$/)
-#   end
-#
-#   %w(TestA TestB).each do |klass|
-#     at.extra_class_map[klass] = "test/test_misc.rb"
-#   end
-# end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/.travis.yml

@@ -1,9 +0,0 @@
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - 2.2.2
-cache: bundler
-sudo: false