stylus 0.2.1.beta → 0.2.1

data/CHANGELOG.md

@@ -1,12 +1,14 @@
 ## Changelog
 
-### 0.2.1
-[Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.2.0...master)
+### 0.2.1 (2011-08-30)
+[Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.2.0...v0.2.1)
 
 * Removed a hack for a Sprockets loading order issue;
-* Testing on 1.9.2, REE and Rubinius thanks to [Travis CI](travis-ci.org/#!/lucasmazza/ruby-stylus).
+* Testing on 1.9.2, REE and Rubinius thanks to [Travis CI](travis-ci.org/#!/lucasmazza/ruby-stylus);
+* Enables compression if `Sprockets` is configured to do so;
+* Added Rails and Sprockets tests.
 
-### 0.2.0 (211-07-14)
+### 0.2.0 (2011-07-14)
 [Compare view](https://github.com/lucasmazza/ruby-stylus/compare/v0.1.2...v0.2.0)
 
 * Replaced `stylus:install` with proper generators for Rails 3.1 - now all hooks for the `stylesheet_engine` will generate `.styl` files.

data/README.md

@@ -2,11 +2,25 @@
 
 [![Build Status](https://secure.travis-ci.org/lucasmazza/ruby-stylus.png)](http://travis-ci.org/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. It's aims to be a replacement for the [stylus_rails](https://github.com/lucasmazza/stylus_rails) gem and to support the Rails 3.1 asset pipeline (via [Tilt](https://github.com/rtomayko/tilt)) and other scenarios, backed by the [ExecJS](https://github.com/sstephenson/execjs) gem.
+`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.
+
+## Installation
+
+Be sure to have [node.js](http://nodejs.org) available on your system, and [npm](npmjs.org) to install the [Stylus](https://github.com/LearnBoost/stylus) package (but you can also do a manual installation).
+
+### With npm
+
+You can make a local install (inside your application folder, so the package will be at `./node_modules`) or a global one (with the `-g` flag). With a global install you will need to make sure that the global installation folder is present at the `NODE_PATH` env variable. A global install will also enable the [Stylus](https://github.com/LearnBoost/stylus) command line interface.
+
+### Manual
+
+You can clone Stylus [git repository](http://github.com/learnboost/stylus) into `node_modules/stylus`. Any `node` commands and/or shells from the current directory will be able to find the cloned package.
+
+Check your installation with `node -e "require('stylus')"`. It should print something like [this](https://gist.github.com/1182631) and exit successfully.
 
 ## Usage
 
-First, be sure to have stylus installed in your system. If needed, check the project [README](https://github.com/learnboost/stylus) for more information.
+The interaction is done by the `Stylus` module. You can compile stylus syntax to CSS, convert it back, enable plugins and tweak some other options:
 
 ```ruby
 require 'stylus'
@@ -24,24 +38,39 @@ Stylus.compile(File.read('application.styl'))
 # Converting old and boring CSS to awesome Stylus.
 Stylus.convert(File.new('file.css'))
 
-# Importing plugins directly from Node.JS, like nib.
+# Importing plugins directly from Node.js, like nib.
 Stylus.use :nib
 ```
 ### With the Rails 3.1 Asset Pipeline.
 
-Just add the `stylus` gem to your Gemfile and the gem will hook itself into Sprockets and enable the `.styl` templates for your stylesheets. If you're including partial files inside your stylesheets, remember to use the `depend_on` directive on the top of your file so Sprockets can recompile it when the partial changes, as below.
+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.
+
+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.
 
-```sass
-//= depend_on 'mixins/vendor.styl'
-@import 'mixins/vendor'
+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.
 
-// Code goes here...
+## 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`:
+
+```ruby
+Stylus.use :fingerprint, :literal => 'caa8c262e23268d2a7062c6217202343b84f472b'
+```
+
+Will run something like this on javascript:
+
+```javascript
+stylus(file).use(fingerprint({literal:'caa8c262e23268d2a7062c6217202343b84f472b'}));
 ```
 
-If you just want to merge the generated css in another file, you can use only the `require` directive from Sprockets.
+## Question, Bugs or Support
+
+You can [submit an issue](https://github.com/lucasmazza/ruby-stylus/issues) or ping me at [GitHub](http://github.com/lucasmazza) or [twitter](http://twitter.com/lucasmazza).
+
+For more info about the [Stylus](https://github.com/LearnBoost/stylus) syntax and it's features you can check the [project repository](https://github.com/learnboost/stylus) and [GitHub page](learnboost.github.com/stylus).
 
 ## Changelog
-[here.](https://github.com/lucasmazza/ruby-stylus/blob/master/CHANGELOG.md)
+[It's available here.](https://github.com/lucasmazza/ruby-stylus/blob/master/CHANGELOG.md)
 
 ## License
 

data/lib/stylus/railtie.rb

@@ -15,6 +15,7 @@ module Stylus
     # 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.paths.concat app.assets.paths
     end
   end

data/lib/stylus/version.rb

@@ -1,3 +1,3 @@
 module Stylus
-  VERSION = "0.2.1.beta"
+  VERSION = "0.2.1"
 end

data/spec/spec_helper.rb

@@ -1,3 +1,14 @@
+require 'rails'
+require 'rails/test_help'
+require 'rails/generators/test_case'
+
+require 'active_support/railtie'
+require 'action_controller/railtie'
+require 'sprockets/railtie'
+require 'stylus/railtie'
+
+require 'active_support/core_ext/class/attribute_accessors'
+
 require 'support/helpers'
 require 'support/matchers'
 require 'support/generators/test_case'

data/spec/sprockets_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Sprockets and Rails integration' do
+
+  it 'copies the asset paths into the Stylus load path' do
+    app = create_app
+    Stylus.paths.should =~ app.assets.paths
+  end
+
+  it 'process .styl files with the asset pipeline' do
+    result = fixture(:simple).last
+
+    app = create_app
+    app.assets['simple'].to_s.should == result
+  end
+
+  it 'enables @import definitions' do
+    result = fixture(:import).last
+
+    app = create_app
+    app.assets['import'].to_s.should == result
+  end
+
+  it 'compress the output if Rails is configured to compress them too' do
+    result = fixture(:compressed).last
+
+    app = create_app(:compress => true)
+    app.assets['compressed'].to_s.should == result
+  end
+end

data/spec/support/generators/test_case.rb

@@ -2,12 +2,6 @@
 # But `RSpec::Rails::RailsExampleGroup` loads a truckload of things from rails and rspec-rails
 # That we don't need.
 
-ENV["RAILS_ENV"] = 'test'
-require 'rails'
-require 'rails/test_help'
-require 'rails/generators/test_case'
-require 'active_support/core_ext/class/attribute_accessors'
-
 module Generators
   module TestCase
     extend ActiveSupport::Concern

data/spec/support/helpers.rb

@@ -6,6 +6,17 @@ module Helpers
     FileUtils.touch File.join(destination, 'routes.rb')
   end
 
+  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
+      app.config.active_support.deprecation = :log
+      app.initialize!
+    end
+  end
+
   def fixture_root
     File.expand_path('../../fixtures', __FILE__)
   end

data/stylus.gemspec

@@ -14,9 +14,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'execjs'
   s.add_development_dependency 'rspec',       '~> 2.0'
-  s.add_development_dependency 'railties',    '~> 3.1.0.rc1'
-  s.add_development_dependency 'actionpack',  '~> 3.1.0.rc1'
-  s.add_development_dependency 'sprockets',   '~> 2.0.0.beta.10'
+  s.add_development_dependency 'railties',    '~> 3.1.0'
+  s.add_development_dependency 'tzinfo'
   s.add_development_dependency 'yajl-ruby'
   s.add_development_dependency 'rocco'
 

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: stylus
 version: !ruby/object:Gem::Version
-  version: 0.2.1.beta
-  prerelease: 6
+  version: 0.2.1
+  prerelease: 
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-22 00:00:00.000000000Z
+date: 2011-08-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
-  requirement: &2156715060 !ruby/object:Gem::Requirement
+  requirement: &2157713640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156715060
+  version_requirements: *2157713640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156714460 !ruby/object:Gem::Requirement
+  requirement: &2157713100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,43 +32,32 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2156714460
+  version_requirements: *2157713100
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &2156713820 !ruby/object:Gem::Requirement
+  requirement: &2157712580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0.rc1
+        version: 3.1.0
   type: :development
   prerelease: false
-  version_requirements: *2156713820
+  version_requirements: *2157712580
 - !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: &2156713220 !ruby/object:Gem::Requirement
+  name: tzinfo
+  requirement: &2157712200 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.1.0.rc1
-  type: :development
-  prerelease: false
-  version_requirements: *2156713220
-- !ruby/object:Gem::Dependency
-  name: sprockets
-  requirement: &2156712640 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta.10
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156712640
+  version_requirements: *2157712200
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2156712140 !ruby/object:Gem::Requirement
+  requirement: &2157711740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156712140
+  version_requirements: *2157711740
 - !ruby/object:Gem::Dependency
   name: rocco
-  requirement: &2156711520 !ruby/object:Gem::Requirement
+  requirement: &2157699620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156711520
+  version_requirements: *2157699620
 description: Bridge library to compile .styl stylesheets from ruby code.
 email:
 - luc4smazza@gmail.com
@@ -125,6 +114,7 @@ files:
 - spec/generators/controller_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
 - spec/spec_helper.rb
+- spec/sprockets_spec.rb
 - spec/stylus_spec.rb
 - spec/support/generators/test_case.rb
 - spec/support/helpers.rb
@@ -146,12 +136,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby Stylus Compiler
@@ -171,6 +161,7 @@ test_files:
 - spec/generators/controller_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
 - spec/spec_helper.rb
+- spec/sprockets_spec.rb
 - spec/stylus_spec.rb
 - spec/support/generators/test_case.rb
 - spec/support/helpers.rb