phantom_svg 1.0.0

data/spec/images/stuck_out_tongue/loops_test.json

@@ -0,0 +1,9 @@
+{
+  "name": "stuck_out_tongue",
+  "loops": 3,
+  "skip_first": false,
+  "default_delay": "50/1000",
+  "frames": [
+    "*.svg"
+  ]
+}

data/spec/images/stuck_out_tongue/loops_test.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<animation name="myanimation" loops="3" skip_first="false" default_delay="50/1000">
+  <frame src="*.svg" />
+</animation>

data/spec/images/stuck_out_tongue/skip_first_test.json

@@ -0,0 +1,10 @@
+{
+  "name": "stuck_out_tongue",
+  "loops": 0,
+  "skip_first": true,
+  "default_delay": "50/1000",
+  "frames": [
+    "../ninja.svg",
+    "*.svg"
+  ]
+}

data/spec/images/stuck_out_tongue/skip_first_test.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<animation name="myanimation" loops="0" skip_first="true" default_delay="50/1000">
+  <frame src="../ninja.svg" />
+  <frame src="*.svg" />
+</animation>

data/spec/images/stuck_out_tongue/test1.json

@@ -0,0 +1,20 @@
+{
+	"name": "stuck_out_tongue",
+	"loops": 0,
+  "skip_first": false,
+  "default_delay": "100/1000",
+	"frames": [
+    {"0": 1000},
+    "1",
+    "2",
+    "3",
+    "4",
+    "5",
+    "6",
+    "7",
+    "8",
+    "9",
+    "10",
+    {"11": "10/5"}
+  ]
+}

data/spec/images/stuck_out_tongue/test1.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<animation name="myanimation" loops="0" skip_first="false" default_delay="100/1000">
+  <frame src="0" delay="1000" />
+  <frame src="1" />
+  <frame src="2" />
+  <frame src="3" />
+  <frame src="4" />
+  <frame src="5" />
+  <frame src="6" />
+  <frame src="7" />
+  <frame src="8" />
+  <frame src="9" />
+  <frame src="10" />
+  <frame src="11" delay="4/2" />
+</animation>

data/spec/images/stuck_out_tongue/test2.json

@@ -0,0 +1,13 @@
+{
+	"name": "stuck_out_tongue",
+	"loops": 0,
+  "skip_first": false,
+  "default_delay": "200/1000",
+	"frames": [
+    "*.svg"
+  ],
+  "delays": [
+    "2/1",
+    3000
+  ]
+}

data/spec/images/stuck_out_tongue/test2.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<animation name="myanimation" loops="0" skip_first="false" default_delay="200/1000">
+  <frame src="*.svg" />
+</animation>

data/spec/phantom/svg_spec.rb

