File: Rakefile

package info (click to toggle)
ruby-sinatra 4.1.1-5
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,924 kB
  • sloc: ruby: 17,647; sh: 25; makefile: 8
file content (228 lines) | stat: -rw-r--r-- 7,010 bytes parent folder | download
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
# 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 git (no push)'
    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 --all --message '#{source_version} release'
      SH
    end

    desc 'Tags the version in git (no push)'
    task :tag_version do
      sh <<-SH
        git tag --sign v#{source_version} --message '#{source_version} release'
      SH
    end

    desc 'Watch the release workflow run'
    task :watch do
      sh <<-SH
        runId=$(gh run list --workflow=release.yml --limit 1 --json databaseId --jq '.[].databaseId')
        gh run watch --interval 1 --exit-status $runId
      SH
    end

    desc 'Release all gems as packages'
    task all: %i[test commit_version] + GEMS_AND_ROOT_DIRECTORIES.keys
  end
end