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
|
#!ruby
# vim: noet ts=2 sts=8 sw=2
require 'rubygems'
gem 'rdoc', '>= 2.4'
require 'pp'
require 'pathname'
require 'fileutils'
require 'erb'
require 'yaml'
require 'rdoc/rdoc'
require 'rdoc/generator'
require 'rdoc/generator/markup'
require 'uri'
#
# Darkfish RDoc HTML Generator
#
# $Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $
#
# == Author/s
# * Michael Granger (ged@FaerieMUD.org)
#
# == Contributors
# * Mahlon E. Smith (mahlon@martini.nu)
# * Eric Hodel (drbrain@segment7.net)
#
# == License
#
# Copyright (c) 2007, 2008, Michael Granger. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the author/s, nor the names of the project's
# contributors may be used to endorse or promote products derived from this
# software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
class RDoc::Generator::SingleDarkfish < RDoc::Generator::Darkfish
RDoc::RDoc.add_generator( self )
RDoc::Context.instance_eval do
org = instance_method(:http_url)
define_method(:http_url) do |prefix|
if RDoc::Generator::SingleDarkfish.current?
prefix + full_name.gsub("::", '-')
else
org.bind(self).call(prefix)
end
end
end
RDoc::AnyMethod.instance_eval do
org = instance_method(:path)
define_method(:path) do
if RDoc::Generator::SingleDarkfish.current?
"/api.html##{@aref}"
else
org.bind(self).call
end
end
end
def self.current?
RDoc::RDoc.current.generator.class.ancestors.include?(self)
end
#################################################################
### I N S T A N C E M E T H O D S
#################################################################
### Initialize a few instance variables before we start
def initialize( options )
@options = options
@options.diagram = false
template = @options.template || 'darkfish'
template_dir = $LOAD_PATH.map do |path|
File.join path, GENERATOR_DIR, 'template', template
end.find do |dir|
File.directory? dir
end
raise RDoc::Error, "could not find template #{template.inspect}" unless
template_dir
@template_dir = Pathname.new File.expand_path(template_dir)
@basedir = Pathname.pwd.expand_path
end
######
public
######
def class_dir
'/api.html#class-'
end
def template(name)
"#{name}.rhtml"
end
### Build the initial indices and output objects
### based on an array of TopLevel objects containing
### the extracted information.
def generate( top_levels )
@outputdir = Pathname.new( @options.op_dir ).expand_path( @basedir )
@files = top_levels.sort
@classes = RDoc::TopLevel.all_classes_and_modules.sort
@methods = @classes.map { |m| m.method_list }.flatten.sort
@modsort = get_sorted_module_list( @classes )
# Now actually write the output
write_style_sheet
generate_thing(:readme, 'index.html')
generate_thing(:reference, 'api.html')
generate_thing(:toc, 'book.html')
generate_book
rescue StandardError => err
debug_msg "%s: %s\n %s" % [ err.class.name, err.message, err.backtrace.join("\n ") ]
raise
end
def generate_book
chapters.each do |file|
templatefile = @template_dir + template(:page)
outfile = @basedir + @options.op_dir + file.path
rel_prefix = @outputdir.relative_path_from(outfile.dirname)
render_template(templatefile, binding, outfile)
end
end
def generate_thing(name, to)
debug_msg "Rendering #{name}..."
templatefile = @template_dir + template(name)
outfile = @basedir + @options.op_dir + to
rel_prefix = @outputdir.relative_path_from(outfile.dirname)
FileUtils.mkdir_p(File.dirname(outfile))
render_template(templatefile, binding, outfile)
end
def methods_for(klass)
klass.methods_by_type.each do |type, visibilities|
next if visibilities.empty?
visibilities.each do |visibility, methods|
next if methods.empty?
methods.each do |method|
yield method, type, visibility
end
end
end
end
## For book.rhtml
def chapters
@chapters ||= @files.select do |file|
next unless file.full_name =~ /^book\//
(class << file; self; end).class_eval { attr_accessor :title, :content, :toc, :id }
file.toc = []
file.content = file.description
file.title = file.content[%r{<h1>(.*?)</h1>}, 1]
file.content.gsub!(%r{<h2>(.*?)</h2>}) do |match|
arr = [make_id($1), $1]
file.toc << arr
'<h2 class="ruled" id="%s">%s</h2>' % arr
end
true
end
end
def make_id(title)
title.downcase.gsub(/\s/, '-').gsub(/[^\w-]+/, '')
end
end # Roc::Generator::SingleDarkfish
# :stopdoc:
|
