yard 0.9.24 → 0.9.25

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of yard might be problematic. Click here for more details.

Files changed (223) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +37 -24
  3. data/CHANGELOG.md +18 -3
  4. data/README.md +96 -101
  5. data/Rakefile +2 -0
  6. data/lib/yard/cli/diff.rb +4 -1
  7. data/lib/yard/cli/server.rb +22 -13
  8. data/lib/yard/code_objects/proxy.rb +2 -1
  9. data/lib/yard/globals.rb +1 -1
  10. data/lib/yard/handlers/c/base.rb +164 -129
  11. data/lib/yard/parser/ruby/ruby_parser.rb +6 -4
  12. data/lib/yard/registry_store.rb +1 -1
  13. data/lib/yard/templates/helpers/html_helper.rb +10 -3
  14. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +5 -4
  15. data/lib/yard/version.rb +1 -1
  16. data/tasks/update_error_map.rake +53 -0
  17. data/yard.gemspec +1 -1
  18. metadata +3 -207
  19. data/spec/cli/command_parser_spec.rb +0 -43
  20. data/spec/cli/command_spec.rb +0 -36
  21. data/spec/cli/config_spec.rb +0 -148
  22. data/spec/cli/diff_spec.rb +0 -254
  23. data/spec/cli/display_spec.rb +0 -30
  24. data/spec/cli/gems_spec.rb +0 -81
  25. data/spec/cli/graph_spec.rb +0 -18
  26. data/spec/cli/help_spec.rb +0 -22
  27. data/spec/cli/i18n_spec.rb +0 -107
  28. data/spec/cli/list_spec.rb +0 -8
  29. data/spec/cli/markup_types_spec.rb +0 -22
  30. data/spec/cli/server_spec.rb +0 -324
  31. data/spec/cli/stats_spec.rb +0 -96
  32. data/spec/cli/yard_on_yard_spec.rb +0 -38
  33. data/spec/cli/yardoc_spec.rb +0 -896
  34. data/spec/cli/yri_spec.rb +0 -101
  35. data/spec/code_objects/base_spec.rb +0 -485
  36. data/spec/code_objects/class_object_spec.rb +0 -226
  37. data/spec/code_objects/code_object_list_spec.rb +0 -36
  38. data/spec/code_objects/constants_spec.rb +0 -116
  39. data/spec/code_objects/extra_file_object_spec.rb +0 -161
  40. data/spec/code_objects/macro_object_spec.rb +0 -150
  41. data/spec/code_objects/method_object_spec.rb +0 -184
  42. data/spec/code_objects/module_object_spec.rb +0 -142
  43. data/spec/code_objects/namespace_mapper_spec.rb +0 -32
  44. data/spec/code_objects/namespace_object_spec.rb +0 -171
  45. data/spec/code_objects/proxy_spec.rb +0 -147
  46. data/spec/code_objects/spec_helper.rb +0 -3
  47. data/spec/config_spec.rb +0 -171
  48. data/spec/core_ext/array_spec.rb +0 -13
  49. data/spec/core_ext/file_spec.rb +0 -72
  50. data/spec/core_ext/hash_spec.rb +0 -14
  51. data/spec/core_ext/insertion_spec.rb +0 -37
  52. data/spec/core_ext/module_spec.rb +0 -9
  53. data/spec/core_ext/string_spec.rb +0 -42
  54. data/spec/core_ext/symbol_hash_spec.rb +0 -89
  55. data/spec/docstring_parser_spec.rb +0 -280
  56. data/spec/docstring_spec.rb +0 -373
  57. data/spec/handlers/alias_handler_spec.rb +0 -82
  58. data/spec/handlers/attribute_handler_spec.rb +0 -96
  59. data/spec/handlers/base_spec.rb +0 -216
  60. data/spec/handlers/c/alias_handler_spec.rb +0 -34
  61. data/spec/handlers/c/attribute_handler_spec.rb +0 -41
  62. data/spec/handlers/c/class_handler_spec.rb +0 -78
  63. data/spec/handlers/c/constant_handler_spec.rb +0 -71
  64. data/spec/handlers/c/init_handler_spec.rb +0 -48
  65. data/spec/handlers/c/method_handler_spec.rb +0 -327
  66. data/spec/handlers/c/mixin_handler_spec.rb +0 -44
  67. data/spec/handlers/c/module_handler_spec.rb +0 -71
  68. data/spec/handlers/c/override_comment_handler_spec.rb +0 -47
  69. data/spec/handlers/c/path_handler_spec.rb +0 -36
  70. data/spec/handlers/c/spec_helper.rb +0 -23
  71. data/spec/handlers/c/struct_handler_spec.rb +0 -16
  72. data/spec/handlers/class_condition_handler_spec.rb +0 -87
  73. data/spec/handlers/class_handler_spec.rb +0 -247
  74. data/spec/handlers/class_method_handler_shared_examples.rb +0 -133
  75. data/spec/handlers/class_variable_handler_spec.rb +0 -12
  76. data/spec/handlers/constant_handler_spec.rb +0 -112
  77. data/spec/handlers/decorator_handler_methods_spec.rb +0 -393
  78. data/spec/handlers/dsl_handler_spec.rb +0 -226
  79. data/spec/handlers/examples/alias_handler_001.rb.txt +0 -46
  80. data/spec/handlers/examples/attribute_handler_001.rb.txt +0 -32
  81. data/spec/handlers/examples/class_condition_handler_001.rb.txt +0 -69
  82. data/spec/handlers/examples/class_handler_001.rb.txt +0 -120
  83. data/spec/handlers/examples/class_variable_handler_001.rb.txt +0 -10
  84. data/spec/handlers/examples/constant_handler_001.rb.txt +0 -35
  85. data/spec/handlers/examples/dsl_handler_001.rb.txt +0 -156
  86. data/spec/handlers/examples/exception_handler_001.rb.txt +0 -59
  87. data/spec/handlers/examples/extend_handler_001.rb.txt +0 -19
  88. data/spec/handlers/examples/method_condition_handler_001.rb.txt +0 -10
  89. data/spec/handlers/examples/method_handler_001.rb.txt +0 -128
  90. data/spec/handlers/examples/mixin_handler_001.rb.txt +0 -40
  91. data/spec/handlers/examples/module_handler_001.rb.txt +0 -29
  92. data/spec/handlers/examples/private_constant_handler_001.rb.txt +0 -8
  93. data/spec/handlers/examples/process_handler_001.rb.txt +0 -11
  94. data/spec/handlers/examples/visibility_handler_001.rb.txt +0 -36
  95. data/spec/handlers/examples/yield_handler_001.rb.txt +0 -54
  96. data/spec/handlers/exception_handler_spec.rb +0 -49
  97. data/spec/handlers/extend_handler_spec.rb +0 -28
  98. data/spec/handlers/legacy_base_spec.rb +0 -128
  99. data/spec/handlers/method_condition_handler_spec.rb +0 -15
  100. data/spec/handlers/method_handler_spec.rb +0 -214
  101. data/spec/handlers/mixin_handler_spec.rb +0 -60
  102. data/spec/handlers/module_function_handler_spec.rb +0 -106
  103. data/spec/handlers/module_handler_spec.rb +0 -35
  104. data/spec/handlers/private_class_method_handler_spec.rb +0 -11
  105. data/spec/handlers/private_constant_handler_spec.rb +0 -25
  106. data/spec/handlers/processor_spec.rb +0 -35
  107. data/spec/handlers/public_class_method_handler_spec.rb +0 -11
  108. data/spec/handlers/ruby/base_spec.rb +0 -95
  109. data/spec/handlers/ruby/legacy/base_spec.rb +0 -84
  110. data/spec/handlers/spec_helper.rb +0 -33
  111. data/spec/handlers/visibility_handler_spec.rb +0 -44
  112. data/spec/handlers/yield_handler_spec.rb +0 -52
  113. data/spec/i18n/locale_spec.rb +0 -81
  114. data/spec/i18n/message_spec.rb +0 -52
  115. data/spec/i18n/messages_spec.rb +0 -67
  116. data/spec/i18n/pot_generator_spec.rb +0 -295
  117. data/spec/i18n/text_spec.rb +0 -184
  118. data/spec/logging_spec.rb +0 -44
  119. data/spec/options_spec.rb +0 -171
  120. data/spec/parser/base_spec.rb +0 -24
  121. data/spec/parser/c_parser_spec.rb +0 -236
  122. data/spec/parser/examples/array.c.txt +0 -6267
  123. data/spec/parser/examples/example1.rb.txt +0 -8
  124. data/spec/parser/examples/extrafile.c.txt +0 -8
  125. data/spec/parser/examples/file.c.txt +0 -28
  126. data/spec/parser/examples/multifile.c.txt +0 -22
  127. data/spec/parser/examples/namespace.cpp.txt +0 -68
  128. data/spec/parser/examples/override.c.txt +0 -424
  129. data/spec/parser/examples/parse_in_order_001.rb.txt +0 -2
  130. data/spec/parser/examples/parse_in_order_002.rb.txt +0 -2
  131. data/spec/parser/examples/tag_handler_001.rb.txt +0 -8
  132. data/spec/parser/ruby/ast_node_spec.rb +0 -33
  133. data/spec/parser/ruby/legacy/statement_list_spec.rb +0 -299
  134. data/spec/parser/ruby/legacy/token_list_spec.rb +0 -79
  135. data/spec/parser/ruby/ruby_parser_spec.rb +0 -520
  136. data/spec/parser/ruby/token_resolver_spec.rb +0 -165
  137. data/spec/parser/source_parser_spec.rb +0 -727
  138. data/spec/parser/tag_parsing_spec.rb +0 -17
  139. data/spec/rake/yardoc_task_spec.rb +0 -118
  140. data/spec/registry_resolver_spec.rb +0 -15
  141. data/spec/registry_spec.rb +0 -463
  142. data/spec/registry_store_spec.rb +0 -327
  143. data/spec/rubygems/doc_manager_spec.rb +0 -112
  144. data/spec/serializers/data/serialized_yardoc/checksums +0 -1
  145. data/spec/serializers/data/serialized_yardoc/objects/Foo.dat +0 -0
  146. data/spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat +0 -0
  147. data/spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat +0 -0
  148. data/spec/serializers/data/serialized_yardoc/objects/root.dat +0 -0
  149. data/spec/serializers/data/serialized_yardoc/proxy_types +0 -2
  150. data/spec/serializers/file_system_serializer_spec.rb +0 -145
  151. data/spec/serializers/spec_helper.rb +0 -2
  152. data/spec/serializers/yardoc_serializer_spec.rb +0 -90
  153. data/spec/server/adapter_spec.rb +0 -39
  154. data/spec/server/commands/base_spec.rb +0 -91
  155. data/spec/server/commands/library_command_spec.rb +0 -39
  156. data/spec/server/doc_server_helper_spec.rb +0 -72
  157. data/spec/server/doc_server_serializer_spec.rb +0 -60
  158. data/spec/server/rack_adapter_spec.rb +0 -21
  159. data/spec/server/router_spec.rb +0 -123
  160. data/spec/server/spec_helper.rb +0 -22
  161. data/spec/server/static_caching_spec.rb +0 -47
  162. data/spec/server/webrick_servlet_spec.rb +0 -20
  163. data/spec/server_spec.rb +0 -19
  164. data/spec/spec_helper.rb +0 -212
  165. data/spec/tags/default_factory_spec.rb +0 -168
  166. data/spec/tags/default_tag_spec.rb +0 -11
  167. data/spec/tags/directives_spec.rb +0 -463
  168. data/spec/tags/library_spec.rb +0 -48
  169. data/spec/tags/overload_tag_spec.rb +0 -53
  170. data/spec/tags/ref_tag_list_spec.rb +0 -53
  171. data/spec/tags/types_explainer_spec.rb +0 -203
  172. data/spec/templates/class_spec.rb +0 -45
  173. data/spec/templates/constant_spec.rb +0 -41
  174. data/spec/templates/engine_spec.rb +0 -131
  175. data/spec/templates/examples/class001.html +0 -308
  176. data/spec/templates/examples/class001.txt +0 -36
  177. data/spec/templates/examples/class002.html +0 -39
  178. data/spec/templates/examples/constant001.txt +0 -25
  179. data/spec/templates/examples/constant002.txt +0 -7
  180. data/spec/templates/examples/constant003.txt +0 -11
  181. data/spec/templates/examples/method001.html +0 -137
  182. data/spec/templates/examples/method001.txt +0 -35
  183. data/spec/templates/examples/method002.html +0 -91
  184. data/spec/templates/examples/method002.txt +0 -20
  185. data/spec/templates/examples/method003.html +0 -165
  186. data/spec/templates/examples/method003.txt +0 -45
  187. data/spec/templates/examples/method004.html +0 -48
  188. data/spec/templates/examples/method004.txt +0 -10
  189. data/spec/templates/examples/method005.html +0 -105
  190. data/spec/templates/examples/method005.txt +0 -33
  191. data/spec/templates/examples/method006.html +0 -108
  192. data/spec/templates/examples/method006.txt +0 -20
  193. data/spec/templates/examples/module001.dot +0 -33
  194. data/spec/templates/examples/module001.html +0 -833
  195. data/spec/templates/examples/module001.txt +0 -33
  196. data/spec/templates/examples/module002.html +0 -341
  197. data/spec/templates/examples/module003.html +0 -202
  198. data/spec/templates/examples/module004.html +0 -394
  199. data/spec/templates/examples/module005.html +0 -82
  200. data/spec/templates/examples/tag001.txt +0 -82
  201. data/spec/templates/helpers/base_helper_spec.rb +0 -171
  202. data/spec/templates/helpers/html_helper_spec.rb +0 -666
  203. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +0 -65
  204. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +0 -84
  205. data/spec/templates/helpers/markup_helper_spec.rb +0 -136
  206. data/spec/templates/helpers/method_helper_spec.rb +0 -107
  207. data/spec/templates/helpers/module_helper_spec.rb +0 -35
  208. data/spec/templates/helpers/shared_signature_examples.rb +0 -126
  209. data/spec/templates/helpers/text_helper_spec.rb +0 -65
  210. data/spec/templates/markup_processor_integrations/asciidoctor_spec.rb +0 -60
  211. data/spec/templates/markup_processor_integrations/integration_spec_helper.rb +0 -50
  212. data/spec/templates/markup_processor_integrations/rdoc_markdown_spec.rb +0 -48
  213. data/spec/templates/markup_processor_integrations/rdoc_spec.rb +0 -39
  214. data/spec/templates/markup_processor_integrations/redcarpet_spec.rb +0 -64
  215. data/spec/templates/markup_processor_integrations/redcloth_spec.rb +0 -64
  216. data/spec/templates/method_spec.rb +0 -118
  217. data/spec/templates/module_spec.rb +0 -203
  218. data/spec/templates/onefile_spec.rb +0 -66
  219. data/spec/templates/section_spec.rb +0 -144
  220. data/spec/templates/spec_helper.rb +0 -76
  221. data/spec/templates/tag_spec.rb +0 -52
  222. data/spec/templates/template_spec.rb +0 -410
  223. data/spec/verifier_spec.rb +0 -106
