active_assets 0.2.3 → 0.2.4

data/README.md

@@ -1,15 +1,10 @@
 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.
+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:
 
-    gem install rmagick
-    ... OR ...
-    gem install oily_png
-    ... OR ...
-    gem install chunky_png
-
-    gem install active_assets
+* 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.
 
 Gemfile
 -------
@@ -24,11 +19,14 @@ Gemfile
       gem 'oily_png'
       ... OR ...
       gem 'chunky_png'
-      ...
+      ... OR ...
+      gem 'mini_magick
     end
     ...
 
-In your rails app
+The above order of image libraries is also the load order precedence.
+
+In your Rails app
 -----------------
 ### application.rb
 
@@ -37,25 +35,27 @@ In your rails app
     require 'active_assets/railtie'
     ...
 
-You can also include only ActiveSprites or only ActiveExpansions in your application
-
+#### You can also include only ActiveSprites or only ActiveExpansions in your application
 ### application.rb
+Instead of the above,
+
     ...
     require 'rails/all'
-    require 'active\_assets/active\_expansions/railtie'
+    require 'active_assets/active_expansions/railtie'
     ... OR ...
-    require 'active\_assets/active\_sprites/railtie'
+    require 'active_assets/active_sprites/railtie'
     ...
 
-## The dsls
-
+## The DSLs
 ### Introduction to Active Sprites
 
-ActiveSprites allows you to generate sprites within your Rails apps with `rake sprites`!  All you need is rmagick and you are on your way. If you don't have rmagick installed, ActiveSprites will just fail silently when you try to generate the sprites. 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.
+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.
+
+A basic example ...
 
 #### config/sprites.rb
     Rails.application.sprites do
-      sprite 'sprites/world_flags.png' => 'sprites/world_flags.css'
+      sprite 'sprites/world_flags.png' => 'sprites/world_flags.css' do
         _"sprite_images/world_flags/Argentina.gif" => ".flags.argentina"
         _"sprite_images/world_flags/Australia.gif" => ".flags.australia"
         ...
@@ -74,7 +74,7 @@ or
 It is possible to add all of the world flags!  Haha, see the following example,
 
     Rails.application.sprites do
-      sprite :world_flags
+      sprite :world_flags do
         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('_')}"
