Overloaded Unapply

This topic is related to previous posts on matching. I recommend reading some of them as well:

• Basic Matching
• Extractors 1
• Extracting Sequences
• Operator Style Extractors

Since an Extactor is just an object with an unapply method it logically follows that an Extractor can have an overloaded unapply method. In other words can have an unapply(String) and an unapply(Int); allowing matching Strings and Ints.

1. scala> object T{                                                         
2.      |  def unapply(v:String)= if(v== "s") Some("yay") else None
3.      |  def unapply(v:Int) = if(v==1) Some("hmmm") else None
4.      | }
5. defined module T
7. scala> 1 match { case T(x) => println(x) }
8. hmmm
10. scala> "s" match { case T(x) => println(x) }
11. yay
14. scala> object T{                                 
15.      | def unapplySeq(v:String) = if (v=="x") Some(List(1,2,3)) else None
16.      | def unapplySeq(v:Int) = if (v==1) Some(List("one","two")) else None
17.      | }
18. defined module T
20. scala>  "x"  match { case T(x,y,z) => println(x,y,z) }
21. (1,2,3)
23. scala>  1  match { case T(x,y) => println(x,y) }  
24. (one,two)

Defining Custom Control Structures

Scala has only a handful of built-in control structures: for, while, try-catch, if, etc... However it is quite simple to define custom control structures. There are several good examples in the Scala 2.8 library. For some examples look at the classes in the scala.util.control package.

For this topic, we will develop a simplified version of the Exception class. First a demonstration of the 2.8 version.

