asset_compiler 0.2

data/lib/asset_compiler.rb

@@ -0,0 +1,26 @@
+$: << File.join( File.dirname( __FILE__ ), 'asset_compiler' )
+
+require 'rubygems' unless $".include? 'rubygems.rb'
+require 'asset_task'
+require 'image_task'
+
+# Convenience method to define an AssetTask in the assets namespace.
+def asset_task name, &block
+  namespace :assets do
+    AssetTask.new name, &block
+  end
+end
+
+# Convenience method to define an ImageTask in the assets namespace.
+def image_task name, &block
+  namespace :assets do
+    ImageTask.new name, &block
+  end
+end
+
+# Convenience method to add transformations to RMagickTransformationScript
+def define_image_transformation name, &block
+  RMagickTransformationScript.class_eval do
+    define_method name, &block
+  end
+end

data/lib/asset_compiler/asset_task.rb

@@ -0,0 +1,168 @@
+#--
+# Jeremy Voorhis
+# March 2006
+#++
+
+# Task library for managing a directory of assets.
+# For example:
+#
+#   namespace :assets do
+#     AssetTask.new( :old_war_films ) do |t|
+#       t.src_files  = Rake::FileList[image_src 'old_war_films/*.mov']
+#       t.build_path = File.join RAILS_ROOT, 'public/assets/old_war_films'
+# 
+#       t.transformation do |src, target|
+#         cp src, target
+#       end
+#     end
+#   end
+#
+# This example defines the following tasks:
+#   rake assets:build                  # Build all assets
+#   rake assets:clobber                # Clobber all assets
+#   rake assets:old_war_films:build    # Build the old_war_films files
+#   rake assets:old_war_films:clobber  # Remove old_war_films files
+#   rake assets:old_war_films:rebuild  # Force a rebuild of the old_war_films files
+#   rake assets:rebuild                # Rebuild all assets
+
+require 'rake/tasklib'
+
+class AssetTask
+  attr_accessor :name
+  attr_accessor :src_files
+  attr_accessor :build_path
+  attr_accessor :remote_dirs
+  
+  def initialize name, &block
+    @name           = name
+    @src_files      = Rake::FileList.new
+    @remote_dirs    = []
+
+    instance_eval &block
+
+    define_clobber
+    define_rebuild
+    define_build_directory_task
+    define_build_task
+    add_dependencies_to_main_task
+  end
+
+  def from path
+    @src_files = path
+  end
+
+  def to path
+    @build_path = path
+  end
+
+  # Captures the transformation run on each individual object.
+  def transformation
+    @transformation = Proc.new
+  end
+
+  protected
+    # Returns an absolute target path for a given absolute +src+ path.
+    def target_for src
+      File.join @build_path, File.basename( src )
+    end
+
+    # Name of the build task for this task library.
+    def build_task_name
+      "#{@name}:build"
+    end
+
+    # Name of the clobber task for this task library.
+    def clobber_task_name
+      "#{@name}:clobber"
+    end
+
+    # Name of the rebuild task for this task library.
+    def rebuild_task_name
+      "#{@name}:rebuild"
+    end
+  
+    # Defines the rebuild task for this task library.
+    def define_rebuild
+      desc "Force a rebuild of the #{@name} files"
+      task rebuild_task_name => [clobber_task_name, build_task_name]
+    end
+    
+    # Defines the clobber task for this task library.
+    def define_clobber
+      desc "Remove #{@name} files"
+      task clobber_task_name do
+        rm_r @build_path rescue nil
+      end
+    end
+    
+    # Defines the task which creates the build directory if it does not exist.
+    # Automatically a dependency of the task lib's build task.
+    def define_build_directory_task
+      directory @build_path
+      task build_task_name => @build_path
+    end
+    
+    # Defines the main build task for this task library.
+    def define_build_task
+      desc "Build the #{@name} files"
+      task build_task_name
+
+      @src_files.each do |src|
+        # Figure our target
+        target = target_for src
+
+        # Process each file
+        file target => [src, @build_path] do
+          do_transformation src, target
+          do_transfer target
+        end
+        
+        # Add target as a dependency
+        task build_task_name => target
+      end
+    end
+    
+    # Adds dependencies for main asset-related tasks in this namespace
+    def add_dependencies_to_main_task
+      desc 'Build all assets' unless task( :build ).comment
+      task :build => build_task_name
+
+      desc 'Clobber all assets' unless task( :clobber ).comment
+      task :clobber => [clobber_task_name]
+
+      desc 'Rebuild all assets' unless task( :rebuild ).comment
+      task :rebuild => [clobber_task_name, build_task_name]
+    end
+    
+  protected
+    # Transform a file based on a previously captured block where +src+ is the path to a source file
+    # and +target+ is the build task's target file. Dependent tasks may expect +target+ to exist.
+    def do_transformation src, target
+      @transformation.call src, target
+    end
+
+    # Transfer a file to a remote directory. Supports multiple file transports.
+    def do_transfer target
+      unless @remote_dirs.empty? || ENV['TRANSFER'] == 'no'
+        raise "File #{target} not found!" unless File.exist? target
+        
+        @remote_dirs.each do |dir|
+          case dir[:transport]
+          when :ftp
+            do_ftp dir[:host], dir[:user], dir[:password], dir[:path], target
+          when :ssh
+            # TODO: implement me!
+          end
+        end
+      end
+    end
+    
+    # Transport a file to a remote directory via FTP.
+    def do_ftp host, user, pwd, path, file
+      require 'net/ftp'
+      Net::FTP.open host, user, pwd do |ftp|
+        ftp.chdir path
+        ftp.putbinaryfile file
+      end
+    end
+end

