├── .gitignore
├── README.markdown
├── build.default.properties
└── build.xml


/.gitignore:
--------------------------------------------------------------------------------
1 | build.properties
2 | coverage/*
3 | logs/*
4 | tests/*
5 | tools/*


--------------------------------------------------------------------------------
/README.markdown:
--------------------------------------------------------------------------------
 1 | # Phing Drupal Template
 2 | 
 3 | An XML build file for the [Phing build system](http://www.phing.info/trac/) with tasks and configuration designed for [Drupal](http://drupal.org) projects.
 4 | 
 5 | For more information read [the documentation](http://reload.github.com/phing-drupal-template/).
 6 | 
 7 | 
 8 | ## Related projects
 9 | * [Jenkins job template for Drupal projects](http://reload.github.com/jenkins-drupal-template/): A standard Jenkins job template for Drupal projects
10 | * [Drupal Jenkins demo](https://github.com/kasperg/drupal-jenkins-demo): An example project which uses the Phing Drupal template and is continuously integrated using the Jenkins job template.


--------------------------------------------------------------------------------
/build.default.properties:
--------------------------------------------------------------------------------
 1 | # The name of the project
 2 | phing.project.name = name-of-project
 3 | 
 4 | # Set this variable to enable the httpget proxy.
 5 | # phing.httpget.proxy = http://localhost:3128/
 6 | 
 7 | # The version of Drupal for the project - 6 or 7
 8 | drupal.version = 7
 9 | # The install profile to use
10 | drupal.profile = standard
11 | # The database url to use for site installs
12 | drupal.db.url = sqlite:${project.drupal.dir}/database.sqlite
13 | 
14 | # The drupal.uri, needed if you want to run the tests.
15 | # Ex: drupal.uri = http://localhost/drupal7
16 | # drupal.uri = 
17 | 
18 | # Options to build the project using drush_make
19 | # The make file for the project
20 | # drupal.make.file = name-of-project.make
21 | # Whether to include core or not
22 | # drupal.make.nocore = 1
23 | # The directory to make the site in relative to the project root directory
24 | # drupal.make.dir = site
25 | # Should we update the RewriteBase directive in .htaccess ?
26 | # Ex: drupal.make.rewritebase = /drupal7
27 | # drupal.make.rewritebase =
28 | 
29 | # The directory containing the modules and themes for the project relative to the drupal root directory. If using Drush Make this is also where modules, themes, libraries etc. will be downloaded to.
30 | project.code.dir = sites/all
31 | # A common prefix for modules developed for the site e.g. your_prefix_your_module
32 | project.code.prefix = your_prefix
33 | # The names of other modules and themes developed for the site seperated by whitespace
34 | project.code.custom = your_theme other_module
35 | 
36 | # The repository to clone for Phing PHPLoc task
37 | phing.phploc.repository.url = https://github.com/raphaelstolt/phploc-phing.git
38 | phing.phploc.repository.revision = 1.6.1
39 | 
40 | # The repository to clone for Phing Drush task
41 | phing.drush.repository.url = https://github.com/kasperg/phing-drush-task.git
42 | phing.drush.repository.revision = HEAD
43 | 
44 | # The repository to clone for PHP CodeSniffer coding standards task
45 | # NB: This is only required if using the phpcs target / PHP_Codesniffer
46 | phpcs.drupalcs.repository = https://github.com/ericduran/drupalcs.git
47 | 
48 | # The url to the jslint4java to use
49 | jslint4java.url = http://jslint4java.googlecode.com/files/jslint4java-2.0.0-dist.zip
50 | 
51 | # The version of jslint to use
52 | jslint.repository.url = https://github.com/mikewest/JSLint.git
53 | # The file within the repository containing jslint
54 | jslint.file = fulljslint.js
55 | 
56 | # The version of csslint to use
57 | csslint.repository.url = https://github.com/stubbornella/csslint.git
58 | csslint.repository.revision = v0.8.5
59 | 
60 | # The csslint rules to use
61 | # The current selection is based on discussion here: http://mattwilcox.net/archive/entry/id/1054/
62 | csslint.rules = display-property-grouping,duplicate-properties,empty-rules,known-properties,box-sizing,compatible-vendor-prefixes,gradients,vendor-prefix,import,zero-units,shorthand,important
63 | # The csslint rules which should cause the build to break if detected
64 | csslint.rules.break = parsing-errors
65 | 
66 | 
67 | # The url from where to download rhino
68 | rhino.url = http://ftp.mozilla.org/pub/mozilla.org/js/rhino1_7R3.zip
69 | 


--------------------------------------------------------------------------------
/build.xml:
--------------------------------------------------------------------------------
   1 | <?xml version="1.0" encoding="UTF-8"?>
   2 | <!-- **Phing Drupal Template** is a XML build file for the
   3 | **[Phing build system](http://www.phing.info/trac/)** with targets and
   4 | configuration designed for **[Drupal](http://drupal.org)** projects.
   5 | 
   6 | The aim of the project is to provide a build file which can be used with a
   7 | contiuous integration server to ensure clean code - check for compilation
   8 | errors, run unit tests, lint code and verify that code standards are upheld.
   9 | 
  10 | The template has been developed with the
  11 | [Jenkins job template for Drupal projects](http://reload.github.com/jenkins-drupal-template)
  12 | and the [Drupal Jenkins demo](http://github.com/kasperg/drupal-jenkins-demo).
  13 | It may work with other continuous integration systems.
  14 | 
  15 | ### Usage
  16 | 
  17 | The template can be used in several ways:
  18 | 
  19 | * As a starting point for your own build files. Download
  20 | [`build.xml`](https://raw.github.com/reload/phing-drupal-template/master/build.xml)
  21 | to the root directory of your Drupal project and modify it as needed.
  22 | 
  23 | * As the actual build file for your project. You can configure most aspects of
  24 | the build according to your project through a properties file. This works
  25 | whether you have your entire Drupal project in VCS or use
  26 | [drush_make](http://drupal.org/project/drush_make). Download the entire
  27 | project and place it in a subfolder or use it as a
  28 | [git submodule](http://kernel.org/pub/software/scm/git/docs/git-submodule.html).
  29 | Using the `build` subfolder from the root directory is recommended. Copy the
  30 | `build.default.properties` file to the root directory, rename it
  31 | `build.properties` and modify it according to your project. Leave out
  32 | properties where you want to use the default values.
  33 | 
  34 | ### Requirements
  35 | 
  36 | Using the template requires a range of PEAR packages present. They can be
  37 | installed as follows:
  38 | 
  39 |     pear channel-discover pear.phing.info
  40 |     pear channel-discover pear.pdepend.org
  41 |     pear channel-discover pear.phpmd.org
  42 |     pear channel-discover pear.phpunit.de
  43 |     pear channel-discover components.ez.no
  44 |     pear channel-discover pear.symfony-project.com
  45 | 
  46 |     pear install phing/phing
  47 |     pear install  -a phpmd/PHP_PMD
  48 |     pear install phpunit/phpcpd
  49 |     pear install phpunit/phploc
  50 |     pear install PHPDocumentor
  51 |     pear install PHP_CodeSniffer
  52 |     pear install HTTP_Request2
  53 |     pear install -a phpunit/PHP_CodeBrowser
  54 | 
  55 | The following must be available from the command line:
  56 | 
  57 | * [Drush](http://drupal.org/project/drush): The Drupal shell.
  58 | [Installation instructions](http://drupalcode.org/project/drush.git/blob/HEAD:/README.txt).
  59 | * PHP 5.2.7 or newer with sqlite extension
  60 | * Java Runtime Environment
  61 | 
  62 | ### Credits
  63 | 
  64 | The build file is heavily inspired by Sebastian Bergmans wonderful [template
  65 | for Jenkins Jobs for PHP Projects](http://jenkins-php.org/) and began as a
  66 | Phing port of his suggested Apache Ant build file.
  67 | 
  68 | Many of the same tools are used: [phploc](http://sebastianbergmann.github.com/phploc/),
  69 | [phpcpd](https://github.com/sebastianbergmann/phpcpd),
  70 | [PHPMD](http://phpmd.org/), [phpDocumentor](http://www.phpdoc.org/) and [PHP_CodeBrowser](https://github.com/Mayflower/PHP_CodeBrowser).
  71 | 
  72 | A couple of additional external tools are downloaded and used during the
  73 | build process:
  74 | 
  75 | * [Phing Drush Task](http://drupal.org/project/phingdrushtask):
  76 |   A custom task for running drush from Phing
  77 | * [Phing PHPLoc](https://github.com/raphaelstolt/phploc-phing): A custom task
  78 |   for running phploc from Phing
  79 | * [jslint4java](http://jslint4java.googlecode.com/): Supports execution of
  80 |   jslint from the command line
  81 | * [jslint´](https://github.com/mikewest/JSLint): A more humane version of
  82 |   Douglas Crockfords JSLint.
  83 | * [csslint](http://csslint.net): A tool to help point out problems with CSS code.
  84 | * [Mozilla Rhino](http://www.mozilla.org/rhino/download.html): An implementation of Javascript in Java.
  85 | * [Coder](http://drupal.org/project/coder): Drupal module for
  86 |   performing code reviews.
  87 | 
  88 | This documentation has been generated by
  89 | [phrocco](https://github.com/oneblackbear/phrocco)
  90 | - a PHP port of the literate documentation generator Docco.
  91 | 
  92 | ### Contributors
  93 | 
  94 | The Phing Drupal template is developed by [Reload!](http://reload.dk) - a Drupal development agency located in Copenhagen, Denmark.
  95 | 
  96 | Drush Make and Simpletest support has been sponsored by [DBC](http://www.dbc.dk/).
  97 | 
  98 | <a href="http://github.com/reload/phing-drupal-template">
  99 |   <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://a248.e.akamai.net/assets.github.com/img/30f550e0d38ceb6ef5b81500c64d970b7fb0f028/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6f72616e67655f6666373630302e706e67" alt="Fork me on GitHub">
 100 | </a>
 101 | -->
 102 | 
 103 | <project name="phing-drupal" default="build" phingVersion="2.4.11">
 104 | 
 105 | <!-- ## Main targets -->
 106 | 
 107 | <!-- ### Build project
 108 | 
 109 | Do a complete build of the project by verifying code consistency and and
 110 | performing static analysis of the code.
 111 | 
 112 | This is the default build target.
 113 | 
 114 | Do not run `docs` for now. Generating documentation eats up memory and build
 115 | time and is largely obsolete when using GitHub. -->
 116 |   <target name="build" depends="init,
 117 |                                 clean,
 118 |                                 verify,
 119 |                                 analyze" />
 120 | 
 121 | <!-- ### Verify code consistency
 122 | 
 123 | Make sure that our code is clean and functional. -->
 124 |   <target name="verify" depends="init,
 125 |                                  clean,
 126 |                                  lint-php-custom,
 127 |                                  lint-js-custom,
 128 |                                  lint-css-custom,
 129 |                                  check-php-debug,
 130 |                                  check-js-debug,
 131 |                                  simpletest"/>
 132 | 
 133 | <!-- ### Analyze code
 134 | 
 135 | Perform static analysis of the code to generate statistics, identify potential
 136 | problems and opportunities for refactorings and make sure that the code
 137 | complies with coding standards. -->
 138 |   <target name="analyze" depends="init,
 139 |                                   clean,
 140 |                                   phploc,
 141 |                                   phpmd,
 142 |                                   phpcpd">
 143 |     <!-- Moved inside target to support properties in target name -->
 144 |     <phingcall target="coder-review-d${drupal.version}">
 145 |       <!-- Run the target as if it was executed from the Drupal root
 146 |            directory. -->
 147 |       <property name="project.basedir" value="${project.drupal.dir}"/>
 148 |       <!-- We already have a clean environment so avoid further cleaning. -->
 149 |       <property name="project.cleaned" value="1"/>
 150 |       <!-- Make will run again as a part of the `init` target. We already have
 151 |            a working site so skip that. -->
 152 |       <property name="project.make.skip" value="1"/>
 153 |     </phingcall>
 154 |   </target>
 155 | 
 156 | <!-- ### Generate documentation
 157 | 
 158 | Generate HTML documentation and code browser for the project. -->
 159 |   <target name="docs" depends="init,
 160 |                                clean,
 161 |                                phpdoc,
 162 |                                phpcb" />
 163 | 
 164 | <!-- ## Individual targets
 165 | These targets can be executed individually or grouped unless explicitly
 166 | stated as a part of the task.
 167 | 
 168 | **As a rule targets without descriptions should not be executed directly.** -->
 169 | 
 170 | <!-- ### PHP linting
 171 | 
 172 | Check files for syntax errors. -->
 173 |   <target name="lint-php"
 174 |           description="Check all PHP files for syntax errors using PHPLint"
 175 |           depends="init">
 176 |     <phplint haltonfailure="true">
 177 |       <fileset refid="src.php" />
 178 |     </phplint>
 179 |   </target>
 180 | 
 181 |   <target name="lint-php-custom"
 182 |           description="Check custom PHP files for syntax errors using PHPLint"
 183 |           depends="init">
 184 |     <phplint haltonfailure="true">
 185 |       <fileset refid="src.php.custom" />
 186 |     </phplint>
 187 |   </target>
 188 | 
 189 | <!-- ### Javascript linting
 190 | 
 191 | Checks code against [jslint](http://www.jslint.com/) to assure a coding
 192 | standard is followed and detect potential problems. By default
 193 | [jslint´](https://github.com/mikewest/JSLint) is used. -->
 194 |   <target name="lint-js"
 195 |           description="Check all Javascript files using JSlint"
 196 |           depends="init, setup-jslint4java, setup-jslint">
 197 |     <foreach target="jslint-file" param="filename" absparam="absfilename">
 198 |       <fileset refid="src.js"/>
 199 |     </foreach>
 200 |   </target>
 201 | 
 202 |   <target name="lint-js-custom"
 203 |           description="Check custom Javascript files using JSlint"
 204 |           depends="init, setup-jslint4java, setup-jslint">
 205 |     <foreach target="jslint-file" param="filename" absparam="absfilename">
 206 |       <fileset refid="src.js.custom"/>
 207 |     </foreach>
 208 |   </target>
 209 | 
 210 | <!-- #### jslint a file
 211 | 
 212 | No need to run `init` or setup targets here. This target should only be called
 213 | from parent `lint-js` targets. -->
 214 |   <target name="jslint-file">
 215 |     <echo>Linting file: ${absfilename}</echo>
 216 | 
 217 |     <!-- Execute jslint4java and return the result in checkstyle format-->
 218 |     <exec command="java -jar ${jslint4java.file}
 219 |                    --jslint ${jslint.file} --report checkstyle ${absfilename}"
 220 |           outputProperty="report" />
 221 | 
 222 |     <!-- Print the result to a file.
 223 |          Replace / with - in path to create legal filenames in the format
 224 |          `checkstyle-jslint-dir1-dir2-file.js.xml`. -->
 225 |     <php function="str_replace" returnProperty="filename.normalized">
 226 |       <param value="/" />
 227 |       <param value="-" />
 228 |       <param value="${filename}" />
 229 |     </php>
 230 |     <delete file="${project.logdir}/checkstyle-jslint-${filename.normalized}.xml" />
 231 |     <append text="${report}"  destFile="${project.logdir}/checkstyle-jslint-${filename.normalized}.xml" />
 232 |   </target>
 233 | 
 234 |   <!-- #### Setup jslint4java -->
 235 |   <target name="setup-jslint4java"
 236 |           depends="init"
 237 |           unless="project.jslint4java.setup">
 238 |     <property name="jslint4java.dir"
 239 |               value="${project.toolsdir}/jslint4java" />
 240 |     <php function="basename" returnProperty="jslint4java.basename">
 241 |       <param value="${jslint4java.url}" />
 242 |       <!-- We assume that the version of jslint4java used is a distribution
 243 |            where the filename ends in `-dist.zip` -->
 244 |       <param value="-dist.zip" />
 245 |     </php>
 246 | 
 247 |     <!-- Download and unpack jslint4java -->
 248 |     <mkdir dir="${jslint4java.dir}" />
 249 |     <php function="basename" returnProperty="jslint4java.zipfile">
 250 |       <param value="${jslint4java.url}" />
 251 |     </php>
 252 |     <httpget url="${jslint4java.url}"
 253 |              dir="${jslint4java.dir}"
 254 |              proxy="${phing.httpget.proxy}" />
 255 |     <unzip file="${jslint4java.dir}/${jslint4java.zipfile}"
 256 |            todir="${jslint4java.dir}" />
 257 | 
 258 |     <!-- Other targets use this property to determine the location of the
 259 |          `jslint4java.jar` file -->
 260 |     <property name="jslint4java.file"
 261 |  value="${jslint4java.dir}/${jslint4java.basename}/${jslint4java.basename}.jar"/>
 262 | 
 263 |     <!-- Set property to prevent unnecessary additional invocations of this
 264 |          target -->
 265 |     <property name="project.jslint4java.setup" value="true" />
 266 |   </target>
 267 | 
 268 |   <!-- #### Setup jslint -->
 269 |   <target name="setup-jslint"
 270 |           depends="init"
 271 |           unless="project.jslint.setup">
 272 |     <phingcall target="setup-git-repo">
 273 |       <property name="repo.dir" value="${project.toolsdir}/jslint"/>
 274 |       <property name="repo.url" value="${jslint.repository.url}" />
 275 |     </phingcall>
 276 | 
 277 |     <!-- Other targets use this property to determine the location of the jslint
 278 |          file -->
 279 |     <property name="jslint.file"
 280 |               value="${project.toolsdir}/jslint/${jslint.file}"
 281 |               override="true" />
 282 | 
 283 |     <!-- Set property to prevent unnecessary additional invocations of this
 284 |          target -->
 285 |     <property name="project.jslint.setup" value="true" />
 286 |   </target>
 287 | 
 288 | <!-- ### CSS linting
 289 | 
 290 | Checks code against [CSS Lint](http://www.csslint.net/) to help point out problems with CSS code. It does basic syntax checking as well as applying a set of rules to the code that look for problematic patterns or signs of inefficiency. -->
 291 |   <target name="lint-css"
 292 |           description="Check all CSS files using CSS Lint"
 293 |           depends="init, setup-rhino, setup-csslint">
 294 |     <foreach target="csslint-file" param="filename" absparam="absfilename">
 295 |       <fileset refid="src.css"/>
 296 |     </foreach>
 297 |   </target>
 298 | 
 299 |   <target name="lint-css-custom"
 300 |           description="Check custom CSS files using CSS Lint"
 301 |           depends="init, setup-rhino, setup-csslint">
 302 |     <foreach target="csslint-file" param="filename" absparam="absfilename">
 303 |       <fileset refid="src.css.custom"/>
 304 |     </foreach>
 305 |   </target>
 306 | 
 307 | <!-- #### csslint a file
 308 | 
 309 | No need to run `init` or setup targets here. This target should only be called
 310 | from parent `lint-css` targets. -->
 311 |   <target name="csslint-file">
 312 |     <echo>Linting file: ${absfilename}</echo>
 313 | 
 314 |     <!-- Run csslint through Rhino and return the result in
 315 |          checkstyle format-->
 316 |     <exec command="java -jar ${rhino.jar} ${csslint.rhino.file}
 317 |                    --format=checkstyle-xml --rules=${csslint.rules}
 318 |                    ${absfilename}"
 319 |           outputProperty="report" />
 320 | 
 321 |     <!-- Print the result to a file.
 322 |          Replace / with - in path to create legal filenames in the format
 323 |          `checkstyle-csslint-dir1-dir2-file.css.xml`. -->
 324 |     <php function="str_replace" returnProperty="filename.normalized">
 325 |       <param value="/" />
 326 |       <param value="-" />
 327 |       <param value="${filename}" />
 328 |     </php>
 329 | 
 330 |     <property name="csslint.report.file" value="${project.logdir}/checkstyle-csslint-${filename.normalized}.xml" />
 331 |     <delete file="${csslint.report.file}" />
 332 |     <append text="${report}"  destFile="${csslint.report.file}" />
 333 | 
 334 | 
 335 |     <!-- Cleanup the break rules property.
 336 |          Hyphens are removed to support both input and output rule format.
 337 |          csslint-rule becomes CsslintRule.
 338 |          Seperators (Commas and multiple whitespace characters) are reduced
 339 |          to a pipe to be used in a regular expression. -->
 340 |          <php expression="str_replace('-', '', '${csslint.rules.break}')"
 341 |               returnProperty="csslint.rules.break"/>
 342 |          <php expression="preg_replace('/(\s+|\s*,\s*)/', '|', '${csslint.rules.break}')"
 343 |               returnProperty="csslint.rules.break"/>
 344 | 
 345 |     <!-- If any rules which require the build to break are defined then
 346 |          look for them. -->
 347 |     <if>
 348 |       <not>
 349 |         <equals arg1="${csslint.rules.break}" arg2="" />
 350 |       </not>
 351 |       <then>
 352 |         <!-- CSS Lint reports checkstyle errors using the format
 353 |              net.csslint.RuleName. Load all checkstyle reports and look for
 354 |              errors with such a source from the provided rules. -->
 355 |         <loadfile property="csslint.break.errors"
 356 |                   file="${csslint.report.file}">
 357 |           <filterchain>
 358 |             <linecontainsregexp>
 359 |                 <regexp pattern="(net\.csslint\.(${csslint.rules.break}))"
 360 |                         ignoreCase="true" />
 361 |               </linecontainsregexp>
 362 |           </filterchain>
 363 |         </loadfile>
 364 | 
 365 |         <!-- Break if any errors from the provided rules are detected! -->
 366 |         <if>
 367 |           <not>
 368 |             <equals arg1="${csslint.break.errors}" arg2="" />
 369 |           </not>
 370 |           <then>
 371 |             <fail message="CSS error detected in file ${absfilename}" />
 372 |           </then>
 373 |         </if>
 374 |       </then>
 375 |     </if>
 376 |   </target>
 377 | 
 378 |    <!-- #### Setup csslint -->
 379 |    <target name="setup-csslint"
 380 |            depends="init"
 381 |            unless="project.csslint.setup">
 382 |      <phingcall target="setup-git-repo">
 383 |        <property name="repo.dir"
 384 |                  value="${project.toolsdir}/csslint"/>
 385 |        <property name="repo.url"
 386 |                  value="${csslint.repository.url}" />
 387 |        <property name="repo.revision"
 388 |                  value="${csslint.repository.revision}" />
 389 |      </phingcall>
 390 | 
 391 |      <!-- Other targets use this property to determine the location of the
 392 |           csslint rhino file -->
 393 |      <property name="csslint.rhino.file"
 394 |                value="${project.toolsdir}/csslint/release/csslint-rhino.js" />
 395 | 
 396 |      <!-- Set property to prevent unnecessary additional invocations of this
 397 |           target -->
 398 |      <property name="project.csslint.setup" value="true" />
 399 |    </target>
 400 | 
 401 | <!-- ### Debug code detection
 402 | 
 403 | Code should not call functions which are usually used for debugging.
 404 | This belongs on developer environments - not VCS. This goes for mentioning
 405 | them in comments as well. -->
 406 |   <target name="check-php-debug"
 407 |           description="Check custom PHP code for debug statements"
 408 |           depends="init">
 409 |     <phingcall target="check-debug">
 410 |       <property name="debug.language" value="PHP" override="true" />
 411 |       <property name="debug.pattern" value="(var_dump\(|dsm\(|dpm\()"
 412 |                 override="true" />
 413 |       <property name="debug.fileset" value="src.php.custom"/>
 414 |     </phingcall>
 415 |   </target>
 416 | 
 417 |   <target name="check-js-debug"
 418 |           description="Check custom Javascript code for debug statements">
 419 |     <phingcall target="check-debug">
 420 |       <property name="debug.language" value="Javascript" override="true" />
 421 |       <property name="debug.pattern" value="(console\.log\()" override="true" />
 422 |       <property name="debug.fileset" value="src.js.custom"/>
 423 |     </phingcall>
 424 |   </target>
 425 | 
 426 |   <!-- #### Check a fileset for debug code -->
 427 |   <target name="check-debug"
 428 |           depends="init">
 429 |     <php function="strtolower" returnProperty="debug.language.lower">
 430 |       <param value="${debug.language}" />
 431 |     </php>
 432 |     <property name="debug.output"
 433 |               value="${project.logdir}/debug_${debug.language.lower}.txt"
 434 |               override="true" />
 435 |     <delete file="${debug.output}"/>
 436 |     <append text="" destFile="${debug.output}" />
 437 | 
 438 |     <foreach target="check-debug-file" param="filename"
 439 |              absparam="absfilename">
 440 |       <fileset refid="${debug.fileset}"/>
 441 |     </foreach>
 442 | 
 443 |     <loadfile property="debug.lines" file="${debug.output}" />
 444 |     <!-- Break if debug code is detected! -->
 445 |     <if>
 446 |       <not>
 447 |         <equals arg1="${debug.lines}" arg2="" />
 448 |       </not>
 449 |       <then>
 450 |         <fail message="${debug.language} debug code detected:${line.separator}
 451 |                        ${debug.lines}" />
 452 |       </then>
 453 |     </if>
 454 |   </target>
 455 | 
 456 | <!-- #### Check an individual file for debug code
 457 | 
 458 | No need to run `init` here. This target should only be called through parent
 459 | `check-debug` target. -->
 460 |   <target name="check-debug-file">
 461 |     <echo>Checking file for debug statements: ${absfilename}</echo>
 462 |     <loadfile property="debug.lines" file="${absfilename}">
 463 |       <filterchain>
 464 |         <linecontainsregexp>
 465 |             <regexp pattern="${debug.pattern}" />
 466 |           </linecontainsregexp>
 467 |       </filterchain>
 468 |     </loadfile>
 469 |     <if>
 470 |       <not>
 471 |         <equals arg1="${debug.lines}" arg2="" />
 472 |       </not>
 473 |       <then>
 474 |         <append text="${filename}:${line.separator}
 475 |                       ${debug.lines}${line.separator}
 476 |                       ${line.separator}"
 477 |                 destFile="${debug.output}"/>
 478 |       </then>
 479 |     </if>
 480 |   </target>
 481 | 
 482 | <!-- ### Detect code mess
 483 | 
 484 | Uses [PHPMD](http://phpmd.org/) to detect code mess and look for potential
 485 | problems. -->
 486 |   <target name="phpmd"
 487 |           description="Generate pmd.xml using PHPMD"
 488 |           depends="init">
 489 |     <!-- We do not use the unusedcode ruleset as Drupal hook implementations
 490 |          usually are declared with all arguements but may not use them
 491 |          all. -->
 492 |     <phpmd rulesets="codesize,naming,design">
 493 |       <fileset refid="src.php.custom" />
 494 |       <formatter type="xml" outfile="${project.logdir}/pmd.xml"/>
 495 |     </phpmd>
 496 |   </target>
 497 | 
 498 | <!-- ### Detect potential copy/pasting
 499 | 
 500 | Uses [phpcpd](https://github.com/sebastianbergmann/phpcpd) to detect duplicate
 501 | code. This indicates potential refactorings.-->
 502 |   <target name="phpcpd"
 503 |           description="Generate pmd-cpd.xml using phpcpd"
 504 |           depends="init">
 505 |     <phpcpd>
 506 |       <fileset refid="src.php.custom" />
 507 |       <formatter type="pmd" outfile="${project.logdir}/pmd-cpd.xml"/>
 508 |     </phpcpd>
 509 |   </target>
 510 | 
 511 | <!-- ### Generate code statistics
 512 | 
 513 | Measures the size of the project using
 514 | [phploc](http://sebastianbergmann.github.com/phploc/) and generates
 515 | statistics. -->
 516 |   <target name="phploc"
 517 |           description="Generate phploc.csv using phploc"
 518 |           depends="init, setup-phing-phploc">
 519 |     <!-- Suffixes should be the same as included in the
 520 |          src.php filesets -->
 521 |     <phploc reportType="csv"
 522 |             reportName="phploc" reportDirectory="${project.logdir}"
 523 |             suffixes="php,module,inc,install,profile,test" countTests="true">
 524 |       <fileset refid="src.php.custom" />
 525 |     </phploc>
 526 |   </target>
 527 | 
 528 |   <!-- #### Setup Phing phploc integration -->
 529 |   <target name="setup-phing-phploc"
 530 |           depends="init" >
 531 |     <!-- Clone the project -->
 532 |     <phingcall target="setup-git-repo">
 533 |       <property name="repo.dir" value="${project.toolsdir}/phing-phploc"/>
 534 |       <property name="repo.url" value="${phing.phploc.repository.url}" />
 535 |     </phingcall>
 536 |     <!-- Register the custom Phing task -->
 537 |     <taskdef name="phploc" classname="PHPLocTask"
 538 |              classpath="${project.toolsdir}/phing-phploc" />
 539 |   </target>
 540 | 
 541 | <!-- ### Drupal Coder review
 542 | 
 543 | Review code using [Drupal coder module](http://drupal.org/project/coder).
 544 | 
 545 | Configuration of which modules and themes to review is done in
 546 | `build.properties`. If your modules use a common prefix such as
 547 | `yourproject_module1`, `yourproject_module2` you can add all modules with a
 548 | specific prefix. -->
 549 |   <target name="coder-review-d6"
 550 |           description="Review code using Drupal 6 Coder module"
 551 |           depends="init">
 552 |     <echo level="warning">Coder Review is not supported for Drupal 6 yet.
 553 |                           Check http://drupal.org/node/858330 for
 554 |                           patches/updates.</echo>
 555 |   </target>
 556 | 
 557 |   <target name="coder-review-d7"
 558 |           description="Review code using Drupal 7 Coder module"
 559 |           depends="init, clean, site-install">
 560 |     <!-- Setup properties for running Coder Review.
 561 |          For some reason these properties are not passed correctly through to
 562 |          subtargets when defining them within the phingcall. -->
 563 |     <property name="coder.review.command" value="coder-review"/>
 564 | 
 565 |     <!-- Download and enable the Coder Review module -->
 566 |     <phingcall target="enable-module">
 567 |       <property name="project" value="coder"/>
 568 |       <property name="project.version" value="7.x-1.0"/>
 569 |       <property name="module" value="coder_review"/>
 570 |     </phingcall>
 571 | 
 572 |     <!-- Perform actual coder review for each style -->
 573 |     <foreach target="coder-review" param="coder.review.type"
 574 |              list="comment,i18n,security,sql,style" />
 575 |   </target>
 576 | 
 577 | <!-- #### Perform coder review
 578 | 
 579 | This target requires properties set by calling targets coder-review-d6 or
 580 | coder-review-d7.
 581 | 
 582 | No need to run `init` here. This target should only be called from parent
 583 | `coder-review-*` targets. -->
 584 |   <target name="coder-review"
 585 |           depends="setup-phing-drush">
 586 |     <!-- Get a list of modules and themes matching the project prefix.
 587 |          These are the ones we are going to review. -->
 588 |     <drush command="pm-list" pipe="true" returnProperty="projects" />
 589 |     <!-- The project list is piped through a file as this seems to be
 590 |          the only way to handle filtering of values in Phing. -->
 591 |     <delete file="${project.logdir}/projects.txt" />
 592 |     <append text="${projects}" destFile="${project.logdir}/projects.txt" />
 593 | 
 594 |     <!-- Build a regular expression to match modules based on the
 595 |          set properties. The propery can contain prefixes separated by comma
 596 |          and/or spaces. The expression should be in the format
 597 |          `^(prefix1|prefix2|prefix3)_`. -->
 598 |     <php expression="'^(' . preg_replace('/(\s+|\s*,\s*)/', '|', '${project.code.prefix}') .')_'"
 599 |          returnProperty="project.code.prefix.regex"/>
 600 | 
 601 |     <loadfile property="project.code.projects"
 602 |               file="${project.logdir}/projects.txt">
 603 |       <filterchain>
 604 |         <linecontainsregexp>
 605 |           <regexp pattern="${project.code.prefix.regex}" />
 606 |         </linecontainsregexp>
 607 |         <!-- Prefix all lines with a space.
 608 |              We need the space as separator when we strip line breaks -->
 609 |         <prefixlines prefix=" " />
 610 |         <striplinebreaks />
 611 |       </filterchain>
 612 |     </loadfile>
 613 | 
 614 |     <!-- Cleanup the custom code property. Commas and multiple whitespace
 615 |          characters are reduced to a single space. -->
 616 |     <php expression="preg_replace('/(\s+|\s*,\s*)/', ' ', '${project.code.custom}')"
 617 |          returnProperty="project.code.custom"/>
 618 | 
 619 |     <!-- Execute coder review and output results in XML format-->
 620 |     <drush command="${coder.review.command}" assume="yes"
 621 |            pipe="yes" returnProperty="xml">
 622 |       <param>no-empty</param>
 623 |       <param>checkstyle</param>
 624 |       <param>minor</param>
 625 |       <param>${coder.review.type}</param>
 626 |       <!-- Review all the modules and themes matching the project prefix -->
 627 |       <param>${project.code.projects}</param>
 628 |       <!-- Review additional modules which do not match the prefix -->
 629 |       <param>${project.code.custom}</param>
 630 |     </drush>
 631 | 
 632 |     <!-- Write XML output to file -->
 633 |     <property name="coderreview.checkstyle.file"
 634 |               value="${project.logdir}/checkstyle-${coder.review.type}.xml" />
 635 |     <delete file="${coderreview.checkstyle.file}" />
 636 |     <append destFile="${coderreview.checkstyle.file}" text="${xml}" />
 637 | 
 638 |     <!-- Convert source from source extract to Category.Type format -->
 639 |     <php function="ucwords" returnProperty="type">
 640 |       <param value="${coder.review.type}"/>
 641 |     </php>
 642 |     <reflexive file="${coderreview.checkstyle.file}">
 643 |       <filterchain>
 644 |         <replaceregexp>
 645 |           <regexp pattern='source=".*"'
 646 |                   replace='source="Drupal.CoderReview.${type}"' />
 647 |         </replaceregexp>
 648 |       </filterchain>
 649 |     </reflexive>
 650 |   </target>
 651 | 
 652 | <!-- ### Review code using PHP_CodeSniffer
 653 | 
 654 | The purpose and outcome of this target is the same as the coder-review
 655 | targets. In general [PHP_CodeSniffer](http://pear.php.net/package/PHP_CodeSniffer/)
 656 | is faster to execute but there does not seem to be a complete ruleset which
 657 | covers all of the
 658 | [Drupal coding standards](http://drupal.org/coding-standards).
 659 | 
 660 | Consequently `coder-review-d6/7` and not `phpcs` is used for the main targets.
 661 | -->
 662 |     <target name="phpcs"
 663 |             description="Generate checkstyle.xml using PHP_CodeSniffer"
 664 |             depends="init">
 665 |       <!-- Clone a repository containing Drupal code guidelines for
 666 |            PHP_CodeSniffer. -->
 667 |       <phingcall target="setup-git-repo">
 668 |         <property name="repo.dir" value="${project.toolsdir}/drupalcs"/>
 669 |         <property name="repo.url" value="${phpcs.drupalcs.repository.url}" />
 670 |       </phingcall>
 671 |       <!-- There is no Phing task for PHP Codesniffer in v2.4.6.
 672 |            It's coming for v2.5. Execute while we wait. -->
 673 |       <exec command="phpcs --report=checkstyle
 674 |                     --report-file=${project.logdir}/checkstyle-codesniffer.xml
 675 |                     --standard=${project.toolsdir}/drupalcs/ruleset.xml
 676 |                     --extensions=php,inc
 677 |                     --ignore=*/contrib/*,*/*.features.*,*/*.field_group.inc,*/*.layout.*,*/*.pages_default.*,*/*.panels_default.*,*/*strongarm.inc,*/*.views_default.inc
 678 |                     ${project.sitesdir}"
 679 |             logoutput="true" />
 680 |     </target>
 681 | 
 682 |   <!-- ### Run simpletests
 683 | 
 684 | Execution of this target can be skipped by setting the
 685 |  `project.simpletest.skip` property from the command line or in other targets.
 686 | -->
 687 |   <target name="simpletest"
 688 |           description="Run all unit tests"
 689 |           depends="init, setup-phing-drush, site-install"
 690 |           unless="project.simpletest.skip">
 691 |     <!-- Enable simpletest module. If using Drupal 6 the module will be
 692 |          downloaded as well. -->
 693 |     <phingcall target="enable-module">
 694 |       <property name="module" value="simpletest"/>
 695 |     </phingcall>
 696 | 
 697 |     <if>
 698 |       <isset property="drupal.uri" />
 699 |       <then>
 700 | 
 701 |         <!-- Get a list of all available test cases -->
 702 |         <drush command="test-run" uri="${drupal.uri}" root="${project.drupal.dir}" returnProperty="tests" returnGlue="${line.separator}"/>
 703 | 
 704 |         <!-- The project list is piped through a file as this seems to be
 705 |              the only way to handle filtering of values in Phing. -->
 706 |         <delete file="${project.logdir}/tests.txt" />
 707 |         <append text="${tests}" destFile="${project.logdir}/tests.txt" />
 708 | 
 709 |         <!-- Build a regular expression to match test groups based on the
 710 |              set properties. The expression should be in the format
 711 |              `^\s?(prefix1|prefix2|prefix3)_`. -->
 712 |         <php expression="'^\s?(' . preg_replace('/(\s+|\s*,\s*)/', '|', '${project.code.prefix}') .').*'"
 713 |              returnProperty="project.code.prefix.regex"/>
 714 | 
 715 |         <!-- Load the list of tests but keep only the test groups matching our
 716 |              prefixes. -->
 717 |         <loadfile property="project.simpletest.tests"
 718 |                   file="${project.logdir}/tests.txt">
 719 |           <filterchain>
 720 |             <linecontainsregexp>
 721 |               <regexp pattern="${project.code.prefix.regex}" ignoreCase="true"/>
 722 |             </linecontainsregexp>
 723 |           </filterchain>
 724 |         </loadfile>
 725 | 
 726 |         <!-- Transform the list of filtered test groups in the form
 727 | 
 728 |         Groupname 1             Groupname 1
 729 |         Groupname 2             Groupname 2
 730 | 
 731 |         into a list of comma separated unique group names `Groupname 1,Groupname 2`. -->
 732 |         <php expression="implode(',', array_unique(preg_split('/(\s{2,}|\r|\n)/', trim('${project.simpletest.tests}', PREG_SPLIT_NO_EMPTY))))"
 733 |              returnProperty="project.simpletest.tests"/>
 734 | 
 735 |         <!-- Run the tests and generate JUnit XML reports. This requires
 736 |              Drush 4.5 or newer or [a patch](http://drupal.org/node/1109408). -->
 737 |         <drush command="test-run" uri="${drupal.uri}" root="${project.drupal.dir}" haltonerror="false">
 738 |           <param>${project.simpletest.tests}</param>
 739 |           <option name="xml">${project.testdir}</option>
 740 |           </drush>
 741 |       </then>
 742 |       <else>
 743 |         <echo msg="You must set the drupal.uri property to get simpletests working." />
 744 |       </else>
 745 |     </if>
 746 |     
 747 |   </target>
 748 | 
 749 | <!-- ### Generate documentation -->
 750 | <!-- #### Generate API Documentation
 751 | 
 752 | Uses [phpDocumentor](http://www.phpdoc.org/) to generate documentation. -->
 753 |   <target name="phpdoc"
 754 |           description="Generate API documentation using phpDocumentor">
 755 |     <mkdir dir="${project.buildir}/api"/>
 756 |     <phpdoc title="API Documentation"
 757 |             destdir="${project.builddir}/api"
 758 |             sourcecode="php"
 759 |             output="HTML:Smarty:PHP">
 760 |       <fileset refid="src.php" />
 761 |     </phpdoc>
 762 |   </target>
 763 | 
 764 | <!-- #### Generate a code browser
 765 | 
 766 | Generate a code browser for PHP files with syntax highlighting and
 767 | colored error-sections using
 768 | [PHP_CodeBrowser](https://github.com/Mayflower/PHP_CodeBrowser). -->
 769 |   <target name="phpcb"
 770 |           description="Aggregate tool output with PHP_CodeBrowser"
 771 |           depends="init">
 772 |     <mkdir dir="${project.builddir}/code-browser"/>
 773 |     <!-- There is no Phing target for PHP CodeBrowser so do a plain
 774 |          execute. -->
 775 |     <exec command="phpcb  --log ${project.logdir}
 776 |                           --source ${project.basedir}
 777 |                           --output ${project.builddir}/code-browser"
 778 |           logoutput="true" />
 779 |   </target>
 780 | 
 781 | <!-- ## Helper targets
 782 | 
 783 | These targets are used throughout the project and should normally not be
 784 | executed directly.-->
 785 | 
 786 | <!-- ### Initialization
 787 | 
 788 | This target sets up many of the common resources used throughout the build.
 789 | All other targets except dependencies for this target should depend on this
 790 | unless specifically stated why. -->
 791 |   <target name="init"
 792 |           depends="load-properties, setup-dirs, make, setup-filesets"
 793 |           unless="project.initialized">
 794 |     <!-- Set property to prevent target from being executed multiple times -->
 795 |     <property name="project.initialized" value="true"/>
 796 |   </target>
 797 | 
 798 | <!-- ### Load properties
 799 | 
 800 | Loads a set of project specific properties from a `.properties` file.
 801 | 
 802 | These properties contain information regarding the individual project and/or
 803 | environment such as which version of Drupal you are using, how to create a
 804 | database and the names of your custom modules.
 805 | 
 806 | All available properties are described and set to a default value in
 807 | [`build.default.properties`](https://raw.github.com/reload/phing-drupal-template/master/build.default.properties).
 808 | You should create your own properties file by copying the
 809 | `build.default.properties` file to the root directory, rename it
 810 | `build.properties` and modify it according to your project.
 811 | 
 812 | Both property files are loaded so your custom `build.properties` file should
 813 | only contain properties where you want to override the default value e.g. set
 814 | your custom module code prefix or use a special version of one of the build
 815 | tools. -->
 816 |   <target name="load-properties">
 817 |     <php function="dirname" returnProperty="phing.dir">
 818 |       <param value="${phing.file}"/>
 819 |     </php>
 820 | 
 821 |     <property name="project.basedir" value="${phing.dir}" />
 822 | 
 823 |     <!-- Use condition instead of unless property as we cannot unset properties in Phing -->
 824 |     <if>
 825 |       <or>
 826 |         <!-- `istrue` evaluates to true is value is not set we need to check
 827 |              `isset` as well -->
 828 |         <not><istrue value="${project.properties.loaded}" /></not>
 829 |         <not><isset property="project.properties.loaded" /></not>
 830 |       </or>
 831 |       <then>
 832 | <!-- By default Jenkins runs Phing from the directory containing the build
 833 | file.  If this file is located in a subdirectory - e.g. when using Phing Drupal as a submodule - we need to reset the project basedir and reload properties.
 834 | 
 835 | NB: This only works if the subdirectory is directly within the Drupal
 836 | root directory. -->
 837 |         <if>
 838 |           <!-- If `build.properties` exists then assume we have a
 839 |                project root directory -->
 840 |           <available file="${project.basedir}/../build.properties"/>
 841 |           <then>
 842 |             <resolvepath propertyName="project.basedir"
 843 |                          file="${project.basedir}/../"/>
 844 |           </then>
 845 |         </if>
 846 | 
 847 |         <!-- By default use default properties file
 848 |              `build.default.properties` -->
 849 |         <property name="project.properties.file"
 850 |                   value="${phing.dir}/build.default.properties" />
 851 |         <!-- Load the default properties.
 852 |              Override in case `load-properties` are called multiple times. -->
 853 |         <property file="${project.properties.file}" override="true" />
 854 | 
 855 |         <!-- Allow override using `build.properties` in build file
 856 |              directory -->
 857 |         <available file="${phing.dir}/build.properties"
 858 |                    property="project.properties.file"
 859 |                    value="${phing.dir}/build.properties" />
 860 |         <!-- Allow override using `build.properties` in project base
 861 |              directory -->
 862 |         <available file="${project.basedir}/build.properties"
 863 |                    property="project.properties.file"
 864 |                    value="${project.basedir}/build.properties" />
 865 | 
 866 |         <!-- Load the overriding properties. -->
 867 |         <property file="${project.properties.file}" override="true" />
 868 | 
 869 |         <!-- Set property to prevent unnecessary additional invocations of this target -->
 870 |         <property name="project.properties.loaded" value="true" />
 871 |       </then>
 872 |     </if>
 873 |   </target>
 874 | 
 875 | <!-- ### Setup directories
 876 | 
 877 | Define working directories - where the individual parts of the build are and
 878 | should be located. These are used in other targets.
 879 | 
 880 | This is part of the initialization of the build. This target should only be
 881 | called from `init` target. -->
 882 |   <target name="setup-dirs"
 883 |           depends="load-properties">
 884 |     <if>
 885 |       <isset property="drupal.make.dir"/>
 886 |       <then>
 887 |         <property name="project.drupal.dir"
 888 |                 value="${project.basedir}/${drupal.make.dir}" />
 889 |       </then>
 890 |       <else>
 891 |         <property name="project.drupal.dir"
 892 |                 value="${project.basedir}" />
 893 |       </else>
 894 |     </if>
 895 | 
 896 |     <property name="project.sitesdir"
 897 |               value="${project.drupal.dir}/${project.code.dir}" />
 898 |     <property name="project.builddir"
 899 |               value="${project.basedir}/build" />
 900 |     <property name="project.toolsdir"
 901 |               value="${project.builddir}/tools" />
 902 |     <property name="project.coveragedir"
 903 |               value="${project.builddir}/coverage" />
 904 |     <property name="project.logdir"
 905 |               value="${project.builddir}/logs" />
 906 |     <property name="project.testdir"
 907 |               value="${project.builddir}/tests" />
 908 |   </target>
 909 | 
 910 | <!-- ### Drush Make
 911 | 
 912 | Download and install the source code for the site using Drush Make.
 913 | 
 914 | This target is only executed if the project uses make files as configured
 915 | in the `build.properties` file. Execution can also be skipped by setting the
 916 | `project.make.skip` property from the command line or in other targets.
 917 | 
 918 | This is part of the initialization of the build. This target should only be
 919 | called from `init` target. -->
 920 |   <target name="make"
 921 |           depends="load-properties, setup-phing-drush"
 922 |           if="drupal.make.file">
 923 |     <if>
 924 |       <or>
 925 |         <not><isset property="project.make.skip"/></not>
 926 |         <not><istrue value="${project.make.skip}"/></not>
 927 |       </or>
 928 |       <then>
 929 |         <!-- Delete any prexisting builds -->
 930 |         <delete dir="${project.drupal.dir}"/>
 931 | 
 932 |         <!-- If the make file does not include a core Drupal project we need
 933 |              to download one separately. This should be defined in
 934 |              `build.properties`. -->
 935 |         <if>
 936 |           <and>
 937 |             <isset property="drupal.make.nocore"/>
 938 |             <istrue value="${drupal.make.nocore}"/>
 939 |           </and>
 940 |           <then>
 941 |             <!-- Download the appropriate version of Drupal -->
 942 |             <drush command="dl" assume="yes">
 943 |               <param>drupal-${drupal.version}</param>
 944 |               <option name="drupal-project-rename">${drupal.make.dir}</option>
 945 |             </drush>
 946 | 
 947 |             <!-- Make the project in the project code directory. If using
 948 |                  a directory inside the `sites` folder modules can be tested
 949 |                  faster and easier when using the minimal profile. -->
 950 |             <drush command="make" assume="yes">
 951 |               <param>${drupal.make.file}</param>
 952 |               <option name="contrib-destination">${drupal.make.dir}/${project.code.dir}</option>
 953 |               <option name="no-core"/>
 954 |             </drush>
 955 | 
 956 |             <!-- Copy the install profile bundled with the make file to the
 957 |                  appropriate directory. -->
 958 |             <copy todir="${project.drupal.dir}/profiles/${drupal.profile}/">
 959 |               <fileset dir="${project.basedir}">
 960 |                 <include name="${drupal.profile}.*" />
 961 |               </fileset>
 962 |             </copy>
 963 |           </then>
 964 |           <else>
 965 |             <drush command="make" assume="yes">
 966 |               <param>${drupal.make.file}</param>
 967 |               <param>${drupal.make.dir}</param>
 968 |             </drush>
 969 |           </else>
 970 |         </if>
 971 | 
 972 |         <if>
 973 |           <isset property="drupal.make.rewritebase" />
 974 |           <then>
 975 |             <reflexive file="${project.drupal.dir}/.htaccess">
 976 |               <filterchain>
 977 |                 <replaceregexp>
 978 |                   <regexp pattern="# RewriteBase [\w/]*" replace="RewriteBase ${drupal.make.rewritebase}"/>
 979 |                 </replaceregexp>
 980 |               </filterchain>
 981 |             </reflexive>
 982 |           </then>
 983 |         </if>
 984 | 
 985 |         <!-- Set property to prevent target from being executed multiple times -->
 986 |         <property name="project.make.skip" value="true"/>
 987 |       </then>
 988 |       <else>
 989 |         <echo>
 990 |           Skipping drush make.${line.separator}
 991 |           drupal.make.skip has been set to ${project.make.skip}.
 992 |         </echo>
 993 |       </else>
 994 |     </if>
 995 |   </target>
 996 | 
 997 | <!-- ### Setup file sets
 998 | 
 999 | Setup file sets - patterns for different aspects of the source code.
1000 | These are used in other targets.
1001 | 
1002 | This is part of the initialization of the build. This target should only be
1003 | called from `init` target. -->
1004 |   <target name="setup-filesets"
1005 |           depends="load-properties">
1006 |     <!-- Define pattern sets for future reference -->
1007 | 
1008 |     <!-- PHP files -->
1009 |     <patternset id="php">
1010 |       <include name="**/*.php" />
1011 |       <include name="**/*.module" />
1012 |       <include name="**/*.install" />
1013 |       <include name="**/*.inc" />
1014 |       <include name="**/*.profile" />
1015 |       <include name="**/*.test" />
1016 |     </patternset>
1017 | 
1018 |     <!-- Javascript files -->
1019 |     <patternset id="js">
1020 |       <include name="**/*.js" />
1021 |       <!-- Minimized JavaScript files should not be analyzed.
1022 |            In their optimized state they can not be expexted
1023 |            to conform to coding standards. -->
1024 |       <exclude name="**/*.min.js" />
1025 |     </patternset>
1026 | 
1027 |     <!-- CSS files -->
1028 |     <patternset id="css">
1029 |       <include name="**/*.css" />
1030 |     </patternset>
1031 | 
1032 |     <!-- Directories for community contributed code. We exclude these from
1033 |          code analysis as we cannot be held responsible for any problems
1034 |          here. -->
1035 |     <patternset id="contrib">
1036 |       <exclude name="**/contrib/**/*.*" />
1037 |       <exclude name="**/libraries/**/*.*" />
1038 |     </patternset>
1039 | 
1040 |     <!-- We exclude generated files from We exclude these from code analysis
1041 |          as we cannot be held responsible for any problems here. -->
1042 |     <patternset id="generated">
1043 |       <exclude name="**/*.features.*" />
1044 |       <exclude name="**/*.field_group.inc" />
1045 |       <exclude name="**/*.layouts.inc" />
1046 |       <exclude name="**/*.pages_default.inc" />
1047 |       <exclude name="**/*.panels_default.inc" />
1048 |       <exclude name="**/*.strongarm.inc" />
1049 |       <exclude name="**/*.views_default.inc" />
1050 |     </patternset>
1051 | 
1052 |     <!-- Define file sets for future reference -->
1053 | 
1054 |     <!-- All PHP files -->
1055 |     <fileset id="src.php" dir="${project.drupal.dir}">
1056 |       <patternset refid="php"/>
1057 |     </fileset>
1058 | 
1059 |     <!-- Custom PHP files -->
1060 |     <fileset id="src.php.custom" dir="${project.sitesdir}">
1061 |       <patternset refid="php"/>
1062 |       <patternset refid="contrib"/>
1063 |       <patternset refid="generated"/>
1064 |     </fileset>
1065 | 
1066 |     <!-- All Javascript files -->
1067 |     <fileset id="src.js" dir="${project.drupal.dir}">
1068 |       <patternset refid="js" />
1069 |     </fileset>
1070 | 
1071 |     <!-- Custom Javascript files -->
1072 |     <fileset id="src.js.custom" dir="${project.sitesdir}">
1073 |       <patternset refid="js" />
1074 |       <patternset refid="contrib" />
1075 |     </fileset>
1076 | 
1077 |     <!-- All CSS files -->
1078 |     <fileset id="src.css" dir="${project.basedir}">
1079 |       <patternset refid="css" />
1080 |     </fileset>
1081 | 
1082 |     <!-- Custom CSS files -->
1083 |     <fileset id="src.css.custom" dir="${project.sitesdir}">
1084 |       <patternset refid="css" />
1085 |       <patternset refid="contrib" />
1086 |     </fileset>
1087 | 
1088 |   </target>
1089 | 
1090 | <!-- ### Clean working environment  -->
1091 |   <target name="clean"
1092 |           description="Clean up and create artifact directories"
1093 |           depends="setup-dirs"
1094 |           unless="project.cleaned">
1095 |     <!-- Delete any existing artifacts from a previous build.
1096 |          Do not delete builddir. It may contain the build file! -->
1097 |     <delete dir="${project.toolsdir}"/>
1098 |     <delete dir="${project.coveragedir}"/>
1099 |     <delete dir="${project.logdir}"/>
1100 |     <delete dir="${project.testdir}"/>
1101 |     <!-- Verbose. We need to make sure any database is deleted. Reinstalling
1102 |          the site with an existing database causes the build to fail. -->
1103 |     <delete file="${project.drupal.dir}/database.sqlite" verbose="true" />
1104 |     <!-- Remove leftover Drupal simpletest databases -->
1105 |     <delete>
1106 |       <fileset dir="${project.basedir}">
1107 |         <include name="database.sqlite-simpletest*"/>
1108 |       </fileset>
1109 |     </delete>
1110 | 
1111 |     <!-- Recreate directories for artifacts -->
1112 |     <mkdir dir="${project.toolsdir}"/>
1113 |     <mkdir dir="${project.coveragedir}"/>
1114 |     <mkdir dir="${project.logdir}"/>
1115 |     <mkdir dir="${project.testdir}"/>
1116 | 
1117 |     <!-- Set property to prevent target from being executed multiple times -->
1118 |     <property name="project.cleaned" value="true"/>
1119 |   </target>
1120 | 
1121 | <!-- ### Install a Drupal site
1122 | 
1123 | This initializes a Drupal site using a installation profile.
1124 | 
1125 | Configuration of which installation profile and database to use in done in
1126 | `build.properties`. -->
1127 |   <target name="site-install"
1128 |           depends="init, setup-phing-drush"
1129 |           unless="project.installed">
1130 |     <drush command="site-install" assume="yes">
1131 |       <option name="db-url">${drupal.db.url}</option>
1132 |       <param>${drupal.profile}</param>
1133 |     </drush>
1134 |     <!-- Fix permissions for the default site directory and settings. The
1135 |          owner must be able to delete the directories during subsequent
1136 |          builds. -->
1137 |     <chmod file="${project.drupal.dir}/sites/default/"
1138 |            mode="0755" failonerror="true"/>
1139 |     <chmod file="${project.drupal.dir}/sites/default/default.settings.php"
1140 |            mode="0755" failonerror="true"/>
1141 | 
1142 |     <!-- Set property to prevent target from being executed multiple times -->
1143 |     <property name="project.installed" value="true"/>
1144 |   </target>
1145 | 
1146 |   <!-- ### Download and enable a project/module -->
1147 |   <target name="enable-module"
1148 |           depends="setup-phing-drush">
1149 |     <!-- If project is not set then we assume that the module name is also
1150 |          the project name. -->
1151 |     <property name="project" value="${module}" override="no"/>
1152 | 
1153 |     <!-- If the module is not already available then download it -->
1154 |     <drush command="pm-list" returnProperty="modules.available"/>
1155 |     <php function="strpos" returnProperty="module.available">
1156 |       <param>${modules.available}</param>
1157 |       <param>${module}</param>
1158 |     </php>
1159 |     <if>
1160 |       <not><istrue value="${module.available}"/></not>
1161 |       <then>
1162 |         <!-- Download specific version if specified -->
1163 |         <condition property="download" value="${project}-${project.version}">
1164 |           <isset property="project.version"/>
1165 |         </condition>
1166 |         <property name="download" value="${project}" override="false"/>
1167 | 
1168 |         <drush command="pm-download" assume="yes">
1169 |           <param>${download}</param>
1170 |         </drush>
1171 |       </then>
1172 |     </if>
1173 | 
1174 |     <!-- Enable the module -->
1175 |     <drush command="pm-enable" assume="yes">
1176 |       <param>${module}</param>
1177 |     </drush>
1178 |   </target>
1179 | 
1180 |   <!-- ### Clone a git repository -->
1181 |   <target name="setup-git-repo">
1182 |     <!-- Only clone if repository does not exist already -->
1183 |     <if>
1184 |       <not><available file="${repo.dir}" /></not>
1185 |       <then>
1186 |         <!-- Set revision to HEAD if not already defined -->
1187 |         <property name="repo.revision" value="HEAD" override="false"/>
1188 | 
1189 |         <echo>Cloning ${repo.url} ${repo.revision} into ${repo.dir}</echo>
1190 |         <!-- The [`gitclone` task](http://www.phing.info/docs/guide/stable/chapters/appendixes/AppendixC-OptionalTasks.html#GitCloneTask)
1191 |              does not seem to work. Use exec instead. -->
1192 |         <exec command="git clone ${repo.url} ${repo.dir}" />
1193 |         <exec command="git checkout ${repo.revision}" dir="${repo.dir}"/>
1194 |       </then>
1195 |     </if>
1196 |   </target>
1197 | 
1198 |   <!-- ### Download and apply a patch -->
1199 |   <target name="apply-http-patch">
1200 |     <php function="basename" returnProperty="patch.file">
1201 |       <param>${patch.url}</param>
1202 |     </php>
1203 | 
1204 |     <!-- If patch has already been downloaded then we assume it has also been
1205 |          applied -->
1206 |     <if>
1207 |       <not><available file="${project.toolsdir}/${patch.file}"/></not>
1208 |       <then>
1209 |         <httpget url="${patch.url}"
1210 |                  dir="${project.toolsdir}"
1211 |                  proxy="${phing.httpget.proxy}" />
1212 |         <patch patchfile="${project.toolsdir}/${patch.file}"
1213 |                dir="${patch.dir}" haltonfailure="true"/>
1214 |       </then>
1215 |     </if>
1216 |   </target>
1217 | 
1218 |   <!-- ### Setup Phing Drush integration -->
1219 |   <target name="setup-phing-drush"
1220 |           depends="setup-dirs" >
1221 |     <!-- Clone the project -->
1222 |     <phingcall target="setup-git-repo">
1223 |       <property name="repo.dir"
1224 |                 value="${project.toolsdir}/phing-drush"/>
1225 |       <property name="repo.url"
1226 |                 value="${phing.drush.repository.url}" />
1227 |       <property name="repo.revision"
1228 |                 value="${phing.drush.repository.revision}" />
1229 |     </phingcall>
1230 | 
1231 |     <!-- Register as custom Phing task -->
1232 |     <taskdef name="drush" classname="DrushTask"
1233 |              classpath="${project.toolsdir}/phing-drush" />
1234 | 
1235 |     <!-- Run drush from the project Drupal directory -->
1236 |     <property name="drush.root" value="${project.drupal.dir}"/>
1237 |   </target>
1238 | 
1239 |    <!-- ### Setup Rhino
1240 | 
1241 | [Mozilla Rhino](http://www.mozilla.org/rhino/) is an open-source implementation of JavaScript written in Java. -->
1242 |    <target name="setup-rhino"
1243 |            depends="setup-dirs"
1244 |            unless="project.rhino.setup">
1245 |      <property name="rhino.dir"
1246 |                value="${project.toolsdir}/rhino" />
1247 |      <php function="basename" returnProperty="rhino.basename">
1248 |        <param value="${rhino.url}" />
1249 |        <!-- We assume that the version of Rhino used is a distribution
1250 |             where the filename ends in `.zip` -->
1251 |        <param value=".zip" />
1252 |      </php>
1253 | 
1254 |      <!-- Other targets use this property to determine the location of the
1255 |           `js.jar` file -->
1256 |      <property name="rhino.jar"
1257 |                value="${rhino.dir}/${rhino.basename}/js.jar"/>
1258 | 
1259 |      <!-- If the Rhino js.jar file is not available then download and
1260 |           unpack Rhino -->
1261 |      <if>
1262 |        <not><available file="${rhino.jar}"/></not>
1263 |        <then>
1264 |          <mkdir dir="${rhino.dir}" />
1265 |          <php function="basename" returnProperty="rhino.zipfile">
1266 |            <param value="${rhino.url}" />
1267 |          </php>
1268 |          <httpget url="${rhino.url}"
1269 |                   dir="${rhino.dir}"
1270 |                   proxy="${phing.httpget.proxy}"/>
1271 |          <unzip file="${rhino.dir}/${rhino.zipfile}"
1272 |                 todir="${rhino.dir}" />
1273 |        </then>
1274 |      </if>
1275 | 
1276 |      <!-- Set property to prevent unnecessary additional invocations of this
1277 |           target -->
1278 |      <property name="project.rhino.setup" value="true" />
1279 |    </target>
1280 | 
1281 |    <!-- ### Build documentation using Phrocco
1282 | 
1283 | Generate documentation for the build script using [Phrocco](https://github.com/oneblackbear/phrocco) and prepare for pushing changes to [GitHub pages](http://pages.github.com/).
1284 | 
1285 | To use this task you mush have a version of Phrocco with support for XML
1286 | parsing installed. The task is primarily for template developers. -->
1287 |    <target name="phrocco"
1288 |            depends="clean">
1289 |      <!-- Determine current branch -->
1290 |      <exec command="git status --branch --short"
1291 |            outputProperty="phrocco.code.status" />
1292 |      <php expression="array_shift(explode('...', trim('${phrocco.code.status}', '# '), 2))"
1293 |           returnProperty="phrocco.code.branch"/>
1294 | 
1295 |      <!-- Generate documentation in the root build directory -->
1296 |      <exec command="phrocco -i . -o . -l xml"
1297 |            passthru="true" checkreturn="true" />
1298 |      <!-- Checkout the GitHub pages branch -->
1299 |      <exec command="git checkout gh-pages"
1300 |            passthru="true" checkreturn="true"/>
1301 |      <!-- We use the documentation for build.xml and root file so rename
1302 |           it to index.html -->
1303 |      <move file="build.html" tofile="index.html" overwrite="true"
1304 |            haltonerror="true" />
1305 | 
1306 |      <property name="phrocco.commit.mode" value=""/>
1307 |      <!-- If the local documentation branch is ahead then we have other
1308 |           changes which have not been pushed yet. These have probably also
1309 |           been generated by this script so amend these changes. -->
1310 |      <exec command="git status --branch --short"
1311 |            outputProperty="phrocco.docs.status" />
1312 |      <if>
1313 |        <contains string="${phrocco.docs.status}" substring="[ahead"/>
1314 |        <then>
1315 |          <property name="phrocco.commit.mode" value="--amend"
1316 |                    override="true" />
1317 |        </then>
1318 |      </if>
1319 | 
1320 |      <!-- Commit the changes -->
1321 |      <exec command="git commit --all -m 'Documentation update' ${phrocco.commit.mode}"
1322 |            passthru="true" checkreturn="true"/>
1323 | 
1324 |      <!-- Return to the main branch -->
1325 |      <exec command="git checkout ${phrocco.code.branch}"
1326 |            passthru="true" checkreturn="true"/>
1327 |    </target>
1328 | 
1329 | </project>
1330 | 


--------------------------------------------------------------------------------