active_assets 0.1.0 → 0.2.0.rc

data/.gitignore

@@ -1,9 +1,13 @@
+.DS_Store
 .rvmrc
 pkg/*
 *.gem
 .bundle
 Gemfile.lock
+doc
 
 test/fixtures/rails_root/log
 test/fixtures/rails_root/public/stylesheets/cache
 test/fixtures/rails_root/public/javascripts/cache
+test/fixtures/rails_root/public/stylesheets/sprites
+test/fixtures/rails_root/public/images/sprites

data/README.md

@@ -0,0 +1,168 @@
+Active Assets
+=============
+
+A Railtie that provides a full asset management system, including support for development and deployment.  This includes building sprites, concatenating javascript and css via expansion definitions.  Active Assets includes two libraries, Active Expansions and Active Sprites.
+
+    gem install active_assets
+
+Gemfile
+-------
+
+    gem 'active_assets', '~>0.2.0.rc'
+
+In your rails app
+-----------------
+### application.rb
+
+    ...
+    require 'rails/all'
+    require 'active_assets/railtie'
+    ...
+
+## The dsls
+### Introduction to Active Expansions
+
+ActiveExpansions allow you to register Rails javascript and stylesheet expansions via a simple dsl.  Addionally, the assets in the expansion are concatenated when appropriate and the expansion delivers the concatenated (or 'cached') assets' path in the appropriate environments.  Also, files can be specified as deploy only or only for a specific environment.  For example, you may wish to include jQuery or Prototype src files in development and use minified libraries from cdn sources in production.  This is supported.
+
+* Below demonstration shows several variations on how to declare expansions.  Note that these declaration are redundant to demonstrate how to accomplish the same thing in different ways.
+* Alternatively you can also register your assets in multiple files.  Simply omit `config/asets.rb` and add as many .rb files as you like inside a directory `config/assets`
+* Note the `register` is optional `Rails.application.expansions do` will work the same way
+
+#### config/assets.rb
+
+    Rails.application.expansions.register do
+      expansion :global, :type => :js do
+        `vendor/jquery`
+        `application`
+      end
+
+      expansion :global, :type => :css do
+        `vendor/reset`
+        `application`
+      end
+
+      expansion :global do
+        `vendor/jquery.js`
+        `application.js`
+        `vendor/reset.css`
+        `application.css`
+      end
+
+      js do
+        expansion :global do
+          `vendor/jquery`
+          `application`
+        end
+      end
+
+      css do
+        expansion :global do
+          `vendor/reset`
+          `application`
+        end
+      end
+
+      expansion :global do
+        js do
+          `vendor/jquery`
+          `application`
+        end
+
+        css do
+          `vendor/reset`
+          `application`
+        end
+      end
+    end
+
+#### config/assets/js.rb (suggestion only)
+    Rails.application.expansions.js do
+      expansion :global do
+        `vendor/jquery`
+        `application`
+      end
+    end
+
+#### config/assets/css.rb (suggestion only)
+    Rails.application.expansions.css do
+      expansion :global do
+        `vendor/reset`
+        `application`
+      end
+    end
+
+### Introduction to Active Sprites
+
+ActiveSprites allows you to generate sprites within your Rails apps with `rake sprites`!  All you need is rmagick (in development) and you are on your way.  Store the images that make up your sprites in your rails project, use the dsl below to tell ActiveSprites which images to include in your sprites, the css selector the corresponds to each image in the sprite, the location to write the sprite, and the location to write the stylesheet.
+
+#### config/sprites.rb
+    Rails.application.sprites do
+      sprite 'sprites/world_flags.png' => 'sprites/world_flags.css'
+        _"sprite_images/world_flags/Argentina.gif" => ".flags.argentina"
+        _"sprites_images/world_flags/Australia.gif" => ".flags.australia"
+        ...
+      end
+    end
+
+#### To generate
+    rake sprites
+    
+or
+
+    Rails.application.sprites.generate!
+
+### More on Active Expansions
+You can specify certain assets only be used in a deployment setting or only be used in a production setting.  The example below illustrates how to include a library in development and the same library from a cdn in production.  The net result will be that the library will not get cached (concatenated) along with all of the other files because it is specified for use only in development and test.  Hence, the cache file will only be comprised of the other assets in the expansion.  Similarly, the cdn resort will not get cached either but instead will be used directly.  The resulting expansion in production will include two paths, the cdn url to jquery and the path the cache file, in this case, public/{javascript,stylesheets}/cache/global.{js,css}.
+
+    Rails.application.expansions.register do
+      expansion :global do
+        js do
+          asset 'vendor/jquery', :group => [:development, :test]
+          asset 'http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js', :group => :deploy, :cache => false
+          `application`
+        end
+
+        css do
+          asset 'vendor/reset', :group => [:development, :test]
+          asset 'http://ajax.googleapis.com/ajax/libs/yui/2.8.1/build/reset-fonts/reset-fonts.css', :group => :deploy, :cache => false
+          `application`
+        end
+      end
+    end
+
+back-tick and `a` are aliases for `asset`
+
+#### ActiveExpansions configuration and deployment
+By default, ActiveExpansions will not cache your assets even if `ActionController.perform_caching` is enabled.  This is because if you are not serving assets from the same server as where your application resides, then you most likely want to cache your assets at deploy time (on the front-end servers).  To cache assets manually,
+
+    Rails.application.expansions.javascripts.cache!
+    Rails.application.expansions.stylesheets.cache!
+
+To enable your application to cache assets when the application is initialized, i.e. boot time, follow this example,
+
+##### config/environments/production.rb
+
+    ...
+    config.active_expansions.precache_assets = true
+    ...
+
+### More on Active Sprites
+
+It is possible to add all of the world flags!  Haha, see the following example,
+
+    Rails.application.sprites do
+      sprite :world_flags
+        Dir[Rails.root.join('public/images/sprite_images/world_flags/*.{png,gif,jpg}')].each do |path|
+          image_path = path[%r{^.*/public/images/(.*)$}, 1]
+          klass_name = ".flag.#{File.basename(image_path, File.extname(image_path)).split(' ').join('_')}"
+
+          sp image_path => klass_name
+        end
+      end
+    end
+
+`_` and `sp` are aliases for `sprite_piece`
+
+Also, you will notice that I gave a symbol for the sprite instead of a mapping.  This will assume that you wish to store your sprite at `path/to/your/public/images/sprites/world_flags.png` and you wish to store your stylesheet at `path/to/your/public/stylesheets/sprites/world_flags.css`.
+
+Copyright © Sam Woodard 2011.  Release under the MIT License.

