spritely 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d722c5631f45aecb25c733b67c27477cabb3087b
+  data.tar.gz: cacdcf82d6ec8c69a7916443c076ec2cb3f6471d
+SHA512:
+  metadata.gz: 47639393b85c3b0a5bf61103de2d2ccbfd68fc9facae1a21e97b1c492f71edb6e3374e2379cf5af5f48e03605475da54f2caea7500ff001c5039d1bdbf413bdd
+  data.tar.gz: d2e6d843569997d59e82ee7228dea3cd494b2f7e0ad2dba5d2313c6ff34026dd30e3fe97154224a95d9c6f4cd0b10306e1e3482b9ea44b5403d2535038cf20f0

data/lib/spritely/generators/base.rb

@@ -0,0 +1,25 @@
+module Spritely
+  module Generators
+    class Base < Struct.new(:sprite_map)
+      def self.create!(sprite_map)
+        new(sprite_map).tap do |generator|
+          generator.build!
+          generator.ensure_directory_exists!
+          generator.save!
+        end
+      end
+
+      def ensure_directory_exists!
+        FileUtils.mkdir_p(Spritely.directory)
+      end
+
+      def build!
+        raise NotImplementedError, "#{self.class} must implement #build!"
+      end
+
+      def save!
+        raise NotImplementedError, "#{self.class} must implement #save!"
+      end
+    end
+  end
+end

data/lib/spritely/generators/chunky_png.rb

@@ -0,0 +1,25 @@
+require 'spritely/generators/base'
+require 'chunky_png'
+
+module Spritely
+  module Generators
+    class ChunkyPng < Spritely::Generators::Base
+      def build!
+        sprite_map.images.each do |image|
+          png = ::ChunkyPNG::Image.from_blob(image.data)
+          canvas.replace!(png, image.left, image.top)
+        end
+      end
+
+      def save!
+        canvas.save(sprite_map.filename, :fast_rgba)
+      end
+
+      private
+
+      def canvas
+        @canvas ||= ::ChunkyPNG::Image.new(sprite_map.images.max_width, sprite_map.images.total_height)
+      end
+    end
+  end
+end

data/lib/spritely/image.rb

@@ -0,0 +1,20 @@
+module Spritely
+  class Image
+    attr_accessor :top
+    attr_reader :path, :data, :width, :height
+
+    def initialize(path)
+      @path = path
+      @data = File.read(path)
+      @width, @height = data[0x10..0x18].unpack('NN')
+    end
+
+    def left
+      0
+    end
+
+    def name
+      File.basename(path, ".png")
+    end
+  end
+end

data/lib/spritely/images_set.rb

@@ -0,0 +1,41 @@
+require 'spritely/image'
+
+module Spritely
+  class ImagesSet
+    extend Forwardable
+
+    def_delegator :@images, :each
+
+    attr_reader :files, :images
+
+    def initialize(files)
+      @files = files
+      @images = files.collect { |file| Image.new(file) }.sort_by(&:width).reverse
+      position!
+    end
+
+    def find(name)
+      images.find { |image| image.name == name }
+    end
+
+    def max_width
+      @max_width ||= images.collect(&:width).max
+    end
+
+    def total_height
+      @total_height ||= images.collect(&:height).reduce(:+)
+    end
+
+    def last_modification_time
+      files.collect { |file| Spritely.modification_time(file) }.max
+    end
+
+    private
+
+    def position!
+      images.each_with_index do |image, index|
+        image.top = images.collect(&:height)[0..index].reduce(:+) - image.height
+      end
+    end
+  end
+end

data/lib/spritely/sass_functions.rb

