Skip to content

Commit 29b8942

Browse files
authored
Fix circular require of RDoc::Parser::RubyColorizer (#1709)
Loading `RubyColorizer` will trigger autoload of `RDoc::Parser`, and `require_relative 'parser/ruby'`. `parser/ruby.rb` shouldn't require `ruby_colorizer.rb` to avoid circular require. Originally found in `rake test` log, but can be reproduced with: ``` $ ruby -W -rrdoc -Ilib -e 'p RDoc::Markup::ToHtml' warning: loading in progress, circular require considered harmful ```
1 parent 4d6b725 commit 29b8942

4 files changed

Lines changed: 2 additions & 4 deletions

File tree

lib/rdoc/markup/to_html.rb

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
require 'cgi/escape'
33
require 'cgi/util' unless defined?(CGI::EscapeExt)
44
require 'prism'
5-
require 'rdoc/parser/ruby_colorizer'
65

76
##
87
# Outputs RDoc markup as HTML.

lib/rdoc/parser.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,5 +293,5 @@ def handle_tab_width(body)
293293
require_relative 'parser/changelog'
294294
require_relative 'parser/markdown'
295295
require_relative 'parser/rd'
296-
297296
require_relative 'parser/ruby'
297+
require_relative 'parser/ruby_colorizer'

lib/rdoc/parser/ruby.rb

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# frozen_string_literal: true
22

33
require 'prism'
4-
require_relative 'ruby_colorizer'
54

65
# Parse and collect document from Ruby source code.
76

test/rdoc/parser/ruby_colorizer_test.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# frozen_string_literal: true
22
require_relative '../helper'
3-
require 'rdoc/parser/ruby_colorizer'
3+
require 'prism'
44

55
class RDocParserRubyColorizerTest < RDoc::TestCase
66
def token(kind, text)

0 commit comments

Comments
 (0)