stylus 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,7 +1,12 @@
 ## Changelog
 
+### 0.4.0 (2011-11-23)
+[Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.3.0...v.0.4.0)
+
+* `@import` directives will be added as dependencies to Sprockets (based on the work by @metaskills on the less-rails).
+
 ### 0.3.0 (2011-10-17)
-[Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.2.2...v.0.30)
+[Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.2.2...v.0.3.0)
 
 * This gem now uses the [stylus-source](https://github.com/railsjedi/ruby-stylus-source) gem to bundle the latest [NPM](http://search.npmjs.org/#/stylus) package of Stylus, so there's no setup required to install stylus via `npm install` or cloning it into the `node_modules` folder - Thanks @railsjedi.
 * Added a `debug` configuration option, that enables the `linenos` and `firebug` flags on Stylus. Inside Rails, this configuration option will be copied from the `config.assets.debug`;

data/README.md

@@ -42,14 +42,25 @@ Stylus.debug = true
 ```
 ### With the Rails 3.1 Asset Pipeline.
 
-Adding `stylus` to your Gemfile should let you work with `.styl` files with the Rails 3.1 Pipeline. Any asset generated with `rails generate` will be created with a `.css.styl` extension.
+First of all, remember to add `gem 'stylus'` to your Gemfile inside the `:assets` group, So Rails will require the gem according to your current environment - on production you should serve precompiled versions of your assets instead of compiling on the fly.
 
-While [Stylus](https://github.com/LearnBoost/stylus) has a `@import` directive, inside a Rails application you should use the `//= require` directive from Sprockets, so the caching mechanism will look after the changes made on the required file. If you're using mixins (for vendor prefixes or any common statements) or plugins inside your `.styl` files, you should use [Stylus](https://github.com/LearnBoost/stylus) `@import` **and** Sprockets `//= depend_on`. The latter is to ensure the proper dependency management on the Sprockets side.
+Adding `stylus` to your Gemfile should let you work with `.styl` files with the Rails 3.1 Pipeline. Any asset generated with `rails generate` will be created with a `.css.styl` extension.
 
-Any `.styl` file on the Sprockets load path (`app/assets`, `lib/assets`, `vendor/assets` or `assets` folder inside any other gem) will be available via the `@import` directive.
+Any `@import` directive will add the stylesheet as a sprockets dependency, so you can update external libraries and it will reflect on your assets fingerprints. Also, the Sprockets laod path (usually `app/assets`, `lib/assets`, `vendor/assets` and the `assets` folder inside any other gem) will be available to your stylesheets.
 
 If the `config.assets.debug` is turned on, Stylus will emit exta comments on your stylesheets to help debugging and inspection using the `linenos` and `firebug` options. Check the [FireStylus extension for Firebug](https://github.com/LearnBoost/stylus/blob/master/docs/firebug.md) for more info.
 
+### `@import` and file extensions.
+
+Stylus and Sprockets file lookup differ on the subject of handling file extensions, and that may hurt a bit.
+
+If you use Stylus `@import` to expose variables, mixins or just to concatenate code, you should use only the `.styl` extension on your imported files. If you use the `.css.styl` form (a convention from Sprockets), Stylus will treat it as a plain CSS file since it has `.css` on its name.
+
+```sass
+// imports the mixins.styl
+@import 'mixins'
+```
+
 ## Plugins
 
 [Stylus](https://github.com/LearnBoost/stylus) exposes a nice API to create plugins written on [node.js](http://nodejs.org), like [nib](https://github.com/visionmedia/nib). The installation process should be same as described above for [Stylus](https://github.com/LearnBoost/stylus) (since they're all npm packages after all). You can hook them'up on your Ruby code with `Stylus.use`:

data/lib/stylus.rb

@@ -41,11 +41,11 @@ module Stylus
     # Stores a list of stylesheets to import on every compile process.
     def import(*paths)
       if paths.any?
-      @@imports = @@imports.concat(paths)
-    end
+        @@imports = @@imports.concat(paths)
+      end
     @@imports
-  end
-  alias :imports :import
+    end
+    alias :imports :import
 
     # Retrieves all the registered plugins.
     def plugins

data/lib/stylus/import_processor.rb

@@ -0,0 +1,22 @@
+# Based on the ImportProcessor from the less-rails gem, by @metaskills
+module Stylus
+  class ImportProcessor < Tilt::Template
+
+    IMPORT_SCANNER = /@import\s*['"]([^'"]+)['"]\s*/.freeze
+
+    def prepare
+    end
+
+    def evaluate(context, locals, &block)
+      dependencies = data.scan(IMPORT_SCANNER).flatten.compact.uniq
+
+      dependencies.each do |path|
+        asset = context.environment[path]
+        if asset
+          context.depend_on_asset(asset.pathname)
+        end
+      end
+      data
+    end
+  end
+end

data/lib/stylus/railtie.rb

@@ -1,4 +1,6 @@
 require 'stylus/tilt'
+require 'stylus/import_processor'
+
 module Stylus
   ### Stylus Railtie
   #
@@ -7,8 +9,9 @@ module Stylus
 
     config.app_generators.stylesheet_engine :stylus
 
-    initializer :setup_stylus do |app|
+    initializer :setup_stylus, :after => 'sprockets.environment' do |app|
       app.assets.register_engine '.styl', Tilt::StylusTemplate
+      app.assets.register_preprocessor 'text/css', Stylus::ImportProcessor
     end
 
     # After initialization block to inspect the `Sprockets` configuration

data/lib/stylus/version.rb

@@ -1,3 +1,3 @@
 module Stylus
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/import_processor_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Stylus::ImportProcessor do
+
+  let(:app) { create_app }
+  let(:env) { app.assets }
+  let(:context) { double(:environment => env) }
+
+  it 'adds an imported stylesheet as a dependency' do
+    source = fixture(:import).first
+    asset = env['import']
+    template = Stylus::ImportProcessor.new { source }
+    dependency = Pathname.new(fixture_path('mixins/vendor'))
+
+    context.should_receive(:depend_on_asset).with(dependency)
+    template.render(context)
+  end
+
+end

data/spec/support/generators/test_case.rb

@@ -43,8 +43,8 @@ module Generators
     module InstanceMethods
 
       def file(relative)
-         File.expand_path(relative, destination_root)
-       end
+        File.expand_path(relative, destination_root)
+      end
 
       def method_missing(method_sym, *arguments, &block)
         self.test_case_instance.send(method_sym, *arguments, &block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stylus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000Z
+date: 2011-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
-  requirement: &70345063766460 !ruby/object:Gem::Requirement
+  requirement: &2156670840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70345063766460
+  version_requirements: *2156670840
 - !ruby/object:Gem::Dependency
   name: stylus-source
-  requirement: &70345063761640 !ruby/object:Gem::Requirement
+  requirement: &2156670400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70345063761640
+  version_requirements: *2156670400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70345063759280 !ruby/object:Gem::Requirement
+  requirement: &2156669900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70345063759280
+  version_requirements: *2156669900
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70345063757120 !ruby/object:Gem::Requirement
+  requirement: &2156669380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 3.1.0
   type: :development
   prerelease: false
-  version_requirements: *70345063757120
+  version_requirements: *2156669380
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &70345063756220 !ruby/object:Gem::Requirement
+  requirement: &2156668980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345063756220
+  version_requirements: *2156668980
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70345063754580 !ruby/object:Gem::Requirement
+  requirement: &2156668520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345063754580
+  version_requirements: *2156668520
 - !ruby/object:Gem::Dependency
   name: rocco
-  requirement: &70345063752320 !ruby/object:Gem::Requirement
+  requirement: &2156668100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345063752320
+  version_requirements: *2156668100
 description: Bridge library to compile .styl stylesheets from ruby code.
 email:
 - luc4smazza@gmail.com
@@ -107,6 +107,7 @@ files:
 - lib/rails/generators/stylus/scaffold/scaffold_generator.rb
 - lib/stylus.rb
 - lib/stylus/compiler.js
+- lib/stylus/import_processor.rb
 - lib/stylus/railtie.rb
 - lib/stylus/runner.js
 - lib/stylus/tilt.rb
@@ -130,6 +131,7 @@ files:
 - spec/generators/assets_generator_spec.rb
 - spec/generators/controller_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
+- spec/import_processor_spec.rb
 - spec/spec_helper.rb
 - spec/sprockets_spec.rb
 - spec/stylus_spec.rb
@@ -182,6 +184,7 @@ test_files:
 - spec/generators/assets_generator_spec.rb
 - spec/generators/controller_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
+- spec/import_processor_spec.rb
 - spec/spec_helper.rb
 - spec/sprockets_spec.rb
 - spec/stylus_spec.rb