spritely 0.3.2 → 1.0.0

data/lib/spritely/version.rb

@@ -1,3 +1,3 @@
 module Spritely
-  VERSION = "0.3.2"
+  VERSION = "1.0.0"
 end

data/spec/fixtures/rails-app-changes/app/assets/stylesheets/sprites.css.scss

@@ -1,26 +1,18 @@
-$application-sprite: spritely-map("application/*.png",
-  $background-repeat: true,
-  $football-spacing: 100px,
-  $mario-spacing: 10px,
-  $mario-position: right,
-  $spacing: 5px
-);
-
 body {
-  background-image: spritely-url($application-sprite);
-  background-position: spritely-position($application-sprite, "background");
+  background-image: spritely-url("application");
+  background-position: spritely-position("application", "background");
 }
 
 #mario {
-  background-image: spritely-url($application-sprite);
-  background-position: spritely-position($application-sprite, "mario");
-  width: spritely-width($application-sprite, "mario");
-  height: spritely-height($application-sprite, "mario");
+  background-image: spritely-url("application");
+  background-position: spritely-position("application", "mario");
+  width: spritely-width("application", "mario");
+  height: spritely-height("application", "mario");
 }
 
 #arrow {
-  background-image: spritely-url($application-sprite);
-  background-position: spritely-position($application-sprite, "dropdown-arrow");
-  width: spritely-width($application-sprite, "dropdown-arrow");
-  height: spritely-height($application-sprite, "dropdown-arrow");
+  background-image: spritely-url("application");
+  background-position: spritely-position("application", "dropdown-arrow");
+  width: spritely-width("application", "dropdown-arrow");
+  height: spritely-height("application", "dropdown-arrow");
 }

data/spec/fixtures/rails-app/app/assets/images/sprites/application.png.sprite

@@ -0,0 +1,5 @@
+//= repeat background true
+//= spacing football 100
+//= spacing mario 10
+//= position mario right
+//= spacing 5

data/spec/fixtures/rails-app/app/assets/images/sprites/foo.png.sprite

@@ -0,0 +1 @@
+//= spacing 5

data/spec/fixtures/rails-app/app/assets/stylesheets/sprites.css.scss

@@ -1,19 +1,11 @@
-$application-sprite: spritely-map("application/*.png",
-  $background-repeat: true,
-  $football-spacing: 100px,
-  $mario-spacing: 10px,
-  $mario-position: right,
-  $spacing: 5px
-);
-
 body {
-  background-image: spritely-url($application-sprite);
-  background-position: spritely-position($application-sprite, "background");
+  background-image: spritely-url("application");
+  background-position: spritely-position("application", "background");
 }
 
 #mario {
-  background-image: spritely-url($application-sprite);
-  background-position: spritely-position($application-sprite, "mario");
-  width: spritely-width($application-sprite, "mario");
-  height: spritely-height($application-sprite, "mario");
+  background-image: spritely-url("application");
+  background-position: spritely-position("application", "mario");
+  width: spritely-width("application", "mario");
+  height: spritely-height("application", "mario");
 }

data/spec/fixtures/rails-app/app/assets/stylesheets/sprites_2.css.scss

@@ -1,8 +1,6 @@
-$foo-sprite: spritely-map("foo/*.png", $spacing: 5px);
-
 #foo {
-  background-image: spritely-url($foo-sprite);
-  background-position: spritely-position($foo-sprite, "fool");
-  width: spritely-width($foo-sprite, "fool");
-  height: spritely-height($foo-sprite, "fool");
+  background-image: spritely-url("foo");
+  background-position: spritely-position("foo", "fool");
+  width: spritely-width("foo", "fool");
+  height: spritely-height("foo", "fool");
 }

data/spec/integration/precompilation_spec.rb

@@ -1,14 +1,10 @@
 require 'spec_helper'
 
 describe 'Precompilation', :integration do
-  it 'should create the sprite in the right location' do
-    render_asset('sprites.css')
-    expect(File).to exist(File.join('app', 'assets', 'images', 'sprites', 'application.png'))
-  end
-
   it 'should compile the correct-looking sprite file' do
     render_asset('sprites.css')
