active_assets 0.3.1 → 1.0.0.rc1

data/README.md

@@ -1,22 +1,16 @@
 Active Assets
 =============
 
-A gem that provides an asset management system for css, javascript, and sprites in your Rails applications and engines. ActiveAssets includes two libraries, ActiveExpansions and ActiveSprites.  ActiveSprites generates sprites defined by a dsl similar to a route definition.  Similarly, ActiveExpansions' dsl creates `ActionView::Helpers::AssetTagHelper` javascript and stylesheet expansions, and adds additional features:
+A Railtie that provides an asset management system for css, javascript, and sprites in your Rails applications and engines. ActiveAssets includes two libraries, ActiveExpansions and ActiveSprites.  ActiveSprites generates sprites defined by a dsl similar to a route definition.  Similarly, ActiveExpansions' dsl creates `ActionView::Helpers::AssetTagHelper` javascript and stylesheet expansions, and adds additional features:
 
 * Concatenation of included assets for expansions at boot or deploy time.
 * Support for environment specific assets, so that, say, you can use one file for development and another for production or one file for development and then a cdn resource for production.
 
-Installation
-============
-
-    gem install active_assets -v 0.3.0
-
-Using Bundler?
---------------
-### Gemfile
+Gemfile
+-------
 
     ...
-    gem 'active_assets', '~> 0.3.0'
+    gem 'active_assets'
     ...
     group :development do
       ...
@@ -32,14 +26,28 @@ Using Bundler?
 
 The above order of image libraries is also the load order precedence.
 
-Run the generator
+In your Rails app
 -----------------
+### application.rb
+
+    ...
+    require 'rails/all'
+    require 'active_assets/railtie'
+    ...
+
+#### You can also include only ActiveSprites or only ActiveExpansions in your application
+### application.rb
+Instead of the above,
 
-    script/generate active_assets
+    ...
+    require 'rails/all'
+    require 'active_assets/active_expansions/railtie'
+    ... OR ...
+    require 'active_assets/active_sprites/railtie'
+    ...
 
-The DSLs
-========
-## Introduction to Active Sprites
+## The DSLs
+### Introduction to Active Sprites
 
 ActiveSprites allows you to generate sprites within your Rails apps with `rake sprites`!  All you need is `rmagick`, `chunky_png`, or `mini_magick` and you are on your way. Store the images that make up your sprites within your Rails project, use the dsl below to inform ActiveSprites of which images to include in your sprites as well as the css selector corresponding to each image, the location to write the sprite, and the location to write the stylesheet.
 
@@ -89,9 +97,9 @@ Rmagick is used by default and is by far the fastest.  You can use one of two me
     ...
 
 
-## Introduction to Active Expansions
+### Introduction to Active Expansions
 
