Skip to content

Fix rubygems hook execution when gemspec.rdoc_options contains --ri #1347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 23, 2025
+20 −5
Merged

Fix rubygems hook execution when gemspec.rdoc_options contains --ri #1347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5a64f4
Fix rubygems hook execution when gemspec.rdoc_options contains --ri
tompng Apr 23, 2025
ca64d7a
Add a comment for the reason of options.dup
tompng Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions lib/rdoc/rubygems_hook.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,18 +182,21 @@ def generate
options.default_title = "#{@spec.full_name} Documentation"
options.parse args
options.quiet = !Gem.configuration.really_verbose
options.finish
end

@rdoc = new_rdoc
@rdoc.options = options

@rdoc.store = RDoc::Store.new(options)

say "Parsing documentation for #{@spec.full_name}"

Dir.chdir @spec.full_gem_path do
@rdoc.parse_files options.files
# RDoc::Options#finish must be called before parse_files.
# RDoc::Options#finish is also called after ri/darkfish generator setup.
# We need to dup the options to avoid modifying it after finish is called.
parse_options = options.dup
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about adding a comment why we need to create a separated options here?

parse_options.finish
@rdoc.options = parse_options
@rdoc.store = RDoc::Store.new(parse_options)
@rdoc.parse_files parse_options.files
end

document 'ri', options, @ri_dir if
Expand Down
12 changes: 12 additions & 0 deletions test/rdoc/test_rdoc_rubygems_hook.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,18 @@ def test_generate_no_overwrite
assert_path_not_exist File.join(@a.doc_dir('ri'), 'cache.ri')
end

def test_generate_with_ri_opt
@a.rdoc_options << '--ri'
FileUtils.mkdir_p @a.doc_dir
FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
@hook.generate_rdoc = true
@hook.generate_ri = true
@hook.generate

assert_path_exist File.join(@a.doc_dir('rdoc'), 'index.html')
assert_path_exist File.join(@a.doc_dir('ri'), 'cache.ri')
end

def test_new_rdoc
assert_kind_of RDoc::RDoc, @hook.new_rdoc
end
Expand Down