Make Options a required constructor argument of Store (#1309)

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.

---------

Co-authored-by: Sutou Kouhei <[email protected]>

Author: st0012

lib/rdoc/rdoc.rb

@@ -69,7 +69,7 @@ class RDoc::RDoc
   ##
   # The current documentation store
 
-  attr_reader :store
+  attr_accessor :store
 
   ##
   # Add +klass+ that can generate output after parsing
@@ -208,15 +208,6 @@ def setup_output_dir(dir, force)
     last
   end
 
-  ##
-  # Sets the current documentation tree to +store+ and sets the store's rdoc
-  # driver to this instance.
-
-  def store= store
-    @store = store
-    @store.rdoc = self
-  end
-
   ##
   # Update the flag file in an output directory.
 
@@ -450,8 +441,6 @@ def remove_unparseable files
   # current directory, so make sure you're somewhere writable before invoking.
 
   def document options
-    self.store = RDoc::Store.new
-
     if RDoc::Options === options then
       @options = options
     else
@@ -460,6 +449,8 @@ def document options
     end
     @options.finish
 
+    @store = RDoc::Store.new(@options)
+
     if @options.pipe then
       handle_pipe
       exit
@@ -469,12 +460,6 @@ def document options
       @last_modified = setup_output_dir @options.op_dir, @options.force_update
     end
 
-    @store.encoding = @options.encoding
-    @store.dry_run  = @options.dry_run
-    @store.main     = @options.main_page
-    @store.title    = @options.title
-    @store.path     = @options.op_dir
-
     @start_time = Time.now
 
     @store.load_cache

lib/rdoc/ri/driver.rb

@@ -420,7 +420,7 @@ def initialize initial_options = {}
                          *options[:extra_doc_dirs]) do |path, type|
       @doc_dirs << path
 
-      store = RDoc::RI::Store.new path, type
+      store = RDoc::RI::Store.new(RDoc::Options.new, path: path, type: type)
       store.load_cache
       @stores << store
     end

lib/rdoc/rubygems_hook.rb

@@ -188,13 +188,7 @@ def generate
     @rdoc = new_rdoc
     @rdoc.options = options
 
-    store = RDoc::Store.new
-    store.encoding = options.encoding
-    store.dry_run  = options.dry_run
-    store.main     = options.main_page
-    store.title    = options.title
-
-    @rdoc.store = store
+    @rdoc.store = RDoc::Store.new(options)
 
     say "Parsing documentation for #{@spec.full_name}"
 

lib/rdoc/servlet.rb

@@ -133,7 +133,7 @@ def do_GET req, res
       show_documentation req, res
     end
   rescue WEBrick::HTTPStatus::NotFound => e
-    generator = generator_for RDoc::Store.new
+    generator = generator_for RDoc::Store.new(@options)
 
     not_found generator, req, res, e.message
   rescue WEBrick::HTTPStatus::Status
@@ -291,7 +291,7 @@ def if_modified_since req, res, path = nil
   def installed_docs
     extra_counter = 0
     ri_paths.map do |path, type|
-      store = RDoc::Store.new path, type
+      store = RDoc::Store.new(@options, path: path, type: type)
       exists = File.exist? store.cache_path
 
       case type
@@ -420,15 +420,15 @@ def show_documentation req, res
   def store_for source_name
     case source_name
     when 'home' then
-      RDoc::Store.new RDoc::RI::Paths.home_dir, :home
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.home_dir, type: :home)
     when 'ruby' then
-      RDoc::Store.new RDoc::RI::Paths.system_dir, :system
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.system_dir, type: :system)
     when 'site' then
-      RDoc::Store.new RDoc::RI::Paths.site_dir, :site
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.site_dir, type: :site)
     when /\Aextra-(\d+)\z/ then
       index = $1.to_i - 1
       ri_dir = installed_docs[index][4]
-      RDoc::Store.new ri_dir, :extra
+      RDoc::Store.new(@options, path: ri_dir, type: :extra)
     else
       ri_dir, type = ri_paths.find do |dir, dir_type|
         next unless dir_type == :gem
@@ -439,7 +439,7 @@ def store_for source_name
       raise WEBrick::HTTPStatus::NotFound,
             "Could not find gem \"#{ERB::Util.html_escape(source_name)}\". Are you sure you installed it?" unless ri_dir
 
-      store = RDoc::Store.new ri_dir, type
+      store = RDoc::Store.new(@options, path: ri_dir, type: type)
 
       return store if File.exist? store.cache_path
 

lib/rdoc/store.rb

@@ -94,7 +94,7 @@ def message # :nodoc:
 
   attr_accessor :path
 
-  attr_writer :rdoc
+  attr_reader :options
 
   ##
   # Type of ri datastore this was loaded from.  See RDoc::RI::Driver,
@@ -120,11 +120,11 @@ def message # :nodoc:
   ##
   # Creates a new Store of +type+ that will load or save to +path+
 
