montage 0.2.1

data/spec/lib/fixtures.rb

@@ -0,0 +1,7 @@
+Spec::Runner.configure do |config|
+  config.include(Module.new do
+    def fixture_path(name, *segments)
+      File.join(File.expand_path("../../fixtures/#{name}", __FILE__), *segments)
+    end
+  end)
+end

data/spec/lib/have_public_method_defined.rb

@@ -0,0 +1,19 @@
+::Spec::Matchers.define :have_public_method_defined do |value|
+  match do |klass|
+    klass.public_method_defined?(value.to_sym)
+  end
+
+  description do
+    "should define public instance method ##{value.to_s}"
+  end
+
+  failure_message_for_should do |klass|
+    "expected #{klass.inspect} to define public instance method " \
+    "#{value.inspect}, but it didn't"
+  end
+
+  failure_message_for_should_not do |klass|
+    "expected #{klass.inspect} to not define public instance method " \
+    "#{value.inspect}, but it did"
+  end
+end

data/spec/lib/project_helper.rb

@@ -0,0 +1,135 @@
+require 'rbconfig'
+require 'tempfile'
+
+module Montage
+  module Spec
+    # Provides useful functionality for dealing with temporary project
+    # directories when running tests.
+    #
+    # Any helper classes which use ProjectHelper will always run in a single
+    # temporary directory (which is removed and recreated each time) and thus
+    # doesn't need to be cleaned up afterwards.
+    #
+    class ProjectHelper
+
+      # --- Class methods ----------------------------------------------------
+
+      def self.project_dir
+        @project_dir ||= Pathname.new(Dir.mktmpdir)
+      end
+
+      def project_dir
+        self.class.project_dir
+      end
+
+      def self.cleanup!
+        FileUtils.remove_entry_secure(project_dir) if project_dir.directory?
+      end
+
+      # ----------------------------------------------------------------------
+
+      def initialize
+        # Wipe out the temporary directory to ensure
+        # we have a clean state before each run.
+        self.class.cleanup!
+        project_dir.mkpath
+
+        self.sources_path = "public/images/sprites/src"
+        self.sprites_path = "public/images/sprites"
+      end
+
+      def sources_path=(path)
+        @sources_path = Pathname.new(path)
+      end
+
+      def sprites_path=(path)
+        @sprites_path = Pathname.new(path)
+      end
+
+      # Returns a project instance representing the contents of the test
+      # directory.
+      #
+      # @return [Montage::Project]
+      #
+      def project
+        Project.find(project_dir)
+      end
+
+      # --- Paths ------------------------------------------------------------
+
+      # Returns the path to a file.
+      #
+      # @param [String] name
+      #   The name of the source file.
+      #
+      def path_to_file(name)
+        (project_dir + name).expand_path
+      end
+
+      # Returns the path to a source file (sans extension).
+      #
+      # @param [String] name
+      #   The name of the source file.
+      #
+      def path_to_source(name)
+        path_to_file @sources_path + "#{name}.png"
+      end
+
+      # Returns the path to a sprite file (sans extension).
+      #
+      # @param [String] name
+      #   The name of the sprite file.
+      #
+      def path_to_sprite(name)
+        path_to_file @sprites_path + "#{name}.png"
+      end
+
+      # --- File Writers -----------------------------------------------------
+
+      # Writes montage.yml file in the project root with the given contents.
+      #
+      # @param [String] contents
+      #   The contents to be saved as the config file.
+      #
+      def write_config(contents)
+        File.open(project_dir + 'montage.yml', 'w') do |file|
+          file.puts contents.unindent
+        end
+      end
+
+      # Writes a source image file to the src directory.
+      #
+      # @param [String] name
+      #   The name of the source image file, sans extension.
+      # @param [Integer] width
+      #   The width of the source file in pixels.
+      # @param [Integer] height
+      #   The height of the source file in pixels.
+      #
+      def write_source(name, width = 50, height = 20)
+        source_path = path_to_source(name)
+
+        # Create the sources directory.
+        source_path.dirname.mkpath
+
+        Magick::Image.new(width, height) do
+          self.background_color = '#CCC'
+        end.write(source_path)
+
+        unless source_path.file?
+          raise "Source #{name} was not successfully saved"
+        end
+      end
+
+      # Creates a directory in the project.
+      #
+      # @param [String] dir
+      #   Path to the directory, relative to the project root.
+      #
+      def mkdir(path)
+        (project_dir + path).mkpath
+      end
+
+    end # ProjectHelper
+  end # Spec
+end # Montage

data/spec/lib/shared_project_specs.rb

