org.scalatest.matchers.dsl.IncludeWord.scala Maven / Gradle / Ivy

/*
 * 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.scalatest.matchers.dsl

import org.scalatest.matchers._
import org.scalactic._
import scala.util.matching.Regex
import org.scalatest.UnquotedString
import org.scalatest.Resources
import org.scalatest.matchers.MatchersHelper.includeRegexWithGroups

/**
 * This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of
 * the matchers DSL.
 *
 * @author Bill Venners
 */
final class IncludeWord {

  /**
   * This method enables the following syntax:
   *
   *    * "1.7" should (include ("1.7") and include ("1.8"))
   *                       ^
   * 
   */
  def apply(expectedSubstring: String): Matcher[String] =
    new Matcher[String] {
      def apply(left: String): MatchResult =
        MatchResult(
          left.indexOf(expectedSubstring) >= 0, 
          Resources.rawDidNotIncludeSubstring,
          Resources.rawIncludedSubstring,
          Vector(left, expectedSubstring)
        )
      override def toString: String = "include (" + Prettifier.default(expectedSubstring) + ")"
    }

  /**
   * This method enables the following syntax:
   *
   *    * val decimal = """(-)?(\d+)(\.\d*)?"""
   * "a1.7b" should (include regex (decimal) and include regex (decimal))
   *                         ^
   * 
   */
  def regex[T <: String](right: T): Matcher[T] = regex(right.r)
  
  /**
   * This method enables the following syntax:
   *
   *    * string should not { include regex ("a(b*)c" withGroup "bb") } 
   *                             ^
   * 
   */	
  def regex(regexWithGroups: RegexWithGroups) = 
    new Matcher[String] {
      def apply(left: String): MatchResult = 
        includeRegexWithGroups(left, regexWithGroups.regex, regexWithGroups.groups)
      override def toString: String = "include regex " + Prettifier.default(regexWithGroups)
    }

  /**
   * This method enables the following syntax:
   *
   *    * val decimalRegex = """(-)?(\d+)(\.\d*)?""".r
   * "a1.7" should (include regex (decimalRegex) and include regex (decimalRegex))
   *                        ^
   * 
   */
  def regex(expectedRegex: Regex): Matcher[String] =
    new Matcher[String] {
      def apply(left: String): MatchResult =
        MatchResult(
          expectedRegex.findFirstIn(left).isDefined,
          Resources.rawDidNotIncludeRegex,
          Resources.rawIncludedRegex,
          Vector(left, UnquotedString(expectedRegex.toString))
        )
      override def toString: String = "include regex \"" + Prettifier.default(expectedRegex) + "\""
    }
  
  /**
   * Overrides toString to return "include"
   */
  override def toString: String = "include"
}