Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

file 377 lines (316 sloc) 11.223 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
require 'rubygems'
require 'rake'

# ----- Benchmarking -----

desc <<END
Benchmark haml against ERb.
TIMES=n sets the number of runs. Defaults to 1000.
END
task :benchmark do
  sh "ruby test/benchmark.rb #{ENV['TIMES']}"
end

# ----- Default: Testing ------

if ENV["RUN_CODE_RUN"] == "true"
  task :default => :"test:rails_compatibility"
else
  task :default => :test
end

require 'rake/testtask'

Rake::TestTask.new do |t|
  t.libs << 'lib'
  test_files = FileList['test/**/*_test.rb']
  test_files.exclude('test/rails/*')
  test_files.exclude('test/haml/spec/*')
  t.test_files = test_files
  t.verbose = true
end
Rake::Task[:test].send(:add_comment, <<END)
To run with an alternate version of Rails, make test/rails a symlink to that version.
END

# ----- Packaging -----

require 'rake/gempackagetask'
load 'haml.gemspec'

Rake::GemPackageTask.new(HAML_GEMSPEC) do |pkg|
  if Rake.application.top_level_tasks.include?('release')
    pkg.need_tar_gz = true
    pkg.need_tar_bz2 = true
    pkg.need_zip = true
  end
end

task :revision_file do
  require 'lib/haml'

  release = Rake.application.top_level_tasks.include?('release') || File.exist?('EDGE_GEM_VERSION')
  if Haml.version[:rev] && !release
    File.open('REVISION', 'w') { |f| f.puts Haml.version[:rev] }
  elsif release
    File.open('REVISION', 'w') { |f| f.puts "(release)" }
  else
    File.open('REVISION', 'w') { |f| f.puts "(unknown)" }
  end
end
Rake::Task[:package].prerequisites.insert(0, :revision_file)

# We also need to get rid of this file after packaging.
at_exit { File.delete('REVISION') rescue nil }