-  def initialize path = nil, type = nil
-    @dry_run  = false
-    @encoding = nil
-    @path     = path
-    @rdoc     = nil
+  def initialize(options, path: nil, type: nil)
+    @options  = options
+    @dry_run  = options.dry_run
+    @encoding = options.encoding
+    @path     = path || options.op_dir
     @type     = type
 
     @cache = {
@@ -135,10 +135,10 @@ def initialize path = nil, type = nil
       :c_singleton_class_variables => {},
       :encoding                    => @encoding,
       :instance_methods            => {},
-      :main                        => nil,
+      :main                        => options.main_page,
       :modules                     => [],
       :pages                       => [],
-      :title                       => nil,
+      :title                       => options.title,
     }
 
     @classes_hash = {}
@@ -977,10 +977,6 @@ def unique_modules
     @unique_modules
   end
 
-  def options
-    @rdoc&.options
-  end
-
   private
   def marshal_load(file)
     File.open(file, 'rb') {|io| Marshal.load(io, MarshalFilter)}

test/rdoc/support/test_case.rb

@@ -47,11 +47,12 @@ def setup
 
     @pwd = Dir.pwd
 
-    @store = RDoc::Store.new
+    @options = RDoc::Options.new
+    @store = RDoc::Store.new(@options)
 
     @rdoc = RDoc::RDoc.new
     @rdoc.store = @store
-    @rdoc.options = RDoc::Options.new
+    @rdoc.options = @options
 
     @rdoc.generator = Object.new
 

test/rdoc/test_rdoc_any_method.rb

@@ -180,7 +180,7 @@ def test_markup_code_with_line_numbers
 <span class="ruby-constant">B</span>
     EXPECTED
 
-    @options.line_numbers = true
+    @c2_a.options.line_numbers = true
     assert_equal <<-EXPECTED.chomp, @c2_a.markup_code
   <span class="ruby-comment"># File xref_data.rb</span>
 <span class="line-num">1</span> <span class="ruby-constant">A</span>

test/rdoc/test_rdoc_class_module.rb

@@ -791,7 +791,7 @@ def test_merge_constants
     const = cm1.add_constant RDoc::Constant.new('C3', nil, 'one')
     const.record_location tl1
 
-    store = RDoc::Store.new
+    store = RDoc::Store.new(RDoc::Options.new)
     tl = store.add_file 'one.rb'
     cm2 = tl.add_class RDoc::ClassModule, 'Klass'
     cm2.instance_variable_set :@comment, @RM::Document.new
@@ -826,7 +826,7 @@ def test_merge_constants_version_0
     const = cm1.add_constant RDoc::Constant.new('C3', nil, 'one')
     const.record_location tl1
 
-    store = RDoc::Store.new
+    store = RDoc::Store.new(RDoc::Options.new)
     tl = store.add_file 'one.rb'
     cm2 = tl.add_class RDoc::ClassModule, 'Klass'
     cm2.instance_variable_set :@comment, @RM::Document.new
@@ -859,7 +859,7 @@ def test_merge_extends
     ext.record_location tl1
 
     tl2 = @store.add_file 'two.rb'
-    tl2.store = RDoc::Store.new
+    tl2.store = RDoc::Store.new(RDoc::Options.new)
 
     cm2 = tl2.add_class RDoc::ClassModule, 'Klass'
     cm2.instance_variable_set :@comment, @RM::Document.new
@@ -895,7 +895,7 @@ def test_merge_includes
     incl.record_location tl1
 
     tl2 = @store.add_file 'two.rb'
-    tl2.store = RDoc::Store.new
+    tl2.store = RDoc::Store.new(RDoc::Options.new)
 
     cm2 = tl2.add_class RDoc::ClassModule, 'Klass'
     cm2.instance_variable_set :@comment, @RM::Document.new
@@ -931,7 +931,7 @@ def test_merge_includes_version_0
     incl.record_location tl1
 
     tl2 = @store.add_file 'one.rb'
-    tl2.store = RDoc::Store.new
+    tl2.store = RDoc::Store.new(RDoc::Options.new)
 
     cm2 = tl2.add_class RDoc::ClassModule, 'Klass'
     cm2.instance_variable_set :@comment, @RM::Document.new
@@ -1034,7 +1034,7 @@ def test_merge_sections
            cm1.add_section 'section 2', comment('comment 2 a', tl1_1)
            cm1.add_section 'section 4', comment('comment 4 a', tl1_1)
 
-    store2 = RDoc::Store.new
+    store2 = RDoc::Store.new(RDoc::Options.new)
     tl2_1 = store2.add_file 'one.rb'
     tl2_2 = store2.add_file 'two.rb'
 
@@ -1086,7 +1086,7 @@ def test_merge_sections_overlap
     cm1.add_section 'section', comment('comment 1 a', tl1_1)
     cm1.add_section 'section', comment('comment 3',   tl1_3)
 