-    compiled_sprite = ChunkyPNG::Image.from_file(File.join('app', 'assets', 'images', 'sprites', 'application.png'))
+    runner %~Rails.application.assets["sprites/application.png"].write_to("compiled-sprite.png")~
+    compiled_sprite = ChunkyPNG::Image.from_file('compiled-sprite.png')
     correct_sprite = ChunkyPNG::Image.from_file(File.join(__dir__, '..', 'fixtures', 'correct-sprite.png'))
     expect(compiled_sprite).to eq(correct_sprite)
   end
@@ -26,14 +22,6 @@ describe 'Precompilation', :integration do
     expect(sprite_files.length).to eq(1)
   end
 
-  it 'should compile even if the sprite files no longer exist' do
-    compile_assets
-    FileUtils.rm_rf(Dir.glob(File.join('app', 'assets', 'images', 'sprites', '*.png')))
-    compile_assets
-    expect(File).to exist(File.join('app', 'assets', 'images', 'sprites', 'application.png'))
-    expect(File).to exist(File.join('app', 'assets', 'images', 'sprites', 'foo.png'))
-  end
-
   it 'should correctly compile a new sprite image and CSS when files change' do
     compile_assets
     FileUtils.cp_r "#{__dir__}/../fixtures/rails-app-changes/.", "."

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require 'rspec'
 require 'rspec/its'
-require 'generator_spec/generator_example_group'
 require 'spritely'
 
 require 'pry-byebug'
@@ -12,9 +11,6 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 
-  config.include "Sprockets#{Spritely.sprockets_version}SassFunctionsHelpers".constantize, :sass_functions
-
   config.include RailsAppHelpers, :integration
-  config.include GeneratorSpec::GeneratorExampleGroup, :generator
   config.around(:each, :integration) { |example| within_rails_app(&example) }
 end

data/spec/spritely/collection_spec.rb

@@ -4,15 +4,15 @@ describe Spritely::Collection do
   let(:first_set) { double(repeated?: true, name: 'foo', width: 1, outer_height: 10, images: [1]) }
   let(:second_set) { double(repeated?: false, name: 'bar', width: 100, outer_height: 100, images: [2, 3]) }
 
-  subject { Spritely::Collection.new(['file-1.png', 'file-2.png'], {'file-1' => {repeat: true}}) }
+  subject { Spritely::Collection.new(['file-1.png', 'file-2.png'], { global: { spacing: '5' }, images: { 'file-1' => { repeat: 'true' } } }) }
 
   before do
-    allow(Spritely::ImageSet).to receive(:new).with('file-1.png', repeat: true).and_return(first_set)
-    allow(Spritely::ImageSet).to receive(:new).with('file-2.png', nil).and_return(second_set)
+    allow(Spritely::ImageSet).to receive(:new).with('file-1.png', repeat: 'true').and_return(first_set)
+    allow(Spritely::ImageSet).to receive(:new).with('file-2.png', spacing: '5').and_return(second_set)
   end
 
   its(:files) { should eq(['file-1.png', 'file-2.png']) }
-  its(:options) { should eq({'file-1' => {repeat: true}}) }
+  its(:options) { should eq({ global: { spacing: '5' }, images: { 'file-1' => { repeat: 'true' } } }) }
   its(:images) { should eq([1, 2, 3]) }
   its(:height) { should eq(110) }
 
@@ -29,12 +29,12 @@ describe Spritely::Collection do
   describe '#width' do
     let(:third_set) { double(repeated?: false, width: 65, height: 100) }
 
-    subject { Spritely::Collection.new(['file-1.png', 'file-2.png', 'file-3.png'], {}) }
+    subject { Spritely::Collection.new(['file-1.png', 'file-2.png', 'file-3.png'], { global: {}, images: {} }) }
 
     before do
