montage 0.2.1

data/lib/montage/sprite.rb

@@ -0,0 +1,132 @@
+module Montage
+  # Represents a collection of images which will be used to make a sprite.
+  #
+  class Sprite
+    attr_reader :name
+
+    # Creates a new Sprite instance.
+    #
+    # @param [String] name
+    #   The name of the sprite. Will be used as the sprite filename (with an
+    #   extension added).
+    # @param [Array<String>] sources
+    #   The name of each source image.
+    # @param [Project] Project
+    #   The project to which the sprite belongs.
+    #
+    def initialize(name, sources, project)
+      @name, @project = name, project
+
+      @sources =
+        sources.inject(ActiveSupport::OrderedHash.new) do |hash, source|
+          hash[source] = Source.new(@project.paths.sources, source, @name)
+          hash
+        end
+    end
+
+    # Returns an array of Source instances held by this Sprite.
+    #
+    # @return [Array<Source>]
+    #
+    def sources
+      @sources.map { |_, source| source }
+    end
+
+    # Returns an array of RMagick image instances; one for each source.
+    #
+    # @return [Array<Magick::Image>]
+    #   The Image instances for the sources.
+    #
+    def images
+      sources.map { |source| source.image }
+    end
+
+    # Returns the path to the sprite on disk.
+    #
+    # @return [Pathname]
+    #
+    def path
+      @project.paths.sprites + "#{@name}.png"
+    end
+
+    # Returns the y-position of a given source.
+    #
+    # @return [Integer, Source]
+    #   The vertical position of the source image.
+    #
+    def position_of(source)
+      source = source.name if source.is_a?(Source)
+
+      unless @sources.keys.include?(source)
+        raise MissingSource,
+          "Source image '#{source}' is not present in the '#{@name}' sprite"
+      end
+
+      unless @positions
+        # Rather than calculate each time we call position_of, cache the
+        # position of each image the first time it is called. Since we almost
+        # always want the position of each image at some point (when
+        # generating CSS), it works out faster to fetch each source height
+        # just once.
+        @positions = {}
+        @sources.inject(0) do |offset, (name, src)|
+          @positions[name] = offset
+          offset + src.image.rows + 20
+        end
+      end
+
+      @positions[source]
+    end
+
+    # Returns a digest which represents the sprite and it's contents. If any
+    # of the file _contents_ or source names change, so will the hash.
+    #
+    # @return [Digest::SHA256]
+    #
+    def digest
+      Digest::SHA256.hexdigest(sources.map { |source| source.digest }.join)
+    end
+
+    # Uses RMagick to creates a 8-bit (with alpha) PNG containing all of the
+    # source files.
+    #
+    # If a file exists at the output path, it will be overwritten.
+    #
+    # @raise [Montage::TargetNotWritable]
+    #   Raised when the output directory can not be written to.
+    #
+    def write
+      unless @project.paths.sprites.writable?
+        raise TargetNotWritable, <<-MESSAGE
+          Montage can't save the sprite in `#{@project.paths.sprites.to_s}'
+          as it isn't writable.
+        MESSAGE
+      end
+
+      list = sources.inject(Magick::ImageList.new) do |list, source|
+        list << source.image
+        list << Magick::Image.new(1, @project.padding) do
+          self.background_color = '#FFF0'
+        end
+      end
+
+      # RMagick uses instance_eval, @set isn't available in the block below.
+      sources_length = sources.length
+
+      montage = list.montage do
+        self.gravity = Magick::NorthWestGravity
+        # Transparent background.
+        self.background_color = '#FFF0'
+        # Allow each image to take up as much space as it needs.
+        self.geometry = '+0+0'
+        # columns=1, rows=Sources plus padding.
+        self.tile = Magick::Geometry.new(1, sources_length * 2)
+      end
+
+      # Remove the blank space from the bottom of the image.
+      montage.crop!(0, 0, 0, (montage.first.rows) - @project.padding)
+      montage.write("PNG32:#{path}")
+    end
+
+  end # Set
+end # Montage

data/lib/montage/templates/montage.yml

