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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
# frozen_string_literal: true
require 'yaml'
RSpec.describe YARD::Config do
describe ".load" do
before do
expect(File).to receive(:file?).twice.with(CLI::Yardoc::DEFAULT_YARDOPTS_FILE).and_return(false)
end
it "uses default options if no ~/.yard/config is found" do
expect(File).to receive(:file?).with(YARD::Config::IGNORED_PLUGINS).and_return(false)
expect(File).to receive(:file?).with(YARD::Config::CONFIG_FILE).and_return(false)
YARD::Config.load
expect(YARD::Config.options).to eq YARD::Config::DEFAULT_CONFIG_OPTIONS
end
it "overwrites options with data in ~/.yard/config" do
expect(File).to receive(:file?).with(YARD::Config::CONFIG_FILE).and_return(true)
expect(File).to receive(:file?).with(YARD::Config::IGNORED_PLUGINS).and_return(false)
expect(YAML).to receive(:load_file).with(YARD::Config::CONFIG_FILE).and_return('test' => true)
YARD::Config.load
expect(YARD::Config.options[:test]).to be true
end unless /ruby2\.7/ =~ RbConfig.ruby
it "ignores any plugins specified in '~/.yard/ignored_plugins'" do
expect(File).to receive(:file?).with(YARD::Config::CONFIG_FILE).and_return(false)
expect(File).to receive(:file?).with(YARD::Config::IGNORED_PLUGINS).and_return(true)
expect(File).to receive(:read).with(YARD::Config::IGNORED_PLUGINS).and_return('yard-plugin plugin2')
YARD::Config.load
expect(YARD::Config.options[:ignored_plugins]).to eq ['yard-plugin', 'yard-plugin2']
expect(YARD::Config).not_to receive(:require).with('yard-plugin2')
expect(YARD::Config.load_plugin('yard-plugin2')).to be false
end
it "loads safe_mode setting from --safe command line option" do
expect(File).to receive(:file?).with(YARD::Config::IGNORED_PLUGINS).and_return(false)
expect(File).to receive(:file?).with(YARD::Config::CONFIG_FILE).and_return(false)
ARGV.replace(['--safe'])
YARD::Config.load
expect(YARD::Config.options[:safe_mode]).to be true
ARGV.replace([''])
end
end
describe ".save" do
it "saves options to config file" do
allow(YARD::Config).to receive(:options).and_return(:a => 1, :b => %w(a b c))
file = double(:file)
expect(File).to receive(:open).with(YARD::Config::CONFIG_FILE, 'w').and_yield(file)
expect(file).to receive(:write).with(YAML.dump(:a => 1, :b => %w(a b c)))
YARD::Config.save
end
end
describe ".load_plugin" do
it "loads a plugin by 'name' as 'yard-name'" do
expect(YARD::Config).to receive(:require).with('yard-foo')
expect(log).to receive(:debug).with(/Loading plugin 'yard-foo'/).once
expect(YARD::Config.load_plugin('foo')).to be true
end
it "does not load plugins like 'doc-*'" do
expect(YARD::Config).not_to receive(:require).with('yard-doc-core')
YARD::Config.load_plugin('doc-core')
YARD::Config.load_plugin('yard-doc-core')
end
it "loads plugin by 'yard-name' as 'yard-name'" do
expect(YARD::Config).to receive(:require).with('yard-foo')
expect(log).to receive(:debug).with(/Loading plugin 'yard-foo'/).once
expect(YARD::Config.load_plugin('yard-foo')).to be true
end
it "loads plugin by 'yard_name' as 'yard_name'" do
expect(YARD::Config).to receive(:require).with('yard_foo')
expect(log).to receive(:debug).with(/Loading plugin 'yard_foo'/).once
log.show_backtraces = false
expect(YARD::Config.load_plugin('yard_foo')).to be true
end
it "logs error if plugin is not found" do
expect(YARD::Config).to receive(:require).with('yard-foo').and_raise(LoadError)
expect(log).to receive(:error).with(/Error loading plugin 'yard-foo'/).once
expect(YARD::Config.load_plugin('yard-foo')).to be false
end
it "sanitizes plugin name (remove /'s)" do
expect(YARD::Config).to receive(:require).with('yard-foofoo')
expect(YARD::Config.load_plugin('foo/foo')).to be true
end
it "ignores plugins in :ignore_plugins" do
allow(YARD::Config).to receive(:options).and_return(:ignored_plugins => ['yard-foo', 'yard-bar'])
expect(YARD::Config.load_plugin('foo')).to be false
expect(YARD::Config.load_plugin('bar')).to be false
end
end
describe ".load_plugins" do
it "loads gem plugins if :load_plugins is true" do
allow(YARD::Config).to receive(:options).and_return(:load_plugins => true, :ignored_plugins => [], :autoload_plugins => [])
allow(YARD::Config).to receive(:load_plugin)
expect(YARD::Config).to receive(:require).with('rubygems')
YARD::Config.load_plugins
end
it "ignores gem loading if RubyGems cannot load" do
allow(YARD::Config).to receive(:options).and_return(:load_plugins => true, :ignored_plugins => [], :autoload_plugins => [])
expect(YARD::Config).to receive(:require).with('rubygems').and_raise(LoadError)
expect(YARD::Config.load_plugins).to be false
end
it "loads certain plugins automatically when specified in :autoload_plugins" do
expect(File).to receive(:file?).with(CLI::Yardoc::DEFAULT_YARDOPTS_FILE).and_return(false)
allow(YARD::Config).to receive(:options).and_return(:load_plugins => false, :ignored_plugins => [], :autoload_plugins => ['yard-plugin'])
expect(YARD::Config).to receive(:require).with('yard-plugin').and_return(true)
expect(YARD::Config.load_plugins).to be true
end
it "parses --plugin from command line arguments" do
expect(YARD::Config).to receive(:arguments).at_least(1).times.and_return(%w(--plugin foo --plugin bar a b c))
expect(YARD::Config).to receive(:load_plugin).with('foo').and_return(true)
expect(YARD::Config).to receive(:load_plugin).with('bar').and_return(true)
expect(YARD::Config.load_plugins).to be true
end
it "loads --plugin arguments from .yardopts" do
expect(File).to receive(:file?).with(CLI::Yardoc::DEFAULT_YARDOPTS_FILE).twice.and_return(true)
expect(File).to receive(:file?).with(YARD::Config::CONFIG_FILE).and_return(false)
expect(File).to receive(:file?).with(YARD::Config::IGNORED_PLUGINS).and_return(false)
expect(File).to receive(:read_binary).with(CLI::Yardoc::DEFAULT_YARDOPTS_FILE).twice.and_return('--plugin foo')
expect(YARD::Config).to receive(:load_plugin).with('foo')
YARD::Config.load
end
it "loads any gem plugins starting with 'yard_' or 'yard-'" do
expect(File).to receive(:file?).with(CLI::Yardoc::DEFAULT_YARDOPTS_FILE).and_return(false)
allow(YARD::Config).to receive(:options).and_return(:load_plugins => true, :ignored_plugins => ['yard_plugin'], :autoload_plugins => [])
plugins = {
'yard' => double('yard'),
'yard_plugin' => double('yard_plugin'),
'yard-plugin' => double('yard-plugin'),
'my-yard-plugin' => double('yard-plugin'),
'rspec' => double('rspec')
}
plugins.each do |k, v|
expect(v).to receive(:name).at_least(1).times.and_return(k)
end
expect(YARD::GemIndex).to receive(:each) {|&b| plugins.values.each(&b) }
expect(YARD::Config).to receive(:load_plugin).with('yard_plugin').and_return(false)
expect(YARD::Config).to receive(:load_plugin).with('yard-plugin').and_return(true)
expect(YARD::Config.load_plugins).to be true
end unless /ruby2\.7/ =~ RbConfig.ruby
it "logs an error if a gem raises an error" do
allow(YARD::Config).to receive(:options).and_return(:load_plugins => true, :ignored_plugins => [], :autoload_plugins => [])
plugins = {
'yard-plugin' => double('yard-plugin')
}
plugins.each do |k, v|
expect(v).to receive(:name).at_least(1).times.and_return(k)
end
expect(YARD::GemIndex).to receive(:each) {|&b| plugins.values.each(&b) }
expect(YARD::Config).to receive(:load_plugin).with('yard-plugin').and_raise(Gem::LoadError)
expect(log).to receive(:error).with(/Error loading plugin 'yard-plugin'/)
expect(YARD::Config.load_plugins).to be false
end
end
end
|