-      allow(Spritely::ImageSet).to receive(:new).with('file-1.png', nil).and_return(first_set)
-      allow(Spritely::ImageSet).to receive(:new).with('file-2.png', nil).and_return(second_set)
-      allow(Spritely::ImageSet).to receive(:new).with('file-3.png', nil).and_return(third_set)
+      allow(Spritely::ImageSet).to receive(:new).with('file-1.png', {}).and_return(first_set)
+      allow(Spritely::ImageSet).to receive(:new).with('file-2.png', {}).and_return(second_set)
+      allow(Spritely::ImageSet).to receive(:new).with('file-3.png', {}).and_return(third_set)
     end
 
     its(:width) { should eq(100) }
@@ -77,6 +77,7 @@ describe Spritely::Collection do
     end
 
     its(:cache_key) { should eq('foobar') }
+    its(:to_s) { should eq('foobar') }
   end
 
   describe '#position!' do

data/spec/spritely/generators/chunky_png_spec.rb

@@ -1,32 +1,27 @@
 require 'spec_helper'
 
 describe Spritely::Generators::ChunkyPng do
-  let(:png_canvas) { double(metadata: {}) }
+  let(:png_canvas) { double(metadata: {}, to_blob: "final PNG content") }
+  let(:images) { [OpenStruct.new(data: 'first image data', left: 1, top: 10), OpenStruct.new(data: 'second image data', left: 2, top: 20)] }
+  let(:sprite_map) { double(images: images, width: 100, height: 200, filename: 'blah.png', cache_key: 'cachevalue') }
 
   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) }
 
+  its(:sprite_map) { should eq(sprite_map) }
+
   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
+    it 'should append each image to the PNG canvas and output to string' 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!
-      expect(png_canvas.metadata).to include('cache_key' => 'cachevalue')
+      expect(png_canvas).to receive(:to_blob).with(:fast_rgba)
+      expect(subject.build!).to eq('final PNG content')
     end
   end
 end

data/spec/spritely/image_set_spec.rb

@@ -3,7 +3,7 @@ require 'ostruct'
 
 describe Spritely::ImageSet do
   let(:path) { "#{__dir__}/../fixtures/test/foo.png" }
-  let(:options) { {repeat: true, spacing: 10, position: 'right'} }
+  let(:options) { {repeat: 'true', spacing: '10', position: 'right'} }
 
   subject { Spritely::ImageSet.new(path, options) }
 
@@ -26,12 +26,6 @@ describe Spritely::ImageSet do
   describe '#repeated?' do
     it { should be_repeated }
 
-    context 'repeat option is passed as truthy' do
-      let(:options) { {repeat: 'repeat'} }
-
-      it { should be_repeated }
-    end
-
     context 'repeat option is passed as false' do
       let(:options) { {repeat: false} }
 
@@ -85,7 +79,7 @@ describe Spritely::ImageSet do
       end
 
       context 'it is also positioned to the right' do
-        let(:options) { {position: 'right', repeat: true} }
+        let(:options) { {position: 'right', repeat: 'true'} }
 
         its(:left) { should eq(0) }
 

data/spec/spritely/sass_functions_spec.rb

@@ -1,54 +1,45 @@
 require 'spec_helper'
 require 'sprockets'
-require 'ostruct'
 
-describe Spritely::SassFunctions, :sass_functions do
-  class SpriteMapDouble < Sass::Script::Literal
-    def name; 'test'; end
-    def filename; 'test.png'; end
-    def files; []; end
-  end
-
-  let(:directory) { __dir__ }
-  let(:sprite_map) { SpriteMapDouble.new }
+describe Spritely::SassFunctions do
+  let(:asset) { double(metadata: { sprite_directives: 'directives' }) }
+  let(:sprite_map) { double(name: 'test') }
   let(:image) { double(left: 10, top: 12, width: 25, height: 50) }
 
   before do
-    allow(Spritely).to receive(:directory).and_return(directory)
-    allow(Spritely).to receive_message_chain(:sprockets_adapter, :reset_cache!)
-    allow(Spritely::SpriteMap).to receive(:create).and_return(sprite_map)
+    allow(sprockets_environment).to receive(:find_asset).with('sprites/test.png.sprite').and_return(asset)
+    allow(Spritely::SpriteMap).to receive(:new).with('test', sprockets_environment, 'directives').and_return(sprite_map)
     allow(sprite_map).to receive(:find).with('bar').and_return(image)
   end
 