-    store2 = RDoc::Store.new
+    store2 = RDoc::Store.new(RDoc::Options.new)
     tl2_1 = store2.add_file 'one.rb'
     tl2_2 = store2.add_file 'two.rb'
     tl2_3 = store2.add_file 'three.rb'
@@ -1382,7 +1382,7 @@ def test_update_aliases_reparent
   end
 
   def test_update_aliases_reparent_root
-    store = RDoc::Store.new
+    store = RDoc::Store.new(RDoc::Options.new)
 
     top_level = store.add_file 'file.rb'
 

test/rdoc/test_rdoc_code_object.rb

@@ -275,14 +275,6 @@ def test_metadata
     assert_equal 'not_rdoc', @co.metadata['markup']
   end
 
-  def test_options
-    assert_kind_of RDoc::Options, @co.options
-
-    @co.store = @store
-
-    assert_same @options, @co.options
-  end
-
   def test_parent_file_name
     assert_equal '(unknown)', @co.parent_file_name
     assert_equal 'xref_data.rb', @c1.parent_file_name

test/rdoc/test_rdoc_context.rb

@@ -290,7 +290,7 @@ def test_add_module_alias
   end
 
   def test_add_module_alias_top_level
-    store = RDoc::Store.new
+    store = RDoc::Store.new(RDoc::Options.new)
 
     top_level = store.add_file 'file.rb'
 

test/rdoc/test_rdoc_generator_ri.rb

@@ -52,7 +52,7 @@ def test_generate
     assert_file File.join(@tmpdir, 'Object', 'method-i.ri')
     assert_file File.join(@tmpdir, 'Object', 'method%21-i.ri')
 
-    store = RDoc::RI::Store.new @tmpdir
+    store = RDoc::RI::Store.new(@options, path: @tmpdir)
     store.load_cache
 
     encoding = Encoding::UTF_8

test/rdoc/test_rdoc_method_attr.rb

@@ -185,8 +185,7 @@ def test_equals2
 
   def test_pretty_print
     temp_dir do |tmpdir|
-      s = RDoc::RI::Store.new tmpdir
-      s.rdoc = @rdoc
+      s = RDoc::RI::Store.new(RDoc::Options.new, path: tmpdir)
 
       top_level = s.add_file 'file.rb'
       meth_bang = RDoc::AnyMethod.new nil, 'method!'

test/rdoc/test_rdoc_rdoc.rb

@@ -7,7 +7,8 @@ def setup
     super
 
     @rdoc = RDoc::RDoc.new
-    @rdoc.options = RDoc::Options.new
+    @options = RDoc::Options.new
+    @rdoc.options = @options
 
     @stats = RDoc::Stats.new @store, 0, 0
     @rdoc.instance_variable_set :@stats, @stats
@@ -244,7 +245,7 @@ def test_normalized_file_list_with_skipping_tests_disabled
   end
 
   def test_parse_file
-    @rdoc.store = RDoc::Store.new
+    @rdoc.store = RDoc::Store.new(@options)
 
     temp_dir do |dir|
       @rdoc.options.root = Pathname(Dir.pwd)
@@ -261,7 +262,7 @@ def test_parse_file
   end
 
   def test_parse_file_binary
-    @rdoc.store = RDoc::Store.new
+    @rdoc.store = RDoc::Store.new(@options)
 
     root = File.dirname __FILE__
 
@@ -278,7 +279,7 @@ def test_parse_file_binary
   end
 
   def test_parse_file_include_root
-    @rdoc.store = RDoc::Store.new
+    @rdoc.store = RDoc::Store.new(@options)
 
     test_path = File.expand_path('..', __FILE__)
     top_level = nil
@@ -300,7 +301,7 @@ def test_parse_file_include_root
   end
 
   def test_parse_file_page_dir
-    @rdoc.store = RDoc::Store.new
+    @rdoc.store = RDoc::Store.new(@options)
 
     temp_dir do |dir|
       FileUtils.mkdir 'pages'
@@ -321,7 +322,7 @@ def test_parse_file_page_dir
   def test_parse_file_relative
     pwd = Dir.pwd
 
-    @rdoc.store = RDoc::Store.new
+    @rdoc.store = RDoc::Store.new(@options)
 
     temp_dir do |dir|
       @rdoc.options.root = Pathname(dir)
@@ -343,7 +344,7 @@ def test_parse_file_relative
 
   def test_parse_file_encoding
     @rdoc.options.encoding = Encoding::ISO_8859_1
-    @rdoc.store = RDoc::Store.new
+    @rdoc.store = RDoc::Store.new(@options)
 
     tf = Tempfile.open 'test.txt' do |io|
       io.write 'hi'
@@ -361,7 +362,7 @@ def test_parse_file_forbidden
     omit 'chmod not supported' if Gem.win_platform?
     omit "assumes that euid is not root" if Process.euid == 0
 
-    @rdoc.store = RDoc::Store.new
+    @rdoc.store = RDoc::Store.new(@options)
 
     tf = Tempfile.open 'test.txt' do |io|
       io.write 'hi'