1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# frozen_string_literal: true
require File.dirname(__FILE__) + '/spec_helper'
RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}YieldHandler" do
before(:all) { parse_file :yield_handler_001, __FILE__ }
it "only parses yield blocks in methods" do
expect(P(:Testing).tag(:yield)).to be nil
expect(P(:Testing).tag(:yieldparam)).to be nil
end
it "handles an empty yield statement" do
expect(P('Testing#mymethod').tag(:yield)).to be nil
expect(P('Testing#mymethod').tag(:yieldparam)).to be nil
end
it "does not document a yield statement in a method with either @yield or @yieldparam" do
expect(P('Testing#mymethod2').tag(:yield).types).to eq ['a', 'b']
expect(P('Testing#mymethod2').tag(:yield).text).to eq "Blah"
expect(P('Testing#mymethod2').tags(:yieldparam).size).to eq 2
expect(P('Testing#mymethod3').tag(:yield).types).to eq ['a', 'b']
expect(P('Testing#mymethod3').tags(:yieldparam).size).to eq 0
expect(P('Testing#mymethod4').tag(:yieldparam).name).to eq '_self'
expect(P('Testing#mymethod4').tag(:yieldparam).text).to eq 'BLAH'
end
it "handles any arbitrary yield statement" do
expect(P('Testing#mymethod5').tag(:yield).types).to eq [':a', 'b', '_self', 'File.read(\'file\', \'w\')', 'CONSTANT']
end
it "handles parentheses" do
expect(P('Testing#mymethod6').tag(:yield).types).to eq ['b', 'a']
end
it "only documents the first yield statement in a method (limitation of yield handler)" do
expect(P('Testing#mymethod7').tag(:yield).types).to eq ['a']
end
it "handles `self` keyword and list object type as yieldparam for _self" do
expect(P('Testing#mymethod8').tag(:yield).types).to eq ['_self']
expect(P('Testing#mymethod8').tag(:yieldparam).types).to eq ['Testing']
expect(P('Testing#mymethod8').tag(:yieldparam).text).to eq "the object that the method was called on"
end
it "handles `super` keyword and document it under _super" do
expect(P('Testing#mymethod9').tag(:yield).types).to eq ['_super']
expect(P('Testing#mymethod9').tag(:yieldparam).types).to be nil
expect(P('Testing#mymethod9').tag(:yieldparam).text).to eq "the result of the method from the superclass"
end
end
|
