Add .gitignore; Update docs

Author: MGatner

README.md

@@ -10,22 +10,33 @@ framework without being integrated into a specific project.
 For more on Testing in CodeIgniter 4 visit the
 [User Guide](https://codeigniter4.github.io/CodeIgniter4/testing/).
 
-## Install
+## Installation
 
-1. Clone this repo and merge the **tests** folder and **phpunit.xml.dist** and
-**composer.json**<sup>1</sup> files from **src/** into the root of your module. 
+### New Projects
+
+1. Clone this repo and merge the all files from **src/** into the root of your module. 
 2. From your package root run `composer install` to install all the required support packages.
-3. Run `composer test` to initiate the tests.
+3. Start your module code in **src/** and add your namespace to **composer.json**'s `autoload`
+4. Run `composer test` to initiate the tests.
+
+### Existing Projects
 
-<sup>1</sup> Note: Unless you are starting fresh you likely will already have your own version of
-**composer.json**, in which case you will need to be sure to merge the following settings
-for **CIModuleTests**:
+Unless you are starting fresh you likely will already have your own versions of some of the
+package files in **src/**. In this case you will need to be sure to merge some necessary
+settings for **CIModuleTests**. In **composer.json**:
 * `repositories` needs an entry for `https://github.com/codeigniter4/CodeIgniter4`
 * `require-dev` needs the CodeIgniter 4 repo, PHPUnit, and Mockery
 * `autoload-dev` must supply the PSR4 namespace for the test supports
-
 See the provided [composer.json](src/composer.json) for examples.
 
+Also review **src/.gitignore** for helpful additions so you don't track test results.
+
+### phpunit.xml
+
+**src/** includes a ready-to-use PHPUnit template in **phpunit.xml.dist**. You can keep this
+as is but if you plan to add environment info (like database connections) be sure to rename
+it to **phpunit.xml** and prevent it from being tracked via **.gitignore**.
+
 ## Customizing
 
 The **_support** directory comes loaded with easy-to-use examples of test cases and their
@@ -52,10 +63,10 @@ Tests are individual methods within each file. Method names must start with the
 
 ### Database Tests
 
-If you are using database tests that require a live database connect you will need to edit
-**phpunit.xml.dist**, uncomment the database configuration lines and add your connection
-details. Example directories and files are provided for test Seeds and Models, which you
-can modify or replace with your own. Also be sure to modify
+If you are using database tests that require a live database connect you will need to
+rename **phpunit.xml.dist** to **phpunit.xml**, uncomment the database configuration lines
+and add your connection details. Example directories and files are provided for test Seeds
+and Models, which you can modify or replace with your own. Also be sure to modify
 **tests/_support/DatabaseTestCase.php** to point to your seed and include any additional
 steps in `setUp()`.
 

src/.gitignore

@@ -0,0 +1,104 @@
+#-------------------------
+# Operating Specific Junk Files
+#-------------------------
+
+# OS X
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# OS X Thumbnails
+._*
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# Linux
+*~
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+#-------------------------
+# Environment Files
+#-------------------------
+# These should never be under version control,
+# as it poses a security risk.
+.env
+.vagrant
+Vagrantfile
+
+#-------------------------
+# Temporary Files
+#-------------------------
+php_errors.log
+
+#-------------------------
+# Test Files
+#-------------------------
+build/*
+
+# Don't save phpunit under version control.
+phpunit
+
+#-------------------------
+# Composer
+#-------------------------
+vendor/
+composer.lock
+
+#-------------------------
+# IDE / Development Files
+#-------------------------
+
+# Modules Testing
+_modules/*
+
+# phpenv local config
+.php-version
+
+# Jetbrains editors (PHPStorm, etc)
+.idea/
+*.iml
+
+# Netbeans
+nbproject/
+build/
+nbbuild/
+dist/
+nbdist/
+nbactions.xml
+nb-configuration.xml
+.nb-gradle/
+
+# Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+*.sublime-workspace
+*.sublime-project
+.phpintel
+/api/
+
+# Visual Studio Code
+.vscode/
+
+/results/
+/phpunit*.xml

src/tests/session/ExampleSessionTest.php

@@ -11,7 +11,7 @@ public function testSessionSimple()
 	{
 		$this->session->set('logged_in', 123);
 
-		$value = $this->session->get('logged_in')
+		$value = $this->session->get('logged_in');
 
 		$this->assertEquals(123, $value);
 	}