build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="name-of-project" default="full-build" basedir=".">
	<!-- By default, we assume all tools to be on the $PATH -->
	<property name="pdepend" value="pdepend"/>
	<property name="phpcpd"  value="phpcpd"/>
	<property name="phpcs"   value="phpcs"/>
	<property name="phpdox"  value="/usr/local/bin/phpdox"/>
	<property name="phploc"  value="phploc"/>
	<property name="phpmd"   value="phpmd"/>
	<property name="phpunit" value="phpunit"/>

	<!-- Use this when the tools are located as PHARs in ${basedir}/build/tools
	<property name="pdepend" value="${basedir}/build/tools/pdepend.phar"/>
	<property name="phpcpd"  value="${basedir}/build/tools/phpcpd.phar"/>
	<property name="phpcs"   value="${basedir}/build/tools/phpcs.phar"/>
	<property name="phpdox"  value="${basedir}/build/tools/phpdox.phar"/>
	<property name="phploc"  value="${basedir}/build/tools/phploc.phar"/>
	<property name="phpmd"   value="${basedir}/build/tools/phpmd.phar"/>
	<property name="phpunit" value="${basedir}/build/tools/phpunit.phar"/> -->

	<!-- Use this when the tools are managed by Composer in ${basedir}/vendor/bin
	<property name="pdepend" value="${basedir}/vendor/bin/pdepend"/>
	<property name="phpcpd"  value="${basedir}/vendor/bin/phpcpd"/>
	<property name="phpcs"   value="${basedir}/vendor/bin/phpcs"/>
	<property name="phpdox"  value="${basedir}/vendor/bin/phpdox"/>
	<property name="phploc"  value="${basedir}/vendor/bin/phploc"/>
	<property name="phpmd"   value="${basedir}/vendor/bin/phpmd"/>
	<property name="phpunit" value="${basedir}/vendor/bin/phpunit"/> -->

	<target name="full-build"
		depends="prepare,composer,static-analysis,phpdox,phpunit"
		description="Performs static analysis, runs the tests, and generates project documentation"/>

	<target name="full-build-parallel"
		depends="prepare,static-analysis-parallel,phpunit,phpdox,-check-failure"
		description="Performs static analysis (executing the tools in parallel), runs the tests, and generates project documentation"/>

	<target name="quick-build"
		depends="prepare,lint,phpunit-no-coverage"
		description="Performs a lint check and runs the tests (without generating code coverage reports)"/>

	<target name="static-analysis"
		depends="lint,phploc-ci,pdepend,phpmd-ci,phpcs-ci,phpcpd-ci"
		description="Performs static analysis" />

	<!-- Adjust the threadCount attribute's value to the number of CPUs -->
	<target name="static-analysis-parallel"
		description="Performs static analysis (executing the tools in parallel)">
		<parallel threadCount="2">
			<sequential>
				<antcall target="pdepend"/>
				<antcall target="phpmd-ci"/>
			</sequential>
			<antcall target="lint"/>
			<antcall target="phpcpd-ci"/>
			<antcall target="phpcs-ci"/>
			<antcall target="phploc-ci"/>
		</parallel>
	</target>

	<target name="clean"
		unless="clean.done"
		description="Cleanup build artifacts">
			<delete dir="${basedir}/logs"/>
			<delete dir="${basedir}/build/api"/>
			<delete dir="${basedir}/build/coverage"/>
			<delete dir="${basedir}/build/logs"/>
			<delete dir="${basedir}/build/pdepend"/>
			<delete dir="${basedir}/build/phpdox"/>
			<property name="clean.done" value="true"/>
	</target>

	<target name="prepare"
		unless="prepare.done"
		depends="clean"
		description="Prepare for build">
        <mkdir dir="${basedir}/build/api"/>
        <mkdir dir="${basedir}/build/coverage"/>
        <mkdir dir="${basedir}/build/logs"/>
        <mkdir dir="${basedir}/build/pdepend"/>
        <mkdir dir="${basedir}/build/phpdox"/>
        <property name="prepare.done" value="true"/>
	</target>

	<target name="lint"
		unless="lint.done"
		description="Perform syntax check of sourcecode files">
	<apply executable="php" taskname="lint">
	<arg value="-l" />

	<fileset dir="${basedir}/src">
		<include name="**/*.php" />
		<modified />
	</fileset>

	<fileset dir="${basedir}/tests">
		<include name="**/*.php" />
		<modified />
	</fileset>
	</apply>

	<property name="lint.done" value="true"/>
	</target>

    <target name="composer" depends="clean-composer,composer-install,composer-update" description="Install or update dependencies" />
    
    <!--// Check to see it the vendor folder already exist, if so, then no reason to run //-->
    <target name="composer.check">
        <condition property="composer.lock.exist.in.gitignore">
            <resourcecontains resource="${basedir}/.gitignore" substring="composer.lock" />
        </condition>
    </target>

    <target name="clean-composer" depends="composer.check" if="composer.lock.exist.in.gitignore" description="Cleanup composer artifacts">
        <delete file="${basedir}/composer.lock" />
    </target>

    <target name="composer-install" depends="composer.check" unless="composer.lock.exist.in.gitignore" description="Installing dependencies">
        <echo>Installing dependencies</echo>
        <exec executable="composer" failonerror="true">
            <arg value="install" />
        </exec>
    </target>

    <target name="composer-update" depends="composer.check" if="composer.lock.exist.in.gitignore" description="Updating dependencies">
        <echo>Updating dependencies</echo>
        <exec executable="composer" failonerror="true">
            <arg value="update" />
        </exec>
    </target>

	<target name="phploc"
		unless="phploc.done"
		description="Measure project size using PHPLOC and print human readable output. Intended for usage on the command line.">
		<exec executable="${phploc}" taskname="phploc">
			<arg value="--count-tests" />
			<arg path="${basedir}/src" />
			<arg path="${basedir}/tests" />
		</exec>
		<property name="phploc.done" value="true"/>
	</target>

	<target name="phploc-ci"
		unless="phploc.done"
		depends="prepare"
		description="Measure project size using PHPLOC and log result in CSV and XML format. Intended for usage within a continuous integration environment.">
		<exec executable="${phploc}" taskname="phploc">
			<arg value="--count-tests" />
			<arg value="--log-csv" />
			<arg path="${basedir}/build/logs/phploc.csv" />
			<arg value="--log-xml" />
			<arg path="${basedir}/build/logs/phploc.xml" />
			<arg path="${basedir}/src" />
			<arg path="${basedir}/tests" />
		</exec>

		<property name="phploc.done" value="true"/>
	</target>

	<target name="pdepend"
		unless="pdepend.done"
		depends="prepare"
		description="Calculate software metrics using PHP_Depend and log result in XML format. Intended for usage within a continuous integration environment.">
		<exec executable="${pdepend}" taskname="pdepend">
			<arg value="--jdepend-xml=${basedir}/build/logs/jdepend.xml" />
			<arg value="--jdepend-chart=${basedir}/build/pdepend/dependencies.svg" />
			<arg value="--overview-pyramid=${basedir}/build/pdepend/overview-pyramid.svg" />
			<arg path="${basedir}/src" />
		</exec>

		<property name="pdepend.done" value="true"/>
	</target>

	<target name="phpmd"
		unless="phpmd.done"
		description="Perform project mess detection using PHPMD and print human readable output. Intended for usage on the command line before committing.">
		<exec executable="${phpmd}" taskname="phpmd">
			<arg path="${basedir}/src" />
			<arg value="text" />
			<arg path="${basedir}/build/phpmd.xml" />
		</exec>
		<property name="phpmd.done" value="true"/>
	</target>

	<target name="phpmd-ci"
		unless="phpmd.done"
		depends="prepare"
		description="Perform project mess detection using PHPMD and log result in XML format. Intended for usage within a continuous integration environment.">
		<exec executable="${phpmd}" taskname="phpmd">
			<arg path="${basedir}/src" />
			<arg value="xml" />
			<arg path="${basedir}/build/phpmd.xml" />
			<arg value="--reportfile" />
			<arg path="${basedir}/build/logs/pmd.xml" />
		</exec>
		<property name="phpmd.done" value="true"/>
	</target>

	<target name="phpcs"
		unless="phpcs.done"
		description="Find coding standard violations using PHP_CodeSniffer and print human readable output. Intended for usage on the command line before committing.">
		<exec executable="${phpcs}" taskname="phpcs">
			<arg value="--standard=PSR2" />
			<arg value="--extensions=php" />
			<arg value="--ignore=autoload.php" />
			<arg path="${basedir}/src" />
			<arg path="${basedir}/tests" />
		</exec>
		<property name="phpcs.done" value="true"/>
	</target>

	<target name="phpcs-ci"
		unless="phpcs.done"
		depends="prepare"
		description="Find coding standard violations using PHP_CodeSniffer and log result in XML format. Intended for usage within a continuous integration environment.">
		<exec executable="${phpcs}" output="/dev/null" taskname="phpcs">
			<arg value="--report=checkstyle" />
			<arg value="--report-file=${basedir}/build/reports/checkstyle.xml" />
			<arg value="--standard=PSR2" />
			<arg value="--extensions=php" />
			<arg value="--ignore=autoload.php" />
			<arg path="${basedir}/src" />
			<arg path="${basedir}/tests" />
		</exec>

		<property name="phpcs.done" value="true"/>
	</target>

	<target name="phpcpd"
		unless="phpcpd.done"
		description="Find duplicate code using PHPCPD and print human readable output. Intended for usage on the command line before committing.">
		<exec executable="${phpcpd}" taskname="phpcpd">
			<arg path="${basedir}/src" />
		</exec>

		<property name="phpcpd.done" value="true"/>
	</target>

	<target name="phpcpd-ci"
		unless="phpcpd.done"
		depends="prepare"
		description="Find duplicate code using PHPCPD and log result in XML format. Intended for usage within a continuous integration environment.">
		<exec executable="${phpcpd}" taskname="phpcpd">
			<arg value="--log-pmd" />
			<arg path="${basedir}/build/logs/pmd-cpd.xml" />
			<arg path="${basedir}/src" />
		</exec>
		<property name="phpcpd.done" value="true"/>
	</target>

	<target name="phpdox"
		unless="phpdox.done"
		depends="phploc-ci,phpcs-ci,phpmd-ci"
		description="Generate project documentation using phpDox">
		<exec executable="${phpdox}" dir="${basedir}/build" taskname="phpdox"/>
		<property name="phpdox.done" value="true"/>
	</target>

	<target name="phpunit"
		unless="phpunit.done"
		depends="prepare"
		description="Run unit tests with PHPUnit">
		<exec executable="${phpunit}" failonerror="true">
            <arg value="-c" />
            <arg value="${basedir}/phpunit.xml" />
            <arg value="--coverage-html" />
            <arg value="${basedir}/build/coverage" />
            <arg value="--coverage-clover" />
            <arg value="${basedir}/build/logs/clover.xml" />
            <arg value="--coverage-crap4j" />
            <arg value="${basedir}/build/logs/crap4j.xml" />
            <arg value="--log-junit" />
            <arg value="${basedir}/build/logs/junit.xml" />
		</exec>
		<property name="phpunit.done" value="true"/>
	</target>

	<target name="phpunit-no-coverage"
		unless="phpunit.done"
		depends="prepare"
		description="Run unit tests with PHPUnit (without generating code coverage reports)">
		<exec executable="${phpunit}" failonerror="false" taskname="phpunit">
			<arg value="--configuration"/>
			<arg path="${basedir}/phpunit.xml"/>
			<arg value="--no-coverage"/>
		</exec>
		<property name="phpunit.done" value="true"/>
	</target>

	<target name="-check-failure">
		<fail message="PHPUnit did not finish successfully">
			<condition>
				<not>
					<equals arg1="${result.phpunit}" arg2="0"/>
				</not>
			</condition>
		</fail>
	</target>
</project>