ruby_spriter 0.6.5 → 0.6.6

data/spec/ruby_spriter/processor_spec.rb

@@ -0,0 +1,385 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RubySpriter::Processor do
+  describe 'default options' do
+    it 'sets default max_width to 320' do
+      processor = described_class.new
+      expect(processor.options[:max_width]).to eq(320)
+    end
+  end
+
+  describe 'numeric option validation' do
+    describe '--frames validation' do
+      it 'raises error when frame_count is below minimum (0)' do
+        expect {
+          described_class.new(frame_count: 0)
+        }.to raise_error(RubySpriter::ValidationError, /frame_count must be between 1 and 10000/)
+      end
+
+      it 'raises error when frame_count is above maximum (10001)' do
+        expect {
+          described_class.new(frame_count: 10001)
+        }.to raise_error(RubySpriter::ValidationError, /frame_count must be between 1 and 10000/)
+      end
+    end
+
+    describe '--columns validation' do
+      it 'raises error when columns is below minimum (0)' do
+        expect {
+          described_class.new(columns: 0)
+        }.to raise_error(RubySpriter::ValidationError, /columns must be between 1 and 100/)
+      end
+
+      it 'raises error when columns is above maximum (101)' do
+        expect {
+          described_class.new(columns: 101)
+        }.to raise_error(RubySpriter::ValidationError, /columns must be between 1 and 100/)
+      end
+    end
+
+    describe '--width validation' do
+      it 'raises error when max_width is below minimum (0)' do
+        expect {
+          described_class.new(max_width: 0)
+        }.to raise_error(RubySpriter::ValidationError, /max_width must be between 1 and 1920/)
+      end
+
+      it 'raises error when max_width is above maximum (1921)' do
+        expect {
+          described_class.new(max_width: 1921)
+        }.to raise_error(RubySpriter::ValidationError, /max_width must be between 1 and 1920/)
+      end
+    end
+
+    describe '--scale validation' do
+      it 'raises error when scale_percent is below minimum (0)' do
+        expect {
+          described_class.new(scale_percent: 0)
+        }.to raise_error(RubySpriter::ValidationError, /scale_percent must be between 1 and 500/)
+      end
+
+      it 'raises error when scale_percent is above maximum (501)' do
+        expect {
+          described_class.new(scale_percent: 501)
+        }.to raise_error(RubySpriter::ValidationError, /scale_percent must be between 1 and 500/)
+      end
+    end
+
+    describe '--grow validation' do
+      it 'raises error when grow_selection is below minimum (-1)' do
+        expect {
+          described_class.new(grow_selection: -1)
+        }.to raise_error(RubySpriter::ValidationError, /grow_selection must be between 0 and 100/)
+      end
+
+      it 'raises error when grow_selection is above maximum (101)' do
+        expect {
+          described_class.new(grow_selection: 101)
+        }.to raise_error(RubySpriter::ValidationError, /grow_selection must be between 0 and 100/)
+      end
+    end
+
+    describe '--sharpen-radius validation' do
+      it 'raises error when sharpen_radius is below minimum (0.0)' do
+        expect {
+          described_class.new(sharpen_radius: 0.0)
+        }.to raise_error(RubySpriter::ValidationError, /sharpen_radius must be between 0.1 and 100.0/)
+      end
+
+      it 'raises error when sharpen_radius is above maximum (100.1)' do
+        expect {
+          described_class.new(sharpen_radius: 100.1)
+        }.to raise_error(RubySpriter::ValidationError, /sharpen_radius must be between 0.1 and 100.0/)
+      end
+    end
+
+    describe '--sharpen-gain validation' do
+      it 'raises error when sharpen_gain is below minimum (-0.1)' do
+        expect {
+          described_class.new(sharpen_gain: -0.1)
+        }.to raise_error(RubySpriter::ValidationError, /sharpen_gain must be between 0.0 and 10.0/)
+      end
+
+      it 'raises error when sharpen_gain is above maximum (10.1)' do
+        expect {
+          described_class.new(sharpen_gain: 10.1)
+        }.to raise_error(RubySpriter::ValidationError, /sharpen_gain must be between 0.0 and 10.0/)
+      end
+    end
+
+    describe '--sharpen-threshold validation' do
+      it 'raises error when sharpen_threshold is below minimum (-0.1)' do
+        expect {
+          described_class.new(sharpen_threshold: -0.1)
+        }.to raise_error(RubySpriter::ValidationError, /sharpen_threshold must be between 0.0 and 1.0/)
+      end
+
+      it 'raises error when sharpen_threshold is above maximum (1.1)' do
+        expect {
+          described_class.new(sharpen_threshold: 1.1)
+        }.to raise_error(RubySpriter::ValidationError, /sharpen_threshold must be between 0.0 and 1.0/)
+      end
+    end
+
+    describe '--threshold validation' do
+      it 'raises error when bg_threshold is below minimum (-0.1)' do
+        expect {
+          described_class.new(bg_threshold: -0.1)
+        }.to raise_error(RubySpriter::ValidationError, /bg_threshold must be between 0.0 and 100.0/)
+      end
+
+      it 'raises error when bg_threshold is above maximum (100.1)' do
+        expect {
+          described_class.new(bg_threshold: 100.1)
+        }.to raise_error(RubySpriter::ValidationError, /bg_threshold must be between 0.0 and 100.0/)
+      end
+    end
+  end
+
+  describe '--split validation' do
+    describe 'format validation' do
+      it 'raises error for invalid split format (missing colon)' do
+        expect {
+          described_class.new(image: 'test.png', split: '44')
+        }.to raise_error(RubySpriter::ValidationError, /Invalid --split format/)
+      end
+
+      it 'raises error for invalid split format (non-numeric rows)' do
+        expect {
+          described_class.new(image: 'test.png', split: 'a:4')
+        }.to raise_error(RubySpriter::ValidationError, /Invalid --split format/)
+      end
+
+      it 'raises error for invalid split format (non-numeric columns)' do
+        expect {
+          described_class.new(image: 'test.png', split: '4:b')
+        }.to raise_error(RubySpriter::ValidationError, /Invalid --split format/)
+      end
+    end
+
+    describe 'range validation' do
+      it 'raises error when rows is below minimum (0)' do
+        expect {
+          described_class.new(image: 'test.png', split: '0:4')
+        }.to raise_error(RubySpriter::ValidationError, /rows must be between 1 and 99/)
+      end
+
+      it 'raises error when rows is above maximum (100)' do
+        expect {
+          described_class.new(image: 'test.png', split: '100:4')
+        }.to raise_error(RubySpriter::ValidationError, /rows must be between 1 and 99/)
+      end
+
+      it 'raises error when columns is below minimum (0)' do
+        expect {
+          described_class.new(image: 'test.png', split: '4:0')
+        }.to raise_error(RubySpriter::ValidationError, /columns must be between 1 and 99/)
+      end
+
+      it 'raises error when columns is above maximum (100)' do
+        expect {
+          described_class.new(image: 'test.png', split: '4:100')
+        }.to raise_error(RubySpriter::ValidationError, /columns must be between 1 and 99/)
+      end
+
+      it 'raises error when total frames >= 1000' do
+        expect {
+          described_class.new(image: 'test.png', split: '32:32')
+        }.to raise_error(RubySpriter::ValidationError, /Total frames \(1024\) must be less than 1000/)
+      end
+
+      it 'raises error when total frames equals 1000' do
+        expect {
+          described_class.new(image: 'test.png', split: '20:50')
+        }.to raise_error(RubySpriter::ValidationError, /Total frames \(1000\) must be less than 1000/)
+      end
+
+      it 'allows maximum valid frames (999)' do
+        expect {
+          described_class.new(image: 'test.png', split: '27:37')
+        }.not_to raise_error
+      end
+    end
+  end
+
+  describe '--split metadata priority logic' do
+    let(:temp_dir) { Dir.mktmpdir('test_split_') }
+    let(:image_file) { File.join(temp_dir, 'spritesheet.png') }
+
+    before do
+      FileUtils.touch(image_file)
+
+      allow_any_instance_of(RubySpriter::DependencyChecker).to receive(:check_all).and_return({
+        ffmpeg: { available: true },
+        ffprobe: { available: true },
+        imagemagick: { available: true },
+        gimp: { available: true }
+      })
+      allow_any_instance_of(RubySpriter::DependencyChecker).to receive(:gimp_path).and_return('/usr/bin/gimp')
+    end
+
+    after do
+      FileUtils.rm_rf(temp_dir)
+    end
+
+    context 'when image has metadata' do
+      before do
+        allow(RubySpriter::MetadataManager).to receive(:read).with(image_file).and_return({
+          columns: 4,
+          rows: 4,
+          frames: 16
+        })
+      end
+
+      it 'uses metadata when --split not provided' do
+        processor = described_class.new(image: image_file, save_frames: true)
+
+        splitter = instance_double(RubySpriter::Utils::SpritesheetSplitter)
+        allow(RubySpriter::Utils::SpritesheetSplitter).to receive(:new).and_return(splitter)
+        expect(splitter).to receive(:split_into_frames).with(image_file, anything, 4, 4, 16)
+
+        processor.run
+      end
+
+      it 'warns and uses metadata when --split provided without --override-md' do
+        processor = described_class.new(image: image_file, split: '5:5')
+
+        splitter = instance_double(RubySpriter::Utils::SpritesheetSplitter)
+        allow(RubySpriter::Utils::SpritesheetSplitter).to receive(:new).and_return(splitter)
+        expect(splitter).to receive(:split_into_frames).with(image_file, anything, 4, 4, 16)
+
+        expect(RubySpriter::Utils::OutputFormatter).to receive(:note).with(/Image has metadata.*Your --split values will be ignored/)
+
+        processor.run
+      end
+
+      it 'uses --split when --override-md provided' do
+        processor = described_class.new(image: image_file, split: '5:5', override_md: true)
+
+        # Mock ImageMagick identify for dimension validation
+        allow(Open3).to receive(:capture3).with(/identify/).and_return(
+          ["500x500\n", '', instance_double(Process::Status, success?: true)]
+        )
+
+        splitter = instance_double(RubySpriter::Utils::SpritesheetSplitter)
+        allow(RubySpriter::Utils::SpritesheetSplitter).to receive(:new).and_return(splitter)
+        expect(splitter).to receive(:split_into_frames).with(image_file, anything, 5, 5, 25)
+
+        processor.run
+      end
+    end
+
+    context 'when image has no metadata' do
+      before do
+        allow(RubySpriter::MetadataManager).to receive(:read).with(image_file).and_return(nil)
+      end
+
+      it 'uses --split values when provided' do
+        processor = described_class.new(image: image_file, split: '6:6')
+
+        # Mock ImageMagick identify for dimension validation
+        allow(Open3).to receive(:capture3).with(/identify/).and_return(
+          ["600x600\n", '', instance_double(Process::Status, success?: true)]
+        )
+
+        splitter = instance_double(RubySpriter::Utils::SpritesheetSplitter)
+        allow(RubySpriter::Utils::SpritesheetSplitter).to receive(:new).and_return(splitter)
+        expect(splitter).to receive(:split_into_frames).with(image_file, anything, 6, 6, 36)
+
+        processor.run
+      end
+
+      it 'raises error when --split not provided' do
+        processor = described_class.new(image: image_file, save_frames: true)
+
+        expect {
+          processor.run
+        }.to raise_error(RubySpriter::ValidationError, /Image has no metadata.*Please provide --split/)
+      end
+    end
+  end
+
+  describe 'frame extraction with --save-frames' do
+    let(:temp_dir) { Dir.mktmpdir('test_') }
+    let(:video_file) { File.join(temp_dir, 'test.mp4') }
+    let(:spritesheet_file) { File.join(temp_dir, 'spritesheet.png') }
+
+    before do
+      FileUtils.touch(video_file)
+      FileUtils.touch(spritesheet_file)
+
+      allow_any_instance_of(RubySpriter::DependencyChecker).to receive(:check_all).and_return({
+        ffmpeg: { available: true },
+        ffprobe: { available: true },
+        imagemagick: { available: true },
+        gimp: { available: true }
+      })
+      allow_any_instance_of(RubySpriter::DependencyChecker).to receive(:gimp_path).and_return('/usr/bin/gimp')
+    end
+
+    after do
+      FileUtils.rm_rf(temp_dir)
+    end
+
+    it 'splits spritesheet into frames after video processing when save_frames is true' do
+      processor = described_class.new(video: video_file, save_frames: true)
+
+      # The output file will be generated from video filename
+      expected_output = File.join(temp_dir, 'test_spritesheet.png')
+
+      video_processor = instance_double(RubySpriter::VideoProcessor)
+      allow(RubySpriter::VideoProcessor).to receive(:new).and_return(video_processor)
+      allow(video_processor).to receive(:create_spritesheet).and_return({
+        output_file: expected_output,
+        columns: 4,
+        rows: 4,
+        frames: 16
+      })
+
+      splitter = instance_double(RubySpriter::Utils::SpritesheetSplitter)
+      allow(RubySpriter::Utils::SpritesheetSplitter).to receive(:new).and_return(splitter)
+      expect(splitter).to receive(:split_into_frames).with(expected_output, anything, 4, 4, 16)
+
+      processor.run
+    end
+
+    it 'splits spritesheet into frames after image processing when save_frames is true' do
+      processor = described_class.new(image: spritesheet_file, save_frames: true)
+
+      # Mock metadata reading
+      allow(RubySpriter::MetadataManager).to receive(:read).with(spritesheet_file).and_return({
+        columns: 4,
+        rows: 4,
+        frames: 16
+      })
+
+      splitter = instance_double(RubySpriter::Utils::SpritesheetSplitter)
+      allow(RubySpriter::Utils::SpritesheetSplitter).to receive(:new).and_return(splitter)
+      expect(splitter).to receive(:split_into_frames).with(spritesheet_file, anything, 4, 4, 16)
+
+      processor.run
+    end
+
+    it 'does not split frames when save_frames is false' do
+      processor = described_class.new(video: video_file, save_frames: false)
+
+      # The output file will be generated from video filename
+      expected_output = File.join(temp_dir, 'test_spritesheet.png')
+
+      video_processor = instance_double(RubySpriter::VideoProcessor)
+      allow(RubySpriter::VideoProcessor).to receive(:new).and_return(video_processor)
+      allow(video_processor).to receive(:create_spritesheet).and_return({
+        output_file: expected_output,
+        columns: 4,
+        rows: 4,
+        frames: 16
+      })
+
+      expect(RubySpriter::Utils::SpritesheetSplitter).not_to receive(:new)
+
+      processor.run
+    end
+  end
+end

