Merge pull request #418 from koenpunt/test-comment

update test instructions

Author: koenpunt

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to PHP ActiveRecord #
+
+We always appreciate contributions to PHP ActiveRecord, but we are not always able to respond as quickly as we would like.
+Please do not take delays personal and feel free to remind us by commenting on issues.
+
+### Testing ###
+
+PHP ActiveRecord has a full set of unit tests, which are run by PHPUnit.
+
+In order to run these unit tests, you need to install the required packages using [Composer](https://getcomposer.org/):
+
+```sh
+composer install
+```
+
+After that you can run the tests by invoking the local PHPUnit
+
+To run all test simply use:
+
+```sh
+vendor/bin/phpunit
+```
+
+Or run a single test file by specifying its path:
+
+```sh
+vendor/bin/phpunit test/InflectorTest.php
+```

README.md

@@ -37,7 +37,7 @@ Of course, there are some differences which will be obvious to the user if they
 - PostgreSQL
 - Oracle
 
-# Features ##
+## Features ##
 
 - Finder methods
 - Dynamic finder methods
@@ -50,11 +50,11 @@ Of course, there are some differences which will be obvious to the user if they
 - Support for multiple adapters
 - Miscellaneous options such as: aliased/protected/accessible attributes
 
-### Installation ##
+## Installation ##
 
 Setup is very easy and straight-forward. There are essentially only three configuration points you must concern yourself with:
 
-1. Setting the model auto_load directory.
+1. Setting the model autoload directory.
 2. Configuring your database connections.
 3. Setting the database connection to use for your environment.
 
@@ -164,3 +164,7 @@ $post->delete();
 # DELETE FROM `posts` WHERE id=1
 echo $post->title; # 'New real title'
 ```
+
+## Contributing ##
+
+Please refer to [CONTRIBUTING.md](https://github.com/jpfuentes2/php-activerecord/blob/master/CONTRIBUTING.md) for information on how to contribute to PHP ActiveRecord.

composer.json

@@ -10,8 +10,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "3.7.*",
-        "pear/pear_exception": "1.0.*@dev",
-        "pear/Log": "dev-master"
+        "pear/pear_exception": "1.0-beta1",
+        "pear/log": "~1.12"
     },
     "autoload": {
         "files": [ "ActiveRecord.php" ]

test/helpers/config.php

@@ -1,23 +1,29 @@
 <?php
+
 /**
- * In order to run these unit tests, you need to install:
- *  - PHPUnit
- *  - PEAR Log (otherwise logging SQL queries will be disabled)
- *  - Memcache (otherwise Caching tests will not be executed)
- *  
- * To run all tests : phpunit AllTests.php --slow-tests
- * To run a specific test : phpunit ????Test.php 
- */
-
-set_include_path(get_include_path() . PATH_SEPARATOR . './vendor/phpunit/PHPUnit'
-									. PATH_SEPARATOR . './vendor/pear/log');
-
-@include_once 'Log.php';
-@include_once 'Log/file.php';
-require_once 'PHPUnit/Framework/TestCase.php';
+ * In order to run these unit tests, you need to install the required packages using Composer:
+ *
+ *    $ composer install
+ *
+ * After that you can run the tests by invoking the local PHPUnit
+ *
+ * To run all test simply use:
+ *
+ *    $ vendor/bin/phpunit
+ *
+ * Or run a single test file by specifying its path:
+ *
+ *    $ vendor/bin/phpunit test/InflectorTest.php
+ *
+ **/
+
+require_once 'vendor/autoload.php';
+
 require_once 'SnakeCase_PHPUnit_Framework_TestCase.php';
+
 require_once 'DatabaseTest.php';
 require_once 'AdapterTest.php';
+
 require_once __DIR__ . '/../../ActiveRecord.php';
 
 // whether or not to run the slow non-crucial tests
@@ -65,7 +71,7 @@
 	}
 
 	if ($GLOBALS['show_warnings']  && !isset($GLOBALS['show_warnings_done']))
-	{ 
+	{
 		if (!extension_loaded('memcache'))
 			echo "(Cache Tests will be skipped, Memcache not found.)\n";
 	}