From eedf2e77ba1b42b05b16b93c1bf9533f1cb6115a Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:02:14 +0000 Subject: [PATCH 01/10] Remove unused CodeObject#each_parent --- lib/rdoc/code_object.rb | 14 -------------- test/rdoc/test_rdoc_code_object.rb | 10 ---------- 2 files changed, 24 deletions(-) diff --git a/lib/rdoc/code_object.rb b/lib/rdoc/code_object.rb index 37dcadd3d7..9090ec374e 100644 --- a/lib/rdoc/code_object.rb +++ b/lib/rdoc/code_object.rb @@ -217,20 +217,6 @@ def done_documenting=(value) @document_children = @document_self end - ## - # Yields each parent of this CodeObject. See also - # RDoc::ClassModule#each_ancestor - - def each_parent - code_object = self - - while code_object = code_object.parent do - yield code_object - end - - self - end - ## # File name where this CodeObject was found. # diff --git a/test/rdoc/test_rdoc_code_object.rb b/test/rdoc/test_rdoc_code_object.rb index 6d0cbc5cd4..df7d893923 100644 --- a/test/rdoc/test_rdoc_code_object.rb +++ b/test/rdoc/test_rdoc_code_object.rb @@ -201,16 +201,6 @@ def test_done_documenting refute @co.done_documenting end - def test_each_parent - parents = [] - - @parent_m.each_parent do |code_object| - parents << code_object - end - - assert_equal [@parent, @xref_data], parents - end - def test_file_name assert_nil @co.file_name From 103b8790478deda4c0b60e550e03cabbc48e9b60 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:03:19 +0000 Subject: [PATCH 02/10] Remove single-use CodeObject#parent_file_name --- lib/rdoc/code_object.rb | 7 ------- lib/rdoc/code_object/require.rb | 2 +- test/rdoc/test_rdoc_code_object.rb | 5 ----- 3 files changed, 1 insertion(+), 13 deletions(-) diff --git a/lib/rdoc/code_object.rb b/lib/rdoc/code_object.rb index 9090ec374e..be6e187634 100644 --- a/lib/rdoc/code_object.rb +++ b/lib/rdoc/code_object.rb @@ -313,13 +313,6 @@ def parent end end - ## - # File name of our parent - - def parent_file_name - @parent ? @parent.base_name : '(unknown)' - end - ## # Name of our parent diff --git a/lib/rdoc/code_object/require.rb b/lib/rdoc/code_object/require.rb index 05e26b84b0..f47e3b1534 100644 --- a/lib/rdoc/code_object/require.rb +++ b/lib/rdoc/code_object/require.rb @@ -24,7 +24,7 @@ def inspect # :nodoc: self.class, object_id, @name, - parent_file_name, + @parent ? @parent.base_name : '(unknown)' ] end diff --git a/test/rdoc/test_rdoc_code_object.rb b/test/rdoc/test_rdoc_code_object.rb index df7d893923..429def790b 100644 --- a/test/rdoc/test_rdoc_code_object.rb +++ b/test/rdoc/test_rdoc_code_object.rb @@ -265,11 +265,6 @@ def test_metadata assert_equal 'not_rdoc', @co.metadata['markup'] end - def test_parent_file_name - assert_equal '(unknown)', @co.parent_file_name - assert_equal 'xref_data.rb', @c1.parent_file_name - end - def test_parent_name assert_equal '(unknown)', @co.parent_name assert_equal 'xref_data.rb', @c1.parent_name From 74eba1bc8bbbc6cbe1ada736299d3bb860671e2d Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:05:29 +0000 Subject: [PATCH 03/10] Remove unused CodeObject#viewer --- lib/rdoc/code_object.rb | 7 ------- lib/rdoc/code_object/class_module.rb | 1 - test/rdoc/test_rdoc_parser_ruby.rb | 4 ---- 3 files changed, 12 deletions(-) diff --git a/lib/rdoc/code_object.rb b/lib/rdoc/code_object.rb index be6e187634..1460433b1f 100644 --- a/lib/rdoc/code_object.rb +++ b/lib/rdoc/code_object.rb @@ -90,13 +90,6 @@ class RDoc::CodeObject attr_reader :store - ## - # We are the model of the code, but we know that at some point we will be - # worked on by viewers. By implementing the Viewable protocol, viewers can - # associated themselves with these objects. - - attr_accessor :viewer - ## # When mixed-in to a class, this points to the Context in which it was originally defined. diff --git a/lib/rdoc/code_object/class_module.rb b/lib/rdoc/code_object/class_module.rb index e171c86f02..0af340fa26 100644 --- a/lib/rdoc/code_object/class_module.rb +++ b/lib/rdoc/code_object/class_module.rb @@ -56,7 +56,6 @@ def self.from_module class_type, mod klass.parent = mod.parent klass.section = mod.section - klass.viewer = mod.viewer klass.attributes.concat mod.attributes klass.method_list.concat mod.method_list diff --git a/test/rdoc/test_rdoc_parser_ruby.rb b/test/rdoc/test_rdoc_parser_ruby.rb index 96dbb69f8b..b39ed59ca9 100644 --- a/test/rdoc/test_rdoc_parser_ruby.rb +++ b/test/rdoc/test_rdoc_parser_ruby.rb @@ -1277,7 +1277,6 @@ def test_parse_comment_attr assert_equal @top_level, foo.file assert_equal 1, foo.line - assert_nil foo.viewer assert_equal true, foo.document_children assert_equal true, foo.document_self assert_equal false, foo.done_documenting @@ -1344,7 +1343,6 @@ def test_parse_comment_method assert_nil foo.block_params assert_nil foo.call_seq assert_nil foo.is_alias_for - assert_nil foo.viewer assert_equal true, foo.document_children assert_equal true, foo.document_self assert_equal '', foo.params @@ -1677,7 +1675,6 @@ def test_parse_meta_method assert_equal klass, foo.parent assert_equal false, foo.singleton assert_equal 'add_my_method :foo', foo.text - assert_nil foo.viewer assert_equal :public, foo.visibility assert_equal klass.current_section, foo.section @@ -1878,7 +1875,6 @@ def test_parse_method assert_nil foo.block_params assert_nil foo.call_seq assert_nil foo.is_alias_for - assert_nil foo.viewer assert_equal true, foo.document_children assert_equal true, foo.document_self assert_equal '()', foo.params From 1c1ff67a7181412efc877d386653f5fe1b84ed8b Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:07:32 +0000 Subject: [PATCH 04/10] Remove unused Alias#full_old_name --- lib/rdoc/code_object/alias.rb | 7 ------- 1 file changed, 7 deletions(-) diff --git a/lib/rdoc/code_object/alias.rb b/lib/rdoc/code_object/alias.rb index b76f0ad7e8..bd5b3ec6b5 100644 --- a/lib/rdoc/code_object/alias.rb +++ b/lib/rdoc/code_object/alias.rb @@ -59,13 +59,6 @@ def aref "#alias-#{type}-#{html_name}" end - ## - # Full old name including namespace - - def full_old_name - @full_name || "#{parent.name}#{pretty_old_name}" - end - ## # HTML id-friendly version of +#new_name+. From c38cb93766417c868d4e98ef86ba2d72849e9a83 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:21:53 +0000 Subject: [PATCH 05/10] Remove singled-used Context#find_file_named --- lib/rdoc/code_object/context.rb | 9 +-------- test/rdoc/test_rdoc_context.rb | 5 ----- 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/lib/rdoc/code_object/context.rb b/lib/rdoc/code_object/context.rb index 2d2c5f90c8..2a1045ad6b 100644 --- a/lib/rdoc/code_object/context.rb +++ b/lib/rdoc/code_object/context.rb @@ -847,13 +847,6 @@ def find_external_alias_named(name) end end - ## - # Finds a file with +name+ in this context - - def find_file_named name - @store.find_file_named name - end - ## # Finds an instance method with +name+ in this context @@ -871,7 +864,7 @@ def find_local_symbol(symbol) find_attribute_named(symbol) or find_external_alias_named(symbol) or find_module_named(symbol) or - find_file_named(symbol) + @store.find_file_named(symbol) end ## diff --git a/test/rdoc/test_rdoc_context.rb b/test/rdoc/test_rdoc_context.rb index 20bb3893e9..8d1f350647 100644 --- a/test/rdoc/test_rdoc_context.rb +++ b/test/rdoc/test_rdoc_context.rb @@ -538,11 +538,6 @@ def test_find_enclosing_module_named assert_equal @c2, @c2_c3.find_enclosing_module_named('C2') end - def test_find_file_named - assert_nil @c1.find_file_named('nonexistent.rb') - assert_equal @xref_data, @c1.find_file_named(@file_name) - end - def test_find_instance_method_named assert_nil @c1.find_instance_method_named('none') From 063f696d7e8101094c3ca5b9c0bc459f29787102 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:24:24 +0000 Subject: [PATCH 06/10] Remove unnecessary `ClassModule#each_*` iterating methods --- lib/rdoc/code_object/context.rb | 28 ------------------- lib/rdoc/generator/pot/message_extractor.rb | 4 +-- .../template/darkfish/_sidebar_extends.rhtml | 2 +- .../template/darkfish/_sidebar_includes.rhtml | 2 +- lib/rdoc/stats.rb | 4 +-- lib/rdoc/store.rb | 2 +- test/rdoc/test_rdoc_class_module.rb | 6 ++-- 7 files changed, 10 insertions(+), 38 deletions(-) diff --git a/lib/rdoc/code_object/context.rb b/lib/rdoc/code_object/context.rb index 2a1045ad6b..003e438965 100644 --- a/lib/rdoc/code_object/context.rb +++ b/lib/rdoc/code_object/context.rb @@ -713,13 +713,6 @@ def display(method_attr) # :nodoc: def each_ancestor(&_) # :nodoc: end - ## - # Iterator for attributes - - def each_attribute # :yields: attribute - @attributes.each { |a| yield a } - end - ## # Iterator for classes and modules @@ -727,27 +720,6 @@ def each_classmodule(&block) # :yields: module classes_and_modules.sort.each(&block) end - ## - # Iterator for constants - - def each_constant # :yields: constant - @constants.each {|c| yield c} - end - - ## - # Iterator for included modules - - def each_include # :yields: include - @includes.each do |i| yield i end - end - - ## - # Iterator for extension modules - - def each_extend # :yields: extend - @extends.each do |e| yield e end - end - ## # Iterator for methods diff --git a/lib/rdoc/generator/pot/message_extractor.rb b/lib/rdoc/generator/pot/message_extractor.rb index 4938858bdc..463132929f 100644 --- a/lib/rdoc/generator/pot/message_extractor.rb +++ b/lib/rdoc/generator/pot/message_extractor.rb @@ -35,11 +35,11 @@ def extract_from_klass klass end end - klass.each_constant do |constant| + klass.constants.each do |constant| extract_text(constant.comment, constant.full_name) end - klass.each_attribute do |attribute| + klass.attributes.each do |attribute| extract_text(attribute.comment, attribute.full_name) end diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml index 7602076c96..067bd62edd 100644 --- a/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +++ b/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml @@ -3,7 +3,7 @@

