rdoc 6.5.0 → 6.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/README.rdoc +2 -2
  3. data/TODO.rdoc +1 -1
  4. data/lib/rdoc/alias.rb +0 -1
  5. data/lib/rdoc/anon_class.rb +0 -1
  6. data/lib/rdoc/any_method.rb +15 -0
  7. data/lib/rdoc/attr.rb +0 -1
  8. data/lib/rdoc/class_module.rb +0 -1
  9. data/lib/rdoc/comment.rb +20 -41
  10. data/lib/rdoc/constant.rb +0 -1
  11. data/lib/rdoc/context/section.rb +0 -1
  12. data/lib/rdoc/cross_reference.rb +0 -1
  13. data/lib/rdoc/encoding.rb +1 -6
  14. data/lib/rdoc/erb_partial.rb +0 -1
  15. data/lib/rdoc/erbio.rb +2 -7
  16. data/lib/rdoc/extend.rb +0 -1
  17. data/lib/rdoc/generator/darkfish.rb +2 -6
  18. data/lib/rdoc/generator/json_index.rb +2 -2
  19. data/lib/rdoc/generator/markup.rb +0 -1
  20. data/lib/rdoc/generator/ri.rb +0 -1
  21. data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +1 -1
  22. data/lib/rdoc/generator/template/darkfish/class.rhtml +6 -0
  23. data/lib/rdoc/generator/template/darkfish/css/rdoc.css +27 -13
  24. data/lib/rdoc/generator/template/darkfish/js/darkfish.js +13 -0
  25. data/lib/rdoc/generator/template/darkfish/js/search.js +3 -3
  26. data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +5 -4
  27. data/lib/rdoc/generator/template/json_index/js/navigation.js +8 -8
  28. data/lib/rdoc/ghost_method.rb +0 -1
  29. data/lib/rdoc/include.rb +0 -1
  30. data/lib/rdoc/markdown/entities.rb +0 -1
  31. data/lib/rdoc/markdown/literals.rb +91 -49
  32. data/lib/rdoc/markdown.kpeg +1 -1
  33. data/lib/rdoc/markdown.rb +3 -1
  34. data/lib/rdoc/markup/attr_changer.rb +0 -1
  35. data/lib/rdoc/markup/attr_span.rb +0 -1
  36. data/lib/rdoc/markup/attribute_manager.rb +11 -12
  37. data/lib/rdoc/markup/attributes.rb +0 -1
  38. data/lib/rdoc/markup/blank_line.rb +0 -1
  39. data/lib/rdoc/markup/block_quote.rb +0 -1
  40. data/lib/rdoc/markup/document.rb +0 -1
  41. data/lib/rdoc/markup/formatter.rb +0 -1
  42. data/lib/rdoc/markup/hard_break.rb +0 -1
  43. data/lib/rdoc/markup/heading.rb +0 -1
  44. data/lib/rdoc/markup/include.rb +0 -1
  45. data/lib/rdoc/markup/indented_paragraph.rb +0 -1
  46. data/lib/rdoc/markup/list.rb +0 -1
  47. data/lib/rdoc/markup/list_item.rb +0 -1
  48. data/lib/rdoc/markup/paragraph.rb +0 -1
  49. data/lib/rdoc/markup/raw.rb +0 -1
  50. data/lib/rdoc/markup/regexp_handling.rb +0 -1
  51. data/lib/rdoc/markup/rule.rb +0 -1
  52. data/lib/rdoc/markup/to_ansi.rb +0 -1
  53. data/lib/rdoc/markup/to_html.rb +3 -2
  54. data/lib/rdoc/markup/to_html_crossref.rb +0 -1
  55. data/lib/rdoc/markup/to_html_snippet.rb +0 -1
  56. data/lib/rdoc/markup/to_joined_paragraph.rb +2 -3
  57. data/lib/rdoc/markup/to_label.rb +0 -1
  58. data/lib/rdoc/markup/to_markdown.rb +0 -1
  59. data/lib/rdoc/markup/to_rdoc.rb +0 -1
  60. data/lib/rdoc/markup/to_table_of_contents.rb +0 -1
  61. data/lib/rdoc/markup/to_test.rb +0 -1
  62. data/lib/rdoc/markup/to_tt_only.rb +0 -1
  63. data/lib/rdoc/markup/verbatim.rb +0 -1
  64. data/lib/rdoc/meta_method.rb +0 -1
  65. data/lib/rdoc/method_attr.rb +0 -1
  66. data/lib/rdoc/mixin.rb +0 -1
  67. data/lib/rdoc/normal_class.rb +0 -1
  68. data/lib/rdoc/normal_module.rb +0 -1
  69. data/lib/rdoc/options.rb +3 -2
  70. data/lib/rdoc/parser/changelog.rb +0 -1
  71. data/lib/rdoc/parser/markdown.rb +0 -2
  72. data/lib/rdoc/parser/rd.rb +0 -1
  73. data/lib/rdoc/parser/ripper_state_lex.rb +1 -1
  74. data/lib/rdoc/parser/ruby.rb +4 -4
  75. data/lib/rdoc/parser/ruby_tools.rb +0 -2
  76. data/lib/rdoc/parser/text.rb +0 -1
  77. data/lib/rdoc/rd/block_parser.rb +654 -4
  78. data/lib/rdoc/rd/block_parser.ry +1 -1
  79. data/lib/rdoc/rd/inline.rb +0 -1
  80. data/lib/rdoc/rd/inline_parser.rb +3 -1
  81. data/lib/rdoc/rdoc.rb +2 -4
  82. data/lib/rdoc/require.rb +0 -1
  83. data/lib/rdoc/ri/driver.rb +9 -8
  84. data/lib/rdoc/ri/store.rb +0 -1
  85. data/lib/rdoc/single_class.rb +0 -1
  86. data/lib/rdoc/stats/quiet.rb +0 -1
  87. data/lib/rdoc/stats/verbose.rb +0 -2
  88. data/lib/rdoc/task.rb +28 -2
  89. data/lib/rdoc/token_stream.rb +0 -1
  90. data/lib/rdoc/top_level.rb +0 -1
  91. data/lib/rdoc/version.rb +1 -1
  92. metadata +8 -5
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # DO NOT MODIFY!!!!
4
- # This file is automatically generated by Racc 1.6.0
4
+ # This file is automatically generated by Racc 1.7.1
5
5
  # from Racc grammar file "".
