rack-asset-compiler 0.1.0 → 0.2.0

data/Readme.md

@@ -19,7 +19,7 @@ in and the compiled output is expected to be returned.
 
     require 'rack/asset_compiler'
 
-    use Rack::AssetCompiler(
+    use Rack::AssetCompiler,
       :source_dir => 'lowercase',
       :url => '/uppercase',
       :content_type => 'text/plain',
@@ -27,17 +27,17 @@ in and the compiled output is expected to be returned.
       :compiler => lambda { |source_file|
         File.read(source_file).upcase
       }
-    )
 
 ## Subclassing
 An alternative to passing in a lambda to the :compiler option is to subclass Rack::AssetCompiler and
 override the `compile` method.
 
-This gem comes with two subclasses: one for compiling CoffeeScript and one for Sass.
+This gem comes with three subclasses: one for compiling CoffeeScript one for Sass, and one for Compass.
 
 ## Compiling CoffeeScript
 
 config.ru
+
     require 'rack/coffee_compiler'
 
     use Rack::CoffeeCompiler,
@@ -46,6 +46,7 @@ config.ru
       :alert_on_error => true  # Generates a window.alert on compile error.  Defaults to (RACK_ENV != 'production')
 
 Gemfile
+
     gem 'therubyracer'
     gem 'coffee-script'
 
@@ -66,15 +67,57 @@ On Rails
     # Insert the new middleware
     Rails.application.config.middleware.use Rack::SassCompiler,
       :source_dir => 'app/sass',
-      :url => '/css',
-      :syntax => :scss # :sass or :scss, defaults to :scss
+      :url => '/css'
+
+The above uses the default options for the sass compiler, including the
+use of the scss syntax. To compile sass, or to change any of the other
+sass compiler options, provide the optional `sass_options` hash in the
+options hash. For example...
+
+    # Insert the new middleware
+    Rails.application.config.middleware.use Rack::SassCompiler,
+      :source_dir => 'app/sass',
+      :url => '/css'
+      :sass_options => {
+        :syntax => :sass,
+        :style => :compressed
+      }
+
+The above would use the the sass syntax compiler and output compressed
+CSS. See [Sass Documentation](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options)
+for a list of options.
+
+To make the Compass frameworks available to the SassCompiler, simply
+require Compass and any compass plugins. For example...
+
+    require 'compass'
+    require 'ninesixty' # 960.gs Compass plugin 
+
+    use Rack::SassCompiler,
+      :source_dir => 'sass'
+      :url => '/css'
+
+
+## Running without an HTTP cache
+If your stack doesn't include an HTTP cache (like Varnish), the compilation step will run each time a new visitor requests a compiled resource.
+
+An easy solution is to use [Rack::Cache][rack-cache]
+
+    require 'rack/asset_compiler'
+    require 'rack/cache'
+    use Rack::Cache # Make sure this comes first
+    use Rack::AssetCompiler, ...
+
+If you're running on Heroku, you get Varnish for free.  So you don't have to worry about this.
+
+If you're running locally, the user agent cache in your browser is sufficient.  So you also don't need to worry about this.
 
 ## Contribute
 
 Contributions must be accompanied by passing tests. To run the test suite for
  the gem you need the following gems installed:
 
-    [sudo] gem install rack rack-test haml coffee-script rspec
+    [sudo] gem install rack rack-test haml coffee-script rspec compass
 
 After installing the required gems and before beginning development,
 ensure your environment is properly configured and all tests pass by
@@ -82,7 +125,10 @@ running `rake`.
 
 ## Thanks
 asset-compiler was inspired by [rack-coffee] by [Matthew Lyon][mattly]
+
 ruby 1.9.2 compatibility added by [Derek Prior][derekprior]
 
 [rack-coffee]: https://github.com/mattly/rack-coffee
-[mattly]: https://github.com/mattly/rack-coffee
+[mattly]: https://github.com/mattly
+[derekprior]: https://github.com/derekprior
+[rack-cache]: http://rtomayko.github.com/rack-cache/

data/examples/jasmine_config.rb