1. scala> import scala.util.control.Exception._
2. import scala.util.control.Exception._
4. scala> val numberFormat = catching(classOf[NumberFormatException])
5. numberFormat: util.control.Exception.Catch[Nothing] = Catch(java.lang.NumberFormatException)
7. scala> val result = numberFormat opt { "10".toInt }               
8. result: Option[Int] = Some(10)
10. scala> result match {
11.      | case Some(n) => // do something
12.      | case None => // handle this situation
13.      |

A question that often arises when presented with the Exception control flow is why not use try-catch. There are two main reasons in my opinion.

First, people coming from certain functional style languages find that form more comfortable (so I have heard.) So in this case it is a style issue.

The other reason (and the one more pertinent to Java developers), is that it provides a nice way to handle common exceptions. Why do I say nice? First it declares when exceptions are handled before the code and that provides more context while reading the code. In addition, if you create the Catch object and assign it to a nicely named variable then it is clear what the intent is. For example there may be several reasons to catch a runtime exception and they should be handled differently. A few well-named variables can really assist in readability. A final point is that several of these variables can be defined in on object and shared throughout a project adding some consistency to a project.

Back to the topic at hand.

We will develop a simplified version: a catching method that will return Some(...) if no exception occurs or None if one of the declared exceptions has occurred or throw exception if the exception is not one we declare as handling. Now this is not what I would necessarily call a custom control flow because it does not offer a choice of execution flows. To do that I would add more components like int the Exceptions object. However, this is a good demonstration of the parts required to create a custom control struction. The key is the => in def method(arg: => T) This is a special type construct which means that a no param function is passed in but is not executed until called within the method. A few comparisons:

1. scala> def method(arg: =>Int) = println(arg)
2. method: (arg: => Int)Unit
4. scala> def method2(arg: =>Int) = println("not calling arg")
5. method2: (arg: => Int)Unit
7. scala> var x = 1
8. x: Int = 1
10. // when method is called x is incremented because method calls the argument
11. scala> method { x += 1; x }                                
12. 2
14. scala> println(x)          
15. 2
17. // when method2 is called x is not incremented because 
18. // the argument is not called/referenced
19. scala> method2 { x += 1; x }
20. not calling arg
22. scala> println(x)           
23. 2
25. // arg is referenced 2 times in method three so x is incremented 2 times
26. scala> def method3(arg: => Int) = println("first call="+arg+" second call="+arg)
27. method3: (arg: => Int)Unit
29. scala> method3 { x += 1; x }                                                   
30. first call=3 second call=4
32. // Now demonstrate the standard way of defining arguments
33. // the value passed is calculated before calling the method
34. // so is at most called once
35. scala> def byValue(arg: Int) = println(arg)
36. byValue: (arg: Int)Unit
38. scala> def byValue2(arg: Int) = println("not calling arg")
39. byValue2: (arg: Int)Unit
41. scala> def byValue3(arg: Int) = println("first call="+arg+" second call="+arg)
42. byValue3: (arg: Int)Unit
44. scala> byValue{ x += 1; x }
45. 5
47. scala> byValue2{ x += 1; x }
48. not calling arg
50. scala> println(x)
51. 6
53. scala> byValue3{ x += 1; x }
54. first call=7 second call=7
56. // And finally show the normal way to pass in a function. 
57. // This has the benefit of allowing the reader of the code to
58. // realize that the argument is a function
59. // but is not a nice syntax for control flow
60. scala> def stdFunc(arg: ()=>Int) = println(arg())
61. stdFunc: (arg: () => Int)Unit
63. scala> def stdFunc2(arg: ()=>Int) = println("not calling arg")
64. stdFunc2: (arg: () => Int)Unit
66. scdef stdFunc3(arg: ()=>Int) = println("first call="+arg()+" second call="+arg()) 
67. stdFunc3: (arg: () => Int)Unit
69. scala> stdFunc {() => x += 1; x }  
70. 8
72. scala> stdFunc2 {() => x += 1; x }
73. not calling arg
75. scala> println(x)
76. 8
78. scala> stdFunc3 {() => x += 1; x }
79. first call=9 second call=10

Now for the complete catching example:

1. scala> def catching[T](exceptions: Class[_]*)(body: => T) = {
2.      | try {                                                 
3.      | Some (body)                                           
4.      | } catch {
5.      | case e if (exceptions contains e.getClass) => None
6.      | }                
7.      | }
8. catching: [T](exceptions: Class[_]*)(body: => T)Option[T]
10. scala> val runtime = catching[Number](classOf[NullPointerException], classOf[NumberFormatException])_
11. runtime: (=> java.lang.Number) => Option[java.lang.Number] = < function1>
13. scala> runtime { "".toInt }                                                                          
14. res2: Option[java.lang.Number] = None
16. scala> runtime { "10".toInt }
17. res3: Option[java.lang.Number] = Some(10)
19. scala> runtime { throw new NullPointerException }
20. res6: Option[java.lang.Number] = None
22. scala> runtime { throw new RuntimeException }
23. java.lang.RuntimeException
24.         at $anonfun$1.apply(< console>:10)
25.         at $anonfun$1.apply(< console>:10)
26.         at .catching(< console>:9)
27.         at $anonfun$1.apply(< console>:8)
28.         at $anonfun$1.apply(< console>:8)
29.         at .< init>(< console>:10)
30.         at .< clinit>(< console>)
31.         at RequestResult$.< init>(< console>:4)
32.         at RequestResult$.< clinit>(< console>)
33.         at RequestResult$result(< console>)
34.         ...

Good Scala Style

This topic is a bit of a departure from the normal but is very important. The goal of these posts has not been(necessarily) to introduce good coding style, instead to introduce the different tools at your disposal. There have been some good styles to follow and some bad ones (hopefully more good than bad.) Today is mainly a link to a project and document that is documenting a style guide for Scala programming. I highly recommend taking a look at it and a big thanks to Daniel Spiewak for spearheading this project, although I think it has now grown beyond just Daniel so thanks to the other contributors as well.

Github project: http://github.com/davetron5000/scala-style
HTML - http://davetron5000.github.com/scala-style
PDF - http://davetron5000.github.com/scala-style/ScalaStyleGuide.pdf

Thanks again for a wonderful resource.

Varargs

Both Java and Scala have varargs. In Scala the syntax for a varargs argument is def method (param:String*). In the off-chance you are not aware of what varargs are; they allow an arbitrary number of values to be passed to the method. Some restrictions on when varargs can be used are:

• The vararg parameter must be the last parameter in the list
• There can not be default values for any parameters in the method containing the varargs (Scala 2.8+)

From the caller's point of view; varargs can be called as follows: method("p1", "p2", "p3") where the number of values is not limited. However, the () must be used.

In Java (if I remember right) only arrays can be passed in place of varargs:

1. class C {
2.   public static void main(String... args) {
3.     System.out.println(args.length)
4.   }
5. }
6. String[] args = new String[]{"arg1", "arg2"}
7. C.main (args)

However Scala is more general and allows any sequence to be passed to varargs, with a caveat. When a sequence is passed to varargs a hint must be provided to indicate that you are intending to have the sequence be expanded to be the varargs.

1. def method (args:Int*) = println(args)
2. val list = List(1,2,3)
3. method (list:_*)  // note the use of _*

Examples:

1. scala> def method(varargs:Int*)(more:String*) = println(varargs,more)
2. method: (Int*)(String*)Unit
4. scala> method(1,2,3,4)("one")
5. (Array(1, 2, 3, 4),Array(one))
7. scala> method(1,2,3,4)       
8. < console>:6: error: missing arguments for method method in object $iw;
9. follow this method with '_' if you want to treat it as a partially applied function
10.        method(1,2,3,4)
11.        ^
13. scala> method(1,2,3,4)()
14. (Array(1, 2, 3, 4),Array())
16. scala> method()("one")  
17. (Array(),Array(one))
19. scala> method("one")  
20. < console>:6: error: type mismatch;
21.  found   : java.lang.String("one")
22.  required: Int
23.        method("one")
24.               ^
26. scala> method()()     
27. (Array(),Array())
29. scala> val method2 = method(1,2,3)_  
30. method2: (String*) => Unit = < function>
32. scala> val paramList = List("hi","ho")
33. paramList: List[java.lang.String] = List(hi, ho)
35. scala> method2(paramList)
36. < console>:8: error: type mismatch;
37.  found   : List[java.lang.String]
38.  required: String
39.        method2(paramList)
40.                ^
42. scala> method2(paramList:_*)
43. (Array(1, 2, 3),List(hi, ho))
45. scala> val range = (1 to 5) map {_.toString} 
46. range: RandomAccessSeq.Projection[java.lang.String] = RangeM(1, 2, 3, 4, 5)
48. scala> method2(range:_*)                     
49. (Array(1, 2, 3),RangeM(1, 2, 3, 4, 5))

Equals, Tuples and Case-classes

This is mostly a quick tip (or opportunity for refactoring).

Most of Scala's built in classes implement a useful equals and hashcode. The very commonly used case-classes and Tuple classes are the examples that spring to mind. So this enables the following options:

1. // Assume Box is out of your control and you cannot refactor it into a case class
2. scala> class Box(val name:String, val minx:Int, val miny:Int, val maxx:Int, val maxy:Int)
3. defined class Box
5. scala> val box = new Box("mybox", 0, 0, 10, 10)
6. box: Box = Box@568bf3ec
8. // before:
9. scala> box.minx == 0 && box.miny == 0 && box.maxx == 10 && box.maxy == 10      
10. res3: Boolean = true
12. // after
13. scala> import box._
14. import box._
16. scala> (minx,miny,maxx,maxy) == (0,0,10,10)
17. res5: Boolean = true
19. // another box definition:
20. scala> case class Box2 (name:String, ul:(Int,Int), lr:(Int,Int)) 
21. defined class Box2
23. // case classes have nice equals for comparison
24. scala> box2 == Box2("a nicer box", (0,0), (10,10))
25. res6: Boolean = true
27. // but what if you don't want to compare names
28. scala> import box2._
29. import box2._
31. scala> (ul,lr) == ((0,0),(10,10))
32. res7: Boolean = true

Type aliasing and implicit conversions in harmony

This topic combines advanced two topics. types and implicit methods. This topic is not really intended to be instructional as much as a illustration of the cool stuff you can do with the language. As always becareful not to cut yourself :-)

