Skip to content

Commit e93905f

Browse files
st0012st0012
authored
Merge pull request #1289 from ruby/refactor-call-seq-extraction
Remove unnecessary coupling in comments' call_seq extraction
2 parents f642dbe + d1256c4 commit e93905f

File tree

6 files changed

+19
-53
lines changed

6 files changed

+19
-53
lines changed

‎lib/rdoc/code_object/any_method.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ def call_seq
110110
# See also #param_seq
111111

112112
def call_seq= call_seq
113-
return if call_seq.empty?
113+
return if call_seq.nil? || call_seq.empty?
114114

115115
@call_seq = call_seq
116116
end

‎lib/rdoc/comment.rb

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ def == other # :nodoc:
9292
# # ARGF.to_a(limit) -> array
9393
# # ARGF.to_a(sep, limit) -> array
9494

95-
def extract_call_seq method
95+
def extract_call_seq
9696
# we must handle situations like the above followed by an unindented first
9797
# comment. The difficulty is to make sure not to match lines starting
9898
# with ARGF at the same indent, but that are after the first description
@@ -116,10 +116,7 @@ def extract_call_seq method
116116
@text.slice! all_start...all_stop
117117

118118
seq.gsub!(/^\s*/, '')
119-
method.call_seq = seq
120119
end
121-
122-
method
123120
end
124121

125122
##

‎lib/rdoc/parser/c.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -810,7 +810,7 @@ def find_const_comment(type, const_name, class_name = nil)
810810

811811
def find_modifiers comment, meth_obj
812812
comment.normalize
813-
comment.extract_call_seq meth_obj
813+
meth_obj.call_seq = comment.extract_call_seq
814814

815815
look_for_directives_in meth_obj, comment
816816
end

‎lib/rdoc/parser/prism_ruby.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ def handle_meta_method_comment(comment, node)
303303
meth.singleton = @singleton || singleton_method
304304
handle_consecutive_comment_directive(meth, comment)
305305
comment.normalize
306-
comment.extract_call_seq(meth)
306+
meth.call_seq = comment.extract_call_seq
307307
meth.comment = comment
308308
if node
309309
tokens = visible_tokens_from_location(node.location)
@@ -520,7 +520,7 @@ def add_method(name, receiver_name:, receiver_fallback_type:, visibility:, singl
520520
handle_consecutive_comment_directive(meth, comment)
521521

522522
comment.normalize
523-
comment.extract_call_seq(meth)
523+
meth.call_seq = comment.extract_call_seq
524524
meth.comment = comment
525525
end
526526
handle_modifier_directive(meth, start_line)

‎lib/rdoc/parser/ruby.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1153,7 +1153,7 @@ def parse_comment_ghost container, text, name, column, line_no, # :nodoc:
11531153
end
11541154

11551155
comment.normalize
1156-
comment.extract_call_seq meth
1156+
meth.call_seq = comment.extract_call_seq
11571157

11581158
return unless meth.name
11591159

@@ -1417,7 +1417,7 @@ def parse_meta_method_params container, single, meth, tk, comment # :nodoc:
14171417

14181418
look_for_directives_in meth, comment
14191419
comment.normalize
1420-
comment.extract_call_seq meth
1420+
meth.call_seq = comment.extract_call_seq
14211421

14221422
container.add_method meth
14231423

@@ -1485,7 +1485,7 @@ def parse_method(container, single, tk, comment)
14851485
parse_method_params_and_body container, single, meth, added_container
14861486

14871487
comment.normalize
1488-
comment.extract_call_seq meth
1488+
meth.call_seq = comment.extract_call_seq
14891489

14901490
meth.comment = comment
14911491

‎test/rdoc/test_rdoc_comment.rb

Lines changed: 11 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
require_relative 'helper'
55

6-
class TestRDocComment < RDoc::TestCase
6+
class RDocCommentTest < RDoc::TestCase
77

88
def setup
99
super
@@ -42,74 +42,54 @@ def test_equals2
4242
end
4343

4444
def test_extract_call_seq
45-
m = RDoc::AnyMethod.new nil, 'm'
46-
4745
comment = RDoc::Comment.new <<-COMMENT, @top_level
4846
call-seq:
4947
bla => true or false
5048
5149
moar comment
5250
COMMENT
5351

54-
comment.extract_call_seq m
55-
56-
assert_equal "bla => true or false\n", m.call_seq
52+
assert_equal "bla => true or false\n", comment.extract_call_seq
5753
end
5854

5955
def test_extract_call_seq_blank
60-
m = RDoc::AnyMethod.new nil, 'm'
61-
6256
comment = RDoc::Comment.new <<-COMMENT, @top_level
6357
call-seq:
6458
bla => true or false
6559
6660
COMMENT
6761

68-
comment.extract_call_seq m
69-
70-
assert_equal "bla => true or false\n", m.call_seq
62+
assert_equal "bla => true or false\n", comment.extract_call_seq
7163
end
7264

7365
def test_extract_call_seq_commented
74-
m = RDoc::AnyMethod.new nil, 'm'
75-
7666
comment = RDoc::Comment.new <<-COMMENT, @top_level
7767
# call-seq:
7868
# bla => true or false
7969
#
8070
# moar comment
8171
COMMENT
8272

83-
comment.extract_call_seq m
84-
85-
assert_nil m.call_seq
73+
assert_nil comment.extract_call_seq
8674
end
8775

8876
def test_extract_call_seq_no_blank
89-
m = RDoc::AnyMethod.new nil, 'm'
90-
9177
comment = RDoc::Comment.new <<-COMMENT, @top_level
9278
call-seq:
9379
bla => true or false
9480
COMMENT
9581

96-
comment.extract_call_seq m
97-
98-
assert_equal "bla => true or false\n", m.call_seq
82+
assert_equal "bla => true or false\n", comment.extract_call_seq
9983
end
10084

10185
def test_extract_call_seq_undent
102-
m = RDoc::AnyMethod.new nil, 'm'
103-
10486
comment = RDoc::Comment.new <<-COMMENT, @top_level
10587
call-seq:
10688
bla => true or false
10789
moar comment
10890
COMMENT
10991

110-
comment.extract_call_seq m
111-
112-
assert_equal "bla => true or false\nmoar comment\n", m.call_seq
92+
assert_equal "bla => true or false\nmoar comment\n", comment.extract_call_seq
11393
end
11494

11595
def test_extract_call_seq_c
@@ -128,18 +108,14 @@ def test_extract_call_seq_c
128108
and commercial week day given. Ignores the 4th argument.
129109
COMMENT
130110

131-
method_obj = RDoc::AnyMethod.new nil, 'blah'
132-
133-
comment.extract_call_seq method_obj
134-
135111
expected = <<-CALL_SEQ.chomp
136112
commercial() -> Date <br />
137113
commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
138114
commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
139115
140116
CALL_SEQ
141117

142-
assert_equal expected, method_obj.call_seq
118+
assert_equal expected, comment.extract_call_seq
143119
end
144120

145121
def test_extract_call_seq_c_no_blank
@@ -150,18 +126,14 @@ def test_extract_call_seq_c_no_blank
150126
commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
151127
COMMENT
152128

153-
method_obj = RDoc::AnyMethod.new nil, 'blah'
154-
155-
comment.extract_call_seq method_obj
156-
157129
expected = <<-CALL_SEQ.chomp
158130
commercial() -> Date <br />
159131
commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
160132
commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
161133
162134
CALL_SEQ
163135

164-
assert_equal expected, method_obj.call_seq
136+
assert_equal expected, comment.extract_call_seq
165137
end
166138

167139
def test_extract_call_seq_c_separator
@@ -183,10 +155,6 @@ def test_extract_call_seq_c_separator
183155
184156
COMMENT
185157

186-
method_obj = RDoc::AnyMethod.new nil, 'blah'
187-
188-
comment.extract_call_seq method_obj
189-
190158
expected = <<-CALL_SEQ
191159
ARGF.readlines(sep=$/) -> array
192160
ARGF.readlines(limit) -> array
@@ -196,7 +164,7 @@ def test_extract_call_seq_c_separator
196164
ARGF.to_a(sep, limit) -> array
197165
CALL_SEQ
198166

199-
assert_equal expected, method_obj.call_seq
167+
assert_equal expected, comment.extract_call_seq
200168

201169
expected = <<-'COMMENT'
202170
@@ -211,11 +179,12 @@ def test_extract_call_seq_c_separator
211179
assert_equal expected, comment.text
212180
end
213181

182+
# This test relies on AnyMethod#call_seq's behaviour as well
214183
def test_extract_call_linear_performance
215184
pre = ->(n) {[n, RDoc::Comment.new("\n"*n + 'call-seq:' + 'a'*n)]}
216185
method_obj = RDoc::AnyMethod.new nil, 'blah'
217186
assert_linear_performance((2..5).map {|i| 10**i}, pre: pre) do |n, comment|
218-
comment.extract_call_seq method_obj
187+
method_obj.call_seq = comment.extract_call_seq
219188
assert_equal n, method_obj.call_seq.size
220189
end
221190
end

0 commit comments

Comments
 (0)