6
6
  #
7
7
 
@@ -652,6 +652,7 @@ Racc_arg = [
652
652
  racc_shift_n,
653
653
  racc_reduce_n,
654
654
  racc_use_result_var ]
655
+ Ractor.make_shareable(Racc_arg) if defined?(Ractor)
655
656
 
656
657
  Racc_token_to_s_table = [
657
658
  "$end",
@@ -723,6 +724,7 @@ Racc_token_to_s_table = [
723
724
  "normal_strings",
724
725
  "verb_string",
725
726
  "verb_normal_string" ]
727
+ Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
726
728
 
727
729
  Racc_debug_parser = false
728
730
 
data/lib/rdoc/rdoc.rb CHANGED
@@ -119,7 +119,7 @@ class RDoc::RDoc
119
119
  # +files+.
120
120
 
121
121
  def gather_files files
122
- files = ["."] if files.empty?
122
+ files = [@options.root.to_s] if files.empty?
123
123
 
124
124
  file_list = normalized_file_list files, true, @options.exclude
125
125
 
@@ -429,9 +429,7 @@ The internal error was:
429
429
  files.reject do |file, *|
430
430
  file =~ /\.(?:class|eps|erb|scpt\.txt|svg|ttf|yml)$/i or
431
431
  (file =~ /tags$/i and
432
- File.open(file, 'rb') { |io|
433
- io.read(100) =~ /\A(\f\n[^,]+,\d+$|!_TAG_)/
434
- })
432
+ /\A(\f\n[^,]+,\d+$|!_TAG_)/.match?(File.binread(file, 100)))
435
433
  end
