DependencyMatchers

The dependency matchers trait provides a way to specify the dependencies that should be verified in your project and then to check that there's no unwanted dependency in the code.

It does so by:

specifying the dependencies as "layers" where a package name declared in one layer can only be dependent on a package name declared in a lower layer
using the scala compiler BuildManager class to recompile the files and get dependency analysis data

Usage:

layers( "package1", layer("package2", "package3", "package4"), layer("package6", "package7") ) must beRespected

Linear Supertypes

DependencyBeHaveMatchers, BeHaveMatchers, DependencyBaseMatchers, LayersAnalysis, ClassycleDependencyFinder, DependencyFinder, AnyRef, Any

Known Subclasses

Analysis

Type Members

case class Layer(names: Set[String], prefix: String = "", sourceDir: DirectoryPath = ..., targetDir: DirectoryPath = ..., included: Seq[String] = ..., excluded: Seq[String] = ...) extends Product with Serializable

The Layer class represent a list of packages.
case class Layers(layers: Seq[Layer]) extends Product with Serializable

This class represents an ordered set of layers, where each package on a given layer can only depend on packages defined in lower layers
class LayersDependenciesMatcher extends Matcher[Layers]

this matcher checks that dependencies are satisfied for a given Layers definition
class LayersResultMatcher extends AnyRef

Definition Classes
DependencyBeHaveMatchers

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def be: NeutralMatcher[Any]

Definition Classes
BeHaveMatchers
def beRespected: LayersDependenciesMatcher

matcher for Layers declarations
matcher for Layers declarations

Definition Classes
DependencyBaseMatchers
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] )
val fs: FilePathReader.type

Definition Classes
ClassycleDependencyFinder
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getPackageDependents(sourceDir: DirectoryPath, targetDir: DirectoryPath): (String) ⇒ Action[Seq[Dependency]]

returns
the classes depending on the classes of package, given its name

Definition Classes
ClassycleDependencyFinder → DependencyFinder
def hashCode(): Int

Definition Classes
AnyRef → Any
def have: NeutralMatcher[Any]

Definition Classes
BeHaveMatchers
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def layer(names: String*): Layer

returns
a new Layer object. If a prefix is defined, it will apply to each given name

Definition Classes
LayersAnalysis
def layers(ls: Layer*): Layers

returns
a new Layers object, composed of other layers. If a prefix is defined it will apply to each layer

Definition Classes
LayersAnalysis
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def not: NotMatcher[Any]

Definition Classes
BeHaveMatchers
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def respected: LayersDependenciesMatcher

Definition Classes
DependencyBeHaveMatchers
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
implicit def toLayer(s: String): Layer

this implicit definition allows to use a single string instead of a Layer object
this implicit definition allows to use a single string instead of a Layer object

Definition Classes
LayersAnalysis
implicit def toLayersResultMatcher(result: MatchResult[Layers]): LayersResultMatcher

Definition Classes
DependencyBeHaveMatchers
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( ... )

trait DependencyMatchers extends DependencyBaseMatchers with DependencyBeHaveMatchers

Type Members

case class Layer(names: Set[String], prefix: String = "", sourceDir: DirectoryPath = ..., targetDir: DirectoryPath = ..., included: Seq[String] = ..., excluded: Seq[String] = ...) extends Product with Serializable

case class Layers(layers: Seq[Layer]) extends Product with Serializable

class LayersDependenciesMatcher extends Matcher[Layers]

class LayersResultMatcher extends AnyRef

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def be: NeutralMatcher[Any]

def beRespected: LayersDependenciesMatcher

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val fs: FilePathReader.type

final def getClass(): Class[_]

def getPackageDependents(sourceDir: DirectoryPath, targetDir: DirectoryPath): (String) ⇒ Action[Seq[Dependency]]

def hashCode(): Int

def have: NeutralMatcher[Any]

final def isInstanceOf[T0]: Boolean

def layer(names: String*): Layer

def layers(ls: Layer*): Layers

final def ne(arg0: AnyRef): Boolean

def not: NotMatcher[Any]

final def notify(): Unit

final def notifyAll(): Unit

def respected: LayersDependenciesMatcher

final def synchronized[T0](arg0: ⇒ T0): T0

implicit def toLayer(s: String): Layer

implicit def toLayersResultMatcher(result: MatchResult[Layers]): LayersResultMatcher

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from DependencyBeHaveMatchers

Inherited from BeHaveMatchers

Inherited from DependencyBaseMatchers

Inherited from LayersAnalysis

Inherited from ClassycleDependencyFinder

Inherited from DependencyFinder

Inherited from AnyRef

Inherited from Any

Ungrouped