spritely 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41e28bf3c683cf51ded0b5bf335e09274ba130c0
-  data.tar.gz: 0f2b23688154ab07300b3d14d7184d84af3d2eec
+  metadata.gz: 5b00a4ad9457e4493951eac13ca827af28207421
+  data.tar.gz: 2d89d336b23c78c6c4db583aaf4e37bf0fe3f958
 SHA512:
-  metadata.gz: 95f01f44df4c8d559fa3f2fbffa5cd5d972354d3471b025507747d99fc2d2e09cf9774062665e22586417c032f1763754779f4bfca9c1a3662b1cf1621166211
-  data.tar.gz: a23a5f9d76f0a8c34d127c2963ce740174c54b8efff1c633c3693c1b17e6b3d184404feb03b6f0de0c181a9e5c4c89d05d1ead3b049f9af3c949bc3bd8a813f0
+  metadata.gz: e84f5a25f0a49cd6ea73f59efe0261f630163595bdb7099fda42e5aa01afbab3f3989ba77a4e10bb7c002b97034c6d76e4017a5afe2403dfb663b9a93512542f
+  data.tar.gz: 7392bd00d2d4e4d0029f07c16a26b5c5a359e8b23716a35192db62f54ae666f030f722312c2d128f515e5566330676de591745a04833ef63dea40cc947b23c6c

data/lib/generators/spritely/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/base'
+
+module Spritely
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      def create_empty_sprites_folder
+        empty_directory Spritely.relative_folder_path
+        create_file "#{Spritely.relative_folder_path}/.keep"
+      end
+
+      def add_sprites_folder_to_gitignore
+        create_file '.gitignore', skip: true
+        inject_into_file '.gitignore', "\n#{Spritely.relative_folder_path.join('*.png')}\n", after: /\z/
+      end
+    end
+  end
+end

data/lib/spritely/generators/base.rb

@@ -10,7 +10,7 @@ module Spritely
       end
 
       def ensure_directory_exists!
-        FileUtils.mkdir_p(Spritely.directory)
+        raise("'#{Spritely.relative_folder_path}' doesn't exist. Run `rails generate spritely:install`.") unless File.exist?(Spritely.directory)
       end
 
       def build!

data/lib/spritely/sass_functions.rb

@@ -5,6 +5,7 @@ module Spritely
     def spritely_map(glob, kwargs = {})
       SpriteMap.create(glob.value, kwargs).tap do |sprite_map|
         reset_sprockets_directory_cache!
+        sprockets_context.depend_on(Spritely.directory)
         sprite_map.files.each do |file|
           sprockets_context.depend_on(file)
           sprockets_context.depend_on_asset(file)

data/lib/spritely/version.rb

@@ -1,3 +1,3 @@
 module Spritely
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/spritely.rb

@@ -8,6 +8,10 @@ module Spritely
   end
 
   def self.directory
-    ::Rails.root.join('app', 'assets', 'images', 'sprites')
+    ::Rails.root.join(relative_folder_path)
+  end
+
+  def self.relative_folder_path
+    Pathname.new(File.join('app', 'assets', 'images', 'sprites'))
   end
 end

data/spec/generators/spritely/install_generator_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'generators/spritely/install_generator'
+
+describe Spritely::Generators::InstallGenerator, :generator do
+  destination File.expand_path("../../../../tmp", __FILE__)
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  subject { destination_root }
+
+  it { is_expected.to have_structure {
+    directory 'app' do
+      directory 'assets' do
+        directory 'images' do
+          directory 'sprites' do
+            file '.keep'
+          end
+        end
+      end
+    end
+    file '.gitignore' do
+      contains 'app/assets/images/sprites/*.png'
+    end
+  } }
+end

data/spec/integration/precompilation_spec.rb

@@ -4,7 +4,7 @@ require 'active_support/core_ext/string'
 describe 'Precompilation', :integration do
   it 'should create the sprite in the right location' do
     render_asset('sprites.css')
-    expect(File.exist?(File.join('app', 'assets', 'images', 'sprites', 'application.png'))).to be_truthy
+    expect(File).to exist(File.join('app', 'assets', 'images', 'sprites', 'application.png'))
   end
 
   it 'should compile the correct-looking sprite file' do
@@ -26,4 +26,12 @@ describe 'Precompilation', :integration do
     sprite_files = Dir.glob(File.join('public', 'assets', 'sprites', 'application-*.png'))
     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
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 require 'rspec/its'
+require 'generator_spec/generator_example_group'
 require 'spritely'
 
 require 'pry-byebug'
@@ -12,5 +13,6 @@ RSpec.configure do |config|
   end
 
   config.include RailsAppHelpers, :integration