@@ -0,0 +1,32 @@
+describe 'a project with correct paths', :shared => true do
+  # Requires:
+  #
+  #   @project => Montage::Project
+  #   @root    => Pathname (path to project root)
+  #   @config  => Pathname (path to config file)
+  #
+
+  it 'should set the project root path' do
+    @project.paths.root.should == @root
+  end
+
+  it 'should set the configuration file path' do
+    @project.paths.config.should == @config
+  end
+
+  it 'should set the sources path' do
+    @project.paths.sources.should == @root + 'public/images/sprites/src'
+  end
+
+  it 'should set the sprite path' do
+    @project.paths.sprites.should == @root + 'public/images/sprites'
+  end
+
+  it 'should set the SASS output path' do
+    @project.paths.sass.should == @root + 'public/stylesheets/sass'
+  end
+
+  it 'should set the CSS sprite URL' do
+    @project.paths.url.should == '/images/sprites'
+  end
+end

data/spec/lib/shared_sprite_specs.rb

@@ -0,0 +1,30 @@
+describe 'saving a sprite', :shared => true do
+  # Requires:
+  #
+  #   @sprite => Montage::Sprite
+  #   @dir    => Pathname (path at which the sprite is saved)
+  #   @output => Pathname (path for the final sprite)
+  #
+  it 'should save the sprite to the specified directory' do
+    lambda { @sprite.write }.should \
+      change(&lambda { @output.file? })
+  end
+
+  it 'should save an 8-bit PNG with transparency' do
+    @sprite.write
+    image = Magick::Image.ping(@output).first
+    image.format.should == 'PNG'
+    image.quantum_depth.should == 8 # 8-bits per channel.
+  end
+
+  it 'should overwrite an existingn file' do
+    FileUtils.touch(@output)
+    orig_size = @output.size
+    @sprite.write
+
+    # Using touch should create an empty file. Saving the PNG
+    # should result in a larger file.
+    @output.should be_file
+    @output.size.should > orig_size
+  end
+end

data/spec/montage/commands/generate_spec.rb

