jQAssistant 1.2.0 released

The year 2017 is still fresh and we’d like to celebrate it with the release of jQAssistant 1.2.0! It comes with two main changes:

1. New Maven Coordinates

The project has been restructured, i.e. it is now a collection of several sub-projects. The main parts are:

• Framework
• Plugins
• Maven plugin
• Command line tool

The idea behind is to allow faster release cycles to deliver enhancements or bugfixes more quickly, especially for plugins. From a user’s perspective the following changes are required to upgrade from jQAssistant Maven plugin 1.1.x to 1.2.0:

• The groupId of the Maven plugin must be changed from „com.buschmais.jqassistant.scm“ to „com.buschmais.jqassistant“
• All plugins maintained by the jQAssistant project itself are now included as dependency of the Maven plugin, i.e. explicit plugin declarations should be removed

Here is an example for upgrading from jQAssistant 1.1.4…

<plugin>
	<groupId>com.buschmais.jqassistant.scm</groupId> <!-- change to "com.buschmais.jqassistant" -->
	<artifactId>jqassistant-maven-plugin</artifactId>
	<version>1.1.4</version>
	<dependencies>
		<dependency>
			<!-- should be removed -->
			<groupId>com.buschmais.jqassistant.plugin</groupId>
			<artifactId>jqassistant.plugin.graphml</artifactId>
			<version>1.1.4</version>			
		</dependency>
		<dependency>
			<!-- additional 3rd party plugin -->
			<groupId>de.kontext-e.jqassistant.plugin</groupId>
			<artifactId>jqassistant.plugin.git</artifactId>
			<version>1.1.3</version>
		</dependency>			
	</dependencies>
</plugin>

…to jQAssistant 1.2.0:

<plugin>
	<groupId>com.buschmais.jqassistant</groupId> <!-- the new groupId -->
	<artifactId>jqassistant-maven-plugin</artifactId>
	<version>1.2.0</version>
	<dependencies>
		<dependency>
			<!-- additional 3rd party plugin -->
			<groupId>de.kontext-e.jqassistant.plugin</groupId>
			<artifactId>jqassistant.plugin.git</artifactId>
			<version>1.1.3</version>
		</dependency>
	</dependencies>
</plugin>

2. Rule parameters

Concepts and constraints may now define parameters for better re-usability of rules:

Asciidoc example:

[[example:RootPackage]]
[source,cypher,role=concept,requiresParameters="String rootPackage"]
.Labels the root package with `Root`.
----
MATCH
  (root:Package)
WHERE
  root.fqn = {rootPackage}
SET
  root:RootPackage
RETURN
  root as RootPackage
----

XML example:

<concept id="example:RootPackage">
	<requiresParameter name="rootPackage" type="String"/>
	<description>Labels the root package with "Root".</description>
	<cypher><![CDATA[
		MATCH
		  (root:Package)
		WHERE
		  root.fqn = {rootPackage}
		SET
		  root:RootPackage
		RETURN
		  root as RootPackage
	]]></cypher>
</concept>

The defined parameters – rootPackage in this example – must be provided at runtime, i.e. for the Maven plugin…

<plugins>
	<plugin>
		<groupId>com.buschmais.jqassistant</groupId>
		<artifactId>jqassistant-maven-plugin</artifactId>
		<version>1.2.0</version>
		...
		<configuration>
			<ruleParameters>
				<rootPackage>com.buschmais.example</rootPackage>
			</ruleParameters>
		</configuration>
	</plugin>
</plugins>

…and the command line utility:

jqassistant analyze -ruleParameters=parameters.properties

where the file parameters.properties contains the parameter values:

rootPackage=com.buschmais.example

Download and Documentation

The command line distribution is available for download, the release notes provide a complete list of changes and the updated documentation is available online.

Enjoy!