org.scalatest.StreamlinedXmlNormMethods.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalatest-app_3 Show documentation
scalatest-app
The newest version!
/*
 * Copyright 2001-2014 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

import scala.xml.{NodeSeq}
import org.scalactic.{NormMethods, Uniformity}

/**
 * Subtrait of NormMethods that provides
 * an implicit Uniformity[T] for subtypes of scala.xml.NodeSeq that enables
 * you to streamline XML by invoking .norm on it.
 *
 * 
 * Here's an example:
 * 
 *
 *  * scala> <good><day>sunshine</day></good> == <good>
 *      |   <day>
 *      |     sunshine
 *      |   </day>
 *      | </good>
 * res1: Boolean = false
 * 
 * scala> import org.scalactic._
 * import org.scalactic._
 * 
 * scala> import TripleEquals._
 * import TripleEquals._
 * 
 * scala> import org.scalatest.StreamlinedXmlNormMethods._
 * import org.scalatest.StreamlinedXmlNormMethods._
 *
 * scala> <good><day>sunshine</day></good> === <good>
 *      |   <day>
 *      |     sunshine
 *      |   </day>
 *      | </good>.norm
 * res2: Boolean = true
 * 
 */
trait StreamlinedXmlNormMethods extends StreamlinedXml with NormMethods {

  /**
   * Provides an implicit Uniformity[T]
   * instance for any subtype of scala.xml.NodeSeq that will normalize the XML by removing empty text nodes and trimming
   * non-empty text nodes.
   *
   * 
   * This Uniformity[T] enables normalization of XML by invoking the .norm
   * method on subtypes of scala.xml.NodeSeq.  See the main documentation for this trait for more
   * details and examples.
   * 
   *
   * @return a Uniformity[T] instance that normalizes XML for testing
   */
  implicit override def streamlined[T <: NodeSeq]: Uniformity[T] = super.streamlined[T]
}

/**
 * Companion object that facilitates the importing of StreamlinedXmlNormMethods members as 
 * an alternative to mixing it the trait. One use case is to import StreamlinedXmlNormMethods's implicit so you can use
 * it in the Scala interpreter.
 *
 * @author Bill Venners
 */
object StreamlinedXmlNormMethods extends StreamlinedXmlNormMethods