montage 0.2.1 → 0.3.0

data/spec/montage/sass_builder_spec.rb

@@ -14,15 +14,9 @@ describe Montage::SassBuilder do
 
     context 'with a project containing a single sprite and two sources' do
       before(:each) do
-        @helper.write_config <<-CONFIG
-        ---
-          only:
-            - one
-            - two
-        CONFIG
-
-        @helper.write_source('one')
-        @helper.write_source('two')
+        @helper.write_simple_config
+        @helper.write_source('only/one')
+        @helper.write_source('only/two')
 
         Montage::SassBuilder.new(@helper.project).write
 
@@ -63,7 +57,7 @@ describe Montage::SassBuilder do
 
       it 'should include the background statement' do
         @sass.should include(
-          "  background: url(/images/sprites/only.png)")
+          "  background: url(/images/only.png)")
       end
 
       describe 'the generated mixins' do
@@ -76,7 +70,7 @@ describe Montage::SassBuilder do
           SASS
 
           sass.should include(
-            'background: url(/images/sprites/only.png) 0px 0px no-repeat')
+            'background: url(/images/only.png) 0px 0px no-repeat')
         end
 
         it 'should correctly position the second source' do
@@ -88,7 +82,7 @@ describe Montage::SassBuilder do
           SASS
 
           sass.should include(
-            'background: url(/images/sprites/only.png) 0px -40px no-repeat')
+            'background: url(/images/only.png) 0px -40px no-repeat')
         end
 
         it 'should apply x-offsets' do
@@ -100,7 +94,7 @@ describe Montage::SassBuilder do
           SASS
 
           sass.should include(
-            'background: url(/images/sprites/only.png) 5px 0px no-repeat')
+            'background: url(/images/only.png) 5px 0px no-repeat')
         end
 
         it 'should apply y-offsets' do
@@ -113,25 +107,16 @@ describe Montage::SassBuilder do
 
           # -20px (source one) - 20px (padding) - 10px (third arg) = -50px
           sass.should include(
-            'background: url(/images/sprites/only.png) 0px -50px no-repeat')
+            'background: url(/images/only.png) 0px -50px no-repeat')
         end
       end
     end # with a project containing a single sprite and two sources
 
     context 'with a project containing two sprites, each with two sources' do
       before(:each) do
-        @helper.write_config <<-CONFIG
-        ---
-          first:
-            - one
-            - two
+        @helper.write_simple_config
 
-          second:
-            - three
-            - four
-        CONFIG
-
-        %w( one two three four ).each do |source|
+        %w( first/one first/two second/three second/four ).each do |source|
           @helper.write_source(source)
         end
 
@@ -157,33 +142,21 @@ describe Montage::SassBuilder do
         @sass.should =~ /^=second-sprite/
       end
 
