smart_asset 0.3.2 → 0.3.4

data/README.md

@@ -3,9 +3,132 @@ SmartAsset
 
 Smart asset packaging for Rails and Sinatra.
 
-Requirements
+Features
+--------
+
+Similar to <code>AssetPackager</code>, but with the following changes:
+
+* Git modified date/time for package version
+* Google Closure Compiler for javascript compression
+* Framework agnostic (adapters provided for Rails 2, Rails 3, and Sinatra)
+
+<a name="installation"></a>
+
+Installation
 ------------
 
+### Install Gem
+
 <pre>
 gem install smart_asset
+</pre>
+
+### Rails 2
+
+#### config/environment.rb
+
+<pre>
+config.gem 'smart_asset'
+</pre>
+
+### Rails 3
+
+#### Gemfile
+
+<pre>
+gem 'smart_asset'
+</pre>
+
+### Sinatra
+
+<pre>
+require 'sinatra/base'
+require 'smart_asset'
+
+class Application &lt; Sinatra::Base
+  include SmartAsset::Adapters::Sinatra
+end
+</pre>
+
+Create Configuration File
+-------------------------
+
+### config/assets.yml
+
+<pre>
+javascripts:
+  package_1:
+    - jquery/jquery
+    - underscore
+  package_2:
+    - front_page
+stylesheets:
+  package_1:
+    - blueprint/blueprint
+    - 960
+  package_2:
+    - front_page
+</pre>
+
+By default, SmartAsset will look for assets in <code>public/javascripts</code> and <code>public/stylesheets</code>.
+
+Create Packaged Assets
+----------------------
+
+<code>cd</code> to your project and run
+
+<pre>
+smart_asset
+</pre>
+
+If your project is Git version controlled, only the assets that have changed are repackaged.
+
+Otherwise, all packages generate every time.
+
+Include Packages in Your Template
+---------------------------------
+
+<pre>
+&lt;%= javascript_include_merged :package_1, :package_2 %&gt;
+&lt;%= stylesheet_link_merged :package_1, :package_2 %&gt;
+</pre>
+
+Migrating from AssetPackager
+----------------------------
+
+* <code>rm vendor/plugins/asset\_packager</code>
+* <a href="#installation">Install SmartAsset</a>
+* Move <code>config/asset\_packages.yml</code> to <code>config/assets.yml</code>
+* Instead of running <code>rake asset:packager:build_all</code>, run <code>smart\_asset</code>
+
+Other Options
+-------------
+
+You may add extra options to your <code>config/assets.yml</code> file.
+
+All the values below are the default values, excluding <code>append\_random</code> and <code>asset\_host</code>:
+
+<pre>
+# Append random numbers to script paths (defaults to true in development mode)
+append_random: false
+
+# Asset host URL (defaults to ActionController::Base.asset_host or nil)
+asset_host:
+  production: http://assets%d.mydomain.com
+
+# How many asset hosts you have (if asset_host defined with %d)
+asset_host_count: 4
+
+# Public directory
+public: public
+
+# Package destination directory (within the public directory)
+destination:
+  javascripts: javascripts/packaged
+  stylesheets: stylesheets/packaged
+
+# Asset source directories (within the public directory)
+sources:
+  javascripts: javascripts
+  stylesheets: stylesheets
 </pre>

data/lib/smart_asset/adapters/rails3.rb

@@ -1,5 +1,16 @@
-SmartAsset.env = Rails.env
-SmartAsset.load_config(Rails.root)
+if Rails.root.nil?
+  class SmartAsset
+    class SmartAssetRailtie < Rails::Railtie
+      initializer "smart_asset_railtie.configure_rails_initialization" do
+        SmartAsset.env = Rails.env
+        SmartAsset.load_config(Rails.root)
+      end
+    end
+  end
+else
+  SmartAsset.env = Rails.env
+  SmartAsset.load_config(Rails.root)
+end
 
 ActionController::Base.send(:include, SmartAsset::Helper)
 ActionController::Base.helper(SmartAsset::Helper)

data/lib/smart_asset/helper.rb

@@ -2,17 +2,19 @@ class SmartAsset
   module Helper
     
     def javascript_include_merged(*javascripts)
+      append = SmartAsset.append_random ? "?#{rand.to_s[2..-1]}" : ''
       output = javascript_paths(*javascripts).collect { |js|
-        "<script src=\"#{SmartAsset.prepend_asset_host js}\" type=\"text/javascript\"></script>"
+        "<script src=\"#{SmartAsset.prepend_asset_host js}#{append}\"></script>"
       }.join("\n")
       defined?(Rails) && Rails.version[0..0] == '3' ? output.html_safe : output
     end
     
     def stylesheet_link_merged(*stylesheets)
+      append = SmartAsset.append_random ? "?#{rand.to_s[2..-1]}" : ''
       options = stylesheets.last.is_a?(::Hash) ? stylesheets.pop : {}
       options[:media] ||= 'screen'
       output = stylesheet_paths(*stylesheets).collect { |css|
-        "<link href=\"#{SmartAsset.prepend_asset_host css}\" media=\"#{options[:media]}\" rel=\"Stylesheet\" type=\"text/css\" />"
+        "<link href=\"#{SmartAsset.prepend_asset_host css}#{append}\" media=\"#{options[:media]}\" rel=\"stylesheet\" />"
       }.join("\n")
       defined?(Rails) && Rails.version[0..0] == '3' ? output.html_safe : output
     end

data/lib/smart_asset/version.rb

@@ -1,3 +1,3 @@
 class SmartAsset
-  VERSION = "0.3.2" unless defined?(::SmartAsset::VERSION)
+  VERSION = "0.3.4" unless defined?(::SmartAsset::VERSION)
 end

data/lib/smart_asset.rb

@@ -14,7 +14,7 @@ require 'smart_asset/version'
 class SmartAsset
   class <<self
     
-    attr_accessor :asset_host, :asset_counter, :cache, :config, :dest, :env, :envs, :pub, :root, :sources
+    attr_accessor :append_random, :asset_host, :asset_counter, :cache, :config, :dest, :env, :envs, :pub, :root, :sources
     
     BIN = File.expand_path(File.dirname(__FILE__) + '/../bin')
     CLOSURE_COMPILER = BIN + '/closure_compiler.jar'
@@ -39,7 +39,7 @@ class SmartAsset
           files.each do |file|
             if File.exists?("#{dir}/#{file}.#{ext}")
               mod = `cd #{@root} && git log --pretty=format:%cd -n 1 --date=iso #{@config['public']}/#{@sources[type]}/#{file}.#{ext}`
-              if mod.strip.empty?
+              if mod.strip.empty? || mod.include?('command not found')
                 modified << Time.now.utc.strftime("%Y%m%d%H%M%S")
               else
                 modified << Time.parse(mod).utc.strftime("%Y%m%d%H%M%S")
@@ -90,6 +90,9 @@ class SmartAsset
       @root = File.expand_path(root)
       @config = YAML::load(File.read("#{@root}/#{relative_config}"))
       
+      if @config['append_random'].nil?
+        @config['append_random'] = @env == 'development'
+      end
       @config['asset_host_count'] ||= 4
       @config['asset_host'] ||= ActionController::Base.asset_host rescue nil
       @config['environments'] ||= %w(production)
@@ -110,6 +113,7 @@ class SmartAsset
         end
       end
       
+      @append_random = @config['append_random']
       @asset_host = @config['asset_host']
       @envs = @config['environments']
       @sources = @config['sources']

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Winton Welsh
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-08 00:00:00 -08:00
+date: 2010-12-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency