stylus_rails 0.0.3 → 0.1.0

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Changelog
 
+### 0.1.0 (2011-03-28)
+[Compare view](http://github.com/lucasmazza/stylus_rails/compare/v0.0.3...v0.1.0)
+
+* Sinatra plugin added. Check the docs for usage and configuration;
+* The rake task can be used standalone using `load 'stylus_rails/tasks/compile.rake'`;
+* Compress flag changed from `-C` to `-c` ([see it here](https://github.com/LearnBoost/stylus/commit/910246859718e1817c9a76683f9a892e4cad4965)). Be sure to have stylus 0.9.0 or higher installed.
+
 ### 0.0.3 (2011-03-13)
 [Compare view](http://github.com/lucasmazza/stylus_rails/compare/v0.0.2...v0.0.3)
 

data/README.md

@@ -1,15 +1,10 @@
 # Stylus for Rails apps
 
-A Rails helper to compile your [Stylus](https://github.com/LearnBoost/stylus) files located at `public/stylesheets/stylus/*.styl` between HTTP Requests during Rails development.
-
+A Rails helper to compile your [Stylus](https://github.com/LearnBoost/stylus) files in your Rails apps.
 
 ## Installation
 
-Just add `gem 'stylus_rails'` To your `Gemfile`.
-
-## Partials
-
-`stylus_rails` will skip all files starting with `_`, so you can use this naming convention on your partial files.
+Just add `gem 'stylus_rails'` To your `Gemfile`. Rails will load the Stylus Railtie on your app on the development environment.
 
 ## Folders
 
@@ -19,6 +14,58 @@ By default, `stylus_rails` will compile all files existing at `public/stylesheet
     Stylus.directory = 'stylus'
     Stylus.compile_directory = File.join(Rails.root, 'public', 'stylesheets')
 
+## Partials
+
+`stylus_rails` will skip all files starting with `_`, so you can use this naming convention on your partial files and import them on other files.
+
+So, let's say that you have the following `_vendor.styl`:
+
+    border-radius()
+      -webkit-border-radius arguments
+      -moz-border-radius arguments
+      border-radius arguments
+
+And a `application.styl`
+
+    @import '_mixins'
+    .button
+      border-radius 5px
+
+Stylus will compile your `application.styl` into a `application.css` and your `_vendor.styl` will be ignored.
+
+## Sinatra
+
+We all love [Sinatra](http://www.sinatrarb.com/), so we have a extension to add `stylus` to your Sinatra applications.
+When using classic applications, just requiring `stylus_rails` will load the extension inside the Sinatra stack. When goin' modular, you will need to register it yourself.
+
+    require 'sinatra'
+    require 'stylus_rails'
+
+    class MyApp < Sinatra::Base
+      register Stylus::Sinatra
+
+      get '/' do
+        'oh hai'
+      end
+    end
+
+You can also customize the `root` and `compile_directory` options using the Sinatra settings:
+
+    # storing your .styl files in ./styl ...
+    set :stylus_root, File.dirname(__FILE__)
+    # and compiling to ./public/stylesheets
+    set :stylus_directory, File.join(setting.public, 'stylesheets')
+
+
+## Rake task
+
+`stylus_rails` bundles a rake task `stylus:compile` to recompile your `.styl` files. Just add the following to your Rakefile:
+
+    require 'rubygems'
+    load 'stylus_rails/tasks/compile.rake'
+
+The task is included automatically the Railtile on Rails apps.
+
 ## Changelog
 [here.](https://github.com/lucasmazza/stylus_rails/blob/master/CHANGELOG.md)
 

data/lib/stylus_rails.rb

@@ -1,3 +1,5 @@
+require 'stylus_rails/core_ext/attribute_accessors'
 require 'stylus_rails/stylus'
 require 'stylus_rails/runner'
-require 'stylus_rails/railtie' if defined?(::Rails) && Rails.env.development?
+require 'stylus_rails/railtie' if defined?(::Rails) && Rails.env.development?
+require 'stylus_rails/sinatra' if defined?(::Sinatra) && ::Sinatra.send(:development?)

data/lib/stylus_rails/core_ext/attribute_accessors.rb

@@ -0,0 +1,18 @@
+# Similar implementation to the ActiveSupport core extension.
+# https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
+class Module
+
+  def mattr_accessor(sym)
+    class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+      @@#{sym} = nil unless defined? @@#{sym}
+
+      def self.#{sym}
+        @@#{sym}
+      end
+
+      def self.#{sym}=(obj)
+        @@#{sym} = obj
+      end
+    EOS
+  end
+end

data/lib/stylus_rails/railtie.rb

@@ -2,7 +2,7 @@ module Stylus
   class Railtie < ::Rails::Railtie
 
     rake_tasks do
-      load "stylus_rails/tasks/tasks.rake"
+      load "stylus_rails/tasks/compile.rake"
     end
 
     initializer "stylus.reloader" do
@@ -11,7 +11,7 @@ module Stylus
         if `which stylus` && $?.success?
           Stylus.compile
         else
-          Rails.logger.warn(Stylus.message)
+          Rails.logger.warn(Stylus.warning)
         end
       end
     end

data/lib/stylus_rails/runner.rb

@@ -11,25 +11,24 @@ module Stylus
 
       directories.each_pair do |directory, files|
         FileUtils.mkdir_p(directory) unless File.directory?(directory)
-        system("stylus #{files.join(" ")} -o #{directory}#{' -C' if Stylus.compress?}")
+        system("stylus #{files.join(" ")} -o #{directory}#{' -c' if Stylus.compress?}")
       end
     end
 
     private
-    def css_folder(path)
+    def output_folder(path)
+      dirname = File.dirname(path)
       if Stylus.compile_directory.nil?
-        dirname = File.dirname(File.dirname(path))
+        File.dirname(dirname)
       else
-        dirname = File.dirname(path)
-        dirname.gsub!(File.join(Stylus.root, Stylus.directory), Stylus.compile_directory)
+        dirname.gsub(Stylus.folder, Stylus.compile_directory)
       end
-      dirname
     end
 
     def group_paths
-      directories = Hash.new { |h, k| h[k] = [] }
+      directories = Hash.new { |hash, key| hash[key] = [] }
       paths.each do |path|
-        directories[css_folder(path)] << path
+        directories[output_folder(path)] << path
       end
       directories
     end

data/lib/stylus_rails/sinatra.rb

@@ -0,0 +1,17 @@
+module Stylus
+  module Sinatra
+
+    def self.registered(app)
+      app.set :stylus_root, Proc.new { public? && File.join(public, 'stylesheets') }
+      app.set :stylus_directory, nil
+
+      app.before do
+        Stylus.root = settings.stylus_root if settings.stylus_root?
+        Stylus.compile_directory = settings.stylus_directory if settings.stylus_directory?
+        Stylus.compile
+      end
+    end
+  end
+end
+
+::Sinatra.register(Stylus::Sinatra)

data/lib/stylus_rails/stylus.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/module/attribute_accessors'
-
 module Stylus
 
   # Directory to look for .stylus files
@@ -8,8 +6,8 @@ module Stylus
 
   # Root path for the stylus directory lookup.
   mattr_accessor :root
-  @@root = File.dirname(__FILE__)
-  
+  @@root = Dir.pwd
+
   # Root path for the output
   mattr_accessor :compile_directory
   @@compile_directory = nil
@@ -27,17 +25,17 @@ module Stylus
       paths = Dir[File.join(folder, "**", "*.#{extension}")]
       Stylus::Runner.new(paths).call
     end
-    def message
-      <<-warn
 
-  Warning: 'stylus' executable was not found on your system.
+    def warning
+      <<-WARN
+
+  Warning: The 'stylus' executable was not found on your system.
            Check stylus docs about installation at https://github.com/LearnBoost/stylus
            and be sure to have node.js and npm properly installed.
 
-      warn
+      WARN
     end
 
-    protected
     def folder
       File.join(root, directory)
     end

data/lib/stylus_rails/tasks/compile.rake

@@ -0,0 +1,9 @@
+namespace :stylus do
+  prereq = defined?(::Rails) ? :environment : []
+  path = File.join(Stylus.root, Stylus.directory).gsub(Dir.pwd, ".")
+
+  desc "Compiles all the .#{Stylus.extension} inside '#{path}' into css files."
+  task :compile => prereq do
+    Stylus.compile
+  end
+end

data/lib/stylus_rails/version.rb

@@ -1,3 +1,3 @@
 module Stylus
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/runner_spec.rb

@@ -17,13 +17,13 @@ describe Stylus::Runner do
       parser = Stylus::Runner.new(fixtures("stylus/simple.styl", "stylus/_border_radius.styl"))
       parser.paths.should == fixture("stylus/simple.styl")
     end
-    
+
     it "process nested files correctly" do
       parser = Stylus::Runner.new(fixtures("stylus/nested/bar.styl"))
       parser.paths.should == fixture("stylus/nested/bar.styl")
     end
   end
-  
+
   describe "#call" do
     subject { Stylus::Runner.new(fixture("stylus/simple.styl")) }
     let(:stylus_file) { fixture("stylus/simple.styl").first }
@@ -47,11 +47,11 @@ describe Stylus::Runner do
 
     it "uses the compress flag when configured to" do
       Stylus.compress = true
-      subject.should_receive(:system).with("stylus #{stylus_file} -o #{target_folder} -C")
+      subject.should_receive(:system).with("stylus #{stylus_file} -o #{target_folder} -c")
       subject.call
     end
   end
-  
+
   describe "#call with different compile_dir" do
     subject { Stylus::Runner.new(fixture("stylus/simple.styl")) }
     let(:stylus_file) { fixture("stylus/simple.styl").first }
@@ -78,7 +78,7 @@ describe Stylus::Runner do
 
     it "uses the compress flag when configured to" do
       Stylus.compress = true
-      subject.should_receive(:system).with("stylus #{stylus_file} -o #{target_folder} -C")
+      subject.should_receive(:system).with("stylus #{stylus_file} -o #{target_folder} -c")
       subject.call
     end
   end

data/stylus_rails.gemspec

@@ -12,8 +12,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{Stylus stylesheets for Rails apps}
   s.description = %q{Rails plugin to compile .styl files between requests}
 
-  s.add_dependency "activesupport", "~> 3.0"
-  s.add_development_dependency "rspec", "~> 2.4"
+  s.add_development_dependency "rspec", "~> 2.0"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stylus_rails
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
-  version: 0.0.3
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Lucas Mazza
@@ -10,31 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-13 00:00:00 -03:00
+date: 2011-03-28 00:00:00 -03:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "2.4"
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id001
 description: Rails plugin to compile .styl files between requests
 email: 
 - luc4smazza@gmail.com
@@ -52,10 +50,12 @@ files:
 - README.md
 - Rakefile
 - lib/stylus_rails.rb
+- lib/stylus_rails/core_ext/attribute_accessors.rb
 - lib/stylus_rails/railtie.rb
 - lib/stylus_rails/runner.rb
+- lib/stylus_rails/sinatra.rb
 - lib/stylus_rails/stylus.rb
-- lib/stylus_rails/tasks/tasks.rake
+- lib/stylus_rails/tasks/compile.rake
 - lib/stylus_rails/version.rb
 - spec/fixtures/foo.css
 - spec/fixtures/output/foo.css
@@ -84,17 +84,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Stylus stylesheets for Rails apps

data/lib/stylus_rails/tasks/tasks.rake

@@ -1,6 +0,0 @@
-namespace :stylus do
-  desc "Compiles all the .#{Stylus.extension} inside 'public/stylesheets/#{Stylus.directory}' into css files."
-  task :compile => :environment do
-    Stylus.compile
-  end
-end