@@ -0,0 +1,44 @@
+require 'spritely/sprite_map'
+
+module Spritely
+  module SassFunctions
+    def sprite_map(glob)
+      SpriteMap.create(glob)
+    end
+
+    ::Sass::Script::Functions.declare :sprite_map, [:glob]
+
+    def sprite_url(sprite_map)
+      asset_url(Sass::Script::String.new("sprites/#{sprite_map.name}.png"))
+    end
+
+    ::Sass::Script::Functions.declare :sprite_url, [:sprite_map]
+
+    def sprite_position(sprite_map, image_name)
+      image = sprite_map.images.find(image_name.value)
+
+      x = Sass::Script::Number.new(image.left, image.left == 0 ? [] : ['px'])
+      y = Sass::Script::Number.new(-image.top, image.top == 0 ? [] : ['px'])
+
+      Sass::Script::List.new([x, y], :space)
+    end
+
+    ::Sass::Script::Functions.declare :sprite_position, [:sprite_map, :image_name]
+
+    def sprite_width(sprite_map, image_name)
+      image = sprite_map.images.find(image_name.value)
+
+      Sass::Script::Number.new(image.width, ['px'])
+    end
+
+    ::Sass::Script::Functions.declare :sprite_width, [:sprite_map, :image_name]
+
+    def sprite_height(sprite_map, image_name)
+      image = sprite_map.images.find(image_name.value)
+
+      Sass::Script::Number.new(image.height, ['px'])
+    end
+
+    ::Sass::Script::Functions.declare :sprite_height, [:sprite_map, :image_name]
+  end
+end

data/lib/spritely/sprite_map.rb

@@ -0,0 +1,53 @@
+require 'spritely/images_set'
+require 'spritely/generators/chunky_png'
+
+module Spritely
+  class SpriteMap
+    attr_accessor :options # Sass expects an object returned from a script function to have an #options accessor
+    attr_reader :glob
+
+    def self.create(*args)
+      new(*args).tap do |sprite_map|
+        sprite_map.generate! if sprite_map.needs_generation?
+      end
+    end
+
+    def initialize(glob)
+      @glob = glob.value
+    end
+
+    def images
+      @images ||= ImagesSet.new(files)
+    end
+
+    def generate!
+      Generators::ChunkyPng.create!(self)
+    end
+
+    def name
+      glob.split('/')[0..-2].join('-')
+    end
+
+    def filename
+      Spritely.directory.join("#{name}.png")
+    end
+
+    def needs_generation?
+      !File.exist?(filename) || outdated?
+    end
+
+    private
+
+    def files
+      Spritely.environment.paths.flat_map { |path| Dir.glob(File.join(path, glob)) }
+    end
+
+    def outdated?
+      images.last_modification_time > modification_time
+    end
+
+    def modification_time
+      Spritely.modification_time(filename)
+    end
+  end
+end

data/lib/spritely/version.rb

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

data/lib/spritely.rb

@@ -0,0 +1,20 @@
+require 'sass'
+require 'spritely/sass_functions'
+
+raise LoadError, "Spritely cannot be used in conjunction with Compass. Hope you choose Spritely!" if defined?(::Compass)
+
+module Spritely
+  def self.environment
+    ::Rails.application.assets
+  end
+
+  def self.directory
+    ::Rails.root.join('app', 'assets', 'images', 'sprites')
+  end
+
+  def self.modification_time(filename)
+    File.mtime(filename).to_i
+  end
+end
+
+::Sass::Script::Functions.send(:include, Spritely::SassFunctions)

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require 'pry-byebug'
+require 'spritely'
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}

data/spec/spritely/generators/chunky_png_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe Spritely::Generators::ChunkyPng do
+  let(:png_canvas) { double }
+
+  subject { Spritely::Generators::ChunkyPng.new(sprite_map) }
+
+  include_examples "a generator"
+
+  before { allow(::ChunkyPNG::Image).to receive(:new).with(100, 200).and_return(png_canvas) }
+
+  describe '#build!' do
+    before do
+      allow(::ChunkyPNG::Image).to receive(:from_blob).with('first image data').and_return('first image chunk')
+      allow(::ChunkyPNG::Image).to receive(:from_blob).with('second image data').and_return('second image chunk')
+    end
+
+    it 'should append each image to the PNG canvas' do
+      expect(png_canvas).to receive(:replace!).with('first image chunk', 1, 10)
+      expect(png_canvas).to receive(:replace!).with('second image chunk', 2, 20)
+      subject.build!
+    end
+  end
+
+  describe '#save!' do
+    it 'should save the PNG canvas' do
+      expect(png_canvas).to receive(:save).with('blah.png', :fast_rgba)
+      subject.save!
+    end
+  end
+end