-  shared_examples "a sprite function that checks image existence" do
-    let(:image) { nil }
+  shared_examples "a sprite function that checks sprite map and image existence" do
+    context "the sprite map doesn't exist" do
+      let(:asset) { nil }
 
-    it 'should raise a nice exception' do
-      expect { subject }.to raise_error(Sass::SyntaxError, "No image 'bar' found in sprite map 'test'.")
+      it 'should raise a nice exception' do
+        expect { subject }.to raise_error(Sass::SyntaxError, "No sprite map 'test' found.")
+      end
     end
-  end
 
-  shared_examples "a sprite function that resets the sprockets directory caches" do
-    it 'should clear the Sprockets cache' do
-      subject
+    context "the image doesn't exist in the sprite map" do
+      let(:image) { nil }
 
-      expect(Spritely.sprockets_adapter).to have_received(:reset_cache!).with(sprockets_environment, 'test.png')
+      it 'should raise a nice exception' do
+        expect { subject }.to raise_error(Sass::SyntaxError, "No image 'bar' found in sprite map 'test'.")
+      end
     end
   end
 
   describe '#spritely_url' do
-    subject { evaluate(".background-image { background-image: spritely-url(spritely-map('test/*.png')); }") }
-
-    it_should_behave_like "a sprite function that resets the sprockets directory caches"
+    subject { evaluate(".background-image { background-image: spritely-url('test'); }") }
 
     it { should eq(".background-image {\n  background-image: url(sprites/test.png); }\n") }
   end
 
   describe '#spritely_position' do
-    subject { evaluate(".background-position { background-position: spritely-position(spritely-map('test/*.png'), 'bar'); }") }
+    subject { evaluate(".background-position { background-position: spritely-position('test', 'bar'); }") }
 
-    it_should_behave_like "a sprite function that checks image existence"
-    it_should_behave_like "a sprite function that resets the sprockets directory caches"
+    it_should_behave_like "a sprite function that checks sprite map and image existence"
 
     it { should eq(".background-position {\n  background-position: -10px -12px; }\n") }
 
@@ -60,29 +51,39 @@ describe Spritely::SassFunctions, :sass_functions do
   end
 
   describe '#spritely_background' do
-    subject { evaluate(".background { background: spritely-background(spritely-map('test/*.png'), 'bar'); }") }
+    subject { evaluate(".background { background: spritely-background('test', 'bar'); }") }
 
-    it_should_behave_like "a sprite function that checks image existence"
-    it_should_behave_like "a sprite function that resets the sprockets directory caches"
+    it_should_behave_like "a sprite function that checks sprite map and image existence"
 
     it { should eq(".background {\n  background: url(sprites/test.png) -10px -12px; }\n") }
   end
 
   describe '#spritely_width' do
-    subject { evaluate(".width { width: spritely-width(spritely-map('test/*.png'), 'bar'); }") }
+    subject { evaluate(".width { width: spritely-width('test', 'bar'); }") }
 
-    it_should_behave_like "a sprite function that checks image existence"
-    it_should_behave_like "a sprite function that resets the sprockets directory caches"
+    it_should_behave_like "a sprite function that checks sprite map and image existence"
 
     it { should eq(".width {\n  width: 25px; }\n") }
   end
 
   describe '#spritely_height' do
-    subject { evaluate(".height { height: spritely-height(spritely-map('test/*.png'), 'bar'); }") }
+    subject { evaluate(".height { height: spritely-height('test', 'bar'); }") }
 
-    it_should_behave_like "a sprite function that checks image existence"
-    it_should_behave_like "a sprite function that resets the sprockets directory caches"
+    it_should_behave_like "a sprite function that checks sprite map and image existence"
 
     it { should eq(".height {\n  height: 50px; }\n") }
   end