data/lib/asset_compiler/image_task.rb

@@ -0,0 +1,39 @@
+#--
+# Jeremy Voorhis
+# March 2006
+#++
+
+require 'rmagick_transformation_script'
+
+# Task library for managing a directory of images.
+#
+# For example:
+#   namespace :assets do
+#     ImageTask.new( :navigation_icons ) do |t|
+#       t.src_files  = Rake::FileList[image_src 'navigation_icons/*.jpg']
+#       t.build_path = File.join RAILS_ROOT, 'public/assets/navigation_icons'
+# 
+#       t.transformation do |img|
+#         img.greyscale
+#         img.size_to_fit '64x64'
+#         img.icc_profile icc_profile_path
+#         img.icm_profile icm_profile_path
+#       end
+#     end
+#   end
+#
+# This example defines the following tasks:
+#   rake assets:build                     # Build all assets
+#   rake assets:clobber                   # Clobber all assets
+#   rake assets:navigation_icons:build    # Build the navigation_icons files
+#   rake assets:navigation_icons:clobber  # Remove navigation_icons files
+#   rake assets:navigation_icons:rebuild  # Force a rebuild of the navigation_icons files
+#   rake assets:rebuild                   # Rebuild all assets
+class ImageTask < AssetTask
+  
+  protected
+    def do_transformation src, target
+      transformation_script = RMagickTransformationScript.new src, &@transformation
+      transformation_script.write target
+    end
+end

data/lib/asset_compiler/rmagick_transformation_script.rb

