rack-less 1.3.1 → 1.4.0

data/README.rdoc

@@ -74,15 +74,27 @@ You should now see `Rack::Less` listed in the middleware pipeline:
 * .*combinations* [{}]
   - Directives for combining the output of many stylesheets and serving them as a single resource.
 
-* .*combination_timestamp* [false]
+* .*cache_bust* [nil]
   - Directives for timestamping (cache-busting) while using combinations
-    - :*false* - don't explicitly add timestamps
-    - :*true* - add Time.now.to_i as the explicit timestamp (will never cache)
-    - :*<any other value>* - add the value as "foo.css?<value>" (use something like a File.mtime to cache-bust like Rails does)
+    - :*false* - don't explicitly cache bust (no value added)
+    - :*true* - use Time.now.to_i as the explicit value (will never cache)
+    - :*nil* - change cache bust value if the file is modified (similar to Rails' stylesheet_link_tag)
+    - :*<any other value>* - add the value as "foo.css?<value>"
+    
+=== Using in layouts
+
+==== Cache Busting
+
+Rails does a lot of helpful things with 'stylesheet_link_tag' to help reference your stylesheets into your layouts - things like cache busting stylesheet hrefs.  However, Rails' will only cache bust your stylesheets if the file exists in the public/stylesheets directory.  When using Rack::Less a file may never exist at that path or, when caching is used, only exist after the initial request.
+
+To help provide this behavior, Rack::Less provides a helper for generating reference paths to your stylesheets.
+
+    # equivalent to: stylesheet_link_tag 'reset'
+    stylesheet_link_tag Rack::Less.stylesheet('reset')
 
-=== Combinations
+==== Combinations
 
-At times, it is useful to combine multiple stylesheets and serve them as one resource.  For example you may have two sets of stylesheets: one for traditional web views and one for mobile web views.  Rails' provides the :cache option on 'stylesheet_link_tag' helper to provide this function, ie:
+At times, it is useful to combine multiple stylesheets and serve them as one resource.  For example you may have two sets of stylesheets: one for traditional web views and one for mobile web views.  Rails' provides the :cache option on 'stylesheet_link_tag' helper to provide this function.
 
     stylesheet_link_tag 'reset', 'common', 'app_web', :cache => 'web'
     stylesheet_link_tag 'reset', 'common', 'iui', 'app_mobile', :cache => 'mobile'
@@ -96,13 +108,13 @@ Rack::Less uses combinations, in conjunction with the :cache config setting, to
       }
     end
 
-and stylesheet link tags like this, respectively:
+and stylesheet link tags like this:
 
     # equivalent to: stylesheet_link_tag 'reset', 'common', 'app_web'
-    stylesheet_link_tag Rack::Less.combinations('web')
+    stylesheet_link_tag Rack::Less.stylesheet('web')
     
     # equivalent to: stylesheet_link_tag 'reset', 'common', 'iui', 'app_mobile'
-    stylesheet_link_tag Rack::Less.combinations('mobile')
+    stylesheet_link_tag Rack::Less.stylesheet('mobile')
     
 If you configure Rack::Less to cache, with something like this:
 
@@ -111,10 +123,10 @@ If you configure Rack::Less to cache, with something like this:
 then the same stylesheet link tags behave like they have the :cache option set, respectively:
 
     # equivalent to: stylesheet_link_tag 'reset', 'common', 'app_web', :cache => 'web'
-    stylesheet_link_tag Rack::Less.combinations('web')
+    stylesheet_link_tag Rack::Less.stylesheet('web')
 
     # equivalent to: stylesheet_link_tag 'reset', 'common', 'iui', 'app_mobile', :cache => 'mobile'
-    stylesheet_link_tag Rack::Less.combinations('mobile')
+    stylesheet_link_tag Rack::Less.stylesheet('mobile')
 
 == Links
 

data/Rakefile

@@ -17,13 +17,14 @@ spec = Gem::Specification.new do |s|
   s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
   # s.executables    = ['rack-less']
 
-  s.add_dependency("rack", [">= 0.4"])
-  s.add_dependency("less", [">= 1.2.21"])
-
   s.add_development_dependency("shoulda", [">= 2.10.2"])
   s.add_development_dependency("sinatra", [">= 0.9.4"])
   s.add_development_dependency("rack-test", [">= 0.5.3"])
   s.add_development_dependency("webrat", [">= 0.6.0"])
+  s.add_development_dependency("yui-compressor", [">=0.9.1"])
+
+  s.add_dependency("rack", [">= 0.4"])
+  s.add_dependency("less", [">= 1.2.21"])
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/lib/rack/less.rb

@@ -43,12 +43,23 @@ module Rack::Less
     def combinations(key=nil)
       @@config.combinations(key)
     end
+    
+    # Stylesheet helper, config convenience method
+    def stylesheet(key)
+      @@config.stylesheet(key)
+    end
 
-    # Combination timestamp config convenience method
-    def combination_timestamp
-      @@config.combination_timestamp
+    # Cache bust config convenience method
+    def cache_bust
+      @@config.cache_bust
     end
 
+    # <b>DEPRECATED:</b> Please use <tt>cache_bust</tt> instead.
+    def combination_timestamp
+      warn "[DEPRECATION] `combination_timestamp` is deprecated.  Please use `cache_bust` instead."
+      cache_bust
+    end
+    
   end
 
   # Create a new Rack::Less middleware component 