+
+  def evaluate(value)
+    Sprockets::ScssProcessor.call(environment: sprockets_environment, data: value, filename: "test.scss", metadata: {}, cache: Sprockets::Cache.new)[:data]
+  end
+
+  def sprockets_environment
+    @sprockets_environment ||= Sprockets::CachedEnvironment.new(Sprockets::Environment.new).tap do |sprockets_environment|
+      sprockets_environment.context_class.class_eval do
+        def link_asset(path); end
+        def asset_path(path, options = {}); path; end
+      end
+    end
+  end
 end

data/spec/spritely/sprite_map_spec.rb

@@ -1,48 +1,27 @@
 require 'spec_helper'
 
 describe Spritely::SpriteMap do
-  let(:options_hash) { {'some_new_image_x' => 123, 'some_new_image_y' => 456, 'another_image_repeat' => true} }
-  let(:options_object) { double(options: 'options', cache_key: 'options') }
+  let(:options) { { global: {}, images: { 'some-new-image' => { x: '123', y: '456' }, 'another-image' => { repeat: 'true' } } } }
+  let(:environment) { double(paths: ["#{__dir__}/../fixtures"]) }
 
-  subject { Spritely::SpriteMap.new('test/*.png', options_hash) }
+  subject { Spritely::SpriteMap.new('test', environment, options) }
 
-  before do
-    allow(Spritely).to receive_message_chain(:environment, :paths).and_return(["#{__dir__}/../fixtures"])
-    allow(Spritely).to receive(:directory).and_return(File)
-    allow(Spritely::Options).to receive(:new).with(options_hash).and_return(options_object)
-  end
-
-  it { should be_a(Sass::Script::Literal) }
-
-  its(:glob) { should eq('test/*.png') }
-  its(:options) { should eq(options_object) }
   its(:name) { should eq('test') }
-  its(:filename) { should eq('test.png') }
-  its(:inspect) { should eq("#<Spritely::SpriteMap name=test options=#{options_object}>") }
-
-  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
+  its(:glob) { should eq('test/*.png') }
+  its(:environment) { should eq(environment) }
+  its(:options) { should eq(options) }
+  its(:inspect) { should eq("#<Spritely::SpriteMap name=test options=#{options}>") }
 
   describe '#cache_key' do
-    before do
-      allow(subject).to receive(:collection).and_return('collection value')
-      allow(Spritely::Cache).to receive(:generate).with(options_object, 'collection value').and_return('cache value')
-    end
+    before { allow(subject).to receive(:collection).and_return(double(to_s: 'collection cache value')) }
 
-    its(:cache_key) { should eq('cache value') }
+    its(:cache_key) { should eq('d9e141f6c3f40279f579b62a201c8f72') }
   end
 
   describe '#collection' do
     let(:collection) { double(find: 'find value', width: 'width value', height: 'height value', images: 'images value') }
 
-    before { allow(Spritely::Collection).to receive(:create).with(["#{__dir__}/../fixtures/test/foo.png"], options_object).and_return(collection) }
+    before { allow(Spritely::Collection).to receive(:create).with(["#{__dir__}/../fixtures/test/foo.png"], options).and_return(collection) }
 
     its(:collection) { should eq(collection) }
 
@@ -54,29 +33,14 @@ describe Spritely::SpriteMap do
     end
   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 }
+  describe '#save!' do
+    let(:generator) { double }
 
-    before { allow(File).to receive(:exist?).with('test.png').and_return(file_exists) }
-
-    its(:needs_generation?) { should be_truthy }
-
-    context 'the sprite file already exists' do
-      let(:file_exists) { true }
-
-      before do
-        allow(subject).to receive(:cache_key).and_return('value')
-        allow(Spritely::Cache).to receive(:busted?).with('test.png', 'value').and_return(true)
-      end
+    it 'should start the ChunkyPNG generator' do
+      expect(Spritely::Generators::ChunkyPng).to receive(:new).with(subject).and_return(generator)
+      expect(generator).to receive(:build!)
 
-      its(:needs_generation?) { should be_truthy }
+      subject.save!
     end
   end