Make Options a required constructor argument of Store

[st0012]

Since Store relies on accessing Options for various tasks, it should simply hold a reference to the Options object itself, instead of accessing it through an RDoc instance and forming an unnecessary coupling.

This PR requires Store to be initialized with an Options instance.

[kou]

+1

Can we move

rdoc/lib/rdoc/rdoc.rb

Lines 472 to 476 in c809ba8

	@store.encoding = @options.encoding
	@store.dry_run = @options.dry_run
	@store.main = @options.main_page
	@store.title = @options.title
	@store.path = @options.op_dir

to Store?

[cloudflare-workers-and-pages]

Deploying rdoc with    Cloudflare Pages

Latest commit:	a68dfb5
Status:	✅  Deploy successful!
Preview URL:	https://d49372c5.rdoc-6cd.pages.dev
Branch Preview URL:	https://decouple-store-and-rdoc.rdoc-6cd.pages.dev

View logs

[st0012]

@kou Updated 👍

[kou]

+1

[jonathanhefner]

Hello, again! 👋 This is a breaking change for SDoc. As part of a performance optimization for its test suite, SDoc manually constructs fresh RDoc::Store instances. The new signature of RDoc::Store#initialize breaks RDoc::Store.new().

RDoc::Store#initialize appears to be a documented public API. Is that accurate?

[st0012]

It's unfortunate that it added additional effort to upgrade, but I don't consider Store part of the official API. In fact, the only public components are probably RDoc::RDoc, RDoc::Options, and some of the Darkfish APIs.
As you probably are aware, RDoc is a legacy codebase and if we consider everything that's been documented as public, then it will take forever to improve its codebase enough to clear the ever-growing features backlog.

[mullermp]

I ran into an issue with this change as well. I was using RDoc to parse documentation for an rspec matcher. I'm not sure if I am using it correctly, maybe I can get some guidance? I'm doing something like this now:

RSpec::Matchers.define :be_in_documentation do |file, klass, method|
  match do |expected|
    rdoc = RDoc::RDoc.new
    options = RDoc::Options.load_options
    rdoc.options = options
    rdoc.store = RDoc::Store.new(options)
    top_level = rdoc.parse_files([file]).first
    documentation = top_level.find_class_or_module(klass)
    documentation = documentation.find_method_named(method) if method
    @actual = documentation.comment.text
    @expected = expected.chomp
    expect(@actual).to include(@expected)
  end

  failure_message do
    differ = RSpec::Support::Differ.new
    differ.diff(@actual, @expected)
  end
end