data/spec/spritely/image_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Spritely::Image do
+  let(:path) { "#{__dir__}/../fixtures/test/foo.png" }
+
+  subject { Spritely::Image.new(path) }
+
+  its(:path) { should eq(path) }
+  its(:data) { should eq(File.read(path)) }
+  its(:width) { should eq(1) }
+  its(:height) { should eq(1) }
+  its(:left) { should eq(0) }
+  its(:name) { should eq('foo') }
+
+  describe '#top' do
+    before { subject.top = 123 }
+
+    its(:top) { should eq(123) }
+  end
+end

data/spec/spritely/images_set_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe Spritely::ImagesSet do
+  class ImageDouble < OpenStruct
+    attr_accessor :top
+  end
+
+  let(:first_image) { ImageDouble.new(name: 'foo', width: 1, height: 10) }
+  let(:second_image) { ImageDouble.new(name: 'bar', width: 100, height: 100) }
+
+  before do
+    allow(Spritely::Image).to receive(:new).with('first').and_return(first_image)
+    allow(Spritely::Image).to receive(:new).with('second').and_return(second_image)
+  end
+
+  subject! { Spritely::ImagesSet.new(['first', 'second']) }
+
+  its(:files) { should eq(['first', 'second']) }
+  its(:images) { should eq([second_image, first_image]) }
+  its(:max_width) { should eq(100) }
+  its(:total_height) { should eq(110) }
+
+  describe 'positioning' do
+    it 'should set the #top position of each image' do
+      expect(first_image.top).to eq(100)
+      expect(second_image.top).to eq(0)
+    end
+  end
+
+  describe '#each delegation' do
+    it 'should pass along the #each method call to the internal #images array' do
+      expect(first_image).to receive(:blah!)
+      expect(second_image).to receive(:blah!)
+      subject.each(&:blah!)
+    end
+  end
+
+  describe '#find' do
+    it 'should find the correct image by name' do
+      expect(subject.find('foo')).to eq(first_image)
+      expect(subject.find('bar')).to eq(second_image)
+    end
+  end
+
+  describe '#last_modification_time' do
+    before do
+      allow(Spritely).to receive(:modification_time).with('first').and_return(10)
+      allow(Spritely).to receive(:modification_time).with('second').and_return(100)
+    end
+
+    its(:last_modification_time) { should eq(100) }
+  end
+end

data/spec/spritely/sprite_map_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Spritely::SpriteMap do
+  subject { Spritely::SpriteMap.new(double(value: 'test/*.png')) }
+
+  before { Spritely.stub(:directory).and_return(File) }
+
+  its(:glob) { should eq('test/*.png') }
+  its(:name) { should eq('test') }
+  its(:filename) { should eq('test.png') }
+
+  describe '.create' do
+    let(:sprite_map) { double(needs_generation?: true) }
+
+    it 'should attempt to generate the sprite' do
+      allow(Spritely::SpriteMap).to receive(:new).with('test/*.png').and_return(sprite_map)
+      expect(sprite_map).to receive(:generate!)
+      Spritely::SpriteMap.create('test/*.png')
+    end
+  end
+
+  describe '#images' do
+    before do
+      Spritely.stub_chain(:environment, :paths).and_return(["#{__dir__}/../fixtures"])
+      allow(Spritely::ImagesSet).to receive(:new).with(["#{__dir__}/../fixtures/test/foo.png"]).and_return('images set')
+    end
+
+    its(:images) { should eq('images set') }
+  end
+
+  describe '#generate!' do
+    it 'should start the ChunkyPNG generator' do
+      expect(Spritely::Generators::ChunkyPng).to receive(:create!).with(subject)
+      subject.generate!
+    end
+  end
+
+  describe '#needs_generation?' do
+    let(:file_exists) { false }
+
+    before { allow(File).to receive(:exist?).with('test.png').and_return(file_exists) }
+
+    its(:needs_generation?) { should be_true }
+
+    context 'the sprite file already exists' do
+      let(:file_exists) { true }
+
+      before do
+        subject.stub_chain(:images, :last_modification_time).and_return(456)
+        allow(Spritely).to receive(:modification_time).and_return(123)
+      end
+
+      its(:needs_generation?) { should be_true }
+    end
+  end
+end

