Circumflex Maven Plugin

Circumflex comes shipped with handy Maven plugin which can help you with following tasks:

configuring Circumflex application using pom.xml instead of cx.properties;
exporting database schema of Circumflex ORM project on build;
generating source code documentation with Docco.

Configuring Circumflex Application

The cfg goal is used to create cx.properties file filled with properties defined in the properties section of your pom.xml. It is a very convenient way to configure various aspects of your Circumflex application. This approach gives you following advantages:

different environments using Maven profiles and settings.xml;
property inheritance;
possibility to reuse properties with the ${prop} notation inside your pom.xml;

All you have to do is configure the cfg goal of maven-cx-plugin:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                             http://maven.apache.org/maven-v4_0_0.xsd">
  <build>
    <sourceDirectory>src/main/scala</sourceDirectory>
    <plugins>
      <plugin>
        <groupId>ru.circumflex</groupId>
        <artifactId>maven-cx-plugin</artifactId>
        <version>${cx.version}</version>
        <executions>
          <execution>
            <id>configure</id>
            <phase>process-resources</phase>
            <goals>
              <goal>cfg</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

After that you may specify configuration properties right in the properties section of your pom.xml (note that cx.properties from your src/main/resourses will not be used anymore):

<project xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                         http://maven.apache.org/maven-v4_0_0.xsd">
  <properties>
     <cx.router>com.myapp.web.MainRouter</cx.router>
     <cx.public>/static</cx.public>
  </properties>
</project>

Exporting Database Schema

You can configure your application to execute schema export scripts on build. Just add a configuration for maven-cx-plugin to your pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                             http://maven.apache.org/maven-v4_0_0.xsd">
  <build>
    <plugins>
      <plugin>
        <groupId>ru.circumflex</groupId>
        <artifactId>maven-cx-plugin</artifactId>
        <version>${cx.version}</version>
        <configuration>
          <packages>
            <package>com.myapp.model</package>
          </packages>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>your-jdbc-driver-vendor</groupId>
            <artifactId>your-jdbc-driver-artifact</artifactId>
            <version>your-jdbc-driver-version</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

Then simply execute following string in your project root:

$ mvn clean compile cx:schema

The database objects from specified package (com.myapp.model in our example) will be created. To drop objects first, add -Ddrop to execution line. Note that plugin searches for schema objects in compiled classes inside project's outputDirectory. Make sure you clean compile your project before running cx:schema to avoid ambiguous situations.

Also note that specifying the dependency to JDBC driver inside maven-cx-plugin configuration is mandatory even if you already have one in your project. This is caused by classloading limitations of c3p0.

Generating Source Documentation

You can use Docco to build your source documentation (just like we did to document our codebase).

Circumflex Docco recognizes documentation in following format:

/*! Your documentation in Markeven
...
...
*/
your_source_code

The API generation is simple: you add a configuration for maven-cx-plugin to your pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                             http://maven.apache.org/maven-v4_0_0.xsd">
  <build>
    <plugins>
      <plugin>
        <groupId>ru.circumflex</groupId>
        <artifactId>maven-cx-plugin</artifactId>
        <version>${cx.version}</version>
      </plugin>
    </plugins>
  </build>
</project>

Then you execute following in your project root:

$ mvn cx:docco

The documentation will be created in target/docco.

Cîrcumflex

Circumflex Maven Plugin

Configuring Circumflex Application

Exporting Database Schema

Generating Source Documentation