@@ -0,0 +1,421 @@
+require 'phantom/svg'
+
+# Set Current directory.
+Dir.chdir(SPEC_ROOT_DIR)
+
+describe Phantom::SVG::Base do
+
+  describe 'loading a non-animated svg' do
+    before(:all) do
+      @image_name = 'ninja'
+      @source = "#{SPEC_SOURCE_DIR}/#{@image_name}.svg"
+    end
+
+    before do
+      @loader = Phantom::SVG::Base.new(@source)
+    end
+
+    it 'frames vector has a size of 1.' do
+      expect(@loader.frames.size).to eq(1)
+    end
+
+    it 'frame duration equals 0.1.' do
+      expect(@loader.frames[0].duration).to eq(0.1)
+    end
+
+    it 'frame surfaces is not nil.' do
+      expect(@loader.frames[0].surfaces).not_to be_nil
+    end
+
+    it 'frame surfaces is not empty.' do
+      expect(@loader.frames[0].surfaces).not_to be_empty
+    end
+
+    it 'frame width equal to \'64px\'.' do
+      expect(@loader.frames[0].width).to eq('64px')
+    end
+
+    it 'frame height equal to \'64px\'.' do
+      expect(@loader.frames[0].height).to eq('64px')
+    end
+
+    it 'frame namespaces is not empty.' do
+      expect(@loader.frames[0].namespaces).not_to be_empty
+    end
+
+    after do
+      # nop
+    end
+  end
+
+  describe 'creating an animated SVG' do
+    before(:all) do
+      @image_name = 'stuck_out_tongue'
+      @source = "#{SPEC_SOURCE_DIR}/#{@image_name}/*.svg"
+      @destination_dir = "#{SPEC_TEMP_DIR}/#{@image_name}"
+      @destination = "#{@destination_dir}/#{@image_name}.svg"
+      FileUtils.mkdir_p(@destination_dir)
+    end
+
+    before do
+      @loader = Phantom::SVG::Base.new
+    end
+
+    it 'saves a non-zero-byte file.' do
+      @loader.add_frame_from_file(@source)
+      write_size = @loader.save_svg(@destination)
+      expect(write_size).not_to eq(0)
+    end
+
+    it 'is an animation with a frame vector size of 12.' do
+      @loader.add_frame_from_file(@destination)
+      expect(@loader.frames.size).to eq(12)
+    end
+
+    it ' has a frame surfaces length not equal to 1.' do
+      @loader.add_frame_from_file(@destination)
+
+      range = 0..(@loader.frames.length - 1)
+      range.each do |i|
+        frame = @loader.frames[i]
+        expect(frame.surfaces.to_s.length).not_to eq(1)
+
+        @loader.save_svg_frame("#{@destination_dir}/#{i}.svg", frame)
+      end
+    end
+
+    after do
+      # nop
+    end
+  end
+
+  describe 'creating an animated SVG file from a JSON animation spec file' do
+    before(:all) do
+      @image_name = 'stuck_out_tongue'
+      @source_dir = "#{SPEC_SOURCE_DIR}/#{@image_name}"
+      @destination_dir = SPEC_TEMP_DIR
+    end
+
+    before do
+      @loader = Phantom::SVG::Base.new
+    end
+
+    it 'loads frames from "test1.json".' do
+      test_name = 'test1'
+      @loader.add_frame_from_file("#{@source_dir}/#{test_name}.json")
+      expect(@loader.frames.size).to eq(12)
+      @loader.frames.each do |frame|
+        expect(frame.duration.instance_of?(Float)).to eq(true)
+        expect(frame.width).to eq('64px')
+        expect(frame.height).to eq('64px')
+        expect(frame.surfaces).not_to be_nil
+        expect(frame.surfaces).not_to be_empty
+        expect(frame.surfaces.to_s.length).not_to eq(1)
+        expect(frame.namespaces).not_to be_empty
+      end
+      write_size = @loader.save_svg("#{@destination_dir}/json_#{test_name}.svg")
+      expect(write_size).not_to eq(0)
+    end
+
+    it 'loads frames from "test2.json".' do
+      test_name = 'test2'
+      @loader.add_frame_from_file("#{@source_dir}/#{test_name}.json")
+      expect(@loader.frames.size).to eq(12)
+      @loader.frames.each do |frame|
+        expect(frame.duration.instance_of?(Float)).to eq(true)
+        expect(frame.width).to eq('64px')
+        expect(frame.height).to eq('64px')
+        expect(frame.surfaces).not_to be_nil
+        expect(frame.surfaces).not_to be_empty
+        expect(frame.surfaces.to_s.length).not_to eq(1)
+        expect(frame.namespaces).not_to be_empty
+      end
+      write_size = @loader.save_svg("#{@destination_dir}/json_#{test_name}.svg")
+      expect(write_size).not_to eq(0)
+    end
+  end
+
+  describe 'creating an animated SVG from file from an XML animation spec' do
+    before(:all) do
+      @image_name = 'stuck_out_tongue'
+      @source_dir = "#{SPEC_SOURCE_DIR}/#{@image_name}"
+      @destination_dir = SPEC_TEMP_DIR
+    end
+
+    before do
+      @loader = Phantom::SVG::Base.new
+    end
+
+    it 'loads frames from "test1.xml".' do
+      test_name = 'test1'
+      @loader.add_frame_from_file("#{@source_dir}/#{test_name}.xml")
+      expect(@loader.frames.size).to eq(12)
+      @loader.frames.each do |frame|
+        expect(frame.duration.instance_of?(Float)).to eq(true)
+        expect(frame.width).to eq('64px')
+        expect(frame.height).to eq('64px')
+        expect(frame.surfaces).not_to be_nil
+        expect(frame.surfaces).not_to be_empty
+        expect(frame.surfaces.to_s.length).not_to eq(1)
+        expect(frame.namespaces).not_to be_empty
+      end
+      write_size = @loader.save_svg("#{@destination_dir}/xml_#{test_name}.svg")
+      expect(write_size).not_to eq(0)
+    end
+
+    it 'load frames from "test2.xml".' do
+      test_name = 'test2'
+      @loader.add_frame_from_file("#{@source_dir}/#{test_name}.xml")
+      expect(@loader.frames.size).to eq(12)
+      @loader.frames.each do |frame|
+        expect(frame.duration.instance_of?(Float)).to eq(true)
+        expect(frame.width).to eq('64px')
+        expect(frame.height).to eq('64px')
+        expect(frame.surfaces).not_to be_nil
+        expect(frame.surfaces).not_to be_empty
+        expect(frame.surfaces.to_s.length).not_to eq(1)
+        expect(frame.namespaces).not_to be_empty
+      end
+      write_size = @loader.save_svg("#{@destination_dir}/xml_#{test_name}.svg")
+      expect(write_size).not_to eq(0)
+    end
+  end
+
+  describe 'converting a keyframe animated SVG to APNG' do
+    before(:all) do
+      @image_name = 'stuck_out_tongue'
+      @source = "#{SPEC_SOURCE_DIR}/#{@image_name}/*.svg"
+      @destination = "#{SPEC_TEMP_DIR}/svg2apng.png"
+    end
+
+    before do
+      options = { duration: 0.5 }
+      @loader = Phantom::SVG::Base.new(@source, options)
+    end
+
+    it 'successfully converts.' do
+      expect(@loader.frames.size).to eq(12)
+      is_succeeded = @loader.save_apng(@destination)
+      expect(is_succeeded).to eq(true)
+    end
+  end
+
+  describe 'converting an APNG to a keyframe animated SVG' do
+    before(:all) do
+      @apng_name = 'apngasm'
+      @source = "#{SPEC_SOURCE_DIR}/#{@apng_name}.png"
+      @destination_dir = "#{SPEC_TEMP_DIR}/#{@apng_name}"
+      @destination = "#{@destination_dir}/#{@apng_name}.svg"
+      FileUtils.mkdir_p(@destination_dir)
+    end
+
+    before do
+      @loader = Phantom::SVG::Base.new
+    end
+
+    it 'loads an APNG and saves a keyframe animated SVG.' do
+      @loader.add_frame_from_file(@source)
+      expect(@loader.frames.size).to eq(34)
+
+      write_size = @loader.save_svg(@destination)
+      expect(write_size).not_to eq(0)
+
+      range = 0..(@loader.frames.length - 1)
+      range.each do |i|
+        frame = @loader.frames[i]
+        write_size = @loader.save_svg_frame("#{@destination_dir}/#{i}.svg", frame)
+        expect(write_size).not_to eq(0)
+      end
+    end
+
+    it 'adds frames.' do
+      @loader.add_frame_from_file(@destination)
+      expect(@loader.frames.size).to eq(34)
+
+      @loader.frames.each do |frame|
+        expect(frame.duration).to eq(0.1)
+        expect(frame.width).to eq('64px')
+        expect(frame.height).to eq('64px')
+        expect(frame.surfaces.to_s.length).not_to eq(0)
+        expect(frame.namespaces.length).not_to eq(0)
+      end
+    end
+  end
+
+  describe 'using a finite loop count' do
+    before(:all) do
+      @image_name = 'stuck_out_tongue'
+      @source_dir = "#{SPEC_SOURCE_DIR}/#{@image_name}"
+      @source = "#{@source_dir}/*.svg"
+      @destination_dir = SPEC_TEMP_DIR
+      @destination_svg = "#{@destination_dir}/loops_test.svg"
+      @destination_png = "#{@destination_dir}/loops_test.png"
+    end
+
+    before do
+      @loader = Phantom::SVG::Base.new
+    end
+
+    it 'saves a keyframe animated SVG.' do
+      @loader.add_frame_from_file(@source)
+      @loader.loops = 2
+
+      write_size = @loader.save_svg(@destination_svg)
+      expect(write_size).not_to eq(0)
+    end
+
+    it 'correctly saved the keyframe animated SVG.' do
+      @loader.add_frame_from_file(@destination_svg)
+
+      expect(@loader.frames.size).to eq(12)
+      expect(@loader.width).to eq('64px')
+      expect(@loader.height).to eq('64px')
+      expect(@loader.loops).to eq(2)
+      expect(@loader.skip_first).to eq(false)
+    end
+
+    it 'exports/saves to APNG.' do
+      @loader.add_frame_from_file(@source)
+      @loader.loops = 2
+
+      write_size = @loader.save_apng(@destination_png)
+      expect(write_size).not_to eq(0)
+    end
+
+    it 'correctly saved the APNG.' do
+      @loader.add_frame_from_file(@destination_png)
+
+      expect(@loader.frames.size).to eq(12)
+      expect(@loader.width).to eq('64px')
+      expect(@loader.height).to eq('64px')
+      expect(@loader.loops).to eq(2)
+      expect(@loader.skip_first).to eq(false)
+    end
+
+    it 'loads an animation spec from a JSON file.' do
+      test_name = 'loops_test'
+      source = "#{@source_dir}/#{test_name}.json"
+      destination = "#{@destination_dir}/#{test_name}_json.svg"
+
+      @loader.add_frame_from_file(source)
+      @loader.save_svg(destination)
+      @loader.reset
+      @loader.add_frame_from_file(destination)
+
+      expect(@loader.frames.size).to eq(12)
+      expect(@loader.width).to eq('64px')
+      expect(@loader.height).to eq('64px')
+      expect(@loader.loops).to eq(3)
+      expect(@loader.skip_first).to eq(false)
+      expect(@loader.frames[0].duration).to eq(0.05)
+    end
+
+    it 'loads an animation spec from an XML file.' do
+      test_name = 'loops_test'
+      source = "#{@source_dir}/#{test_name}.xml"
+      destination = "#{@destination_dir}/#{test_name}_xml.svg"
+
+      @loader.add_frame_from_file(source)
+      @loader.save_svg(destination)
+      @loader.reset
+      @loader.add_frame_from_file(destination)
+
+      expect(@loader.frames.size).to eq(12)
+      expect(@loader.width).to eq('64px')
+      expect(@loader.height).to eq('64px')
+      expect(@loader.loops).to eq(3)
+      expect(@loader.skip_first).to eq(false)
+      expect(@loader.frames[0].duration).to eq(0.05)
+    end
+  end
+
+  describe 'using the skip_first flag' do
+    before(:all) do
+      @image_name = 'stuck_out_tongue'
+      @source_dir = "#{SPEC_SOURCE_DIR}/#{@image_name}"
+      @source = "#{@source_dir}/*.svg"
+      @source_skip_frame = "#{SPEC_SOURCE_DIR}/ninja.svg"
+      @destination_dir = SPEC_TEMP_DIR
+      @destination_svg = "#{@destination_dir}/skip_first_test.svg"
+      @destination_png = "#{@destination_dir}/skip_first_test.png"
+    end
+
+    before do
+      @loader = Phantom::SVG::Base.new
+    end
+
+    it 'can save a keyframe animated SVG' do
+      @loader.add_frame_from_file(@source_skip_frame)
+      @loader.add_frame_from_file(@source)
+      @loader.skip_first = true
+
+      write_size = @loader.save_svg(@destination_svg)
+      expect(write_size).not_to eq(0)
+    end
+
+    it 'successfully saves a keyframe animated SVG.' do
+      @loader.add_frame_from_file(@destination_svg)
+
+      expect(@loader.frames.size).to eq(13)
+      expect(@loader.width).to eq('64px')
+      expect(@loader.height).to eq('64px')
+      expect(@loader.loops).to eq(0)
+      expect(@loader.skip_first).to eq(true)
+    end
+
+    it 'exports/saves to APNG' do
+      @loader.add_frame_from_file(@source_skip_frame)
+      @loader.add_frame_from_file(@source)
+      @loader.skip_first = true
+
+      write_size = @loader.save_apng(@destination_png)
+      expect(write_size).not_to eq(0)
+    end
+
+    it 'correctly saved an APNG.' do
+      @loader.add_frame_from_file(@destination_png)
+
+      expect(@loader.frames.size).to eq(13)
+      expect(@loader.width).to eq('64px')
+      expect(@loader.height).to eq('64px')
+      expect(@loader.loops).to eq(0)
+      expect(@loader.skip_first).to eq(true)
+    end
+
+    it 'loads an animation spec from a JSON.' do
+      test_name = 'skip_first_test'
+      source = "#{@source_dir}/#{test_name}.json"
+      destination = "#{@destination_dir}/#{test_name}_json.svg"
+
+      @loader.add_frame_from_file(source)
+      @loader.save_svg(destination)
+      @loader.reset
+      @loader.add_frame_from_file(destination)
+
+      expect(@loader.frames.size).to eq(13)
+      expect(@loader.width).to eq('64px')
+      expect(@loader.height).to eq('64px')
+      expect(@loader.loops).to eq(0)
+      expect(@loader.skip_first).to eq(true)
+      expect(@loader.frames[1].duration).to eq(0.05)
+    end
+
+    it 'loads an animation spec from an XML file.' do
+      test_name = 'skip_first_test'
+      source = "#{@source_dir}/#{test_name}.xml"
+      destination = "#{@destination_dir}/#{test_name}_xml.svg"
+
+      @loader.add_frame_from_file(source)
+      @loader.save_svg(destination)
+      @loader.reset
+      @loader.add_frame_from_file(destination)
+
+      expect(@loader.frames.size).to eq(13)
+      expect(@loader.width).to eq('64px')
+      expect(@loader.height).to eq('64px')
+      expect(@loader.loops).to eq(0)
+      expect(@loader.skip_first).to eq(true)
+      expect(@loader.frames[1].duration).to eq(0.05)
+    end
+  end
+end