haml 2.2.24 → 3.0.0.beta.1

data/.yardopts

@@ -3,7 +3,6 @@
 --markup-provider maruku
 --default-return  ""
 --title           "Haml/Sass Documentation"
---query           'object.type != :classvariable'
 --hide-void-return
 --protected
 --no-private

data/README.md

@@ -21,7 +21,7 @@ After you convert some HTML to Haml or some CSS to Sass,
 you can run
 
     haml document.haml
-    sass style.sass
+    sass style.scss
 
 to compile them.
 For more information on these commands, check out
@@ -129,171 +129,110 @@ like `if` and `while`:
         = "Happy new " + "year!"
 
 Haml provides far more tools than those presented here.
-Check out the reference documentation in the Haml module.
+Check out the [reference documentation](http://beta.haml-lang.com/docs/yardoc/file.HAML_REFERENCE.md)
+for full details.
 
-### Sass
-
-At its most basic,
-Sass is just another way of writing CSS.
-Although it's very much like normal CSS,
-the basic syntax offers a few helpful features:
-indentation indicates the properties in a rule,
-rather than non-DRY brackets;
-and newlines indicate the end of a properties,
-rather than a semicolon.
-For example:
+#### Indentation
 
-    #main
-      background-color: #f00
-      width: 98%
+Haml's indentation can be made up of one or more tabs or spaces.
+However, indentation must be consistent within a given document.
+Hard tabs and spaces can't be mixed,
+and the same number of tabs or spaces must be used throughout.
 
-becomes:
+### Sass
 
-    #main {
-      background-color: #f00;
-      width: 98% }
-
-However, Sass provides much more than a way to make CSS look nice.
-In CSS, it's important to have accurate selectors,
-so your styles don't just apply to everything.
-However, in order to do this,
-you need to use nested element selectors.
-These get very ugly very quickly.
-I'm sure everyone's had to write something like
-"#main .sidebar .top p h1 a",
-followed by
-"#main .sidebar .top p h1 a:visited" and
-"#main .sidebar .top p h1 a:hover".
-Well, Sass gets rid of that.
-Like Haml, it uses indentation to indicate the structure of the document.
-So, what was:
-
-    #main {
-      width: 90%;
+Sass is an extension of CSS
+that adds power and elegance to the basic language.
+It allows you to use [variables][vars], [nested rules][nested],
+[mixins][mixins], [inline imports][imports],
+and more, all with a fully CSS-compatible syntax.
+Sass helps keep large stylesheets well-organized,
+and get small stylesheets up and running quickly,
+particularly with the help of
+[the Compass style library](http://compass-style.org).
+
+[vars]:    http://beta.sass-lang.com/docs/yardoc/file.SASS_REFERENCE.md#variables_
+[nested]:  http://beta.sass-lang.com/docs/yardoc/file.SASS_REFERENCE.md#nested_rules_
+[mixins]:  http://beta.sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#mixins
+[imports]: http://beta.sass-lang.com/docs/yardoc/file.SASS_REFERENCE.md#import
+
+Sass has two syntaxes.
+The one presented here, known as "SCSS" (for "Sassy CSS"),
+is fully CSS-compatible.
+The other (older) syntax, known as the indented syntax or just "Sass",
+is whitespace-sensitive and indentation-based.
+For more information, see the [reference documentation][syntax].
+
+[syntax]: http://beta.sass-lang.com/docs/yardoc/file.SASS_REFERENCE.md#syntax
+
+To run the following examples and see the CSS they produce,
+put them in a file called `test.scss` and run `sass test.scss`.
+
+#### Nesting
+
+Sass avoids repetition by nesting selectors within one another.
+The same thing works for properties.
+
+    table.hl {
+      margin: 2em 0;
+      td.ln { text-align: right; }
     }
-    #main p {
-      border-style: solid;
-      border-width: 1px;
-      border-color: #00f;
-    }
-    #main p a {
-      text-decoration: none;
-      font-weight: bold;
-    }
-    #main p a:hover {
-      text-decoration: underline;
-    }
-
-becomes:
-
-    #main
-      width: 90%
-      p
-        border-style: solid
-        border-width: 1px
-        border-color: #00f
-        a
-          text-decoration: none
-          font-weight: bold
-        a:hover
-          text-decoration: underline
-
-Pretty nice, no? Well, it gets better.
-One of the main complaints against CSS is that it doesn't allow variables.
-What if have a color or a width you re-use all the time?
-In CSS, you just have to re-type it each time,
-which is a nightmare when you decide to change it later.
-Not so for Sass!
-You can use the `!` character to set variables.
-Then, if you put `=` after your property name,
-you can set it to a variable.
-For example:
-
-    !note_bg= #55aaff
 