data/spec/spritely_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Spritely do
+  describe '.environment' do
+    before { stub_const('::Rails', double(application: double(assets: 'assets environment'))) }
+
+    its(:environment) { should eq('assets environment') }
+  end
+
+  describe '.directory' do
+    before { stub_const('::Rails', double(root: File)) }
+
+    its(:directory) { should eq('app/assets/images/sprites') }
+  end
+
+  describe '.modification_time' do
+    before { allow(File).to receive(:mtime).with('foo').and_return('123') }
+
+    it 'should give us the modification time' do
+      expect(Spritely.modification_time('foo')).to eq(123)
+    end
+  end
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,39 @@
+shared_examples "a generator" do
+  class ImagesDouble
+    def max_width; 100; end
+    def total_height; 200; end
+
+    def each(&block)
+      [
+        OpenStruct.new(data: 'first image data', left: 1, top: 10),
+        OpenStruct.new(data: 'second image data', left: 2, top: 20)
+      ].each(&block)
+    end
+  end
+
+  let(:sprite_map) { double(images: ImagesDouble.new, filename: 'blah.png') }
+
+  its(:sprite_map) { should eq(sprite_map) }
+
+  describe '.create!' do
+    let(:generator) { double }
+
+    before { allow(described_class).to receive(:new).with(sprite_map).and_return(generator) }
+
+    it 'should work some magic' do
+      expect(generator).to receive(:build!)
+      expect(generator).to receive(:ensure_directory_exists!)
+      expect(generator).to receive(:save!)
+      described_class.create!(sprite_map)
+    end
+  end
+
+  describe '#ensure_directory_exists!' do
+    before { allow(Spritely).to receive(:directory).and_return('blah') }
+
+    it 'should mkdir -p' do
+      expect(FileUtils).to receive(:mkdir_p).with('blah')
+      subject.ensure_directory_exists!
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: spritely
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Robbin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rspec
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- alex@robbinsweb.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/spritely.rb
+- lib/spritely/generators/base.rb
+- lib/spritely/generators/chunky_png.rb
+- lib/spritely/image.rb
+- lib/spritely/images_set.rb
+- lib/spritely/sass_functions.rb
+- lib/spritely/sprite_map.rb
+- lib/spritely/version.rb
+- spec/fixtures/test/foo.png
+- spec/spec_helper.rb
+- spec/spritely/generators/chunky_png_spec.rb
+- spec/spritely/image_spec.rb
+- spec/spritely/images_set_spec.rb
+- spec/spritely/sprite_map_spec.rb
+- spec/spritely_spec.rb
+- spec/support/shared_examples.rb
+homepage: http://www.robbinsweb.biz
+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: Hooks into the Rails asset pipeline to allow you to easily generate sprite
+  maps
+test_files:
+- spec/fixtures/test/foo.png
+- spec/spec_helper.rb
+- spec/spritely/generators/chunky_png_spec.rb
+- spec/spritely/image_spec.rb
+- spec/spritely/images_set_spec.rb
+- spec/spritely/sprite_map_spec.rb
+- spec/spritely_spec.rb
+- spec/support/shared_examples.rb