In keeping with the uniform principle of Scala, types can defined as variables. This is useful for several reasons but this topic covers a cool/fun effect of having types be declared like variables. Type Aliasing. In the example below an alias | is created for the Either class. This allows the | to be used in place of Either.

1. // Start of example 1.  creating the type alias
2. // define the | type
3. scala> type |[A,B] = Either[A,B]
4. defined type alias $bar
6. // If a Type has 2 parameters it can be used in operator form
7. scala> Array[Int | Long](Left(5),Right(12L))
8. res0: Array[|[Int,Long]] = Array(Left(5), Right(12))
10. // start of example 2.  Simplify creation of an Array (or other collection) of either
11. scala> implicit def makeLeft[A,B](a:A):Either[A,B] = Left(a)
12. makeLeft: [A,B](a: A)Either[A,B]
14. scala> implicit def makeRight[A,B](b:B):Either[A,B] = Right(b) 
15. makeRight: [A,B](b: B)Either[A,B]
17. // Since there are implicits to convert to Right and Left the values in the Array will be wrapped
18. // automatically.  Makes the syntax MUCH cleaner and easier to read.
19. scala> Array[Int|String](5,"Wurst",123,2,6)
20. res1: Array[|[Int,String]] = Array(Left(5), Right(Wurst), Left(123), Left(2), Left(6))