-    #main
-      width: 70%
-      .note
-        background-color = !note_bg
-      p
-        width: 5em
-        background-color = !note_bg
-
-becomes:
-
-    #main {
-      width: 70%; }
-      #main .note {
-        background-color: #55aaff; }
-      #main p {
-        width: 5em;
-        background-color: #55aaff; }
-
-You can even do simple arithmetic operations with variables,
-adding numbers and even colors together:
-
-    !main_bg= #46ar12
-    !main_width= 40em
-
-    #main
-      background-color = !main_bg
-      width = !main_width
-      .sidebar
-        background-color = !main_bg + #333333
-        width = !main_width - 25em
+    li {
+      font: {
+        family: serif;
+        weight: bold;
+        size: 1.2em;
+      }
+    }
 
-becomes:
+#### Variables
 
-    #main {
-      background-color: #46a312;
-      width: 40em; }
-      #main .sidebar {
-        background-color: #79d645;
-        width: 15em; }
+Use the same color all over the place?
+Need to do some math with height and width and text size?
+Sass supports variables, math operations, and many useful functions.
 
-Taking the idea of variables a bit further are mixins.
-These let you group whole bunches of CSS properties into a single
-directive and then include those anywhere you want:
+    $blue: #3bbfce;
+    $margin: 16px;
 
-    =blue-border
-      border:
-        color: blue
-        width: 2px
-        style: dotted
+    .content_navigation {
+      border-color: $blue;
+      color: darken($blue, 10%);
+    }
 
-    .comment
-      +blue-border
-      padding: 2px
-      margin: 10px 0
+    .border {
+      padding: $margin / 2;
+      margin: $margin / 2;
+      border-color: $blue;
+    }
 
-    .reply
-      +blue-border
+#### Mixins
 
-becomes:
+Even more powerful than variables,
+mixins allow you to re-use whole chunks of CSS,
+properties or selectors.
+You can even give them arguments. 
 