@@ -35,8 +35,10 @@ module Jasmine
         run Jasmine.app(config)
       end
 
-      handler = Rack::Handler.default
-      handler.run app, :Port => port, :AccessLog => []
+      server = Rack::Server.new(:Port => port, :AccessLog => [])
+      # workaround for Rack bug, when Rack > 1.2.1 is released Rack::Server.start(:app => Jasmine.app(self)) will work
+      server.instance_variable_set(:@app, app)
+      server.start
     end
   end
 end

data/lib/rack/sass_compiler.rb

@@ -3,7 +3,7 @@ require 'sass'
 
 module Rack
   class SassCompiler < AssetCompiler
-    attr_accessor :syntax
+    attr_accessor :sass_options
 
     def initialize(app, options={})
       options
@@ -11,21 +11,33 @@ module Rack
       options = {
         :url => '/stylesheets',
         :content_type => 'text/css',
-        :syntax => :scss
       }.merge(options)
 
-      @syntax = options[:syntax]
-      options[:source_extension] ||= syntax.to_s
+      options[:sass_options] ||= {}
+      options[:sass_options] = {
+        :syntax => :scss,
+        :cache  => false
+      }.merge(options[:sass_options])
+
+      @sass_options = options[:sass_options]
+      options[:source_extension] ||= @sass_options[:syntax].to_s
       super
     end
 
+    def get_load_paths(src_dir)
+      paths = [src_dir]
+      if defined?(Compass::Frameworks)
+        Compass::Frameworks::ALL.each do |framework|
+          paths << framework.stylesheets_directory if ::File.exists?(framework.stylesheets_directory)
+        end
+      end
+      paths
+    end
+
     def compile(source_file)
-      sass_options = {
-        :syntax => syntax,
-        :cache => false,
-        :load_paths => [source_dir]
-      }
-      Sass::Engine.new(::File.read(source_file), sass_options).render
+      @sass_options[:load_paths] ||= []
+      @sass_options[:load_paths]   = @sass_options[:load_paths] | get_load_paths(source_dir)
+      Sass::Engine.new(::File.read(source_file), @sass_options).render
     end
   end
-end
+end

data/rack-asset-compiler.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rack-asset-compiler'
-  s.version = "0.1.0"
+  s.version = "0.2.0"
   s.author = 'Jonathan Baudanza'
   s.email = 'jon@jonb.org'
   s.summary = 'Rack Middleware to facilitate the generic compiling static assets.'

data/spec/fixtures/sass/compass.scss

@@ -0,0 +1,6 @@
+@import "compass/css3";
+
+#border-radius-test {
+  @include border-radius(25px); 
+}
+

data/spec/sass_compiler_spec.rb

@@ -1,6 +1,6 @@
 require 'rack/sass_compiler'
 require 'rack/lobster'
-require "rack/test"
+require 'rack/test'
 
 include Rack::Test::Methods
 
@@ -31,11 +31,19 @@ describe "SassCompiler" do
   end
 
   it "should compile sass" do
-    @options[:syntax] = :sass
+    @options[:sass_options] = {:syntax => :sass}
     get '/stylesheets/style.css'
     last_response.body.should ==
       Sass::Engine.new(File.read("#{@source_dir}/style.sass"), :syntax => :sass).render
     last_response.status.should == 200
     last_response.content_type.should == 'text/css'
   end
-end
+
+  it "should compile compass when library is loaded" do
+    require 'compass'
+    get '/stylesheets/compass.css'
+    last_response.status.should == 200
+    last_response.content_type.should == 'text/css'
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-asset-compiler
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jonathan Baudanza
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 -07:00
+date: 2011-04-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,7 @@ files:
 - spec/fixtures/coffeescripts/syntax_error.coffee
 - spec/fixtures/eggscripts/application.eggscript
 - spec/fixtures/eggscripts/subdir/application.eggscript
+- spec/fixtures/sass/compass.scss
 - spec/fixtures/sass/style.sass
 - spec/fixtures/sass/style.scss
 - spec/sass_compiler_spec.rb
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Rack Middleware to facilitate the generic compiling static assets.