com.seanshubin.detangler:detangler-parent

Analyzes dependency structure and cycles

License	Unlicense
GroupId	com.seanshubin.detangler
ArtifactId	detangler-parent
Last Version	0.9.4
Release Date	Dec 14, 2018
Type	pom
Description	com.seanshubin.detangler:detangler-parent Analyzes dependency structure and cycles
Project URL	https://github.com/SeanShubin/detangler
Source Code Management	https://github.com/SeanShubin/detangler

Download detangler-parent

Filename	Size
detangler-parent-0.9.4.pom	7 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.seanshubin.detangler/detangler-parent/ -->
<dependency>
    <groupId>com.seanshubin.detangler</groupId>
    <artifactId>detangler-parent</artifactId>
    <version>0.9.4</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.seanshubin.detangler/detangler-parent/
implementation 'com.seanshubin.detangler:detangler-parent:0.9.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.seanshubin.detangler/detangler-parent/
implementation ("com.seanshubin.detangler:detangler-parent:0.9.4")

Apache Buildr

'com.seanshubin.detangler:detangler-parent:pom:0.9.4'

Apache Ivy

<dependency org="com.seanshubin.detangler" name="detangler-parent" rev="0.9.4">
  <artifact name="detangler-parent" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.seanshubin.detangler', module='detangler-parent', version='0.9.4')
)

Scala SBT

libraryDependencies += "com.seanshubin.detangler" % "detangler-parent" % "0.9.4"

Leiningen

[com.seanshubin.detangler/detangler-parent "0.9.4"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.12.8

test (1)

Group / Artifact	Type	Version
org.scalatest : scalatest_2.12	jar	3.0.5

Project Modules

• analysis
• bytecode
• collection
• compare
• console
• contract
• contract-test
• data
• domain
• graphviz
• maven-plugin
• model
• report
• scanner
• timer
• zip

Detangler

Analyzes dependency structure and cycles

Levels

• there must be at least 1 level
• the last level is always the class level
• the second to last level is the package level
• the first x levels greater than 2 establish a hierarchy
• every class will be broken down into the same number of levels
  • this makes sensible graphs possible without losing information
  • placeholders will be created if necessary

3 level example

Suppose you had the following configuration

{
  level 3
  startsWith {
    include [[com seanshubin]]
    drop [[com seanshubin]]
  }
}

And the following (contrived) classes

com.seanshubin.detangler.analysis.Detangler
com.seanshubin.detangler.analysis.tree.DetanglerBackedByTree
com.seanshubin.detangler.Metrics
com.seanshubin.CollectionUtil

Here is how they would be broken down into levels

drop	top	package	class
com.seanshubin	detangler	analysis	Detangler
com.seanshubin	detangler	analysis.tree	DetanglerBackedByTree
com.seanshubin	detangler	root-of-detangler	Metrics
com.seanshubin	-root-	-root-	CollectionUtil

Configuration File

{
  reportDir console/target/detangled
  searchPaths [
    console/target/detangler.jar
  ]
  level 2
  startsWith {
    include [[com seanshubin detangler]]
    drop [[com seanshubin detangler]]
    exclude []
  }
  allowedInCycle console/detangler-allowed-in-cycle.txt
  canFailBuild true
}

Running from the command line

java -jar console/target/detangler.jar console/detangler.txt

Running from maven

In the file maven-sample/pom.xml

<plugin>
    <groupId>com.seanshubin.detangler</groupId>
    <artifactId>detangler-maven-plugin</artifactId>
    <version>0.9.4</version>
    <executions>
        <execution>
            <phase>verify</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <detanglerConfig>detangler.txt</detanglerConfig>
    </configuration>
</plugin>

At the console

mvn -f maven-sample/ detangler:report -DdetanglerConfig=detangler.txt

Versions

Version
0.9.4 Dec 14, 2018
0.9.3 Oct 10, 2018
0.9.2 Jan 10, 2018
0.9.1 Aug 16, 2017
0.9 Sep 15, 2016