data/spec/ruby_spriter/utils/file_helper_spec.rb

@@ -62,10 +62,89 @@ RSpec.describe RubySpriter::Utils::FileHelper do
     it 'validates file exists and is readable' do
       file = File.join(@test_dir, 'test.txt')
       File.write(file, 'test')
-      
+
       expect {
         described_class.validate_readable!(file)
       }.not_to raise_error
     end
   end
+
+  describe '.unique_filename' do
+    it 'returns original filename when file does not exist' do
+      result = described_class.unique_filename('/path/to/output.png')
+      expect(result).to eq('/path/to/output.png')
+    end
+
+    it 'adds timestamp when file exists' do
+      file = File.join(@test_dir, 'existing.png')
+      File.write(file, 'test')
+
+      result = described_class.unique_filename(file)
+      expect(result).to match(/existing_\d{8}_\d{6}_\d{3}\.png$/)
+      expect(result).not_to eq(file)
+    end
+
+    it 'handles files with multiple dots in name' do
+      file = File.join(@test_dir, 'my.sprite.sheet.png')
+      File.write(file, 'test')
+
+      result = described_class.unique_filename(file)
+      expect(result).to match(/my\.sprite\.sheet_\d{8}_\d{6}_\d{3}\.png$/)
+    end
+
+    it 'preserves directory path' do
+      file = File.join(@test_dir, 'subdir', 'output.png')
+      FileUtils.mkdir_p(File.dirname(file))
+      File.write(file, 'test')
+
+      result = described_class.unique_filename(file)
+      expect(result).to start_with(File.join(@test_dir, 'subdir'))
+    end
+
+    it 'generates different filenames for consecutive calls' do
+      file = File.join(@test_dir, 'test.png')
+      File.write(file, 'test')
+
+      result1 = described_class.unique_filename(file)
+      sleep(0.01) # Small delay to ensure different timestamps
+      result2 = described_class.unique_filename(file)
+
+      expect(result1).not_to eq(result2)
+    end
+  end
+
+  describe '.ensure_unique_output' do
+    it 'returns original path when overwrite is true' do
+      file = File.join(@test_dir, 'output.png')
+      File.write(file, 'test')
+
+      result = described_class.ensure_unique_output(file, overwrite: true)
+      expect(result).to eq(file)
+    end
+
+    it 'returns original path when file does not exist and overwrite is false' do
+      file = File.join(@test_dir, 'new_output.png')
+
+      result = described_class.ensure_unique_output(file, overwrite: false)
+      expect(result).to eq(file)
+    end
+
+    it 'returns unique filename when file exists and overwrite is false' do
+      file = File.join(@test_dir, 'existing_output.png')
+      File.write(file, 'test')
+
+      result = described_class.ensure_unique_output(file, overwrite: false)
+      expect(result).to match(/existing_output_\d{8}_\d{6}_\d{3}\.png$/)
+      expect(result).not_to eq(file)
+    end
+
+    it 'defaults to overwrite false when not specified' do
+      file = File.join(@test_dir, 'default_test.png')
+      File.write(file, 'test')
+
+      result = described_class.ensure_unique_output(file)
+      expect(result).not_to eq(file)
+      expect(result).to match(/default_test_\d{8}_\d{6}_\d{3}\.png$/)
+    end
+  end
 end

