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.
- checksums.yaml +5 -5
- data/.rubocop.yml +61 -0
- data/.rubocop_todo.yml +27 -0
- data/CONTRIBUTING.md +7 -0
- data/README.md +136 -42
- data/RELEASE.md +166 -16
- data/Rakefile +52 -36
- data/bin/build-matrix +32 -21
- data/docs/CNAME +1 -0
- data/docs/Mocha.html +254 -0
- data/docs/Mocha/API.html +1129 -0
- data/docs/Mocha/ClassMethods.html +339 -0
- data/docs/Mocha/Configuration.html +1383 -0
- data/docs/Mocha/Expectation.html +2654 -0
- data/docs/Mocha/ExpectationError.html +152 -0
- data/docs/Mocha/ExpectationErrorFactory.html +260 -0
- data/docs/Mocha/Hooks.html +370 -0
- data/docs/Mocha/Integration.html +125 -0
- data/docs/Mocha/Integration/MiniTest.html +123 -0
- data/docs/Mocha/Integration/MiniTest/Adapter.html +164 -0
- data/docs/Mocha/Integration/TestUnit.html +123 -0
- data/docs/Mocha/Integration/TestUnit/Adapter.html +164 -0
- data/docs/Mocha/Mock.html +1237 -0
- data/docs/Mocha/ObjectMethods.html +765 -0
- data/docs/Mocha/ParameterMatchers.html +2961 -0
- data/docs/Mocha/ParameterMatchers/AllOf.html +153 -0
- data/docs/Mocha/ParameterMatchers/AnyOf.html +153 -0
- data/docs/Mocha/ParameterMatchers/AnyParameters.html +153 -0
- data/docs/Mocha/ParameterMatchers/Anything.html +153 -0
- data/docs/Mocha/ParameterMatchers/Base.html +441 -0
- data/docs/Mocha/ParameterMatchers/Equals.html +153 -0
- data/docs/Mocha/ParameterMatchers/EquivalentUri.html +153 -0
- data/docs/Mocha/ParameterMatchers/HasEntries.html +153 -0
- data/docs/Mocha/ParameterMatchers/HasEntry.html +153 -0
- data/docs/Mocha/ParameterMatchers/HasKey.html +153 -0
- data/docs/Mocha/ParameterMatchers/HasValue.html +153 -0
- data/docs/Mocha/ParameterMatchers/Includes.html +153 -0
- data/docs/Mocha/ParameterMatchers/InstanceOf.html +153 -0
- data/docs/Mocha/ParameterMatchers/IsA.html +153 -0
- data/docs/Mocha/ParameterMatchers/KindOf.html +153 -0
- data/docs/Mocha/ParameterMatchers/Not.html +153 -0
- data/docs/Mocha/ParameterMatchers/Optionally.html +153 -0
- data/docs/Mocha/ParameterMatchers/RegexpMatches.html +153 -0
- data/docs/Mocha/ParameterMatchers/RespondsWith.html +153 -0
- data/docs/Mocha/ParameterMatchers/YamlEquivalent.html +153 -0
- data/docs/Mocha/Sequence.html +149 -0
- data/docs/Mocha/StateMachine.html +527 -0
- data/docs/Mocha/StateMachine/State.html +140 -0
- data/docs/Mocha/StateMachine/StatePredicate.html +140 -0
- data/docs/Mocha/StubbingError.html +150 -0
- data/docs/_index.html +519 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.COPYING.html +81 -0
- data/docs/file.MIT-LICENSE.html +85 -0
- data/docs/file.README.html +429 -0
- data/docs/file.RELEASE.html +942 -0
- data/docs/file_list.html +71 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +429 -0
- data/docs/js/app.js +303 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +635 -0
- data/docs/top-level-namespace.html +118 -0
- data/gemfiles/Gemfile.minitest.5.11.3 +7 -0
- data/gemfiles/Gemfile.test-unit.latest +5 -1
- data/init.rb +1 -3
- data/lib/mocha.rb +8 -0
- data/lib/mocha/any_instance_method.rb +12 -50
- data/lib/mocha/api.rb +63 -65
- data/lib/mocha/argument_iterator.rb +4 -8
- data/lib/mocha/backtrace_filter.rb +1 -5
- data/lib/mocha/cardinality.rb +43 -35
- data/lib/mocha/central.rb +21 -12
- data/lib/mocha/change_state_side_effect.rb +0 -4
- data/lib/mocha/class_methods.rb +18 -20
- data/lib/mocha/configuration.rb +305 -18
- data/lib/mocha/debug.rb +3 -2
- data/lib/mocha/deprecation.rb +6 -10
- data/lib/mocha/detection/mini_test.rb +0 -2
- data/lib/mocha/detection/test_unit.rb +3 -5
- data/lib/mocha/error_with_filtered_backtrace.rb +13 -0
- data/lib/mocha/exception_raiser.rb +4 -6
- data/lib/mocha/expectation.rb +62 -67
- data/lib/mocha/expectation_error.rb +1 -1
- data/lib/mocha/expectation_error_factory.rb +0 -1
- data/lib/mocha/expectation_list.rb +7 -11
- data/lib/mocha/hooks.rb +1 -3
- data/lib/mocha/in_state_ordering_constraint.rb +0 -4
- data/lib/mocha/inspect.rb +28 -38
- data/lib/mocha/instance_method.rb +15 -8
- data/lib/mocha/integration.rb +2 -5
- data/lib/mocha/integration/mini_test.rb +7 -0
- data/lib/mocha/integration/mini_test/adapter.rb +2 -4
- data/lib/mocha/integration/mini_test/exception_translation.rb +1 -1
- data/lib/mocha/integration/mini_test/nothing.rb +4 -4
- data/lib/mocha/integration/mini_test/version_13.rb +4 -1
- data/lib/mocha/integration/mini_test/version_140.rb +4 -1
- data/lib/mocha/integration/mini_test/version_141.rb +4 -1
- data/lib/mocha/integration/mini_test/version_142_to_172.rb +4 -1
- data/lib/mocha/integration/mini_test/version_200.rb +4 -1
- data/lib/mocha/integration/mini_test/version_201_to_222.rb +4 -1
- data/lib/mocha/integration/mini_test/version_2110_to_2111.rb +4 -1
- data/lib/mocha/integration/mini_test/version_2112_to_320.rb +4 -1
- data/lib/mocha/integration/mini_test/version_230_to_2101.rb +4 -1
- data/lib/mocha/integration/monkey_patcher.rb +8 -2
- data/lib/mocha/integration/test_unit.rb +7 -0
- data/lib/mocha/integration/test_unit/adapter.rb +5 -6
- data/lib/mocha/integration/test_unit/gem_version_200.rb +5 -2
- data/lib/mocha/integration/test_unit/gem_version_201_to_202.rb +5 -2
- data/lib/mocha/integration/test_unit/gem_version_203_to_220.rb +5 -2
- data/lib/mocha/integration/test_unit/gem_version_230_to_250.rb +5 -2
- data/lib/mocha/integration/test_unit/nothing.rb +4 -4
- data/lib/mocha/integration/test_unit/ruby_version_185_and_below.rb +4 -1
- data/lib/mocha/integration/test_unit/ruby_version_186_and_above.rb +4 -1
- data/lib/mocha/invocation.rb +61 -0
- data/lib/mocha/is_a.rb +0 -2
- data/lib/mocha/logger.rb +0 -4
- data/lib/mocha/macos_version.rb +5 -0
- data/lib/mocha/method_matcher.rb +1 -5
- data/lib/mocha/minitest.rb +8 -0
- data/lib/mocha/mock.rb +70 -44
- data/lib/mocha/mockery.rb +78 -91
- data/lib/mocha/multiple_yields.rb +0 -5
- data/lib/mocha/names.rb +2 -12
- data/lib/mocha/no_yields.rb +1 -7
- data/lib/mocha/not_initialized_error.rb +7 -0
- data/lib/mocha/object_methods.rb +27 -33
- data/lib/mocha/parameter_matchers.rb +2 -4
- data/lib/mocha/parameter_matchers/all_of.rb +2 -8
- data/lib/mocha/parameter_matchers/any_of.rb +2 -8
- data/lib/mocha/parameter_matchers/any_parameters.rb +3 -9
- data/lib/mocha/parameter_matchers/anything.rb +2 -8
- data/lib/mocha/parameter_matchers/base.rb +6 -12
- data/lib/mocha/parameter_matchers/equals.rb +1 -7
- data/lib/mocha/parameter_matchers/{query_string.rb → equivalent_uri.rb} +15 -15
- data/lib/mocha/parameter_matchers/has_entries.rb +2 -6
- data/lib/mocha/parameter_matchers/has_entry.rb +8 -11
- data/lib/mocha/parameter_matchers/has_key.rb +2 -6
- data/lib/mocha/parameter_matchers/has_value.rb +2 -6
- data/lib/mocha/parameter_matchers/includes.rb +50 -8
- data/lib/mocha/parameter_matchers/instance_methods.rb +18 -0
- data/lib/mocha/parameter_matchers/instance_of.rb +0 -6
- data/lib/mocha/parameter_matchers/is_a.rb +2 -6
- data/lib/mocha/parameter_matchers/kind_of.rb +2 -6
- data/lib/mocha/parameter_matchers/not.rb +2 -6
- data/lib/mocha/parameter_matchers/optionally.rb +4 -10
- data/lib/mocha/parameter_matchers/regexp_matches.rb +0 -6
- data/lib/mocha/parameter_matchers/responds_with.rb +3 -8
- data/lib/mocha/parameter_matchers/yaml_equivalent.rb +2 -6
- data/lib/mocha/parameters_matcher.rb +6 -9
- data/lib/mocha/pretty_parameters.rb +0 -4
- data/lib/mocha/raised_exception.rb +11 -0
- data/lib/mocha/receivers.rb +10 -14
- data/lib/mocha/return_values.rb +4 -8
- data/lib/mocha/ruby_version.rb +4 -0
- data/lib/mocha/sequence.rb +4 -9
- data/lib/mocha/setup.rb +5 -0
- data/lib/mocha/single_return_value.rb +2 -5
- data/lib/mocha/single_yield.rb +0 -5
- data/lib/mocha/singleton_class.rb +9 -0
- data/lib/mocha/state_machine.rb +6 -10
- data/lib/mocha/stubbed_method.rb +127 -0
- data/lib/mocha/stubbing_error.rb +2 -13
- data/lib/mocha/test_unit.rb +7 -2
- data/lib/mocha/thrower.rb +4 -6
- data/lib/mocha/thrown_object.rb +12 -0
- data/lib/mocha/version.rb +1 -1
- data/lib/mocha/yield_parameters.rb +3 -7
- data/mocha.gemspec +35 -39
- data/test/acceptance/acceptance_test_helper.rb +6 -6
- data/test/acceptance/bug_18914_test.rb +7 -13
- data/test/acceptance/bug_21465_test.rb +0 -3
- data/test/acceptance/bug_21563_test.rb +0 -3
- data/test/acceptance/display_matching_invocations_alongside_expectations_test.rb +69 -0
- data/test/acceptance/exception_rescue_test.rb +7 -9
- data/test/acceptance/expectations_on_multiple_methods_test.rb +2 -2
- data/test/acceptance/expected_invocation_count_test.rb +27 -30
- data/test/acceptance/failure_messages_test.rb +3 -6
- data/test/acceptance/issue_272_test.rb +50 -0
- data/test/acceptance/issue_65_test.rb +15 -14
- data/test/acceptance/issue_70_test.rb +0 -2
- data/test/acceptance/mocha_example_test.rb +5 -7
- data/test/acceptance/mocha_test_result_test.rb +7 -8
- data/test/acceptance/mock_test.rb +48 -9
- data/test/acceptance/mocked_methods_dispatch_test.rb +0 -3
- data/test/acceptance/multiple_expectations_failure_message_test.rb +16 -18
- data/test/acceptance/optional_parameters_test.rb +0 -3
- data/test/acceptance/parameter_matcher_test.rb +6 -44
- data/test/acceptance/partial_mocks_test.rb +4 -7
- data/test/acceptance/prepend_test.rb +86 -0
- data/test/acceptance/prevent_use_of_mocha_outside_test_test.rb +76 -0
- data/test/acceptance/raise_exception_test.rb +2 -5
- data/test/acceptance/return_value_test.rb +0 -3
- data/test/acceptance/sequence_test.rb +9 -12
- data/test/acceptance/states_test.rb +6 -5
- data/test/acceptance/stub_any_instance_method_defined_on_superclass_test.rb +33 -3
- data/test/acceptance/stub_any_instance_method_test.rb +119 -21
- data/test/acceptance/stub_class_method_defined_on_active_record_association_proxy_test.rb +8 -9
- data/test/acceptance/stub_class_method_defined_on_class_test.rb +5 -5
- data/test/acceptance/stub_class_method_defined_on_module_test.rb +0 -2
- data/test/acceptance/stub_class_method_defined_on_superclass_test.rb +34 -2
- data/test/acceptance/stub_everything_test.rb +1 -4
- data/test/acceptance/stub_instance_method_defined_on_active_record_association_proxy_test.rb +6 -8
- data/test/acceptance/stub_instance_method_defined_on_class_and_aliased_test.rb +0 -2
- data/test/acceptance/stub_instance_method_defined_on_class_test.rb +3 -5
- data/test/acceptance/stub_instance_method_defined_on_kernel_module_test.rb +63 -2
- data/test/acceptance/stub_instance_method_defined_on_module_test.rb +3 -2
- data/test/acceptance/stub_instance_method_defined_on_object_class_test.rb +2 -2
- data/test/acceptance/stub_instance_method_defined_on_singleton_class_test.rb +0 -3
- data/test/acceptance/stub_instance_method_defined_on_superclass_test.rb +0 -2
- data/test/acceptance/stub_method_defined_on_module_and_aliased_test.rb +38 -0
- data/test/acceptance/stub_module_method_test.rb +58 -21
- data/test/acceptance/stub_test.rb +1 -4
- data/test/acceptance/stubba_example_test.rb +6 -15
- data/test/acceptance/stubba_test_result_test.rb +11 -6
- data/test/acceptance/stubbing_error_backtrace_test.rb +6 -7
- data/test/acceptance/stubbing_frozen_object_test.rb +2 -2
- data/test/acceptance/stubbing_method_accepting_block_parameter_test.rb +12 -8
- data/test/acceptance/stubbing_method_unnecessarily_test.rb +5 -7
- data/test/acceptance/stubbing_nil_test.rb +36 -35
- data/test/acceptance/stubbing_non_existent_any_instance_method_test.rb +23 -12
- data/test/acceptance/stubbing_non_existent_class_method_test.rb +14 -14
- data/test/acceptance/stubbing_non_existent_instance_method_test.rb +12 -14
- data/test/acceptance/stubbing_non_public_any_instance_method_test.rb +8 -10
- data/test/acceptance/stubbing_non_public_class_method_test.rb +12 -12
- data/test/acceptance/stubbing_non_public_instance_method_test.rb +10 -12
- data/test/acceptance/stubbing_on_non_mock_object_test.rb +17 -11
- data/test/acceptance/stubbing_same_class_method_on_parent_and_child_classes_test.rb +3 -5
- data/test/acceptance/throw_test.rb +0 -3
- data/test/acceptance/unexpected_invocation_test.rb +2 -4
- data/test/acceptance/unstubbing_test.rb +41 -15
- data/test/assertions.rb +6 -4
- data/test/deprecation_disabler.rb +1 -1
- data/test/execution_point.rb +7 -7
- data/test/integration/mini_test_test.rb +2 -2
- data/test/integration/shared_tests.rb +27 -23
- data/test/integration/test_unit_test.rb +2 -2
- data/test/method_definer.rb +11 -19
- data/test/mini_test_result.rb +17 -11
- data/test/minitest_result.rb +2 -3
- data/test/simple_counter.rb +0 -2
- data/test/test_helper.rb +13 -5
- data/test/test_runner.rb +5 -5
- data/test/test_unit_result.rb +4 -2
- data/test/unit/any_instance_method_test.rb +74 -31
- data/test/unit/array_inspect_test.rb +2 -4
- data/test/unit/backtrace_filter_test.rb +3 -5
- data/test/unit/cardinality_test.rb +41 -25
- data/test/unit/central_test.rb +26 -28
- data/test/unit/change_state_side_effect_test.rb +0 -4
- data/test/unit/class_methods_test.rb +35 -6
- data/test/unit/configuration_test.rb +13 -14
- data/test/unit/date_time_inspect_test.rb +1 -3
- data/test/unit/exception_raiser_test.rb +10 -7
- data/test/unit/expectation_list_test.rb +13 -13
- data/test/unit/expectation_test.rb +111 -131
- data/test/unit/hash_inspect_test.rb +3 -5
- data/test/unit/hooks_test.rb +14 -8
- data/test/unit/in_state_ordering_constraint_test.rb +0 -4
- data/test/unit/instance_method_test.rb +282 -0
- data/test/unit/method_matcher_test.rb +1 -3
- data/test/unit/mock_test.rb +56 -25
- data/test/unit/mockery_test.rb +49 -29
- data/test/unit/module_methods_test.rb +2 -5
- data/test/unit/multiple_yields_test.rb +0 -2
- data/test/unit/no_yields_test.rb +0 -2
- data/test/unit/object_inspect_test.rb +27 -5
- data/test/unit/object_methods_test.rb +25 -8
- data/test/unit/parameter_matchers/all_of_test.rb +0 -2
- data/test/unit/parameter_matchers/any_of_test.rb +0 -2
- data/test/unit/parameter_matchers/anything_test.rb +2 -4
- data/test/unit/parameter_matchers/equals_test.rb +1 -3
- data/test/unit/parameter_matchers/equivalent_uri_test.rb +41 -0
- data/test/unit/parameter_matchers/has_entries_test.rb +3 -3
- data/test/unit/parameter_matchers/has_entry_test.rb +16 -17
- data/test/unit/parameter_matchers/has_key_test.rb +1 -2
- data/test/unit/parameter_matchers/has_value_test.rb +2 -4
- data/test/unit/parameter_matchers/includes_test.rb +50 -3
- data/test/unit/parameter_matchers/instance_of_test.rb +1 -3
- data/test/unit/parameter_matchers/is_a_test.rb +1 -3
- data/test/unit/parameter_matchers/kind_of_test.rb +1 -3
- data/test/unit/parameter_matchers/not_test.rb +0 -2
- data/test/unit/parameter_matchers/regexp_matches_test.rb +1 -2
- data/test/unit/parameter_matchers/responds_with_test.rb +10 -4
- data/test/unit/parameter_matchers/stub_matcher.rb +0 -4
- data/test/unit/parameter_matchers/yaml_equivalent_test.rb +1 -3
- data/test/unit/parameters_matcher_test.rb +2 -4
- data/test/unit/receivers_test.rb +35 -5
- data/test/unit/return_values_test.rb +28 -25
- data/test/unit/sequence_test.rb +1 -5
- data/test/unit/single_return_value_test.rb +6 -3
- data/test/unit/single_yield_test.rb +0 -2
- data/test/unit/state_machine_test.rb +1 -3
- data/test/unit/string_inspect_test.rb +3 -5
- data/test/unit/thrower_test.rb +7 -4
- data/test/unit/yield_parameters_test.rb +0 -2
- data/yard-templates/default/layout/html/google_analytics.erb +6 -9
- data/yard-templates/default/layout/html/setup.rb +2 -3
- metadata +99 -42
- data/lib/mocha/class_method.rb +0 -106
- data/lib/mocha/mini_test.rb +0 -3
- data/lib/mocha/module_method.rb +0 -16
- data/lib/mocha/module_methods.rb +0 -14
- data/lib/mocha/parameter_matchers/object.rb +0 -17
- data/lib/mocha/standalone.rb +0 -4
- data/lib/mocha/unexpected_invocation.rb +0 -26
- data/lib/mocha_standalone.rb +0 -4
- data/test/acceptance/mock_with_initializer_block_test.rb +0 -51
- data/test/unit/class_method_test.rb +0 -223
data/docs/Mocha/API.html
ADDED
@@ -0,0 +1,1129 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Module: Mocha::API
|
8
|
+
|
9
|
+
— Mocha 1.10.0.alpha
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "Mocha::API";
|
19
|
+
relpath = '../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../_index.html">Index (A)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../Mocha.html" title="Mocha (module)">Mocha</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">API</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Module: Mocha::API
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
<dl>
|
75
|
+
<dt>Includes:</dt>
|
76
|
+
<dd><span class='object_link'><a href="Hooks.html" title="Mocha::Hooks (module)">Hooks</a></span>, <span class='object_link'><a href="ParameterMatchers.html" title="Mocha::ParameterMatchers (module)">ParameterMatchers</a></span></dd>
|
77
|
+
</dl>
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
<dl>
|
83
|
+
<dt>Included in:</dt>
|
84
|
+
<dd><span class='object_link'><a href="Integration/MiniTest/Adapter.html" title="Mocha::Integration::MiniTest::Adapter (module)">Integration::MiniTest::Adapter</a></span>, <span class='object_link'><a href="Integration/TestUnit/Adapter.html" title="Mocha::Integration::TestUnit::Adapter (module)">Integration::TestUnit::Adapter</a></span></dd>
|
85
|
+
</dl>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
<dl>
|
90
|
+
<dt>Defined in:</dt>
|
91
|
+
<dd>lib/mocha/api.rb</dd>
|
92
|
+
</dl>
|
93
|
+
|
94
|
+
</div>
|
95
|
+
|
96
|
+
<h2>Overview</h2><div class="docstring">
|
97
|
+
<div class="discussion">
|
98
|
+
|
99
|
+
<p>Methods added to <code>Test::Unit::TestCase</code>, <code>MiniTest::Unit::TestCase</code> or equivalent. The mock creation methods are <span class='object_link'><a href="#mock-instance_method" title="Mocha::API#mock (method)">#mock</a></span>, <span class='object_link'><a href="#stub-instance_method" title="Mocha::API#stub (method)">#stub</a></span> and <span class='object_link'><a href="#stub_everything-instance_method" title="Mocha::API#stub_everything (method)">#stub_everything</a></span>, all of which return a #<span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span> which can be further modified by <span class='object_link'><a href="Mock.html#responds_like-instance_method" title="Mocha::Mock#responds_like (method)">Mock#responds_like</a></span> and <span class='object_link'><a href="Mock.html#responds_like_instance_of-instance_method" title="Mocha::Mock#responds_like_instance_of (method)">Mock#responds_like_instance_of</a></span> methods, both of which return a <span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span>, too, and can therefore, be chained to the original creation methods.</p>
|
100
|
+
|
101
|
+
<p><span class='object_link'><a href="Mock.html#responds_like-instance_method" title="Mocha::Mock#responds_like (method)">Mock#responds_like</a></span> and <span class='object_link'><a href="Mock.html#responds_like_instance_of-instance_method" title="Mocha::Mock#responds_like_instance_of (method)">Mock#responds_like_instance_of</a></span> force the mock to indicate what it is supposed to be mocking, thus making it a safer verifying mock. They check that the underlying <code>responder</code> will actually respond to the methods being stubbed, throwing a <code>NoMethodError</code> upon invocation otherwise.</p>
|
102
|
+
|
103
|
+
|
104
|
+
</div>
|
105
|
+
</div>
|
106
|
+
<div class="tags">
|
107
|
+
|
108
|
+
<div class="examples">
|
109
|
+
<p class="tag_title">Examples:</p>
|
110
|
+
|
111
|
+
|
112
|
+
<p class="example_title"><div class='inline'>
|
113
|
+
<p>Verifying mock using <span class='object_link'><a href="Mock.html#responds_like_instance_of-instance_method" title="Mocha::Mock#responds_like_instance_of (method)">Mock#responds_like_instance_of</a></span></p>
|
114
|
+
</div></p>
|
115
|
+
|
116
|
+
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>Sheep</span>
|
117
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
118
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>some awkward code we don't want to call</span><span class='tstring_end'>"</span></span>
|
119
|
+
<span class='kw'>end</span>
|
120
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_chew'>chew</span><span class='lparen'>(</span><span class='id identifier rubyid_grass'>grass</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span>
|
121
|
+
<span class='kw'>end</span>
|
122
|
+
|
123
|
+
<span class='id identifier rubyid_sheep'>sheep</span> <span class='op'>=</span> <span class='id identifier rubyid_mock'>mock</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sheep</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_responds_like_instance_of'>responds_like_instance_of</span><span class='lparen'>(</span><span class='const'>Sheep</span><span class='rparen'>)</span>
|
124
|
+
<span class='id identifier rubyid_sheep'>sheep</span><span class='period'>.</span><span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:chew</span><span class='rparen'>)</span>
|
125
|
+
<span class='id identifier rubyid_sheep'>sheep</span><span class='period'>.</span><span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:foo</span><span class='rparen'>)</span>
|
126
|
+
<span class='id identifier rubyid_sheep'>sheep</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:chew</span><span class='rparen'>)</span> <span class='comment'># => true
|
127
|
+
</span><span class='id identifier rubyid_sheep'>sheep</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:foo</span><span class='rparen'>)</span> <span class='comment'># => false
|
128
|
+
</span><span class='id identifier rubyid_sheep'>sheep</span><span class='period'>.</span><span class='id identifier rubyid_chew'>chew</span>
|
129
|
+
<span class='id identifier rubyid_sheep'>sheep</span><span class='period'>.</span><span class='id identifier rubyid_foo'>foo</span> <span class='comment'># => raises NoMethodError exception</span></code></pre>
|
130
|
+
|
131
|
+
</div>
|
132
|
+
|
133
|
+
|
134
|
+
</div>
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
<h2>
|
143
|
+
Instance Method Summary
|
144
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
145
|
+
</h2>
|
146
|
+
|
147
|
+
<ul class="summary">
|
148
|
+
|
149
|
+
<li class="public ">
|
150
|
+
<span class="summary_signature">
|
151
|
+
|
152
|
+
<a href="#mock-instance_method" title="#mock (instance method)">#<strong>mock</strong>(*arguments) ⇒ Mock </a>
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
</span>
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
<span class="summary_desc"><div class='inline'>
|
167
|
+
<p>Builds a new mock object.</p>
|
168
|
+
</div></span>
|
169
|
+
|
170
|
+
</li>
|
171
|
+
|
172
|
+
|
173
|
+
<li class="public ">
|
174
|
+
<span class="summary_signature">
|
175
|
+
|
176
|
+
<a href="#sequence-instance_method" title="#sequence (instance method)">#<strong>sequence</strong>(name) ⇒ Sequence </a>
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
</span>
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
<span class="summary_desc"><div class='inline'>
|
191
|
+
<p>Builds a new sequence which can be used to constrain the order in which expectations can occur.</p>
|
192
|
+
</div></span>
|
193
|
+
|
194
|
+
</li>
|
195
|
+
|
196
|
+
|
197
|
+
<li class="public ">
|
198
|
+
<span class="summary_signature">
|
199
|
+
|
200
|
+
<a href="#states-instance_method" title="#states (instance method)">#<strong>states</strong>(name) ⇒ StateMachine </a>
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
</span>
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
<span class="summary_desc"><div class='inline'>
|
215
|
+
<p>Builds a new state machine which can be used to constrain the order in which expectations can occur.</p>
|
216
|
+
</div></span>
|
217
|
+
|
218
|
+
</li>
|
219
|
+
|
220
|
+
|
221
|
+
<li class="public ">
|
222
|
+
<span class="summary_signature">
|
223
|
+
|
224
|
+
<a href="#stub-instance_method" title="#stub (instance method)">#<strong>stub</strong>(*arguments) ⇒ Mock </a>
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
</span>
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
<span class="summary_desc"><div class='inline'>
|
239
|
+
<p>Builds a new mock object.</p>
|
240
|
+
</div></span>
|
241
|
+
|
242
|
+
</li>
|
243
|
+
|
244
|
+
|
245
|
+
<li class="public ">
|
246
|
+
<span class="summary_signature">
|
247
|
+
|
248
|
+
<a href="#stub_everything-instance_method" title="#stub_everything (instance method)">#<strong>stub_everything</strong>(*arguments) ⇒ Mock </a>
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
</span>
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
<span class="summary_desc"><div class='inline'>
|
263
|
+
<p>Builds a mock object that accepts calls to any method.</p>
|
264
|
+
</div></span>
|
265
|
+
|
266
|
+
</li>
|
267
|
+
|
268
|
+
|
269
|
+
</ul>
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Hooks.html" title="Mocha::Hooks (module)">Hooks</a></span></h3>
|
282
|
+
<p class="inherited"><span class='object_link'><a href="Hooks.html#mocha_setup-instance_method" title="Mocha::Hooks#mocha_setup (method)">#mocha_setup</a></span>, <span class='object_link'><a href="Hooks.html#mocha_teardown-instance_method" title="Mocha::Hooks#mocha_teardown (method)">#mocha_teardown</a></span>, <span class='object_link'><a href="Hooks.html#mocha_verify-instance_method" title="Mocha::Hooks#mocha_verify (method)">#mocha_verify</a></span></p>
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="ParameterMatchers.html" title="Mocha::ParameterMatchers (module)">ParameterMatchers</a></span></h3>
|
293
|
+
<p class="inherited"><span class='object_link'><a href="ParameterMatchers.html#Not-instance_method" title="Mocha::ParameterMatchers#Not (method)">#Not</a></span>, <span class='object_link'><a href="ParameterMatchers.html#all_of-instance_method" title="Mocha::ParameterMatchers#all_of (method)">#all_of</a></span>, <span class='object_link'><a href="ParameterMatchers.html#any_of-instance_method" title="Mocha::ParameterMatchers#any_of (method)">#any_of</a></span>, <span class='object_link'><a href="ParameterMatchers.html#any_parameters-instance_method" title="Mocha::ParameterMatchers#any_parameters (method)">#any_parameters</a></span>, <span class='object_link'><a href="ParameterMatchers.html#anything-instance_method" title="Mocha::ParameterMatchers#anything (method)">#anything</a></span>, <span class='object_link'><a href="ParameterMatchers.html#equals-instance_method" title="Mocha::ParameterMatchers#equals (method)">#equals</a></span>, <span class='object_link'><a href="ParameterMatchers.html#equivalent_uri-instance_method" title="Mocha::ParameterMatchers#equivalent_uri (method)">#equivalent_uri</a></span>, <span class='object_link'><a href="ParameterMatchers.html#has_entries-instance_method" title="Mocha::ParameterMatchers#has_entries (method)">#has_entries</a></span>, <span class='object_link'><a href="ParameterMatchers.html#has_entry-instance_method" title="Mocha::ParameterMatchers#has_entry (method)">#has_entry</a></span>, <span class='object_link'><a href="ParameterMatchers.html#has_key-instance_method" title="Mocha::ParameterMatchers#has_key (method)">#has_key</a></span>, <span class='object_link'><a href="ParameterMatchers.html#has_value-instance_method" title="Mocha::ParameterMatchers#has_value (method)">#has_value</a></span>, <span class='object_link'><a href="ParameterMatchers.html#includes-instance_method" title="Mocha::ParameterMatchers#includes (method)">#includes</a></span>, <span class='object_link'><a href="ParameterMatchers.html#instance_of-instance_method" title="Mocha::ParameterMatchers#instance_of (method)">#instance_of</a></span>, <span class='object_link'><a href="ParameterMatchers.html#is_a-instance_method" title="Mocha::ParameterMatchers#is_a (method)">#is_a</a></span>, <span class='object_link'><a href="ParameterMatchers.html#kind_of-instance_method" title="Mocha::ParameterMatchers#kind_of (method)">#kind_of</a></span>, <span class='object_link'><a href="ParameterMatchers.html#optionally-instance_method" title="Mocha::ParameterMatchers#optionally (method)">#optionally</a></span>, <span class='object_link'><a href="ParameterMatchers.html#regexp_matches-instance_method" title="Mocha::ParameterMatchers#regexp_matches (method)">#regexp_matches</a></span>, <span class='object_link'><a href="ParameterMatchers.html#responds_with-instance_method" title="Mocha::ParameterMatchers#responds_with (method)">#responds_with</a></span>, <span class='object_link'><a href="ParameterMatchers.html#yaml_equivalent-instance_method" title="Mocha::ParameterMatchers#yaml_equivalent (method)">#yaml_equivalent</a></span></p>
|
294
|
+
|
295
|
+
|
296
|
+
<div id="instance_method_details" class="method_details_list">
|
297
|
+
<h2>Instance Method Details</h2>
|
298
|
+
|
299
|
+
|
300
|
+
<div class="method_details first">
|
301
|
+
<h3 class="signature first" id="mock-instance_method">
|
302
|
+
|
303
|
+
|
304
|
+
<span class="overload">#<strong>mock</strong>(name) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
305
|
+
|
306
|
+
<span class="overload">#<strong>mock</strong>(expected_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
307
|
+
|
308
|
+
<span class="overload">#<strong>mock</strong>(name, expected_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
</h3><div class="docstring">
|
316
|
+
<div class="discussion">
|
317
|
+
|
318
|
+
<p>Builds a new mock object</p>
|
319
|
+
|
320
|
+
|
321
|
+
</div>
|
322
|
+
</div>
|
323
|
+
<div class="tags">
|
324
|
+
|
325
|
+
<div class="examples">
|
326
|
+
<p class="tag_title">Examples:</p>
|
327
|
+
|
328
|
+
|
329
|
+
<p class="example_title"><div class='inline'>
|
330
|
+
<p>Using expected_methods_vs_return_values Hash to setup expectations.</p>
|
331
|
+
</div></p>
|
332
|
+
|
333
|
+
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_test_motor_starts_and_stops'>test_motor_starts_and_stops</span>
|
334
|
+
<span class='id identifier rubyid_motor'>motor</span> <span class='op'>=</span> <span class='id identifier rubyid_mock'>mock</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>motor</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:start</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:stop</span> <span class='op'>=></span> <span class='kw'>true</span><span class='rparen'>)</span>
|
335
|
+
<span class='id identifier rubyid_assert'>assert</span> <span class='id identifier rubyid_motor'>motor</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
|
336
|
+
<span class='id identifier rubyid_assert'>assert</span> <span class='id identifier rubyid_motor'>motor</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
|
337
|
+
<span class='comment'># an error will be raised unless both Motor#start and Motor#stop have been called
|
338
|
+
</span><span class='kw'>end</span></code></pre>
|
339
|
+
|
340
|
+
</div>
|
341
|
+
|
342
|
+
<p class="tag_title">Overloads:</p>
|
343
|
+
<ul class="overload">
|
344
|
+
|
345
|
+
|
346
|
+
<li class="overload_item">
|
347
|
+
<span class="signature">#<strong>mock</strong>(name) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
348
|
+
<div class="docstring">
|
349
|
+
<div class="discussion">
|
350
|
+
|
351
|
+
|
352
|
+
</div>
|
353
|
+
</div>
|
354
|
+
<div class="tags">
|
355
|
+
<p class="tag_title">Parameters:</p>
|
356
|
+
<ul class="param">
|
357
|
+
|
358
|
+
<li>
|
359
|
+
|
360
|
+
<span class='name'>name</span>
|
361
|
+
|
362
|
+
|
363
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
—
|
368
|
+
<div class='inline'>
|
369
|
+
<p>identifies mock object in error messages.</p>
|
370
|
+
</div>
|
371
|
+
|
372
|
+
</li>
|
373
|
+
|
374
|
+
</ul>
|
375
|
+
|
376
|
+
|
377
|
+
</div>
|
378
|
+
</li>
|
379
|
+
|
380
|
+
|
381
|
+
<li class="overload_item">
|
382
|
+
<span class="signature">#<strong>mock</strong>(expected_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
383
|
+
<div class="docstring">
|
384
|
+
<div class="discussion">
|
385
|
+
|
386
|
+
|
387
|
+
</div>
|
388
|
+
</div>
|
389
|
+
<div class="tags">
|
390
|
+
<p class="tag_title">Parameters:</p>
|
391
|
+
<ul class="param">
|
392
|
+
|
393
|
+
<li>
|
394
|
+
|
395
|
+
<span class='name'>expected_methods_vs_return_values</span>
|
396
|
+
|
397
|
+
|
398
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
399
|
+
|
400
|
+
|
401
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
402
|
+
|
403
|
+
|
404
|
+
—
|
405
|
+
<div class='inline'>
|
406
|
+
<p>expected method name symbols as keys and corresponding return values as values - these expectations are setup as if <span class='object_link'><a href="Mock.html#expects-instance_method" title="Mocha::Mock#expects (method)">Mock#expects</a></span> were called multiple times.</p>
|
407
|
+
</div>
|
408
|
+
|
409
|
+
</li>
|
410
|
+
|
411
|
+
</ul>
|
412
|
+
|
413
|
+
|
414
|
+
</div>
|
415
|
+
</li>
|
416
|
+
|
417
|
+
|
418
|
+
<li class="overload_item">
|
419
|
+
<span class="signature">#<strong>mock</strong>(name, expected_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
420
|
+
<div class="docstring">
|
421
|
+
<div class="discussion">
|
422
|
+
|
423
|
+
|
424
|
+
</div>
|
425
|
+
</div>
|
426
|
+
<div class="tags">
|
427
|
+
<p class="tag_title">Parameters:</p>
|
428
|
+
<ul class="param">
|
429
|
+
|
430
|
+
<li>
|
431
|
+
|
432
|
+
<span class='name'>name</span>
|
433
|
+
|
434
|
+
|
435
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
—
|
440
|
+
<div class='inline'>
|
441
|
+
<p>identifies mock object in error messages.</p>
|
442
|
+
</div>
|
443
|
+
|
444
|
+
</li>
|
445
|
+
|
446
|
+
<li>
|
447
|
+
|
448
|
+
<span class='name'>expected_methods_vs_return_values</span>
|
449
|
+
|
450
|
+
|
451
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
452
|
+
|
453
|
+
|
454
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
455
|
+
|
456
|
+
|
457
|
+
—
|
458
|
+
<div class='inline'>
|
459
|
+
<p>expected method name symbols as keys and corresponding return values as values - these expectations are setup as if <span class='object_link'><a href="Mock.html#expects-instance_method" title="Mocha::Mock#expects (method)">Mock#expects</a></span> were called multiple times.</p>
|
460
|
+
</div>
|
461
|
+
|
462
|
+
</li>
|
463
|
+
|
464
|
+
</ul>
|
465
|
+
|
466
|
+
|
467
|
+
</div>
|
468
|
+
</li>
|
469
|
+
|
470
|
+
</ul>
|
471
|
+
|
472
|
+
<p class="tag_title">Returns:</p>
|
473
|
+
<ul class="return">
|
474
|
+
|
475
|
+
<li>
|
476
|
+
|
477
|
+
|
478
|
+
<span class='type'>(<tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt>)</span>
|
479
|
+
|
480
|
+
|
481
|
+
|
482
|
+
—
|
483
|
+
<div class='inline'>
|
484
|
+
<p>a new mock object</p>
|
485
|
+
</div>
|
486
|
+
|
487
|
+
</li>
|
488
|
+
|
489
|
+
</ul>
|
490
|
+
|
491
|
+
</div><table class="source_code">
|
492
|
+
<tr>
|
493
|
+
<td>
|
494
|
+
<pre class="lines">
|
495
|
+
|
496
|
+
|
497
|
+
62
|
498
|
+
63
|
499
|
+
64</pre>
|
500
|
+
</td>
|
501
|
+
<td>
|
502
|
+
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 62</span>
|
503
|
+
|
504
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_mock'>mock</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span>
|
505
|
+
<span class='id identifier rubyid_create_mock'>create_mock</span><span class='lparen'>(</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_mock'>mock</span><span class='comma'>,</span> <span class='id identifier rubyid_expectations'>expectations</span><span class='op'>|</span> <span class='id identifier rubyid_mock'>mock</span><span class='period'>.</span><span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='id identifier rubyid_expectations'>expectations</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
506
|
+
<span class='kw'>end</span></pre>
|
507
|
+
</td>
|
508
|
+
</tr>
|
509
|
+
</table>
|
510
|
+
</div>
|
511
|
+
|
512
|
+
<div class="method_details ">
|
513
|
+
<h3 class="signature " id="sequence-instance_method">
|
514
|
+
|
515
|
+
#<strong>sequence</strong>(name) ⇒ <tt><span class='object_link'><a href="Sequence.html" title="Mocha::Sequence (class)">Sequence</a></span></tt>
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
</h3><div class="docstring">
|
522
|
+
<div class="discussion">
|
523
|
+
|
524
|
+
<p>Builds a new sequence which can be used to constrain the order in which expectations can occur.</p>
|
525
|
+
|
526
|
+
<p>Specify that an expected invocation must occur within a named <span class='object_link'><a href="Sequence.html" title="Mocha::Sequence (class)">Sequence</a></span> by using <span class='object_link'><a href="Expectation.html#in_sequence-instance_method" title="Mocha::Expectation#in_sequence (method)">Expectation#in_sequence</a></span>.</p>
|
527
|
+
|
528
|
+
|
529
|
+
</div>
|
530
|
+
</div>
|
531
|
+
<div class="tags">
|
532
|
+
|
533
|
+
<div class="examples">
|
534
|
+
<p class="tag_title">Examples:</p>
|
535
|
+
|
536
|
+
|
537
|
+
<p class="example_title"><div class='inline'>
|
538
|
+
<p>Ensure methods on egg are invoked in correct order.</p>
|
539
|
+
</div></p>
|
540
|
+
|
541
|
+
<pre class="example code"><code><span class='id identifier rubyid_breakfast'>breakfast</span> <span class='op'>=</span> <span class='id identifier rubyid_sequence'>sequence</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>breakfast</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
542
|
+
|
543
|
+
<span class='id identifier rubyid_egg'>egg</span> <span class='op'>=</span> <span class='id identifier rubyid_mock'>mock</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>egg</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
|
544
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:crack</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_in_sequence'>in_sequence</span><span class='lparen'>(</span><span class='id identifier rubyid_breakfast'>breakfast</span><span class='rparen'>)</span>
|
545
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:fry</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_in_sequence'>in_sequence</span><span class='lparen'>(</span><span class='id identifier rubyid_breakfast'>breakfast</span><span class='rparen'>)</span>
|
546
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:eat</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_in_sequence'>in_sequence</span><span class='lparen'>(</span><span class='id identifier rubyid_breakfast'>breakfast</span><span class='rparen'>)</span>
|
547
|
+
<span class='kw'>end</span></code></pre>
|
548
|
+
|
549
|
+
</div>
|
550
|
+
|
551
|
+
<p class="tag_title">Returns:</p>
|
552
|
+
<ul class="return">
|
553
|
+
|
554
|
+
<li>
|
555
|
+
|
556
|
+
|
557
|
+
<span class='type'>(<tt><span class='object_link'><a href="Sequence.html" title="Mocha::Sequence (class)">Sequence</a></span></tt>)</span>
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
—
|
562
|
+
<div class='inline'>
|
563
|
+
<p>a new sequence</p>
|
564
|
+
</div>
|
565
|
+
|
566
|
+
</li>
|
567
|
+
|
568
|
+
</ul>
|
569
|
+
|
570
|
+
<p class="tag_title">See Also:</p>
|
571
|
+
<ul class="see">
|
572
|
+
|
573
|
+
<li><span class='object_link'><a href="Expectation.html#in_sequence-instance_method" title="Mocha::Expectation#in_sequence (method)">Expectation#in_sequence</a></span></li>
|
574
|
+
|
575
|
+
</ul>
|
576
|
+
|
577
|
+
</div><table class="source_code">
|
578
|
+
<tr>
|
579
|
+
<td>
|
580
|
+
<pre class="lines">
|
581
|
+
|
582
|
+
|
583
|
+
130
|
584
|
+
131
|
585
|
+
132</pre>
|
586
|
+
</td>
|
587
|
+
<td>
|
588
|
+
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 130</span>
|
589
|
+
|
590
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sequence'>sequence</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
591
|
+
<span class='const'><span class='object_link'><a href="Sequence.html" title="Mocha::Sequence (class)">Sequence</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
592
|
+
<span class='kw'>end</span></pre>
|
593
|
+
</td>
|
594
|
+
</tr>
|
595
|
+
</table>
|
596
|
+
</div>
|
597
|
+
|
598
|
+
<div class="method_details ">
|
599
|
+
<h3 class="signature " id="states-instance_method">
|
600
|
+
|
601
|
+
#<strong>states</strong>(name) ⇒ <tt><span class='object_link'><a href="StateMachine.html" title="Mocha::StateMachine (class)">StateMachine</a></span></tt>
|
602
|
+
|
603
|
+
|
604
|
+
|
605
|
+
|
606
|
+
|
607
|
+
</h3><div class="docstring">
|
608
|
+
<div class="discussion">
|
609
|
+
|
610
|
+
<p>Builds a new state machine which can be used to constrain the order in which expectations can occur.</p>
|
611
|
+
|
612
|
+
<p>Specify the initial state of the state machine by using <span class='object_link'><a href="StateMachine.html#starts_as-instance_method" title="Mocha::StateMachine#starts_as (method)">StateMachine#starts_as</a></span>.</p>
|
613
|
+
|
614
|
+
<p>Specify that an expected invocation should change the state of the state machine by using <span class='object_link'><a href="Expectation.html#then-instance_method" title="Mocha::Expectation#then (method)">Expectation#then</a></span>.</p>
|
615
|
+
|
616
|
+
<p>Specify that an expected invocation should be constrained to occur within a particular <code>state</code> by using <span class='object_link'><a href="Expectation.html#when-instance_method" title="Mocha::Expectation#when (method)">Expectation#when</a></span>.</p>
|
617
|
+
|
618
|
+
<p>A test can contain multiple state machines.</p>
|
619
|
+
|
620
|
+
|
621
|
+
</div>
|
622
|
+
</div>
|
623
|
+
<div class="tags">
|
624
|
+
|
625
|
+
<div class="examples">
|
626
|
+
<p class="tag_title">Examples:</p>
|
627
|
+
|
628
|
+
|
629
|
+
<p class="example_title"><div class='inline'>
|
630
|
+
<p>Constrain expected invocations to occur in particular states.</p>
|
631
|
+
</div></p>
|
632
|
+
|
633
|
+
<pre class="example code"><code><span class='id identifier rubyid_power'>power</span> <span class='op'>=</span> <span class='id identifier rubyid_states'>states</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>power</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_starts_as'>starts_as</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>off</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
634
|
+
|
635
|
+
<span class='id identifier rubyid_radio'>radio</span> <span class='op'>=</span> <span class='id identifier rubyid_mock'>mock</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>radio</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
|
636
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:switch_on</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_then'>then</span><span class='lparen'>(</span><span class='id identifier rubyid_power'>power</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>on</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
637
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:select_channel</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>BBC Radio 4</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_when'>when</span><span class='lparen'>(</span><span class='id identifier rubyid_power'>power</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>on</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
638
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:adjust_volume</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='int'>+5</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_when'>when</span><span class='lparen'>(</span><span class='id identifier rubyid_power'>power</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>on</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
639
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:select_channel</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>BBC World Service</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_when'>when</span><span class='lparen'>(</span><span class='id identifier rubyid_power'>power</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>on</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
640
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:adjust_volume</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='op'>-</span><span class='int'>5</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_when'>when</span><span class='lparen'>(</span><span class='id identifier rubyid_power'>power</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>on</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
641
|
+
<span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='symbol'>:switch_off</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_then'>then</span><span class='lparen'>(</span><span class='id identifier rubyid_power'>power</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>off</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
642
|
+
<span class='kw'>end</span></code></pre>
|
643
|
+
|
644
|
+
</div>
|
645
|
+
|
646
|
+
<p class="tag_title">Returns:</p>
|
647
|
+
<ul class="return">
|
648
|
+
|
649
|
+
<li>
|
650
|
+
|
651
|
+
|
652
|
+
<span class='type'>(<tt><span class='object_link'><a href="StateMachine.html" title="Mocha::StateMachine (class)">StateMachine</a></span></tt>)</span>
|
653
|
+
|
654
|
+
|
655
|
+
|
656
|
+
—
|
657
|
+
<div class='inline'>
|
658
|
+
<p>a new state machine</p>
|
659
|
+
</div>
|
660
|
+
|
661
|
+
</li>
|
662
|
+
|
663
|
+
</ul>
|
664
|
+
|
665
|
+
<p class="tag_title">See Also:</p>
|
666
|
+
<ul class="see">
|
667
|
+
|
668
|
+
<li><span class='object_link'><a href="Expectation.html#then-instance_method" title="Mocha::Expectation#then (method)">Expectation#then</a></span></li>
|
669
|
+
|
670
|
+
<li><span class='object_link'><a href="Expectation.html#when-instance_method" title="Mocha::Expectation#when (method)">Expectation#when</a></span></li>
|
671
|
+
|
672
|
+
<li><span class='object_link'><a href="StateMachine.html" title="Mocha::StateMachine (class)">StateMachine</a></span></li>
|
673
|
+
|
674
|
+
</ul>
|
675
|
+
|
676
|
+
</div><table class="source_code">
|
677
|
+
<tr>
|
678
|
+
<td>
|
679
|
+
<pre class="lines">
|
680
|
+
|
681
|
+
|
682
|
+
160
|
683
|
+
161
|
684
|
+
162</pre>
|
685
|
+
</td>
|
686
|
+
<td>
|
687
|
+
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 160</span>
|
688
|
+
|
689
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_states'>states</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
690
|
+
<span class='const'>Mockery</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_new_state_machine'>new_state_machine</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
691
|
+
<span class='kw'>end</span></pre>
|
692
|
+
</td>
|
693
|
+
</tr>
|
694
|
+
</table>
|
695
|
+
</div>
|
696
|
+
|
697
|
+
<div class="method_details ">
|
698
|
+
<h3 class="signature " id="stub-instance_method">
|
699
|
+
|
700
|
+
|
701
|
+
<span class="overload">#<strong>stub</strong>(name) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
702
|
+
|
703
|
+
<span class="overload">#<strong>stub</strong>(stubbed_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
704
|
+
|
705
|
+
<span class="overload">#<strong>stub</strong>(name, stubbed_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
706
|
+
|
707
|
+
|
708
|
+
|
709
|
+
|
710
|
+
|
711
|
+
|
712
|
+
</h3><div class="docstring">
|
713
|
+
<div class="discussion">
|
714
|
+
|
715
|
+
<p>Builds a new mock object</p>
|
716
|
+
|
717
|
+
|
718
|
+
</div>
|
719
|
+
</div>
|
720
|
+
<div class="tags">
|
721
|
+
|
722
|
+
<div class="examples">
|
723
|
+
<p class="tag_title">Examples:</p>
|
724
|
+
|
725
|
+
|
726
|
+
<p class="example_title"><div class='inline'>
|
727
|
+
<p>Using stubbed_methods_vs_return_values Hash to setup stubbed methods.</p>
|
728
|
+
</div></p>
|
729
|
+
|
730
|
+
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_test_motor_starts_and_stops'>test_motor_starts_and_stops</span>
|
731
|
+
<span class='id identifier rubyid_motor'>motor</span> <span class='op'>=</span> <span class='id identifier rubyid_stub'>stub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>motor</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:start</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:stop</span> <span class='op'>=></span> <span class='kw'>true</span><span class='rparen'>)</span>
|
732
|
+
<span class='id identifier rubyid_assert'>assert</span> <span class='id identifier rubyid_motor'>motor</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
|
733
|
+
<span class='id identifier rubyid_assert'>assert</span> <span class='id identifier rubyid_motor'>motor</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
|
734
|
+
<span class='comment'># an error will not be raised even if either Motor#start or Motor#stop has not been called
|
735
|
+
</span><span class='kw'>end</span></code></pre>
|
736
|
+
|
737
|
+
</div>
|
738
|
+
|
739
|
+
<p class="tag_title">Overloads:</p>
|
740
|
+
<ul class="overload">
|
741
|
+
|
742
|
+
|
743
|
+
<li class="overload_item">
|
744
|
+
<span class="signature">#<strong>stub</strong>(name) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
745
|
+
<div class="docstring">
|
746
|
+
<div class="discussion">
|
747
|
+
|
748
|
+
|
749
|
+
</div>
|
750
|
+
</div>
|
751
|
+
<div class="tags">
|
752
|
+
<p class="tag_title">Parameters:</p>
|
753
|
+
<ul class="param">
|
754
|
+
|
755
|
+
<li>
|
756
|
+
|
757
|
+
<span class='name'>name</span>
|
758
|
+
|
759
|
+
|
760
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
761
|
+
|
762
|
+
|
763
|
+
|
764
|
+
—
|
765
|
+
<div class='inline'>
|
766
|
+
<p>identifies mock object in error messages.</p>
|
767
|
+
</div>
|
768
|
+
|
769
|
+
</li>
|
770
|
+
|
771
|
+
</ul>
|
772
|
+
|
773
|
+
|
774
|
+
</div>
|
775
|
+
</li>
|
776
|
+
|
777
|
+
|
778
|
+
<li class="overload_item">
|
779
|
+
<span class="signature">#<strong>stub</strong>(stubbed_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
780
|
+
<div class="docstring">
|
781
|
+
<div class="discussion">
|
782
|
+
|
783
|
+
|
784
|
+
</div>
|
785
|
+
</div>
|
786
|
+
<div class="tags">
|
787
|
+
<p class="tag_title">Parameters:</p>
|
788
|
+
<ul class="param">
|
789
|
+
|
790
|
+
<li>
|
791
|
+
|
792
|
+
<span class='name'>stubbed_methods_vs_return_values</span>
|
793
|
+
|
794
|
+
|
795
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
796
|
+
|
797
|
+
|
798
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
799
|
+
|
800
|
+
|
801
|
+
—
|
802
|
+
<div class='inline'>
|
803
|
+
<p>stubbed method name symbols as keys and corresponding return values as values - these stubbed methods are setup as if <span class='object_link'><a href="Mock.html#stubs-instance_method" title="Mocha::Mock#stubs (method)">Mock#stubs</a></span> were called multiple times.</p>
|
804
|
+
</div>
|
805
|
+
|
806
|
+
</li>
|
807
|
+
|
808
|
+
</ul>
|
809
|
+
|
810
|
+
|
811
|
+
</div>
|
812
|
+
</li>
|
813
|
+
|
814
|
+
|
815
|
+
<li class="overload_item">
|
816
|
+
<span class="signature">#<strong>stub</strong>(name, stubbed_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
817
|
+
<div class="docstring">
|
818
|
+
<div class="discussion">
|
819
|
+
|
820
|
+
|
821
|
+
</div>
|
822
|
+
</div>
|
823
|
+
<div class="tags">
|
824
|
+
<p class="tag_title">Parameters:</p>
|
825
|
+
<ul class="param">
|
826
|
+
|
827
|
+
<li>
|
828
|
+
|
829
|
+
<span class='name'>name</span>
|
830
|
+
|
831
|
+
|
832
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
833
|
+
|
834
|
+
|
835
|
+
|
836
|
+
—
|
837
|
+
<div class='inline'>
|
838
|
+
<p>identifies mock object in error messages.</p>
|
839
|
+
</div>
|
840
|
+
|
841
|
+
</li>
|
842
|
+
|
843
|
+
</ul>
|
844
|
+
|
845
|
+
|
846
|
+
</div>
|
847
|
+
</li>
|
848
|
+
|
849
|
+
</ul>
|
850
|
+
|
851
|
+
<p class="tag_title">Returns:</p>
|
852
|
+
<ul class="return">
|
853
|
+
|
854
|
+
<li>
|
855
|
+
|
856
|
+
|
857
|
+
<span class='type'>(<tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt>)</span>
|
858
|
+
|
859
|
+
|
860
|
+
|
861
|
+
—
|
862
|
+
<div class='inline'>
|
863
|
+
<p>a new mock object</p>
|
864
|
+
</div>
|
865
|
+
|
866
|
+
</li>
|
867
|
+
|
868
|
+
</ul>
|
869
|
+
|
870
|
+
</div><table class="source_code">
|
871
|
+
<tr>
|
872
|
+
<td>
|
873
|
+
<pre class="lines">
|
874
|
+
|
875
|
+
|
876
|
+
84
|
877
|
+
85
|
878
|
+
86</pre>
|
879
|
+
</td>
|
880
|
+
<td>
|
881
|
+
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 84</span>
|
882
|
+
|
883
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stub'>stub</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span>
|
884
|
+
<span class='id identifier rubyid_create_mock'>create_mock</span><span class='lparen'>(</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_stub'>stub</span><span class='comma'>,</span> <span class='id identifier rubyid_expectations'>expectations</span><span class='op'>|</span> <span class='id identifier rubyid_stub'>stub</span><span class='period'>.</span><span class='id identifier rubyid_stubs'>stubs</span><span class='lparen'>(</span><span class='id identifier rubyid_expectations'>expectations</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
885
|
+
<span class='kw'>end</span></pre>
|
886
|
+
</td>
|
887
|
+
</tr>
|
888
|
+
</table>
|
889
|
+
</div>
|
890
|
+
|
891
|
+
<div class="method_details ">
|
892
|
+
<h3 class="signature " id="stub_everything-instance_method">
|
893
|
+
|
894
|
+
|
895
|
+
<span class="overload">#<strong>stub_everything</strong>(name) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
896
|
+
|
897
|
+
<span class="overload">#<strong>stub_everything</strong>(stubbed_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
898
|
+
|
899
|
+
<span class="overload">#<strong>stub_everything</strong>(name, stubbed_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
900
|
+
|
901
|
+
|
902
|
+
|
903
|
+
|
904
|
+
|
905
|
+
|
906
|
+
</h3><div class="docstring">
|
907
|
+
<div class="discussion">
|
908
|
+
|
909
|
+
<p>Builds a mock object that accepts calls to any method. By default it will return <code>nil</code> for any method call.</p>
|
910
|
+
|
911
|
+
|
912
|
+
</div>
|
913
|
+
</div>
|
914
|
+
<div class="tags">
|
915
|
+
|
916
|
+
<div class="examples">
|
917
|
+
<p class="tag_title">Examples:</p>
|
918
|
+
|
919
|
+
|
920
|
+
<p class="example_title"><div class='inline'>
|
921
|
+
<p>Ignore invocations of irrelevant methods.</p>
|
922
|
+
</div></p>
|
923
|
+
|
924
|
+
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_test_motor_stops'>test_motor_stops</span>
|
925
|
+
<span class='id identifier rubyid_motor'>motor</span> <span class='op'>=</span> <span class='id identifier rubyid_stub_everything'>stub_everything</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>motor</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:stop</span> <span class='op'>=></span> <span class='kw'>true</span><span class='rparen'>)</span>
|
926
|
+
<span class='id identifier rubyid_assert_nil'>assert_nil</span> <span class='id identifier rubyid_motor'>motor</span><span class='period'>.</span><span class='id identifier rubyid_irrelevant_method_1'>irrelevant_method_1</span> <span class='comment'># => no error raised
|
927
|
+
</span> <span class='id identifier rubyid_assert_nil'>assert_nil</span> <span class='id identifier rubyid_motor'>motor</span><span class='period'>.</span><span class='id identifier rubyid_irrelevant_method_2'>irrelevant_method_2</span> <span class='comment'># => no error raised
|
928
|
+
</span> <span class='id identifier rubyid_assert'>assert</span> <span class='id identifier rubyid_motor'>motor</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
|
929
|
+
<span class='kw'>end</span></code></pre>
|
930
|
+
|
931
|
+
</div>
|
932
|
+
|
933
|
+
<p class="tag_title">Overloads:</p>
|
934
|
+
<ul class="overload">
|
935
|
+
|
936
|
+
|
937
|
+
<li class="overload_item">
|
938
|
+
<span class="signature">#<strong>stub_everything</strong>(name) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
939
|
+
<div class="docstring">
|
940
|
+
<div class="discussion">
|
941
|
+
|
942
|
+
|
943
|
+
</div>
|
944
|
+
</div>
|
945
|
+
<div class="tags">
|
946
|
+
<p class="tag_title">Parameters:</p>
|
947
|
+
<ul class="param">
|
948
|
+
|
949
|
+
<li>
|
950
|
+
|
951
|
+
<span class='name'>name</span>
|
952
|
+
|
953
|
+
|
954
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
955
|
+
|
956
|
+
|
957
|
+
|
958
|
+
—
|
959
|
+
<div class='inline'>
|
960
|
+
<p>identifies mock object in error messages.</p>
|
961
|
+
</div>
|
962
|
+
|
963
|
+
</li>
|
964
|
+
|
965
|
+
</ul>
|
966
|
+
|
967
|
+
|
968
|
+
</div>
|
969
|
+
</li>
|
970
|
+
|
971
|
+
|
972
|
+
<li class="overload_item">
|
973
|
+
<span class="signature">#<strong>stub_everything</strong>(stubbed_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
974
|
+
<div class="docstring">
|
975
|
+
<div class="discussion">
|
976
|
+
|
977
|
+
|
978
|
+
</div>
|
979
|
+
</div>
|
980
|
+
<div class="tags">
|
981
|
+
<p class="tag_title">Parameters:</p>
|
982
|
+
<ul class="param">
|
983
|
+
|
984
|
+
<li>
|
985
|
+
|
986
|
+
<span class='name'>stubbed_methods_vs_return_values</span>
|
987
|
+
|
988
|
+
|
989
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
990
|
+
|
991
|
+
|
992
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
993
|
+
|
994
|
+
|
995
|
+
—
|
996
|
+
<div class='inline'>
|
997
|
+
<p>stubbed method name symbols as keys and corresponding return values as values - these stubbed methods are setup as if <span class='object_link'><a href="Mock.html#stubs-instance_method" title="Mocha::Mock#stubs (method)">Mock#stubs</a></span> were called multiple times.</p>
|
998
|
+
</div>
|
999
|
+
|
1000
|
+
</li>
|
1001
|
+
|
1002
|
+
</ul>
|
1003
|
+
|
1004
|
+
|
1005
|
+
</div>
|
1006
|
+
</li>
|
1007
|
+
|
1008
|
+
|
1009
|
+
<li class="overload_item">
|
1010
|
+
<span class="signature">#<strong>stub_everything</strong>(name, stubbed_methods_vs_return_values = {}) ⇒ <tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt> </span>
|
1011
|
+
<div class="docstring">
|
1012
|
+
<div class="discussion">
|
1013
|
+
|
1014
|
+
|
1015
|
+
</div>
|
1016
|
+
</div>
|
1017
|
+
<div class="tags">
|
1018
|
+
<p class="tag_title">Parameters:</p>
|
1019
|
+
<ul class="param">
|
1020
|
+
|
1021
|
+
<li>
|
1022
|
+
|
1023
|
+
<span class='name'>name</span>
|
1024
|
+
|
1025
|
+
|
1026
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
1027
|
+
|
1028
|
+
|
1029
|
+
|
1030
|
+
—
|
1031
|
+
<div class='inline'>
|
1032
|
+
<p>identifies mock object in error messages.</p>
|
1033
|
+
</div>
|
1034
|
+
|
1035
|
+
</li>
|
1036
|
+
|
1037
|
+
<li>
|
1038
|
+
|
1039
|
+
<span class='name'>stubbed_methods_vs_return_values</span>
|
1040
|
+
|
1041
|
+
|
1042
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1043
|
+
|
1044
|
+
|
1045
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1046
|
+
|
1047
|
+
|
1048
|
+
—
|
1049
|
+
<div class='inline'>
|
1050
|
+
<p>stubbed method name symbols as keys and corresponding return values as values - these stubbed methods are setup as if <span class='object_link'><a href="Mock.html#stubs-instance_method" title="Mocha::Mock#stubs (method)">Mock#stubs</a></span> were called multiple times.</p>
|
1051
|
+
</div>
|
1052
|
+
|
1053
|
+
</li>
|
1054
|
+
|
1055
|
+
</ul>
|
1056
|
+
|
1057
|
+
|
1058
|
+
</div>
|
1059
|
+
</li>
|
1060
|
+
|
1061
|
+
</ul>
|
1062
|
+
|
1063
|
+
<p class="tag_title">Returns:</p>
|
1064
|
+
<ul class="return">
|
1065
|
+
|
1066
|
+
<li>
|
1067
|
+
|
1068
|
+
|
1069
|
+
<span class='type'>(<tt><span class='object_link'><a href="Mock.html" title="Mocha::Mock (class)">Mock</a></span></tt>)</span>
|
1070
|
+
|
1071
|
+
|
1072
|
+
|
1073
|
+
—
|
1074
|
+
<div class='inline'>
|
1075
|
+
<p>a new mock object</p>
|
1076
|
+
</div>
|
1077
|
+
|
1078
|
+
</li>
|
1079
|
+
|
1080
|
+
</ul>
|
1081
|
+
|
1082
|
+
</div><table class="source_code">
|
1083
|
+
<tr>
|
1084
|
+
<td>
|
1085
|
+
<pre class="lines">
|
1086
|
+
|
1087
|
+
|
1088
|
+
107
|
1089
|
+
108
|
1090
|
+
109
|
1091
|
+
110
|
1092
|
+
111
|
1093
|
+
112</pre>
|
1094
|
+
</td>
|
1095
|
+
<td>
|
1096
|
+
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 107</span>
|
1097
|
+
|
1098
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stub_everything'>stub_everything</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span>
|
1099
|
+
<span class='id identifier rubyid_create_mock'>create_mock</span><span class='lparen'>(</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_stub'>stub</span><span class='comma'>,</span> <span class='id identifier rubyid_expectations'>expectations</span><span class='op'>|</span>
|
1100
|
+
<span class='id identifier rubyid_stub'>stub</span><span class='period'>.</span><span class='id identifier rubyid_stub_everything'>stub_everything</span>
|
1101
|
+
<span class='id identifier rubyid_stub'>stub</span><span class='period'>.</span><span class='id identifier rubyid_stubs'>stubs</span><span class='lparen'>(</span><span class='id identifier rubyid_expectations'>expectations</span><span class='rparen'>)</span>
|
1102
|
+
<span class='kw'>end</span>
|
1103
|
+
<span class='kw'>end</span></pre>
|
1104
|
+
</td>
|
1105
|
+
</tr>
|
1106
|
+
</table>
|
1107
|
+
</div>
|
1108
|
+
|
1109
|
+
</div>
|
1110
|
+
|
1111
|
+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-625523-7"></script>
|
1112
|
+
<script>
|
1113
|
+
window.dataLayer = window.dataLayer || [];
|
1114
|
+
function gtag(){dataLayer.push(arguments);}
|
1115
|
+
gtag('js', new Date());
|
1116
|
+
|
1117
|
+
gtag('config', 'UA-625523-7');
|
1118
|
+
</script>
|
1119
|
+
</div>
|
1120
|
+
|
1121
|
+
<div id="footer">
|
1122
|
+
Generated on Sun Nov 24 15:26:49 2019 by
|
1123
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1124
|
+
0.9.20 (ruby-2.6.5).
|
1125
|
+
</div>
|
1126
|
+
|
1127
|
+
</div>
|
1128
|
+
</body>
|
1129
|
+
</html>
|