@@ -0,0 +1,156 @@
+require 'RMagick'
+
+# Holds a reference to an instance of <tt>Magick::Image</tt> and manages operations on it. Used
+# to provide a more consistent, higher-level api than is given by RMagick.
+#
+# +ImageTransformationScript+ automatically invokes Ruby's garbage collector by calling <tt>GC.start</tt>
+# upon instantiating a Magick::Image object. To bypass this, set the +GC+ environment variable to 'no'.
+class RMagickTransformationScript
+  
+  GRAVITY_TYPES = {
+    :none      => Magick::ForgetGravity,
+    :northwest => Magick::NorthWestGravity,
+    :north     => Magick::NorthGravity,
+    :northeast => Magick::NorthEastGravity,
+    :west      => Magick::WestGravity,
+    :center    => Magick::CenterGravity,
+    :east      => Magick::EastGravity,
+    :southwest => Magick::SouthWestGravity,
+    :south     => Magick::SouthGravity,
+    :southeast => Magick::SouthEastGravity
+  }
+
+  # Initialize an <tt>ImageTransformationScript</tt> where +img+ is either a path to an image or
+  # an instance of <tt>Magick::Image</tt>.
+  def initialize img, &block
+    @image = img      if img.is_a? Magick::Image
+    @image = read img if img.is_a? String
+    raise ArgumentError.new( 'img must be either a path to an image or a Magick::Image object' ) \
+        unless @image
+    
+    instance_eval &block
+    
+    GC.start unless ENV['GC'] == 'no'
+  end
+
+  # Read an image from a file specified by +src+ and return a <tt>Magick::Image</tt> instance.
+  def read src
+    Magick::Image.read( src ).first
+  end
+  
+  # Write the image to a specified path, <tt>target</tt>.
+  def write target
+    @image.write target do
+      quality = 95
+    end
+  end
+  
+  # Tints the image according to the following parameters:
+  # * <tt>r</tt> Blending factor for the red channel
+  # * <tt>g</tt> Blending factor for the green channel
+  # * <tt>b</tt> Blending factor for the blue channel
+  # * <tt>overlay</tt> Color to tint the image
+  #   img.tint 0.25, 0.25, 0.25, #ffffff # lightens the image 25%
+  def tint r, g, b, overlay
+    @image = @image.colorize r, g, b, overlay
+    @image
+  end
+  
+  # Sharpen only the edges of the image. Parameters are:
+  # * <tt>rad</tt> Radius: how big an edge can be
+  # * <tt>sig</tt> Sigma weight for gaussian: leave it at 1.0.
+  # * <tt>blend</tt> Blending factor: how much sharpening to apply as a percentage
+  # * <tt>thresh</tt> Threshold: how different 2 pixels must be to qualify as an edge
+  #   img.unsharp_mask  0.5, 1.0, 0.5, 0.25
+  def unsharp_mask rad = 0.5, sig = 1.0, blend = 0.5, thresh = 0.25
+    @image = @image.unsharp_mask rad, sig, blend, thresh
+    @image
+  end
+
+  # Lightens the image. Defaults to a blend factor of 25%.
+  #   img.lighten      # lightens the image 25%.
+  #   img.lighten 0.40 # lightens the image 40%.
+  def lighten factor = 0.25
+    tint factor, factor, factor, '#ffffff'
+  end
+  
+  # Darkens the image. Defaults to a blend factor of 25%.
+  #   img.darken      # darkens the image 25%.
+  #   img.darken 0.40 # darkens the image 40%.
+  def darken factor = 0.25
+    tint factor, factor, factor, '#000000'
+  end
+
+  # Converts the image to greyscale.
+  #   img.greyscale           # uses default overlay of #aa9955.
+  #   img.greyscale '#aaaaaa' # uses specified overlay.
+  def greyscale overlay = '#aa9955'
+    @image = @image.quantize 256, Magick::GRAYColorspace
+    tint 0.25, 0.25, 0.25, overlay
+    @image
+  end
+  
+  # Resizes the image to fit within the constraints specified by +dimensions+ where +dimensions+ is
+  # a +String+ in the format of 'WIDTHxLENGTH'.
+  #   img.size_to_fit '64x64'
+  def size_to_fit dimensions
+    @image.change_geometry dimensions do |w,h,img|
+      img.density = '72x72'
+      img.resize! w, h
+      #             radius, sigma,  blend, threshold
+      unsharp_mask  0.5,    1.0,    0.5,   0.25
+    end
+  end
+  
+  # Resizes the image proportionally to fit the smaller dimension, then crops excess.
+  # Optionally, a gravity setting may be provided. From the RMagick docs:
+  #
+  #   Gravity provides a convenient way to locate objects irrespective of the size of the
+  #   bounding region, in other words, you don't need to provide absolute coordinates in
+  #   order to position an object.
+  #
+  # The default gravity setting is <tt>:center</tt>. Available settings are:
+  # [<tt>:none</tt>]      don't use gravity
+  # [<tt>:northwest</tt>] crop to northwest
+  # [<tt>:north</tt>]     crop to north - good for vertical images
+  # [<tt>:northeast</tt>] crop to northeast
+  # [<tt>:west</tt>]      crop to west
+  # [<tt>:center</tt>]    crop to center - default
+  # [<tt>:east</tt>]      crop to east
+  # [<tt>:southwest</tt>] crop to southwest
+  # [<tt>:south</tt>]     crop to south
+  # [<tt>:southeast</tt>] crop to southeast
+  #
+  # Usage:
+  #   img.crop_to '64x64'         # crops to center, 64x64 pixels
+  #   img.crop_to '64x64', :north # crops to north - common for thumbnailing portraits
+  def crop_to size_string, gravity = :center
+    width, height = size_string.scan( /\d+/ ).collect { |i| i.to_i }
+    max = ( width > height ? width : height )
+    aspect = @image.columns.to_f / @image.rows.to_f
+    @image.resize!( max, ( max / aspect ).to_i ) if     aspect < 1.0
+    @image.resize!( (max*aspect).to_i, max )     unless aspect < 1.0
+    #            radius, sigma,  blend, threshold
+    unsharp_mask 0.5,    1.0,    0.5,   0.25
+    @image.crop!( GRAVITY_TYPES[gravity], width, height )
+    @image
+  end
+
+  # Applies an ICC profile to the image. Requires +path+ which is a path to a file containing
+  # a valid ICC profile.
+  #   img.icc_profile 'srgb.icc'
+  def icc_profile path
+    profile = File.open( path ).readlines.join( '' ) if File.exist? path
+    @image.profile! 'ICC', profile if profile
+    @image
+  end
+
+  # Applies an ICM profile to the image. Requires +path+ which is a path to a file containing
+  # a valid ICM profile.
+  #   img.icm_profile 'srgb.icm'
+  def icm_profile path
+    profile = File.open( path ).readlines.join('') if File.exist? path
+    @image.profile! 'ICM', profile if profile
+    @image
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.10
+specification_version: 1
+name: asset_compiler
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+date: 2006-05-08
+summary: Rake task libraries for managing assets. Especially images.
+require_paths: 
+  - lib
+email: jeremy@planetargon.com
+homepage: 
+rubyforge_project: 
+description: "Asset Compiler is a collection of Rake task libraries to lighten the load of
+  asset management. These libraries allow you to manage local assets, manipulate
+  images and transport assets to a remote server."
+autorequire: asset_compiler
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Jeremy Voorhis
+files: 
+  - lib/asset_compiler.rb
+  - lib/asset_compiler/asset_task.rb
+  - lib/asset_compiler/image_task.rb
+  - lib/asset_compiler/rmagick_transformation_script.rb
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: 
+  - "RMagick, built with lcms"
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.7.0
+      version: