generators/css_dryer/USAGE generators/css_dryer/css_dryer_generator.rb generators/css_dryer/templates/stylesheets_controller.rb generators/css_dryer/templates/stylesheets_helper.rb generators/css_dryer/templates/test.ncss @@ -2,6 +2,10 @@ Below is a complete list of changes for each revision of CssDryer. +== 0.2.5 + +* Added a generator for convenience. + == 0.2.4 * Fixed README to use proper Markdown syntax for links. CHANGELOG @@ -121,40 +121,37 @@ And all this would render to site.css: ## Installation -Version 0.2+ of the plugin requires Rails 2. +Pre-requisite: Rails 2. -Install in the usual Rails way. From your application's directory: +First, install in the usual Rails way. From your application's directory: - script/plugin install http://opensource.airbladesoftware.com/trunk/plugins/css_dryer + $ script/plugin install http://opensource.airbladesoftware.com/trunk/plugins/css_dryer - -## Usage +Second, generate the stylesheets controller and helper, and a test nested stylesheet: -Create a controller to serve your DRY stylesheets: + $ script/generate css_dryer - script/generate controller stylesheets +Third, add a named route to your config/routes.rb: -You don't have to call it <code>stylesheets</code> but doing so lets you use Rails' <code>stylesheet_link_tag</code> helper. + map.stylesheets 'stylesheets/:action.:format', :controller => 'stylesheets' -Edit the controller so it looks like this: +Verify that everything is working by visiting this URL: - class StylesheetsController < ApplicationController - before_filter :set_headers - after_filter { |c| c.cache_page } - session :off - layout nil + http://0.0.0.0:3000/stylesheets/test.css - private - def set_headers - headers['Content-Type'] = 'text/css; charset=utf-8' - end - end +You should see this output: -Add this line to your routes in <code>config/routes.rb</code> (note the full stop immediately after the word <code>action</code>): + body { + color: blue; + } + body p { + color: red; + } + - map.connect 'stylesheets/:action.:format', :controller => 'stylesheets' +## Usage -You can then put your stylesheets, DRY or otherwise, in <code>app/views/stylesheets/</code>. Once rendered they will be cached in <code>public/stylesheets/</code>. +You put your stylesheets, DRY or otherwise, in <code>app/views/stylesheets/</code>. Once rendered they will be cached in <code>public/stylesheets/</code>. DRY stylesheet files should have a <code>ncss</code> extension -- think 'n' for nested. For example, <code>site.ncss</code>. @@ -170,22 +167,21 @@ or with Rails' <code>stylesheet_link_tag</code> helper: ## To Do * Package as a gem as well as a plugin. -* Merb compatability. -* Generator for stylesheets controller. +* Merb compatibility. * Split out a separate EXAMPLES document. * Replace regexp-based nested-stylesheet parser with a Treetop parser. -* Make CssDryer work with Rails's asset packaging. +* Make CssDryer work with Rails' asset packaging. ## Alternatives -* [RCSS] [1]: ERB, server-side constants, server-side classes and command line execution. No nesting as such, though server-side classes offer a form of inheritance. +* [RCSS][1]: ERB, server-side constants, server-side classes and command line execution. No nesting as such, though server-side classes offer a form of inheritance. -* [DCSS] [2] (written up [here] [3]): server-side constants, different syntax. Descendant selectors only. +* [DCSS][2] (written up [here][3]): server-side constants, different syntax. Descendant selectors only. -* [Styleaby] [4] creates CSS with Ruby syntax. "An experimental, unauthorized mashup of Scott Barron's stillborn Builder::CSS templates and Why The Lucky Stiff's Markaby templates." +* [Styleaby][4] creates CSS with Ruby syntax. "An experimental, unauthorized mashup of Scott Barron's stillborn Builder::CSS templates and Why The Lucky Stiff's Markaby templates." -* [Dirt Simple .rcss Templates] [5] by Josh Susser. No nesting, just variables. +* [Dirt Simple .rcss Templates][5] by Josh Susser. No nesting, just variables. [1]: http://rubyforge.org/projects/rcss [2]: http://rubyforge.org/projects/dcss @@ -196,11 +192,11 @@ or with Rails' <code>stylesheet_link_tag</code> helper: ## Credits -The idea came from John Nunemaker on [Rails Tips] [6]. John beta-tested the code, provided a test case for @media blocks and suggested the controller's body. Thanks John! +The idea came from John Nunemaker on [Rails Tips][6]. John beta-tested the code, provided a test case for @media blocks and suggested the controller's body. Thanks John! -The caching code is based on [Topfunky's] [7]. +The caching code is based on [Topfunky's][7]. -Changing the controller's name to <code>stylesheets</code>, thus allowing one to use Rails' <code>stylesheet_link_tag</code> helper, occurred to me while reading Josh Susser's [Dirt Simple .rcss Templates] [5]. Once I noticed it, I realised everybody was using a <code>StylesheetsController</code>. Doh! +Changing the controller's name to <code>stylesheets</code>, thus allowing one to use Rails' <code>stylesheet_link_tag</code> helper, occurred to me while reading Josh Susser's [Dirt Simple .rcss Templates][5]. Once I noticed it, I realised everybody was using a <code>StylesheetsController</code>. Doh! [6]: http://railstips.org/2006/12/7/styleaby-css-plugin/ [7]: http://topfunky.net/svn/plugins/styleaby/lib/stylesheets_controller.rb @@ -208,7 +204,7 @@ Changing the controller's name to <code>stylesheets</code>, thus allowing one to ## Author -[Andrew Stewart] [8], [AirBlade Software] [9]. +[Andrew Stewart][8], [AirBlade Software][9]. [8]: mailto:boss@airbladesoftware.com [9]: http://airbladesoftware.com README @@ -17,6 +17,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_dir = 'rdoc' rdoc.title = 'CssDryer' rdoc.options << '--line-numbers' << '--inline-source' - rdoc.rdoc_files.include('README', 'MIT-LICENCE', 'CHANGELOG') + rdoc.rdoc_files.include('README') rdoc.rdoc_files.include('lib/**/*.rb') end Rakefile @@ -17,7 +17,7 @@ end # Converts DRY stylesheets into normal CSS ones. module CssDryer - VERSION = '0.2.4' + VERSION = '0.2.5' class StyleHash < Hash #:nodoc: attr_accessor :multiline lib/css_dryer.rb 803c5ad14ea1daac338e070b630ff375fa7ddb8e Andy Stewart boss@airbladesoftware.com http://github.com/airblade/css_dryer/commit/d8b6825ab7e29cf3814cc6bc8d2027f7531ef44b d8b6825ab7e29cf3814cc6bc8d2027f7531ef44b 2008-03-20T11:24:57-07:00 2008-03-20T11:24:57-07:00 Added a generator. 9c66662bc01ef1d619c3dd77739c0dad537d1c33 Andy Stewart boss@airbladesoftware.com