+  config.include GeneratorSpec::GeneratorExampleGroup, :generator
   config.around(:each, :integration) { |example| within_rails_app(&example) }
 end

data/spec/spritely/sass_functions_spec.rb

@@ -7,11 +7,12 @@ describe Spritely::SassFunctions do
     def files; []; end
   end
 
+  let(:directory) { __dir__ }
   let(:sprite_map) { SpriteMapDouble.new }
   let(:image) { double(left: 10, top: 12, width: 25, height: 50) }
 
   before do
-    allow(Spritely).to receive(:directory).and_return('spritely-directory')
+    allow(Spritely).to receive(:directory).and_return(directory)
     allow(Spritely::SpriteMap).to receive(:create).and_return(sprite_map)
     allow(sprite_map).to receive(:find).with('bar').and_return(image)
   end
@@ -27,7 +28,7 @@ describe Spritely::SassFunctions do
   shared_examples "a sprite function that resets the sprockets directory cache" do
     it 'should clear out the trail entries' do
       subject
-      expect(environment.send(:trail).instance_variable_get(:@entries)).to_not have_key('spritely-directory')
+      expect(environment.send(:trail).instance_variable_get(:@entries)).to_not have_key(directory)
     end
   end
 

data/spec/spritely_spec.rb

@@ -8,8 +8,12 @@ describe Spritely do
   end
 
   describe '.directory' do
-    before { stub_const('::Rails', double(root: File)) }
+    before { stub_const('::Rails', double(root: Pathname.new('foo/bar'))) }
 
-    its(:directory) { should eq('app/assets/images/sprites') }
+    its(:directory) { should eq(Pathname.new('foo/bar/app/assets/images/sprites')) }
+  end
+
+  describe '.relative_folder_path' do
+    its(:relative_folder_path) { should eq(Pathname.new('app/assets/images/sprites')) }
   end
 end

data/spec/support/rails_app_helpers.rb

@@ -3,8 +3,7 @@ module RailsAppHelpers
     '--skip-active-record',
     '--skip-test-unit',
     '--skip-javascript',
-    '--skip-spring',
-    '--skip-git'
+    '--skip-spring'
   ]
 
   def within_rails_app(&block)
@@ -19,6 +18,7 @@ module RailsAppHelpers
               f.write("gem 'spritely', path: '#{__dir__}/../../'\n")
             end
             %x(bundle install)
+            %x(rails generate spritely:install)
             FileUtils.cp_r "#{__dir__}/../fixtures/rails-app/.", "."
             yield
           end

data/spec/support/shared_examples.rb

@@ -18,11 +18,23 @@ shared_examples "a generator" do
   end
 
   describe '#ensure_directory_exists!' do
-    before { allow(Spritely).to receive(:directory).and_return('blah') }
+    let(:directory_exists) { true }
 
-    it 'should mkdir -p' do
-      expect(FileUtils).to receive(:mkdir_p).with('blah')
-      subject.ensure_directory_exists!
+    before do
+      allow(Spritely).to receive(:directory).and_return('blah')
+      allow(File).to receive(:exist?).with('blah').and_return(directory_exists)
+    end
+
+    it 'should not raise an exception' do
+      expect { subject.ensure_directory_exists! }.to_not raise_error
+    end
+
+    context 'the sprites folder does not exist' do
+      let(:directory_exists) { false }
+
+      it 'should raise an exception' do
+        expect { subject.ensure_directory_exists! }.to raise_error("'app/assets/images/sprites' doesn't exist. Run `rails generate spritely:install`.")
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spritely
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alex Robbin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -142,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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
@@ -149,6 +163,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/spritely/install_generator.rb
 - lib/spritely.rb
 - lib/spritely/cache.rb
 - lib/spritely/collection.rb
@@ -170,6 +185,7 @@ files:
 - spec/fixtures/rails-app/app/assets/stylesheets/sprites.css.scss
 - spec/fixtures/rails-app/app/assets/stylesheets/sprites_2.css.scss
 - spec/fixtures/test/foo.png
+- spec/generators/spritely/install_generator_spec.rb
 - spec/integration/precompilation_spec.rb
 - spec/integration/stylesheet_spec.rb
 - spec/spec_helper.rb
@@ -219,6 +235,7 @@ test_files:
 - spec/fixtures/rails-app/app/assets/stylesheets/sprites.css.scss
 - spec/fixtures/rails-app/app/assets/stylesheets/sprites_2.css.scss
 - spec/fixtures/test/foo.png
+- spec/generators/spritely/install_generator_spec.rb
 - spec/integration/precompilation_spec.rb
 - spec/integration/stylesheet_spec.rb
 - spec/spec_helper.rb