Either

The Scala Either class is similar in function as Option but it represents a choice. For example a method can return Either an Int or an Exception. Usage example:

1. // If string can be converted to an Int then return Right[Int] otherwise
2. // return a Left[String] with the error message
3. // by convention the error state will always be the Left
4. scala> def toInt(string:String):Either[String,Int] = {
5.      | try { Right(string.toInt) }
6.      | catch { case e => Left("Error: "+e.getMessage) }
7.      | }
8. toInt: (string: String)Either[String,Int]
10. scala> toInt("1")
11. res0: Either[String,Int] = Right(1)
13. scala> toInt("booger")
14. res1: Either[String,Int] = Left(Error: For input string: "booger")

By convention if one return value is a error state and the other the expected state then Right will contain the expected state and Left will contain the error state.

1. scala> def toInt(string:String):Either[String,Int] = {
2.      | try { Right(string.toInt) }
3.      | catch { case e => Left("Error: "+e.getMessage) }
4.      | }
5. toInt: (string: String)Either[String,Int]
7. scala> toInt("1")
8. res0: Either[String,Int] = Right(1)
10. scala> toInt("booger")
11. res1: Either[String,Int] = Left(Error: For input string: "booger")
13. // you can test if the value is a left or right value quite easily
14. scala> res0.isLeft
15. res2: Boolean = false
17. scala> res1.isRight
18. res3: Boolean = false
20. scala> res0.isRight
21. res4: Boolean = true
23. scala> res1.isLeft 
24. res5: Boolean = true
26. // or matching can be used
27. scala> res0 match {                                   
28.      | case Left(l) => println("it is a left")        
29.      | case Right(r) => println("it is a right")      
30.      | }
31. it is a right
33. scala> res1 match {                             
34.      | case Left(l) => println("it is a left")  
35.      | case Right(r) => println("it is a right")
36.      | }
37. it is a left
40. // Perhaps cleaner than matching even is being able to pass 
41. // functions to the fold method:
42. // define one function for each side of the either
44. // first the function to handle the left side case
45. scala> def leftFunc(errMsg:String) = println("there has been an error")             
46. leftFunc: (errMsg: String)Unit
48. // next the function the handle the right side case
49. scala> def rightFunc(i:Int) = println(i+" was calculated")              
50. rightFunc: (i: Int)Unit
52. // then you can pass the two functions to the fold method
53. // and the correct one will be invoked
54. scala> res0 fold (leftFunc _, rightFunc _)
55. 1 was calculated
57. scala> res1 fold (leftFunc _, rightFunc _)
58. there has been an error

Options

Scala is forced to have a "null" value because it interoperates with Java. However unlike Java APIs the recommended way to hand cases where there may or may not be a value (IE a return value) is to return an Option object. Compare the Scala and Java idioms for handling a possible null (or None) return value:

Note: The Option class have been updated in Scala 2.8 so I am going to use some of the scala 2.8 methods. Most of the examples will work with Scala 2.7 but not all; the principal is the same for 2.7 and 2.8.

Java:

1. /**
2.  * Returns the annotation with the given name or null if there is no annotation
3.  * on the objects class with the given name.
4.  */
5. public static < A extends java.lang.annotation.Annotation> Annotation annotation(Object obj, Class< A> annotationCls) {
6.   return obj.getClass().getAnnotation(annotationCls)
7. }

Scala:

1. import java.lang.annotation.Annotation
2. /**
3.  * Returns the annotation with the given name.
4.  */
5. def annotation[A <: Annotation](obj:Object, annotationCls:Class[A]) : Option[Annotation] = {
6.    Option (obj.getClass.getAnnotation (annotationCls))
7. }

