stylus 0.2.2 → 0.3.0.pre

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Changelog
 
+### 0.3.0
+[Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.2.2...master)
+
+* 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`;
+* Added a global array `import` that handles other stylesheets to include on every compilation process;
+* Added a shorthand `Stylus.nib = true` to use the plugin and import it on every processed stylesheet.
+
 ### 0.2.2 (2011-09-14)
 [Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.2.1...v0.2.2)
 

data/README.md

@@ -40,6 +40,11 @@ Stylus.convert(File.new('file.css'))
 
 # Importing plugins directly from Node.js, like nib.
 Stylus.use :nib
+
+# Enabling debug info, which sends the 'linenos' and 'firebug' options to Stylus.
+# If you provide a raw content String to the `Stylus.compile` method, remember to send
+# a `:filename` option so Stylus can locate your stylesheet for proper inspection.
+Stylus.debug = true
 ```
 ### With the Rails 3.1 Asset Pipeline.
 
@@ -49,6 +54,8 @@ While [Stylus](https://github.com/LearnBoost/stylus) has a `@import` directive,
 
 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.
 
+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.
+
 ## 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

@@ -24,8 +24,10 @@ require 'stylus/railtie' if defined?(::Rails)
 module Stylus
   class << self
     @@compress = false
-    @@paths = []
-    @@plugins = {}
+    @@debug    = false
+    @@paths    = []
+    @@imports  = []
+    @@plugins  = {}
 
     # Stores a list of plugins to import inside `Stylus`, with an optional hash.
     def use(*options)
@@ -36,6 +38,15 @@ module Stylus
     end
     alias :plugin :use
 
+    # Stores a list of stylesheets to import on every compile process.
+    def import(*paths)
+      if paths.any?
+      @@imports = @@imports.concat(paths)
+    end
+    @@imports
+  end
+  alias :imports :import
+
     # Retrieves all the registered plugins.
     def plugins
       @@plugins
@@ -51,22 +62,48 @@ module Stylus
       @@paths = Array(val)
     end
 
+    # Returns the `debug` flag used to set the `linenos` and `firebug` option for Stylus.
+    def debug
+      @@debug
+    end
+    alias :debug? :debug
+
+    # Marks the `nib` plugin to be loaded and included on every stylesheet.
+    def nib=(flag)
+      if flag
+        use :nib
+        import :nib
+      end
+    end
+
+    # Sets the `debug` flag.
+    def debug=(val)
+      @@debug = val
+    end
+
     # Returns the global compress flag.
     def compress
       @@compress
     end
+    alias :compress? :compress
 
     # Sets the global flag for the `compress` option.
     def compress=(val)
       @@compress = val
     end
 
-    # Compiles a given input - a `File`, `StringIO`, `String` or anything that responds to `read`.
-    # Also accepts a hash of options that will be merged with the global configuration.
+    # Compiles a given input - a plain String, `File` or some sort of IO object that
+    # responds to `read`.
+    # It accepts a hash of options that will be merged with the global configuration.
+    # If the source has a `path`, it will be expanded and used as the :filename option
+    # So the debug options can be used.
     def compile(source, options = {})
-      source = source.read if source.respond_to?(:read)
+      if source.respond_to?(:path) && source.path
+        options[:filename] ||= File.expand_path(source.path)
+      end
+      source  = source.read if source.respond_to?(:read)
       options = merge_options(options)
-      context.call('compiler', source, options, plugins)
+      context.call('compiler', source, options, plugins, imports)
     end
 
     # Converts back an input of plain CSS to the `Stylus` syntax. The source object can be
@@ -79,15 +116,27 @@ module Stylus
     # Returns a `Hash` of the given `options` merged with the default configuration.
     # It also concats the global load path with a given `:paths` option.
     def merge_options(options)
-      _paths = options.delete(:paths)
+      filename = options[:filename]
+
+      _paths  = options.delete(:paths)
       options = defaults.merge(options)
       options[:paths] = paths.concat(Array(_paths))
+      if filename
+        options = options.merge(debug_options)
+      end
       options
     end
 
-    # Returns the default `Hash` of options.
+    # Returns the default `Hash` of options:
+    # the compress flag and the global load path.
     def defaults
-      { :compress => self.compress, :paths => self.paths }
+      { :compress => self.compress?, :paths => self.paths }
+    end
+
+    # Returns a Hash with the debug options to pass to
+    # Stylus.
+    def debug_options
+      { :linenos => self.debug?, :firebug => self.debug? }
     end
 
     # Return the gem version alongside with the current `Stylus` version of your system.

data/lib/stylus/compiler.js

@@ -1,6 +1,6 @@
 var stylus = require('stylus');
 
-function compiler(str, options, plugins) {
+function compiler(str, options, plugins, imports) {
   var style = stylus(str, options);
   var output = '';
 
@@ -8,6 +8,9 @@ function compiler(str, options, plugins) {
     var fn = require(name);
     style.use(fn(plugins[name]));
   }
+  imports.forEach(function(path) {
+    style.import(path);
+  })
 
   style.render(function(error, css) {
     if(error) throw error;

data/lib/stylus/railtie.rb

@@ -2,8 +2,7 @@ require 'stylus/tilt'
 module Stylus
   ### Stylus Railtie
   #
-  # `Railtie` responsible for injecting `stylus` inside the
-  # Rails application and the `Sprockets` Asset Pipeline.
+  # `Railtie` that hooks `stylus` inside a Rails application.
   class Railtie < ::Rails::Railtie
 
     config.app_generators.stylesheet_engine :stylus
@@ -12,10 +11,13 @@ module Stylus
       app.assets.register_engine '.styl', Tilt::StylusTemplate
     end
 
-    # Includes the `Rails` asset load path into `stylus` so any
-    # `.styl` file inside it can be imported by the `stylus` API.
+    # After initialization block to inspect the `Sprockets` configuration
+    # And reflect it on the `Stylus` module;
+    # It also includes the `Rails` asset load path into `Stylus` so any
+    # `.styl` file inside it can be imported by the `Stylus` API.
     config.after_initialize do |app|
       Stylus.compress = app.config.assets.compress
+      Stylus.debug = app.config.assets.debug
       Stylus.paths.concat app.assets.paths
     end
   end

data/lib/stylus/tilt.rb

@@ -1,9 +1,9 @@
 require 'tilt'
 
 module Tilt
-  ### Stylus template implementation for `Tilt`.
+  ### stylus template implementation for `Tilt`.
   #
-  # It can be used by the `Rails` Asset Pipeline or `Sinatra` applications.
+  # It can be used by the `Rails` 3.1 or `Sinatra` applications.
   class StylusTemplate < Template
     self.default_mime_type = 'text/css'
 
@@ -11,12 +11,18 @@ module Tilt
       defined? ::Stylus
     end
 
-    def prepare
+    def initialize_engine
       require_template_library 'stylus'
     end
 
+    def prepare
+      if self.file
+        options[:filename] ||= self.file
+      end
+    end
+
     def evaluate(scope, locals, &block)
-      Stylus.compile(data, options)
+      @output ||= Stylus.compile(data, options)
     end
   end
 end

data/lib/stylus/version.rb

@@ -1,3 +1,3 @@
 module Stylus
-  VERSION = "0.2.2"
+  VERSION = "0.3.0.pre"
 end

data/spec/cases/import.css

@@ -0,0 +1,5 @@
+a {
+  -moz-border-radius: 3px;
+  -webkit-border-radius: 3px;
+  border-radius: 3px;
+}

data/spec/cases/plugin.css

@@ -0,0 +1,5 @@
+background {
+  line-height: 1;
+  color: #000;
+  background: #fff;
+}

data/spec/fixtures/debug.styl

@@ -0,0 +1,2 @@
+body
+  color black

data/spec/fixtures/implicit.styl

@@ -0,0 +1,2 @@
+a
+  border-radius 3px

data/spec/fixtures/nib.styl

@@ -1,4 +1,2 @@
-@import 'nib'
-
 background
   reset-body()

data/spec/fixtures/plugin.styl

@@ -0,0 +1,4 @@
+@import 'nib'
+
+background
+  reset-body()

data/spec/spec_helper.rb

@@ -18,7 +18,9 @@ RSpec.configure do |config|
 
   config.after :each do
     Stylus.compress = false
+    Stylus.debug = false
     Stylus.paths = []
     Stylus.plugins.clear
+    Stylus.imports.clear
   end
 end

data/spec/sprockets_spec.rb

@@ -21,6 +21,18 @@ describe 'Sprockets and Rails integration' do
     app.assets['import'].to_s.should == result
   end
 
+  it 'skips debug info by default' do
+    app = create_app
+    asset = app.assets['simple']
+    asset.to_s.should_not match(/line 1 : #{asset.pathname}/)
+  end
+
+  it 'provides debug info if required' do
+    app = create_app(:debug => true)
+    asset = app.assets['simple']
+    asset.to_s.should match(/line 1 : #{asset.pathname}/)
+  end
+
   it 'compress the output if Rails is configured to compress them too' do
     result = fixture(:compressed).last
 

data/spec/stylus_spec.rb

@@ -37,6 +37,13 @@ describe Stylus do
     Stylus.compile(input).should == output
   end
 
+  it 'implicit imports the given paths' do
+    path = File.expand_path('mixins/vendor.styl', fixture_root)
+    input, output = fixture :implicit
+    Stylus.import path
+    Stylus.compile(input).should == output
+  end
+
   it "outputs both gem and library version" do
     Stylus.version.should =~ /Stylus - gem .+ library .+/
   end
@@ -53,7 +60,38 @@ describe Stylus do
 
   it "includes the given plugins" do
     Stylus.use :nib
+    input, output = fixture :plugin
+    Stylus.compile(input).should == output
+  end
+
+  it "includes and imports 'nib' automatically" do
+    Stylus.nib = true
     input, output = fixture :nib
     Stylus.compile(input).should == output
   end
+
+  describe "The debug flag" do
+
+    let(:path) { fixture_path(:debug) }
+    let(:fixture) { File.read(path) }
+    let(:file) { File.new(path) }
+
+    before { Stylus.debug = true }
+
+    it "turns the 'linenos' option on" do
+      Stylus.compile(file).should match(/line 1 : #{path}/)
+    end
+
+    it "skips the 'linenos' option if no filename is given" do
+      Stylus.compile(fixture).should_not match(/line 1 : #{path}/)
+    end
+
+    it "turns the 'firebug' option on" do
+      Stylus.compile(file).should match(/@media -stylus-debug-info/)
+    end
+
+    it "skips the 'firebug' option if no filename is given" do
+      Stylus.compile(fixture).should_not match(/@media -stylus-debug-info/)
+    end
+  end
 end

data/spec/support/helpers.rb

@@ -8,10 +8,14 @@ module Helpers
 
   def create_app(options = {})
     Rails.application = nil
+
     Class.new(Rails::Application).tap do |app|
-      app.config.assets.enabled = true
-      app.config.assets.compress = true if options[:compress]
-      app.config.assets.paths << fixture_root
+      assets = app.config.assets
+      assets.cache_store = :memory_store
+      assets.enabled  = true
+      assets.compress = true if options[:compress]
+      assets.debug    = true if options[:debug]
+      assets.paths << fixture_root
       app.config.active_support.deprecation = :log
       app.initialize!
     end
@@ -21,9 +25,23 @@ module Helpers
     File.expand_path('../../fixtures', __FILE__)
   end
 
+  def output_root
+    File.expand_path('../../cases', __FILE__)
+  end
+
   def fixture(name)
-    stylus = File.read(File.join(fixture_root, "#{name}.styl"))
-    css    = File.read(File.join(fixture_root, "#{name}.css"))
-    [stylus, css]
+    source = fixture_path(name)
+    output = css_path(name)
+    [source, output].map do |path|
+      File.read(path) if File.file?(path)
+    end
+  end
+
+  def css_path(name)
+    File.join(output_root, "#{name}.css")
+  end
+
+  def fixture_path(name)
+    File.join(fixture_root, "#{name}.styl")
   end
 end

metadata

@@ -1,119 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: stylus
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
+version: !ruby/object:Gem::Version
+  version: 0.3.0.pre
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-14 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: execjs
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153343380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2153343380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153342840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: railties
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2153342840
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &2153342300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 3
-        - 1
-        - 0
+      - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: tzinfo
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2153342300
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: &2153341920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: yajl-ruby
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2153341920
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &2153341440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rocco
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2153341440
+- !ruby/object:Gem::Dependency
+  name: rocco
+  requirement: &2153340900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *2153340900
 description: Bridge library to compile .styl stylesheets from ruby code.
-email: 
+email:
 - luc4smazza@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
@@ -130,16 +100,21 @@ files:
 - lib/stylus/runner.js
 - lib/stylus/tilt.rb
 - lib/stylus/version.rb
-- spec/fixtures/compressed.css
+- spec/cases/compressed.css
+- spec/cases/implicit.css
+- spec/cases/import.css
+- spec/cases/nib.css
+- spec/cases/plugin.css
+- spec/cases/simple.css
+- spec/cases/stylesheet.css
 - spec/fixtures/compressed.styl
-- spec/fixtures/import.css
+- spec/fixtures/debug.styl
+- spec/fixtures/implicit.styl
 - spec/fixtures/import.styl
 - spec/fixtures/mixins/vendor.styl
-- spec/fixtures/nib.css
 - spec/fixtures/nib.styl
-- spec/fixtures/simple.css
+- spec/fixtures/plugin.styl
 - spec/fixtures/simple.styl
-- spec/fixtures/stylesheet.css
 - spec/fixtures/stylesheet.styl
 - spec/generators/assets_generator_spec.rb
 - spec/generators/controller_generator_spec.rb
@@ -154,48 +129,44 @@ files:
 - stylus.gemspec
 homepage: https://github.com/lucasmazza/ruby-stylus
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby Stylus Compiler
-test_files: 
-- spec/fixtures/compressed.css
+test_files:
+- spec/cases/compressed.css
+- spec/cases/implicit.css
+- spec/cases/import.css
+- spec/cases/nib.css
+- spec/cases/plugin.css
+- spec/cases/simple.css
+- spec/cases/stylesheet.css
 - spec/fixtures/compressed.styl
-- spec/fixtures/import.css
+- spec/fixtures/debug.styl
+- spec/fixtures/implicit.styl
 - spec/fixtures/import.styl
 - spec/fixtures/mixins/vendor.styl
-- spec/fixtures/nib.css
 - spec/fixtures/nib.styl
-- spec/fixtures/simple.css
+- spec/fixtures/plugin.styl
 - spec/fixtures/simple.styl
-- spec/fixtures/stylesheet.css
 - spec/fixtures/stylesheet.styl
 - spec/generators/assets_generator_spec.rb
 - spec/generators/controller_generator_spec.rb