psd_to_sprite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0216dead5623252fbb7623b0442dbc2657e70c2
+  data.tar.gz: 0fb377da4b4d0bce98ed907431aef8621df72458
+SHA512:
+  metadata.gz: 7d9e8bae968dea87864b37c68035141f9193bc174e6c2e5f8bb3f10a24093617f232f5dd0bd8121750b1e3f6d9d0bab22f1f469e54a5e0760585f8069ad5fd78
+  data.tar.gz: 04685ce38b77cb60a75ea1092f688a627cbad8a348ddf79dfcd760bff5d6e2b20e6782434b1ddf0b5097eb71e623a9f5e55de37916d6cf7ffbb86581c3c81e36

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+spec/support/example.png

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in psd_to_sprite.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Carl Furrow
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# PsdToSprite
+
+Convert a PSD with layers to a single sprite sheet for animations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'psd_to_sprite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install psd_to_sprite
+
+## Usage
+
+This gem takes a Photoshop file (PSD) that has layers, all the same size, and outputs
+each layer into a horizontal sprite sheet, with each layer laid next to the other,
+left to right. The ordering of the layers in your PSD will dictate the ordering
+of the sprites in the output png. The layer at the very bottom will become frame 0,
+the next one frame 1, and so on.
+
+```ruby
+require 'psd_to_sprite'
+
+sprite_maker = PsdToSprite::SpriteMaker.new("example.psd")
+sprite_maker.process # => outputs to example.png
+sprite_maker.process("foo.png") #=> outputs to foo.png
+```
+
+### Output example
+
+*Note: Example image comes from the [Phaser.js](http://phaser.io/) project*
+
+![example](example/example.png)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/psd_to_sprite/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write specs
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/psd_to_sprite.rb

@@ -0,0 +1,59 @@
+require 'psd_to_sprite/version'
+require 'pathname'
+require 'psd'
+require 'rmagick'
+
+module PsdToSprite
+  class SpriteMaker
+    attr_reader :frame_width, :frame_height, :path, :psd
+
+    def initialize(psd_path)
+      @path = Pathname.new(psd_path)
+      @psd = PSD.new(psd_path)
+    end
+
+    def process(output_path = nil)
+      psd.parse!
+      root_node = psd.tree
+      @frame_height = root_node.height
+      @frame_width = root_node.width
+
+      output_width = root_node.children.count * frame_width
+
+      pngs = collect_pngs_from_layers(root_node.children)
+      img  = save_pngs_to_new_image(pngs, output_width, frame_height)
+
+      return img.write(output_path) if output_path
+      img.write("#{path.dirname}/#{filename_without_ext}.png")
+    end
+
+    private
+    def filename_without_ext
+      path.basename.to_s.gsub(path.extname, "")
+    end
+
+    def collect_pngs_from_layers(layers)
+      pngs = []
+      layers.each do |layer|
+        pngs << layer.to_png
+      end
+      pngs
+    end
+
+    def save_pngs_to_new_image(pngs, output_width, output_height)
+      img = Magick::Image.new(output_width, output_height) do
+        self.background_color = "transparent"
+      end
+
+      x = 0
+      y = 0
+
+      pngs.each do |frame|
+        frame_img = Magick::Image.from_blob(frame.to_s).first
+        img = img.composite(frame_img, x, y, Magick::AddCompositeOp)
+        x += frame_width
+      end
+      img
+    end
+  end
+end

data/lib/psd_to_sprite/version.rb

@@ -0,0 +1,3 @@
+module PsdToSprite
+  VERSION = "0.0.1"
+end

data/psd_to_sprite.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'psd_to_sprite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "psd_to_sprite"
+  spec.version       = PsdToSprite::VERSION
+  spec.authors       = ["Carl Furrow"]
+  spec.email         = ["carl.furrow@gmail.com"]
+  spec.summary       = %q{Convert a PSD with layers to a single sprite sheet for animations}
+  spec.description   = %q{Take a psd with layers, one for each frame, and output to a single png file with each frame placed next to the other in order of the layers in the psd.}
+  spec.homepage      = "http://github.com/cfurrow/psd_to_sprite"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "rmagick", "~> 2.13"
+  spec.add_dependency "psd", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/psd_to_sprite/sprite_maker_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module PsdToSprite
+  describe SpriteMaker do
+    PATH_TO_PNG = "spec/support/example.png"
+    LAYER_COUNT = 13
+    FRAME_WIDTH = 32
+    FRAME_HEIGHT = 48
+
+    let(:psd_path) { '' }
+    let(:maker) { SpriteMaker.new(psd_path) }
+
+    describe "#process" do
+      subject { maker.process }
+
+      context "when psd does not exist" do
+        it "fails hard" do
+          expect { subject }.to raise_error
+        end
+      end
+
+      context "when psd does exist" do
+        let(:psd_path) { 'spec/support/example.psd' }
+        let(:output_image) { Magick::Image.read(PATH_TO_PNG).first }
+
+        it "does not fail hard" do
+          expect { subject }.to_not raise_error
+        end
+
+        it "creates example.png" do
+          path = Pathname.new(PATH_TO_PNG)
+          expect { subject }.to change { path.exist? }.to(true).from(false)
+        end
+
+        it "creates an output image wide enough for all frames" do
+          subject
+          expect(output_image.base_columns).to eq(LAYER_COUNT * FRAME_WIDTH)
+        end
+
+        it "creates an output file with a height of the input frame file" do
+          subject
+          expect(output_image.base_rows).to eq(FRAME_HEIGHT)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'psd_to_sprite'
+require 'pathname'
+require 'pry'
+require 'rmagick'
+
+RSpec.configure do |c|
+  c.color = true
+
+  c.before(:each) do
+    path = Pathname.new("spec/support/example.png")
+    path.delete if path.exist?
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: psd_to_sprite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carl Furrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: psd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Take a psd with layers, one for each frame, and output to a single png
+  file with each frame placed next to the other in order of the layers in the psd.
+email:
+- carl.furrow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/example.png
+- example/example.psd
+- lib/psd_to_sprite.rb
+- lib/psd_to_sprite/version.rb
+- psd_to_sprite.gemspec
+- spec/psd_to_sprite/sprite_maker_spec.rb
+- spec/spec_helper.rb
+- spec/support/example.psd
+homepage: http://github.com/cfurrow/psd_to_sprite
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Convert a PSD with layers to a single sprite sheet for animations
+test_files:
+- spec/psd_to_sprite/sprite_maker_spec.rb
+- spec/spec_helper.rb
+- spec/support/example.psd