forked from gettalong/kramdown
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Rakefile
270 lines (218 loc) · 7.05 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
# -*- ruby -*-
# load all optional developer libraries
begin
require 'rubygems'
require 'rubygems/package_task'
rescue LoadError
end
begin
require 'webgen/page'
rescue LoadError
end
begin
gem 'rdoc' if RUBY_VERSION >= '1.9'
require 'rdoc/task'
require 'rdoc/rdoc'
class RDoc::RDoc
alias :old_parse_files :parse_files
def parse_files(options)
file_info = old_parse_files(options)
require 'kramdown/options'
# Add options documentation to Kramdown::Options module
opt_module = @store.all_classes_and_modules.find {|m| m.full_name == 'Kramdown::Options'}
opt_defs = Kramdown::Options.definitions.sort.collect do |n, definition|
desc = definition.desc.split(/\n/).map {|l| " #{l}"}
desc[-2] = []
desc = desc.join("\n")
"[<tt>#{n}</tt> (type: #{definition.type}, default: #{definition.default.inspect})]\n#{desc}\n\n"
end
opt_module.comment.text += "\n== Available Options\n\n" << opt_defs.join("\n\n")
file_info
end
end
rescue LoadError
end
begin
require 'rcov/rcovtask'
rescue LoadError
end
require 'fileutils'
require 'rake/clean'
require 'rake/testtask'
require 'rake/packagetask'
require 'erb'
$:.unshift('lib')
require 'kramdown'
# End user tasks ################################################################
task :default => :test
desc "Install using setup.rb"
task :install do
ruby "setup.rb config"
ruby "setup.rb setup"
ruby "setup.rb install"
end
task :clobber do
ruby "setup.rb clean"
end
if defined?(Webgen)
desc "Generate the HTML documentation"
task :htmldoc do
ruby "-Ilib -S webgen"
end
CLOBBER << "htmldoc/"
CLOBBER << "webgen-tmp"
end
if defined? RDoc::Task
rd = RDoc::Task.new do |rdoc|
rdoc.rdoc_dir = 'htmldoc/rdoc'
rdoc.title = 'kramdown'
rdoc.main = 'lib/kramdown/document.rb'
rdoc.rdoc_files.include('lib')
end
end
if defined?(Webgen) && defined?(RDoc::Task)
desc "Build the whole user documentation"
task :doc => [:rdoc, 'htmldoc']
end
tt = Rake::TestTask.new do |test|
test.warning = false
test.libs << 'test'
test.test_files = FileList['test/test_*.rb']
end
# Release tasks and development tasks ############################################
namespace :dev do
SUMMARY = 'kramdown is a fast, pure-Ruby Markdown-superset converter.'
DESCRIPTION = <<EOF
kramdown is yet-another-markdown-parser but fast, pure Ruby,
using a strict syntax definition and supporting several common extensions.
EOF
begin
REL_PAGE = Webgen::Page.from_data(File.read('doc/news/release_' + Kramdown::VERSION.split('.').join('_') + '.page'))
rescue
puts 'NO RELEASE NOTES/CHANGES FILE'
end
PKG_FILES = FileList.new([
'Rakefile',
'setup.rb',
'COPYING', 'README.md', 'AUTHORS',
'VERSION', 'CONTRIBUTERS',
'bin/*',
'benchmark/*',
'lib/**/*.rb',
'man/man1/kramdown.1',
'data/**/*',
'doc/**',
'test/**/*'
])
CLOBBER << "VERSION"
file 'VERSION' do
puts "Generating VERSION file"
File.open('VERSION', 'w+') {|file| file.write(Kramdown::VERSION + "\n")}
end
CLOBBER << 'CONTRIBUTERS'
file 'CONTRIBUTERS' do
puts "Generating CONTRIBUTERS file"
`echo " Count Name" > CONTRIBUTERS`
`echo "======= ====" >> CONTRIBUTERS`
`git log | grep ^Author: | sed 's/^Author: //' | sort | uniq -c | sort -nr >> CONTRIBUTERS`
end
CLOBBER << "man/man1/kramdown.1"
file 'man/man1/kramdown.1' => ['man/man1/kramdown.1.erb'] do
puts "Generating kramdown man page"
File.open('man/man1/kramdown.1', 'w+') do |file|
file.write(ERB.new(File.read('man/man1/kramdown.1.erb')).result(binding))
end
end
Rake::PackageTask.new('kramdown', Kramdown::VERSION) do |pkg|
pkg.need_tar = true
pkg.need_zip = true
pkg.package_files = PKG_FILES
end
if defined? Gem
spec = Gem::Specification.new do |s|
#### Basic information
s.name = 'kramdown'
s.version = Kramdown::VERSION
s.summary = SUMMARY
s.description = DESCRIPTION
s.license = 'MIT'
#### Dependencies, requirements and files
s.files = PKG_FILES.to_a
s.require_path = 'lib'
s.executables = ['kramdown']
s.default_executable = 'kramdown'
s.add_development_dependency 'minitest', '~> 5.0'
s.add_development_dependency 'coderay', '~> 1.0.0'
s.add_development_dependency 'rouge', '~> 1.8'
s.add_development_dependency 'stringex', '~> 1.5.1'
s.add_development_dependency 'prawn', '~> 2.0'
s.add_development_dependency 'ritex', '~> 1.0'
s.add_development_dependency 'itextomml', '~> 1.5'
#### Documentation
s.has_rdoc = true
s.rdoc_options = ['--main', 'lib/kramdown/document.rb']
#### Author and project details
s.author = 'Thomas Leitner'
s.email = 't_leitner@gmx.at'
s.homepage = "http://kramdown.gettalong.org"
end
task :gemspec => [ 'CONTRIBUTERS', 'VERSION', 'man/man1/kramdown.1'] do
print "Generating Gemspec\n"
contents = spec.to_ruby
File.open("kramdown.gemspec", 'w+') {|f| f.puts(contents)}
end
Gem::PackageTask.new(spec) do |pkg|
pkg.need_zip = true
pkg.need_tar = true
end
end
if defined?(Webgen) && defined?(Gem) && defined?(Rake::RDocTask)
desc 'Release Kramdown version ' + Kramdown::VERSION
task :release => [:clobber, :package, :publish_files, :publish_website]
end
if defined?(Gem)
desc "Upload the release to Rubygems"
task :publish_files => [:package] do
sh "gem push pkg/kramdown-#{Kramdown::VERSION}.gem"
puts 'done'
end
end
desc "Upload the website"
task :publish_website => ['doc'] do
puts "Transfer manually!!!"
# sh "rsync -avc --delete --exclude 'MathJax' --exclude 'robots.txt' htmldoc/ gettalong@rubyforge.org:/var/www/gforge-projects/kramdown/"
end
if defined? Rcov
Rcov::RcovTask.new do |rcov|
rcov.libs << 'test'
end
end
CODING_LINE = "# -*- coding: utf-8 -*-\n"
COPYRIGHT=<<EOF
#
#--
# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
#
# This file is part of kramdown which is licensed under the MIT.
#++
#
EOF
desc "Insert/Update copyright notice"
task :update_copyright do
inserted = false
Dir["lib/**/*.rb", "test/**/*.rb"].each do |file|
if !File.read(file).start_with?(CODING_LINE + COPYRIGHT)
inserted = true
puts "Updating file #{file}"
old = File.read(file)
if !old.gsub!(/\A#{Regexp.escape(CODING_LINE)}#\n#--.*?\n#\+\+\n#\n/m, CODING_LINE + COPYRIGHT)
old.gsub!(/\A(#{Regexp.escape(CODING_LINE)})?/, CODING_LINE + COPYRIGHT + "\n")
end
File.open(file, 'w+') {|f| f.puts(old)}
end
end
puts "Look through the above mentioned files and correct all problems" if inserted
end
end
task :gemspec => ['dev:gemspec']
task :clobber => ['dev:clobber']