In the Scala version it is obvious the use of the API (and the compiler) that there are two types of legal return types. Some or None and the compiler will force you to deal with this fact. Where in Java it is very easy to forget to check for null.

Also not that it is very easy to Wrap a null in an Option using the Option objects apply method. If the parameter is a null then None is return otherwise Some is returned.

The other important aspect is how to deal with the Option object and obtain the data from the object if it is present. This is both simple and non-simple. There are a large number of possible useage patterns that can be applied to it.

Examples:

1. scala> import java.lang.annotation.Annotation
2. import java.lang.annotation.Annotation
4. kscala> def annotation[A <: Annotation](obj:Object, annotationCls:Class[A]) : Option[Annotation] = { 
5.      |    Option (obj.getClass.getAnnotation (annotationCls))                                      
6.      | }
7. annotation: [A <: java.lang.annotation.Annotation](obj: java.lang.Object,annotationCls: Class[A])Option[java.lang.annotation.Annotation]
9. // strings do not have the Documented annotation so None is returned
10. scala> annotation("x", classOf[java.lang.annotation.Documented])                                   
11. res0: Option[java.lang.annotation.Annotation] = None
13. // None is not defined
14. scala> res0.isDefined
15. res1: Boolean = false
17. // None IS empty 
18. scala> res0.isEmpty
19. res26: Boolean = true
21. // We need a some example so LineNumberInputStream has Deprecated annotation
22. // we will use that in order to 
23. scala> val in = new LineNumberInputStream(new ByteArrayInputStream("hello".getBytes))
24. in: java.io.LineNumberInputStream = java.io.LineNumberInputStream@8ca9a2d
26. scala> annotation(in, classOf[Deprecated])                                           
27. res2: Option[java.lang.annotation.Annotation] = Some(@java.lang.Deprecated())
29. // Some(...) is always defined even if it contains null
30. scala> res2.isDefined
31. res3: Boolean = true
33. scala> val nullSome = Some(null)
34. nullSome: Some[Null] = Some(null)
36. scala> nullSome.isDefined
37. res28: Boolean = true
39. // Some is never empty
40. scala> res2.isEmpty
41. res4: Boolean = false
43. // You can also test particular values as follows
44. scala> if(res0 == None) println("its ok to use")
45. its ok to use
47. scala> if (res2.map {a => "found"} == Some("found")) println ("it is deprecated dont use!")
48. it is deprecated dont use!
50. scala> res0 match {                                                       
51.      | case None => println("its ok to use")                              
52.      | case Some(x:Deprecated) => println ("it is deprecated dont use!") 
53.      | }
54. its ok to use
56. scala> res2 match {                                                      
57.      | case None => println("its ok to use")                             
58.      | case Some(x:Deprecated) => println ("it is deprecated dont use!")
59.      | }
60. it is deprecated dont use!
62. scala> if(Some("hi") == Some("hi")) println("a match")    
63. a match
65. scala> if(Some("hi") == Some("ho")) println("a match")
68. // After you have tested you can use get to obtain the value
69. // but becareful, you will get an exception if you forget to test.
70. scala> res0.get
71. java.util.NoSuchElementException: None.get
72.                           at scala.None$.get(Option.scala:169)
73.                           at scala.None$.get(Option.scala:167)
74.                           at .< init>(< console>:12)
75.                           at .< clinit>(< console>)
76.                           [snip]
78. scala> res2.get
79. res10: java.lang.annotation.Annotation = @java.lang.Deprecated()
81. // a potentially better way of optaining the value is to provide a default if 
82. // the value does not exists
83. scala> res2.getOrElse(classOf[java.lang.annotation.Documented])
84. res13: java.lang.Object = @java.lang.Deprecated()
86. scala> res0.getOrElse(classOf[java.lang.annotation.Documented])
87. res14: java.lang.Object = interface java.lang.annotation.Documented
89. // A Option is a "monad" (dont worry too much about the term if 
90. // you dont know it) a very (VERY) simplified meaning of that is that 
91. // option behaves a bit like a collection of size 1 or 0
92. // you can use similar methods on an Option as a collection.  
93. // So exists tests each element in the Option to see if it matches 
94. // the function passed in as the parameter
96. // res2 has an object that is an instanceOf Annotation 
97. scala> res2.exists {_.isInstanceOf[Annotation]}  
98. res7: Boolean = true
100. // None always returns false to exists
101. scala> res0.exists {_.isInstanceOf[Annotation]}
102. res8: Boolean = false
104. scala> res2.exists {_.toString == "hi"}
105. res29: Boolean = false
107. // Similarly you can use the filter method that is present in all collections
108. scala> res2.filter {_.toString == "hi"}    
109. res30: Option[java.lang.annotation.Annotation] = None
111. scala> res2.filter {_.isInstanceOf[Annotation]}
112. res32: Option[java.lang.annotation.Annotation] = Some(@java.lang.Deprecated())
114. // apart from just filtering you can convert the type contained 
115. // in the Option by using map to map from one type of Option to
116. // another type of Option in this examples we map from 
117. // Option[Annotation] to Option[String]
118. scala> res0.map {_.toString}.getOrElse("does not exist")                        
119. res15: java.lang.String = does not exist
121. scala> res2.map {_.toString}.getOrElse("does not exist")
122. res16: java.lang.String = @java.lang.Deprecated()
124. // Another very handy and safe way to access the value is to use foreach
125. // this will call the function with the parameter from the Option if
126. // the Option is Some but a noop will occur if the Option is None.
127. scala> res2.foreach { println _ }
128. @java.lang.Deprecated()
130. scala> res0.foreach { println _ }
132. // orElse is simply a method to ensure that the Option is a Some
133. scala> res0.orElse(Some(classOf[java.lang.annotation.Documented]))
134. res22: Option[java.lang.Object] = Some(interface java.lang.annotation.Documented)
136. scala> res2.orElse(Some(classOf[java.lang.annotation.Documented]))
137. res23: Option[java.lang.Object] = Some(@java.lang.Deprecated())

