sprites 0.0.1.rc2 → 0.0.1.rc3

data/.gitignore

@@ -10,4 +10,7 @@ doc
 
 spec/fixtures/project1/public/images/sprites/*.png
 spec/fixtures/project1/public/stylesheets/sprites/*.css
+spec/fixtures/rails_project1/log
+spec/fixtures/rails_project1/app/assets/images/sprites
+spec/fixtures/rails_project1/app/assets/stylesheets
 

data/Gemfile

@@ -2,11 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in sprites.gemspec
 gemspec
-
-platforms :mri_18 do
-  gem 'ruby-debug'
-end
-
-platforms :mri_19 do
-  gem 'ruby-debug19'
-end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2012 Sam Woodard - http://github.com/shwoodard
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,7 +2,21 @@
 
 Sprites is a library that let's you define the sprites for your application with configuration or convention.  Sprites will generate your sprites, and a corresponding stylesheet for each using either the cli or from within a Rails application.
 
-## Project Structure
+## The DSL for sprites.rb
+
+``` ruby
+sprite :bas
+
+sprite :buttons, :path => "buttons.png", :stylesheet_path => "buttons.css", :autoload => false do
+  sprite_piece 'buttons/btn-black-default-28.png', 'a.black.button > span, button.black.submit span'
+  sprite_piece 'buttons/btn-black-default-cap-28.png', 'a.black.button, button.black.submit', :x => 'right'
+  ...
+end
+```
+
+## For the cli
+
+### Project Structure
 
     |
     |\_config
@@ -16,3 +30,64 @@ Sprites is a library that let's you define the sprites for your application with
              \_sprite_name2
                |\_blue_icon.png
                 \_green_icon.png
+
+    gem install sprites
+
+execute:
+
+    cd PROJECT_ROOT
+    sprites
+
+For usage
+
+    sprites --help
+
+
+## In your Rails app
+
+#### Gemfile
+
+``` ruby
+gem 'sprites'
+```
+
+#### application.rb
+
+``` ruby
+config.uses_sprites = true
+```
+
+Optionally include a `config/sprites.rb` (see above).  Otherwise _Sprites_ will use it's auto-load feature.  Example, if you have `app/assets/images/sprite_images/foo/bar.png` and `app/assets/images/sprite_images/foo/bas.png`, _Sprites_ will create `app/assets/stylesheets/sprites/foo.css` and `app/assets/images/sprites/foo.png`.  The class for `bar.png` will be `.bar` and for `bas.png`, `.bas`, etc.
+
+
+    rake sprites
+
+to generate.
+
+## In your Rails Engine
+
+#### engine.rb
+
+``` ruby
+module MyGem
+  class Engine < Rails::Engine
+    config.uses_sprites = true
+  end
+end
+```
+
+Use `app/assets` in your gem like you would your rails app and use the asset pipeline.
+
+From your rails root
+
+    ENGINES=true rake sprites
+
+Note: this will generate your sprites for your _Sprites_ enabled Engines _and_ your _Sprites_ enabled Rails app.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,44 +1,9 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
 
-desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-  # Put spec opts in a file named .rspec in root
-end
+RSpec::Core::RakeTask.new :spec
+Cucumber::Rake::Task.new
 
-desc "Generate code coverage"
-RSpec::Core::RakeTask.new(:coverage) do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec']
-end
-
-
-namespace :spec do
-  desc 'Create spec'
-  task :create, :path do |t, args|
-    spec_path = File.join('spec', args[:path].gsub(%r{.rb$}, '_spec.rb'))
-    klass = File.basename(args[:path], File.extname(args[:path])).split('_').map {|s| "#{s[0,1].upcase}#{s[1..-1]}" }.join
-    mkdir_p File.dirname(spec_path)
-
-    spec_doc = <<-EOS
-require 'spec_helper'
-
-describe #{klass} do
-end
-EOS
-
-    File.open(spec_path, 'w+') do |f|
-      f.puts spec_doc
-    end
-
-    puts spec_doc
-  end
-end
-
-desc "Run cucumber"
-task(:cucumber) { sh 'cucumber' }
-
-desc 'Default: run specs.'
+desc 'Default: run specs and features.'
 task :default => [:spec, :cucumber]

data/bin/sprites

@@ -3,16 +3,14 @@
 require 'sprites'
 require 'sprites/cli'
 
-include Sprites
-
 begin
-  options = CommandLineOptionParser.new(ARGV)
+  options = Sprites::CommandLineOptionParser.new(ARGV)
   options.parse
 
   sprite_definition_file_path = options.definition_file_path
-  configuration = Configuration.new_for_command_line_options(options.options)
+  configuration = Sprites::Configuration.new_for_command_line_options(options.options)
   
-  CliApplication.run(sprite_definition_file_path, configuration)
-rescue CliApplication::DefinitionFileNotFound
-  abort 'No Sprite Definition File found.  Please supply a path or place your definition file in `pwd` or `pwd/config`'
+  Sprites::CliApplication.run(sprite_definition_file_path, configuration)
+rescue Sprites::CliApplication::DefinitionFileNotFound
+  abort 'No Sprite Definition File found.  Please supply a path or place your definition file in `pwd/config`'
 end

data/features/cli.feature

@@ -7,5 +7,5 @@ Feature: Creating sprites and stylesheets
     Given a project folder
     And it contains a sprites dsl definition file
     And it contains sprite images
-    When I run the executable "sprites"
+    When I run the executable "sprites" with flags "-r spec/fixtures/project1"
     Then I should get valid sprites

data/features/step_definitions/common_steps.rb

@@ -14,23 +14,25 @@ Given(/^it contains sprite images$/) do
   Dir['public/images/sprite_images/**/*.png'].should_not be_empty
 end
 