data/Rakefile

@@ -9,4 +9,10 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
+task :environment do
+  load 'test/fixtures/rails_root/config/environment.rb'
+end
+
+Dir['lib/tasks/**/*.rake'].each {|f| load f}
+
 task :default => :test

data/active_assets.gemspec

@@ -1,22 +1,27 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "active_assets"
-  s.version     = '0.1.0'
+  s.version     = '0.2.0.rc'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Sam Woodard"]
   s.email       = ["sam@wildfireapp.com"]
-  s.homepage    = ""
+  s.homepage    = "http://github.com/shwoodard/active_assets"
   s.summary     = %q{A Railtie that provides a full asset management system, including support for development and deployment.}
-  s.description = %q{A Railtie that provides a full asset management system, including support for development and deployment.  Currently it is designed to manage javascripts and stylesheets but will handle image sprites in the future.}
+  s.description = %q{A Railtie that provides a full asset management system, including support for development and deployment.  It is comprised of two libraries, ActiveSprites and ActiveExpansions.  ActiveSprites generates sprites and their corresponding stylesheet from dsl definition. ActiveExpansions manages javascript and css, including concatenation support for deployment, using Rails expansions plus a dsl.}
 
-  s.rubyforge_project = "rails-assets"
+  s.rubyforge_project = "activeassets"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rails", "3.0.3"
+  s.add_runtime_dependency 'rmagick'
+
+  s.add_development_dependency "sinatra", "~>1.1.2"
+  s.add_development_dependency "thin", "~>1.2.7"
+  s.add_development_dependency "rails", "~>3.0.3"
   s.add_development_dependency "test-unit", "> 2.0"
-  s.add_development_dependency "ZenTest"
+  s.add_development_dependency "capybara", "~>0.4.1.1"
+  s.add_development_dependency "ZenTest", "~>4.4.2"
 end

data/config.ru

@@ -0,0 +1,2 @@
+require 'active_assets_test_app'
+run ActiveAssetsTestApp

data/lib/active_assets.rb

@@ -4,4 +4,5 @@ module ActiveAssets
   extend ActiveSupport::Autoload
 
   autoload :ActiveExpansions
+  autoload :ActiveSprites
 end

data/lib/active_assets/active_expansions/railtie.rb

@@ -1,37 +1,38 @@
 require "rails"
-require "rails/active_assets"
+require "rails/active_expansions"
 require 'active_support/ordered_options'
 
 module ActiveAssets
   module ActiveExpansions
     class Railtie < Rails::Railtie
       rake_tasks do
-        Dir[File.expand_path("../../../tasks/*.rake", __FILE__)].each {|f| load f}
+        Dir[File.expand_path("../../../tasks/active_expansions/*.rake", __FILE__)].each {|f| load f}
       end
 
       config.active_expansions = ActiveSupport::OrderedOptions.new
 