data/spec/ruby_spriter/utils/spritesheet_splitter_spec.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RubySpriter::Utils::SpritesheetSplitter do
+  describe '#split_into_frames' do
+    let(:spritesheet_file) { 'spritesheet.png' }
+    let(:output_dir) { '/tmp/frames' }
+    let(:columns) { 4 }
+    let(:rows) { 4 }
+    let(:frames) { 16 }
+    let(:tile_width) { 100 }
+    let(:tile_height) { 100 }
+
+    let(:splitter) { described_class.new }
+
+    before do
+      allow(FileUtils).to receive(:mkdir_p)
+      allow(File).to receive(:exist?).and_return(true)
+      allow(Open3).to receive(:capture3).and_return(['', '', instance_double(Process::Status, success?: true)])
+
+      # Mock ImageMagick identify to return dimensions
+      allow(Open3).to receive(:capture3).with(/identify/).and_return(
+        ["400x400\n", '', instance_double(Process::Status, success?: true)]
+      )
+    end
+
+    it 'creates output directory for frames' do
+      expect(FileUtils).to receive(:mkdir_p).with(output_dir)
+
+      splitter.split_into_frames(spritesheet_file, output_dir, columns, rows, frames)
+    end
+
+    it 'extracts each frame with FR prefix and zero-padded numbers' do
+      # Expect ImageMagick convert commands for each frame
+      expect(Open3).to receive(:capture3).with(/identify/).once.and_return(
+        ["400x400\n", '', instance_double(Process::Status, success?: true)]
+      )
+
+      (1..frames).each do |i|
+        expect(Open3).to receive(:capture3).with(/convert.*FR#{format('%03d', i)}_/).and_return(
+          ['', '', instance_double(Process::Status, success?: true)]
+        )
+      end
+
+      splitter.split_into_frames(spritesheet_file, output_dir, columns, rows, frames)
+    end
+
+    it 'calculates tile dimensions from spritesheet size and grid' do
+      # For 400x400 image with 4x4 grid, tiles should be 100x100
+      expect(Open3).to receive(:capture3).with(/identify/).and_return(
+        ["400x400\n", '', instance_double(Process::Status, success?: true)]
+      )
+
+      # Check that crop parameters use 100x100
+      expect(Open3).to receive(:capture3).with(/100x100\+0\+0/).and_return(
+        ['', '', instance_double(Process::Status, success?: true)]
+      )
+
+      allow(Open3).to receive(:capture3).and_return(['', '', instance_double(Process::Status, success?: true)])
+
+      splitter.split_into_frames(spritesheet_file, output_dir, columns, rows, 1)
+    end
+
+    it 'includes spritesheet basename in frame output names' do
+      basename = File.basename(spritesheet_file, '.*')
+
+      # Mock identify first
+      allow(Open3).to receive(:capture3).with(/identify/).and_return(
+        ["400x400\n", '', instance_double(Process::Status, success?: true)]
+      )
+
+      # Expect convert with frame filename
+      expect(Open3).to receive(:capture3).with(/FR001_#{basename}\.png/).and_return(
+        ['', '', instance_double(Process::Status, success?: true)]
+      )
+
+      splitter.split_into_frames(spritesheet_file, output_dir, columns, rows, 1)
+    end
+
+    it 'raises ProcessingError when ImageMagick fails' do
+      allow(Open3).to receive(:capture3).with(/identify/).and_return(
+        ["400x400\n", '', instance_double(Process::Status, success?: true)]
+      )
+
+      allow(Open3).to receive(:capture3).with(/convert/).and_return(
+        ['', 'Error message', instance_double(Process::Status, success?: false)]
+      )
+
+      expect {
+        splitter.split_into_frames(spritesheet_file, output_dir, columns, rows, 1)
+      }.to raise_error(RubySpriter::ProcessingError, /Could not extract frame/)
+    end
+
+    it 'displays progress information' do
+      expect(RubySpriter::Utils::OutputFormatter).to receive(:header).with(/Extracting Frames/)
+      expect(RubySpriter::Utils::OutputFormatter).to receive(:indent).with(/Splitting spritesheet into #{frames} frames/)
+      expect(RubySpriter::Utils::OutputFormatter).to receive(:indent).with(/Output directory:/)
+      expect(RubySpriter::Utils::OutputFormatter).to receive(:indent).with(/Frames extracted successfully/)
+
+      splitter.split_into_frames(spritesheet_file, output_dir, columns, rows, frames)
+    end
+  end
+end

data/spec/ruby_spriter/video_processor_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RubySpriter::VideoProcessor do
+  describe '#create_spritesheet' do
+    let(:video_file) { 'test_video.mp4' }
+    let(:output_file) { 'spritesheet.png' }
+    let(:processor) { described_class.new(frame_count: 16, columns: 4) }
+
+    before do
+      allow(RubySpriter::Utils::FileHelper).to receive(:validate_readable!)
+      allow(File).to receive(:size).and_return(1000)
+      allow(File).to receive(:exist?).and_return(true)
+      allow(File).to receive(:delete)
+      allow(RubySpriter::MetadataManager).to receive(:embed)
+      allow(Open3).to receive(:capture3).and_return(['2.0', '', instance_double(Process::Status, success?: true)])
+    end
+
+    it 'creates spritesheet from video file' do
+      result = processor.create_spritesheet(video_file, output_file)
+
+      expect(result[:output_file]).to eq(output_file)
+      expect(result[:columns]).to eq(4)
+      expect(result[:rows]).to eq(4)
+      expect(result[:frames]).to eq(16)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_spriter
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - scooter-indie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-23 00:00:00.000000000 Z
+date: 2025-10-24 00:00:00.000000000 Z
 dependencies: []
 description: |
   Ruby Spriter is a cross-platform tool for creating spritesheets from video files
@@ -38,6 +38,7 @@ files:
 - lib/ruby_spriter/utils/file_helper.rb
 - lib/ruby_spriter/utils/output_formatter.rb
 - lib/ruby_spriter/utils/path_helper.rb
+- lib/ruby_spriter/utils/spritesheet_splitter.rb
 - lib/ruby_spriter/version.rb
 - lib/ruby_spriter/video_processor.rb
 - ruby_spriter.gemspec
@@ -57,6 +58,7 @@ files:
 - spec/ruby_spriter/utils/file_helper_spec.rb
 - spec/ruby_spriter/utils/output_formatter_spec.rb
 - spec/ruby_spriter/utils/path_helper_spec.rb
+- spec/ruby_spriter/utils/spritesheet_splitter_spec.rb
 - spec/ruby_spriter/video_processor_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/scooter-indie/ruby-spriter