Manifests

Added in Scala 2.7 as an experimental feature is the manifest class it is a handy class allowing for very limited type reification. Take the following example:
def inspect[T](l:List[T])
If you want to know they type of T in Java you are out of luck because that type information is gone. However, Scala offers help through manifests.

1. def inspect[T](l:List[T])(implicit manifest : scala.reflect.Manifest[T]) = println(manifest.toString)

This code snippet will print out the string representation of type T.

More Examples:

1. scala> def inspect[T](l:List[T])(implicit manifest : scala.reflect.Manifest[T]) = println(manifest.toString)
2. inspect: [T](List[T])(implicit scala.reflect.Manifest[T])Unit
4. scala> inspect(List(1,2,3,4))
5. int
7. scala> inspect(List(List(1,2),List(3,4)))
8. scala.List[int]
10. scala> inspect(List(List(List(1),List(2)),List(List(3),List(4))))
11. scala.List[scala.List[int]]
13. scala> val l:List[Iterable[Int]] = List(List(1,2))  
14. l: List[Iterable[Int]] = List(List(1, 2))
16. scala> inspect(l)                                                                                           
17. scala.collection.Iterable[Int]
19. scala> class MV[T](val v:T)(implicit m:scala.reflect.Manifest[T]) { println(m.toString) }
20. defined class MV
22. scala> new MV(1)
23. Int
24. res1: MV[Int] = MV@180e6899
26. scala> class MV2[T](val v:T)(implicit m:scala.reflect.Manifest[T]) {                     
27.      | def isA[A](implicit testManifest:scala.reflect.Manifest[A]) = m.toString == testManifest.toString
28.      | }
29. defined class MV2
31. scala> val x = new MV2(19)
32. x: MV2[Int] = MV2@41ff8506
34. scala> x.isA[String]
35. res2: Boolean = false
37. scala> x.isA[Int]   
38. res3: Boolean = true
40. scala> def isA[A](o:Object)(implicit m:Manifest[A]) = {
41.      | val `class` = Class.forName(m.toString)         
42.      | `class`.isAssignableFrom(o.getClass)            
43.      | }
44. isA: [A](o: java.lang.Object)(implicit m: scala.reflect.Manifest[A])Boolean
46. scala> isA[java.lang.Integer](java.lang.Integer.valueOf(19))
47. res6: Boolean = true

XML matching

The Scala XML support includes the ability to match on XML elements. Here are several examples. One of the most important parts to remember is to not miss the '{' and '}'.