data/lib/rack/less/base.rb

@@ -55,6 +55,6 @@ module Rack::Less
         raise(ArgumentError, "no :source option set")
       end
     end
-
+    
   end
 end

data/lib/rack/less/config.rb

@@ -21,24 +21,36 @@ module Rack::Less
   #       'web'    => ['reset', 'common', 'app_web'],
   #       'mobile' => ['reset', 'iui', 'common', 'app_mobile']
   #     }
-  # :combination_timestamps
+  # :cache_bust
   #   whether to append a timestamp to the sheet requests generated by combinations
   class Config
     
-    ATTRIBUTES = [:cache, :compress, :combinations, :combination_timestamp]
+    ATTRIBUTES = [:cache, :compress, :combinations, :cache_bust]
     attr_accessor *ATTRIBUTES
     
     DEFAULTS = {
       :cache        => false,
       :compress     => false,
-      :combinations => {},
-      :combination_timestamp => false
+      :combinations => {}
     }
 
     def initialize(settings={})
       ATTRIBUTES.each do |a|
         instance_variable_set("@#{a}", settings[a] || DEFAULTS[a])
-      end
+      end      
+      @cache_bust = default_cache_bust if @cache_bust.nil?
+    end
+    
+    # <b>DEPRECATED:</b> Please use <tt>cache_bust</tt> instead.
+    def combination_timestamp
+      warn "[DEPRECATION] `combination_timestamp` is deprecated.  Please use `cache_bust` instead."
+      cache_bust
+    end
+    
+    # <b>DEPRECATED:</b> Please use <tt>cache_bust=</tt> instead.
+    def combination_timestamp=(value)
+      warn "[DEPRECATION] `combination_timestamp=` is deprecated.  Please use `cache_bust=` instead."
+      cache_bust = value
     end
     
     def cache?
@@ -54,30 +66,58 @@ module Rack::Less
         @combinations
       else
         if cache?
-          combo_filename(key)
+          stylesheet_filename(key)
         else
           (@combinations[key] || []).collect do |combo|
-            combo_filename(combo)
+            stylesheet_filename(combo)
           end
         end
       end
     end
     
+    def stylesheet(key)
+      if @combinations[key]
+        combinations(key.to_s)
+      else
+        stylesheet_filename(key.to_s)
+      end
+    end
+
     private
     
-    def combo_filename(combo)
-      filename = combo.strip
+    def stylesheet_filename(key)
+      filename = key.strip
       filename += ".css" unless filename.include?('.css')
-      if !filename.include?('?') && combination_timestamp
+      if !filename.include?('?') && cache_bust
         filename += "?"
-        filename += if combination_timestamp == true
+        filename += if cache_bust == true
           Time.now.to_i
         else
-          combination_timestamp
+          cache_bust
         end.to_s
       end
       filename
     end
     
+    def default_cache_bust
+      if defined?(::Sinatra) && defined?(::Sinatra::Application)
+        app_root_cache_bust(::Sinatra::Application)
+      elsif defined?(::Rails)
+        app_root_cache_bust(::Rails)
+      end || false
+    end
+    
+    def app_root_cache_bust(app)
+      if app.respond_to?(:root)
+        mtime_cache_bust(app.root.to_s)
+      end
+    end
+    
+    def mtime_cache_bust(path)
+      if File.exists?(path)
+        File.mtime(path).to_i
+      end
+    end
+    
   end
 end

data/lib/rack/less/version.rb

@@ -2,8 +2,8 @@ module RackLess
   module Version
     
     MAJOR = 1
-    MINOR = 3
-    TINY  = 1
+    MINOR = 4
+    TINY  = 0
     
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-less
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: false
   segments: 
   - 1
-  - 3
-  - 1
-  version: 1.3.1
+  - 4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -14,92 +15,120 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-14 00:00:00 -05:00
+date: 2010-08-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rack
+  name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 35
         segments: 
-        - 0
-        - 4
-        version: "0.4"
-  type: :runtime
+        - 2
+        - 10
+        - 2
+        version: 2.10.2
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: less
+  name: sinatra
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 51
         segments: 
-        - 1
-        - 2
-        - 21
-        version: 1.2.21
-  type: :runtime
+        - 0
+        - 9
+        - 4
+        version: 0.9.4
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: rack-test
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
-        - 2
-        - 10
-        - 2
-        version: 2.10.2
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: sinatra
+  name: webrat
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 0
-        - 9
-        - 4
-        version: 0.9.4
+        - 6
+        - 0
+        version: 0.6.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rack-test
+  name: yui-compressor
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 57
         segments: 
         - 0
-        - 5
-        - 3
-        version: 0.5.3
+        - 9
+        - 1
+        version: 0.9.1
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: webrat
+  name: rack
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
-        - 6
-        - 0
-        version: 0.6.0
-  type: :development
+        - 4
+        version: "0.4"
+  type: :runtime
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: less
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 1
+        - 2
+        - 21
+        version: 1.2.21
+  type: :runtime
+  version_requirements: *id007
 description: 
 email: kelly@kelredd.com
 executables: []
@@ -130,23 +159,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A better way to use LESS CSS in Ruby web apps.