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
|
# frozen_string_literal: true
require "rdoc/task"
require "rails/api/generator"
module Rails
module API
class Task < RDoc::Task
RDOC_FILES = {
"activesupport" => {
include: %w(
README.rdoc
lib/active_support/**/*.rb
)
},
"activerecord" => {
include: %w(
README.rdoc
lib/active_record/**/*.rb
)
},
"activemodel" => {
include: %w(
README.rdoc
lib/active_model/**/*.rb
)
},
"actionpack" => {
include: %w(
README.rdoc
lib/abstract_controller/**/*.rb
lib/action_controller/**/*.rb
lib/action_dispatch/**/*.rb
)
},
"actionview" => {
include: %w(
README.rdoc
lib/action_view/**/*.rb
),
exclude: "lib/action_view/vendor/*"
},
"actionmailer" => {
include: %w(
README.rdoc
lib/action_mailer/**/*.rb
)
},
"activejob" => {
include: %w(
README.md
lib/active_job/**/*.rb
)
},
"actioncable" => {
include: %w(
README.md
lib/action_cable/**/*.rb
)
},
"activestorage" => {
include: %w(
README.md
app/**/active_storage/**/*.rb
lib/active_storage/**/*.rb
)
},
"actionmailbox" => {
include: %w(
README.md
app/**/action_mailbox/**/*.rb
lib/action_mailbox/**/*.rb
)
},
"actiontext" => {
include: %w(
README.md
app/**/action_text/**/*.rb
lib/action_text/**/*.rb
)
},
"railties" => {
include: %w(
README.rdoc
lib/**/*.rb
),
exclude: %w(
lib/rails/generators/**/templates/**/*.rb
lib/rails/test_unit/*
lib/rails/api/generator.rb
)
}
}
def initialize(name)
super
# Every time rake runs this task is instantiated as all the rest.
# Be lazy computing stuff to have as light impact as possible to
# the rest of tasks.
before_running_rdoc do
configure_sdoc
configure_rdoc_files
setup_horo_variables
end
end
# Hack, ignore the desc calls performed by the original initializer.
def desc(description)
# no-op
end
def configure_sdoc
self.title = "Ruby on Rails API"
self.rdoc_dir = api_dir
options << "-m" << api_main
options << "-e" << "UTF-8"
options << "-f" << "api"
options << "-T" << "rails"
end
def configure_rdoc_files
rdoc_files.include(api_main)
RDOC_FILES.each do |component, cfg|
cdr = component_root_dir(component)
Array(cfg[:include]).each do |pattern|
rdoc_files.include("#{cdr}/#{pattern}")
end
Array(cfg[:exclude]).each do |pattern|
rdoc_files.exclude("#{cdr}/#{pattern}")
end
end
# Only generate documentation for files that have been
# changed since the API was generated.
if Dir.exist?("doc/rdoc") && !ENV["ALL"]
last_generation = DateTime.rfc2822(File.open("doc/rdoc/created.rid", &:readline))
rdoc_files.keep_if do |file|
File.mtime(file).to_datetime > last_generation
end
# Nothing to do
exit(0) if rdoc_files.empty?
end
end
def setup_horo_variables
ENV["HORO_PROJECT_NAME"] = "Ruby on Rails"
ENV["HORO_PROJECT_VERSION"] = rails_version
end
def api_main
component_root_dir("railties") + "/RDOC_MAIN.rdoc"
end
end
class RepoTask < Task
def configure_sdoc
super
options << "-g" # link to GitHub, SDoc flag
end
def component_root_dir(component)
component
end
def api_dir
"doc/rdoc"
end
end
class EdgeTask < RepoTask
def rails_version
"master@#{`git rev-parse HEAD`[0, 7]}"
end
end
class StableTask < RepoTask
def rails_version
File.read("RAILS_VERSION").strip
end
end
end
end
|