1. scala> <document>
2.      |  <child1/>
3.      |  <child2/>
4.      | </document>
5. res0: scala.xml.Elem =
6. <document>
7.         <child1></child1>
8.         <child2></child2>
9.        </document>
11. scala> res0 match {
12.        // match the document tag
13.        // the {_*} is critical
14.      | case <document>{_*}</document> => println("found document element")
15.      | case _ => println("Found another element")
16.      | }
17. found document element
19. scala> res0 match {
20.        // assign the document element to e
21.      | case e @ <document>{_*}</document> => println(e)
22.      | case _ => println("Found another element")
23.      | }
24. <document>
25.         <child1></child1>
26.         <child2></child2>
27.        </document>
29. scala> res0 match {
30.        // assign the children of document to children
31.        // notice that there are Text elements that are part of children
32.      | case <document>{children @ _*}</document> => println(children)
33.      | case _ => println("Found another element")
34.      | }
35. ArrayBuffer(
36.         , <child1></child1>,
37.         , <child2></child2>,
38.        )
40. // the '\' is xpath like but only returns elements and attributes
41. // in this case the \ "_" returns all element children of res0.  It
42. // will not return the Text elements.
43. scala> res0 \ "_" foreach {
44.      | case <child1>{_*}</child1> => println("child1 found")
45.      | case <child2>{_*}</child2> => println("child2 found")
46.      | case e => println("found another element")
47.      | }
48. child1 found
49. child2 found
51. // another example of how \ does not return any text elements.  This returns
52. // no elements
53. scala> <doc>Hello</doc> \ "_" foreach { case scala.xml.Text(t) => println("a text element found: "+t) }
55. // the .child returns all children of an Elem
56. scala> <doc>Hello</doc>.child foreach { case scala.xml.Text(t) => println("a text element found: "+t) }
57. a text element found: Hello
59. // This example throws a match error because there are whitespace text elements
60. // that cause the match to fail.
61. scala> res0 match {                                                                                    
62.      | case <document><child1/><child2/></document> => println("found the fragment")
63.      | }
64. scala.MatchError: <document>
65.         <child1></child1>
66.         <child2></child2>
67.        </document>
68.        at .< init>(< console>:6)
69.        at .< clinit>(< console>)
70.        at RequestResult$.< init>(< console>:3)
71.        at RequestResult$.< clinit>(< console>)
72.        at RequestResult$result(< console>)
73.        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
74.        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMetho...
76. // The trim method removes the whitespace nodes so now the 
77. // match will work
78. scala> scala.xml.Utility.trim(res0) match {                                                            
79.      | case <document><child1/><child2/></document> => println("found the fragment")
80.      | }
81. found the fragment
83. // you can select part of the tree using matching
84. // child2 is assigned to 3 in this example.
85. scala> scala.xml.Utility.trim(res0) match {                                           
86.      | case <document><child1/>{e @ _*}</document> => println("found the fragment:"+e)
87.      | }
88. found the fragment:RandomAccessSeq(<child2></child2>)

ScalaTest BDD testing DSL

This is the first of three topics exploring some of the testing tools that you can use with Scala. They all integrate with JUnit and can be used with maven and ant.

The first example is ScalaTest. ScalaTest provides many different usage patterns but the one I will show today is a Behaviour Driven Design test. It provides a DSL for declaring a test that is nearly english in syntax and if done correctly can be given to a non technical person to review. The ScalaTest BDD test style was inspired by the work done on Specs by Eric Torreborre. I will demonstrate that library in the next topic.

I want to reiterate that ScalaTest permits several different styles of test writing. NUnit, JUnit and BDD are the main styles. So anyone that is used to NUnit or JUnit should have no problem using ScalaTest but if you like the look of the BDD test specifications then you can migrate and slowly become accustomed to that style.

If you want to integrate with JUnit one easy way to add the @RunWith annotation for the class. See JUnitRunner for details:

1. import org.scalatest.junit.JUnitRunner
2. import org.junit.runner.RunWith
4. @RunWith(classOf[JUnitRunner])
5. class StackSpec extends WordSpec {
6. ...
7. }

Instructions to run example:

1. Download ScalaTest: http://www.scalatest.org/download
2. Extract archive. For example to /tmp/
3. Run scala with the ScalaTest jar on classpath: scala -classpath /tmp/scalatest-1.0/scalatest-1.0.jar
4. copy in code