-ActiveExpansions allow you to register Rails javascript and stylesheet expansions via a simple dsl.  Additionally, 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.
+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`
@@ -181,12 +189,16 @@ You can specify certain assets only be used in a deployment setting or only be u
 
 `_` and `a` are aliases for `asset`
 
-#### ActiveExpansions caching
-By default, ActiveExpansions will not cache your assets automatically.  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, add the following to an initializer to concat assets at boot time or to your deploy scripts if you wish to do it when deploying:
+#### 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!
 
-Contributing
-============
-You know the drill!
+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
+    ...

data/Rakefile

@@ -13,4 +13,6 @@ 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,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "active_assets"
-  s.version     = '0.3.1'
+  s.version     = '1.0.0.rc1'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Sam Woodard"]
   s.email       = ["sam@wildfireapp.com"]
@@ -16,15 +16,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "activesupport", "~>2.3.5"
-
-  s.add_development_dependency 'rails', "~>2.3.5"
-  s.add_development_dependency 'rake'
   s.add_development_dependency 'oily_png'
   s.add_development_dependency 'chunky_png'
   s.add_development_dependency 'rmagick'
   s.add_development_dependency 'mini_magick'
   s.add_development_dependency 'css_parser', '~>1.1.5'
+  s.add_development_dependency "rails", "~>3.0.3"
   s.add_development_dependency "test-unit", "> 2.0"
   s.add_development_dependency "ZenTest", "~>4.4.2"
 end

data/lib/active_assets.rb

@@ -1,16 +1,8 @@
 require 'active_support'
 
 module ActiveAssets
-  autoload :ActiveExpansions, 'active_assets/active_expansions'
-  autoload :ActiveSprites, 'active_assets/active_sprites'
+  extend ActiveSupport::Autoload
 
-  def self.rails2?
-    rv = Rails.version rescue nil
-    rv ||= RAILS_GEM_VERSION rescue nil
-    rv ||= Gem.loaded_specs.find { |n,spec| n == 'rails' }[1].version.to_s
-
-    Gem::Version.new(rv) < Gem::Version.new('3.0.0.beta')
-  end
+  autoload :ActiveExpansions
+  autoload :ActiveSprites
 end
-
-require 'active_assets/rails2_support' if ActiveAssets.rails2?

data/lib/active_assets/active_expansions.rb

@@ -2,23 +2,16 @@ require 'active_support'
 
 module ActiveAssets
   module ActiveExpansions
-    autoload :Asset, 'active_assets/active_expansions/asset'
-    autoload :AssetScope, 'active_assets/active_expansions/asset_scope'
-    autoload :TypeInferrable, 'active_assets/active_expansions/type_inferrable'
-    autoload :Configurable, 'active_assets/active_expansions/configurable'
-    autoload :Expansion, 'active_assets/active_expansions/expansion'
-    autoload :Assets, 'active_assets/active_expansions/assets'
-    autoload :Javascripts, 'active_assets/active_expansions/javascripts'
-    autoload :Stylesheets, 'active_assets/active_expansions/stylesheets'
-    autoload :Expansions, 'active_assets/active_expansions/expansions'
+    extend ActiveSupport::Autoload
 
-    def self.define_tasks
-      namespace :activeexpansions do
-        desc "Cache the active expansions to the {stylesheets,javascripts} cache directory"
-        task :cache => :environment do
-          Rails.application.expansions.javascripts.cache! and Rails.application.expansions.stylesheets.cache!
-        end
-      end
-    end
+    autoload :Asset
+    autoload :AssetScope
+    autoload :TypeInferrable
+    autoload :Configurable
+    autoload :Expansion
+    autoload :Assets
+    autoload :Javascripts
+    autoload :Stylesheets
+    autoload :Expansions
   end
 end

data/lib/active_assets/active_expansions/assets.rb

@@ -85,7 +85,7 @@ module ActiveAssets
 
         def cleanse_paths!(paths)
           paths.map! do |path|
-            if path =~ %r{^[-a-z]*:?//|^cid:}
+            if path =~ %r{^https?}
               path
             else
               dirname = File.dirname(path)

data/lib/active_assets/active_expansions/configurable.rb

@@ -0,0 +1,14 @@
+require 'active_support/concern'
+
+module ActiveAssets
+  module ActiveExpansions
+    module Configurable
+      extend ActiveSupport::Concern
+
+      included do
+        config_accessor :precache_assets
+        self.precache_assets = false if precache_assets.nil?
+      end
+    end
+  end
+end

data/lib/active_assets/active_expansions/expansion.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require 'active_support/hash_with_indifferent_access'
 
 module ActiveAssets
   module ActiveExpansions

data/lib/active_assets/active_expansions/expansions.rb

@@ -1,13 +1,13 @@
+require 'active_support/configurable'
+
 module ActiveAssets
   module ActiveExpansions
     class Expansions
       include AssetScope
       include TypeInferrable
-
-      @@precache_assets = false
-      cattr_accessor :precache_assets
-
-      ActiveSupport.run_load_hooks(:active_expansions, self) if ActiveSupport.respond_to?(:run_load_hooks)
+      include ActiveSupport::Configurable
+      include Configurable
+      ActiveSupport.run_load_hooks(:active_expansions, self)
 
       def initialize
         @expansions = Hash.new(&method(:build_expansions_hash_with_defaults))
@@ -71,14 +71,6 @@ module ActiveAssets
         @expansions.clear
       end
 
-      def precache_assets
-        @@precache_assets
-      end
-
-      def precache_assets=(val)
-        @@precache_assets = val
-      end
-
       private
         def defer_expansion(name, options, &blk)
           @deferred_expansion_config = [name, options]

data/lib/active_assets/active_expansions/railtie.rb

@@ -6,7 +6,7 @@ module ActiveAssets
   module ActiveExpansions
     class Railtie < Rails::Railtie
       rake_tasks do
-        ActiveAssets::ActiveExpansions.define_tasks
+        Dir[File.expand_path("../../../tasks/active_expansions/*.rake", __FILE__)].each {|f| load f}
       end
 
       config.active_expansions = ActiveSupport::OrderedOptions.new

data/lib/active_assets/active_sprites.rb

@@ -2,21 +2,38 @@ require 'active_support'
 
 module ActiveAssets
   module ActiveSprites
-    autoload :SpritePiece, 'active_assets/active_sprites/sprite_piece'
-    autoload :Sprite, 'active_assets/active_sprites/sprite'
-    autoload :Sprites, 'active_assets/active_sprites/sprites'
-    autoload :Configurable, 'active_assets/active_sprites/configurable'
-    autoload :SpriteStylesheet, 'active_assets/active_sprites/sprite_stylesheet'
-    autoload :AbstractRunner, 'active_assets/active_sprites/runners/abstract_runner'
-    autoload :RmagickRunner, 'active_assets/active_sprites/runners/rmagick_runner'
-    autoload :MiniMagickRunner, 'active_assets/active_sprites/runners/mini_magick_runner'
-    autoload :ChunkyPngRunner, 'active_assets/active_sprites/runners/chunky_png_runner'
-
-    def self.define_tasks
-      desc "Generate sprites."
-      task :sprites => :environment do
+    extend ActiveSupport::Autoload
+
+    autoload :SpritePiece
+    autoload :Sprite
+    autoload :Sprites
+    autoload :Configurable
+    autoload :SpriteStylesheet
+    autoload_under "runners" do
+      autoload :AbstractRunner
+      autoload :RmagickRunner
+      autoload :MiniMagickRunner
+      autoload :ChunkyPngRunner
+    end
+
+    def self.load_engine_tasks(engine_class)
+      desc "Generate sprites"
+      task :sprites do
+        require 'rails'
+        require 'rails/active_sprites'
+
         ENV['VERBOSE'] ||= 'true'
-        Rails.application.sprites.generate!
+
+        Rails.application ||= Class.new(Rails::Application)
+        Rails.application.extend Rails::ActiveSprites
+
+        engine = engine_class.new
+        sprite_path = File.join(engine.config.paths.config.paths.first, 'sprites.rb')
+
+        if File.exists?(sprite_path)
+          load sprite_path
+          Rails.application.sprites.generate!(engine)
+        end
       end
     end
 

data/lib/active_assets/active_sprites/configurable.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+
+module ActiveAssets
+  module ActiveSprites
+    module Configurable
+      extend ActiveSupport::Concern
+
+      included do
+        config_accessor :sprite_backend
+      end
+    end
+  end
+end

data/lib/active_assets/active_sprites/railtie.rb

@@ -9,7 +9,7 @@ module ActiveAssets
       config.active_sprites = ActiveSupport::OrderedOptions.new
 
       rake_tasks do
-        ActiveAssets::ActiveSprites.define_tasks
+        Dir[File.expand_path("../../../tasks/active_sprites/*.rake", __FILE__)].each {|f| load f}
       end
 
       initializer 'active_sprites-extend-application' do

data/lib/active_assets/active_sprites/runners/abstract_runner.rb

@@ -1,5 +1,6 @@
 require 'action_controller'
 require 'action_view'
+require 'rack/mount'
 require 'action_view'
 require 'fileutils'
 
@@ -9,14 +10,15 @@ module ActiveAssets
       class AssetContext < ActionView::Base
       end
 
-      def initialize(sprites)
+      def initialize(railtie, sprites)
+        @railtie = railtie
         @sprites = if ENV['SPRITE']
           sprites.select do |name, sprite|
             ENV['SPRITE'].split(',').map(&:strip).any? do |sp|
               # were going to be very forgiving
               name == sp ||
               name == sp.to_sym ||
-              name == self.normalize_path(sp)
+              name == ::Rack::Mount::Utils.normalize_path(sp)
             end
           end.map(&:last)
         else
@@ -59,7 +61,7 @@ module ActiveAssets
             end
 
             stylesheet = SpriteStylesheet.new(sprite_pieces)
-            stylesheet_file_path = File.join(Rails.public_path, sprite_stylesheet_path)
+            stylesheet_file_path = File.join(@railtie.config.paths.public.to_a.first, sprite_stylesheet_path)
             $stdout << "Writing stylesheet to #{stylesheet_file_path} ... " if verbose
             stylesheet.write stylesheet_file_path
             $stdout << "done.\n" if verbose
@@ -68,7 +70,7 @@ module ActiveAssets
             create_sprite(sprite, sprite_path, sprite_pieces, image_list, width, height, orientation, verbose)
             $stdout << "Success!\n" if verbose
 
-            sprite_file_path = File.join(Rails.public_path, sprite_path)
+            sprite_file_path = File.join(@railtie.config.paths.public.to_a.first, sprite_path)
             $stdout << "Writing sprite to #{sprite_file_path} ... " if verbose
             write sprite_file_path, sprite.quality
             $stdout << "done.\n" if verbose
@@ -89,11 +91,13 @@ module ActiveAssets
         end
 
         def image_computed_full_path(path)
-          File.join(Rails.public_path, image_computed_path(path))
+          File.join(@railtie.config.paths.public.to_a.first, image_computed_path(path))
         end
 
         def stylesheet_computed_path(path)
-          File.join('stylesheets', path)
+          stylesheet_full_path = @railtie.config.respond_to?(:action_controller) && @railtie.config.paths.public.stylesheets.to_a.first
+          stylesheet_path = stylesheet_full_path ? stylesheet_full_path[%r{public/(.*)}, 1] : 'stylesheets'
+          File.join(stylesheet_path, path)
         end
 
         def sanitize_asset_path(path)
@@ -101,25 +105,9 @@ module ActiveAssets
         end
 
         def sprite_url(sprite, sprite_path)
-          sprite.url.present? ? sprite.url : normalize_path(sprite_path)
+          sprite.url.present? ? sprite.url : ::Rack::Mount::Utils.normalize_path(sprite_path)
         end
 
-        # Rack::Mount::Utils#normalize_path from rack-mount 0.6.13
-        # Normalizes URI path.
-        #
-        # Strips off trailing slash and ensures there is a leading slash.
-        #
-        #   normalize_path("/foo")  # => "/foo"
-        #   normalize_path("/foo/") # => "/foo"
-        #   normalize_path("foo")   # => "/foo"
-        #   normalize_path("")      # => "/"
-        def normalize_path(path)
-          path = "/#{path}"
-          path.squeeze!('/')
-          path.sub!(%r{/+\Z}, '')
-          path = '/' if path == ''
-          path
-        end
     end
   end
 end

data/lib/active_assets/active_sprites/sprite_piece.rb

@@ -1,3 +1,5 @@
+require 'rack/mount'
+
 module ActiveAssets
   module ActiveSprites
     class SpritePiece

data/lib/active_assets/active_sprites/sprites.rb

@@ -1,7 +1,11 @@
+require 'active_support/configurable'
+
 module ActiveAssets
   module ActiveSprites
     class Sprites
-      cattr_accessor :sprite_backend
+      include ActiveSupport::Configurable
+      include Configurable
+      ActiveSupport.run_load_hooks(:active_sprites, self)
 
       def initialize
         @sprites = Hash.new do |sprites, name|
@@ -45,39 +49,39 @@ module ActiveAssets
         @sprites.clear
       end
 
-      def generate!
+      def generate!(railtie = Rails.application)
         begin
           case sprite_backend
           when :rmagick
             require 'rmagick'
-            RmagickRunner.new(@sprites).generate!
+            RmagickRunner.new(railtie, @sprites).generate!
           when :mini_magick
             require 'mini_magick'
-            MiniMagickRunner.new(@sprites).generate!
+            MiniMagickRunner.new(railtie, @sprites).generate!
           when :chunky_png, :oily_png
             begin
               require 'oily_png'
-              ChunkyPngRunner.new(@sprites).generate!
+              ChunkyPngRunner.new(railtie, @sprites).generate!
             rescue LoadError
               require 'chunky_png'
-              ChunkyPngRunner.new(@sprites).generate!
+              ChunkyPngRunner.new(railtie, @sprites).generate!
             end
           else
             begin
               require 'rmagick'
-              RmagickRunner.new(@sprites).generate!
+              RmagickRunner.new(railtie, @sprites).generate!
             rescue LoadError
               begin
                 begin
                   require 'oily_png'
-                  ChunkyPngRunner.new(@sprites).generate!
+                  ChunkyPngRunner.new(railtie, @sprites).generate!
                 rescue LoadError
                   require 'chunky_png'
-                  ChunkyPngRunner.new(@sprites).generate!
+                  ChunkyPngRunner.new(railtie, @sprites).generate!
                 end
               rescue LoadError
                 require 'mini_magick'
-                MiniMagickRunner.new(@sprites).generate!
+                MiniMagickRunner.new(railtie, @sprites).generate!
               end
             end
           end
@@ -89,16 +93,6 @@ module ActiveAssets
           $stdout << msg
         end
       end
-
-      def sprite_backend
-        @@sprite_backend
-      end
-
-      def sprite_backend=(val)
-        @@sprite_backend = val
-      end
-
-      ActiveSupport.run_load_hooks(:active_sprites, self) if ActiveSupport.respond_to?(:run_load_hooks)
     end
   end
 end