Update references for Projects

Author: MGatner

README.md

@@ -1,11 +1,11 @@
-# ModuleTests
+# ProjectTests
 
-PHPUnit testing scaffold for CodeIgniter 4 modules
+PHPUnit testing scaffold for CodeIgniter 4 projects
 
 ## Overview
 
-Not a module itself but a testing scaffold for CodeIgniter 4 modules,
-**module-tests** makes it easy to setup PHPUnit tests in your modules.
+Not a module itself but a testing scaffold for CodeIgniter 4 projects,
+**ProjectTests** makes it easy to setup PHPUnit tests in your projects.
 
 To read more on Unit Testing in CodeIgniter 4 visit the
 [User Guide](https://codeigniter4.github.io/userguide/testing/index.html).
@@ -29,7 +29,7 @@ project root. Add the following lines to **composer.json**:
 	},
 	"autoload-dev": {
 		"psr-4": {
-			"ModuleTests\\Support\\": "tests/_support"
+			"ProjectTests\\Support\\": "tests/_support"
 		}
 	},
 	"scripts": {
@@ -56,7 +56,7 @@ folder if you need a starting point.
 ## Updating
 
 As this repo is updated with bugfixes and improvements you will want to update your
-modules that use it. Because files need to be copied in place manually you will have to
+projects that use it. Because files need to be copied in place manually you will have to
 handle updates manually by cloning or downloading this repo and merging changed files
 into your project. "Watch" this repo to be notified of new releases and changes.
 
@@ -74,3 +74,10 @@ in **build/logs/**.
 ## Code Coverage
 
 See the docs on [Code Coverage](docs/COVERAGE.md).
+
+## Module Testing
+
+**ProjectTests** is designed to be added to applications using CodeIgniter 4 as their core
+framework. If you are looking for a testing scaffold for your modular library intended to
+be included into other project, check out
+[Codeigniter4Projects/ModuleTests](https://github.com/codeigniter4projects/module-tests).

docs/COVERAGE.md

@@ -5,21 +5,21 @@
 
 ## Overview
 
-**ci4-module-tests** comes preconfigured to handle code coverage in addition to the unit tests.
+**ProjectTests** comes preconfigured to handle code coverage in addition to the unit tests.
 You will need to have a code coverage driver installed to use this feature, such as
 [Xdebug](https://xdebug.org).
 
 ## Setup
 
-**ci4-module-tests** assumes your source code is in **src/**; if your code is somewhere else
+**ProjectTests** assumes your source code is in **src/**; if your code is somewhere else
 then you will need to modify the following line in your PHPUnit XML file:
 ```
 	<directory suffix=".php">./src</directory>
 ```
 
 ## PHPUnit.xml
 
-**ci4-module-tests** includes a ready-to-use PHPUnit template in **phpunit.xml.dist**.
+**ProjectTests** includes a ready-to-use PHPUnit template in **phpunit.xml.dist**.
 Common practice is to create a local copy of this file as **phpunit.xml** and add any
 sensitive or environment info (like database connections). Prevent **phpunit.xml** from
 being tracked in your repo by adding it to **.gitignore**.
@@ -30,7 +30,7 @@ being tracked in your repo by adding it to **.gitignore**.
 
 In addition to the code source mentioned above, PHPUnit can be configured to exclude files
 that are not relevant to testing or would otherwise cause the coverage calculations to fail.
-**ci4-module-tests** starts with a few files common to CodeIgniter 4 but you may need to add
+**ProjectTests** starts with a few files common to CodeIgniter 4 but you may need to add
 your own:
 ```
 	<exclude>

docs/CREATING.md

@@ -12,28 +12,28 @@ provides a few that you may use directly:
 * `CodeIgniter\Test\CIUnitTestCase` - for basic tests with no other service needs
 * `CodeIgniter\Test\CIDatabaseTestCase` - for tests that need database access
 
-**ModuleTests** also provides some examples:
-* `ModuleTests\Support\DatabaseTestCase` - for database tests, pre-configured for migrations, seeds, and models from **tests/_support**
-* `ModuleTests\Support\SessionTestCase` - for session tests, pre-configured with a mock session driver
+**ProjectTests** also provides some examples:
+* `ProjectTests\Support\DatabaseTestCase` - for database tests, pre-configured for migrations, seeds, and models from **tests/_support**
+* `ProjectTests\Support\SessionTestCase` - for session tests, pre-configured with a mock session driver
 
 Most of the time you will want to write your own test cases to hold functions and services
 common to your test suites.
 
 ## Tests
 
-All tests go in the **tests/** directory. **ModuleTests** provides two generic
-subfolders for you, **unit** and **database** - but feel free to make your own. Each test file
-is a class that extends a **Test Case** (see above) and contains methods for the individual
-tests. These method names must start with the word "test" and should have descriptive names
-for precisely what they are testing: `testUserCanModifyFile()` `testOutputColorMatchesInput()`
-`testIsLoggedInFailsWithInvalidUser()`
+All tests go in the **tests/** directory. **ProjectTests** provides some generic
+subfolders for you (**unit**, **session**, and **database**) - but feel free to make your
+own. Each test file is a class that extends a **Test Case** (see above) and contains methods
+for the individual tests. These method names must start with the word "test" and should
+have descriptive names for precisely what they are testing:
+`testUserCanModifyFile()` `testOutputColorMatchesInput()` `testIsLoggedInFailsWithInvalidUser()`
 
 Writing tests is an art, and there are many resources available to help learn how. Review
 the links above and always pay attention to your [Code Coverage](docs/COVERAGE.md).
 
 ### Database Tests
 
-**ModuleTests** provides examples for migrating, seeding, and testing against a mock
+**ProjectTests** provides examples for migrating, seeding, and testing against a mock
 or live<sup>1</sup> database. The example files can be modified or replaced with your own:
 * **tests/_support/Database/Migrations/create_test_tables.php**
 * **tests/_support/Database/Seeds/ExampleSeeder.php**
@@ -50,7 +50,7 @@ repo by adding it to **.gitignore**.
 
 ### Session Tests
 
-Similar to database testing, **ModuleTests** provides a test case pre-configured
+Similar to database testing, **ProjectTests** provides a test case pre-configured
 with the [mock session class](https://codeigniter4.github.io/userguide/testing/overview.html#mocking-services)
 to make testing sessions easier:
 * **tests/_support/SessionTestCase.php**

src/tests/_support/Database/Migrations/2019-09-02-092335_create_test_tables.php

@@ -1,4 +1,4 @@
-<?php namespace ModuleTests\Support\Database\Migrations;
+<?php namespace ProjectTests\Support\Database\Migrations;
 
 use CodeIgniter\Database\Migration;
 

src/tests/_support/Database/Seeds/ExampleSeeder.php

@@ -1,6 +1,8 @@
-<?php namespace ModuleTests\Support\Database\Seeds;
+<?php namespace ProjectTests\Support\Database\Seeds;
 
-class ExampleSeeder extends \CodeIgniter\Database\Seeder
+use CodeIgniter\Database\Seeder;
+
+class ExampleSeeder extends Seeder
 {
 	public function run()
 	{

src/tests/_support/DatabaseTestCase.php

@@ -1,4 +1,4 @@
-<?php namespace ModuleTests\Support;
+<?php namespace ProjectTests\Support;
 
 class DatabaseTestCase extends \CodeIgniter\Test\CIDatabaseTestCase
 {
@@ -14,7 +14,7 @@ class DatabaseTestCase extends \CodeIgniter\Test\CIDatabaseTestCase
      *
      * @var string
      */
-    protected $seed = 'ModuleTests\Support\Database\Seeds\ExampleSeeder';
+    protected $seed = 'ProjectTests\Support\Database\Seeds\ExampleSeeder';
 
     /**
      * The path to where we can find the test Seeds directory.
@@ -28,7 +28,7 @@ class DatabaseTestCase extends \CodeIgniter\Test\CIDatabaseTestCase
      *
      * @var string
      */
-    protected $namespace = 'ModuleTests\Support';
+    protected $namespace = 'ProjectTests\Support';
 
     public function setUp(): void
     {

src/tests/_support/Models/ExampleModel.php

@@ -1,4 +1,4 @@
-<?php namespace ModuleTests\Support\Models;
+<?php namespace ProjectTests\Support\Models;
 
 use CodeIgniter\Model;
 

src/tests/_support/SessionTestCase.php

@@ -1,9 +1,10 @@
-<?php namespace ModuleTests\Support;
+<?php namespace ProjectTests\Support;
 
+use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Session\Handlers\ArrayHandler;
 use Tests\Support\Session\MockSession;
 
-class SessionTestCase extends \CodeIgniter\Test\CIUnitTestCase
+class SessionTestCase extends CIUnitTestCase
 {
     /**
      * @var SessionHandler
@@ -24,7 +25,7 @@ public function setUp(): void
      */
     protected function mockSession()
     {
-        require_once ROOTPATH . 'tests/_support/Session/MockSession.php';
+        require_once CIPATH . 'tests/_support/Session/MockSession.php';
         $config = config('App');
         $this->session = new MockSession(new ArrayHandler($config, '0.0.0.0'), $config);
         \Config\Services::injectMock('session', $this->session);

src/tests/_support/bootstrap.php

@@ -10,21 +10,20 @@
 define('ENVIRONMENT', 'testing');
 
 // Load our paths config file
-require __DIR__ . '/../../vendor/codeigniter4/codeigniter4/app/Config/Paths.php';
+require __DIR__ . '/../../app/Config/Paths.php';
 $paths = new Config\Paths();
 
 // Define necessary framework path constants
 define('APPPATH',       realpath($paths->appDirectory) . DIRECTORY_SEPARATOR);
 define('ROOTPATH',      realpath(APPPATH . '../') . DIRECTORY_SEPARATOR);
 define('FCPATH',        realpath(ROOTPATH . 'public') . DIRECTORY_SEPARATOR);
-define('SYSTEMPATH',    realpath($paths->systemDirectory) . DIRECTORY_SEPARATOR);
 define('WRITEPATH',     realpath($paths->writableDirectory) . DIRECTORY_SEPARATOR);
+define('SYSTEMPATH',    realpath($paths->systemDirectory) . DIRECTORY_SEPARATOR);
+define('CIPATH',        realpath(SYSTEMPATH . '../') . DIRECTORY_SEPARATOR);
 
 // Define necessary module test path constants
 define('SUPPORTPATH',   realpath(__DIR__) . DIRECTORY_SEPARATOR);
 define('TESTPATH',      realpath(SUPPORTPATH . '../') . DIRECTORY_SEPARATOR);
-define('MODULEPATH',    realpath(__DIR__ . '/../../') . DIRECTORY_SEPARATOR);
-define('COMPOSER_PATH', MODULEPATH . 'vendor/autoload.php');
 
 // Set environment values that would otherwise stop the framework from functioning during tests.
 if (! isset($_SERVER['app.baseURL']))

src/tests/database/ExampleDatabaseTest.php

@@ -1,6 +1,6 @@
 <?php
 
-class ExampleDatabaseTest extends ModuleTests\Support\DatabaseTestCase
+class ExampleDatabaseTest extends ProjectTests\Support\DatabaseTestCase
 {
 	public function setUp(): void
 	{
@@ -9,7 +9,7 @@ public function setUp(): void
 
 	public function testDatabaseSimple()
 	{
-		$model = new \ModuleTests\Support\Models\ExampleModel();
+		$model = new \ProjectTests\Support\Models\ExampleModel();
 
 		$objects = $model->findAll();
 

src/tests/session/ExampleSessionTest.php

@@ -1,6 +1,6 @@
 <?php
 
-class ExampleSessionTest extends ModuleTests\Support\SessionTestCase
+class ExampleSessionTest extends ProjectTests\Support\SessionTestCase
 {
 	public function setUp(): void
 	{