sinatra/Rakefile

228 lines
6.9 KiB
Ruby
Raw Normal View History

2008-08-31 07:49:22 +00:00
require 'rake/clean'
require 'rake/testtask'
require 'fileutils'
require 'date'
2011-06-09 11:46:30 +00:00
2009-06-06 04:53:27 +00:00
task :default => :test
task :spec => :test
2007-11-21 22:56:42 +00:00
2011-02-19 10:24:09 +00:00
CLEAN.include "**/*.rbc"
def source_version
2011-02-26 14:48:25 +00:00
@source_version ||= begin
2011-06-05 13:31:30 +00:00
load './lib/sinatra/version.rb'
Sinatra::VERSION
2011-02-26 14:48:25 +00:00
end
end
def prev_feature
source_version.gsub(/^(\d\.)(\d+)\..*$/) { $1 + ($2.to_i - 1).to_s }
end
def prev_version
return prev_feature + '.0' if source_version.end_with? '.0'
source_version.gsub(/\d+$/) { |s| s.to_i - 1 }
end
2008-08-31 07:49:22 +00:00
# SPECS ===============================================================
2011-02-26 14:48:25 +00:00
task :test do
ENV['LANG'] = 'C'
ENV.delete 'LC_CTYPE'
end
2008-08-31 07:49:22 +00:00
Rake::TestTask.new(:test) do |t|
t.test_files = FileList['test/*_test.rb']
t.ruby_opts = ['-rubygems'] if defined? Gem
t.ruby_opts << '-I.'
2013-07-01 05:21:35 +00:00
t.warning = true
I knew I shoulda taken that left turn at Hoboken This is a fairly large reworking of Sinatra's innards. Although most of the internal implementation has been modified, it provides the same basic feature set and is meant to be compatible with Sinatra 0.3.2. * The Event and EventContext classes have been removed. Sinatra applications are now defined within the class context of a Sinatra::Base subclass; each request is processed within a new instance. * Sinatra::Base can be used as a base class for multiple Rack applications within a single process and can be used as Rack middleware. * The routing and result type processing implementation has been simplified and enhanced a bit. There's a new route conditions system for things like :agent/:host matching and a request level #pass method has been added to allow an event handler to exit immediately, passing control to the next matching route. * Regular expressions may now be used in route patterns. Captures are available as an array from "params[:captures]". * The #body helper method now takes a block. The block is not evaluated until an attempt is made to read the body. * Options are now dynamically generated class attributes on the Sinatra::Base subclass (instead of OpenStruct); options are inherited by subclasses and may be overridden up the inheritance hierarchy. The Base.set manages all option related stuff. * The application file (app_file) detection heuristics are bit more sane now. This fixes some bugs with reloading and public/views directory detection. All thin / passenger issues of these type should be better now. * Error mappings are now split into to distinct layers: exception mappings and custom error pages. Exception mappings are registered with 'error(Exception)' and are run only when the app raises an exception. Custom error pages are registered with error(status_code) and are run any time the response has the status code specified. It's also possible to register an error page for a range of status codes: 'error(500..599)'. * The spec and unit testing extensions have been modified to take advantage of the ability to have multiple Sinatra applications. The Sinatra::Test module must be included within the TestCase in order to take advantage of these methods (unless the 'sinatra/compat' library has been required). * Rebuilt specs from scratch for better coverage and organization. Sinatra 3.2 unit tests have been retained under ./compat to ensure a baseline level of compatibility with previous versions; use the 'rake compat' task to run these. A large number of existing Sinatra idioms have been deprecated but continue to be supported through the 'sinatra/compat' library. * The "set_option" and "set_options" methods have been deprecated due to redundancy; use "set". * The "env" option (Sinatra::Base.env) has been renamed to "environment" and deprecated because it's too easy to confuse with the request-level Rack environment Hash (Sinatra::Base#env). * The request level "stop" method has been renamed "halt" and deprecated. This is for consistency with `throw :halt`. * The request level "entity_tag" method has been renamed "etag" and deprecated. Both versions were previously supported. * The request level "headers" method has been deprecated. Use response['Header-Name'] to access and modify response headers. * Sinatra.application is deprecated. Use Sinatra::Application instead. * Setting Sinatra.application = nil to reset an application is deprecated. You shouldn't have to reset objects anymore. * The Sinatra.default_options Hash is deprecated. Modifying this object now results in "set(key, value)" invocations on the Sinatra::Base subclass. * The "body.to_result" convention has been deprecated. * The ServerError exception has been deprecated. Any Exception is now considered a ServerError.
2008-12-13 21:06:02 +00:00
end
2011-02-26 14:48:25 +00:00
Rake::TestTask.new(:"test:core") do |t|
core_tests = %w[base delegator encoding extensions filter
helpers mapped_error middleware radius rdoc
readme request response result route_added_hook
routing server settings sinatra static templates]
t.test_files = core_tests.map {|n| "test/#{n}_test.rb"}
t.ruby_opts = ["-rubygems"] if defined? Gem
t.ruby_opts << "-I."
2013-07-01 05:21:35 +00:00
t.warning = true
end
# Rcov ================================================================
2011-02-26 14:48:25 +00:00
namespace :test do
2012-05-22 19:47:15 +00:00
desc 'Measures test coverage'
task :coverage do
rm_f "coverage"
ENV['COVERAGE'] = '1'
Rake::Task['test'].invoke
end
2008-04-11 23:29:36 +00:00
end
# Website =============================================================
2008-11-02 12:51:09 +00:00
desc 'Generate RDoc under doc/api'
2009-01-19 00:39:39 +00:00
task 'doc' => ['doc:api']
task('doc:api') { sh "yardoc -o doc/api" }
2008-11-02 12:51:09 +00:00
CLEAN.include 'doc/api'
# README ===============================================================
2011-02-26 14:48:25 +00:00
task :add_template, [:name] do |t, args|
Dir.glob('README.*') do |file|
code = File.read(file)
if code =~ /^===.*#{args.name.capitalize}/
2010-11-05 12:57:03 +00:00
puts "Already covered in #{file}"
else
template = code[/===[^\n]*Liquid.*index\.liquid<\/tt>[^\n]*/m]
if !template
puts "Liquid not found in #{file}"
else
2010-11-05 12:57:03 +00:00
puts "Adding section to #{file}"
2011-06-09 11:46:30 +00:00
template = template.gsub(/Liquid/, args.name.capitalize).gsub(/liquid/, args.name.downcase)
2010-11-05 12:59:49 +00:00
code.gsub! /^(\s*===.*CoffeeScript)/, "\n" << template << "\n\\1"
File.open(file, "w") { |f| f << code }
end
end
end
end
# Thanks in announcement ===============================================
2017-01-27 03:02:54 +00:00
team = ["Ryan Tomayko", "Blake Mizerany", "Simon Rozet", "Konstantin Haase", "Zachary Scott"]
desc "list of contributors"
task :thanks, ['release:all', :backports] do |t, a|
a.with_defaults :release => "#{prev_version}..HEAD",
:backports => "#{prev_feature}.0..#{prev_feature}.x"
2013-03-09 17:15:30 +00:00
included = `git log --format=format:"%aN\t%s" #{a.release}`.lines.map { |l| l.force_encoding('binary') }
excluded = `git log --format=format:"%aN\t%s" #{a.backports}`.lines.map { |l| l.force_encoding('binary') }
commits = (included - excluded).group_by { |c| c[/^[^\t]+/] }
authors = commits.keys.sort_by { |n| - commits[n].size } - team
puts authors[0..-2].join(', ') << " and " << authors.last,
"(based on commits included in #{a.release}, but not in #{a.backports})"
end
2011-06-05 12:44:24 +00:00
desc "list of authors"
task :authors, [:commit_range, :format, :sep] do |t, a|
a.with_defaults :format => "%s (%d)", :sep => ", ", :commit_range => '--all'
authors = Hash.new(0)
2011-03-15 17:18:50 +00:00
blake = "Blake Mizerany"
2011-06-05 12:44:24 +00:00
overall = 0
2011-03-15 17:18:50 +00:00
mapping = {
"blake.mizerany@gmail.com" => blake, "bmizerany" => blake,
"a_user@mac.com" => blake, "ichverstehe" => "Harry Vangberg",
"Wu Jiang (nouse)" => "Wu Jiang" }
2011-06-05 12:44:24 +00:00
`git shortlog -s #{a.commit_range}`.lines.map do |line|
2012-03-11 12:45:06 +00:00
line = line.force_encoding 'binary' if line.respond_to? :force_encoding
2011-03-15 17:18:50 +00:00
num, name = line.split("\t", 2).map(&:strip)
authors[mapping[name] || name] += num.to_i
2011-06-05 12:44:24 +00:00
overall += num.to_i
2011-03-15 17:18:50 +00:00
end
2011-06-05 12:44:24 +00:00
puts "#{overall} commits by #{authors.count} authors:"
2011-03-15 17:18:50 +00:00
puts authors.sort_by { |n,c| -c }.map { |e| a.format % e }.join(a.sep)
end
2013-02-26 11:25:50 +00:00
desc "generates TOC"
task :toc, [:readme] do |t, a|
a.with_defaults :readme => 'README.md'
def self.link(title)
title.downcase.gsub(/(?!-)\W /, '-').gsub(' ', '-').gsub(/(?!-)\W/, '')
end
puts "* [Sinatra](#sinatra)"
2013-02-26 11:39:24 +00:00
title = Regexp.new('(?<=\* )(.*)') # so Ruby 1.8 doesn't complain
2013-02-26 11:25:50 +00:00
File.binread(a.readme).scan(/^##.*/) do |line|
2013-02-26 11:39:24 +00:00
puts line.gsub(/#(?=#)/, ' ').gsub('#', '*').gsub(title) { "[#{$1}](##{link($1)})" }
2013-02-26 11:25:50 +00:00
end
end
# PACKAGING ============================================================
if defined?(Gem)
GEMS_AND_ROOT_DIRECTORIES = {
"sinatra" => ".",
"sinatra-contrib" => "./sinatra-contrib",
"rack-protection" => "./rack-protection"
}
# Load the gemspec using the same limitations as github
def spec(gem)
require 'rubygems' unless defined? Gem::Specification
directory = GEMS_AND_ROOT_DIRECTORIES[gem]
eval(File.read("#{directory + "/" + gem}.gemspec"))
end
def package(gem, ext='')
"pkg/#{gem}-#{spec(gem).version}" + ext
end
directory 'pkg/'
CLOBBER.include('pkg')
GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
file package(gem, '.gem') => ["pkg/", "#{directory + '/' + gem}.gemspec"] do |f|
sh "cd #{directory} && gem build #{gem}.gemspec"
mv directory + "/" + File.basename(f.name), f.name
end
file package(gem, '.tar.gz') => ["pkg/"] do |f|
sh <<-SH
git archive \
--prefix=#{gem}-#{source_version}/ \
--format=tar \
HEAD -- #{directory} | gzip > #{f.name}
SH
end
end
namespace :package do
GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
desc "Build #{gem} packages"
task gem => %w[.gem .tar.gz].map { |e| package(gem, e) }
end
2011-10-05 16:44:47 +00:00
desc "Build all packages"
task :all => GEMS_AND_ROOT_DIRECTORIES.keys
end
namespace :install do
GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
desc "Build and install #{gem} as local gem"
task gem => package(gem, '.gem') do
sh "gem install #{package(gem, '.gem')}"
end
end
desc "Build and install all of the gems as local gems"
task :all => GEMS_AND_ROOT_DIRECTORIES.keys
end
namespace :release do
GEMS_AND_ROOT_DIRECTORIES.each do |gem, directory|
desc "Release #{gem} as a package"
task gem => "package:#{gem}" do
sh <<-SH
gem install #{package(gem, '.gem')} --local &&
gem push #{package(gem, '.gem')} &&
SH
end
end
desc "Commits the version to github repository"
task :commit_version do
sh <<-SH
git commit --allow-empty -a -m '#{source_version} release' &&
git tag -s v#{source_version} -m '#{source_version} release' &&
git tag -s #{source_version} -m '#{source_version} release' &&
git push && (git push sinatra || true) &&
git push --tags && (git push sinatra --tags || true)
SH
end
desc "Release all gems as packages"
task :all => [:test, :commit_version] + GEMS_AND_ROOT_DIRECTORIES.keys
2010-10-23 08:02:14 +00:00
end
2009-09-25 22:28:09 +00:00
end