436
434
  end
437
435
 
data/lib/rdoc/require.rb CHANGED
@@ -49,4 +49,3 @@ class RDoc::Require < RDoc::CodeObject
49
49
  end
50
50
 
51
51
  end
52
-
@@ -34,9 +34,9 @@ class RDoc::RI::Driver
34
34
 
35
35
  class NotFoundError < Error
36
36
 
37
- def initialize(klass, suggestions = nil) # :nodoc:
37
+ def initialize(klass, suggestion_proc = nil) # :nodoc:
38
38
  @klass = klass
39
- @suggestions = suggestions
39
+ @suggestion_proc = suggestion_proc
40
40
  end
41
41
 
42
42
  ##
@@ -48,8 +48,9 @@ class RDoc::RI::Driver
48
48
 
49
49
  def message # :nodoc:
50
50
  str = "Nothing known about #{@klass}"
51
- if @suggestions and !@suggestions.empty?
52
- str += "\nDid you mean? #{@suggestions.join("\n ")}"
51
+ suggestions = @suggestion_proc&.call
52
+ if suggestions and !suggestions.empty?
53
+ str += "\nDid you mean? #{suggestions.join("\n ")}"
53
54
  end
54
55
  str
55
56
  end
@@ -948,8 +949,8 @@ or the PAGER environment variable.
948
949
  ary = class_names.grep(Regexp.new("\\A#{klass.gsub(/(?=::|\z)/, '[^:]*')}\\z"))
949
950
  if ary.length != 1 && ary.first != klass
950
951
  if check_did_you_mean
951
- suggestions = DidYouMean::SpellChecker.new(dictionary: class_names).correct(klass)
952
- raise NotFoundError.new(klass, suggestions)
952
+ suggestion_proc = -> { DidYouMean::SpellChecker.new(dictionary: class_names).correct(klass) }
953
+ raise NotFoundError.new(klass, suggestion_proc)
953
954
  else
954
955
  raise NotFoundError, klass
955
956
  end
@@ -1237,8 +1238,8 @@ or the PAGER environment variable.
1237
1238
  methods.push(*store.instance_methods[klass]) if [:instance, :both].include? types
1238
1239
  end
1239
1240
  methods = methods.uniq
1240
- suggestions = DidYouMean::SpellChecker.new(dictionary: methods).correct(method_name)
1241
- raise NotFoundError.new(name, suggestions)
1241
+ suggestion_proc = -> { DidYouMean::SpellChecker.new(dictionary: methods).correct(method_name) }
1242
+ raise NotFoundError.new(name, suggestion_proc)
1242
1243
  else
1243
1244
  raise NotFoundError, name
1244
1245
  end
data/lib/rdoc/ri/store.rb CHANGED
@@ -4,4 +4,3 @@ module RDoc::RI
4
4
  Store = RDoc::Store # :nodoc:
5
5
 
6
6
  end
7
-
@@ -28,4 +28,3 @@ class RDoc::SingleClass < RDoc::ClassModule
28
28
  end
29
29
  end
30
30
  end
31
-
@@ -57,4 +57,3 @@ class RDoc::Stats::Quiet
57
57
  def done_adding(*) end
58
58
 
59
59
  end
60
-
@@ -42,5 +42,3 @@ class RDoc::Stats::Verbose < RDoc::Stats::Normal
42
42
  end
43
43
 
44
44
  end
45
-
46
-
data/lib/rdoc/task.rb CHANGED
@@ -50,6 +50,9 @@ require 'rake/tasklib'
50
50
  # [rerdoc]
51
51
  # Rebuild the rdoc files from scratch, even if they are not out of date.
52
52
  #
53
+ # [rdoc:coverage]
54
+ # Print RDoc coverage report for all rdoc files.
55
+ #
53
56
  # Simple Example:
54
57
  #
55
58
  # require 'rdoc/task'
@@ -90,8 +93,8 @@ require 'rake/tasklib'
90
93
  # RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
