stylus 0.6.2 → 0.7.0

data/.gitignore

@@ -4,4 +4,6 @@ node_modules
 gemfiles/*.lock
 Gemfile.lock
 pkg/*
-docs
+spec/support/generators/tmp/
+docs
+log/

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### HEAD
+
+### 0.7.0 (2013-01-27)
+[Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.6.2...v0.7.0)
+
+* `ImportProcessor` tracks `@import` definitions recursively.
+* `Tilt` shouldn't a hard dependency.
+
 ### 0.6.2 (2012-06-01)
 [Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.6.1...v0.6.2)
 

data/README.md

@@ -1,7 +1,6 @@
 # Ruby Stylus
 
 [![Build Status](https://secure.travis-ci.org/lucasmazza/ruby-stylus.png)](http://travis-ci.org/lucasmazza/ruby-stylus)
-[![Dependencies](https://gemnasium.com/lucasmazza/ruby-stylus.png?travis)](https://gemnasium.com/lucasmazza/ruby-stylus)
 
 `stylus` is a bridge between your Ruby code and the [Stylus](https://github.com/LearnBoost/stylus) library that runs on [node.js](http://nodejs.org). It has support for the Rails 3.1 asset pipeline (thanks to a [Tilt](https://github.com/rtomayko/tilt) Template) and it's backed by the [ExecJS](https://github.com/sstephenson/execjs) gem.
 
@@ -62,6 +61,36 @@ If you use Stylus `@import` to expose variables, mixins or just to concatenate c
 @import 'mixins'
 ```
 
+### `@import` dependency resolution
+
+Because of how sprockets handles dependency resolution for computing
+file changes and expiring caches, it is necessary to specify the full import path in your import statements.
+
+That is, given:
+
+    app/assets/stylesheets/
+    app/assets/stylesheets/file.styl
+    app/assets/stylesheets/some_directory/other_file.styl
+    app/assets/stylesheets/some_directory/another_file.styl
+
+Imports should be specified with the full path relative to
+`app/assets/stylesheets` regardless of where the file calling the import is. In this example we use the `app/assets` directory, but this also applies to `vendor/assets` and `lib/assets`.
+
+`app/assets/stylesheets/file.styl`
+
+    @import "some_directory/other_file.styl"
+    ...
+
+`app/assets/stylesheets/some_directory/other_file.styl`
+
+    @import "some_directory/another_file.styl"
+    ...
+
+This will ensure that all changes get reflected when any of the imported
+files change. If you don't do this, sprockets will not accurately be
+able to keep track of your dependencies.
+
+
 ### Standalone Sprockets usage
 
 If you're using Sprockets outside Rails, on Sinatra or on a plain Rack app, you can wire up Stylus inside a instance of `Sprockets::Environment` with the `Stylus.setup` method.
@@ -128,4 +157,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/stylus.rb

@@ -2,7 +2,6 @@ require 'stylus/runtime'
 require 'stylus/source'
 require 'stylus/sprockets'
 require 'stylus/version'
-require 'stylus/tilt' if defined?(::Tilt)
 require 'stylus/railtie' if defined?(::Rails)
 ## Stylus
 #
@@ -154,5 +153,5 @@ module Stylus
 
   # Exports the `.node_modules` folder on the working directory so npm can
   # require modules installed locally.
-  ENV['NODE_PATH'] = "#{File.expand_path('node_modules')}:#{bundled_path}:#{ENV['NODE_PATH']}"
+  ENV['NODE_PATH'] = "#{File.expand_path('node_modules')}:#{File.expand_path('vendor/node_modules')}:#{bundled_path}:#{ENV['NODE_PATH']}"
 end

data/lib/stylus/import_processor.rb

@@ -17,9 +17,22 @@ module Stylus
     def prepare
     end
 
-    # Internal: Scan the stylesheet body, looking for '@import' calls to
-    # declare them as dependency on the context using 'depend_on' method.
+    # Public: Scans the current stylesheet to track down Stylus
+    # '@import' calls as dependencies.
+    #
+    # Returns the stylesheet content, unmodified.
     def evaluate(context, locals, &block)
+      depend_on(context, data)
+      data
+    end
+
+    private
+
+    # Internal: Scan the stylesheet body, looking for '@import' calls to
+    # declare them as a dependency on the context using 'depend_on' method.
+    # This method will recursively scans all dependency to ensure that
+    # the current stylesheet tracks down nested dependencies.
+    def depend_on(context, data)
       dependencies = data.scan(IMPORT_SCANNER).flatten.compact.uniq
 
       dependencies.each do |path|
@@ -27,9 +40,9 @@ module Stylus
 
         if asset
           context.depend_on(asset)
+          depend_on(context, File.read(asset))
         end
       end
-      data
     end
 
     # Internal: Resolves the given 'path' with the Sprockets context, but
@@ -40,7 +53,11 @@ module Stylus
     def resolve(context, path)
       context.resolve(path, :content_type => 'text/css')
     rescue ::Sprockets::FileNotFound
-      nil
+      begin
+        context.resolve(path + '/index', :content_type => 'text/css')
+      rescue
+        nil
+      end
     end
   end
-end
+end

data/lib/stylus/sprockets.rb

@@ -1,5 +1,7 @@
-require 'stylus/tilt'
-require 'stylus/import_processor'
+if defined?(::Tilt)
+  require 'stylus/tilt'
+  require 'stylus/import_processor'
+end
 
 # Public: The setup logic to configure both Stylus and Sprockets on any
 # kind of application - Rails, Sinatra or Rack.

data/lib/stylus/version.rb

@@ -1,3 +1,3 @@
 module Stylus
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/spec/import_processor_spec.rb

@@ -1,24 +1,57 @@
 require 'spec_helper'
 
 describe Stylus::ImportProcessor do
+  let(:env) do
+    Sprockets::Environment.new do |assets|
+      assets.append_path fixture_root
+      Stylus.setup(assets)
+    end
+  end
+
   it 'adds an imported stylesheet as a dependency' do
-    source     = fixture(:import).first
-    template   = Stylus::ImportProcessor.new { source }
-    dependency = Pathname.new(fixture_path('mixins/vendor'))
-    sprockets  = double(:resolve => dependency)
+    asset = env['import']
+    dependencies = dependencies_on(asset)
+
+    dependencies.should include(fixture_path('mixins/vendor'))
+  end
+
+  context "nested dependencies" do
+    it 'walks the dependency chain of imported files' do
+      asset = env['nested_import']
+      dependencies = dependencies_on(asset)
+
+      dependencies.should include(fixture_path('mixins/nested'))
+      dependencies.should include(fixture_path('mixins/vendor'))
+    end
+
+    it "adds files referenced in a directory's index file" do
+      asset = env['indexed_nested_import']
+      dependencies = dependencies_on(asset)
+
+      dependencies.should include(fixture_path('indexed/index'))
+      dependencies.should include(fixture_path('indexed/first_dep'))
+      dependencies.should include(fixture_path('indexed/second_dep'))
+    end
+
+    it "walks dependency chains through indexes" do
+      asset = env['indexed_recursive_import']
+      dependencies = dependencies_on(asset)
 
-    sprockets.should_receive(:depend_on).with(dependency)
-    template.render(sprockets)
+      dependencies.should include(fixture_path('indexed_nested_import'))
+      dependencies.should include(fixture_path('indexed/index'))
+      dependencies.should include(fixture_path('indexed/first_dep'))
+      dependencies.should include(fixture_path('indexed/second_dep'))
+    end
   end
 
   it "swallows errors from files outside the Sprockets paths" do
     source = "@import 'nib'"
     template = Stylus::ImportProcessor.new { source }
     sprockets = double()
-    sprockets.should_receive(:resolve).and_raise(::Sprockets::FileNotFound)
+    sprockets.should_receive(:resolve).twice.and_raise(::Sprockets::FileNotFound)
 
     expect {
       template.render(sprockets)
     }.to_not raise_error(::Sprockets::FileNotFound)
   end
-end
+end

data/spec/stylesheets/indexed/first_dep.styl

@@ -0,0 +1,2 @@
+body
+  background-color: yellow

data/spec/stylesheets/indexed/index.styl

@@ -0,0 +1,2 @@
+@import "indexed/first_dep"
+@import "indexed/second_dep"

data/spec/stylesheets/indexed/second_dep.styl

@@ -0,0 +1,3 @@
+body
+  h1
+    font-size: 22em

data/spec/stylesheets/indexed_nested_import.styl

@@ -0,0 +1 @@
+@import 'indexed'

data/spec/stylesheets/indexed_recursive_import.styl

@@ -0,0 +1 @@
+@import 'indexed_nested_import'

data/spec/stylesheets/mixins/nested.styl

@@ -0,0 +1 @@
+@import 'mixins/vendor'

data/spec/stylesheets/nested_import.styl

@@ -0,0 +1 @@
+@import 'mixins/nested'

data/spec/support/helpers.rb

@@ -45,4 +45,10 @@ module Helpers
   def fixture_path(name)
     File.join(fixture_root, "#{name}.styl")
   end
+
+  def dependencies_on(asset)
+    context = env.context_class.new(env, asset.logical_path, asset.pathname)
+    context.evaluate(asset.pathname)
+    context._dependency_paths
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stylus
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-01 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -154,7 +154,14 @@ files:
 - spec/stylesheets/debug.styl
 - spec/stylesheets/implicit.styl
 - spec/stylesheets/import.styl
+- spec/stylesheets/indexed/first_dep.styl
+- spec/stylesheets/indexed/index.styl
+- spec/stylesheets/indexed/second_dep.styl
+- spec/stylesheets/indexed_nested_import.styl
+- spec/stylesheets/indexed_recursive_import.styl
+- spec/stylesheets/mixins/nested.styl
 - spec/stylesheets/mixins/vendor.styl
+- spec/stylesheets/nested_import.styl
 - spec/stylesheets/nib.styl
 - spec/stylesheets/plugin.styl
 - spec/stylesheets/simple.styl
@@ -213,7 +220,14 @@ test_files:
 - spec/stylesheets/debug.styl
 - spec/stylesheets/implicit.styl
 - spec/stylesheets/import.styl
+- spec/stylesheets/indexed/first_dep.styl
+- spec/stylesheets/indexed/index.styl
+- spec/stylesheets/indexed/second_dep.styl
+- spec/stylesheets/indexed_nested_import.styl
+- spec/stylesheets/indexed_recursive_import.styl
+- spec/stylesheets/mixins/nested.styl
 - spec/stylesheets/mixins/vendor.styl
+- spec/stylesheets/nested_import.styl
 - spec/stylesheets/nib.styl
 - spec/stylesheets/plugin.styl
 - spec/stylesheets/simple.styl