-When(/^I run the executable "([^"]*)"$/) do |bin|
-  `#{GEM_ROOT}/bin/#{bin}`
+When /^I run the executable "([^"]*)" with flags "([^"]*)"$/ do |bin, flags|
+  `#{GEM_ROOT}/bin/#{bin} #{flags}`
   $?.to_i.should be(0)
 end
 
 Then(/^I should get valid sprites$/) do
-  options = CommandLineOptionParser.new($*)
+  options = Sprites::CommandLineOptionParser.new($*)
   options.parse
 
   sprite_definition_file_path = options.definition_file_path
-  configuration = Configuration.new_for_command_line_options(options.options)
+  configuration = Sprites::Configuration.new_for_command_line_options(options.options)
 
-  load sprite_definition_file_path
+  sprites = Sprites.new
+  sprites.configure configuration.to_options
+  sprites.load
 
-  tester = SpriteGeneratorTester.new(Sprites.application.sprites[:buttons], configuration)
+  tester = Sprites::SpriteGeneratorTester.new(sprites[:buttons])
   tester.should be_accurate
 
-  FileUtils.rm Sprite.sprite_full_path(configuration, Sprites.application.sprites[:buttons])
-  FileUtils.rm Stylesheet.stylesheet_full_path(configuration, Sprites.application.sprites[:buttons].stylesheet)
+  FileUtils.rm sprites[:buttons].path
+  FileUtils.rm sprites[:buttons].stylesheet_path
 end

data/lib/sprites.rb

@@ -2,32 +2,142 @@ require 'active_support'
 require 'active_support/core_ext'
 require "sprites/version"
 
-module Sprites
+require 'forwardable'
+
+class Sprites
   extend ActiveSupport::Autoload
 
-  autoload :Application
   autoload :Configuration
-  autoload :Sprites
   autoload :Sprite
   autoload :SpritePieces
   autoload :SpritePiece
   autoload :Stylesheet
   autoload :ChunkyPngGenerator, 'sprites/sprite_generators/chunky_png_generator'
 
-  class << self
-    def application
-      @application ||= Application.new(configuration)
+  include Enumerable
+  extend Forwardable
+  def_delegators :@sprites, :clear, :empty?, :count, :[]
+
+  attr_reader :configuration
+
+  def initialize(configuration = Configuration.new)
+    @configuration = configuration
+
+    @sprites = Hash.new do |sprites, name|
+      sprites[name] = Sprite.new(name, self)
     end
+    @loaded = false
+  end
 
-    def define(&blk)
-      application.define(&blk)
+  def [](sprite_identifier)
+    @sprites[sprite_identifier] if @sprites.has_key?(sprite_identifier)
+  end
+
+  def each(&blk)
+    @sprites.values.each(&blk)
+  end
+
+  def configure(options)
+    configuration.configure(options)
+  end
+
+  # The +sprite+ method adds sprites to the sprites collection
+  #
+  # === Examples ===
+  # sprite :foo
+  # sprite :foo, :orientation => :horizontal, :css_prefix => '.foo '
+  #
+  # options:
+  # => :orientation - sprite orientation
+  #       default:  :vertical
+  # => :path - path to which to write the sprite relative to config.sprites_path
+  #       default:  public/images/sprites/{name}.png
+  # => :stylesheet_path - path to which to write the stylesheet relative to config.sprite_stylesheets_path
+  #       default:  public/stylesheets/sprites/{name}.css
+  # => :url - path to use in background attribute in stylesheet
+  #       default:  /images/sprites/{name}.png
+  # => :autoload - whether or not to auto-define the sprite based on directory contents
+  #       default: true
+  # => :css_prefix - a css string to prepend to all css classes define or autogenerated
+  #       examples: '.icon', '.contacts '
+  #       default: ''
+  #
+  def sprite(name, options = {}, &blk)
+    sprite = @sprites[name.to_sym]
+    sprite.configure(options, &blk)
+  end
+
+  def add(sprite)
+    @sprites[sprite.name] = sprite
+  end
+
+  def loaded?
+    @loaded
+  end
+
+  def load
+    return if loaded?
+    if configuration.definition_file
+      load_file configuration.definition_file
+    elsif configuration.autoload
+      auto_load
     end
+    @loaded = true
+  end
 
-    def configure(&blk)
-      @configuration ||= Configuration.new
-      @configuration.configure(&blk) if block_given?
-      @configuration
+  def auto_load
+    Dir[File.join(configuration.sprite_pieces_path, '*')].each do |sprite_path|
+      sprite(File.basename(sprite_path).intern) if File.directory?(sprite_path)
     end
-    alias_method :configuration, :configure
+  end
+
+  def load_file(path)
+    instance_eval File.read(path), path, 0    
+  end
+
+  alias define instance_eval
+  public :define
+
+  def reset!
+    clear
+    @configuration = Configuration.new
+    @loaded = false
+  end
+
+  def all_files
+    files = {}
+
+    all_files = []
+    if configuration.definition_file
+      files[configuration.definition_file] = all_files
+    end
+
+    @sprites.each do |name, sprite|
+      all_files.concat sprite.all_sprite_piece_files
+      files[sprite.stylesheet_path] = sprite.all_sprite_piece_files
+      files[sprite.path] = sprite.all_sprite_piece_files
+    end
+
+    all_files.uniq!
+
+    files
+  end
+
+  def generate(generator = configuration.generator)
+    generator.new(self).generate
+  end
+
+  def define_file_tasks(task_name = :sprites)
+    extend Rake::DSL
+    all_files.each do |output, inputs|
+      FileList[inputs]
+      file output => inputs do
+        # XXX this will currently run once per output, we need to fix that.
+        generate
+      end
+    end
+    task task_name => all_files.keys
   end
 end
+
+require 'sprites/railtie' if defined?(Rails)

data/lib/sprites/cli/cli_application.rb

@@ -1,11 +1,13 @@
-module Sprites
+class Sprites
   class CliApplication
     class DefinitionFileNotFound < StandardError; end
 
     def self.run(def_file, configuration)
-      load def_file
-      sprite_generator = ChunkyPngGenerator.new(configuration)
-      sprite_generator.generate(::Sprites.application.sprites)
+      sprites = Sprites.new
+      sprites.configure(configuration.to_options)
+      sprites.load
+      sprite_generator = ChunkyPngGenerator.new(sprites)
+      sprite_generator.generate
     end
   end
 end

data/lib/sprites/cli/command_line_option_parser.rb

@@ -1,14 +1,13 @@
+require 'pathname'
 require 'optparse'
 
-module Sprites
+class Sprites
   class CommandLineOptionParser < OptionParser
-    PRIMARY_DEF_FILE_LOCATION = 'config/sprites.rb'
-    SECONDARY_DEF_FILE_LOCATION = 'sprites.rb'
-
     attr_reader :definition_file_path, :options
 
     def initialize(arguments)
-      @definition_file_path, @arguments = extract_sprite_definition_file_path(arguments.clone)
+      @arguments, @raw_arguments = arguments.clone, arguments
+      @definition_file_path = extract_sprite_definition_file_path(@arguments)
       @options = Hash.new
 
       super do |opts|
@@ -17,25 +16,19 @@ module Sprites
     end
 
     def parse
-      super(@arguments)
+      super(@raw_arguments)
     end
 
     def extract_sprite_definition_file_path(arguments)
       sprite_def_file_pathname = if arguments[0] =~ %r{^.+\.rb}
         Pathname(arguments.shift)
-      elsif file_exists?('config/sprites.rb')
-        Pathname('config/sprites.rb')
+      elsif File.exists?(path = File.join(Dir.pwd, 'config/sprites.rb'))
+        Pathname(path)
       else
-        raise
+        raise CliApplication::DefinitionFileNotFound
       end
 
-      [sprite_def_file_pathname.realpath.to_s, arguments]
-    rescue
-      raise CliApplication::DefinitionFileNotFound
-    end
-
-    def file_exists?(path)
-      Pathname(path).exist?
+      sprite_def_file_pathname.realpath.to_s
     end
 
     def setup_parser(opts)
@@ -44,6 +37,13 @@ module Sprites
       opts.separator ""
       opts.separator "Specific options:"
 
+      opts.on("-r", "--project_root", <<-EOS
+Define the path to the root of the project. DEFAULT: pwd
+      EOS
+      ) do |path|
+        @options[:project_root] = path || Dir.pwd
+      end
+
       opts.on("-s", "--sprites_path", <<-EOS
 Define the path to where the sprites should be placed. DEFAULT: 'public/images/sprites'
       EOS