trait StreamlinedXmlEquality extends AnyRef
Trait providing an implicit Equality[T]
for subtypes
of scala.xml.NodeSeq
that before testing for equality, will normalize left and right sides
by removing empty XML text nodes and trimming non-empty text nodes.
Here's an example of some unnormalized XML:
<summer>
<day></day>
<night>
with lots of stars
</night>
</summer>
Prior to testing it for equality, the implicit Equality[T]
provided by this trait would transform
the above XML to:
<summer><day></day><night>with lots of stars</night></summer>
The goal of this trait is to provide an implicit Equality
for XML that makes it easier to write tests involving XML.
White space is significant in XML, and is taken into account by the default equality for XML, accessed
by invoking the ==
method on an XML NodeSeq
. Here's an example:
scala> val xmlElem = <summer><day></day><night>with lots of stars</night></summer> xmlElem: scala.xml.Elem = <summer><day></day><night>with lots of stars</night></summer> scala> import org.scalatest.Assertions._ import org.scalatest.Assertions._ scala> assert(xmlElem === <summer> | <day></day> | <night> | with lots of stars | </night> | </summer>) org.scalatest.exceptions.TestFailedException: <summer><day></day><night>with lots of stars</night></summer> did not equal <summer> <day></day> <night> with lots of stars </night> </summer> at org.scalatest.Assertions$class.newAssertionFailedException(Assertions.scala:500) at org.scalatest.Assertions$.newAssertionFailedException(Assertions.scala:1538) at org.scalatest.Assertions$AssertionsHelper.macroAssert(Assertions.scala:466) ... 53 elided
The above assertion fails because of whitespace differences in the XML.
When such whitespace differences are unimportant to the actual application, it can make it
easier to write readable test code if you can compare XML for equality without taking
into account empty text nodes, or leading and trailing whitespace in nonempty text nodes.
This trait provides an Equality[T]
instance that does just that:
scala> import org.scalatest.StreamlinedXmlEquality._ import org.scalatest.StreamlinedXmlEquality._ scala> assert(xmlElem === <summer> | <day></day> | <night> | with lots of stars | </night> | </summer>)
- Alphabetic
- By Inheritance
- StreamlinedXmlEquality
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
implicit
def
streamlinedXmlEquality[T <: NodeSeq]: Equality[T]
Provides an implicit
Equality[T]
instance for any subtype ofscala.xml.NodeSeq
that, prior for testing for equality, will normalize the XML by removing empty text nodes and trimming non-empty text nodes.Provides an implicit
Equality[T]
instance for any subtype ofscala.xml.NodeSeq
that, prior for testing for equality, will normalize the XML by removing empty text nodes and trimming non-empty text nodes.See the main documentation for this trait for more details and examples.
- returns
an
Equality[T]
instance that normalizes XML before testing for equality
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )