mocha 1.0.0.alpha → 1.10.0.alpha

Sign up to get free protection for your applications and to get access to all the features.
Files changed (313) hide show
  1. checksums.yaml +5 -5
  2. data/.rubocop.yml +61 -0
  3. data/.rubocop_todo.yml +27 -0
  4. data/CONTRIBUTING.md +7 -0
  5. data/README.md +136 -42
  6. data/RELEASE.md +166 -16
  7. data/Rakefile +52 -36
  8. data/bin/build-matrix +32 -21
  9. data/docs/CNAME +1 -0
  10. data/docs/Mocha.html +254 -0
  11. data/docs/Mocha/API.html +1129 -0
  12. data/docs/Mocha/ClassMethods.html +339 -0
  13. data/docs/Mocha/Configuration.html +1383 -0
  14. data/docs/Mocha/Expectation.html +2654 -0
  15. data/docs/Mocha/ExpectationError.html +152 -0
  16. data/docs/Mocha/ExpectationErrorFactory.html +260 -0
  17. data/docs/Mocha/Hooks.html +370 -0
  18. data/docs/Mocha/Integration.html +125 -0
  19. data/docs/Mocha/Integration/MiniTest.html +123 -0
  20. data/docs/Mocha/Integration/MiniTest/Adapter.html +164 -0
  21. data/docs/Mocha/Integration/TestUnit.html +123 -0
  22. data/docs/Mocha/Integration/TestUnit/Adapter.html +164 -0
  23. data/docs/Mocha/Mock.html +1237 -0
  24. data/docs/Mocha/ObjectMethods.html +765 -0
  25. data/docs/Mocha/ParameterMatchers.html +2961 -0
  26. data/docs/Mocha/ParameterMatchers/AllOf.html +153 -0
  27. data/docs/Mocha/ParameterMatchers/AnyOf.html +153 -0
  28. data/docs/Mocha/ParameterMatchers/AnyParameters.html +153 -0
  29. data/docs/Mocha/ParameterMatchers/Anything.html +153 -0
  30. data/docs/Mocha/ParameterMatchers/Base.html +441 -0
  31. data/docs/Mocha/ParameterMatchers/Equals.html +153 -0
  32. data/docs/Mocha/ParameterMatchers/EquivalentUri.html +153 -0
  33. data/docs/Mocha/ParameterMatchers/HasEntries.html +153 -0
  34. data/docs/Mocha/ParameterMatchers/HasEntry.html +153 -0
  35. data/docs/Mocha/ParameterMatchers/HasKey.html +153 -0
  36. data/docs/Mocha/ParameterMatchers/HasValue.html +153 -0
  37. data/docs/Mocha/ParameterMatchers/Includes.html +153 -0
  38. data/docs/Mocha/ParameterMatchers/InstanceOf.html +153 -0
  39. data/docs/Mocha/ParameterMatchers/IsA.html +153 -0
  40. data/docs/Mocha/ParameterMatchers/KindOf.html +153 -0
  41. data/docs/Mocha/ParameterMatchers/Not.html +153 -0
  42. data/docs/Mocha/ParameterMatchers/Optionally.html +153 -0
  43. data/docs/Mocha/ParameterMatchers/RegexpMatches.html +153 -0
  44. data/docs/Mocha/ParameterMatchers/RespondsWith.html +153 -0
  45. data/docs/Mocha/ParameterMatchers/YamlEquivalent.html +153 -0
  46. data/docs/Mocha/Sequence.html +149 -0
  47. data/docs/Mocha/StateMachine.html +527 -0
  48. data/docs/Mocha/StateMachine/State.html +140 -0
  49. data/docs/Mocha/StateMachine/StatePredicate.html +140 -0
  50. data/docs/Mocha/StubbingError.html +150 -0
  51. data/docs/_index.html +519 -0
  52. data/docs/class_list.html +51 -0
  53. data/docs/css/common.css +1 -0
  54. data/docs/css/full_list.css +58 -0
  55. data/docs/css/style.css +496 -0
  56. data/docs/file.COPYING.html +81 -0
  57. data/docs/file.MIT-LICENSE.html +85 -0
  58. data/docs/file.README.html +429 -0
  59. data/docs/file.RELEASE.html +942 -0
  60. data/docs/file_list.html +71 -0
  61. data/docs/frames.html +17 -0
  62. data/docs/index.html +429 -0
  63. data/docs/js/app.js +303 -0
  64. data/docs/js/full_list.js +216 -0
  65. data/docs/js/jquery.js +4 -0
  66. data/docs/method_list.html +635 -0
  67. data/docs/top-level-namespace.html +118 -0
  68. data/gemfiles/Gemfile.minitest.5.11.3 +7 -0
  69. data/gemfiles/Gemfile.test-unit.latest +5 -1
  70. data/init.rb +1 -3
  71. data/lib/mocha.rb +8 -0
  72. data/lib/mocha/any_instance_method.rb +12 -50
  73. data/lib/mocha/api.rb +63 -65
  74. data/lib/mocha/argument_iterator.rb +4 -8
  75. data/lib/mocha/backtrace_filter.rb +1 -5
  76. data/lib/mocha/cardinality.rb +43 -35
  77. data/lib/mocha/central.rb +21 -12
  78. data/lib/mocha/change_state_side_effect.rb +0 -4
  79. data/lib/mocha/class_methods.rb +18 -20
  80. data/lib/mocha/configuration.rb +305 -18
  81. data/lib/mocha/debug.rb +3 -2
  82. data/lib/mocha/deprecation.rb +6 -10
  83. data/lib/mocha/detection/mini_test.rb +0 -2
  84. data/lib/mocha/detection/test_unit.rb +3 -5
  85. data/lib/mocha/error_with_filtered_backtrace.rb +13 -0
  86. data/lib/mocha/exception_raiser.rb +4 -6
  87. data/lib/mocha/expectation.rb +62 -67
  88. data/lib/mocha/expectation_error.rb +1 -1
  89. data/lib/mocha/expectation_error_factory.rb +0 -1
  90. data/lib/mocha/expectation_list.rb +7 -11
  91. data/lib/mocha/hooks.rb +1 -3
  92. data/lib/mocha/in_state_ordering_constraint.rb +0 -4
  93. data/lib/mocha/inspect.rb +28 -38
  94. data/lib/mocha/instance_method.rb +15 -8
  95. data/lib/mocha/integration.rb +2 -5
  96. data/lib/mocha/integration/mini_test.rb +7 -0
  97. data/lib/mocha/integration/mini_test/adapter.rb +2 -4
  98. data/lib/mocha/integration/mini_test/exception_translation.rb +1 -1
  99. data/lib/mocha/integration/mini_test/nothing.rb +4 -4
  100. data/lib/mocha/integration/mini_test/version_13.rb +4 -1
  101. data/lib/mocha/integration/mini_test/version_140.rb +4 -1
  102. data/lib/mocha/integration/mini_test/version_141.rb +4 -1
  103. data/lib/mocha/integration/mini_test/version_142_to_172.rb +4 -1
  104. data/lib/mocha/integration/mini_test/version_200.rb +4 -1
  105. data/lib/mocha/integration/mini_test/version_201_to_222.rb +4 -1
  106. data/lib/mocha/integration/mini_test/version_2110_to_2111.rb +4 -1
  107. data/lib/mocha/integration/mini_test/version_2112_to_320.rb +4 -1
  108. data/lib/mocha/integration/mini_test/version_230_to_2101.rb +4 -1
  109. data/lib/mocha/integration/monkey_patcher.rb +8 -2
  110. data/lib/mocha/integration/test_unit.rb +7 -0
  111. data/lib/mocha/integration/test_unit/adapter.rb +5 -6
  112. data/lib/mocha/integration/test_unit/gem_version_200.rb +5 -2
  113. data/lib/mocha/integration/test_unit/gem_version_201_to_202.rb +5 -2
  114. data/lib/mocha/integration/test_unit/gem_version_203_to_220.rb +5 -2
  115. data/lib/mocha/integration/test_unit/gem_version_230_to_250.rb +5 -2
  116. data/lib/mocha/integration/test_unit/nothing.rb +4 -4
  117. data/lib/mocha/integration/test_unit/ruby_version_185_and_below.rb +4 -1
  118. data/lib/mocha/integration/test_unit/ruby_version_186_and_above.rb +4 -1
  119. data/lib/mocha/invocation.rb +61 -0
  120. data/lib/mocha/is_a.rb +0 -2
  121. data/lib/mocha/logger.rb +0 -4
  122. data/lib/mocha/macos_version.rb +5 -0
  123. data/lib/mocha/method_matcher.rb +1 -5
  124. data/lib/mocha/minitest.rb +8 -0
  125. data/lib/mocha/mock.rb +70 -44
  126. data/lib/mocha/mockery.rb +78 -91
  127. data/lib/mocha/multiple_yields.rb +0 -5
  128. data/lib/mocha/names.rb +2 -12
  129. data/lib/mocha/no_yields.rb +1 -7
  130. data/lib/mocha/not_initialized_error.rb +7 -0
  131. data/lib/mocha/object_methods.rb +27 -33
  132. data/lib/mocha/parameter_matchers.rb +2 -4
  133. data/lib/mocha/parameter_matchers/all_of.rb +2 -8
  134. data/lib/mocha/parameter_matchers/any_of.rb +2 -8
  135. data/lib/mocha/parameter_matchers/any_parameters.rb +3 -9
  136. data/lib/mocha/parameter_matchers/anything.rb +2 -8
  137. data/lib/mocha/parameter_matchers/base.rb +6 -12
  138. data/lib/mocha/parameter_matchers/equals.rb +1 -7
  139. data/lib/mocha/parameter_matchers/{query_string.rb → equivalent_uri.rb} +15 -15
  140. data/lib/mocha/parameter_matchers/has_entries.rb +2 -6
  141. data/lib/mocha/parameter_matchers/has_entry.rb +8 -11
  142. data/lib/mocha/parameter_matchers/has_key.rb +2 -6
  143. data/lib/mocha/parameter_matchers/has_value.rb +2 -6
  144. data/lib/mocha/parameter_matchers/includes.rb +50 -8
  145. data/lib/mocha/parameter_matchers/instance_methods.rb +18 -0
  146. data/lib/mocha/parameter_matchers/instance_of.rb +0 -6
  147. data/lib/mocha/parameter_matchers/is_a.rb +2 -6
  148. data/lib/mocha/parameter_matchers/kind_of.rb +2 -6
  149. data/lib/mocha/parameter_matchers/not.rb +2 -6
  150. data/lib/mocha/parameter_matchers/optionally.rb +4 -10
  151. data/lib/mocha/parameter_matchers/regexp_matches.rb +0 -6
  152. data/lib/mocha/parameter_matchers/responds_with.rb +3 -8
  153. data/lib/mocha/parameter_matchers/yaml_equivalent.rb +2 -6
  154. data/lib/mocha/parameters_matcher.rb +6 -9
  155. data/lib/mocha/pretty_parameters.rb +0 -4
  156. data/lib/mocha/raised_exception.rb +11 -0
  157. data/lib/mocha/receivers.rb +10 -14
  158. data/lib/mocha/return_values.rb +4 -8
  159. data/lib/mocha/ruby_version.rb +4 -0
  160. data/lib/mocha/sequence.rb +4 -9
  161. data/lib/mocha/setup.rb +5 -0
  162. data/lib/mocha/single_return_value.rb +2 -5
  163. data/lib/mocha/single_yield.rb +0 -5
  164. data/lib/mocha/singleton_class.rb +9 -0
  165. data/lib/mocha/state_machine.rb +6 -10
  166. data/lib/mocha/stubbed_method.rb +127 -0
  167. data/lib/mocha/stubbing_error.rb +2 -13
  168. data/lib/mocha/test_unit.rb +7 -2
  169. data/lib/mocha/thrower.rb +4 -6
  170. data/lib/mocha/thrown_object.rb +12 -0
  171. data/lib/mocha/version.rb +1 -1
  172. data/lib/mocha/yield_parameters.rb +3 -7
  173. data/mocha.gemspec +35 -39
  174. data/test/acceptance/acceptance_test_helper.rb +6 -6
  175. data/test/acceptance/bug_18914_test.rb +7 -13
  176. data/test/acceptance/bug_21465_test.rb +0 -3
  177. data/test/acceptance/bug_21563_test.rb +0 -3
  178. data/test/acceptance/display_matching_invocations_alongside_expectations_test.rb +69 -0
  179. data/test/acceptance/exception_rescue_test.rb +7 -9
  180. data/test/acceptance/expectations_on_multiple_methods_test.rb +2 -2
  181. data/test/acceptance/expected_invocation_count_test.rb +27 -30
  182. data/test/acceptance/failure_messages_test.rb +3 -6
  183. data/test/acceptance/issue_272_test.rb +50 -0
  184. data/test/acceptance/issue_65_test.rb +15 -14
  185. data/test/acceptance/issue_70_test.rb +0 -2
  186. data/test/acceptance/mocha_example_test.rb +5 -7
  187. data/test/acceptance/mocha_test_result_test.rb +7 -8
  188. data/test/acceptance/mock_test.rb +48 -9
  189. data/test/acceptance/mocked_methods_dispatch_test.rb +0 -3
  190. data/test/acceptance/multiple_expectations_failure_message_test.rb +16 -18
  191. data/test/acceptance/optional_parameters_test.rb +0 -3
  192. data/test/acceptance/parameter_matcher_test.rb +6 -44
  193. data/test/acceptance/partial_mocks_test.rb +4 -7
  194. data/test/acceptance/prepend_test.rb +86 -0
  195. data/test/acceptance/prevent_use_of_mocha_outside_test_test.rb +76 -0
  196. data/test/acceptance/raise_exception_test.rb +2 -5
  197. data/test/acceptance/return_value_test.rb +0 -3
  198. data/test/acceptance/sequence_test.rb +9 -12
  199. data/test/acceptance/states_test.rb +6 -5
  200. data/test/acceptance/stub_any_instance_method_defined_on_superclass_test.rb +33 -3
  201. data/test/acceptance/stub_any_instance_method_test.rb +119 -21
  202. data/test/acceptance/stub_class_method_defined_on_active_record_association_proxy_test.rb +8 -9
  203. data/test/acceptance/stub_class_method_defined_on_class_test.rb +5 -5
  204. data/test/acceptance/stub_class_method_defined_on_module_test.rb +0 -2
  205. data/test/acceptance/stub_class_method_defined_on_superclass_test.rb +34 -2
  206. data/test/acceptance/stub_everything_test.rb +1 -4
  207. data/test/acceptance/stub_instance_method_defined_on_active_record_association_proxy_test.rb +6 -8
  208. data/test/acceptance/stub_instance_method_defined_on_class_and_aliased_test.rb +0 -2
  209. data/test/acceptance/stub_instance_method_defined_on_class_test.rb +3 -5
  210. data/test/acceptance/stub_instance_method_defined_on_kernel_module_test.rb +63 -2
  211. data/test/acceptance/stub_instance_method_defined_on_module_test.rb +3 -2
  212. data/test/acceptance/stub_instance_method_defined_on_object_class_test.rb +2 -2
  213. data/test/acceptance/stub_instance_method_defined_on_singleton_class_test.rb +0 -3
  214. data/test/acceptance/stub_instance_method_defined_on_superclass_test.rb +0 -2
  215. data/test/acceptance/stub_method_defined_on_module_and_aliased_test.rb +38 -0
  216. data/test/acceptance/stub_module_method_test.rb +58 -21
  217. data/test/acceptance/stub_test.rb +1 -4
  218. data/test/acceptance/stubba_example_test.rb +6 -15
  219. data/test/acceptance/stubba_test_result_test.rb +11 -6
  220. data/test/acceptance/stubbing_error_backtrace_test.rb +6 -7
  221. data/test/acceptance/stubbing_frozen_object_test.rb +2 -2
  222. data/test/acceptance/stubbing_method_accepting_block_parameter_test.rb +12 -8
  223. data/test/acceptance/stubbing_method_unnecessarily_test.rb +5 -7
  224. data/test/acceptance/stubbing_nil_test.rb +36 -35
  225. data/test/acceptance/stubbing_non_existent_any_instance_method_test.rb +23 -12
  226. data/test/acceptance/stubbing_non_existent_class_method_test.rb +14 -14
  227. data/test/acceptance/stubbing_non_existent_instance_method_test.rb +12 -14
  228. data/test/acceptance/stubbing_non_public_any_instance_method_test.rb +8 -10
  229. data/test/acceptance/stubbing_non_public_class_method_test.rb +12 -12
  230. data/test/acceptance/stubbing_non_public_instance_method_test.rb +10 -12
  231. data/test/acceptance/stubbing_on_non_mock_object_test.rb +17 -11
  232. data/test/acceptance/stubbing_same_class_method_on_parent_and_child_classes_test.rb +3 -5
  233. data/test/acceptance/throw_test.rb +0 -3
  234. data/test/acceptance/unexpected_invocation_test.rb +2 -4
  235. data/test/acceptance/unstubbing_test.rb +41 -15
  236. data/test/assertions.rb +6 -4
  237. data/test/deprecation_disabler.rb +1 -1
  238. data/test/execution_point.rb +7 -7
  239. data/test/integration/mini_test_test.rb +2 -2
  240. data/test/integration/shared_tests.rb +27 -23
  241. data/test/integration/test_unit_test.rb +2 -2
  242. data/test/method_definer.rb +11 -19
  243. data/test/mini_test_result.rb +17 -11
  244. data/test/minitest_result.rb +2 -3
  245. data/test/simple_counter.rb +0 -2
  246. data/test/test_helper.rb +13 -5
  247. data/test/test_runner.rb +5 -5
  248. data/test/test_unit_result.rb +4 -2
  249. data/test/unit/any_instance_method_test.rb +74 -31
  250. data/test/unit/array_inspect_test.rb +2 -4
  251. data/test/unit/backtrace_filter_test.rb +3 -5
  252. data/test/unit/cardinality_test.rb +41 -25
  253. data/test/unit/central_test.rb +26 -28
  254. data/test/unit/change_state_side_effect_test.rb +0 -4
  255. data/test/unit/class_methods_test.rb +35 -6
  256. data/test/unit/configuration_test.rb +13 -14
  257. data/test/unit/date_time_inspect_test.rb +1 -3
  258. data/test/unit/exception_raiser_test.rb +10 -7
  259. data/test/unit/expectation_list_test.rb +13 -13
  260. data/test/unit/expectation_test.rb +111 -131
  261. data/test/unit/hash_inspect_test.rb +3 -5
  262. data/test/unit/hooks_test.rb +14 -8
  263. data/test/unit/in_state_ordering_constraint_test.rb +0 -4
  264. data/test/unit/instance_method_test.rb +282 -0
  265. data/test/unit/method_matcher_test.rb +1 -3
  266. data/test/unit/mock_test.rb +56 -25
  267. data/test/unit/mockery_test.rb +49 -29
  268. data/test/unit/module_methods_test.rb +2 -5
  269. data/test/unit/multiple_yields_test.rb +0 -2
  270. data/test/unit/no_yields_test.rb +0 -2
  271. data/test/unit/object_inspect_test.rb +27 -5
  272. data/test/unit/object_methods_test.rb +25 -8
  273. data/test/unit/parameter_matchers/all_of_test.rb +0 -2
  274. data/test/unit/parameter_matchers/any_of_test.rb +0 -2
  275. data/test/unit/parameter_matchers/anything_test.rb +2 -4
  276. data/test/unit/parameter_matchers/equals_test.rb +1 -3
  277. data/test/unit/parameter_matchers/equivalent_uri_test.rb +41 -0
  278. data/test/unit/parameter_matchers/has_entries_test.rb +3 -3
  279. data/test/unit/parameter_matchers/has_entry_test.rb +16 -17
  280. data/test/unit/parameter_matchers/has_key_test.rb +1 -2
  281. data/test/unit/parameter_matchers/has_value_test.rb +2 -4
  282. data/test/unit/parameter_matchers/includes_test.rb +50 -3
  283. data/test/unit/parameter_matchers/instance_of_test.rb +1 -3
  284. data/test/unit/parameter_matchers/is_a_test.rb +1 -3
  285. data/test/unit/parameter_matchers/kind_of_test.rb +1 -3
  286. data/test/unit/parameter_matchers/not_test.rb +0 -2
  287. data/test/unit/parameter_matchers/regexp_matches_test.rb +1 -2
  288. data/test/unit/parameter_matchers/responds_with_test.rb +10 -4
  289. data/test/unit/parameter_matchers/stub_matcher.rb +0 -4
  290. data/test/unit/parameter_matchers/yaml_equivalent_test.rb +1 -3
  291. data/test/unit/parameters_matcher_test.rb +2 -4
  292. data/test/unit/receivers_test.rb +35 -5
  293. data/test/unit/return_values_test.rb +28 -25
  294. data/test/unit/sequence_test.rb +1 -5
  295. data/test/unit/single_return_value_test.rb +6 -3
  296. data/test/unit/single_yield_test.rb +0 -2
  297. data/test/unit/state_machine_test.rb +1 -3
  298. data/test/unit/string_inspect_test.rb +3 -5
  299. data/test/unit/thrower_test.rb +7 -4
  300. data/test/unit/yield_parameters_test.rb +0 -2
  301. data/yard-templates/default/layout/html/google_analytics.erb +6 -9
  302. data/yard-templates/default/layout/html/setup.rb +2 -3
  303. metadata +99 -42
  304. data/lib/mocha/class_method.rb +0 -106
  305. data/lib/mocha/mini_test.rb +0 -3
  306. data/lib/mocha/module_method.rb +0 -16
  307. data/lib/mocha/module_methods.rb +0 -14
  308. data/lib/mocha/parameter_matchers/object.rb +0 -17
  309. data/lib/mocha/standalone.rb +0 -4
  310. data/lib/mocha/unexpected_invocation.rb +0 -26
  311. data/lib/mocha_standalone.rb +0 -4
  312. data/test/acceptance/mock_with_initializer_block_test.rb +0 -51
  313. data/test/unit/class_method_test.rb +0 -223
@@ -0,0 +1,303 @@
1
+ (function() {
2
+
3
+ var localStorage = {}, sessionStorage = {};
4
+ try { localStorage = window.localStorage; } catch (e) { }
5
+ try { sessionStorage = window.sessionStorage; } catch (e) { }
6
+
7
+ function createSourceLinks() {
8
+ $('.method_details_list .source_code').
9
+ before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
10
+ $('.toggleSource').toggle(function() {
11
+ $(this).parent().nextAll('.source_code').slideDown(100);
12
+ $(this).text("Hide source");
13
+ },
14
+ function() {
15
+ $(this).parent().nextAll('.source_code').slideUp(100);
16
+ $(this).text("View source");
17
+ });
18
+ }
19
+
20
+ function createDefineLinks() {
21
+ var tHeight = 0;
22
+ $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
23
+ $('.toggleDefines').toggle(function() {
24
+ tHeight = $(this).parent().prev().height();
25
+ $(this).prev().css('display', 'inline');
26
+ $(this).parent().prev().height($(this).parent().height());
27
+ $(this).text("(less)");
28
+ },
29
+ function() {
30
+ $(this).prev().hide();
31
+ $(this).parent().prev().height(tHeight);
32
+ $(this).text("more...");
33
+ });
34
+ }
35
+
36
+ function createFullTreeLinks() {
37
+ var tHeight = 0;
38
+ $('.inheritanceTree').toggle(function() {
39
+ tHeight = $(this).parent().prev().height();
40
+ $(this).parent().toggleClass('showAll');
41
+ $(this).text("(hide)");
42
+ $(this).parent().prev().height($(this).parent().height());
43
+ },
44
+ function() {
45
+ $(this).parent().toggleClass('showAll');
46
+ $(this).parent().prev().height(tHeight);
47
+ $(this).text("show all");
48
+ });
49
+ }
50
+
51
+ function searchFrameButtons() {
52
+ $('.full_list_link').click(function() {
53
+ toggleSearchFrame(this, $(this).attr('href'));
54
+ return false;
55
+ });
56
+ window.addEventListener('message', function(e) {
57
+ if (e.data === 'navEscape') {
58
+ $('#nav').slideUp(100);
59
+ $('#search a').removeClass('active inactive');
60
+ $(window).focus();
61
+ }
62
+ });
63
+
64
+ $(window).resize(function() {
65
+ if ($('#search:visible').length === 0) {
66
+ $('#nav').removeAttr('style');
67
+ $('#search a').removeClass('active inactive');
68
+ $(window).focus();
69
+ }
70
+ });
71
+ }
72
+
73
+ function toggleSearchFrame(id, link) {
74
+ var frame = $('#nav');
75
+ $('#search a').removeClass('active').addClass('inactive');
76
+ if (frame.attr('src') === link && frame.css('display') !== "none") {
77
+ frame.slideUp(100);
78
+ $('#search a').removeClass('active inactive');
79
+ }
80
+ else {
81
+ $(id).addClass('active').removeClass('inactive');
82
+ if (frame.attr('src') !== link) frame.attr('src', link);
83
+ frame.slideDown(100);
84
+ }
85
+ }
86
+
87
+ function linkSummaries() {
88
+ $('.summary_signature').click(function() {
89
+ document.location = $(this).find('a').attr('href');
90
+ });
91
+ }
92
+
93
+ function summaryToggle() {
94
+ $('.summary_toggle').click(function(e) {
95
+ e.preventDefault();
96
+ localStorage.summaryCollapsed = $(this).text();
97
+ $('.summary_toggle').each(function() {
98
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
99
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
100
+ if (next.hasClass('compact')) {
101
+ next.toggle();
102
+ next.nextAll('ul.summary').first().toggle();
103
+ }
104
+ else if (next.hasClass('summary')) {
105
+ var list = $('<ul class="summary compact" />');
106
+ list.html(next.html());
107
+ list.find('.summary_desc, .note').remove();
108
+ list.find('a').each(function() {
109
+ $(this).html($(this).find('strong').html());
110
+ $(this).parent().html($(this)[0].outerHTML);
111
+ });
112
+ next.before(list);
113
+ next.toggle();
114
+ }
115
+ });
116
+ return false;
117
+ });
118
+ if (localStorage.summaryCollapsed == "collapse") {
119
+ $('.summary_toggle').first().click();
120
+ } else { localStorage.summaryCollapsed = "expand"; }
121
+ }
122
+
123
+ function constantSummaryToggle() {
124
+ $('.constants_summary_toggle').click(function(e) {
125
+ e.preventDefault();
126
+ localStorage.summaryCollapsed = $(this).text();
127
+ $('.constants_summary_toggle').each(function() {
128
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
129
+ var next = $(this).parent().parent().nextAll('dl.constants').first();
130
+ if (next.hasClass('compact')) {
131
+ next.toggle();
132
+ next.nextAll('dl.constants').first().toggle();
133
+ }
134
+ else if (next.hasClass('constants')) {
135
+ var list = $('<dl class="constants compact" />');
136
+ list.html(next.html());
137
+ list.find('dt').each(function() {
138
+ $(this).addClass('summary_signature');
139
+ $(this).text( $(this).text().split('=')[0]);
140
+ if ($(this).has(".deprecated").length) {
141
+ $(this).addClass('deprecated');
142
+ };
143
+ });
144
+ // Add the value of the constant as "Tooltip" to the summary object
145
+ list.find('pre.code').each(function() {
146
+ console.log($(this).parent());
147
+ var dt_element = $(this).parent().prev();
148
+ var tooltip = $(this).text();
149
+ if (dt_element.hasClass("deprecated")) {
150
+ tooltip = 'Deprecated. ' + tooltip;
151
+ };
152
+ dt_element.attr('title', tooltip);
153
+ });
154
+ list.find('.docstring, .tags, dd').remove();
155
+ next.before(list);
156
+ next.toggle();
157
+ }
158
+ });
159
+ return false;
160
+ });
161
+ if (localStorage.summaryCollapsed == "collapse") {
162
+ $('.constants_summary_toggle').first().click();
163
+ } else { localStorage.summaryCollapsed = "expand"; }
164
+ }
165
+
166
+ function generateTOC() {
167
+ if ($('#filecontents').length === 0) return;
168
+ var _toc = $('<ol class="top"></ol>');
169
+ var show = false;
170
+ var toc = _toc;
171
+ var counter = 0;
172
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
173
+ var i;
174
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
175
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
176
+ var lastTag = parseInt(tags[0][1], 10);
177
+ $(tags.join(', ')).each(function() {
178
+ if ($(this).parents('.method_details .docstring').length != 0) return;
179
+ if (this.id == "filecontents") return;
180
+ show = true;
181
+ var thisTag = parseInt(this.tagName[1], 10);
182
+ if (this.id.length === 0) {
183
+ var proposedId = $(this).attr('toc-id');
184
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
185
+ else {
186
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
187
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
188
+ this.id = proposedId;
189
+ }
190
+ }
191
+ if (thisTag > lastTag) {
192
+ for (i = 0; i < thisTag - lastTag; i++) {
193
+ var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
194
+ }
195
+ }
196
+ if (thisTag < lastTag) {
197
+ for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
198
+ }
199
+ var title = $(this).attr('toc-title');
200
+ if (typeof(title) == "undefined") title = $(this).text();
201
+ toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
202
+ lastTag = thisTag;
203
+ });
204
+ if (!show) return;
205
+ html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
206
+ $('#content').prepend(html);
207
+ $('#toc').append(_toc);
208
+ $('#toc .hide_toc').toggle(function() {
209
+ $('#toc .top').slideUp('fast');
210
+ $('#toc').toggleClass('hidden');
211
+ $('#toc .title small').toggle();
212
+ }, function() {
213
+ $('#toc .top').slideDown('fast');
214
+ $('#toc').toggleClass('hidden');
215
+ $('#toc .title small').toggle();
216
+ });
217
+ }
218
+
219
+ function navResizeFn(e) {
220
+ if (e.which !== 1) {
221
+ navResizeFnStop();
222
+ return;
223
+ }
224
+
225
+ sessionStorage.navWidth = e.pageX.toString();
226
+ $('.nav_wrap').css('width', e.pageX);
227
+ $('.nav_wrap').css('-ms-flex', 'inherit');
228
+ }
229
+
230
+ function navResizeFnStop() {
231
+ $(window).unbind('mousemove', navResizeFn);
232
+ window.removeEventListener('message', navMessageFn, false);
233
+ }
234
+
235
+ function navMessageFn(e) {
236
+ if (e.data.action === 'mousemove') navResizeFn(e.data.event);
237
+ if (e.data.action === 'mouseup') navResizeFnStop();
238
+ }
239
+
240
+ function navResizer() {
241
+ $('#resizer').mousedown(function(e) {
242
+ e.preventDefault();
243
+ $(window).mousemove(navResizeFn);
244
+ window.addEventListener('message', navMessageFn, false);
245
+ });
246
+ $(window).mouseup(navResizeFnStop);
247
+
248
+ if (sessionStorage.navWidth) {
249
+ navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
250
+ }
251
+ }
252
+
253
+ function navExpander() {
254
+ var done = false, timer = setTimeout(postMessage, 500);
255
+ function postMessage() {
256
+ if (done) return;
257
+ clearTimeout(timer);
258
+ var opts = { action: 'expand', path: pathId };
259
+ document.getElementById('nav').contentWindow.postMessage(opts, '*');
260
+ done = true;
261
+ }
262
+
263
+ window.addEventListener('message', function(event) {
264
+ if (event.data === 'navReady') postMessage();
265
+ return false;
266
+ }, false);
267
+ }
268
+
269
+ function mainFocus() {
270
+ var hash = window.location.hash;
271
+ if (hash !== '' && $(hash)[0]) {
272
+ $(hash)[0].scrollIntoView();
273
+ }
274
+
275
+ setTimeout(function() { $('#main').focus(); }, 10);
276
+ }
277
+
278
+ function navigationChange() {
279
+ // This works around the broken anchor navigation with the YARD template.
280
+ window.onpopstate = function() {
281
+ var hash = window.location.hash;
282
+ if (hash !== '' && $(hash)[0]) {
283
+ $(hash)[0].scrollIntoView();
284
+ }
285
+ };
286
+ }
287
+
288
+ $(document).ready(function() {
289
+ navResizer();
290
+ navExpander();
291
+ createSourceLinks();
292
+ createDefineLinks();
293
+ createFullTreeLinks();
294
+ searchFrameButtons();
295
+ linkSummaries();
296
+ summaryToggle();
297
+ constantSummaryToggle();
298
+ generateTOC();
299
+ mainFocus();
300
+ navigationChange();
301
+ });
302
+
303
+ })();
@@ -0,0 +1,216 @@
1
+ (function() {
2
+
3
+ var $clicked = $(null);
4
+ var searchTimeout = null;
5
+ var searchCache = [];
6
+ var caseSensitiveMatch = false;
7
+ var ignoreKeyCodeMin = 8;
8
+ var ignoreKeyCodeMax = 46;
9
+ var commandKey = 91;
10
+
11
+ RegExp.escape = function(text) {
12
+ return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
13
+ }
14
+
15
+ function escapeShortcut() {
16
+ $(document).keydown(function(evt) {
17
+ if (evt.which == 27) {
18
+ window.parent.postMessage('navEscape', '*');
19
+ }
20
+ });
21
+ }
22
+
23
+ function navResizer() {
24
+ $(window).mousemove(function(e) {
25
+ window.parent.postMessage({
26
+ action: 'mousemove', event: {pageX: e.pageX, which: e.which}
27
+ }, '*');
28
+ }).mouseup(function(e) {
29
+ window.parent.postMessage({action: 'mouseup'}, '*');
30
+ });
31
+ window.parent.postMessage("navReady", "*");
32
+ }
33
+
34
+ function clearSearchTimeout() {
35
+ clearTimeout(searchTimeout);
36
+ searchTimeout = null;
37
+ }
38
+
39
+ function enableLinks() {
40
+ // load the target page in the parent window
41
+ $('#full_list li').on('click', function(evt) {
42
+ $('#full_list li').removeClass('clicked');
43
+ $clicked = $(this);
44
+ $clicked.addClass('clicked');
45
+ evt.stopPropagation();
46
+
47
+ if (evt.target.tagName === 'A') return true;
48
+
49
+ var elem = $clicked.find('> .item .object_link a')[0];
50
+ var e = evt.originalEvent;
51
+ var newEvent = new MouseEvent(evt.originalEvent.type);
52
+ newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
53
+ elem.dispatchEvent(newEvent);
54
+ evt.preventDefault();
55
+ return false;
56
+ });
57
+ }
58
+
59
+ function enableToggles() {
60
+ // show/hide nested classes on toggle click
61
+ $('#full_list a.toggle').on('click', function(evt) {
62
+ evt.stopPropagation();
63
+ evt.preventDefault();
64
+ $(this).parent().parent().toggleClass('collapsed');
65
+ highlight();
66
+ });
67
+ }
68
+
69
+ function populateSearchCache() {
70
+ $('#full_list li .item').each(function() {
71
+ var $node = $(this);
72
+ var $link = $node.find('.object_link a');
73
+ if ($link.length > 0) {
74
+ searchCache.push({
75
+ node: $node,
76
+ link: $link,
77
+ name: $link.text(),
78
+ fullName: $link.attr('title').split(' ')[0]
79
+ });
80
+ }
81
+ });
82
+ }
83
+
84
+ function enableSearch() {
85
+ $('#search input').keyup(function(event) {
86
+ if (ignoredKeyPress(event)) return;
87
+ if (this.value === "") {
88
+ clearSearch();
89
+ } else {
90
+ performSearch(this.value);
91
+ }
92
+ });
93
+
94
+ $('#full_list').after("<div id='noresults' style='display:none'></div>");
95
+ }
96
+
97
+ function ignoredKeyPress(event) {
98
+ if (
99
+ (event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
100
+ (event.keyCode == commandKey)
101
+ ) {
102
+ return true;
103
+ } else {
104
+ return false;
105
+ }
106
+ }
107
+
108
+ function clearSearch() {
109
+ clearSearchTimeout();
110
+ $('#full_list .found').removeClass('found').each(function() {
111
+ var $link = $(this).find('.object_link a');
112
+ $link.text($link.text());
113
+ });
114
+ $('#full_list, #content').removeClass('insearch');
115
+ $clicked.parents().removeClass('collapsed');
116
+ highlight();
117
+ }
118
+
119
+ function performSearch(searchString) {
120
+ clearSearchTimeout();
121
+ $('#full_list, #content').addClass('insearch');
122
+ $('#noresults').text('').hide();
123
+ partialSearch(searchString, 0);
124
+ }
125
+
126
+ function partialSearch(searchString, offset) {
127
+ var lastRowClass = '';
128
+ var i = null;
129
+ for (i = offset; i < Math.min(offset + 50, searchCache.length); i++) {
130
+ var item = searchCache[i];
131
+ var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
132
+ var matchString = buildMatchString(searchString);
133
+ var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
134
+ if (searchName.match(matchRegexp) == null) {
135
+ item.node.removeClass('found');
136
+ item.link.text(item.link.text());
137
+ }
138
+ else {
139
+ item.node.addClass('found');
140
+ item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
141
+ lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
142
+ item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
143
+ }
144
+ }
145
+ if(i == searchCache.length) {
146
+ searchDone();
147
+ } else {
148
+ searchTimeout = setTimeout(function() {
149
+ partialSearch(searchString, i);
150
+ }, 0);
151
+ }
152
+ }
153
+
154
+ function searchDone() {
155
+ searchTimeout = null;
156
+ highlight();
157
+ if ($('#full_list li:visible').size() === 0) {
158
+ $('#noresults').text('No results were found.').hide().fadeIn();
159
+ } else {
160
+ $('#noresults').text('').hide();
161
+ }
162
+ $('#content').removeClass('insearch');
163
+ }
164
+
165
+ function buildMatchString(searchString, event) {
166
+ caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
167
+ var regexSearchString = RegExp.escape(searchString);
168
+ if (caseSensitiveMatch) {
169
+ regexSearchString += "|" +
170
+ $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
171
+ join('.+?');
172
+ }
173
+ return regexSearchString;
174
+ }
175
+
176
+ function highlight() {
177
+ $('#full_list li:visible').each(function(n) {
178
+ $(this).removeClass('even odd').addClass(n % 2 == 0 ? 'odd' : 'even');
179
+ });
180
+ }
181
+
182
+ /**
183
+ * Expands the tree to the target element and its immediate
184
+ * children.
185
+ */
186
+ function expandTo(path) {
187
+ var $target = $(document.getElementById('object_' + path));
188
+ $target.addClass('clicked');
189
+ $target.removeClass('collapsed');
190
+ $target.parentsUntil('#full_list', 'li').removeClass('collapsed');
191
+ if($target[0]) {
192
+ window.scrollTo(window.scrollX, $target.offset().top - 250);
193
+ highlight();
194
+ }
195
+ }
196
+
197
+ function windowEvents(event) {
198
+ var msg = event.data;
199
+ if (msg.action === "expand") {
200
+ expandTo(msg.path);
201
+ }
202
+ return false;
203
+ }
204
+
205
+ window.addEventListener("message", windowEvents, false);
206
+
207
+ $(document).ready(function() {
208
+ escapeShortcut();
209
+ navResizer();
210
+ enableLinks();
211
+ enableToggles();
212
+ populateSearchCache();
213
+ enableSearch();
214
+ });
215
+
216
+ })();