@@ -1,254 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'stringio'
3
- require 'open-uri'
4
-
5
- RSpec.describe YARD::CLI::Diff do
6
- before do
7
- allow(CLI::Yardoc).to receive(:run)
8
- allow(CLI::Gems).to receive(:run)
9
- @diff = CLI::Diff.new
10
- end
11
-
12
- describe "Argument handling" do
13
- it "exits if there is only one gem name" do
14
- expect(@diff).to receive(:exit)
15
- expect(log).to receive(:puts).with(/Usage/)
16
- @diff.run
17
- end
18
- end
19
-
20
- describe "Diffing" do
21
- before do
22
- @objects1 = nil
23
- @objects2 = nil
24
- end
25
-
26
- def run(*args)
27
- @all_call = -1
28
- @data = StringIO.new
29
- @objects1 ||= %w(C#fooey C#baz D.bar)
30
- @objects2 ||= %w(A A::B A::B::C A.foo A#foo B C.foo C.bar C#baz)
31
- @objects = [@objects1, @objects2]
32
- expect(@diff).to receive(:load_gem_data).ordered.with('gem1') do
33
- Registry.clear
34
- YARD.parse_string <<-eof
35
- class C
36
- def fooey; end
37
- def baz; FOO end
38
- end
39
- class D
40
- def self.bar; end
41
- end
42
- eof
43
- end
44
- expect(@diff).to receive(:load_gem_data).ordered.with('gem2') do
45
- Registry.clear
46
- YARD.parse_string <<-eof
47
- module A
48
- module B
49
- class C; end
50
- end
51
- def self.foo; end
52
- def foo; end
53
- end
54
- class C
55
- def self.foo; end
56
- def self.bar; end
57
- def baz; BAR end
58
- end
59
- eof
60
- end
61
- allow(log).to receive(:print) {|data| @data << data }
62
- allow(log).to receive(:puts) {|*pargs| @data << pargs.join("\n"); @data << "\n" }
63
- @diff.run(*(args + ['gem1', 'gem2']))
64
- end
65
-
66
- it "shows differences between objects" do
67
- run
68
- expect(@data.string).to eq <<-eof
69
- Added objects:
70
-
71
- A ((stdin):1) (...)
72
- A::B::C ((stdin):3)
73
- C.bar ((stdin):10)
74
- C.foo ((stdin):9)
75
-
76
- Modified objects:
77
-
78
- C#baz ((stdin):3)
79
-
80
- Removed objects:
81
-
82
- C#fooey ((stdin):2)
83
- D ((stdin):5) (...)
84
-
85
- eof
86
- end
87
-
88
- it "accepts --compact" do
89
- run('--compact')
90
- expect(@data.string).to eq <<-eof
91
- A A ((stdin):1) (...)
92
- A A::B::C ((stdin):3)
93
- A C.bar ((stdin):10)
94
- A C.foo ((stdin):9)
95
- M C#baz ((stdin):3)
96
- D C#fooey ((stdin):2)
97
- D D ((stdin):5) (...)
98
- eof
99
- end
100
-
101
- it "accepts -a/--all" do
102
- ['-a', '--all'].each do |opt|
103
- run(opt)
104
- expect(@data.string).to eq <<-eof
105
- Added objects:
106
-
107
- A ((stdin):1)
108
- A#foo ((stdin):6)
109
- A.foo ((stdin):5)
110
- A::B ((stdin):2)
111
- A::B::C ((stdin):3)
112
- C.bar ((stdin):10)
113
- C.foo ((stdin):9)
114
-
115
- Modified objects:
116
-
117
- C#baz ((stdin):3)
118
-
119
- Removed objects:
120
-
121
- C#fooey ((stdin):2)
122
- D ((stdin):5)
123
- D.bar ((stdin):6)
124
-
125
- eof
126
- end
127
- end
128
-
129
- it "accepts --compact and --all" do
130
- run('--compact', '--all')
131
- expect(@data.string).to eq <<-eof
132
- A A ((stdin):1)
133
- A A#foo ((stdin):6)
134
- A A.foo ((stdin):5)
135
- A A::B ((stdin):2)
136
- A A::B::C ((stdin):3)
137
- A C.bar ((stdin):10)
138
- A C.foo ((stdin):9)
139
- M C#baz ((stdin):3)
140
- D C#fooey ((stdin):2)
141
- D D ((stdin):5)
142
- D D.bar ((stdin):6)
143
- eof
144
- end
145
-
146
- it "accepts --no-modified" do
147
- run('--compact', '--no-modified')
148
- expect(@data.string).to eq <<-eof
149
- A A ((stdin):1) (...)
150
- A A::B::C ((stdin):3)
151
- A C.bar ((stdin):10)
152
- A C.foo ((stdin):9)
153
- D C#fooey ((stdin):2)
154
- D D ((stdin):5) (...)
155
- eof
156
- end
157
-
158
- it "accepts --query" do
159
- run('--compact', '--query', 'o.type == :method')
160
- expect(@data.string).to eq <<-eof
161
- A A#foo ((stdin):6)
162
- A A.foo ((stdin):5)
163
- A C.bar ((stdin):10)
164
- A C.foo ((stdin):9)
165
- M C#baz ((stdin):3)
166
- D C#fooey ((stdin):2)
167
- D D.bar ((stdin):6)
168
- eof
169
- end
170
- end
171
-
172
- describe "File searching" do
173
- before do
174
- allow(@diff).to receive(:generate_yardoc)
175
- end
176
-
177
- it "searches for gem/.yardoc" do
178
- expect(File).to receive(:directory?).with('gem1/.yardoc').and_return(true)
179
- expect(File).to receive(:directory?).with('gem2/.yardoc').and_return(true)
180
- expect(Registry).to receive(:load_yardoc).with('gem1/.yardoc')
181
- expect(Registry).to receive(:load_yardoc).with('gem2/.yardoc')
182
- @diff.run('gem1', 'gem2')
183
- end
184
-
185
- it "searches for argument as yardoc" do
186
- expect(File).to receive(:directory?).with('gem1/.yardoc').and_return(false)
187
- expect(File).to receive(:directory?).with('gem2/.yardoc').and_return(false)
188
- expect(File).to receive(:directory?).with('gem1').and_return(true)
189
- expect(File).to receive(:directory?).with('gem2').and_return(true)
190
- expect(Registry).to receive(:load_yardoc).with('gem1')
191
- expect(Registry).to receive(:load_yardoc).with('gem2')
192
- @diff.run('gem1', 'gem2')
193
- end
194
-
195
- it "searches for installed gem" do
196
- expect(File).to receive(:directory?).with('gem1-1.0.0.gem/.yardoc').and_return(false)
197
- expect(File).to receive(:directory?).with('gem2-1.0.0/.yardoc').and_return(false)
198
- expect(File).to receive(:directory?).with('gem1-1.0.0.gem').and_return(false)
199
- expect(File).to receive(:directory?).with('gem2-1.0.0').and_return(false)
200
- spec1 = double(:spec)
201
- spec2 = double(:spec)
202
- allow(YARD::GemIndex).to receive(:each) {|&b| [spec1, spec2].each(&b) }
203
- allow(spec1).to receive(:full_name).and_return('gem1-1.0.0')
204
- allow(spec1).to receive(:name).and_return('gem1')
205
- allow(spec1).to receive(:version).and_return('1.0.0')
206
- allow(spec2).to receive(:full_name).and_return('gem2-1.0.0')
207
- allow(spec2).to receive(:name).and_return('gem2')
208
- allow(spec2).to receive(:version).and_return('1.0.0')
209
- expect(Registry).to receive(:yardoc_file_for_gem).with('gem1', '= 1.0.0').and_return('/path/to/file')
210
- expect(Registry).to receive(:yardoc_file_for_gem).with('gem2', '= 1.0.0').and_return(nil)
211
- expect(Registry).to receive(:load_yardoc).with('/path/to/file')
212
- expect(CLI::Gems).to receive(:run).with('gem2', '1.0.0').and_return(nil)
213
- allow(Dir).to receive(:chdir)
214
- @diff.run('gem1-1.0.0.gem', 'gem2-1.0.0')
215
- end
216
-
217
- it "searches for .gem file" do
218
- expect(File).to receive(:directory?).with('gem1/.yardoc').and_return(false)
219
- expect(File).to receive(:directory?).with('gem2.gem/.yardoc').and_return(false)
220
- expect(File).to receive(:directory?).with('gem1').and_return(false)
221
- expect(File).to receive(:directory?).with('gem2.gem').and_return(false)
222
- expect(File).to receive(:exist?).with('gem1.gem').and_return(true)
223
- expect(File).to receive(:exist?).with('gem2.gem').and_return(true)
224
- expect(File).to receive(:open).with('gem1.gem', 'rb')
225
- expect(File).to receive(:open).with('gem2.gem', 'rb')
226
- allow(FileUtils).to receive(:mkdir_p)
227
- allow(Gem::Package).to receive(:open)
228
- allow(FileUtils).to receive(:rm_rf)
229
- @diff.run('gem1', 'gem2.gem')
230
- end
231
-
232
- it "searches for .gem file on rubygems.org" do
233
- expect(File).to receive(:directory?).with('gem1/.yardoc').and_return(false)
234
- expect(File).to receive(:directory?).with('gem2.gem/.yardoc').and_return(false)
235
- expect(File).to receive(:directory?).with('gem1').and_return(false)
236
- expect(File).to receive(:directory?).with('gem2.gem').and_return(false)
237
- expect(File).to receive(:exist?).with('gem1.gem').and_return(false)
238
- expect(File).to receive(:exist?).with('gem2.gem').and_return(false)
239
- expect(@diff).to receive(:open).with('http://rubygems.org/downloads/gem1.gem')
240
- expect(@diff).to receive(:open).with('http://rubygems.org/downloads/gem2.gem')
241
- allow(FileUtils).to receive(:mkdir_p)
242
- allow(Gem::Package).to receive(:open)
243
- allow(FileUtils).to receive(:rm_rf)
244
- @diff.run('gem1', 'gem2.gem')
245
- end
246
-
247
- it "raises an error if gem is not found" do
248
- expect(log).to receive(:error).with("Cannot find gem gem1")
249
- expect(log).to receive(:error).with("Cannot find gem gem2.gem")
250
- allow(@diff).to receive(:load_gem_data).and_return(false)
251
- @diff.run('gem1', 'gem2.gem')
252
- end
253
- end
254
- end
@@ -1,30 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- RSpec.describe YARD::CLI::Display do
4
- before do
5
- allow(Registry).to receive(:load)
6
- @object = CodeObjects::ClassObject.new(:root, :Foo)
7
- @object.docstring = 'Foo bar'
8
- end
9
-
10
- it "displays an object" do
11
- YARD::CLI::Display.run('-f', 'text', 'Foo')
12
- expect(log.io.string.strip).to eq(@object.format.strip)
13
- end
14
-
15
- it "wraps output with -l (defaulting to layout)" do
16
- YARD::CLI::Display.run('-l', '-f', 'html', 'Foo')
17
- formatted_output = @object.format(:format => :html).strip
18
- actual_output = log.io.string.strip
19
- expect(actual_output).not_to eq(formatted_output)
20
- expect(actual_output).to include(formatted_output)
21
- end
22
-
23
- it "wraps output with --layout onefile" do
24
- YARD::CLI::Display.run('--layout', 'onefile', '-f', 'html', 'Foo')
25
- formatted_output = @object.format(:format => :html).strip
26
- actual_output = log.io.string.strip
27
- expect(actual_output).not_to eq(formatted_output)
28
- expect(actual_output).to include(formatted_output)
29
- end
30
- end
@@ -1,81 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'ostruct'
3
- require 'rubygems'
4
-
5
- RSpec.describe YARD::CLI::Gems do
6
- before do
7
- @rebuild = false
8
- @gem1 = build_mock('gem1')
9
- @gem2 = build_mock('gem2')
10
- @gem3 = build_mock('gem3')
11
- end
12
-
13
- def build_mock(name, version = '1.0')
14
- OpenStruct.new :name => name,
15
- :version => version,
16
- :full_gem_path => "/path/to/gems/#{name}-#{version}",
17
- :yardoc_file => "/path/to/yardoc/#{name}-#{version}"
18
- end
19
-
20
- def build_specs(*specs)
21
- specs.each do |themock|
22
- allow(Registry).to receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}").and_return(themock.yardoc_file)
23
- allow(File).to receive(:directory?).with(themock.yardoc_file).and_return(@rebuild)
24
- allow(File).to receive(:directory?).with(themock.full_gem_path).and_return(true)
25
- allow(Registry).to receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}", true).and_return(themock.yardoc_file)
26
- expect(Dir).to receive(:chdir).with(themock.full_gem_path).and_yield
27
- end
28
- expect(Registry).to receive(:clear).exactly(specs.size).times
29
- expect(CLI::Yardoc).to receive(:run).exactly(specs.size).times
30
- end
31
-
32
- describe "#run" do
33
- it "builds all gem indexes if no gem is specified" do
34
- build_specs(@gem1, @gem2)
35
- expect(YARD::GemIndex).to receive(:each) {|&b| [@gem1, @gem2].each(&b) }
36
- CLI::Gems.run
37
- end
38
-
39
- it "allows gem to be specified" do
40
- build_specs(@gem1)
41
- expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 0').and_return([@gem1])
42
- CLI::Gems.run(@gem1.name)
43
- end
44
-
45
- it "allows multiple gems to be specified for building" do
46
- build_specs(@gem1, @gem2)
47
- expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, @gem1.version).and_return([@gem1])
48
- expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem2.name, '>= 0').and_return([@gem2])
49
- CLI::Gems.run(@gem1.name, @gem1.version, @gem2.name)
50
- end
51
-
52
- it "allows version to be specified with gem" do
53
- build_specs(@gem1)
54
- expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 1.0').and_return([@gem1])
55
- CLI::Gems.run(@gem1.name, '>= 1.0')
56
- end
57
-
58
- it "warns if one of the gems is not found, but it should process others" do
59
- build_specs(@gem2)
60
- expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 2.0').and_return([])
61
- expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem2.name, '>= 0').and_return([@gem2])
62
- expect(log).to receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
63
- CLI::Gems.run(@gem1.name, '>= 2.0', @gem2.name)
64
- end
65
-
66
- it "fails if specified gem(s) is/are not found" do
67
- expect(CLI::Yardoc).not_to receive(:run)
68
- expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 2.0').and_return([])
69
- expect(log).to receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
70
- expect(log).to receive(:error).with(/No specified gems could be found/)
71
- CLI::Gems.run(@gem1.name, '>= 2.0')
72
- end
73
-
74
- it "accepts --rebuild" do
75
- @rebuild = true
76
- build_specs(@gem1)
77
- expect(YARD::GemIndex).to receive(:each) {|&b| [@gem1].each(&b) }
78
- CLI::Gems.run('--rebuild')
79
- end
80
- end
81
- end
@@ -1,18 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- RSpec.describe YARD::CLI::Graph do
4
- it "serializes output" do
5
- allow(Registry).to receive(:load).at_least(1).times
6
- allow(subject).to receive(:yardopts) { [] }
7
- expect(subject.options.serializer).to receive(:serialize).once
8
- subject.run
9
- end
10
-
11
- it "reads yardoc file from .yardopts" do
12
- allow(Registry).to receive(:load).at_least(1).times
13
- allow(subject).to receive(:yardopts) { %w(--db /path/to/db) }
14
- expect(subject.options.serializer).to receive(:serialize).once
15
- subject.run
16
- expect(Registry.yardoc_file).to eq '/path/to/db'
17
- end
18
- end
@@ -1,22 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- RSpec.describe YARD::CLI::Help do
4
- describe "#run" do
5
- it "accepts help command" do
6
- expect(CLI::Yardoc).to receive(:run).with('--help')
7
- CLI::Help.run('doc')
8
- end
9
-
10
- it "accepts no arguments (and lists all commands)" do
11
- expect(CLI::CommandParser).to receive(:run).with('--help')
12
- CLI::Help.run
13
- end
14
-
15
- it "shows all commands if command isn't found" do
16
- expect(CLI::CommandParser).to receive(:run).with('--help')
17
- help = CLI::Help.new
18
- expect(log).to receive(:puts).with(/not found/)
19
- help.run('unknown')
20
- end
21
- end
22
- end
@@ -1,107 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- RSpec.describe YARD::CLI::I18n do
4
- before do
5
- @i18n = YARD::CLI::I18n.new
6
- @i18n.use_document_file = false
7
- @i18n.use_yardopts_file = false
8
- output_path = File.expand_path(@i18n.options.serializer.basepath)
9
- allow(File).to receive(:open!).with(output_path, "wb")
10
- allow(YARD).to receive(:parse)
11
- end
12
-
13
- describe "Defaults" do
14
- before do
15
- @i18n = YARD::CLI::I18n.new
16
- allow(@i18n).to receive(:yardopts).and_return([])
17
- allow(@i18n).to receive(:support_rdoc_document_file!).and_return([])
18
- @i18n.parse_arguments
19
- end
20
-
21
- it "reads .yardopts by default" do
22
- expect(@i18n.use_yardopts_file).to be true
23
- end
24
-
25
- it "only shows public visibility by default" do
26
- expect(@i18n.visibilities).to eq [:public]
27
- end
28
- end
29
-
30
- describe "General options" do
31
- def self.should_accept(*args, &block)
32
- @counter ||= 0
33
- @counter += 1
34
- counter = @counter
35
- args.each do |arg|
36
- define_method("test_options_#{@counter}", &block)
37
- it("accepts #{arg}") { send("test_options_#{counter}", arg) }
38
- end
39
- end
40
-
41
- should_accept('--yardopts') do |arg|
42
- @i18n = YARD::CLI::I18n.new
43
- @i18n.use_document_file = false
44
- expect(@i18n).to receive(:yardopts).at_least(1).times.and_return([])
45
- @i18n.parse_arguments(arg)
46
- expect(@i18n.use_yardopts_file).to be true
47
- @i18n.parse_arguments('--no-yardopts', arg)
48
- expect(@i18n.use_yardopts_file).to be true
49
- end
50
-
51
- should_accept('--yardopts with filename') do |_arg|
52
- @i18n = YARD::CLI::I18n.new
53
- expect(File).to receive(:read_binary).with('.yardopts_i18n').and_return('')
54
- @i18n.use_document_file = false
55
- @i18n.parse_arguments('--yardopts', '.yardopts_i18n')
56
- expect(@i18n.use_yardopts_file).to be true
57
- expect(@i18n.options_file).to eq '.yardopts_i18n'
58
- end
59
-
60
- should_accept('--no-yardopts') do |arg|
61
- @i18n = YARD::CLI::I18n.new
62
- @i18n.use_document_file = false
63
- expect(@i18n).not_to receive(:yardopts)
64
- @i18n.parse_arguments(arg)
65
- expect(@i18n.use_yardopts_file).to be false
66
- @i18n.parse_arguments('--yardopts', arg)
67
- expect(@i18n.use_yardopts_file).to be false
68
- end
69
-
70
- should_accept('--exclude') do |arg|
71
- expect(YARD).to receive(:parse).with(['a'], ['nota', 'b'])
72
- @i18n.run(arg, 'nota', arg, 'b', 'a')
73
- end
74
- end
75
-
76
- describe ".yardopts handling" do
77
- before do
78
- @i18n.use_yardopts_file = true
79
- end
80
-
81
- it "searches for and uses yardopts file specified by #options_file" do
82
- expect(File).to receive(:read_binary).with("test").and_return("-o \n\nMYPATH\nFILE1 FILE2")
83
- @i18n.use_document_file = false
84
- @i18n.options_file = "test"
85
- expect(File).to receive(:open!).with(File.expand_path("MYPATH"), "wb")
86
- @i18n.run
87
- expect(@i18n.files).to eq ["FILE1", "FILE2"]
88
- end
89
- end
90
-
91
- describe "#run" do
92
- it "calls parse_arguments if run() is called" do
93
- expect(@i18n).to receive(:parse_arguments)
94
- @i18n.run
95
- end
96
-
97
- it "calls parse_arguments if run(arg1, arg2, ...) is called" do
98
- expect(@i18n).to receive(:parse_arguments)
99
- @i18n.run('--private', '-p', 'foo')
100
- end
101
-
102
- it "doesn't call parse_arguments if run(nil) is called" do
103
- expect(@i18n).not_to receive(:parse_arguments)
104
- @i18n.run(nil)
105
- end
106
- end
107
- end