snitko-cssdryer2 0.1.1 → 0.1.2

data/History.txt

@@ -0,0 +1,8 @@
+=== 0.1 / 2009-04-17
+
+* Initial version
+
+== 0.1.2
+
+* helper to include files in .ncss
+* critical fix in rake task template

data/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+USAGE.markdown
+generators/cssdryer2/cssdryer2_generator.rb
+generators/cssdryer2/templates/cssdryer2.rake
+lib/css_dryer_2.rb
+lib/css_dryer_2/files_handler.rb
+lib/css_dryer_2/ncss_handler.rb
+lib/css_dryer_2/processor.rb
+lib/css_dryer_2/stylesheets_helper.rb
+spec/example.ncss
+spec/lib/css_dryer_test.rb
+spec/lib/files_handler_spec.rb
+spec/lib/ncss_handler_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,95 @@
+== DESCRIPTION:
+
+This gem is based on Rails plugin 'css_dryer': http://github.com/airblade/css_dryer.
+Unlike 'css_dryer', this one doesn't create any controllers and views.
+Instead, it acts more like SASS, but uses css_dryer parser (which allows you to use completely
+conventional css-syntax and write one-line css rules).
+
+* Read 'install' section to find out how to use it with Rails or any other Ruby appplication.
+* Read USAGE.markdown file to learn about css_dryer parser (copypasted from css_dryer README).
+
+== REQUIREMENTS:
+
+* ActiveResource gem
+
+== INSTALL:
+
+The following steps assume you're using a Rails application.
+Adjust for using in other cases.
+
+1) 
+
+  sudo gem install cssdryer2
+    
+2) Put this is config/environments/development.rb:
+
+  require 'css_dryer_2'
+  
+3) Go to rails application folder and run: 
+
+  'script/generate cssdryer2'.
+
+This will generate neccessary rake tasks. Step 2 is mandatory before that. 
+
+4) In dev environment, to generate css on any changes in .ncss files, put this in ApplicationController:
+
+  before_filter :ncss
+  def ncss
+    CssDryer2::FilesHandler.new(:settings => :rails).run if RAILS_ENV == 'development'
+  end
+
+You can also set custom directories for files, instead of using rails shortcut option:
+
+  CssDryer2::FilesHandler.new(
+    :source_path  => 'my_css_dir/ncss',
+    :compile_path => 'my_css_dir',
+    :tmp_path     => '/tmp',
+    :force_compile => true
+  )
+
+
+5) While deploying Rails application to production, run rake task:
+
+  rake ncss:compile
+
+6) Now put your .ncss files in your 'public/stylesheets/ncss/' dir.
+The compiler will put generated css files in 'public/stylesheets/' dir.
+
+
+== HOW IT WORKS:
+
+When you fire 'run' method, CssDryer2::FileHandler object checks if the .ncss files
+changed (it stores their SHA1 in tmp dir). If they did, it recompiles them.
+
+For Rails application it assumes that you store your .ncss files in 'public/stylesheets/ncss',
+and it compiles .css files in 'public/stylesheets'.
+You might want to add 'public/stylesheets/*.css' into your '.gitignore' file 
+
+You can force reompile by providing the run method with':force_recompile => true' argument.
+You can also recompile at any time by running 'rake ncss:compile'
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'hoe'
+require File.dirname(__FILE__) + '/lib/css_dryer_2'
+
+def generate_gemspec(options = {})
+  files      = list_files.map     { |i| "\"#{i}\"" }
+  test_files = list_testfiles.map { |i| "\"#{i}\"" }
+  gemspec = File.read('gemspec.template')
+  gemspec.sub!('$files', "[#{files.join(', ')}]")
+  gemspec.sub!('$test_files', "[#{test_files.join(', ')}]")
+  return "Gem::Specification.new do |s|\n" + gemspec + "\nend" if options[:in_block]
+  gemspec
+end
+
+def list_files
+  files = FileList["{lib}/**/*", "{generators}/**/*", "README.txt", "Rakefile", "USAGE.markdown", "Manifest.txt", "History.txt"]
+end
+def list_testfiles
+  test_files = FileList["spec/**/*"]
+end
+ 
+spec = eval(generate_gemspec(:in_block => true))
+
+Hoe.new('cssdryer2', '0.1.2') do |s|
+  s.rubyforge_name = 'cssdryer2'
+  s.developer('Roman Snitko', 'roman@snitko.ru')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  File.open('cssdryer2.gemspec', 'w') { |f| f.puts generate_gemspec(:in_block => true) }
+end 
+
+task :generate_gemspec do
+  File.open('cssdryer2.gemspec', 'w') { |f| f.puts generate_gemspec(:in_block => true) }
+  `cd #{File.dirname(__FILE__)} && rake check_manifest | patch`
+end