@@ -0,0 +1,308 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a single sprite with two sources' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        sprite_one:
+          - one
+          - two
+    CONFIG
+    @runner.write_source('one')
+    @runner.write_source('two')
+    @runner.run!
+  end
+
+  it { @runner.should be_success }
+  it { @runner.stdout.should =~ /Generating "sprite_one": Done/ }
+  it { @runner.path_to_sprite('sprite_one').should be_file }
+  it { @runner.dimensions_of('sprite_one').should == [50, 60] }
+
+  # Sass.
+  it { @runner.path_to_file('public/stylesheets/sass/_montage.sass').should be_file }
+
+  # PNGOut.
+  it { @runner.stdout.should =~ /Optimising "sprite_one": Done/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating multiple sprites' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        sprite_one:
+          - one
+
+        sprite_two:
+          - two
+          - three
+    CONFIG
+    @runner.write_source('one')
+    @runner.write_source('two')
+    @runner.write_source('three', 200, 200)
+    @runner.run!
+  end
+
+  it { @runner.should be_success }
+
+  it { @runner.stdout.should =~ /Generating "sprite_one": Done/ }
+  it { @runner.path_to_sprite('sprite_one').should be_file }
+  it { @runner.dimensions_of('sprite_one').should == [50, 20] }
+
+  it { @runner.stdout.should =~ /Generating "sprite_two": Done/ }
+  it { @runner.path_to_sprite('sprite_two').should be_file }
+  it { @runner.dimensions_of('sprite_two').should == [200, 240] }
+
+  # PNGOut.
+  it { @runner.stdout.should =~ /Optimising "sprite_one": Done/ }
+  it { @runner.stdout.should =~ /Optimising "sprite_two": Done/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a single sprite with custom padding' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        config.padding: 50
+
+        sprite_one:
+          - one
+          - two
+    CONFIG
+    @runner.write_source('one')
+    @runner.write_source('two')
+    @runner.run!
+  end
+
+  it { @runner.should be_success }
+  it { @runner.stdout.should =~ /Generating "sprite_one": Done/ }
+  it { @runner.path_to_sprite('sprite_one').should be_file }
+  it { @runner.dimensions_of('sprite_one').should == [50, 90] }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a single sprite using custom directories' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.sources_path = 'img/sources'
+    @runner.sprites_path = 'img/sprites'
+
+    @runner.write_config <<-CONFIG
+      ---
+        config.sources: img/sources
+        config.sprites: img/sprites
+
+        sprite_one:
+          - one
+          - two
+    CONFIG
+
+    @runner.write_source('one')
+    @runner.write_source('two')
+    @runner.run!
+  end
+
+  it { @runner.should be_success }
+  it { @runner.stdout.should =~ /Generating "sprite_one": Done/ }
+  it { @runner.path_to_sprite('sprite_one').should be_file }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Trying to generate sprites in a non-project directory' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage').run!
+  end
+
+  it { @runner.should be_failure }
+  it { @runner.stdout.should =~ /Couldn't find a Montage project/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Trying to generate sprites when a source is missing' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        sprite_one:
+          - one
+    CONFIG
+    @runner.mkdir('public/images/sprites/src')
+    @runner.run!
+  end
+
+  it { @runner.should be_failure }
+  it { @runner.stdout.should =~ /Couldn't find a matching file for source image `one'/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Trying to generate sprites when the source directory does not exist' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        sprite_one:
+          - one
+    CONFIG
+    @runner.run!
+  end
+
+  it { @runner.should be_failure }
+  it { @runner.stdout.should =~ /Couldn't find the source directory/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Trying to generate sprites when the sprite directory is not writable' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        sprite_one:
+          - one
+    CONFIG
+    @runner.write_source('one')
+
+    old_mode = @runner.project.paths.sprites.stat.mode
+    @runner.project.paths.sprites.chmod(040555)
+
+    begin
+      @runner.run!
+    ensure
+      @runner.project.paths.sprites.chmod(old_mode)
+    end
+  end
+
+  it { @runner.should be_failure }
+  it { @runner.stdout.should =~ /can't save the sprite in .* isn't writable/m }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating two sprites, one of which is unchanged' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        sprite_one:
+          - one
+          - two
+
+        sprite_two:
+          - three
+    CONFIG
+    @runner.write_source('one')
+    @runner.write_source('two')
+    @runner.write_source('three')
+    @runner.run!
+
+    # Change the 'one' source.
+    @runner.write_source('one', 100, 25)
+    @runner.run!
+  end
+
+  it { @runner.should be_success }
+
+  it { @runner.stdout.should =~ /Generating "sprite_one": Done/ }
+  it { @runner.path_to_sprite('sprite_one').should be_file }
+  it { @runner.dimensions_of('sprite_one').should == [100, 65] }
+
+  it { @runner.stdout.should =~ /Generating "sprite_two": Unchanged; ignoring/ }
+  it { @runner.path_to_sprite('sprite_two').should be_file }
+  it { @runner.dimensions_of('sprite_two').should == [50, 20] }
+
+  # PNGOut.
+  it { @runner.stdout.should =~ /Optimising "sprite_one": Done/ }
+  it { @runner.stdout.should_not =~ /Optimising "sprite_two": Done/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating two sprites, one of which is unchanged when using the --force option' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        sprite_one:
+          - one
+          - two
+
+        sprite_two:
+          - three
+    CONFIG
+    @runner.write_source('one')
+    @runner.write_source('two')
+    @runner.write_source('three')
+    @runner.run!
+
+    # Change the 'one' source.
+    @runner.write_source('one', 100, 25)
+    @runner.run('montage --force')
+  end
+
+  it { @runner.should be_success }
+  it { @runner.stdout.should =~ /Generating "sprite_one": Done/ }
+  it { @runner.stdout.should =~ /Generating "sprite_two": Done/ }
+
+  # PNGOut.
+  it { @runner.stdout.should =~ /Optimising "sprite_one": Done/ }
+  it { @runner.stdout.should =~ /Optimising "sprite_two": Done/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating an unchanged sprite which has been deleted' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        sprite_one:
+          - one
+
+    CONFIG
+    @runner.write_source('one')
+    @runner.run!
+
+    # Remove the generated sprite.
+    @runner.path_to_sprite('sprite_one').unlink
+    @runner.run!
+  end
+
+  it { @runner.should be_success }
+
+  it { @runner.stdout.should =~ /Generating "sprite_one": Done/ }
+  it { @runner.path_to_sprite('sprite_one').should be_file }
+
+  # PNGOut.
+  it { @runner.stdout.should =~ /Optimising "sprite_one": Done/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating sprites with a project which disables Sass' do
+  before(:all) do
+    @runner = Montage::Spec::CommandRunner.new('montage')
+    @runner.write_config <<-CONFIG
+      ---
+        config.sass: false
+
+        sprite_one:
+          - one
+
+    CONFIG
+    @runner.write_source('one')
+    @runner.run!
+  end
+
+  it { @runner.path_to_file('public/stylesheets/sass/_montage.sass').should_not be_file }
+end