rdoc 5.0.0 → 6.3.1
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of rdoc might be problematic. Click here for more details.
- checksums.yaml +5 -5
- data/CONTRIBUTING.rdoc +4 -4
- data/Gemfile +9 -0
- data/History.rdoc +12 -2
- data/README.rdoc +5 -6
- data/Rakefile +35 -65
- data/lib/rdoc/alias.rb +1 -1
- data/lib/rdoc/anon_class.rb +1 -1
- data/lib/rdoc/any_method.rb +59 -15
- data/lib/rdoc/attr.rb +1 -1
- data/lib/rdoc/class_module.rb +5 -3
- data/lib/rdoc/code_object.rb +2 -9
- data/lib/rdoc/code_objects.rb +1 -1
- data/lib/rdoc/comment.rb +32 -11
- data/lib/rdoc/constant.rb +3 -3
- data/lib/rdoc/context/section.rb +1 -14
- data/lib/rdoc/context.rb +74 -21
- data/lib/rdoc/cross_reference.rb +33 -15
- data/lib/rdoc/encoding.rb +58 -30
- data/lib/rdoc/erb_partial.rb +2 -2
- data/lib/rdoc/erbio.rb +8 -4
- data/lib/rdoc/extend.rb +1 -1
- data/lib/rdoc/generator/darkfish.rb +60 -29
- data/lib/rdoc/generator/json_index.rb +7 -4
- data/lib/rdoc/generator/markup.rb +3 -13
- data/lib/rdoc/generator/pot/message_extractor.rb +1 -1
- data/lib/rdoc/generator/pot/po.rb +3 -3
- data/lib/rdoc/generator/pot/po_entry.rb +11 -11
- data/lib/rdoc/generator/pot.rb +4 -4
- data/lib/rdoc/generator/ri.rb +1 -1
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +9 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +6 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/class.rhtml +45 -47
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +55 -6
- data/lib/rdoc/generator/template/darkfish/index.rhtml +3 -4
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +22 -99
- data/lib/rdoc/generator/template/darkfish/js/search.js +32 -31
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +15 -16
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +16 -16
- data/lib/rdoc/generator/template/json_index/js/navigation.js +4 -41
- data/lib/rdoc/generator/template/json_index/js/searcher.js +6 -6
- data/lib/rdoc/generator.rb +1 -1
- data/lib/rdoc/ghost_method.rb +1 -1
- data/lib/rdoc/i18n/locale.rb +2 -2
- data/lib/rdoc/i18n/text.rb +5 -5
- data/lib/rdoc/i18n.rb +3 -3
- data/lib/rdoc/include.rb +1 -1
- data/lib/rdoc/known_classes.rb +1 -1
- data/lib/rdoc/markdown/entities.rb +1 -1
- data/lib/rdoc/markdown/literals.kpeg +1 -0
- data/lib/rdoc/markdown/literals.rb +19 -7
- data/lib/rdoc/markdown.kpeg +92 -44
- data/lib/rdoc/markdown.rb +1171 -610
- data/lib/rdoc/markup/attr_changer.rb +1 -1
- data/lib/rdoc/markup/attr_span.rb +9 -3
- data/lib/rdoc/markup/attribute_manager.rb +115 -50
- data/lib/rdoc/markup/attributes.rb +7 -7
- data/lib/rdoc/markup/blank_line.rb +1 -1
- data/lib/rdoc/markup/block_quote.rb +1 -1
- data/lib/rdoc/markup/document.rb +1 -1
- data/lib/rdoc/markup/formatter.rb +25 -24
- data/lib/rdoc/markup/hard_break.rb +1 -1
- data/lib/rdoc/markup/heading.rb +4 -4
- data/lib/rdoc/markup/include.rb +1 -1
- data/lib/rdoc/markup/indented_paragraph.rb +1 -1
- data/lib/rdoc/markup/list.rb +1 -1
- data/lib/rdoc/markup/list_item.rb +1 -1
- data/lib/rdoc/markup/paragraph.rb +1 -1
- data/lib/rdoc/markup/parser.rb +79 -47
- data/lib/rdoc/markup/pre_process.rb +11 -6
- data/lib/rdoc/markup/raw.rb +1 -1
- data/lib/rdoc/markup/regexp_handling.rb +41 -0
- data/lib/rdoc/markup/rule.rb +1 -1
- data/lib/rdoc/markup/to_ansi.rb +1 -1
- data/lib/rdoc/markup/to_bs.rb +4 -4
- data/lib/rdoc/markup/to_html.rb +71 -26
- data/lib/rdoc/markup/to_html_crossref.rb +41 -26
- data/lib/rdoc/markup/to_html_snippet.rb +10 -10
- data/lib/rdoc/markup/to_joined_paragraph.rb +7 -32
- data/lib/rdoc/markup/to_label.rb +10 -10
- data/lib/rdoc/markup/to_markdown.rb +9 -9
- data/lib/rdoc/markup/to_rdoc.rb +35 -7
- data/lib/rdoc/markup/to_table_of_contents.rb +2 -1
- data/lib/rdoc/markup/to_test.rb +1 -1
- data/lib/rdoc/markup/to_tt_only.rb +3 -3
- data/lib/rdoc/markup/verbatim.rb +1 -1
- data/lib/rdoc/markup.rb +14 -17
- data/lib/rdoc/meta_method.rb +1 -1
- data/lib/rdoc/method_attr.rb +2 -2
- data/lib/rdoc/mixin.rb +1 -1
- data/lib/rdoc/normal_class.rb +3 -3
- data/lib/rdoc/normal_module.rb +1 -1
- data/lib/rdoc/options.rb +79 -21
- data/lib/rdoc/parser/c.rb +147 -194
- data/lib/rdoc/parser/changelog.rb +150 -19
- data/lib/rdoc/parser/markdown.rb +1 -1
- data/lib/rdoc/parser/rd.rb +1 -1
- data/lib/rdoc/parser/ripper_state_lex.rb +590 -0
- data/lib/rdoc/parser/ruby.rb +634 -465
- data/lib/rdoc/parser/ruby_tools.rb +33 -34
- data/lib/rdoc/parser/simple.rb +3 -3
- data/lib/rdoc/parser/text.rb +1 -1
- data/lib/rdoc/parser.rb +12 -35
- data/lib/rdoc/rd/block_parser.rb +109 -108
- data/lib/rdoc/rd/block_parser.ry +3 -3
- data/lib/rdoc/rd/inline.rb +5 -5
- data/lib/rdoc/rd/inline_parser.rb +186 -185
- data/lib/rdoc/rd/inline_parser.ry +1 -1
- data/lib/rdoc/rd.rb +1 -1
- data/lib/rdoc/rdoc.rb +54 -41
- data/lib/rdoc/require.rb +1 -1
- data/lib/rdoc/ri/driver.rb +132 -42
- data/lib/rdoc/ri/formatter.rb +1 -1
- data/lib/rdoc/ri/paths.rb +4 -18
- data/lib/rdoc/ri/store.rb +1 -1
- data/lib/rdoc/ri/task.rb +2 -2
- data/lib/rdoc/ri.rb +1 -1
- data/lib/rdoc/rubygems_hook.rb +3 -3
- data/lib/rdoc/servlet.rb +21 -12
- data/lib/rdoc/single_class.rb +1 -1
- data/lib/rdoc/stats/normal.rb +24 -18
- data/lib/rdoc/stats/quiet.rb +1 -1
- data/lib/rdoc/stats/verbose.rb +1 -1
- data/lib/rdoc/stats.rb +1 -1
- data/lib/rdoc/store.rb +38 -27
- data/lib/rdoc/task.rb +2 -2
- data/lib/rdoc/text.rb +16 -21
- data/lib/rdoc/token_stream.rb +56 -33
- data/lib/rdoc/tom_doc.rb +17 -12
- data/lib/rdoc/top_level.rb +9 -3
- data/lib/rdoc/version.rb +8 -0
- data/lib/rdoc.rb +24 -10
- data/man/ri.1 +247 -0
- data/rdoc.gemspec +206 -15
- metadata +15 -64
- data/.document +0 -5
- data/.gitignore +0 -13
- data/.travis.yml +0 -23
- data/lib/gauntlet_rdoc.rb +0 -82
- data/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -4
- data/lib/rdoc/markup/formatter_test_case.rb +0 -764
- data/lib/rdoc/markup/inline.rb +0 -2
- data/lib/rdoc/markup/special.rb +0 -41
- data/lib/rdoc/markup/text_formatter_test_case.rb +0 -115
- data/lib/rdoc/ruby_lex.rb +0 -1367
- data/lib/rdoc/ruby_token.rb +0 -461
- data/lib/rdoc/test_case.rb +0 -204
data/lib/rdoc/test_case.rb
DELETED
@@ -1,204 +0,0 @@
|
|
1
|
-
# frozen_string_literal: false
|
2
|
-
begin
|
3
|
-
gem 'minitest', '~> 4.0' unless defined?(Test::Unit)
|
4
|
-
rescue NoMethodError, Gem::LoadError
|
5
|
-
# for ruby tests
|
6
|
-
end
|
7
|
-
|
8
|
-
require 'minitest/autorun'
|
9
|
-
require 'minitest/benchmark' if ENV['BENCHMARK']
|
10
|
-
|
11
|
-
require 'fileutils'
|
12
|
-
require 'pp'
|
13
|
-
require 'tempfile'
|
14
|
-
require 'tmpdir'
|
15
|
-
require 'stringio'
|
16
|
-
|
17
|
-
require 'rdoc'
|
18
|
-
|
19
|
-
##
|
20
|
-
# RDoc::TestCase is an abstract TestCase to provide common setup and teardown
|
21
|
-
# across all RDoc tests. The test case uses minitest, so all the assertions
|
22
|
-
# of minitest may be used.
|
23
|
-
#
|
24
|
-
# The testcase provides the following:
|
25
|
-
#
|
26
|
-
# * A reset code-object tree
|
27
|
-
# * A reset markup preprocessor (RDoc::Markup::PreProcess)
|
28
|
-
# * The <code>@RM</code> alias of RDoc::Markup (for less typing)
|
29
|
-
# * <code>@pwd</code> containing the current working directory
|
30
|
-
# * FileUtils, pp, Tempfile, Dir.tmpdir and StringIO
|
31
|
-
|
32
|
-
class RDoc::TestCase < MiniTest::Unit::TestCase
|
33
|
-
|
34
|
-
##
|
35
|
-
# Abstract test-case setup
|
36
|
-
|
37
|
-
def setup
|
38
|
-
super
|
39
|
-
|
40
|
-
@top_level = nil
|
41
|
-
|
42
|
-
@RM = RDoc::Markup
|
43
|
-
|
44
|
-
RDoc::Markup::PreProcess.reset
|
45
|
-
|
46
|
-
@pwd = Dir.pwd
|
47
|
-
|
48
|
-
@store = RDoc::Store.new
|
49
|
-
|
50
|
-
@rdoc = RDoc::RDoc.new
|
51
|
-
@rdoc.store = @store
|
52
|
-
@rdoc.options = RDoc::Options.new
|
53
|
-
|
54
|
-
g = Object.new
|
55
|
-
def g.class_dir() end
|
56
|
-
def g.file_dir() end
|
57
|
-
@rdoc.generator = g
|
58
|
-
end
|
59
|
-
|
60
|
-
##
|
61
|
-
# Asserts +path+ is a file
|
62
|
-
|
63
|
-
def assert_file path
|
64
|
-
assert File.file?(path), "#{path} is not a file"
|
65
|
-
end
|
66
|
-
|
67
|
-
##
|
68
|
-
# Asserts +path+ is a directory
|
69
|
-
|
70
|
-
def assert_directory path
|
71
|
-
assert File.directory?(path), "#{path} is not a directory"
|
72
|
-
end
|
73
|
-
|
74
|
-
##
|
75
|
-
# Refutes +path+ exists
|
76
|
-
|
77
|
-
def refute_file path
|
78
|
-
refute File.exist?(path), "#{path} exists"
|
79
|
-
end
|
80
|
-
|
81
|
-
##
|
82
|
-
# Shortcut for RDoc::Markup::BlankLine.new
|
83
|
-
|
84
|
-
def blank_line
|
85
|
-
@RM::BlankLine.new
|
86
|
-
end
|
87
|
-
|
88
|
-
##
|
89
|
-
# Shortcut for RDoc::Markup::BlockQuote.new with +contents+
|
90
|
-
|
91
|
-
def block *contents
|
92
|
-
@RM::BlockQuote.new(*contents)
|
93
|
-
end
|
94
|
-
|
95
|
-
##
|
96
|
-
# Creates an RDoc::Comment with +text+ which was defined on +top_level+.
|
97
|
-
# By default the comment has the 'rdoc' format.
|
98
|
-
|
99
|
-
def comment text, top_level = @top_level
|
100
|
-
RDoc::Comment.new text, top_level
|
101
|
-
end
|
102
|
-
|
103
|
-
##
|
104
|
-
# Shortcut for RDoc::Markup::Document.new with +contents+
|
105
|
-
|
106
|
-
def doc *contents
|
107
|
-
@RM::Document.new(*contents)
|
108
|
-
end
|
109
|
-
|
110
|
-
##
|
111
|
-
# Shortcut for RDoc::Markup::HardBreak.new
|
112
|
-
|
113
|
-
def hard_break
|
114
|
-
@RM::HardBreak.new
|
115
|
-
end
|
116
|
-
|
117
|
-
##
|
118
|
-
# Shortcut for RDoc::Markup::Heading.new with +level+ and +text+
|
119
|
-
|
120
|
-
def head level, text
|
121
|
-
@RM::Heading.new level, text
|
122
|
-
end
|
123
|
-
|
124
|
-
##
|
125
|
-
# Shortcut for RDoc::Markup::ListItem.new with +label+ and +parts+
|
126
|
-
|
127
|
-
def item label = nil, *parts
|
128
|
-
@RM::ListItem.new label, *parts
|
129
|
-
end
|
130
|
-
|
131
|
-
##
|
132
|
-
# Shortcut for RDoc::Markup::List.new with +type+ and +items+
|
133
|
-
|
134
|
-
def list type = nil, *items
|
135
|
-
@RM::List.new type, *items
|
136
|
-
end
|
137
|
-
|
138
|
-
##
|
139
|
-
# Enables pretty-print output
|
140
|
-
|
141
|
-
def mu_pp obj # :nodoc:
|
142
|
-
s = ''
|
143
|
-
s = PP.pp obj, s
|
144
|
-
s = s.force_encoding Encoding.default_external
|
145
|
-
s.chomp
|
146
|
-
end
|
147
|
-
|
148
|
-
##
|
149
|
-
# Shortcut for RDoc::Markup::Paragraph.new with +contents+
|
150
|
-
|
151
|
-
def para *a
|
152
|
-
@RM::Paragraph.new(*a)
|
153
|
-
end
|
154
|
-
|
155
|
-
##
|
156
|
-
# Shortcut for RDoc::Markup::Rule.new with +weight+
|
157
|
-
|
158
|
-
def rule weight
|
159
|
-
@RM::Rule.new weight
|
160
|
-
end
|
161
|
-
|
162
|
-
##
|
163
|
-
# Shortcut for RDoc::Markup::Raw.new with +contents+
|
164
|
-
|
165
|
-
def raw *contents
|
166
|
-
@RM::Raw.new(*contents)
|
167
|
-
end
|
168
|
-
|
169
|
-
##
|
170
|
-
# Creates a temporary directory changes the current directory to it for the
|
171
|
-
# duration of the block.
|
172
|
-
#
|
173
|
-
# Depends upon Dir.mktmpdir
|
174
|
-
|
175
|
-
def temp_dir
|
176
|
-
Dir.mktmpdir do |temp_dir|
|
177
|
-
Dir.chdir temp_dir do
|
178
|
-
yield temp_dir
|
179
|
-
end
|
180
|
-
end
|
181
|
-
end
|
182
|
-
|
183
|
-
##
|
184
|
-
# Shortcut for RDoc::Markup::Verbatim.new with +parts+
|
185
|
-
|
186
|
-
def verb *parts
|
187
|
-
@RM::Verbatim.new(*parts)
|
188
|
-
end
|
189
|
-
|
190
|
-
##
|
191
|
-
# run capture_io with setting $VERBOSE = true
|
192
|
-
|
193
|
-
def verbose_capture_io
|
194
|
-
capture_io do
|
195
|
-
begin
|
196
|
-
orig_verbose = $VERBOSE
|
197
|
-
$VERBOSE = true
|
198
|
-
yield
|
199
|
-
ensure
|
200
|
-
$VERBOSE = orig_verbose
|
201
|
-
end
|
202
|
-
end
|
203
|
-
end
|
204
|
-
end
|