This example is directly taken from the ScalaTest documentation. It tests a Stack implementation.

1. scala>  import org.scalatest.WordSpec
2. import org.scalatest.WordSpec
4. scala>  import scala.collection.mutable.Stack
5. import scala.collection.mutable.Stack
7. scala> 
9. scala>  class StackSpec extends WordSpec {
10.      | 
11.      |    "A Stack" should {
12.      | 
13.      |      "pop values in last-in-first-out order" in {
14.      |        val stack = new Stack[Int]
15.      |        stack.push(1)
16.      |        stack.push(2)
17.      |        assert(stack.pop() === 2)
18.      |        assert(stack.pop() === 1)
19.      |      }
20.      | 
21.      |      "throw NoSuchElementException if an empty stack is popped" in {
22.      |        val emptyStack = new Stack[String]
23.      |        intercept[NoSuchElementException] {
24.      |          emptyStack.pop()
25.      |        }
26.      |      }
27.      |    }
28.      |  }
29. defined class StackSpec
31. scala> new StackSpec().execute()
32. A Stack 
33. - should pop values in last-in-first-out order
34. - should throw NoSuchElementException if an empty stack is popped

Import Instance Properties

A truly fantastic aspect of Scala is the uniform principle that Scala attempts to adhere to. In other words Scala tries to not make any rules that only apply to a single case when it can be applied generally.

One example is matching you can see several uses of matching in the following topics:

• Assignments
• Assignment and Parameter Objects

But matching it applies to today's topic as well. This topic covers a cool trick that helps assist with parameter objects and complex return types.

This topic is another take on Assignment and Parameter Objects. There are cases when a method has a large number of parameters and the API can be cleaned up by introducing a parameter object. Or perhaps an object with several public proprties are passed to a method.

1. scala> case class Params(p1:Int, p2:Int, p3:Int)
2. defined class Params
4. scala>  def method(params:Params) = {
5.      |   println(params.p1, params.p2, params.p3)
6.      | }
7. method: (Params)Unit
9. scala> method(Params(1,2,3))
10. (1,2,3)
11. }

The symbol 'params' introduces noise into the code. The noise can be reduced further by assigned the properties of the parameter object to local variables:

1. scala>  case class Params(p1:Int, p2:Int, p3:Int)
2. defined class Params
4. scala> 
6. scala>  def method(params:Params) = {
7.      |   val Params(p1,p2,p3) = params
8.      |   println(p1,p2,p3)
9.      | }
10. method: (Params)Unit
12. scala> method(Params(1,2,3))
13. (1,2,3)
14. }

But we can do better remember that we can import methods and properties from an object:

1. scala> object Obj {
2.      |  val prop = 10
3.      | }
4. defined module Obj
6. scala> import Obj._
7. import Obj._
9. scala> println(prop)
10. 10

Since all instance are objects it is possible to import fields and methods from instances as well:

1. scala>  case class Params(p1:Int, p2:Int, p3:Int)
2. defined class Params
4. scala> 
6. scala>  def method(params:Params) = {
7.      |   import params._
8.      |   println(p1, p2, p3)
9.      | }
10. method: (Params)Unit
11. }

The same technique is extremely useful when a method needs to return multiple values:

1. scala>  def method() = {
2.      |   (1,2,3)
3.      | }
4. method: ()(Int, Int, Int)
6. scala> val retVal = method()
7. retVal: (Int, Int, Int) = (1,2,3)
8. /*
9.  retVal is a tuple so we can import the tuple
10.  properties.  Becareful to not do this multiple times in
11.  the same scope
12. */
13. scala> import retVal._
14. import retVal._
16. scala> println(_1,_2,_3)
17. (1,2,3)
19. scala> def method2={
20.        // Notice case class declaration can be contained in method
21.      | case class Return(v1:Int,v2:Int)
22.      | Return(6,7)
23.      | }
24. method2: java.lang.Object with ScalaObject with Product{def v1: Int; def v2: Int}
26. scala> val r = method2
27. r: java.lang.Object with ScalaObject with Product{def v1: Int; def v2: Int} = Return(6,7)
29. scala> import r._
30. import r._
32. scala> println(v1,v2)
33. (6,7)
34. }