rack-less 1.0.0 → 1.1.0

data/README.rdoc

@@ -16,10 +16,17 @@ or uses Rack::Builder to construct the application pipeline, simply require
 and use as follows:
 
     require 'rack/less'
+    
+    # optional - use as necessary
+    Rack::Less.configure do |config|
+      config.compress = true
+      # other configs ...
+    end
 
     use Rack::Less,
-      :source   => 'app/less'
-      :compress => true
+      :source    => 'app/less',
+      :hosted_at => '/'
+      # additional options ...
 
     run app
 
@@ -29,56 +36,84 @@ Add this to your `config/environment.rb`:
 
     config.middleware.use "Rack::Less"
 
+Add any configs in an initializer (optional - use as necessary):
+
+    Rack::Less.configure do |config|
+      config.cache = true
+      # additional configs ...
+    end
+
 You should now see `Rack::Less` listed in the middleware pipeline:
 
     rake middleware
     
 == Available Options
-[<default_value>]
+key: name [default]: description
 
 * *root* ["."]:
   the app root. the reference point for the source and public options.
 
 * *source* ['app/stylesheets']:
-  the path (relative to the root) where LESS files are located
+  the path (relative to the root) where LESS source files are located
 
 * *public* ['public']:
-  the path (relative to the root) where LESS files are located
+  the path (relative to the root) static files are located
 
 * *hosted_at* ['/stylesheets']:
-  the public HTTP root path for stylesheets
+  the public HTTP path for hosted stylesheets
+
+== Available Configurations
+key: name [default]: description
 
 * *cache* [false]:
-  whether to cache the compilation output to a corresponding file in the hosted_root
+  whether to cache the compilation output to a corresponding static file
 
 * *compress* [false]:
   whether to remove extraneous whitespace from compilation output
-  
-== Combinations
 
-At times, it is useful to combine many stylesheets and serve them as one resource.  Rails' has a helper for this:
+* *combinations* [{}]:
+  directives for combining the output of many stylesheets and serving them as a single resource
+
+=== 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:
+
+    stylesheet_link_tag 'reset', 'common', 'app_web', :cache => 'web'
+    stylesheet_link_tag 'reset', 'common', 'iui', 'app_mobile', :cache => 'mobile'
+    
+Rack::Less uses combinations, in conjunction with the :cache config setting, to provide this function.  Combinations are configured using a hash, where the key is the resource name and the value is an array of names corresponding to stylesheets to combine as the named resource.  For the above example, use a configuration like this:
+
+    Rack::Less.configure do |config|
+      config.combinations = {
+        'web' => ['reset', 'common', 'app_web'],
+        'mobile' => ['reset', 'common', 'iui', 'app_mobile']
+      }
+    end
 
-    stylesheet_link_tag 'one', two', :cache => 'app'
+and stylesheet link tags like this, respectively:
+
+    # equivalent to: stylesheet_link_tag 'reset', 'common', 'app_web'
+    stylesheet_link_tag Rack::Less.combinations('web')
+    
+    # equivalent to: stylesheet_link_tag 'reset', 'common', 'iui', 'app_mobile'
+    stylesheet_link_tag Rack::Less.combinations('mobile')
     
-Rack::Less supports this concept by providing combinations.  Combinations are specified using a hash, where the key is the combined resource name and the value is an array of stylesheets to combine as that resource.  For example:
+If you configure Rack::Less to cache, with something like this:
 
-    Rack::Less.combinations = {
-      'app' => ['one', 'two']
-    }
+    Rack::Less.config.cache = true
+    
+then the same stylesheet link tags behave like they have the :cache option set, respectively:
 
-would service the above stylesheet_link_tag.  Even better, you could re-factor the stylesheet_link_tag as follows to DRY it up:
+    # equivalent to: stylesheet_link_tag 'reset', 'common', 'app_web', :cache => 'web'
+    stylesheet_link_tag Rack::Less.combinations('web')
 
-    stylesheet_link_tag Rack::Less.combinations['app'], :cache => 'app'
+    # equivalent to: stylesheet_link_tag 'reset', 'common', 'iui', 'app_mobile', :cache => 'mobile'
+    stylesheet_link_tag Rack::Less.combinations('mobile')
 
-* *combine* [{}]:
-  directives for combining the ouput of one or more LESS compilations, for example:
-    { 'app' => ['one', 'two', 'three'] }
-  will direct Rack::Less to respond to a request for app.css with the concatenated output of compiling one.less, two.less, and three.less
-  
 == Links
 
 GitHub: http://github.com/kelredd/rack-less
-    
+
 Less:   http://lesscss.org
 
 == License

data/lib/rack/less.rb

@@ -1,4 +1,5 @@
 require 'rack'
+require 'rack/less/config'
 require 'rack/less/base'
 require 'rack/less/options'
 require 'rack/less/request'
@@ -22,15 +23,25 @@ require 'rack/less/source'
 
 module Rack::Less
   MIME_TYPE = "text/css"
+  @@config = Config.new
   
   class << self
     
-    # Proxy calls to Base.combinations
-    def combinations
-      Rack::Less::Base.combinations
+    # Configuration accessors for Rack::Less
+    # (see config.rb for details)
+    def configure
+      yield @@config if block_given?
     end
-    def combinations=(value={})
-      Rack::Less::Base.combinations = value
+    def config
+      @@config
+    end
+    def config=(value)
+      @@config = value
+    end
+    
+    # Combinations config convenience method
+    def combinations(key=nil)
+      @@config.combinations(key)
     end
 
   end