@@ -88,7 +88,7 @@ It is possible to add all of the world flags!  Haha, see the following example,
 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`.
 
 #### ActiveSprites configuration 
-Rmagick is used by default.  To switch to `oily_png`, which is a c extension for `chunky_png` and has the same api as `chunky_png`, apply the configuration below. 
+Rmagick is used by default and is by far the fastest.  You can use one of two methods to select a backend to use.  Simply install any from the list above, and ActiveSprites, will automatically use the one that is available, OR configure ActiveSprites to use a specific backend:
 
 ##### config/application.rb
 
@@ -96,7 +96,6 @@ Rmagick is used by default.  To switch to `oily_png`, which is a c extension for
     config.active_sprites.sprite_backend = :chunky_png
     ...
 
-In summary, if `rmagick` is installed, it will used by default. If `oily_png` is installed AND the `sprite_backend` is set to `:chunky_png` (see below), then `oliy_png` will be used.  If `oily_png` is not installed but `chunky_png` is, AND the `sprite_backend` is set to `:chunky_png`, then `chunky_png` will be used. 
 
 ### Introduction to Active Expansions
 

data/active_assets.gemspec

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "active_assets"
-  s.version     = '0.2.3'
+  s.version     = '0.2.4'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Sam Woodard"]
   s.email       = ["sam@wildfireapp.com"]
   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.  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.summary     = %q{A Railtie that provides an asset management system for css, javascript, and sprites in your Rails applications and engines.}
+  s.description = %q{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}
 
   s.rubyforge_project = "activeassets"
 
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   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"

data/lib/active_assets/active_sprites.rb

@@ -9,8 +9,12 @@ module ActiveAssets
     autoload :Sprites
     autoload :Configurable
     autoload :SpriteStylesheet
-    autoload :RmagickRunner
-    autoload :ChunkyPngRunner
+    autoload_under "runners" do
+      autoload :AbstractRunner
+      autoload :RmagickRunner
+      autoload :MiniMagickRunner
+      autoload :ChunkyPngRunner
+    end
 
     def self.load_engine_tasks(engine_class)
       desc "Generate sprites"

data/lib/active_assets/active_sprites/configurable.rb

@@ -7,7 +7,6 @@ module ActiveAssets
 
       included do
         config_accessor :sprite_backend
-        self.sprite_backend = :rmagick if sprite_backend.nil?
       end
     end
   end

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

@@ -0,0 +1,124 @@
+require 'action_controller'
+require 'action_view'
+require 'rack/mount'
+require 'action_view'
+require 'fileutils'
+
+module ActiveAssets
+  module ActiveSprites
+    class AbstractRunner
+      class AssetContext < ActionView::Base
+      end
+
+      def initialize(railtie, sprites)
+        @railtie = railtie
+        setup_context
+        @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 == ::Rack::Mount::Utils.normalize_path(sp)
+            end
+          end.map(&:last)
+        else
+          sprites.values
+        end
+      end
+
+      def generate!
+        verbose = ENV['VERBOSE'] == 'true' || ENV['DEBUG']
+
+        if verbose
+          t = Time.now
+          $stdout << "#{t}: Active Sprites: \"I'm starting my run using #{runner_name}.\"\n" 
+          $stdout << "\nSprites to create:\n\"#{@sprites.map(&:path).join('", "')}\"\n"
+        end
+
+        @sprites.each do |sprite|
+          next if sprite.sprite_pieces.empty?
+
+          if verbose
+            t_sprite = Time.now
+            $stdout << "\n=================================================\n"
+            $stdout << "Starting Sprite, #{sprite.path}\n"
+          end
+
+          sprite_path = sanitize_asset_path(context.image_path(sprite.path))
+          sprite_stylesheet_path = sanitize_asset_path(context.stylesheet_path(sprite.stylesheet_path))
+
+          orientation = sprite.orientation.to_s
+          sprite_pieces = sprite.sprite_pieces
+
+          begin
+            $stdout << "Gathering sprite details..." if verbose
+            image_list, width, height = set_sprite_details_and_return_image_list(sprite, sprite_path, sprite_pieces, orientation)
+            $stdout << "done.\n" if verbose
+
+            if ENV['DEBUG']
+              $stdout << "|\tpath\t|\tselectors\t|\tx\t|\ty\t|\twidth\t|\theight\t|\n"
+              $stdout << "#{sprite_pieces.map(&:to_s).join("\n")}\n"
+            end
+
+            stylesheet = SpriteStylesheet.new(sprite_pieces)
+            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
+
+            $stdout << "Beginning sprite generation using #{runner_name.humanize}.\n" if verbose
+            create_sprite(sprite, sprite_path, sprite_pieces, image_list, width, height, orientation, verbose)
+            $stdout << "Success!\n" if verbose
+
+            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
+
+            $stdout << "Finished #{sprite.path} in #{Time.now - t_sprite} seconds.\n" if verbose
+            $stdout << "=================================================\n\n" if verbose
+          ensure
+            finish
+          end
+        end
+
+        $stdout << "#{Time.now}: ActiveSprites \"I finished my run in #{Time.now - t} seconds.\"\n" if verbose
+      end
+
+      private
+        def image_full_path(path)
+          File.join(@railtie.config.paths.public.to_a.first, sanitize_asset_path(context.image_path(path)))
+        end
+
+        def context
+          @context
+        end
+
+        def sanitize_asset_path(path)
+          path.split('?').first
+        end
+
+        def setup_context
+          unless @railtie.config.respond_to?(:action_controller)
+            @railtie.config.action_controller = ActiveSupport::OrderedOptions.new
+
+            paths   = @railtie.config.paths
+            options = @railtie.config.action_controller
+
+            options.assets_dir           ||= paths.public.to_a.first
+            options.javascripts_dir      ||= paths.public.javascripts.to_a.first
+            options.stylesheets_dir      ||= paths.public.stylesheets.to_a.first
+
+            ActiveSupport.on_load(:action_controller) do
+              options.each { |k,v| send("#{k}=", v) }
+            end
+          end
+
+          controller = ActionController::Base.new
+          @context = AssetContext.new(@railtie.config.action_controller, {}, controller)
+        end
+
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+begin
+  require 'oily_png'
+rescue LoadError
+  require 'chunky_png'
+end
+
+module ActiveAssets
+  module ActiveSprites
+    class ChunkyPngRunner < AbstractRunner
+      private
+        def set_sprite_details_and_return_image_list(sprite, sprite_path, sprite_pieces, orientation)
+          width, height = 0, 0
+
+          image_list = sprite_pieces.map do |sp|
+            sprite_piece_path = image_full_path(sp.path)
+            sp_image =  ChunkyPNG::Image.from_file(sprite_piece_path)
+            sp.details = SpritePiece::Details.new(
+              sprite.url.present? ? sprite.url : sprite_path,
+              orientation == Sprite::Orientation::VERTICAL ? 0 : width,
+              orientation == Sprite::Orientation::VERTICAL ? height : 0,
+              sp_image.width,
+              sp_image.height
+            )
+
+            width = orientation == Sprite::Orientation::HORIZONTAL ? width + sp_image.width : [width, sp_image.width].max
+            height = orientation == Sprite::Orientation::VERTICAL ? height + sp_image.height : [height, sp_image.height].max
+
+            sp_image
+          end
+          [image_list, width, height]
+        end
+
+        def create_sprite(sprite, sprite_path, sprite_pieces, image_list, width, height, orientation, verbose)
+          @sprite = ChunkyPNG::Image.new(width, height, ChunkyPNG::Color::TRANSPARENT)
+
+          image_list.each_with_index do |image, i|
+            @sprite.replace(image, sprite_pieces[i].details.x, sprite_pieces[i].details.y)
+            $stdout << '.' if verbose
+          end
+          $stdout << "\n" if verbose
+        end
+
+        def write(path, quality = nil)
+          FileUtils.mkdir_p(File.dirname(path))
+          @sprite.save(path)
+        end
+
+        def finish
+          @sprite = nil
+        end
+
+        def runner_name
+          begin
+            require 'oily_png'
+            'oily_png'
+          rescue LoadError
+            'chunky_png'
+          end
+        end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+require 'mini_magick'
+
+module ActiveAssets
+  module ActiveSprites
+    class MiniMagickRunner < AbstractRunner
+      class ImageTempfile < Tempfile
+        def make_tmpname(ext, n)
+          'mini_magick%d-%d%s' % [$$, n, ext ? ".#{ext}" : '']
+        end
+      end
+
+      private
+        def set_sprite_details_and_return_image_list(sprite, sprite_path, sprite_pieces, orientation)
+          offset = 0
+
+          image_list = sprite_pieces.map do |sp|
+            sp_path = image_full_path(sp.path)
+            image = MiniMagick::Image.open(sp_path)
+            sp.details = SpritePiece::Details.new(
+              sprite.url.present? ? sprite.url : sprite_path,
+              orientation == Sprite::Orientation::VERTICAL ? 0 : offset,
+              orientation == Sprite::Orientation::VERTICAL ? offset : 0,
+              image["width"],
+              image["height"]
+            )
+            offset += orientation == Sprite::Orientation::VERTICAL ? image["width"] : image["height"]
+
+            image
+          end
+          [image_list]
+        end
+
+        def create_sprite(sprite, sprite_path, sprite_pieces, image_list, width, height, orientation, verbose)
+          begin
+            tempfile = ImageTempfile.new(File.extname(sprite_path)[1..-1])
+            tempfile.binmode
+          ensure
+            tempfile.close
+          end
+
+          options = {
+            :tile => orientation == Sprite::Orientation::VERTICAL ? "1x#{sprite_pieces.size}" : "#{sprite_pieces.size}x1",
+            :geometry => "+0+0",
+            :background => "transparent",
+            :mattecolor => sprite.matte_color || '#bdbdbd'
+          }
+
+          args = options.map {|o, v| "-#{o} '#{v}'"}
+          image_list.each {|img| args << img.path}
+          args << tempfile.path
+
+          MiniMagick::Image.new(image_list.first.path).run_command('montage', *args)
+          image_list.size.times { $stdout << '.' } if verbose
+          $stdout << "\n" if verbose
+          @sprite = MiniMagick::Image.open(tempfile.path)
+        end
+
+        def write(path, quality = nil)
+          FileUtils.mkdir_p(File.dirname(path))
+          @sprite.write(path)
+        end
+
+        def finish
+          @sprite.destroy! if @sprite
+          @sprite = nil
+        end
+
+        def runner_name
+          'mini_magick'
+        end
+
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require 'rmagick'
+
+module ActiveAssets
+  module ActiveSprites
+    class RmagickRunner < AbstractRunner
+      include Magick
+
+      DEFAULT_SPRITE = Image.new(0,0).freeze
+
+      private
+        def set_sprite_details_and_return_image_list(sprite, sprite_path, sprite_pieces, orientation)
+          sprite_piece_paths = sprite_pieces.map do |sp|
+            image_full_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 = SpritePiece::Details.new(
+              sprite.url.present? ? sprite.url : sprite_path,
+              orientation == Sprite::Orientation::VERTICAL ? 0 : offset,
+              orientation == Sprite::Orientation::VERTICAL ? offset : 0,
+              image.columns,
+              image.rows
+            )
+            offset += orientation == Sprite::Orientation::VERTICAL ? image.rows : image.columns
+          end
+
+          [image_list]
+        end
+
+        def create_sprite(sprite, sprite_path, sprite_pieces, image_list, width, height, orientation, verbose)
+          @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'
+            self.matte_color = sprite.matte_color || '#bdbdbd'
+          end
+
+          image_list.size.times { $stdout << '.' } if verbose
+          $stdout << "\n" if verbose
+        end
+
+        def write(path, quality = nil)
+          FileUtils.mkdir_p(File.dirname(path))
+          @sprite.write("#{File.extname(path)[1..-1]}:#{path}") do
+            self.quality = quality || 75
+          end
+        end
+
+        def finish
+          if @sprite
+            @sprite.strip!
+            @sprite.destroy! unless @sprite == DEFAULT_SPRITE
+          end
+          @sprite = DEFAULT_SPRITE
+        end
+
+        def runner_name
+          'rmagick'
+        end
+
+    end
+  end
+end