-      it 'should include a condition for the "one" source' do
+      it 'should include a condition for the first sprite sources' do
         expected = Regexp.escape(
           %[  @if $icon == "one"\n] +
-          %[    $y_offset: $y_offset - 0px])
-
-        @sass.should =~ /^#{expected}/
-      end
-
-      it 'should include a condition for the "two" source' do
-        expected = Regexp.escape(
+          %[    $y_offset: $y_offset - 0px\n] +
           %[  @else if $icon == "two"\n] +
           %[    $y_offset: $y_offset - #{20 + @helper.project.padding}px])
 
         @sass.should =~ /^#{expected}/
       end
 
-      it 'should include a condition for the "three" source' do
-        expected = Regexp.escape(
-          %[  @if $icon == "three"\n] +
-          %[    $y_offset: $y_offset - 0px])
-
-        @sass.should =~ /^#{expected}/
-      end
-
-      it 'should include a condition for the "four" source' do
+      it 'should include a condition for the second sprite sources' do
         expected = Regexp.escape(
-          %[  @else if $icon == "four"\n] +
+          %[  @if $icon == "four"\n] +
+          %[    $y_offset: $y_offset - 0px\n] +
+          %[  @else if $icon == "three"\n] +
           %[    $y_offset: $y_offset - #{20 + @helper.project.padding}px])
 
         @sass.should =~ /^#{expected}/
@@ -191,12 +164,12 @@ describe Montage::SassBuilder do
 
       it 'should include the background statement for the first sprite' do
         @sass.should include(
-          "  background: url(/images/sprites/first.png)")
+          "  background: url(/images/first.png)")
       end
 
       it 'should include the background statement for the second sprite' do
         @sass.should include(
-          "  background: url(/images/sprites/second.png)")
+          "  background: url(/images/second.png)")
       end
     end # with a project containing two sprites, each with two sources
 
@@ -206,11 +179,12 @@ describe Montage::SassBuilder do
         ---
           config.sass: "public/sass"
 
-          only:
-            - one
+          "public/images/sprites/:name/*.{png,jpg,jpeg,gif}":
+            to: "public/images/:name.png"
+
         CONFIG
 
-        @helper.write_source('one')
+        @helper.write_source('only/one')
         Montage::SassBuilder.new(@helper.project).write
       end
 
@@ -226,11 +200,12 @@ describe Montage::SassBuilder do
         ---
           config.sass: "public/sass/_here.sass"
 
-          only:
-            - one
+          "public/images/sprites/:name/*.{png,jpg,jpeg,gif}":
+            to: "public/images/:name.png"
+
         CONFIG
 
-        @helper.write_source('one')
+        @helper.write_source('only/one')
         Montage::SassBuilder.new(@helper.project).write
       end
 
@@ -240,17 +215,18 @@ describe Montage::SassBuilder do
       end
     end # with a project using a custom SASS location with a file name
 
-    context 'with a project using a custom sprite_url setting' do
+    context 'with a project using a custom url setting' do
       before(:each) do
         @helper.write_config <<-CONFIG
         ---
-          config.sprite_url: "/right/about/here"
+          config.url: "/right/about/here/:name.png"
+
+          "public/images/sprites/:name/*.{png,jpg,jpeg,gif}":
+            to: "public/images/:name.png"
 
-          only:
-            - one
         CONFIG
 
-        @helper.write_source('one')
+        @helper.write_source('only/one')
 
         Montage::SassBuilder.new(@helper.project).write
 
@@ -262,7 +238,7 @@ describe Montage::SassBuilder do
         @sass.should include(
           "  background: url(/right/about/here/only.png)")
       end
-    end # with a project using a custom sprite_url setting
+    end # with a project using a custom url setting
 
   end # build
 

data/spec/montage/source_spec.rb

@@ -3,50 +3,29 @@ require File.expand_path('../../spec_helper', __FILE__)
 describe Montage::Source do
   subject { Montage::Source }
 
-  # --- path -----------------------------------------------------------------
+  # --- image -----------------------------------------------------------------
 
-  it { should have_public_method_defined(:path) }
+  it { should have_public_method_defined(:image) }
 
-  describe '#path' do
+  describe '#image' do
     before(:each) do
       @helper = Montage::Spec::ProjectHelper.new
-      @helper.write_config <<-CONFIG
-      ---
-        sprite_one:
-          - one
-          - two
-      CONFIG
-
-      @helper.write_source('one', 100, 25)
-      @helper.write_source('two', 100, 25)
+      @helper.write_simple_config
+      @helper.write_source('sprite_one/one', 100, 25)
     end
 
-    it 'should return the path when the source file exists' do
-      name = @helper.project.sprites.first.sources.first.name
-
-      source = Montage::Source.new(@helper.project.paths.sources, name, 'nm')
-      source.path.should == @helper.project.paths.sources + "#{name}.png"
+    it 'should return the Image instance path when the source file exists' do
+      source = Montage::Source.new(@helper.path_to_source('sprite_one/one'))
+      source.image.should be_a(Magick::Image)
     end
 
     it 'should raise an error when the source file does not exist' do
       running = lambda {
-        Montage::Source.new(
-          @helper.project.paths.sources, '__invalid__', 'nm').path
-      }
-
-      running.should raise_error(Montage::MissingSource,
-        /Couldn't find a matching file/)
-    end
-
-    it 'should raise an error when the source directory does not exist' do
-      name = @helper.project.sprites.first.sources.first.name
-
-      running = lambda {
-        Montage::Source.new(Pathname.new('__invalid__'), name, 'nm').path
+        Montage::Source.new(@helper.path_to_source('__invalid__')).image
       }
 
       running.should raise_error(Montage::MissingSource,
-        /Couldn't find the source directory/)
+        /Couldn't find the source file/)
     end
   end
 

data/spec/montage/sprite_definition_spec.rb

@@ -0,0 +1,361 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Montage::SpriteDefinition do
+  subject { Montage::SpriteDefinition }
+
+  # --------------------------------------------------------------------------
+
+  before(:each) do
+    @helper = Montage::Spec::ProjectHelper.new
+    @helper.write_simple_config
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with src/*, matching two sources' do
+    before(:each) do
+      @helper.touch('src/big', 'src/small')
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, 'src/*', 'name' => 'lurrr', "to" => "_")
+
+      @return = definition.to_sprites
+    end
+
+    it 'should return a single sprite' do
+      @return.length.should == 1
+    end
+
+    it 'should set the sprite name' do
+      @return.first.name.should == 'lurrr'
+    end
+
+    it 'should have two sources' do
+      @return.first.should have(2).sources
+
+      sources = @return.first.sources
+
+      sources.detect { |source| source.name == 'small' }.should be
+      sources.detect { |source| source.name == 'big' }.should be
+    end
+
+    it 'should set the sprite save path' do
+      @return.first.save_path.should == @helper.path_to_file('_')
+    end
+
+    it 'should set the padding to 20' do
+      @return.first.padding.should == 20
+    end
+
+    it 'should set the url' do
+      @return.first.url.should == '/images/lurrr.png'
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with src/:name/*, matching two sprites with two sources each' do
+    before(:each) do
+      @helper.touch('src/big/one', 'src/small/one')
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, 'src/:name/*', "to" => ":name")
+
+      @return = definition.to_sprites
+    end
+
+    it 'should return two sprites' do
+      @return.length.should == 2
+      @return.detect { |sprite| sprite.name == 'small' }.should be
+      @return.detect { |sprite| sprite.name == 'big' }.should be
+    end
+
+    it 'should have one source in each sprite' do
+      @return.each { |sprite| sprite.should have(1).sources }
+    end
+
+    it 'should set the sprite save paths' do
+      @return.each do |sprite|
+        sprite.save_path.should == @helper.path_to_file(sprite.name)
+      end
+    end
+
+    it 'should set the padding to 20' do
+      @return.each { |sprite| sprite.padding == 20 }
+    end
+
+    it 'should set the sprite urls' do
+      @return.each do |sprite|
+        sprite.url.should == "/images/#{sprite.name}.png"
+      end
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with **/:name/*, matching two sprites with two sources each' do
+    before(:each) do
+      @helper.touch 'base/one/big/one',
+                    'base/two/big/two',
+                    'base/one/small/three',
+                    'base/two/small/four'
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, '**/:name/*', "to" => ":name")
+
+      @return = definition.to_sprites
+    end
+
+    it 'should return two sprites' do
+      @return.length.should == 2
+      @return.detect { |sprite| sprite.name == 'small' }.should be
+      @return.detect { |sprite| sprite.name == 'big' }.should be
+    end
+
+    it 'should have two sources in each sprite' do
+      @return.each { |sprite| sprite.should have(2).sources }
+    end
+
+    it 'should set the sprite save paths' do
+      @return.each do |sprite|
+        sprite.save_path.should == @helper.path_to_file(sprite.name)
+      end
+    end
+
+    it 'should set the padding to 20' do
+      @return.each { |sprite| sprite.padding == 20 }
+    end
+
+    it 'should set the sprite urls' do
+      @return.each do |sprite|
+        sprite.url.should == "/images/#{sprite.name}.png"
+      end
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with src/:name/*.{png,jpg}, matching one sprite with two sources' do
+    before(:each) do
+      @helper.touch 'src/sprite/one.png',
+                    'src/sprite/two.jpg',
+                    'src/sprite/three.app', # non-match
+                    'src/sprite/four'       # non-match
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, 'src/:name/*.{png,jpg}', "to" => ":name")
+
+      @return = definition.to_sprites
+    end
+
+    it 'should return a single sprite' do
+      @return.length.should == 1
+    end
+
+    it 'should have two sources' do
+      @return.first.should have(2).sources
+
+      sources = @return.first.sources
+
+      sources.detect { |source| source.name == 'one' }.should be
+      sources.detect { |source| source.name == 'two' }.should be
+    end
+
+    it 'should set the sprite save path' do
+      @return.first.save_path.should == @helper.path_to_file('sprite')
+    end
+
+    it 'should set the padding to 20' do
+      @return.first.padding.should == 20
+    end
+
+    it 'should set the url' do
+      @return.first.url.should == '/images/sprite.png'
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with (absolute)/src/:name/*, matching two sprites with one source each' do
+    before(:each) do
+      @helper.touch('src/big/one', 'src/small/one')
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, @helper.project.paths.root + 'src/:name/*',
+        "to" => ":name")
+
+      @return = definition.to_sprites
+    end
+
+    it 'should return two sprites' do
+      @return.length.should == 2
+      @return.detect { |sprite| sprite.name == 'small' }.should be
+      @return.detect { |sprite| sprite.name == 'big' }.should be
+    end
+
+    it 'should have one source in each sprite' do
+      @return.each { |sprite| sprite.should have(1).sources }
+    end
+
+    it 'should set the sprite save paths' do
+      @return.each do |sprite|
+        sprite.save_path.should == @helper.path_to_file(sprite.name)
+      end
+    end
+
+    it 'should set the padding to 20' do
+      @return.each { |sprite| sprite.padding == 20 }
+    end
+
+    it 'should set the sprite urls' do
+      @return.each do |sprite|
+        sprite.url.should == "/images/#{sprite.name}.png"
+      end
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with a custom padding option set to 50' do
+    before(:each) do
+      @helper.touch('src/big/one')
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, 'src/:name/*', 'padding' => 50)
+
+      @return = definition.to_sprites
+    end
+
+    it 'should set the padding to 50' do
+      @return.first.padding == 50
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'where the project customises the padding to 50' do
+    before(:each) do
+      @helper.touch('src/big/one')
+      @helper.write_config <<-CONFIG
+        ---
+          config.padding: 50
+
+          "public/images/sprites/:name/*.{png,jpg,jpeg,gif}":
+            to: "public/images/:name.png"
+      CONFIG
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, 'src/:name/*')
+
+      @return = definition.to_sprites
+    end
+
+    it 'should set the padding to 50' do
+      @return.first.padding == 50
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with a custom url option set to /omicron_persei_8' do
+    before(:each) do
+      @helper.touch('src/big/one')
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, 'src/:name/*', 'url' => '/omicron_persei_8/:name')
+
+      @return = definition.to_sprites
+    end
+
+    it 'should set the sprite url' do
+      @return.first.url.should == '/omicron_persei_8/big'
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with a custom url option using the :filename segment' do
+    before(:each) do
+      @helper.touch('src/big/one')
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, 'src/:name/*', 'url' => '/omicron_persei_8/:filename')
+
+      @return = definition.to_sprites
+    end
+
+    it 'should set the sprite url' do
+      @return.first.url.should == '/omicron_persei_8/big.png'
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'where the project customises the URL to /omicron_persei_8' do
+    before(:each) do
+      @helper.touch('src/big/one')
+      @helper.write_config <<-CONFIG
+        ---
+          config.url: "/omicron_persei_8/:name"
+
+          "public/images/sprites/:name/*.{png,jpg,jpeg,gif}":
+            to: "public/images/:name.png"
+      CONFIG
+
+      definition = Montage::SpriteDefinition.new(
+        @helper.project, 'src/:name/*')
+
+      @return = definition.to_sprites
+    end
+
+    it 'should set the sprite url' do
+      @return.first.url.should == '/omicron_persei_8/big'
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with a :name capture, and a "name" option' do
+    it 'should raise an error' do
+      running = lambda { @path = Montage::SpriteDefinition.new(
+        @helper.project, '/__invalid__/:name/*',
+        'name' => 'lurrr', 'to' => ':name') }
+
+      running.should raise_error(Montage::DuplicateName)
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with a :name capture, and no :name segment in the "to" option' do
+    it 'should raise an error' do
+      running = lambda { @path = Montage::SpriteDefinition.new(
+        @helper.project, '/:name/*', 'to' => '_') }
+
+      running.should raise_error(Montage::MissingName)
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with a no :name capture, and and no "name" option' do
+    it 'should raise an error' do
+      running = lambda { Montage::SpriteDefinition.new(
+        @helper.project, '/__invalid__/*', "to" => "_") }
+
+      running.should raise_error(Montage::MissingName)
+    end
+  end
+
+  # --------------------------------------------------------------------------
+
+  context 'with no "to" option' do
+    it 'should set a default' do
+      @sprite = Montage::SpriteDefinition.new(@helper.project, '_',
+        'name' => 'lurrr').to_sprites.first
+
+      @sprite.save_path.should_not be_nil
+    end
+  end
+
+end