data/lib/rack/less/config.rb

@@ -0,0 +1,58 @@
+module Rack::Less
+  
+  # Handles configuration for Rack::Less
+  # Available config settings:
+  # :cache
+  #   whether to cache the compilation output to
+  #   a corresponding static file. Also determines
+  #   what value config#combinations(:key) returns
+  # :compress
+  #   whether to remove extraneous whitespace from
+  #   compilation output
+  # :combinations
+  #   Rack::Less uses combinations as directives for
+  #   combining the output of many stylesheets and
+  #   serving them as a single resource.  Combinations
+  #   are defined using a hash, where the key is the
+  #   resource name and the value is an array of
+  #   names specifying the stylesheets to combine
+  #   as that resource.  For example:
+  #     Rack::Less.config.combinations = {
+  #       'web'    => ['reset', 'common', 'app_web'],
+  #       'mobile' => ['reset', 'iui', 'common', 'app_mobile']
+  #     }
+  class Config
+    
+    ATTRIBUTES = [:cache, :compress, :combinations]
+    attr_accessor *ATTRIBUTES
+    
+    DEFAULTS = {
+      :cache        => false,
+      :compress     => false,
+      :combinations => {}
+    }
+
+    def initialize(settings={})
+      ATTRIBUTES.each do |a|
+        instance_variable_set("@#{a}", settings[a] || DEFAULTS[a])
+      end
+    end
+    
+    def cache?
+      !!@cache
+    end
+    
+    def compress?
+      !!@compress
+    end
+    
+    def combinations(key=nil)
+      if key.nil?
+        @combinations
+      else
+        cache? ? key : @combinations[key]
+      end
+    end
+    
+  end
+end

data/lib/rack/less/options.rb

@@ -1,7 +1,7 @@
 module Rack::Less
   module Options
     
-    # Handles options and configuration for Rack::Less
+    # Handles options for Rack::Less
     # Available options:
     # => root
     #    the app root. the reference point for the
@@ -14,12 +14,6 @@ module Rack::Less
     #    static files are served
     # => hosted_at
     #    the public HTTP root path for stylesheets
-    # => cache
-    #    whether to cache the compilation output to a
-    #    corresponding file in the hosted_root
-    # => compress
-    #    whether to remove extraneous whitespace from
-    #    compilation output
     
     # Note: the following code is heavily influenced by:
     # => http://github.com/rtomayko/rack-cache/blob/master/lib/rack/cache/options.rb
@@ -35,8 +29,6 @@ module Rack::Less
           option_name(:source)    => 'app/stylesheets',
           option_name(:public)    => 'public',
           option_name(:hosted_at) => '/stylesheets',
-          option_name(:cache)     => false,
-          option_name(:compress)  => false
         }
       end
 
@@ -51,21 +43,6 @@ module Rack::Less
         end
       end
       
-      # Rack::Less uses combinations to combine the output of many stylesheets
-      # and serve them as a single resource.  Combinations are specified using
-      # a hash, where the key is the combined resource name and the value is an
-      # array of stylesheets to combine as that resource.  For example:
-      # Rack::Less.combinations = {
-      #   'app' => ['one', 'two']
-      # }
-      @@combinations = {}
-      def combinations
-        @@combinations || {}
-      end
-      def combinations=(value={})
-        @@combinations = value
-      end
-      
     end
     
     module InstanceMethods

data/lib/rack/less/request.rb

@@ -43,7 +43,7 @@ module Rack::Less
     # The Rack::Less::Source that the request is for
     def source
       @source ||= begin
-        cache = if options(:cache)
+        cache = if Rack::Less.config.cache?
           File.join(options(:root), options(:public), options(:hosted_at))
         else
           nil
@@ -51,7 +51,7 @@ module Rack::Less
         source_opts = {
           :folder   => File.join(options(:root), options(:source)),
           :cache    => cache,
-          :compress => options(:compress)
+          :compress => Rack::Less.config.compress?
         }
         Source.new(path_resource_name, source_opts)
       end

data/lib/rack/less/source.rb

@@ -1,4 +1,5 @@
 require 'less'
+require 'rack/less'
 
 module Rack::Less
 
@@ -27,6 +28,9 @@ module Rack::Less
     def cache?
       !@cache.nil?
     end
+    def cache
+      @cache
+    end
     
     # Use named css sources before using combination sources
     def files
@@ -61,9 +65,9 @@ module Rack::Less
     end
     
     # Preferred, existing source files matching a corresponding
-    # Rack::Less::Base combination directive, if any
+    # Rack::Less::Config combination directive, if any
     def combination_sources
-      @combination_sources ||= preferred_sources(Base.combinations[@css_name] || [])
+      @combination_sources ||= preferred_sources(Rack::Less.config.combinations[@css_name] || [])
     end
     
     private

data/lib/rack/less/version.rb

@@ -2,7 +2,7 @@ module RackLess
   module Version
     
     MAJOR = 1
-    MINOR = 0
+    MINOR = 1
     TINY  = 0
     
     def self.to_s # :nodoc:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-less
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-08 00:00:00 -06:00
+date: 2010-02-09 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/rack/less/base.rb
+- lib/rack/less/config.rb
 - lib/rack/less/options.rb
 - lib/rack/less/request.rb
 - lib/rack/less/response.rb