-      initializer :active_assets_extend_application do
-        Rails.application.extend(Rails::ActiveAssets)
+      initializer 'active_expansion-extend-application' do
+        Rails.application.extend(Rails::ActiveExpansions)
       end
 
-      initializer :load_active_assets do
+      initializer 'active_expansions-load-definitons' do
         load_active_assets(Rails.root)
         Rails.application.railties.engines.each {|e| load_active_assets(e.root) }
       end
 
-      initializer :register_active_assets_expansions do
-        Rails.application.expansions.javascripts.register! and Rails.application.expansions.stylesheets.register!
+      initializer 'active_expansions-register' do
+        Rails.application.expansions.javascripts.register!
+        Rails.application.expansions.stylesheets.register!
       end
 
-      initializer :set_active_expansion_configs do
+      initializer 'active_expansions-set-configs' do
         options = config.active_expansions
         ActiveSupport.on_load(:active_expansions) do
           options.each { |k,v| send("#{k}=", v) }
         end
       end
 
-      initializer :cache_active_assets do
+      initializer 'active_expansions-cache' do
         if Expansions.precache_assets
           Rails.application.expansions.javascripts.cache! and Rails.application.expansions.stylesheets.cache!
         end

data/lib/active_assets/active_sprites.rb

@@ -0,0 +1,13 @@
+require 'active_support'
+
+module ActiveAssets
+  module ActiveSprites
+    extend ActiveSupport::Autoload
+
+    autoload :SpritePiece
+    autoload :Sprite
+    autoload :Sprites
+    autoload :SpriteStylesheet
+    autoload :Runner
+  end
+end

data/lib/active_assets/active_sprites/railtie.rb

@@ -0,0 +1,29 @@
+require 'rails'
+require 'rails/active_sprites'
+require 'active_assets/active_sprites'
+
+module ActiveAssets
+  module ActiveSprites
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        Dir[File.expand_path("../../../tasks/active_sprites/*.rake", __FILE__)].each {|f| load f}
+      end
+
+      initializer 'active_sprites-extend-application' do
+        Rails.application.extend(Rails::ActiveSprites)
+      end
+
+      initializer 'active_sprites-load-definitons' do
+        Rails.application.config.paths.config.paths.each {|config_path| load_sprite_definition(config_path) }
+        Rails.application.railties.engines.map(&:config).map(&:paths).map(&:config).map(&:paths).each do |config_path|
+          load_sprite_definition(config_path)
+        end
+      end
+
+      private
+        def load_sprite_definition(config_path)
+          load File.join(config_path, 'sprites.rb') if File.exists?(File.join(config_path, 'sprites.rb'))
+        end
+    end
+  end
+end

data/lib/active_assets/active_sprites/runner.rb

@@ -0,0 +1,101 @@
+require 'rack/mount'
+require 'action_view'
+require 'rmagick'
+require 'fileutils'
+
+module ActiveAssets
+  module ActiveSprites
+    class Runner
+      class AssetContext < ActionView::Base
+      end
+      SpriteDetails = Struct.new(:sprite_path, :x, :y, :width, :height)
+      
+      include Magick
+
+      DEFAULT_SPRITE = Image.new(0,0).freeze
+
+      def initialize(sprites)
+        @controller = ActionController::Base.new
+        @context = AssetContext.new(Rails.application.config.action_controller, {}, @controller)
+
+        @sprites = if ENV['SPRITE']
+          sprites.select do |name, sprite|
+            ENV['SPRITE'].split(',').map(&:compact).each do |sp|
+              # were going to be very forgiving
+              name == sp ||
+              name == sp.to_sym ||
+              name == ::Rack::Mount::Utils.normalize_path(sp)
+            end
+          end
+        else
+          sprites.values
+        end
+      end
+
+      def generate!(debug = ENV['DEBUG'])
+        @sprites.each do |sprite|
+          next if sprite.sprite_pieces.empty?
+          sprite_path = sanitize_asset_path(context.image_path(sprite.path))
+          p "Sprite Path: #{sprite_path}" if debug
+          sprite_stylesheet_path = sanitize_asset_path(context.stylesheet_path(sprite.stylesheet_path))
+          p "Sprite Stylesheet Path: #{sprite_stylesheet_path}" if debug
+
+          orientation = sprite.orientation.to_s
+          sprite_pieces = sprite.sprite_pieces
+
+          begin
+            sprite_piece_paths = sprite_pieces.map do |sp|
+              File.join(Rails.application.config.paths.public.to_a.first, sanitize_asset_path(context.image_path(sp.path)))
+            end
+            image_list = ImageList.new(*sprite_piece_paths)
+
+            offset = 0
+
+            image_list.each_with_index do |image, i|
+              sprite_pieces[i].details = SpriteDetails.new(
+                sprite_path,
+                orientation == Sprite::Orientation::VERTICAL ? 0 : "#{-offset}px",
+                orientation == Sprite::Orientation::VERTICAL ? "#{-offset}px" : 0,
+                "#{image.columns}px",
+                "#{image.rows}px"
+              )
+              offset += orientation == Sprite::Orientation::VERTICAL ? image.rows : image.columns
+            end
+
+            @sprite = image_list.montage do
+              self.tile = orientation == Sprite::Orientation::VERTICAL ? "1x#{sprite_pieces.size}" : "#{sprite_pieces.size}x1"
+              self.geometry = "+0+0"
+              self.background_color = 'transparent'
+            end
+
+            stylesheet = SpriteStylesheet.new(sprite_path, sprite_pieces)
+            stylesheet.write File.join(Rails.application.config.paths.public.to_a.first, sprite_stylesheet_path)
+            write File.join(Rails.application.config.paths.public.to_a.first, sprite_path)
+          ensure
+            finish
+          end
+        end
+      end
+
+      private
+        def context
+          @context
+        end
+
+        def write(path)
+          FileUtils.mkdir_p(File.dirname(path))
+          @sprite.write("png:#{path}")
+        end
+
+        def finish
+          @sprite.destroy! unless @sprite == DEFAULT_SPRITE
+          @sprite = DEFAULT_SPRITE
+        end
+
+        def sanitize_asset_path(path)
+          path.split('?').first
+        end
+
+    end
+  end
+end