-    .comment {
-      border-color: blue;
-      border-width: 2px;
-      border-style: dotted;
-      padding: 2px;
-      margin: 10px 0;
+    @mixin table-scaffolding {
+      th {
+        text-align: center;
+        font-weight: bold;
+      }
+      td, th { padding: 2px; }
     }
 
-    .reply {
-      border-color: blue;
-      border-width: 2px;
-      border-style: dotted;
+    @mixin left($dist) {
+      float: left;
+      margin-left: $dist;
     }
 
-A comprehensive list of features is in
-the documentation for the Sass module.
-
-## Indentation
+    #data {
+      @include left(10px);
+      @include table-scaffolding;
+    }
 
-Indentation can be made up of one or more tabs or spaces.
-However, indentation must be consistent within a given document.
-Hard tabs and spaces can't be mixed,
-and the same number of tabs or spaces must be used throughout.
+A comprehensive list of features is available
+in the [Sass reference](http://beta.sass-lang.com/docs/yardoc/file.SASS_REFERENCE.md).
 
 ## Executables
 
@@ -318,11 +257,12 @@ Since HTML is so variable, this transformation is not always perfect;
 it's a good idea to have a human check the output of this tool.
 See `html2haml --help` for further information and options.
 
-### `css2sass`
+### `sass-convert`
 
-The `css2sass` executable attempts to transform CSS into Sass code.
-This transformation attempts to use Sass nesting where possible.
-See `css2sass --help` for further information and options.
+The `sass-convert` executable converts between CSS, Sass, and SCSS.
+When converting from CSS to Sass or SCSS,
+nesting is applied where appropriate.
+See `sass-convert --help` for further information and options.
 
 ## Authors
 

data/REMEMBER

@@ -1,2 +1,12 @@
+Deprecate .foo& in stable
+Make .#{} work in extend
+Test newly-invalid selectors, including post-resolution parse errors in Sass
 Be smart about default namespaces (http://www.w3.org/TR/css3-namespace/#declaration)
-Extending nested selectors?
+Don't conflict with Object#extend.
+
+http://camendesign.com/design/ provides some interesting formatting and nesting issues for sass-convert
+Charles Roper's example code for media queries doesn't fare well in css2sass either
+
+Handle unicode escapes (and other escapes?) gracefully in script idents with sass-convert
+Add period to SCSS syntax errors?
+Better #{} in prop names

data/Rakefile

@@ -1,6 +1,3 @@
-require 'rubygems'
-require 'rake'
-
 # ----- Utility Functions -----
 
 def scope(path)
@@ -66,13 +63,14 @@ task :revision_file do
   end
 end
 Rake::Task[:package].prerequisites.insert(0, :revision_file)
+Rake::Task[:package].prerequisites.insert(0, :submodules)
 
 # We also need to get rid of this file after packaging.
 at_exit { File.delete(scope('REVISION')) rescue nil }
 
 desc "Install Haml as a gem."
 task :install => [:package] do
-  sudo = RUBY_PLATFORM =~ /win32|mingw/ ? '' : 'sudo'
+  sudo = RUBY_PLATFORM =~ /win32/ ? '' : 'sudo'
   gem  = RUBY_PLATFORM =~ /java/  ? 'jgem' : 'gem' 
   sh %{#{sudo} #{gem} install --no-ri pkg/haml-#{File.read(scope('VERSION')).strip}}
 end
@@ -94,6 +92,7 @@ task :release_elpa do
   require 'time'
   require scope('lib/haml')
 
+  next if Haml.version[:prerelease]
   version = Haml.version[:number]
 
   haml_unchanged = mode_unchanged?(:haml, version)
@@ -171,6 +170,18 @@ def mode_unchanged?(mode, version)
   return false
 end
 
+task :submodules do
+  if File.exist?(File.dirname(__FILE__) + "/.git")
+    sh %{git submodule sync}
+    sh %{git submodule update --init}
+  elsif !File.exist?(File.dirname(__FILE__) + "/vendor/fssm/lib")
+    warn <<WARN
+WARNING: vendor/fssm doesn't exist, and this isn't a git repository so
+I can't get it automatically!
+WARN
+  end
+end
+
 task :release_edge do
   ensure_git_cleanup do
     puts "#{'=' * 50} Running rake release_edge"
@@ -205,8 +216,8 @@ task :release_edge do
     sh %{rake package}
     sh %{git checkout VERSION}
 
-    sh %{rubyforge login}
     sh %{rubyforge add_release haml haml-edge "Bleeding Edge (v#{edge_version})" pkg/haml-edge-#{edge_version}.gem}
+    sh %{gem push pkg/haml-edge-#{edge_version}.gem}
   end
 end
 
@@ -226,7 +237,7 @@ end
 begin
   require 'yard'
 
-  namespace :doc do
+  namespace :yard do
     task :sass do
       require scope('lib/sass')
       Dir[scope("yard/default/**/*.sass")].each do |sass|
@@ -235,27 +246,12 @@ begin
         end
       end
     end
-
-    desc "List all undocumented methods and classes."
-    task :undocumented do
-      opts = ENV["YARD_OPTS"] || ""
-      ENV["YARD_OPTS"] = opts.dup + <<OPTS
- --list --query "
-  object.docstring.blank? &&
-  !(object.type == :method && object.is_alias?)"
-OPTS
-      Rake::Task['yard'].execute
-    end
   end
 
   YARD::Rake::YardocTask.new do |t|
     t.files = FileList.new(scope('lib/**/*.rb')) do |list|
       list.exclude('lib/haml/template/*.rb')
-      list.exclude('lib/haml/railtie.rb')
       list.exclude('lib/haml/helpers/action_view_mods.rb')
-      list.exclude('lib/haml/helpers/xss_mods.rb')
-      list.exclude('lib/sass/plugin/merb.rb')
-      list.exclude('lib/sass/plugin/rails.rb')
     end.to_a
     t.options << '--incremental' if Rake.application.top_level_tasks.include?('redoc')
     t.options += FileList.new(scope('yard/*.rb')).to_a.map {|f| ['-e', f]}.flatten
@@ -263,15 +259,8 @@ OPTS
     t.options << '--files' << files.join(',')
     t.options << '--template-path' << scope('yard')
     t.options << '--title' << ENV["YARD_TITLE"] if ENV["YARD_TITLE"]
-
-    t.before = lambda do
-      if ENV["YARD_OPTS"]
-        require 'shellwords'
-        t.options.concat(Shellwords.shellwords(ENV["YARD_OPTS"]))
-      end
-    end
   end
-  Rake::Task['yard'].prerequisites.insert(0, 'doc:sass')
+  Rake::Task['yard'].prerequisites.insert(0, 'yard:sass')
   Rake::Task['yard'].instance_variable_set('@comment', nil)
 
   desc "Generate Documentation"
@@ -290,8 +279,18 @@ task :pages do
     sh %{git checkout #{proj}-pages}
     sh %{git reset --hard origin/#{proj}-pages}
 
-    sh %{rake build --trace}
-    sh %{rsync -av --delete site/ /var/www/#{proj}-pages}
+    Dir.chdir("/var/www/#{proj}-pages") do
+      sh %{git fetch origin}
+
+      sh %{git checkout stable}
+      sh %{git reset --hard origin/stable}
+
+      sh %{git checkout #{proj}-pages}
+      sh %{git reset --hard origin/#{proj}-pages}
+      sh %{rake build --trace}
+      sh %{mkdir -p tmp}
+      sh %{touch tmp/restart.txt}
+    end
   end
 end
 
@@ -386,8 +385,22 @@ end
 
 # ----- Handling Updates -----
 
-def ensure_git_cleanup
+def email_on_error
   yield
+rescue Exception => e
+  IO.popen("sendmail nex342@gmail.com", "w") do |sm|
+    sm << "From: nex3@nex-3.com\n" <<
+      "To: nex342@gmail.com\n" <<
+      "Subject: Exception when running rake #{Rake.application.top_level_tasks.join(', ')}\n" <<
+      e.message << "\n\n" <<
+      e.backtrace.join("\n")
+  end
+ensure
+  raise e if e
+end
+
+def ensure_git_cleanup
+  email_on_error {yield}
 ensure
   sh %{git reset --hard HEAD}
   sh %{git clean -xdf}
@@ -395,29 +408,34 @@ ensure
 end
 
 task :handle_update do
-  unless ENV["REF"] =~ %r{^refs/heads/(master|(?:haml|sass)-pages)$}
-    puts "#{'=' * 20} Ignoring rake handle_update REF=#{ENV["REF"].inspect}"
-    next
-  end
-  branch = $1
-
-  puts
-  puts
-  puts '=' * 150
-  puts "Running rake handle_update REF=#{ENV["REF"].inspect}"
+  email_on_error do
+    unless ENV["REF"] =~ %r{^refs/heads/(master|stable|(?:haml|sass)-pages)$}
+      puts "#{'=' * 20} Ignoring rake handle_update REF=#{ENV["REF"].inspect}"
+      next
+    end
+    branch = $1
+
+    puts
+    puts
+    puts '=' * 150
+    puts "Running rake handle_update REF=#{ENV["REF"].inspect}"
+
+    sh %{git fetch origin}
+    sh %{git checkout stable}
+    sh %{git reset --hard origin/stable}
+    sh %{git checkout master}
+    sh %{git reset --hard origin/master}
+
+    if branch == "master"
+      sh %{rake release_edge --trace}
+    elsif branch == "stable"
+      sh %{rake pages --trace PROJ=haml}
+      sh %{rake pages --trace PROJ=sass}
+    elsif branch =~ /^(haml|sass)-pages$/
+      sh %{rake pages --trace PROJ=#{$1}}
+    end
 
-  sh %{git checkout master}
-  sh %{git fetch origin}
-  sh %{git reset --hard origin/master}
-
-  if branch == "master"
-    sh %{rake release_edge --trace}
-    sh %{rake pages --trace PROJ=haml}
-    sh %{rake pages --trace PROJ=sass}
-  elsif branch =~ /^(haml|sass)-pages$/
-    sh %{rake pages --trace PROJ=#{$1}}
+    puts 'Done running handle_update'
+    puts '=' * 150
   end
-
-  puts 'Done running handle_update'
-  puts '=' * 150
 end