1
0
Fork 0
mirror of https://github.com/sinatra/sinatra synced 2023-03-27 23:18:01 -04:00
sinatra/Rakefile
Eloy Pérez f10e571f4d
Minor cleaning setting up tests (#1875)
We use minitest for Sinatra's test suite but we weren't using its rake task. I've updated the Rakefile to require and use Minitest default rake task to simplify.

Another change is to rename the `helper.rb` file to `test_helper.rb` because I think that name is used more in the community and require it directly without calling `File.expand_path`
2023-02-12 19:09:35 +01:00

216 lines
6.6 KiB
Ruby

# frozen_string_literal: true
require 'rake/clean'
require 'minitest/test_task'
require 'fileutils'
require 'date'
task default: :test
def source_version
@source_version ||= File.read(File.expand_path('VERSION', __dir__)).strip
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
# Tests ===============================================================
Minitest::TestTask.create # Default `test` task
Minitest::TestTask.create(:'test:core') do |t|
t.warning = true
t.test_globs = %w[
base delegator encoding extensions filter
helpers mapped_error middleware rdoc
readme request response result route_added_hook
routing server settings sinatra static templates
].map { |n| "test/#{n}_test.rb" }
end
# Test code coverage ==================================================
namespace :test do
desc 'Measures test coverage'
task :coverage do
rm_f 'coverage'
ENV['COVERAGE'] = '1'
Rake::Task['test'].invoke
end
end
CLEAN.include('coverage')
# Website =============================================================
desc 'Generate RDoc under doc/api'
task 'doc' => ['doc:api']
task('doc:api') { sh 'yardoc -o doc/api' }
CLEAN.include 'doc/api'
# README ===============================================================
task :add_template, [:name] do |_t, args|
Dir.glob('README.*') do |file|
code = File.read(file)
if code =~ /^===.*#{args.name.capitalize}/
puts "Already covered in #{file}"
else
template = code[%r{===[^\n]*Liquid.*index\.liquid</tt>[^\n]*}m]
if template
puts "Adding section to #{file}"
template = template.gsub(/Liquid/, args.name.capitalize).gsub(/liquid/, args.name.downcase)
code.gsub! /^(\s*===.*CoffeeScript)/, "\n" << template << "\n\\1"
File.open(file, 'w') { |f| f << code }
else
puts "Liquid not found in #{file}"
end
end
end
end
# Thanks in announcement ===============================================
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"
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
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)
blake = 'Blake Mizerany'
overall = 0
mapping = {
'blake.mizerany@gmail.com' => blake, 'bmizerany' => blake,
'a_user@mac.com' => blake, 'ichverstehe' => 'Harry Vangberg',
'Wu Jiang (nouse)' => 'Wu Jiang'
}
`git shortlog -s #{a.commit_range}`.lines.map do |line|
line = line.force_encoding 'binary' if line.respond_to? :force_encoding
num, name = line.split("\t", 2).map(&:strip)
authors[mapping[name] || name] += num.to_i
overall += num.to_i
end
puts "#{overall} commits by #{authors.count} authors:"
puts authors.sort_by { |_n, c| -c }.map { |e| a.format % e }.join(a.sep)
end
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)'
title = Regexp.new('(?<=\* )(.*)') # so Ruby 1.8 doesn't complain
File.binread(a.readme).scan(/^##.*/) do |line|
puts line.gsub(/#(?=#)/, ' ').gsub('#', '*').gsub(title) { "[#{$1}](##{link($1)})" }
end
end
# PACKAGING ============================================================
if defined?(Gem)
GEMS_AND_ROOT_DIRECTORIES = {
'sinatra' => '.',
'sinatra-contrib' => './sinatra-contrib',
'rack-protection' => './rack-protection'
}.freeze
def package(gem, ext = '')
"pkg/#{gem}-#{source_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
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
%w[
lib/sinatra
sinatra-contrib/lib/sinatra/contrib
rack-protection/lib/rack/protection
].each do |path|
path = File.join(path, 'version.rb')
File.write(path, File.read(path).sub(/VERSION = '(.+?)'/, "VERSION = '#{source_version}'"))
end
sh <<-SH
git commit --allow-empty -a -m '#{source_version} release' &&
git tag -s v#{source_version} -m '#{source_version} release' &&
git push && (git push origin || true) &&
git push --tags && (git push origin --tags || true)
SH
end
desc 'Release all gems as packages'
task all: %i[test commit_version] + GEMS_AND_ROOT_DIRECTORIES.keys
end
end