/
NormMethods.scala
82 lines (75 loc) · 2.7 KB
/
NormMethods.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
/*
* 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.scalactic
/**
* Provides an implicit conversion that allows <code>norm</code> to be invoked on any value of type
* <code>T</code> for which an implicit <code>Normalization[T]</code> exists.
*
* <p>
* Here's an example:
* </p>
*
* <pre class="stREPL">
* scala> import org.scalactic._
* import org.scalactic._
*
* scala> import StringNormalizations._
* import StringNormalizations._
*
* scala> implicit val stringNormalization = lowerCased and trimmed
* stringNormalization: org.scalactic.Uniformity[String] = org.scalactic.Uniformity$$anon$1@19ba67ec
*
* scala> import NormMethods._
* import NormMethods._
*
* scala> val s = " There "
* s: String = " There "
*
* scala> "Hey " + s + "!"
* res5: String = Hey There !
*
* scala> "Hey " + s.norm + "!"
* res6: String = Hey there!
* </pre>
*/
trait NormMethods {
/**
* Class containing a <code>norm</code> method that normalizes the given object <code>o</code> of type <code>T</code>
* via the implicitly passed <code>Normalization[T]</code>.
*/
final class Normalizer[T](o: T)(implicit normalization: Normalization[T]) {
/**
* Normalizes the object <code>o</code> of type <code>T</code> via the implicitly passed <code>Normalization[T]</code> passed
* to the constructor of this <code>Normalizer</code>.
*
* @return a normalized form of <code>o</code>
*/
def norm: T = normalization.normalized(o)
}
import scala.language.implicitConversions
/**
* Implicit conversion that adds a <code>norm</code> method to a value of any type <code>T</code> for which
* an implicit <code>Normalization[T]</code> exists.
*
* @param o the object to convert
* @return a <a href="Normalizer.html"><code>Normalizer</code></a> that enables a <code>norm</code> method to be invoked on the passed object
*/
implicit def convertToNormalizer[T](o: T)(implicit normalization: Normalization[T]): Normalizer[T] = new Normalizer[T](o)
}
/**
* Companion object for <code>NormMethods</code> enabling its members to be imported as an alternative to mixing them in.
*/
object NormMethods extends NormMethods