antw-kin 0.3.2 → 0.3.3

data/lib/kin/tasks/sprites.rb

@@ -0,0 +1,34 @@
+namespace :kin do
+
+  desc "Regenerates the sprite images. Any sprites which haven't been " \
+       "changed won't be regenerated."
+
+  task 'sprites' do
+    generate_sprites!(false)
+  end
+
+  desc "Regenerates the sprite images, even those which have not been " \
+       "changed."
+
+  task 'sprites:force' do
+    generate_sprites!(true)
+  end
+
+  ##
+  # Generates the sprites for the current Merb application.
+  #
+  # @param [Boolean] force
+  #   Defines whether to regenerate sprites which haven't been changed.
+  #
+  def generate_sprites!(force)
+    require 'kin/sprites'
+    require 'kin/sprites/rake_runner'
+
+    Kin::Sprites::RakeRunner.new(
+      File.join(Merb.dir_for(:config), 'sprites.yml'),
+      File.join(Merb.dir_for(:image), 'sprites'),
+      File.join(Merb.dir_for(:stylesheet), 'sass', '_sprites.sass')
+    ).generate!(force)
+  end
+
+end

data/spec/fixture/app/views/nav_specs/has_right_formatter.html.haml

@@ -0,0 +1,9 @@
+:ruby
+  Kin::Nav.setup(:test, Kin::Nav::Formatters::HasRight(:right_one, :right_two)) do |nav|
+    # Items with titles.
+    nav.add(:left, 'Left')
+    nav.add(:right_one, 'Right one')
+    nav.add(:right_two, 'Right one')
+  end
+
+= display_navigation(:test)

data/spec/fixture/app/views/nav_specs/subnav_formatter.html.haml

@@ -0,0 +1,7 @@
+:ruby
+  Kin::Nav.setup(:test, Kin::Nav::Formatters::Subnav) do |nav|
+    nav.add(:one, 'One')
+    nav.add(:two, 'Two')
+  end
+
+= display_navigation(:test)

data/spec/fixture/config/sprites.different.yml

@@ -0,0 +1,11 @@
+---
+  # Used in the RakeRunner specs to test
+  # a sprite definition being changed.
+
+  general:
+    - one
+    - three
+
+  more:
+    - two
+    - three

data/spec/fixture/config/sprites.yml

@@ -0,0 +1,9 @@
+---
+  general:
+    - one
+    - two
+    - three
+
+  more:
+    - two
+    - three

data/spec/masthead_spec.rb

@@ -1,52 +1,10 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
 
-# Masthead::Builder Specs ======================================================
-
-describe 'masthead builder setter', :shared => true do
-  it 'should set the attribute if a value is given' do
-    @builder.send(@method, 'my_value').should == 'my_value'
-  end
-
-  it 'should not change the attribute value if nil is given' do
-    @builder.send(@method, 'my_value')
-    @builder.send(@method).should == 'my_value'
-    @builder.send(@method, nil).should == 'my_value'
-  end
-
-  it 'should set the extra options' do
-    @builder.send(@method, 'my_value', { :link => '/' })
-    @builder.options[@method].should == { :link => '/' }
-  end
-end
-
 describe Kin::Masthead::Builder do
   before(:each) do
     @builder = Kin::Masthead::Builder.new
   end
 
-  # -------
-  # Setters
-
-  describe '#title' do
-    before(:each) { @method = :title }
-    it_should_behave_like 'masthead builder setter'
-  end
-
-  describe '#subtitle' do
-    before(:each) { @method = :subtitle }
-    it_should_behave_like 'masthead builder setter'
-  end
-
-  describe '#right_title' do
-    before(:each) { @method = :right_title }
-    it_should_behave_like 'masthead builder setter'
-  end
-
-  describe '#right_subtitle' do
-    before(:each) { @method = :right_subtitle }
-    it_should_behave_like 'masthead builder setter'
-  end
-
   # -----
   # build
 
@@ -98,7 +56,7 @@ describe Kin::Masthead::Builder do
     it 'should render an empty right title when no right title is set, but ' +
        'a right subtitle is set' do
       @c.render(:right_subtitle).should have_selector('.extra .main') do |main|
-        main.to_s.should =~ / /
+        main.to_xhtml.should include(' ') # Unicode non-breaking space.
       end
     end
 
@@ -130,16 +88,6 @@ describe Kin::Masthead::Builder do
       @c.render(:right_subtitle).should have_selector('.extra .subtitle')
     end
 
-    # Border.
-
-    it 'should not have a "no_border" class by default' do
-      @c.render(:border).should_not have_selector('.no_border')
-    end
-
-    it 'should have a "no_border" class when no_border = true' do
-      @c.render(:no_border).should have_selector('.no_border')
-    end
-
     # Links.
 
     it 'should add links to fields when a :link option is present' do
