rdoc 5.1.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 +4 -4
- data/README.rdoc +5 -6
- data/Rakefile +35 -67
- 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 +63 -20
- 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 +6 -3
- 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 +1 -1
- 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 +68 -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 +632 -466
- 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 +9 -34
- data/lib/rdoc/rd/block_parser.rb +47 -46
- data/lib/rdoc/rd/block_parser.ry +2 -2
- data/lib/rdoc/rd/inline.rb +5 -5
- data/lib/rdoc/rd/inline_parser.rb +139 -138
- 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 -24
- 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/options.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# frozen_string_literal:
|
1
|
+
# frozen_string_literal: true
|
2
2
|
require 'optparse'
|
3
3
|
require 'pathname'
|
4
4
|
|
@@ -164,7 +164,7 @@ class RDoc::Options
|
|
164
164
|
##
|
165
165
|
# Files matching this pattern will be excluded
|
166
166
|
|
167
|
-
|
167
|
+
attr_writer :exclude
|
168
168
|
|
169
169
|
##
|
170
170
|
# The list of files to be processed
|
@@ -338,13 +338,17 @@ class RDoc::Options
|
|
338
338
|
|
339
339
|
attr_reader :visibility
|
340
340
|
|
341
|
-
def initialize # :nodoc:
|
341
|
+
def initialize loaded_options = nil # :nodoc:
|
342
342
|
init_ivars
|
343
|
+
override loaded_options if loaded_options
|
343
344
|
end
|
344
345
|
|
345
346
|
def init_ivars # :nodoc:
|
346
347
|
@dry_run = false
|
347
|
-
@exclude = [
|
348
|
+
@exclude = %w[
|
349
|
+
~\z \.orig\z \.rej\z \.bak\z
|
350
|
+
\.gemspec\z
|
351
|
+
]
|
348
352
|
@files = nil
|
349
353
|
@force_output = false
|
350
354
|
@force_update = true
|
@@ -414,6 +418,37 @@ class RDoc::Options
|
|
414
418
|
init_with map
|
415
419
|
end
|
416
420
|
|
421
|
+
def override map # :nodoc:
|
422
|
+
if map.has_key?('encoding')
|
423
|
+
encoding = map['encoding']
|
424
|
+
@encoding = encoding ? Encoding.find(encoding) : encoding
|
425
|
+
end
|
426
|
+
|
427
|
+
@charset = map['charset'] if map.has_key?('charset')
|
428
|
+
@exclude = map['exclude'] if map.has_key?('exclude')
|
429
|
+
@generator_name = map['generator_name'] if map.has_key?('generator_name')
|
430
|
+
@hyperlink_all = map['hyperlink_all'] if map.has_key?('hyperlink_all')
|
431
|
+
@line_numbers = map['line_numbers'] if map.has_key?('line_numbers')
|
432
|
+
@locale_name = map['locale_name'] if map.has_key?('locale_name')
|
433
|
+
@locale_dir = map['locale_dir'] if map.has_key?('locale_dir')
|
434
|
+
@main_page = map['main_page'] if map.has_key?('main_page')
|
435
|
+
@markup = map['markup'] if map.has_key?('markup')
|
436
|
+
@op_dir = map['op_dir'] if map.has_key?('op_dir')
|
437
|
+
@show_hash = map['show_hash'] if map.has_key?('show_hash')
|
438
|
+
@tab_width = map['tab_width'] if map.has_key?('tab_width')
|
439
|
+
@template_dir = map['template_dir'] if map.has_key?('template_dir')
|
440
|
+
@title = map['title'] if map.has_key?('title')
|
441
|
+
@visibility = map['visibility'] if map.has_key?('visibility')
|
442
|
+
@webcvs = map['webcvs'] if map.has_key?('webcvs')
|
443
|
+
|
444
|
+
if map.has_key?('rdoc_include')
|
445
|
+
@rdoc_include = sanitize_path map['rdoc_include']
|
446
|
+
end
|
447
|
+
if map.has_key?('static_path')
|
448
|
+
@static_path = sanitize_path map['static_path']
|
449
|
+
end
|
450
|
+
end
|
451
|
+
|
417
452
|
def == other # :nodoc:
|
418
453
|
self.class === other and
|
419
454
|
@encoding == other.encoding and
|
@@ -493,6 +528,20 @@ class RDoc::Options
|
|
493
528
|
end
|
494
529
|
end
|
495
530
|
|
531
|
+
##
|
532
|
+
# Create a regexp for #exclude
|
533
|
+
|
534
|
+
def exclude
|
535
|
+
if @exclude.nil? or Regexp === @exclude then
|
536
|
+
# done, #finish is being re-run
|
537
|
+
@exclude
|
538
|
+
elsif @exclude.empty? then
|
539
|
+
nil
|
540
|
+
else
|
541
|
+
Regexp.new(@exclude.join("|"))
|
542
|
+
end
|
543
|
+
end
|
544
|
+
|
496
545
|
##
|
497
546
|
# Completes any unfinished option setup business such as filtering for
|
498
547
|
# existent files, creating a regexp for #exclude and setting a default
|
@@ -505,13 +554,7 @@ class RDoc::Options
|
|
505
554
|
root = @root.to_s
|
506
555
|
@rdoc_include << root unless @rdoc_include.include?(root)
|
507
556
|
|
508
|
-
|
509
|
-
# done, #finish is being re-run
|
510
|
-
elsif @exclude.empty? then
|
511
|
-
@exclude = nil
|
512
|
-
else
|
513
|
-
@exclude = Regexp.new(@exclude.join("|"))
|
514
|
-
end
|
557
|
+
@exclude = self.exclude
|
515
558
|
|
516
559
|
finish_page_dir
|
517
560
|
|
@@ -544,7 +587,13 @@ class RDoc::Options
|
|
544
587
|
|
545
588
|
@files << @page_dir.to_s
|
546
589
|
|
547
|
-
page_dir =
|
590
|
+
page_dir = nil
|
591
|
+
begin
|
592
|
+
page_dir = @page_dir.expand_path.relative_path_from @root
|
593
|
+
rescue ArgumentError
|
594
|
+
# On Windows, sometimes crosses different drive letters.
|
595
|
+
page_dir = @page_dir.expand_path
|
596
|
+
end
|
548
597
|
|
549
598
|
@page_dir = page_dir
|
550
599
|
end
|
@@ -624,16 +673,16 @@ Usage: #{opt.program_name} [options] [names...]
|
|
624
673
|
end
|
625
674
|
|
626
675
|
parsers.sort.each do |parser, regexp|
|
627
|
-
opt.banner
|
676
|
+
opt.banner += " - #{parser}: #{regexp.join ', '}\n"
|
628
677
|
end
|
629
|
-
opt.banner
|
678
|
+
opt.banner += " - TomDoc: Only in ruby files\n"
|
630
679
|
|
631
|
-
opt.banner
|
680
|
+
opt.banner += "\n The following options are deprecated:\n\n"
|
632
681
|
|
633
682
|
name_length = DEPRECATED.keys.sort_by { |k| k.length }.last.length
|
634
683
|
|
635
684
|
DEPRECATED.sort_by { |k,| k }.each do |name, reason|
|
636
|
-
opt.banner
|
685
|
+
opt.banner += " %*1$2$s %3$s\n" % [-name_length, name, reason]
|
637
686
|
end
|
638
687
|
|
639
688
|
opt.accept Template do |template|
|
@@ -738,7 +787,7 @@ Usage: #{opt.program_name} [options] [names...]
|
|
738
787
|
|
739
788
|
opt.on("--[no-]force-update", "-U",
|
740
789
|
"Forces rdoc to scan all sources even if",
|
741
|
-
"newer than the flag file.") do |value|
|
790
|
+
"no files are newer than the flag file.") do |value|
|
742
791
|
@force_update = value
|
743
792
|
end
|
744
793
|
|
@@ -1087,7 +1136,7 @@ Usage: #{opt.program_name} [options] [names...]
|
|
1087
1136
|
|
1088
1137
|
unless quiet then
|
1089
1138
|
deprecated.each do |opt|
|
1090
|
-
$stderr.puts 'option '
|
1139
|
+
$stderr.puts 'option ' + opt + ' is deprecated: ' + DEPRECATED[opt]
|
1091
1140
|
end
|
1092
1141
|
end
|
1093
1142
|
|
@@ -1143,8 +1192,17 @@ Usage: #{opt.program_name} [options] [names...]
|
|
1143
1192
|
|
1144
1193
|
path.reject do |item|
|
1145
1194
|
path = Pathname.new(item).expand_path
|
1146
|
-
|
1147
|
-
relative
|
1195
|
+
is_reject = nil
|
1196
|
+
relative = nil
|
1197
|
+
begin
|
1198
|
+
relative = path.relative_path_from(dot).to_s
|
1199
|
+
rescue ArgumentError
|
1200
|
+
# On Windows, sometimes crosses different drive letters.
|
1201
|
+
is_reject = true
|
1202
|
+
else
|
1203
|
+
is_reject = relative.start_with? '..'
|
1204
|
+
end
|
1205
|
+
is_reject
|
1148
1206
|
end
|
1149
1207
|
end
|
1150
1208
|
|
@@ -1217,7 +1275,7 @@ Usage: #{opt.program_name} [options] [names...]
|
|
1217
1275
|
def write_options
|
1218
1276
|
RDoc.load_yaml
|
1219
1277
|
|
1220
|
-
open '.rdoc_options', 'w' do |io|
|
1278
|
+
File.open '.rdoc_options', 'w' do |io|
|
1221
1279
|
io.set_encoding Encoding::UTF_8
|
1222
1280
|
|
1223
1281
|
YAML.dump self, io
|