data/lib/active_assets/active_sprites/sprite.rb

@@ -0,0 +1,89 @@
+module ActiveAssets
+  module ActiveSprites
+    class Sprite
+      module Orientation
+        VERTICAL = 'vertical'
+        HORIZONTAL = 'horizontal'
+      end
+      REQUIRED_PROPS = [:path, :stylesheet_path, :orientation]
+
+      class ValidationError < StandardError
+        attr_reader :sprite, :missing_fields
+        def initialize(sprite, missing_fields, msg = nil)
+          @sprite, @missing_fields = sprite, missing_fields
+          super(msg || "Your sprite#{", #{sprite.name}," if sprite.name} is invalid.  It is missing the following fields: #{missing_fields.join(', ')}")
+        end
+      end
+
+      class OrientationInvalid < ValidationError
+        def initialize(sprite, orientation)
+          super(sprite, [:orientation], "The sprite orientation, #{orientation}, is invalid")
+        end
+      end
+
+      attr_reader :path, :stylesheet_path, :name, :orientation
+
+      def initialize
+        # Ordered Hash?
+        @sprite_pieces = ActiveSupport::OrderedHash.new do |sprite_pieces, path|
+          raise SpritePiece::ValidationError.new(nil, [:path]) if path.blank?
+          sprite_pieces[path] = SpritePiece.new
+        end
+      end
+
+      def has_sprite_piece_with_path?(path)
+        @sprite_pieces.has_key?(path)
+      end
+
+      def [](path)
+        return nil unless @sprite_pieces.has_key?(path)
+        @sprite_pieces[path]
+      end
+
+      def sprite_pieces
+        @sprite_pieces.values
+      end
+
+      def configure(sprite_path, stylesheet_path, options = {}, &blk)
+        @path ||= sprite_path
+        @name = options.delete(:as) || sprite_path
+        @stylesheet_path = stylesheet_path
+        @orientation = options[:orientation] || :vertical
+        valid!
+        instance_eval(&blk) if block_given?
+        self
+      end
+
+      def sprite_piece(options, &blk)
+        path, css_selector = options.find {|k, v| k.is_a?(String)}
+        options.delete(path)
+        mapping = SpritePiece::Mapping.new(path, css_selector)
+        @sprite_pieces[path].configure(mapping, options, &blk)
+      end
+      alias_method :sp, :sprite_piece
+      alias_method :_, :sprite_piece
+
+      def validation_error
+        missing_fields = REQUIRED_PROPS.reject {|prop| send(prop).present?}
+        return OrientationInvalid.new(self, orientation) if orientation && ![:vertical, :horizontal].include?(orientation.to_sym)
+        return if missing_fields.empty?
+        ValidationError.new(self, missing_fields)
+      end
+
+      def valid?
+        !validation_error
+      end
+
+      def valid!
+        e = validation_error
+        raise e if e
+      end
+
+      private
+
+        def orientation=(orientation)
+          @orientation = orientation
+        end
+    end
+  end
+end