@@ -202,27 +150,3 @@ describe Kin::Masthead::Builder do
   end
 
 end
-
-# Masthead::Helper Specs =====================================================
-
-describe 'Masthead helper mixin' do
-  include Kin::Masthead::Helper
-
-  describe '#masthead' do
-    it 'should pass along the :no_border option' do
-      masthead(:no_border => true) { |_| }
-      masthead_builder.no_border.should be_true
-    end
-
-    it 'should pass the block along to #build' do
-      masthead { |m| m.title('Title') }
-      masthead_builder.title.should == 'Title'
-    end
-  end
-
-  describe '#masthead_builder' do
-    it 'should return the same instance each time' do
-      masthead_builder.object_id.should == masthead_builder.object_id
-    end
-  end
-end

data/spec/nav_spec.rb

@@ -145,6 +145,38 @@ describe Kin::Nav do
       end
     end
 
+    # ------------------
+    # HasRight formatter
+
+    describe 'with the HasRight formatter' do
+      before(:each) do
+        @html = @c.render(:has_right_formatter)
+      end
+
+      it 'should apply a custom style the right-aligned items' do
+        %w( right_one right_two ).each do |name|
+          @html.should have_selector("#nav_#{name} span.right_border")
+        end
+      end
+
+      it 'should use the default style for items not right-aligned' do
+        @html.should_not have_selector('#nav_left span.right_border')
+      end
+    end
+
+    # ----------------
+    # Subnav formatter
+
+    describe 'with the Subnav formatter' do
+      it 'should apply a custom style to all items' do
+        html = @c.render(:subnav_formatter)
+
+        %w( one two ).each do |name|
+          html.should have_selector("#nav_#{name} span.pill")
+        end
+      end
+    end
+
     # ------
     # titles
 

data/spec/spec_helper.rb

@@ -19,6 +19,37 @@ Spec::Runner.configure do |config|
   config.include(Merb::Test::ViewHelper)
   config.include(Merb::Test::RouteHelper)
   config.include(Merb::Test::ControllerHelper)
+  config.include(Module.new do
+    ##
+    # Returns a path to the fixture directory. Any additional string
+    # parameters will be joined with the path.
+    #
+    def fixture_path(*dirs)
+      File.join(File.dirname(__FILE__), 'fixture', *dirs)
+    end
+
+    ##
+    # Returns a path to the tmp/spec folder. Any additional string
+    # parameters will be joined with the path.
+    #
+    def tmp_path(*dirs)
+      File.join(File.dirname(__FILE__), '..', 'tmp', 'spec', *dirs)
+    end
+
+    ##
+    # Does exactly what it says on the tin.
+    #
+    def capture_stdout
+      orig, $stdout = $stdout, StringIO.new
+
+      begin
+        yield
+        return $stdout.string
+      ensure
+        $stdout = orig
+      end
+    end
+  end)
 end
 
 ##

data/spec/sprites_spec.rb