data/USAGE.markdown

@@ -0,0 +1,190 @@
+This is a copypaste of README from http://github.com/airblade/css_dryer
+
+# CssDryer -- Eliminate Repetition In Your Stylesheets
+## Introduction
+
+Cascading style sheets (CSS) are wonderful but repetitive.  [Repetition is bad](http://en.wikipedia.org/wiki/Don't_repeat_yourself), so CssDryer lets you write CSS without repeating yourself.  And you don't need to learn any new syntax.
+
+There are two sources of repetition in CSS:
+
+* nested selectors
+* lack of variables
+
+Nested selectors lead to CSS like this:
+
+    div           { font-family: Verdana; }
+    div#content   { background-color: green; }
+    div#content p { color: red; }
+
+Note the triple repetition of `div` and the double repetition of `#content`.
+
+The lack of variables leads to CSS like this:
+
+    .sidebar { border: 1px solid #fefefe; }
+    .content { color: #fefefe; }
+
+Note the repeated colour `#fefefe`.
+
+CssDryer eliminates both of these.  The examples above become:
+
+    <% dark_grey = '#fefefe' %>
+
+    div {
+      font-family: Verdana;
+      #content {
+        background-color: green;
+        p { color: red; }
+      }
+    }
+
+    .sidebar { border: 1 px solid <%= dark_grey %>; }
+    .content { color: <%= dark_grey %>; }
+
+Note, though, that `@media` blocks are preserved.  For example:
+
+    @media screen, projection {
+      div {font-size:100%;}
+    }
+
+is left unchanged.
+
+The original whitespace is preserved as much as possible.
+
+
+## Which Selectors Are Supported?
+
+CssDryer handles all [CSS 2.1 selectors](http://www.w3.org/TR/CSS21/selector.html): nested descendant, child, adjacent, class, pseudo-class, attribute and id selectors.
+
+Multiple comma separated selectors are also supported.
+
+
+## Comments
+
+Comments on nested selectors do not get 'flattened' or de-nested with their selector.  For example comment B will be left inside the html selector below:
+
+Before:
+
+    /* Comment A */
+    html {
+      /* Comment B */
+      p {
+        color: blue;
+      }
+    }
+
+After:
+
+    /* Comment A */
+    html {
+      /* Comment B */
+    }
+    html p {
+      color: blue;
+    }
+
+This is suboptimal but I hope not too inconvenient.
+
+Please also note that commas in comments will sometimes be replaced with a space.  This is due to a shameful hack in the code that handles comma-separated selectors.
+
+
+## Partials
+
+You may use partial nested stylesheets as you would with normal templates.  For example, assuming your controller(s) set the @user variable and a User has a background colour (red):
+
+app/views/stylesheets/site.css.ncss:
+
+    body {
+      color: blue;
+      <%= render :partial => 'content', :locals => {:background => @user.background} %>
+    }
+
+app/views/stylesheets/_content.css.ncss:
+
+    div#content {
+      background: <%= background %>;
+      margin: 10px;
+    }
+
+And all this would render to `site.css`:
+
+    body {
+      color: blue;
+    }
+    body div#content {
+      background: red;
+      margin: 10px;
+    }
+
+
+## Remember the helper
+
+Browser hacks are an ugly necessity in any non-trivial stylesheet.  They clutter up your stylesheet without actually adding anything.  They make you sad.
+
+So encapsulate them in the StylesheetsHelper instead.  Separate your lovely CSS from the decidely unlovely hacks.  For example:
+
+app/views/stylesheets/site.css.ncss:
+
+    <% ie7 do %>
+      #sidebar {
+        padding: 4px;
+      }
+    <% end %>
+
+This renders to `site.css`:
+
+    *+html #sidebar {
+      padding: 4px;
+    }
+
+In this example the hacky selector, `*+html`, isn't too bad.  However some hacks are pretty long-winded, and soon you'll thank yourself for moving them out of your nested stylesheet.
+
+You don't have to limit yourself to browser hacks.  Consider self-clearing: to make an element clear itself requires 13 lines of CSS, in 3 selector blocks, by my count.  To make a second element clear itself, you need to add the element's selector to each of those three blocks.  It's fiddly.  And your stylesheet gets harder and harder to understand.
+
+We can do better:
+
+    <%= self_clear 'div.foo', 'div.bar', 'baz' %>
+
+Self-clear as many elements as you like in one easy line.
+
+## 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.
+
+* [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."
+
+* [Dirt Simple .rcss Templates][5] by Josh Susser.  No nesting, just variables.
+
+[1]: http://rubyforge.org/projects/rcss
+[2]: http://rubyforge.org/projects/dcss
+[3]: http://myles.id.au/2006/11/20/introducing-dcss/
+[4]: http://topfunky.net/svn/plugins/styleaby/README
+[5]: http://blog.hasmanythrough.com/2006/3/23/dirt-simple-rcss-templates
+
+
+## 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 caching code is based on [Topfunky's][7].
+
+Changing the controller's name to `stylesheets`, thus allowing one to use Rails' `stylesheet_link_tag` helper, occurred to me while reading Josh Susser's [Dirt Simple .rcss Templates][5].  Once I noticed it, I realised everybody was using a `StylesheetsController`.  Doh!
+
+[6]: http://railstips.org/2006/12/7/styleaby-css-plugin/
+[7]: http://topfunky.net/svn/plugins/styleaby/lib/stylesheets_controller.rb
+
+
+## Author
+
+[Andrew Stewart][8], [AirBlade Software Ltd][9].
+
+[8]: mailto:boss@airbladesoftware.com
+[9]: http://airbladesoftware.com
+
+
+## Licence
+
+CssDryer is available under the MIT licence.  See MIT-LICENCE for the details.
+
+Copyright (c) 2006-2008 Andrew Stewart

data/generators/{css_dryer/css_dryer_generator.rb → cssdryer2/cssdryer2_generator.rb}

@@ -1,6 +1,6 @@
 require 'rbconfig'
 
-class CssDryerGenerator < Rails::Generator::Base
+class Cssdryer2Generator < Rails::Generator::Base
 
   def initialize(runtime_args, runtime_options = {})
     Dir.mkdir('lib/tasks') unless File.directory?('lib/tasks')
@@ -9,7 +9,7 @@ class CssDryerGenerator < Rails::Generator::Base
   
   def manifest
     record do |m|
-      m.file "css_dryer_2.rake", "lib/tasks/css_dryer_2.rake"
+      m.file "cssdryer2.rake", "lib/tasks/cssdryer2.rake"
     end
   end
 

data/lib/css_dryer_2/stylesheets_helper.rb

@@ -49,6 +49,13 @@ module StylesheetsHelper
     END
   end
 
+  # This actually ain't cool. It simply allows to set variables in pure ruby code
+  # (no ERB for now). Ideally, we would want a method,
+  # that includes another erb-ed ncss files.
+  def include_file(filename)
+    eval File.read("#{RAILS_ROOT}/public/stylesheets/ncss/#{filename}")
+  end
+
 
   private
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: snitko-cssdryer2
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Roman Snitko
@@ -37,10 +37,15 @@ files:
 - lib/css_dryer_2/files_handler.rb
 - lib/css_dryer_2/stylesheets_helper.rb
 - lib/css_dryer_2/ncss_handler.rb
-- generators/css_dryer
-- generators/css_dryer/templates
-- generators/css_dryer/templates/css_dryer_2.rake
-- generators/css_dryer/css_dryer_generator.rb
+- generators/cssdryer2
+- generators/cssdryer2/cssdryer2_generator.rb
+- generators/cssdryer2/templates
+- generators/cssdryer2/templates/cssdryer2.rake
+- README.txt
+- Rakefile
+- USAGE.markdown
+- Manifest.txt
+- History.txt
 has_rdoc: false
 homepage: http://github.com/snitko/cssdryer2
 post_install_message: