Skip to content

Commit

Permalink
Adding seperate build script to supply api docs, coverage and other m…
Browse files Browse the repository at this point in the history
…etrics.
  • Loading branch information
wtfzdotnet committed Feb 28, 2014
2 parents a6b2f22 + 2c2a12e commit dadc395
Show file tree
Hide file tree
Showing 7 changed files with 219 additions and 15 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
/bin
/docs
/build/*
!/build/phpunit.xml
!/build/phpmd.xml
!/build/phpdox.xml
/vendor/
/composer.lock
/*.php
/.idea/
/apikey.php
/phpunit
/public_html
/cache.properties
127 changes: 127 additions & 0 deletions build.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<?xml version="1.0" encoding="UTF-8"?>

<project name="php-tmdb-api" default="build-parallel">
<target name="build"
depends="prepare,lint,phploc,pdepend,phpmd-ci,phpcs-ci,phpcpd,phpunit,phpdox"/>

<target name="build-parallel"
depends="prepare,lint,tools-parallel,phpunit,phpdox"/>

<target name="tools-parallel" description="Run tools in parallel">
<parallel threadCount="2">
<sequential>
<antcall target="pdepend"/>
<antcall target="phpmd-ci"/>
</sequential>
<antcall target="phploc"/>
<antcall target="phpcpd"/>
<antcall target="phpcs-ci"/>
</parallel>
</target>

<target name="clean" description="Cleanup build artifacts">
<delete dir="${basedir}/build/api"/>
<delete dir="${basedir}/build/coverage"/>
<delete dir="${basedir}/build/logs"/>
<delete dir="${basedir}/build/pdepend"/>
</target>

<target name="prepare" 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"/>
</target>

<target name="lint" description="Perform syntax check of sourcecode files">
<apply executable="php" failonerror="true">
<arg value="-l" />

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

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

<target name="phploc" description="Measure project size using PHPLOC">
<exec executable="phploc">
<arg value="--log-xml" />
<arg value="${basedir}/build/logs/phploc.xml" />
<arg path="${basedir}/lib" />
</exec>
</target>

<target name="pdepend" description="Calculate software metrics using PHP_Depend">
<exec executable="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}/lib" />
</exec>
</target>

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

<target name="phpmd-ci" description="Perform project mess detection using PHPMD creating a log file for the continuous integration server">
<exec executable="phpmd">
<arg path="${basedir}/lib" />
<arg value="xml" />
<arg value="${basedir}/build/phpmd.xml" />
<arg value="--reportfile" />
<arg value="${basedir}/build/logs/pmd.xml" />
</exec>
</target>

<target name="phpcs"
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">
<arg value="--standard=PSR2" />
<arg path="${basedir}/lib" />
</exec>
</target>

<target name="phpcs-ci" description="Find coding standard violations using PHP_CodeSniffer creating a log file for the continuous integration server">
<exec executable="phpcs" output="/dev/null">
<arg value="--report=checkstyle" />
<arg value="--report-file=${basedir}/build/logs/checkstyle.xml" />
<arg value="--standard=PSR2" />
<arg path="${basedir}/lib" />
</exec>
</target>

<target name="phpcpd" description="Find duplicate code using PHPCPD">
<exec executable="phpcpd">
<arg value="--log-pmd" />
<arg value="${basedir}/build/logs/pmd-cpd.xml" />
<arg path="${basedir}/lib" />
</exec>
</target>

<target name="phpdox" description="Generate API documentation using phpDox">
<exec executable="phpdox">
<arg value="-f" />
<arg path="${basedir}/build/phpdox.xml" />
</exec>
</target>

<target name="phpunit" description="Run unit tests with PHPUnit">
<exec executable="phpunit" failonerror="true">
<arg value="-c" />
<arg path="${basedir}/build/phpunit.xml" />
</exec>
</target>
</project>
34 changes: 34 additions & 0 deletions build/phpdox.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="utf-8" ?>
<phpdox xmlns="http://phpdox.net/config">
<project name="php-tmdb-api" source="${basedir}/../lib" workdir="${basedir}/phpdox">
<collector backend="parser" />

<generator output="${basedir}/api">
<enrich base="${basedir}">
<source type="build" />

<source type="git">
<history enabled="true" limit="25" cache="${phpDox.project.workdir}/gitlog.xml" />
</source>

<source type="phploc">
<file name="logs/phploc.xml" />
</source>

<source type="checkstyle">
<file name="logs/checkstyle.xml" />
</source>

<source type="pmd">
<file name="logs/pmd.xml" />
</source>

<source type="phpunit">
<coverage path="coverage/xml" />
</source>
</enrich>

<build engine="html" output="html"/>
</generator>
</project>
</phpdox>
13 changes: 13 additions & 0 deletions build/phpmd.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0"?>
<ruleset name="Symfony2 ruleset" xmlns="http://pmd.sf.net/ruleset/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd" xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
<description>
Custom ruleset.
</description>

<rule ref="rulesets/design.xml" />
<rule ref="rulesets/unusedcode.xml" />
<rule ref="rulesets/codesize.xml" />
<rule ref="rulesets/naming.xml" />

</ruleset>
40 changes: 40 additions & 0 deletions build/phpunit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>

<phpunit backupGlobals="false"
backupStaticAttributes="false"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false"
bootstrap="../test/bootstrap.php"
>
<testsuites>
<testsuite name="php-tmdb-api Test Suite">
<directory>../test/Tmdb/</directory>
</testsuite>
</testsuites>

<groups>
<exclude>
<group>functional</group>
</exclude>
</groups>

<filter>
<whitelist>
<directory suffix=".php">../lib/Tmdb/</directory>
</whitelist>
</filter>

<logging>
<log type="coverage-html" target="coverage" charset="UTF-8"
yui="true" highlight="true"
lowUpperBound="35" highLowerBound="70"/>
<log type="coverage-clover" target="coverage/xml/index.xml" charset="UTF-8"
yui="true" highlight="true"
lowUpperBound="35" highLowerBound="70"/>
</logging>
</phpunit>
9 changes: 0 additions & 9 deletions phpdox.xml

This file was deleted.

6 changes: 0 additions & 6 deletions phpunit.xml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,4 @@
<directory suffix=".php">./lib/Tmdb/</directory>
</whitelist>
</filter>

<logging>
<log type="coverage-html" target="phpunit/coverage" charset="UTF-8"
yui="true" highlight="true"
lowUpperBound="35" highLowerBound="70"/>
</logging>
</phpunit>

0 comments on commit dadc395

Please sign in to comment.