@@ -0,0 +1,26 @@
+---
+
+  # If you need to specify non-standard locations for the source
+  # files, or the output locations for the sprites or SASS, change
+  # the relevant option below. Directories are relative to the
+  # project root unless they have a leading slash.
+
+  config.sources:    <sources>
+  config.sprites:    <sprites>
+  config.sass:       "public/stylesheets/sass"
+  config.sprite_url: "/images/sprites"
+
+  # --------------------------------------------------------------------------
+
+  # The sample below will produce two sprites (one.png and two.png) with the
+  # specified source images. You can omit file extensions.
+
+  one:
+    - book
+    - box-label
+    - calculator
+
+  two:
+    - calendar-month
+    - camera
+    - eraser

data/lib/montage/templates/sass_mixins.erb

@@ -0,0 +1,20 @@
+// The mixins in this file are automatically generated by the 'montage'
+// command provided by the montage' gem. Don't edit this file directly; change
+// the montage.yml configuration file, then re-run 'montage'
+
+<% @project.sprites.each do |sprite| %>
+=<%= sprite.name %>-sprite($icon, $x_offset: 0px, $y_offset: 0px)
+<% sprite.sources.each_with_index do |source, index| %>
+  @<%= index == 0 ? '' : 'else ' %>if $icon == "<%= source.name %>"
+    $y_offset: $y_offset - <%= sprite.position_of(source) %>px
+<% end %>
+  background: url(<%= @project.paths.url + "/#{sprite.name}.png" %>) $x_offset $y_offset no-repeat
+
+=<%= sprite.name %>-sprite-pos($icon, $x_offset: 0px, $y_offset: 0px)
+<% sprite.sources.each_with_index do |source, index| %>
+  @<%= index == 0 ? '' : 'else ' %>if $icon == "<%= source.name %>"
+    $y_offset: $y_offset - <%= sprite.position_of(source) %>px
+<% end %>
+  background-position: $x_offset $y_offset
+
+<% end %>

data/lib/montage/version.rb

@@ -0,0 +1,3 @@
+module Montage
+  VERSION = File.read(File.expand_path('../../../VERSION', __FILE__)).strip
+end

data/montage.gemspec