Extended With Modules

    - <%- klass.each_extend do |ext| -%> + <%- klass.extends.each do |ext| -%> <%- unless String === ext.module then -%>
  • <%= ext.module.full_name %> <%- else -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml index 5b600e5975..04846f84fb 100644 --- a/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +++ b/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml @@ -3,7 +3,7 @@

    Included Modules

      - <%- klass.each_include do |inc| -%> + <%- klass.includes.each do |inc| -%> <%- unless String === inc.module then -%>
    • <%= inc.module.full_name %> <%- else -%> diff --git a/lib/rdoc/stats.rb b/lib/rdoc/stats.rb index 4817c9c729..c3aa24f5be 100644 --- a/lib/rdoc/stats.rb +++ b/lib/rdoc/stats.rb @@ -261,7 +261,7 @@ def report_attributes cm report = [] - cm.each_attribute do |attr| + cm.attributes.each do |attr| next if attr.documented? line = attr.line ? ":#{attr.line}" : nil report << " #{attr.definition} :#{attr.name} # in file #{attr.file.full_name}#{line}\n" @@ -331,7 +331,7 @@ def report_constants cm report = [] - cm.each_constant do |constant| + cm.constants.each do |constant| # TODO constant aliases are listed in the summary but not reported # figure out what to do here next if constant.documented? || constant.is_alias_for diff --git a/lib/rdoc/store.rb b/lib/rdoc/store.rb index 1fce9f6411..11613db0a5 100644 --- a/lib/rdoc/store.rb +++ b/lib/rdoc/store.rb @@ -762,7 +762,7 @@ def save save_method klass, method end - klass.each_attribute do |attribute| + klass.attributes.each do |attribute| save_method klass, attribute end end diff --git a/test/rdoc/test_rdoc_class_module.rb b/test/rdoc/test_rdoc_class_module.rb index e1c2c90202..59e03e2faa 100644 --- a/test/rdoc/test_rdoc_class_module.rb +++ b/test/rdoc/test_rdoc_class_module.rb @@ -1474,7 +1474,7 @@ def test_update_extends @c1.add_extend a @c1.add_extend b @c1.add_extend c - @c1.each_extend do |extend| extend.module end # cache extended modules + @c1.extends.each do |extend| extend.module end # cache extended modules @m1_m2.document_self = nil assert @m1_m2.remove_from_documentation? @@ -1495,7 +1495,7 @@ def test_update_extends_trim @c1.add_extend a @c1.add_extend b - @c1.each_extend do |extend| extend.module end # cache extended modules + @c1.extends.each do |extend| extend.module end # cache extended modules @c1.update_extends @@ -1510,7 +1510,7 @@ def test_update_extends_with_colons @c1.add_extend a @c1.add_extend b @c1.add_extend c - @c1.each_extend do |extend| extend.module end # cache extended modules + @c1.extends.each do |extend| extend.module end # cache extended modules @m1_m2.document_self = nil assert @m1_m2.remove_from_documentation? From 1a1e6eeefe4f405053f653e6805ba1865fdba3ca Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:26:09 +0000 Subject: [PATCH 07/10] Remove unused Context#defined_in? method --- lib/rdoc/code_object/context.rb | 7 ------- test/rdoc/test_rdoc_context.rb | 6 ------ 2 files changed, 13 deletions(-) diff --git a/lib/rdoc/code_object/context.rb b/lib/rdoc/code_object/context.rb index 003e438965..49830036eb 100644 --- a/lib/rdoc/code_object/context.rb +++ b/lib/rdoc/code_object/context.rb @@ -688,13 +688,6 @@ def current_section section end - ## - # Is part of this thing was defined in +file+? - - def defined_in?(file) - @in_files.include?(file) - end - def display(method_attr) # :nodoc: if method_attr.is_a? RDoc::Attr "#{method_attr.definition} #{method_attr.pretty_name}" diff --git a/test/rdoc/test_rdoc_context.rb b/test/rdoc/test_rdoc_context.rb index 8d1f350647..9564ab6636 100644 --- a/test/rdoc/test_rdoc_context.rb +++ b/test/rdoc/test_rdoc_context.rb @@ -437,12 +437,6 @@ def test_current_section assert_equal default_section, @context.current_section end - def test_defined_in_eh - assert @c1.defined_in?(@c1.top_level) - - refute @c1.defined_in?(@store.add_file('name.rb')) - end - def test_equals2 assert_equal @c3, @c3 refute_equal @c2, @c3 From 09cfed0d03a81a73786c37f69575ba27984f2b06 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:29:36 +0000 Subject: [PATCH 08/10] Remove unused MethodAttr#output_name --- lib/rdoc/code_object/method_attr.rb | 13 ------------- test/rdoc/test_rdoc_method_attr.rb | 8 -------- 2 files changed, 21 deletions(-) diff --git a/lib/rdoc/code_object/method_attr.rb b/lib/rdoc/code_object/method_attr.rb index 144aeba9c1..a59f542edc 100644 --- a/lib/rdoc/code_object/method_attr.rb +++ b/lib/rdoc/code_object/method_attr.rb @@ -313,19 +313,6 @@ def name_prefix @singleton ? '::' : '#' end - ## - # Name for output to HTML. For class methods the full name with a "." is - # used like +SomeClass.method_name+. For instance methods the class name is - # used if +context+ does not match the parent. - # - # This is to help prevent people from using :: to call class methods. - - def output_name context - return "#{name_prefix}#{@name}" if context == parent - - "#{parent_name}#{@singleton ? '.' : '#'}#{@name}" - end - ## # Method/attribute name with class/instance indicator diff --git a/test/rdoc/test_rdoc_method_attr.rb b/test/rdoc/test_rdoc_method_attr.rb index 18d5a905e2..d6a3315384 100644 --- a/test/rdoc/test_rdoc_method_attr.rb +++ b/test/rdoc/test_rdoc_method_attr.rb @@ -124,14 +124,6 @@ def test_is_alias_for assert_equal @c2_b, @c2_a.is_alias_for end - def test_output_name - assert_equal '#m', @c1_m.output_name(@c1) - assert_equal '::m', @c1__m.output_name(@c1) - - assert_equal 'C1#m', @c1_m.output_name(@c2) - assert_equal 'C1.m', @c1__m.output_name(@c2) - end - def test_search_record @c1_m.comment = 'This is a comment.' From 870134a8b0eaea50b370fc52fd99f957e7f7b234 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:32:26 +0000 Subject: [PATCH 09/10] Remove unused diagram attribute --- lib/rdoc/code_object/class_module.rb | 3 --- lib/rdoc/code_object/top_level.rb | 3 --- 2 files changed, 6 deletions(-) diff --git a/lib/rdoc/code_object/class_module.rb b/lib/rdoc/code_object/class_module.rb index 0af340fa26..98c486418a 100644 --- a/lib/rdoc/code_object/class_module.rb +++ b/lib/rdoc/code_object/class_module.rb @@ -34,8 +34,6 @@ class RDoc::ClassModule < RDoc::Context attr_accessor :comment_location - attr_accessor :diagram # :nodoc: - ## # Class or module this constant is an alias for @@ -109,7 +107,6 @@ def self.from_module class_type, mod def initialize(name, superclass = nil) @constant_aliases = [] - @diagram = nil @is_alias_for = nil @name = name @superclass = superclass diff --git a/lib/rdoc/code_object/top_level.rb b/lib/rdoc/code_object/top_level.rb index b97ca7deb3..5b849c93a3 100644 --- a/lib/rdoc/code_object/top_level.rb +++ b/lib/rdoc/code_object/top_level.rb @@ -28,8 +28,6 @@ class RDoc::TopLevel < RDoc::Context attr_reader :classes_or_modules - attr_accessor :diagram # :nodoc: - ## # The parser class that processed this file @@ -46,7 +44,6 @@ def initialize absolute_name, relative_name = absolute_name @absolute_name = absolute_name @relative_name = relative_name @file_stat = File.stat(absolute_name) rescue nil # HACK for testing - @diagram = nil @parser = nil @classes_or_modules = [] From acb2e2b9f9e8a1364863b9a2bddde4ea7bced767 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 16 Mar 2025 00:34:28 +0000 Subject: [PATCH 10/10] Remove unused TopLevel#last_modified --- lib/rdoc/code_object/top_level.rb | 15 --------------- test/rdoc/test_rdoc_top_level.rb | 8 -------- 2 files changed, 23 deletions(-) diff --git a/lib/rdoc/code_object/top_level.rb b/lib/rdoc/code_object/top_level.rb index 5b849c93a3..c567fec996 100644 --- a/lib/rdoc/code_object/top_level.rb +++ b/lib/rdoc/code_object/top_level.rb @@ -6,11 +6,6 @@ class RDoc::TopLevel < RDoc::Context MARSHAL_VERSION = 0 # :nodoc: - ## - # This TopLevel's File::Stat struct - - attr_accessor :file_stat - ## # Relative name of this file @@ -43,7 +38,6 @@ def initialize absolute_name, relative_name = absolute_name @name = nil @absolute_name = absolute_name @relative_name = relative_name - @file_stat = File.stat(absolute_name) rescue nil # HACK for testing @parser = nil @classes_or_modules = [] @@ -183,13 +177,6 @@ def inspect # :nodoc: ] end - ## - # Time this file was last modified, if known - - def last_modified - @file_stat ? file_stat.mtime : nil - end - ## # Dumps this TopLevel for use by ri. See also #marshal_load @@ -210,8 +197,6 @@ def marshal_load array # :nodoc: @parser = array[2] @comment = RDoc::Comment.from_document array[3] - - @file_stat = nil end ## diff --git a/test/rdoc/test_rdoc_top_level.rb b/test/rdoc/test_rdoc_top_level.rb index 5e5861d07f..ba077b02aa 100644 --- a/test/rdoc/test_rdoc_top_level.rb +++ b/test/rdoc/test_rdoc_top_level.rb @@ -162,14 +162,6 @@ def test_http_url assert_equal 'path_other/level_rb.html', other_level.http_url end - def test_last_modified - assert_nil @top_level.last_modified - stat = Object.new - def stat.mtime() 0 end - @top_level.file_stat = stat - assert_equal 0, @top_level.last_modified - end - def test_marshal_dump page = @store.add_file 'README.txt' page.parser = RDoc::Parser::Simple