-
Notifications
You must be signed in to change notification settings - Fork 2
/
BehaveWord.scala
89 lines (85 loc) · 3.27 KB
/
BehaveWord.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
* Copyright 2001-2013 Artima, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.scalatest.verbs
/**
* Class that supports shared test registration via instances referenced from the <code>behave</code> field of <code>FunSpec</code>s,
* <code>FlatSpec</code>s, and <code>WordSpec</code>s as well as instance of their sister traits,
* <code>fixture.FunSpec</code>, <code>fixture.FlatSpec</code>, and <code>fixture.WordSpec</code>.
*
* <p>
* This class, via the <code>behave</code> field, enables syntax such as the following in <code>FunSpec</code>s, <code>FlatSpec</code>s,
* <code>fixture.FunSpec</code>s, and <code>fixture.FlatSpec</code>s:
* </p>
*
* <pre class="stHighlighted">
* it should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* It also enables syntax such as the following syntax in <code>WordSpec</code>s and <code>fixture.WordSpec</code>s:
* </p>
*
* <pre class="stHighlighted">
* behave like nonEmptyStack(lastValuePushed)
* ^
* </pre>
*
* <p>
* For more information and examples of the use of <cod>behave</code>, see the Shared tests section
* in the main documentation for trait <a href="../FunSpec.html#SharedTests"><code>FunSpec</code></a>,
* <a href="../FlatSpec.html#SharedTests"><code>FlatSpec</code></a>, or <a href="../WordSpec.html#SharedTests"><code>WordSpec</code></a>.
* </p>
*/
final class BehaveWord {
/**
* Supports the registration of shared tests.
*
* <p>
* This method enables syntax such as the following in <code>FunSpec</code>s, <code>FlatSpec</code>s,
* <code>fixture.FunSpec</code>s, and <code>fixture.FlatSpec</code>s:
* </p>
*
* <pre class="stHighlighted">
* it should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* It also enables syntax such as the following syntax in <code>WordSpec</code>s and <code>fixture.WordSpec</code>s:
* </p>
*
* <pre class="stHighlighted">
* behave like nonEmptyStack(lastValuePushed)
* ^
* </pre>
*
* <p>
* This method just provides syntax sugar intended to make the intent of the code clearer.
* Because the parameter passed to it is
* type <code>Unit</code>, the expression will be evaluated before being passed, which
* is sufficient to register the shared tests.
* For more information and examples of the use of <cod>behave</code>, see the Shared tests section
* in the main documentation for trait <a href="../FunSpec.html#SharedTests"><code>FunSpec</code></a>,
* <a href="../FlatSpec.html#SharedTests"><code>FlatSpec</code></a>, or <a href="../WordSpec.html#SharedTests"><code>WordSpec</code></a>.
* </p>
*/
def like(unit: Unit): Unit = ()
/**
* Overrides toString to return "behave"
*/
override def toString: String = "behave"
}