Extending Compass

Sprite engine

The sprite engine is the work horse of sprite generation it's the interface for assembling and writing the image file to disk.

Requirements

A sprite engine requires only one method and that is construct_sprite which must return an object that responds to save(filepath)

Once inside this method you have access to images which is a collection of Compass::SassExtensions::Sprites::Image

Since the Engine module extends base you also have access to all methods in Compass::SassExtensions::Sprites::Base

Configuration

To enable your sprite engine from the config file set

sprite_engine = :<engine name>

The example below will load Compass::SassExtension::Sprites::ChunkyPngEngine

sprite_engine = :chunky_png

Class Definition

module Compass
  module SassExtensions
    module Sprites
      module <engine name>Engine

        # Returns an object
        def construct_sprite
          #must return a image object that responds to save(filename)
        end

      end
    end
  end
end

Adding Configuration Properties to Compass

To add a new configuration property to Compass:

Compass::Configuration.add_configuration_property(:foobar, "this is a foobar") do
  if environment == :production
    "foo"
  else
    "bar"
  end
end

This will do several things:

make it possible for users to set the foobar configuration property in their configuration file.
Ruby code can read and write the foobar attribute from any configuration object.
It will add the comment # this is a foobar above the property in the configuration file. A comment is not required, you can simply omit this argument if you like.
The block of code provided allows you to assign a sensible default value according to other settings in the configuration or by using arbitrary code to determine what the value should be. For instance it could read from another configuration file or it could change based on the user's operating system.

2.4 KiB Raw Blame History