91
94
  # :rerdoc => "rdoc:force")
92
95
  #
93
- # This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt> and
94
- # <tt>:rdoc:force</tt>.
96
+ # This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt>,
97
+ # <tt>:rdoc:force</tt>, and <tt>:rdoc:coverage</tt>.
95
98
 
96
99
  class RDoc::Task < Rake::TaskLib
97
100
 
@@ -248,6 +251,18 @@ class RDoc::Task < Rake::TaskLib
248
251
  RDoc::RDoc.new.document args
249
252
  end
250
253
 
254
+ namespace rdoc_task_name do
255
+ desc coverage_task_description
256
+ task coverage_task_name do
257
+ @before_running_rdoc.call if @before_running_rdoc
258
+ opts = option_list << "-C"
259
+ args = opts + @rdoc_files
260
+
261
+ $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
262
+ RDoc::RDoc.new.document args
263
+ end
264
+ end
265
+
251
266
  self
252
267
  end
253
268
 
@@ -288,6 +303,13 @@ class RDoc::Task < Rake::TaskLib
288
303
  "Rebuild RDoc HTML files"
289
304
  end
290
305
 
306
+ ##
307
+ # Task description for the coverage task or its renamed description
308
+
309
+ def coverage_task_description
310
+ "Print RDoc coverage report"
311
+ end
312
+
291
313
  private
292
314
 
293
315
  def rdoc_target
@@ -315,6 +337,10 @@ class RDoc::Task < Rake::TaskLib
315
337
  end
316
338
  end
317
339
 
340
+ def coverage_task_name
341
+ "coverage"
342
+ end
343
+
318
344
  end
319
345
 
320
346
  # :stopdoc:
@@ -116,4 +116,3 @@ module RDoc::TokenStream
116
116
  end
117
117
 
118
118
  end
119
-
@@ -286,4 +286,3 @@ class RDoc::TopLevel < RDoc::Context
286
286
  end
287
287
 
288
288
  end
289
-
data/lib/rdoc/version.rb CHANGED
@@ -5,6 +5,6 @@ module RDoc
5
5
  ##
6
6
  # RDoc version you are using
7
7
 
8
- VERSION = '6.5.0'
8
+ VERSION = '6.6.0'
9
9
 
10
10
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rdoc
3
3
  version: !ruby/object:Gem::Version
4
- version: 6.5.0
4
+ version: 6.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Eric Hodel
@@ -14,7 +14,7 @@ authors:
14
14
  autorequire:
15
15
  bindir: exe
16
16
  cert_chain: []
17
- date: 2022-12-05 00:00:00.000000000 Z
17
+ date: 2023-11-06 00:00:00.000000000 Z
18
18
  dependencies:
19
19
  - !ruby/object:Gem::Dependency
20
20
  name: psych
@@ -249,7 +249,10 @@ files:
249
249
  homepage: https://ruby.github.io/rdoc
250
250
  licenses:
251
251
  - Ruby
252
- metadata: {}
252
+ metadata:
253
+ homepage_uri: https://ruby.github.io/rdoc
254
+ source_code_uri: https://github.com/ruby/rdoc
255
+ changelog_uri: https://github.com/ruby/rdoc/releases
253
256
  post_install_message:
254
257
  rdoc_options:
255
258
  - "--main"
@@ -260,14 +263,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
260
263
  requirements:
261
264
  - - ">="
262
265
  - !ruby/object:Gem::Version
263
- version: 2.5.0
266
+ version: 2.6.0
264
267
  required_rubygems_version: !ruby/object:Gem::Requirement
265
268
  requirements:
266
269
  - - ">="
267
270
  - !ruby/object:Gem::Version
268
271
  version: '2.2'
269
272
  requirements: []
270
- rubygems_version: 3.4.0.dev
273
+ rubygems_version: 3.5.0.dev
271
274
  signing_key:
272
275
  specification_version: 4
273
276
  summary: RDoc produces HTML and command-line documentation for Ruby projects