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,60 +0,0 @@
1
- # frozen_string_literal: true
2
- require File.dirname(__FILE__) + '/spec_helper'
3
-
4
- RSpec.describe YARD::Server::DocServerSerializer do
5
- describe "#serialized_path" do
6
- before do
7
- Registry.clear
8
- @serializer = Server::DocServerSerializer.new
9
- end
10
-
11
- after(:all) { Server::Adapter.shutdown }
12
-
13
- it "returns '/PREFIX/library/toplevel' for root" do
14
- expect(@serializer.serialized_path(Registry.root)).to eq "toplevel"
15
- end
16
-
17
- it "returns /PREFIX/library/Object for Object in a library" do
18
- expect(@serializer.serialized_path(P('A::B::C'))).to eq 'A/B/C'
19
- end
20
-
21
- it "links to instance method as Class:method" do
22
- obj = CodeObjects::MethodObject.new(:root, :method)
23
- expect(@serializer.serialized_path(obj)).to eq 'toplevel:method'
24
- end
25
-
26
- it "links to class method as Class.method" do
27
- obj = CodeObjects::MethodObject.new(:root, :method, :class)
28
- expect(@serializer.serialized_path(obj)).to eq 'toplevel.method'
29
- end
30
-
31
- it "links to anchor for constant" do
32
- obj = CodeObjects::ConstantObject.new(:root, :FOO)
33
- expect(@serializer.serialized_path(obj)).to eq 'toplevel#FOO-constant'
34
- end
35
-
36
- it "links to anchor for class variable" do
37
- obj = CodeObjects::ClassVariableObject.new(:root, :@@foo)
38
- expect(@serializer.serialized_path(obj)).to eq 'toplevel#@@foo-classvariable'
39
- end
40
-
41
- it "links files using file/ prefix" do
42
- file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
43
- expect(@serializer.serialized_path(file)).to eq 'file/FooBar'
44
- end
45
-
46
- it "escapes special characters" do
47
- obj = CodeObjects::MethodObject.new(:root, :method?)
48
- expect(@serializer.serialized_path(obj)).to eq 'toplevel:method%3F'
49
- end
50
-
51
- it "handles unicode data" do
52
- file = CodeObjects::ExtraFileObject.new("test\u0160", '')
53
- if file.name.encoding == Encoding.find("Windows-1252")
54
- expect(@serializer.serialized_path(file)).to eq 'file/test_8A'
55
- else
56
- expect(@serializer.serialized_path(file)).to eq 'file/test_C5A0'
57
- end
58
- end if defined?(::Encoding)
59
- end
60
- end
@@ -1,21 +0,0 @@
1
- # frozen_string_literal: true
2
- require File.dirname(__FILE__) + "/spec_helper"
3
-
4
- RSpec.describe "YARD::Server::RackMiddleware" do
5
- before do
6
- begin; require 'rack'; rescue LoadError; pending "rack required for these tests" end
7
- @superapp = double(:superapp)
8
- @app = YARD::Server::RackMiddleware.new(@superapp, :libraries => {'foo' => [LibraryVersion.new('foo', nil)]})
9
- end
10
-
11
- after(:all) { YARD::Server::Adapter.shutdown }
12
-
13
- it "handles requests" do
14
- expect(@app.call(Rack::MockRequest.env_for('/'))[0]).to eq 200
15
- end
16
-
17
- it "passes up to the next middleware on 404" do
18
- expect(@superapp).to receive(:call).and_return([200, {}, ['OK']])
19
- expect(@app.call(Rack::MockRequest.env_for('/INVALID'))).to eq [200, {}, ['OK']]
20
- end
21
- end
@@ -1,123 +0,0 @@
1
- # frozen_string_literal: true
2
- require File.dirname(__FILE__) + '/spec_helper'
3
-
4
- class MyRouterSpecRouter < Router
5
- def docs_prefix; 'mydocs/foo' end
6
- def list_prefix; 'mylist/foo' end
7
- def search_prefix; 'mysearch/foo' end
8
-
9
- def check_static_cache; nil end
10
- end
11
-
12
- RSpec.describe YARD::Server::Router do
13
- before do
14
- @adapter = mock_adapter
15
- @projects = @adapter.libraries['project']
16
- @request = mock_request
17
- end
18
-
19
- describe "#parse_library_from_path" do
20
- def parse(*args)
21
- @request.path_info = '/' + args.join('/')
22
- @router = MyRouterSpecRouter.new(@adapter)
23
- @router.request = @request
24
- @router.parse_library_from_path(args.flatten)
25
- end
26
-
27
- it "parses library and version name out of path" do
28
- expect(parse('project', '1.0.0')).to eq [@projects[0], []]
29
- expect(@request.version_supplied).to be true
30
- end
31
-
32
- it "parses library and use latest version if version is not supplied" do
33
- expect(parse('project')).to eq [@projects[1], []]
34
- expect(@request.version_supplied).to be false
35
- end
36
-
37
- it "parses library and use latest version if next component is not a version" do
38
- expect(parse('project', 'notaversion')).to eq [@projects[1], ['notaversion']]
39
- expect(@request.version_supplied).to be false
40
- end
41
-
42
- it "returns nil library if no library is found" do
43
- expect(parse('notproject')).to eq [nil, ['notproject']]
44
- end
45
-
46
- it "does not parse library or version if single_library == true" do
47
- allow(@adapter).to receive(:options).and_return(:single_library => true)
48
- expect(parse('notproject')).to eq [@projects[0], ['notproject']]
49
- end
50
- end
51
-
52
- describe "#route" do
53
- def route_to(route, command, script_name = '')
54
- req = mock_request(route, script_name)
55
- router = MyRouterSpecRouter.new(@adapter)
56
- expect(command).to receive(:new) do |*args|
57
- @command = command.allocate
58
- @command.send(:initialize, *args)
59
- class << @command; define_method(:call) {|*| self } end
60
- @command
61
- end
62
- router.call(req)
63
- end
64
-
65
- it "routes /docs/OBJECT to object if single_library = true" do
66
- allow(@adapter).to receive(:options).and_return(:single_library => true)
67
- route_to('/mydocs/foo/FOO', DisplayObjectCommand)
68
- end
69
-
70
- it "routes /docs" do
71
- route_to('/mydocs/foo', LibraryIndexCommand)
72
- end
73
-
74
- it "routes /docs as index for library if single_library == true" do
75
- allow(@adapter).to receive(:options).and_return(:single_library => true)
76
- route_to('/mydocs/foo/', DisplayObjectCommand)
77
- end
78
-
79
- it "routes /docs/name/version" do
80
- route_to('/mydocs/foo/project/1.0.0', DisplayObjectCommand)
81
- expect(@command.library).to eq @projects[0]
82
- end
83
-
84
- it "routes /docs/name/ to latest version of library" do
85
- route_to('/mydocs/foo/project', DisplayObjectCommand)
86
- expect(@command.library).to eq @projects[1]
87
- end
88
-
89
- it "routes /list/name/version/class" do
90
- route_to('/mylist/foo/project/1.0.0/class', ListCommand)
91
- expect(@command.library).to eq @projects[0]
92
- end
93
-
94
- it "routes /list/name/version/methods" do
95
- route_to('/mylist/foo/project/1.0.0/methods', ListCommand)
96
- expect(@command.library).to eq @projects[0]
97
- end
98
-
99
- it "routes /list/name/version/files" do
100
- route_to('/mylist/foo/project/1.0.0/files', ListCommand)
101
- expect(@command.library).to eq @projects[0]
102
- end
103
-
104
- it "routes /list/name to latest version of library" do
105
- route_to('/mylist/foo/project/class', ListCommand)
106
- expect(@command.library).to eq @projects[1]
107
- end
108
-
109
- it "routes /search/name/version" do
110
- route_to('/mysearch/foo/project/1.0.0', SearchCommand)
111
- expect(@command.library).to eq @projects[0]
112
- end
113
-
114
- it "routes /search/name to latest version of library" do
115
- route_to('/mysearch/foo/project', SearchCommand)
116
- expect(@command.library).to eq @projects[1]
117
- end
118
-
119
- it "searches static files for non-existent library" do
120
- route_to('/mydocs/foo/notproject', RootRequestCommand)
121
- end
122
- end
123
- end
@@ -1,22 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'ostruct'
3
-
4
- include Server
5
- include Commands
6
-
7
- def mock_adapter(opts = {})
8
- opts[:libraries] ||= {'project' => [LibraryVersion.new('project', '1.0.0'), LibraryVersion.new('project', '1.0.1')]}
9
- opts[:document_root] ||= '/public'
10
- opts[:options] ||= {:single_library => false, :caching => false}
11
- opts[:server_options] ||= {}
12
- OpenStruct.new(opts)
13
- end
14
-
15
- class MockRequest < OpenStruct
16
- def path; "#{script_name}#{path_info}" end
17
- end
18
-
19
- def mock_request(path_info = '/', script_name = '', extra_env = {})
20
- opts = {:path_info => path_info, :script_name => script_name}
21
- MockRequest.new(extra_env.merge(opts))
22
- end
@@ -1,47 +0,0 @@
1
- # frozen_string_literal: true
2
- require File.dirname(__FILE__) + '/spec_helper'
3
-
4
- RSpec.describe YARD::Server::StaticCaching do
5
- include StaticCaching
6
-
7
- describe "#check_static_cache" do
8
- def adapter; @adapter ||= mock_adapter end
9
- def request; @request ||= MockRequest.new end
10
-
11
- it "returns nil if document root is not set" do
12
- adapter.document_root = nil
13
- expect(check_static_cache).to be nil
14
- end
15
-
16
- it "reads a file from document root if path matches file on system" do
17
- request.path_info = '/hello/world.html'
18
- expect(File).to receive(:file?).with('/public/hello/world.html').and_return(true)
19
- expect(File).to receive(:open).with('/public/hello/world.html', anything).and_return('body')
20
- s, _, b = *check_static_cache
21
- expect(s).to eq 200
22
- expect(b).to eq ["body"]
23
- end
24
-
25
- it "reads a file if path matches file on system + .html" do
26
- request.path_info = '/hello/world'
27
- expect(File).to receive(:file?).with('/public/hello/world.html').and_return(true)
28
- expect(File).to receive(:open).with('/public/hello/world.html', anything).and_return('body')
29
- s, _, b = *check_static_cache
30
- expect(s).to eq 200
31
- expect(b).to eq ["body"]
32
- end
33
-
34
- it "returns nil if no matching file is found" do
35
- request.path_info = '/hello/foo'
36
- expect(File).to receive(:file?).with('/public/hello/foo.html').and_return(false)
37
- expect(check_static_cache).to eq nil
38
- end
39
-
40
- it "adds mount point to cache location" do
41
- request.path_info = '/hello/world.html'
42
- request.script_name = '/mount/point'
43
- expect(File).to receive(:file?).with('/public/mount/point/hello/world.html').and_return(false)
44
- expect(check_static_cache).to eq nil
45
- end
46
- end
47
- end
@@ -1,20 +0,0 @@
1
- # frozen_string_literal: true
2
- require File.dirname(__FILE__) + '/spec_helper'
3
-
4
- RSpec.describe YARD::Server::WebrickServlet do
5
- describe "#do_GET" do
6
- it "performs a GET" do
7
- resp = OpenStruct.new
8
- class << resp
9
- def []=(name, value) (self.headers ||= {})[name] = value end
10
- end
11
- server = double(:server, :[] => nil)
12
- adapter = mock_adapter
13
- adapter.router = proc { [200, {'Header' => 'foo'}, ['body']] }
14
- WebrickServlet.new(server, adapter).do_GET(mock_request('/foo'), resp)
15
- expect(resp.status).to eq 200
16
- expect(resp.headers).to eq('Header' => 'foo')
17
- expect(resp.body).to eq 'body'
18
- end
19
- end
20
- end
@@ -1,19 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- RSpec.describe YARD::Server do
4
- describe ".register_static_path" do
5
- it "registers a static path" do
6
- YARD::Server.register_static_path 'foo'
7
- expect(YARD::Server::Commands::StaticFileCommand::STATIC_PATHS.last).to eq "foo"
8
- end
9
-
10
- it "does not duplicate paths" do
11
- paths = YARD::Server::Commands::StaticFileCommand::STATIC_PATHS
12
- count = paths.size
13
- YARD::Server.register_static_path 'foo2'
14
- YARD::Server.register_static_path 'foo2'
15
- expect(paths.size).to eq(count + 1)
16
- expect(paths.last).to eq 'foo2'
17
- end
18
- end
19
- end
@@ -1,212 +0,0 @@
1
- # frozen_string_literal: true
2
- require "rubygems"
3
- begin
4
- require "rspec"
5
- rescue LoadError
6
- require "spec"
7
- end
8
-
9
- begin
10
- require 'bundler/setup'
11
- rescue LoadError
12
- nil # noop
13
- end
14
-
15
- require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'yard'))
16
-
17
- unless defined?(HAVE_RIPPER)
18
- begin require 'ripper'; rescue LoadError; nil end
19
- HAVE_RIPPER = defined?(::Ripper) && !ENV['LEGACY'] ? true : false
20
- LEGACY_PARSER = !HAVE_RIPPER
21
-
22
- class YARD::Parser::SourceParser
23
- def self.parser_type; @parser_type == :ruby ? :ruby18 : @parser_type end
24
- end if ENV['LEGACY']
25
- end
26
-
27
- begin
28
- require 'coveralls'
29
- Coveralls.wear!
30
- end if ENV['CI'] && HAVE_RIPPER
31
-
32
- NAMED_OPTIONAL_ARGUMENTS = RUBY_VERSION >= '2.1.0'
33
-
34
- def parse_file(file, thisfile = __FILE__, log_level = log.level, ext = '.rb.txt')
35
- Registry.clear
36
- path = File.join(File.dirname(thisfile), 'examples', file.to_s + ext)
37
- YARD::Parser::SourceParser.parse(path, [], log_level)
38
- end
39
-
40
- def described_in_docs(klass, meth, file = nil)
41
- YARD::Tags::Library.define_tag "RSpec Specification", :it, :with_raw_title_and_text
42
-
43
- # Parse the file (could be multiple files)
44
- if file
45
- filename = File.join(YARD::ROOT, file)
46
- YARD::Parser::SourceParser.new.parse(filename)
47
- else
48
- underscore = klass.class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
49
- $LOADED_FEATURES.find_all {|p| p.include? underscore }.each do |found_fname|
50
- next unless File.exist? found_fname
51
- YARD::Parser::SourceParser.new.parse(found_fname)
52
- end
53
- end
54
-
55
- # Get the object
56
- objname = klass.name + (meth[0, 1] == '#' ? meth : '::' + meth)
57
- obj = Registry.at(objname)
58
- raise "Cannot find object #{objname} described by spec." unless obj
59
- raise "#{obj.path} has no @it tags to spec." unless obj.has_tag? :it
60
-
61
- # Run examples
62
- describe(klass, meth) do
63
- obj.tags(:it).each do |it|
64
- path = File.relative_path(YARD::ROOT, obj.file)
65
- it(it.name + " (from #{path}:#{obj.line})") do
66
- begin
67
- eval(it.text)
68
- rescue => e
69
- e.set_backtrace(["#{path}:#{obj.line}:in @it tag specification"])
70
- raise e
71
- end
72
- end
73
- end
74
- end
75
- end
76
-
77
- def docspec(objname = self.class.description, klass = self.class.described_type)
78
- # Parse the file (could be multiple files)
79
- underscore = klass.class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
80
- $LOADED_FEATURES.find_all {|p| p.include? underscore }.each do |filename|
81
- filename = File.join(YARD::ROOT, filename)
82
- next unless File.exist? filename
83
- YARD::Parser::SourceParser.new.parse(filename)
84
- end
85
-
86
- # Get the object
87
- objname = klass.name + objname if objname =~ /^[^A-Z]/
88
- obj = Registry.at(objname)
89
- raise "Cannot find object #{objname} described by spec." unless obj
90
- raise "#{obj.path} has no @example tags to spec." unless obj.has_tag? :example
91
-
92
- # Run examples
93
- obj.tags(:example).each do |exs|
94
- exs.text.split(/\n/).each do |ex|
95
- begin
96
- hash = eval("{ #{ex} }")
97
- expect(hash.keys.first).to eq hash.values.first
98
- rescue => e
99
- raise e, "#{e.message}\nInvalid spec example in #{objname}:\n\n\t#{ex}\n"
100
- end
101
- end
102
- end
103
- end
104
-
105
- module Kernel
106
- require 'cgi'
107
-
108
- def p(*args)
109
- puts args.map {|arg| CGI.escapeHTML(arg.inspect) }.join("<br/>\n")
110
- args.first
111
- end
112
-
113
- def puts(str = '')
114
- STDOUT.puts str + "<br/>\n"
115
- str
116
- end
117
- end if ENV['TM_APP_PATH']
118
-
119
- RSpec.configure do |config|
120
- config.before(:each) { log.io = StringIO.new }
121
-
122
- # isolate environment of each test
123
- # any other global settings which might be modified by a test should also
124
- # be saved and restored here
125
- config.around(:each) do |example|
126
- saved_level = log.level
127
- example.run
128
- log.level = saved_level
129
- end
130
-
131
- # rspec-expectations config goes here. You can use an alternate
132
- # assertion/expectation library such as wrong or the stdlib/minitest
133
- # assertions if you prefer.
134
- config.expect_with :rspec do |expectations|
135
- # This option will default to `true` in RSpec 4. It makes the `description`
136
- # and `failure_message` of custom matchers include text for helper methods
137
- # defined using `chain`, e.g.:
138
- # be_bigger_than(2).and_smaller_than(4).description
139
- # # => "be bigger than 2 and smaller than 4"
140
- # ...rather than:
141
- # # => "be bigger than 2"
142
- expectations.include_chain_clauses_in_custom_matcher_descriptions = true
143
- end
144
-
145
- # rspec-mocks config goes here. You can use an alternate test double
146
- # library (such as bogus or mocha) by changing the `mock_with` option here.
147
- config.mock_with :rspec do |mocks|
148
- # Prevents you from mocking or stubbing a method that does not exist on
149
- # a real object. This is generally recommended, and will default to
150
- # `true` in RSpec 4.
151
- # mocks.verify_partial_doubles = true # FIXME: Not yet working
152
- end
153
-
154
- # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
155
- # have no way to turn it off -- the option exists only for backwards
156
- # compatibility in RSpec 3). It causes shared context metadata to be
157
- # inherited by the metadata hash of host groups and examples, rather than
158
- # triggering implicit auto-inclusion in groups with matching metadata.
159
- config.shared_context_metadata_behavior = :apply_to_host_groups
160
-
161
- # This allows you to limit a spec run to individual examples or groups
162
- # you care about by tagging them with `:focus` metadata. When nothing
163
- # is tagged with `:focus`, all examples get run. RSpec also provides
164
- # aliases for `it`, `describe`, and `context` that include `:focus`
165
- # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
166
- config.filter_run_when_matching :focus
167
-
168
- # Allows RSpec to persist some state between runs in order to support
169
- # the `--only-failures` and `--next-failure` CLI options. We recommend
170
- # you configure your source control system to ignore this file.
171
- config.example_status_persistence_file_path = "spec/examples.txt"
172
-
173
- # Limits the available syntax to the non-monkey patched syntax that is
174
- # recommended. For more details, see:
175
- # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
176
- # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
177
- # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
178
- config.disable_monkey_patching!
179
-
180
- # This setting enables warnings. It's recommended, but in some cases may
181
- # be too noisy due to issues in dependencies.
182
- config.warnings = false
183
-
184
- # Many RSpec users commonly either run the entire suite or an individual
185
- # file, and it's useful to allow more verbose output when running an
186
- # individual spec file.
187
- if config.files_to_run.one?
188
- # Use the documentation formatter for detailed output,
189
- # unless a formatter has already been configured
190
- # (e.g. via a command-line flag).
191
- config.default_formatter = 'doc'
192
- end
193
-
194
- # Print the N slowest examples and example groups at the
195
- # end of the spec run, to help surface which specs are running
196
- # particularly slow.
197
- config.profile_examples = 5
198
-
199
- # Run specs in random order to surface order dependencies. If you find an
200
- # order dependency and want to debug it, you can fix the order by providing
201
- # the seed, which is printed after each run.
202
- # --seed 1234
203
- # config.order = :random # FIXME: Not yet working
204
-
205
- # Seed global randomization in this process using the `--seed` CLI option.
206
- # Setting this allows you to use `--seed` to deterministically reproduce
207
- # test failures related to randomization by passing the same `--seed` value
208
- # as the one that triggered the failure.
209
- Kernel.srand config.seed
210
- end
211
-
212
- include YARD