@@ -0,0 +1,349 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+sprites = File.join(File.dirname(__FILE__), '..', 'lib', 'kin', 'sprites')
+
+require sprites
+require File.join(sprites, 'rake_runner')
+
+# IconSet ====================================================================
+
+describe Kin::Sprites::IconSet do
+  it 'should include Enumerable' do
+    Kin::Sprites::IconSet.ancestors.should include(Enumerable)
+  end
+
+  describe '#each' do
+    it 'should yield each icon in turn' do
+      icons, yielded = %w(one two), []
+
+      Kin::Sprites::IconSet.new(icons).each do |icon|
+        yielded << icon
+      end
+
+      yielded.should == icons
+    end
+  end
+
+  describe '#location_of' do
+    before(:each) do
+      @set = Kin::Sprites::IconSet.new(%w(one two))
+    end
+
+    it 'should return 0 if the given icon is first' do
+      @set.location_of('one').should == 0
+    end
+
+    it 'should return 40 if the given icon is second' do
+      @set.location_of('two').should == 40
+    end
+  end
+
+  describe '#length' do
+    it 'should return the number of icons in the set' do
+      Kin::Sprites::IconSet.new([]).length.should == 0
+      Kin::Sprites::IconSet.new(['one']).length.should == 1
+      Kin::Sprites::IconSet.new(['one', 'two']).length.should == 2
+    end
+  end
+end
+
+# ImageGenerator =============================================================
+
+# Requires:
+#
+# @gen (Kin::Sprites::ImageGenerator)
+#   An image generator instance.
+# @sprite_path (String)
+#   A path to where a sprite should be saved.
+#
+describe 'saving a sprite', :shared => true do
+  it 'should save the image to the specified path' do
+    lambda { @gen.save(@sprite_path) }.should \
+      change(&lambda { File.exists?(@sprite_path) })
+  end
+
+  it 'should silently overwrite any existing file at the specified path' do
+    FileUtils.touch(@sprite_path)
+    orig_size = File.size(@sprite_path)
+    @gen.save(@sprite_path)
+
+    # Using touch should create a zero-byte file (as near as makes no
+    # difference, anyway). Saving the PNG should result in a larger file.
+    File.exists?(@sprite_path).should be_true
+    File.size(@sprite_path).should > orig_size
+  end
+
+  it 'should save a 32-bit PNG' do
+    @gen.save(@sprite_path)
+    image = Magick::Image.ping(@sprite_path).first
+    image.format.should == 'PNG'
+    image.quantum_depth.should == 8 # 8-bits per channel.
+  end
+
+  it 'should create a 16 pixel wide image' do
+    @gen.save(@sprite_path)
+    Magick::Image.ping(@sprite_path).first.columns.should == 16
+  end
+end
+
+describe Kin::Sprites::ImageGenerator, '#save' do
+  ##
+  # Creates an ImageGenerator instance suitable for use in specs.
+  #
+  # @param [Array<String>] An array of icons to use.
+  #
+  def create_image_generator(icons)
+    Kin::Sprites::ImageGenerator.new(
+      Kin::Sprites::IconSet.new(icons),
+      fixture_path('public', 'images', 'sprites', 'src')
+    )
+  end
+
+  before(:all) do
+    @dir = tmp_path('sprites')
+    @sprite_path = tmp_path('sprites', 'sprite.png')
+    FileUtils.mkdir_p(@dir)
+  end
+
+  after(:all) do
+    FileUtils.rmdir(@dir)
+  end
+
+  after(:each) do
+    FileUtils.rm(@sprite_path) if @sprite_path && File.exists?(@sprite_path)
+  end
+
+  # On with the specs...
+
+  describe 'when creating a sprite with a single icon' do
+    before(:each) do
+      @gen = create_image_generator(['one'])
+    end
+
+    it_should_behave_like 'saving a sprite'
+
+    it 'should create a 16 pixel high image' do
+      # 40 pixels with the top and bottom 12 (blank) cropped off
+      @gen.save(@sprite_path)
+      Magick::Image.ping(@sprite_path).first.rows.should == 16
+    end
+  end
+
+  describe 'when creating a sprite with a three icons' do
+    before(:each) do
+      @gen = create_image_generator(['one', 'two', 'three'])
+    end
+
+    it_should_behave_like 'saving a sprite'
+
+    it 'should create a 96 pixel high image' do
+      # 120 pixels with the top and bottom 12 (blank) cropped off
+      @gen.save(@sprite_path)
+      Magick::Image.ping(@sprite_path).first.rows.should == 96
+    end
+  end
+
+  it 'should raise IconNotReadable when one of the icons does not exist' do
+    block = lambda { create_image_generator(['not_here']).save(@sprite_path) }
+    block.should raise_error(
+      Kin::Sprites::ImageGenerator::IconNotReadable, /unable to open/)
+  end
+
+  it 'should raise TargetNotWriteable when the sprite path is not ' \
+     'writeable' do
+    gen = create_image_generator(['one'])
+    orig_perms = File.stat(@dir).mode
+    File.chmod(0000, @dir)
+
+    begin
+      lambda { gen.save(@sprite_path) }.should raise_error(
+        Kin::Sprites::ImageGenerator::TargetNotWriteable, /Permission denied/)
+    ensure
+      File.chmod(orig_perms, @dir)
+    end
+  end
+end
+
+# SassGenerator ==============================================================
+
+describe Kin::Sprites::SassGenerator, '#to_sass' do
+  before(:each) do
+    @set  = Kin::Sprites::IconSet.new(%w(one two three))
+    @gen  = Kin::Sprites::SassGenerator.new(@set, 'mysprites')
+    @sass = @gen.to_sass('/images/sprites')
+  end
+
+  it 'should not indent mixin definitions' do
+    @sass.each_line do |line|
+      line.should =~ /^=/ if line =~ /=\w+-icon/
+    end
+  end
+
+  it 'should indent if statements with two spaces' do
+    @sass.each_line do |line|
+      line.should =~ /^  @/ if line =~ /@(?:else|if)/
+    end
+  end
+
+  it 'should indent position assigments with four spaces' do
+    @sass.each_line do |line|
+      line.should =~ /^    !pos/ if line =~ /@pos = -\d+px/
+    end
+  end
+
+  it 'should indent background statements with two spaces' do
+    @sass.each_line do |line|
+      line.should =~ /  :background/ if line =~ /:background/
+    end
+  end
+
+  it 'should include statements for all the icons' do
+    @sass.should include('!icon == "one"')
+    @sass.should include('!icon == "two"')
+    @sass.should include('!icon == "three"')
+  end
+
+  it 'should use an `@if` statement for the first icon' do
+    @sass.should include('@if !icon == "one"')
+    @sass.should_not include('@if !icon == "two"')
+    @sass.should_not include('@if !icon == "three"')
+  end
+
+  it 'should use an `@else if` statement for subsequence icons' do
+    @sass.should_not include('@else if !icon == "one"')
+    @sass.should include('@else if !icon == "two"')
+    @sass.should include('@else if !icon == "three"')
+  end
+
+  it 'should use the given base directory when creating the sprite path' do
+    @sass.should =~ %r{url\(/images/sprites}
+  end
+
+  it 'should use the generator name when creating the sprite path' do
+    @sass.should include('mysprites.png')
+  end
+end
+
+# RakeRunner =================================================================
+
+##
+# Copies the icons source files from fixture/public/images/sprites/src to
+# the tmp/spec/sprites/src directory. Removes tmp/spec/sprites when done.
+#
+describe Kin::Sprites::RakeRunner do
+  before(:each) do
+    FileUtils.mkdir_p(tmp_path('sprites'))
+    FileUtils.cp_r(fixture_path('public', 'images', 'sprites'), tmp_path)
+  end
+
+  after(:each) do
+    FileUtils.rm_r(tmp_path('sprites'))
+  end
+
+  def rake_runner(sprites_yml = 'sprites.yml')
+    Kin::Sprites::RakeRunner.new(
+      fixture_path('config', sprites_yml),
+      tmp_path('sprites'),
+      tmp_path('sprites', '_sprites.sass'))
+  end
+
+  it 'should raise an error when sprites.yml could not be found' do
+    lambda {
+      Kin::Sprites::RakeRunner.new(
+        'not_here.yml',
+        fixture_path('public', 'images', 'sprites'),
+        fixture_path('public', 'stylesheets', 'sass', '_sprites.sass')
+      )
+    }.should raise_error(Kin::Sprites::SpriteError)
+  end
+
+  describe 'when no sprites have been previously generated' do
+    it 'should generate the sprite files' do
+      out = capture_stdout { rake_runner.generate! }
+      out.should =~ /Regenerated "general"/
+      out.should =~ /Regenerated "more"/
+    end
+
+    it 'should generate the SASS partial' do
+      out = capture_stdout { rake_runner.generate! }
+      out.should =~ /Saved SASS/
+    end
+  end
+
+  describe 'when the sprites have been previously generated,' do
+    describe 'and one has changed' do
+      before(:each) do
+        capture_stdout { rake_runner.generate! }
+      end
+
+      it 'should regenerate the changed sprite file' do
+        out = capture_stdout { rake_runner('sprites.different.yml').generate! }
+        out.should =~ /Regenerated "general"/
+      end
+
+      it 'should not regenerate the unchanged sprite file' do
+        out = capture_stdout { rake_runner('sprites.different.yml').generate! }
+        out.should =~ /Ignoring "more"/
+      end
+
+      it 'should regenerate the SASS partial' do
+        out = capture_stdout { rake_runner('sprites.different.yml').generate! }
+        out.should =~ /Saved SASS/
+      end
+    end
+
+    describe 'have not changed,' do
+      before(:each) do
+        capture_stdout { rake_runner.generate! }
+      end
+
+      describe 'and :force is false' do
+        it 'should not regenerate the sprite files' do
+          out = capture_stdout { rake_runner.generate! }
+          out.should =~ /Ignoring "general"/
+          out.should =~ /Ignoring "more"/
+        end
+
+        it 'should not regenerate the SASS partial' do
+          out = capture_stdout { rake_runner.generate! }
+          out.should_not =~ /Saved SASS/
+        end
+      end
+
+      describe 'and :force is true' do
+        it 'should regenerate the sprite files' do
+          out = capture_stdout { rake_runner.generate!(true) }
+          out.should =~ /Regenerated "general"/
+          out.should =~ /Regenerated "more"/
+        end
+
+        it 'should regenerate the SASS partial' do
+          out = capture_stdout { rake_runner.generate!(true) }
+          out.should =~ /Saved SASS/
+        end
+      end
+
+      describe 'and a sprite has been deleted' do
+        before(:each) do
+          FileUtils.rm(tmp_path('sprites', 'general.png'))
+        end
+
+        it 'should regenerate the deleted sprite' do
+          out = capture_stdout { rake_runner.generate! }
+          out.should =~ /Regenerated "general"/
+        end
+
+        it 'should not regenereate the unchanged sprite' do
+          out = capture_stdout { rake_runner.generate! }
+          out.should =~ /Ignoring "more"/
+        end
+
+        it 'should regenerate the SASS partial' do
+          out = capture_stdout { rake_runner.generate!(true) }
+          out.should =~ /Saved SASS/
+        end
+      end
+    end
+  end
+
+end