-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRakefile
312 lines (251 loc) Β· 8.63 KB
/
Rakefile
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
require "bundler/gem_tasks"
require "rake/testtask"
require "rbconfig"
require 'rake/extensiontask'
$LOAD_PATH << File.join(__dir__, "test")
ruby = ENV["RUBY"] || RbConfig.ruby
rbs = File.join(__dir__, "exe/rbs")
bin = File.join(__dir__, "bin")
Rake::ExtensionTask.new("rbs_extension")
Rake::TestTask.new(:test => :compile) do |t|
t.libs << "test"
t.libs << "lib"
t.test_files = FileList["test/**/*_test.rb"].reject do |path|
path =~ %r{test/stdlib/}
end
end
multitask :default => [:test, :stdlib_test, :rubocop, :validate, :test_doc]
task :lexer do
sh "re2c -W --no-generation-date -o ext/rbs_extension/lexer.c ext/rbs_extension/lexer.re"
end
task :confirm_lexer => :lexer do
puts "Testing if lexer.c is updated with respect to lexer.re"
sh "git diff --exit-code ext/rbs_extension/lexer.c"
end
rule ".c" => ".re" do |t|
puts "β οΈβ οΈβ οΈ #{t.name} is older than #{t.source}. You may need to run `rake lexer` β οΈβ οΈβ οΈ"
end
task :annotate do
sh "bin/generate_docs.sh"
end
task :confirm_annotation do
puts "Testing if RBS docs are updated with respect to RDoc"
sh "git diff --exit-code core stdlib"
end
task :compile => "ext/rbs_extension/lexer.c"
task :test_doc do
files = Dir.chdir(File.expand_path('..', __FILE__)) do
`git ls-files -z`.split("\x0").select do |file| Pathname(file).extname == ".md" end
end
sh "#{ruby} #{__dir__}/bin/run_in_md.rb #{files.join(" ")}"
end
task :validate => :compile do
require 'yaml'
sh "#{ruby} #{rbs} validate --silent"
libs = FileList["stdlib/*"].map {|path| File.basename(path).to_s }
# Skip RBS validation because Ruby CI runs without rubygems
case skip_rbs_validation = ENV["SKIP_RBS_VALIDATION"]
when nil
libs << "rbs"
when "true"
# Skip
else
STDERR.puts "π¨π¨π¨π¨ SKIP_RBS_VALIDATION is expected to be `true` or unset, given `#{skip_rbs_validation}` π¨π¨π¨π¨"
libs << "rbs"
end
libs.each do |lib|
sh "#{ruby} #{rbs} -r #{lib} validate --silent"
end
end
FileList["test/stdlib/**/*_test.rb"].each do |test|
task test => :compile do
sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test}"
end
end
task :stdlib_test do
test_files = FileList["test/stdlib/**/*_test.rb"].reject do |path|
path =~ %r{Ractor}
end
sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test_files.join(' ')}"
# TODO: Ractor tests need to be run in a separate process
sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/Ractor_test.rb"
end
task :rubocop do
sh "rubocop --parallel"
end
namespace :generate do
desc "Generate a test file for a stdlib class signatures"
task :stdlib_test, [:class] do |_task, args|
klass = args.fetch(:class) do
raise "Class name is necessary. e.g. rake 'generate:stdlib_test[String]'"
end
require "erb"
require "rbs"
class TestTarget
def initialize(klass)
@type_name = RBS::Namespace.parse(klass).to_type_name
end
def path
Pathname(ENV['RBS_GENERATE_TEST_PATH'] || "test/stdlib/#{file_name}_test.rb")
end
def file_name
@type_name.to_s.gsub(/\A::/, '').gsub(/::/, '_')
end
def to_s
@type_name.to_s
end
def absolute_type_name
@absolute_type_name ||= @type_name.absolute!
end
end
target = TestTarget.new(klass)
path = target.path
raise "#{path} already exists!" if path.exist?
class TestTemplateBuilder
attr_reader :target, :env
def initialize(target)
@target = target
loader = RBS::EnvironmentLoader.new
Dir['stdlib/*'].each do |lib|
next if lib.end_with?('builtin')
loader.add(library: File.basename(lib))
end
@env = RBS::Environment.from_loader(loader).resolve_type_names
end
def call
ERB.new(<<~ERB, trim_mode: "-").result(binding)
require_relative "test_helper"
<%- unless class_methods.empty? -%>
class <%= target %>SingletonTest < Test::Unit::TestCase
include TypeAssertions
# library "pathname", "securerandom" # Declare library signatures to load
testing "singleton(::<%= target %>)"
<%- class_methods.each do |method_name, definition| %>
def test_<%= test_name_for(method_name) %>
<%- definition.method_types.each do |method_type| -%>
assert_send_type "<%= method_type %>",
<%= target %>, :<%= method_name %>
<%- end -%>
end
<%- end -%>
end
<%- end -%>
<%- unless instance_methods.empty? -%>
class <%= target %>Test < Test::Unit::TestCase
include TypeAssertions
# library "pathname", "securerandom" # Declare library signatures to load
testing "::<%= target %>"
<%- instance_methods.each do |method_name, definition| %>
def test_<%= test_name_for(method_name) %>
<%- definition.method_types.each do |method_type| -%>
assert_send_type "<%= method_type %>",
<%= target %>.new, :<%= method_name %>
<%- end -%>
end
<%- end -%>
end
<%- end -%>
ERB
end
private
def test_name_for(method_name)
{
:== => 'double_equal',
:!= => 'not_equal',
:=== => 'triple_equal',
:[] => 'square_bracket',
:[]= => 'square_bracket_assign',
:> => 'greater_than',
:< => 'less_than',
:>= => 'greater_than_equal_to',
:<= => 'less_than_equal_to',
:<=> => 'spaceship',
:+ => 'plus',
:- => 'minus',
:* => 'multiply',
:/ => 'divide',
:** => 'power',
:% => 'modulus',
:& => 'and',
:| => 'or',
:^ => 'xor',
:>> => 'right_shift',
:<< => 'left_shift',
:=~ => 'pattern_match',
:!~ => 'does_not_match',
:~ => 'tilde'
}.fetch(method_name, method_name)
end
def class_methods
@class_methods ||= RBS::DefinitionBuilder.new(env: env).build_singleton(target.absolute_type_name).methods.select {|_, definition|
definition.implemented_in == target.absolute_type_name
}
end
def instance_methods
@instance_methods ||= RBS::DefinitionBuilder.new(env: env).build_instance(target.absolute_type_name).methods.select {|_, definition|
definition.implemented_in == target.absolute_type_name
}
end
end
path.write TestTemplateBuilder.new(target).call
puts "Created: #{path}"
end
end
task :test_generate_stdlib do
sh "RBS_GENERATE_TEST_PATH=/tmp/Array_test.rb rake 'generate:stdlib_test[Array]'"
sh "ruby -c /tmp/Array_test.rb"
sh "RBS_GENERATE_TEST_PATH=/tmp/Thread_Mutex_test.rb rake 'generate:stdlib_test[Thread::Mutex]'"
sh "ruby -c /tmp/Thread_Mutex_test.rb"
end
Rake::Task[:release].enhance do
Rake::Task[:"release:note"].invoke
end
namespace :release do
desc "Explain the post-release steps automatically"
task :note do
version = Gem::Version.new(RBS::VERSION)
major, minor, patch, *_ = RBS::VERSION.split(".")
major = major.to_i
minor = minor.to_i
patch = patch.to_i
puts "ππππ Congratulations for **#{version}** release! ππππ"
puts
puts "There are a few things left to complete the release. πͺ"
puts
if patch == 0 || version.prerelease?
puts "* [ ] Update release note: https://github.com/ruby/rbs/wiki/Release-Note-#{major}.#{minor}"
end
if patch == 0 && !version.prerelease?
puts "* [ ] Delete `RBS XYZ is the latest version of...` from release note: https://github.com/ruby/rbs/wiki/Release-Note-#{major}.#{minor}"
end
puts "* [ ] Publish a release at GitHub"
puts "* [ ] Make some announcements on Twitter/Mustdon/Slack/???"
puts
puts
puts "βοΈ Making a draft release on GitHub..."
content = File.read(File.join(__dir__, "CHANGELOG.md"))
changelog = content.scan(/^## \d.*?(?=^## \d)/m)[0]
changelog = changelog.sub(/^.*\n^.*\n/, "").rstrip
notes = <<NOTES
[Release note](https://github.com/ruby/rbs/wiki/Release-Note-#{major}.#{minor})
#{changelog}
NOTES
command = [
"gh",
"release",
"create",
"--draft",
"v#{RBS::VERSION}",
"--title=#{RBS::VERSION}",
"--notes=#{notes}"
]
if version.prerelease?
command << "--prerelease"
end
require "open3"
output, status = Open3.capture2(*command)
if status.success?
puts " >> Done! Open #{output.chomp} and publish the release!"
end
end
end