Implements caching capabilities with examples ( requires `doctrine-ca…

…che` ) and PSR compatibility. I've also added a generic build script to obtain some metrics and generated documentation.
johannesx75 · Mar 1, 2014 · a310041 · a310041
2 parents e5e04fa + 5f03c04
commit a310041
Show file tree

Hide file tree

Showing 382 changed files with 2,950 additions and 1,841 deletions.
diff --git a/.gitignore b/.gitignore
@@ -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
diff --git a/build.xml b/build.xml
@@ -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>
diff --git a/build/phpdox.xml b/build/phpdox.xml
@@ -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>
diff --git a/build/phpmd.xml b/build/phpmd.xml
@@ -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>
diff --git a/build/phpunit.xml b/build/phpunit.xml
@@ -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>
diff --git a/composer.json b/composer.json
@@ -18,7 +18,11 @@
         "guzzle/guzzle": ">=0.7"
     },
     "require-dev": {
-        "phpunit/phpunit": ">=3.7"
+        "phpunit/phpunit": ">=3.7",
+        "doctrine/cache": ">=1.3.0"
+    },
+    "suggest": {
+        "doctrine/cache": "This library is required if you want to make use of caching features."
     },
     "autoload": {
         "psr-0": { "Tmdb\\": "lib/" }

diff --git a/examples/account/api/account.php b/examples/account/api/account.php
@@ -10,8 +10,8 @@
  * @copyright (c) 2013, Michael Roterman
  * @version 0.0.1
  */
-require_once('../../../vendor/autoload.php');
-require_once('../../../apikey.php');
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
 
 $token = new \Tmdb\ApiToken(TMDB_API_KEY);
 $client = new \Tmdb\Client($token);
@@ -21,4 +21,4 @@
 
 $account = $client->getAccountApi()->getAccount();
 
-var_dump($account);
+var_dump($account);
diff --git a/examples/account/api/favorite.php b/examples/account/api/favorite.php
@@ -10,8 +10,8 @@
  * @copyright (c) 2013, Michael Roterman
  * @version 0.0.1
  */
-require_once('../../../vendor/autoload.php');
-require_once('../../../apikey.php');
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
 
 $token = new \Tmdb\ApiToken(TMDB_API_KEY);
 $client = new \Tmdb\Client($token);
@@ -21,4 +21,4 @@
 
 $favorite = $client->getAccountApi()->favorite(TMDB_ACCOUNT_ID, 97020, true);
 
-var_dump($favorite);
+var_dump($favorite);
diff --git a/examples/account/api/favorite_movies.php b/examples/account/api/favorite_movies.php
@@ -10,8 +10,8 @@
  * @copyright (c) 2013, Michael Roterman
  * @version 0.0.1
  */
-require_once('../../../vendor/autoload.php');
-require_once('../../../apikey.php');
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
 
 $token = new \Tmdb\ApiToken(TMDB_API_KEY);
 $client = new \Tmdb\Client($token);
@@ -21,4 +21,4 @@
 
 $favorite_movies = $client->getAccountApi()->getFavoriteMovies(TMDB_ACCOUNT_ID);
 
-var_dump($favorite_movies);
+var_dump($favorite_movies);
diff --git a/examples/account/api/lists.php b/examples/account/api/lists.php
@@ -10,8 +10,8 @@
  * @copyright (c) 2013, Michael Roterman
  * @version 0.0.1
  */
-require_once('../../../vendor/autoload.php');
-require_once('../../../apikey.php');
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
 
 $token = new \Tmdb\ApiToken(TMDB_API_KEY);
 $client = new \Tmdb\Client($token);
@@ -21,4 +21,4 @@
 
 $lists = $client->getAccountApi()->getLists(TMDB_ACCOUNT_ID);
 
-var_dump($lists);
+var_dump($lists);
diff --git a/examples/account/api/rated_movies.php b/examples/account/api/rated_movies.php
@@ -10,8 +10,8 @@
  * @copyright (c) 2013, Michael Roterman
  * @version 0.0.1
  */
-require_once('../../../vendor/autoload.php');
-require_once('../../../apikey.php');
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
 
 $token = new \Tmdb\ApiToken(TMDB_API_KEY);
 $client = new \Tmdb\Client($token);
@@ -21,4 +21,4 @@
 
 $rated_movies = $client->getAccountApi()->getRatedMovies(TMDB_ACCOUNT_ID);
 
-var_dump($rated_movies);
+var_dump($rated_movies);
diff --git a/examples/account/api/watchlist.php b/examples/account/api/watchlist.php
@@ -10,8 +10,8 @@
  * @copyright (c) 2013, Michael Roterman
  * @version 0.0.1
  */
-require_once('../../../vendor/autoload.php');
-require_once('../../../apikey.php');
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
 
 $token = new \Tmdb\ApiToken(TMDB_API_KEY);
 $client = new \Tmdb\Client($token);
@@ -21,4 +21,4 @@
 
 $watchlist = $client->getAccountApi()->watchlist(TMDB_ACCOUNT_ID, 97020, true);
 
-var_dump($watchlist);
+var_dump($watchlist);
diff --git a/examples/account/api/watchlist_movies.php b/examples/account/api/watchlist_movies.php
@@ -10,8 +10,8 @@
  * @copyright (c) 2013, Michael Roterman
  * @version 0.0.1
  */
-require_once('../../../vendor/autoload.php');
-require_once('../../../apikey.php');
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
 
 $token = new \Tmdb\ApiToken(TMDB_API_KEY);
 $client = new \Tmdb\Client($token);
@@ -21,4 +21,4 @@
 
 $watchlist_movies = $client->getAccountApi()->getMovieWatchlist(TMDB_ACCOUNT_ID);
 
-var_dump($watchlist_movies);
+var_dump($watchlist_movies);
diff --git a/examples/account/model/account.php b/examples/account/model/account.php
@@ -10,8 +10,8 @@
  * @copyright (c) 2013, Michael Roterman
  * @version 0.0.1
  */
-require_once('../../../vendor/autoload.php');
-require_once('../../../apikey.php');
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
 
 $token  = new \Tmdb\ApiToken(TMDB_API_KEY);
 $client = new \Tmdb\Client($token);
@@ -23,4 +23,3 @@
 $account           = $accountRepository->getAccount();
 
 var_dump($account);
-