@@ -0,0 +1,145 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{montage}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anthony Williams"]
+  s.date = %q{2010-04-08}
+  s.default_executable = %q{montage}
+  s.description = %q{Even Rocky had a montage.}
+  s.email = %q{hi@antw.me}
+  s.executables = ["montage"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "History.md",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bin/montage",
+     "lib/montage.rb",
+     "lib/montage/commands.rb",
+     "lib/montage/commands/generate.rb",
+     "lib/montage/commands/init.rb",
+     "lib/montage/core_ext.rb",
+     "lib/montage/project.rb",
+     "lib/montage/sass_builder.rb",
+     "lib/montage/source.rb",
+     "lib/montage/sprite.rb",
+     "lib/montage/templates/montage.yml",
+     "lib/montage/templates/sass_mixins.erb",
+     "lib/montage/templates/sources/book.png",
+     "lib/montage/templates/sources/box-label.png",
+     "lib/montage/templates/sources/calculator.png",
+     "lib/montage/templates/sources/calendar-month.png",
+     "lib/montage/templates/sources/camera.png",
+     "lib/montage/templates/sources/eraser.png",
+     "lib/montage/version.rb",
+     "montage.gemspec",
+     "spec/fixtures/custom_dirs/montage.yml",
+     "spec/fixtures/default/montage.yml",
+     "spec/fixtures/default/public/images/sprites/src/one.png",
+     "spec/fixtures/default/public/images/sprites/src/three.png",
+     "spec/fixtures/default/public/images/sprites/src/two.png",
+     "spec/fixtures/directory_config/config/montage.yml",
+     "spec/fixtures/missing_source/montage.yml",
+     "spec/fixtures/missing_source_dir/montage.yml",
+     "spec/fixtures/root_config/montage.yml",
+     "spec/fixtures/root_config/public/images/sprites/src/source_one.png",
+     "spec/fixtures/root_config/public/images/sprites/src/source_three.jpg",
+     "spec/fixtures/root_config/public/images/sprites/src/source_two",
+     "spec/fixtures/sources/hundred.png",
+     "spec/fixtures/sources/mammoth.png",
+     "spec/fixtures/sources/other.png",
+     "spec/fixtures/sources/twenty.png",
+     "spec/fixtures/subdirs/montage.yml",
+     "spec/fixtures/subdirs/sub/sub/keep",
+     "spec/lib/command_runner.rb",
+     "spec/lib/fixtures.rb",
+     "spec/lib/have_public_method_defined.rb",
+     "spec/lib/project_helper.rb",
+     "spec/lib/shared_project_specs.rb",
+     "spec/lib/shared_sprite_specs.rb",
+     "spec/montage/commands/generate_spec.rb",
+     "spec/montage/commands/init_spec.rb",
+     "spec/montage/core_ext_spec.rb",
+     "spec/montage/project_spec.rb",
+     "spec/montage/sass_builder_spec.rb",
+     "spec/montage/source_spec.rb",
+     "spec/montage/spec/have_public_method_defined_spec.rb",
+     "spec/montage/sprite_spec.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/spec.rake",
+     "tasks/yard.rake"
+  ]
+  s.has_rdoc = false
+  s.homepage = %q{http://github.com/antw/montage}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Montage}
+  s.test_files = [
+    "spec/lib/command_runner.rb",
+     "spec/lib/fixtures.rb",
+     "spec/lib/have_public_method_defined.rb",
+     "spec/lib/project_helper.rb",
+     "spec/lib/shared_project_specs.rb",
+     "spec/lib/shared_sprite_specs.rb",
+     "spec/montage/commands/generate_spec.rb",
+     "spec/montage/commands/init_spec.rb",
+     "spec/montage/core_ext_spec.rb",
+     "spec/montage/project_spec.rb",
+     "spec/montage/sass_builder_spec.rb",
+     "spec/montage/source_spec.rb",
+     "spec/montage/spec/have_public_method_defined_spec.rb",
+     "spec/montage/sprite_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0.beta"])
+      s.add_runtime_dependency(%q<rmagick>, [">= 2.12"])
+      s.add_runtime_dependency(%q<highline>, [">= 1.5"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0.6"])
+      s.add_development_dependency(%q<open4>, [">= 1.0"])
+      s.add_development_dependency(%q<haml>, [">= 3.0.0.beta.1"])
+      s.add_development_dependency(%q<yard>, [">= 0.5"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.0.beta"])
+      s.add_dependency(%q<rmagick>, [">= 2.12"])
+      s.add_dependency(%q<highline>, [">= 1.5"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<cucumber>, [">= 0.6"])
+      s.add_dependency(%q<open4>, [">= 1.0"])
+      s.add_dependency(%q<haml>, [">= 3.0.0.beta.1"])
+      s.add_dependency(%q<yard>, [">= 0.5"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.0.beta"])
+    s.add_dependency(%q<rmagick>, [">= 2.12"])
+    s.add_dependency(%q<highline>, [">= 1.5"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<cucumber>, [">= 0.6"])
+    s.add_dependency(%q<open4>, [">= 1.0"])
+    s.add_dependency(%q<haml>, [">= 3.0.0.beta.1"])
+    s.add_dependency(%q<yard>, [">= 0.5"])
+  end
+end
+

data/spec/fixtures/custom_dirs/montage.yml

@@ -0,0 +1,8 @@
+---
+  config.sources:    "custom/sources"
+  config.sprites:    "custom/output"
+  config.sass:       "custom/sass"
+  config.sprite_url: "custom/images"
+
+  sprite_one:
+    - source_one

data/spec/fixtures/default/montage.yml

@@ -0,0 +1,7 @@
+---
+  sprite_one:
+    - one
+    - two
+
+  sprite_two:
+    - three

data/spec/fixtures/directory_config/config/montage.yml

@@ -0,0 +1,5 @@
+---
+  sprite_one:
+    - source_one
+    - source_two
+    - source_three

data/spec/fixtures/missing_source/montage.yml

@@ -0,0 +1,3 @@
+---
+  sprite_one:
+    - source_one

data/spec/fixtures/missing_source_dir/montage.yml

@@ -0,0 +1,5 @@
+---
+  sprite_one:
+    - source_one
+    - source_two
+    - source_three

data/spec/fixtures/root_config/montage.yml

@@ -0,0 +1,5 @@
+---
+  sprite_one:
+    - source_one
+    - source_two
+    - source_three

data/spec/fixtures/subdirs/montage.yml

@@ -0,0 +1,5 @@
+---
+  sprite_one:
+    - source_one
+    - source_two
+    - source_three

data/spec/lib/command_runner.rb

@@ -0,0 +1,140 @@
+require 'rbconfig'
+require 'tempfile'
+require 'open4'
+
+require Pathname(__FILE__).dirname + 'project_helper'
+
+module Montage
+  module Spec
+    # Runs montage commands in a subprocess and reports back on their exit
+    # status and output.
+    #
+    # See spec/montage/commands/*_spec.rb.
+    #
+    class CommandRunner < ProjectHelper
+
+      # Path to the Ruby binary.
+      RUBY = Pathname.new(Config::CONFIG['bindir']) +
+                          Config::CONFIG['ruby_install_name']
+
+      # Path to the montage executable.
+      EXECUTABLE = Pathname.new(__FILE__).dirname.
+                      expand_path + '../../bin/montage'
+
+      attr_reader :status, :stderr, :stdout
+
+      # ----------------------------------------------------------------------
+
+      # Creates a new CommandRunner instance.
+      #
+      # @param [String] command
+      #   The command to be run (exactly as it would be on the command-line).
+      #
+      def initialize(command)
+        super()
+        @command = command
+      end
+
+      # Runs the command in the test directory.
+      #
+      # @return [CommandRunner]
+      #   Returns self.
+      #
+      def run!(&block)
+        run(@command, &block)
+      end
+
+      # Runs the given command in the test directory.
+      #
+      # @param [String] command
+      #   The command to be run.
+      #
+      # @return [CommandRunner]
+      #   Returns self.
+      #
+      def run(command, &block)
+        if command =~ /^montage(.*)$/
+          command = "#{RUBY} -rubygems #{EXECUTABLE}#{$1} --no-color"
+        end
+
+        @status, @stderr, @stdout = nil, nil, nil
+
+        in_project_dir do
+          @status = Open4.popen4(command.to_s) do |_, stdin, stdout, stderr|
+            yield stdin if block_given?
+
+            @stdout = stdout.read
+            @stderr = stderr.read
+          end.exitstatus
+        end
+
+        self
+      end
+
+      # Returns if the latest command completed successfully.
+      #
+      # @return [Boolean]
+      #
+      def success?
+        @status == 0
+      end
+
+      # Returns if the latest command failed to complete successfully.
+      #
+      # @return [Boolean]
+      #
+      def failure?
+        not success?
+      end
+
+      # Returns the dimensions of a generated sprite image.
+      #
+      # @param [String] name
+      #   The name of the sprite file.
+      #
+      # @return [Array<Integer, Integer>]
+      #
+      def dimensions_of(name)
+        info = Magick::Image.ping path_to_sprite(name)
+        [info.first.columns, info.first.rows]
+      end
+
+      private # --------------------------------------------------------------
+
+      # Temporarily switches to the test directory for running commands.
+      def in_project_dir(&blk)
+        Dir.chdir(project_dir, &blk)
+      end
+
+    end # CommandRunner
+
+    # Runs the montage init command, providing the command with the various
+    # inputs it wants.
+    #
+    class InitCommandRunner < CommandRunner
+      # Creates a new InitCommandRunner instance.
+      #
+      # @param [Hash] responses
+      #   Takes inputs to be given to the highline GUI. Accepts :sources and
+      #   :sprites
+      #
+      def initialize(responses = {})
+        super 'montage init'
+        @responses = responses
+      end
+
+      # Runs the command in the test directory.
+      #
+      # @return [InitCommandRunner]
+      #   Returns self.
+      #
+      def run!
+        super do |stdin|
+          stdin.puts @responses.fetch(:sprites, "\n")
+          stdin.puts @responses.fetch(:sources, "\n")
+        end
+      end
+    end
+
+  end # Spec
+end # Montage