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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
package scala.tools.nsc.scaladoc
import org.scalacheck._
import org.scalacheck.Prop._
import scala.tools.nsc.Global
import scala.tools.nsc.doc
import scala.tools.nsc.doc.base.comment._
import scala.tools.nsc.doc.model._
import scala.tools.nsc.doc.model.diagram._
class Factory(val g: Global, val s: doc.Settings)
extends doc.model.ModelFactory(g, s) {
thisFactory: Factory
with ModelFactoryImplicitSupport
with ModelFactoryTypeSupport
with DiagramFactory
with CommentFactory
with doc.model.TreeFactory
with MemberLookup =>
def strip(c: Comment): Option[Inline] = {
c.body match {
case Body(List(Paragraph(Chain(List(Summary(inner)))))) => Some(inner)
case _ => None
}
}
def getComment(s: String): Comment =
parse(s, "", scala.tools.nsc.util.NoPosition, null)
def parseComment(s: String): Option[Inline] =
strip(getComment(s))
def createBody(s: String) =
parse(s, "", scala.tools.nsc.util.NoPosition, null).body
}
object CommentFactoryTest extends Properties("CommentFactory") {
val factory = {
val settings = new doc.Settings((str: String) => {})
val reporter = new scala.tools.nsc.reporters.ConsoleReporter(settings)
val g = new Global(settings, reporter)
(new Factory(g, settings)
with ModelFactoryImplicitSupport
with ModelFactoryTypeSupport
with DiagramFactory
with CommentFactory
with doc.model.TreeFactory
with MemberLookup)
}
def parse(src: String, dst: Inline): Boolean = {
factory.parseComment(src) match {
case Some(inline) =>
inline == dst
case _ =>
false
}
}
property("parse") = parse(
"/** One two three */",
Text("One two three")
)
property("parse") = parse(
"/** One `two` three */",
Chain(List(Text("One "), Monospace(Text("two")), Text(" three")))
)
property("parse") = parse(
"""
/** One two
* three */""",
Text("One two\nthree")
)
property("parse") = parse(
"""
/** One `two`
* three */""",
Chain(List(Text("One "), Monospace(Text("two")), Text("\n"), Text("three")))
)
property("parse") = parse(
"""
/** One `two`
* three */""",
Chain(List(Text("One "), Monospace(Text("two")), Text("\n"), Text(" three")))
)
property("parse") = parse(
"""
/** One
* `two` three */""",
Chain(List(Text("One"), Text("\n"), Monospace(Text("two")), Text(" three")))
)
property("Trac #4361 - ^...^") = parse(
"""
/**
* hello ^world^ */""",
Chain(List(Text("hello "), Superscript(Text("world"))))
)
property("Trac #4361 - single ^ symbol") = parse(
"""
/**
* <pre>
* hello ^world
* </pre>
*
*/""",
Chain(List(Text(""), Text("\n"),
HtmlTag("<pre>\nhello ^world\n</pre>")))
)
property("Trac #4366 - body") = {
val body = factory.createBody(
"""
/**
* <strong><code>foo</code> has been deprecated and will be removed in a future version. Please call <code>bar</code> instead.</strong>
*/
"""
)
body == Body(List(Paragraph(Chain(List(
Summary(Chain(List(HtmlTag("<strong><code>foo</code> has been deprecated and will be removed in a future version. Please call <code>bar</code> instead.</strong>"), Text("\n"), Text(""))))
)))))
}
property("Trac #4366 - summary") = {
val body = factory.createBody(
"""
/**
* <strong><code>foo</code> has been deprecated and will be removed in a future version. Please call <code>bar</code> instead.</strong>
*/
"""
)
body.summary == Some(Chain(List(HtmlTag("<strong><code>foo</code> has been deprecated and will be removed in a future version. Please call <code>bar</code> instead.</strong>"), Text("\n"), Text(""))))
}
property("Trac #4358 - body") = {
factory.createBody(
"""
/**
* Implicit conversion that invokes the <code>expect</code> method on the <code>EasyMock</code> companion object (<em>i.e.</em>, the
* static <code>expect</code> method in Java class <code>org.easymock.EasyMock</code>).
*/
"""
) match {
case Body(List(Paragraph(Chain(List(Summary(Chain(List(Chain(List(
Text("Implicit conversion that invokes the "),
HtmlTag("<code>expect</code>"),
Text(" method on the "),
HtmlTag("<code>EasyMock</code>"),
Text(" companion object ("),
HtmlTag("<em>i.e.</em>"),
Text(", the\nstatic "),
HtmlTag("<code>expect</code>"),
Text(" method in Java class "),
HtmlTag("<code>org.easymock.EasyMock</code>"),
Text(")")
)), Text(".")))), Text("\n")))))) =>
true
case other => {
println(other)
false
}
}
}
property("Empty parameter text should be empty") = {
// used to fail with
// body == Body(List(Paragraph(Chain(List(Summary(Text('\n')))))))
factory.getComment(
"""
/**
* @deprecated
*/
""").deprecated match {
case Some(Body(l)) if l.isEmpty => true
case other =>
println(other)
false
}
}
}
|