desc "Install Haml as a gem."
task :install => [:package] do
  sudo = RUBY_PLATFORM =~ /win32/ ? '' : 'sudo'
  gem = RUBY_PLATFORM =~ /java/ ? 'jgem' : 'gem'
  sh %{#{sudo} #{gem} install --no-ri pkg/haml-#{File.read('VERSION').strip}}
end

desc "Release a new Haml package to Rubyforge."
task :release => [:check_release, :release_elpa, :package] do
  name = File.read("VERSION_NAME").strip
  version = File.read("VERSION").strip
  sh %{rubyforge login}
  sh %{rubyforge add_release haml haml "#{name} (v#{version})" pkg/haml-#{version}.gem}
  sh %{rubyforge add_file haml haml "#{name} (v#{version})" pkg/haml-#{version}.tar.gz}
  sh %{rubyforge add_file haml haml "#{name} (v#{version})" pkg/haml-#{version}.tar.bz2}
  sh %{rubyforge add_file haml haml "#{name} (v#{version})" pkg/haml-#{version}.zip}
end

# Releases haml-mode.el and sass-mode.el to ELPA.
task :release_elpa do
  require 'tlsmail'
  require 'time'

  version = File.read("VERSION").strip

  haml_unchanged = mode_unchanged?(:haml, version)
  sass_unchanged = mode_unchanged?(:sass, version)
  next if haml_unchanged && sass_unchanged
  raise "haml-mode.el and sass-mode.el are out of sync." if haml_unchanged ^ sass_unchanged

  if sass_unchanged && File.read("extra/sass-mode.el").
      include?(";; Package-Requires: ((haml-mode #{sass_unchanged.inspect}))")
    raise "sass-mode.el doesn't require the same version of haml-mode."
  end

  rev = File.read('.git/HEAD').strip
  if rev =~ /^ref: (.*)$/
    rev = File.read(".git/#{$1}").strip
  end

  from = `git config user.email`.strip
  raise "Don't know how to send emails except via Gmail" unless from =~ /@gmail.com$/

  to = "elpa@tromey.com"
  Net::SMTP.enable_tls(OpenSSL::SSL::VERIFY_NONE)
  Net::SMTP.start('smtp.gmail.com', 587, 'gmail.com', from, read_password("GMail Password"), :login) do |smtp|
    smtp.send_message(<<CONTENT, from, to)
From: Nathan Weizenbaum <#{from}>
To: #{to}
Subject: Submitting haml-mode and sass-mode #{version}
Date: #{Time.now.rfc2822}

haml-mode and sass-mode #{version} are packaged and ready to be included in ELPA.
They can be downloaded from:

http://github.com/nex3/haml/raw/#{rev}/extra/haml-mode.el
http://github.com/nex3/haml/raw/#{rev}/extra/sass-mode.el
CONTENT
  end
end

# Ensures that the version have been updated for a new release.
task :check_release do
  version = File.read("VERSION").strip
  raise "There have been changes since current version (#{version})" if changed_since?(version)
  raise "VERSION_NAME must not be 'Bleeding Edge'" if File.read("VERSION_NAME") == "Bleeding Edge"
end

# Reads a password from the command line.
#
# @param name [String] The prompt to use to read the password
def read_password(prompt)
  require 'readline'
  system "stty -echo"
  Readline.readline("#{prompt}: ").strip
ensure
  system "stty echo"
  puts
end

# Returns whether or not the repository, or specific files,
# has/have changed since a given revision.
#
# @param rev [String] The revision to check against
# @param files [Array<String>] The files to check.
# If this is empty, checks the entire repository
def changed_since?(rev, *files)
  IO.popen("git diff --exit-code #{rev} #{files.join(' ')}") {}
  return !$?.success?
end

# Returns whether or not the given Emacs mode file (haml or sass)
# has changed since the given version.
#
# @param mode [String, Symbol] The name of the mode
# @param version [String] The version number
# @return [String, nil] The version number if the version has changed
def mode_unchanged?(mode, version)
  mode_version = File.read("extra/#{mode}-mode.el").scan(/^;; Version: (.*)$/).first.first
  return false if mode_version == version
  return mode_version unless changed_since?(mode_version, "extra/#{mode}-mode.el")
  raise "#{mode}-mode.el version is #{version.inspect}, but it has changed as of #{version.inspect}"
  return false
end

task :release_edge do
  ensure_git_cleanup do
    puts "#{'=' * 50} Running rake release_edge"

    sh %{git checkout edge-gem}
    sh %{git reset --hard origin/edge-gem}
    sh %{git merge origin/master}

    # Get the current master branch version
    version = File.read('VERSION').strip.split('.').map {|n| n.to_i}
    unless version[1] % 2 == 1 && version[2] == 0
      raise "#{version.join('.')} is not a development version"
    end

    # Bump the edge gem version
    edge_version = File.read('EDGE_GEM_VERSION').strip.split('.').map {|n| n.to_i}
    if edge_version[0..1] != version[0..1]
      # A new master branch version was released, reset the edge gem version
      edge_version[0..1] = version[0..1]
      edge_version[2] = 0
    else
      # Just bump the teeny version
      edge_version[2] += 1
    end
    edge_version = edge_version.join('.')
    File.open('EDGE_GEM_VERSION', 'w') {|f| f.puts(edge_version)}
    sh %{git commit -m "Bump edge gem version to #{edge_version}." EDGE_GEM_VERSION}
    sh %{git push origin edge-gem}

    # Package the edge gem with the proper version
    File.open('VERSION', 'w') {|f| f.puts(edge_version)}
    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}
  end
end

task :watch_for_update do
  sh %{ruby extra/update_watch.rb}
end

# ----- Documentation -----

task :rdoc do
  puts '=' * 100, <<END, '=' * 100
Haml uses the YARD documentation system (http://github.com/lsegal/yard).
Install the yard gem and then run "rake doc".
END
end

begin
  require 'yard'

  YARD::Rake::YardocTask.new do |t|
    t.files = FileList.new('lib/**/*.rb') do |list|
      list.exclude('lib/haml/template/*.rb')
      list.exclude('lib/haml/helpers/action_view_mods.rb')
    end.to_a
    t.options << '--use-cache' if Rake.application.top_level_tasks.include?('redoc')
    t.options += FileList.new('yard/*.rb').to_a.map {|f| ['-e', f]}.flatten
    files = FileList.new('doc-src/*').to_a.sort_by {|s| s.size} + %w[MIT-LICENSE VERSION]
    t.options << '--files' << files.join(',')
  end
  Rake::Task['yardoc'].instance_variable_set('@comment', nil)

  desc "Generate Documentation"
  task :doc => :yardoc
  task :redoc => :yardoc
rescue LoadError
  desc "Generate Documentation"
  task :doc => :rdoc
  task :yardoc => :rdoc
end

task :pages do
  ensure_git_cleanup do
    puts "#{'=' * 50} Running rake pages PROJ=#{ENV["PROJ"].inspect}"
    raise 'No ENV["PROJ"]!' unless proj = ENV["PROJ"]
    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}
  end
end

# ----- Coverage -----

begin
  require 'rcov/rcovtask'

  Rcov::RcovTask.new do |t|
    t.test_files = FileList['test/**/*_test.rb']
    t.rcov_opts << '-x' << '"^\/"'
    if ENV['NON_NATIVE']
      t.rcov_opts << "--no-rcovrt"
    end
    t.verbose = true
  end
rescue LoadError; end

# ----- Profiling -----

begin
  require 'ruby-prof'

  desc <<END
Run a profile of haml.
ENGINE=str sets the engine to be profiled. Defaults to Haml.
TIMES=n sets the number of runs. Defaults to 1000.
FILE=str sets the file to profile.
Defaults to 'standard' for Haml and 'complex' for Sass.
OUTPUT=str sets the ruby-prof output format.
Can be Flat, CallInfo, or Graph. Defaults to Flat. Defaults to Flat.
END
  task :profile do
    engine = (ENV['ENGINE'] || 'haml').downcase
    times = (ENV['TIMES'] || '1000').to_i
    file = ENV['FILE']

    if engine == 'sass'
      require 'lib/sass'

      file = File.read("#{File.dirname(__FILE__)}/test/sass/templates/#{file || 'complex'}.sass")
      result = RubyProf.profile { times.times { Sass::Engine.new(file).render } }
    else
      require 'lib/haml'

      file = File.read("#{File.dirname(__FILE__)}/test/haml/templates/#{file || 'standard'}.haml")
      obj = Object.new
      Haml::Engine.new(file).def_method(obj, :render)
      result = RubyProf.profile { times.times { obj.render } }
    end

    RubyProf.const_get("#{(ENV['OUTPUT'] || 'Flat').capitalize}Printer").new(result).print
  end
rescue LoadError; end

# ----- Testing Multiple Rails Versions -----

rails_versions = [
  "v2.3.0",
  "v2.2.2",
  "v2.1.2",
  "v2.0.5"
]

namespace :test do
  desc "Test all supported versions of rails. This takes a while."
  task :rails_compatibility do
    `rm -rf test/rails`
    puts "Checking out rails. Please wait."
    `git clone git://github.com/rails/rails.git test/rails` rescue nil
    begin
      rails_versions.each do |version|
        Dir.chdir "test/rails" do
          `git checkout #{version}`
        end
        puts "Testing Rails #{version}"
        Rake::Task['test'].reenable
        Rake::Task['test'].execute
      end
    ensure
      `rm -rf test/rails`
    end
  end
end

# ----- Handling Updates -----

def ensure_git_cleanup
  yield
ensure
  sh %{git reset --hard HEAD}
  sh %{git clean -xdf}
  sh %{git checkout master}
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}"

  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}}
  end

  puts 'Done running handle_update'
  puts '=' * 150
end
Something went wrong with that request. Please try again.