Merge pull request #1914 from jim-parry/housekeeping/beta2

jim-parry · web-flow · commit a70e9e4043fe · 2019-04-04T00:04:47.000-07:00
Housekeeping - prep for beta.2
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 CodeIgniter is a PHP full-stack web framework that is light, fast, flexible, and secure. 
 More information can be found at the [official site](http://codeigniter.com).
 
-This repository holds the alpha code for CodeIgniter 4 only. 
+This repository holds the source code for CodeIgniter 4 only. 
 Version 4 is a complete rewrite to bring the quality and the code into a more modern version, 
 while still keeping as many of the things intact that has made people love the framework over the years. 
 
@@ -19,9 +19,12 @@ More information about the plans for version 4 can be found in [the announcement
 
 ### Documentation
 
-The current in-progress documentation can be found [here](https://codeigniter4.github.io/CodeIgniter4/). 
-As with the rest of the framework, it is currently a work in progress, and will see changes over time to structure, explanations, etc.
+The [User Guide](https://codeigniter4.github.io/userguide/) is the primary documentation for CodeIgniter 4. 
 
+The current **in-progress** User Guide can be found [here](https://codeigniter4.github.io/CodeIgniter4/). 
+As with the rest of the framework, it is a work in progress, and will see changes over time to structure, explanations, etc.
+
+You might also be interested in the [API documentation](https://codeigniter4.github.io/api/) for the framework components.
 
 ## Important Change with index.php
 
diff --git a/admin/framework/README.md b/admin/framework/README.md
@@ -31,26 +31,12 @@ The user guide updating and deployment is a bit awkward at the moment, but we ar
 
 ## Repository Management
 
-We use Github issues to track **BUGS** and to track approved **DEVELOPMENT** work packages.
+We use Github issues, in our main repository, to track **BUGS** and to track approved **DEVELOPMENT** work packages.
 We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss
 FEATURE REQUESTS.
 
-If you raise an issue here that pertains to support or a feature request, it will
-be closed! If you are not sure if you have found a bug, raise a thread on the forum first -
-someone else may have encountered the same thing.
-
-Before raising a new Github issue, please check that your bug hasn't already
-been reported or fixed. 
-
-We use pull requests (PRs) for CONTRIBUTIONS to the repository.
-We are looking for contributions that address one of the reported bugs or
-approved work packages.
-
-Do not use a PR as a form of feature request.
-Unsolicited contributions will only be considered if they fit nicely
-into the framework roadmap.
-Remember that some components that were part of CodeIgniter 3 are being moved
-to optional packages, with their own repository.
+This repository is a "distribution" one, built by our release preparation script. 
+Problems with it can be raised on our forum, or as issues in the main repository.
 
 ## Contributing
 
diff --git a/admin/framework/phpunit.xml.dist b/admin/framework/phpunit.xml.dist
@@ -12,17 +12,11 @@
     <testsuites>
         <testsuite name="app">
             <directory>./tests</directory>
-            <exclude>./tests/system</exclude>
         </testsuite>
     </testsuites>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./system</directory>
-            <exclude>
-                <directory>./system</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+    
+    <php>
+        <env name="app.baseURL" value="http://example.com"/>
+    </php>
 
 </phpunit>
diff --git a/admin/starter/.gitignore b/admin/starter/.gitignore
@@ -123,4 +123,4 @@ nb-configuration.xml
 .vscode/
 
 /results/
-/phpunit*.xml
+/phpunit*.xml
diff --git a/admin/starter/README.md b/admin/starter/README.md
@@ -11,13 +11,6 @@ It has been built from the
 
 **This is pre-release code and should not be used in production sites.**
 
---- 
- 
-**CAUTION: This app starter is EXPERIMENTAL, and likely to change before
-the framework release. We are looking for feedback and suggestions!**  
-
----
-
 More information about the plans for version 4 can be found in [the announcement](http://forum.codeigniter.com/thread-62615.html) on the forums.
 
 The user guide corresponding to this version of the framework can be found
@@ -28,6 +21,10 @@ The user guide corresponding to this version of the framework can be found
 `composer create-project codeigniter4/appstarter` then `composer update` whenever
 there is a new release of the framework.
 
+When updating, check the release notes to see if there are any changes you might need to apply
+to your `app` folder. The affected files can be copied or merged from
+`vendor/codeigniter4/framework/app`.
+
 ## Setup
 
 Copy `env` to `.env` and tailor for your app, specifically the baseURL
@@ -45,6 +42,15 @@ framework are exposed.
 **Please** read the user guide for a better explanation of how CI4 works!
 The user guide updating and deployment is a bit awkward at the moment, but we are working on it!
 
+## Repository Management
+
+We use Github issues, in our main repository, to track **BUGS** and to track approved **DEVELOPMENT** work packages.
+We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss
+FEATURE REQUESTS.
+
+This repository is a "distribution" one, built by our release preparation script. 
+Problems with it can be raised on our forum, or as issues in the main repository.
+
 ## Server Requirements
 
 PHP version 7.2 or higher is required, with the following extensions installed: 
diff --git a/admin/starter/phpunit.xml.dist b/admin/starter/phpunit.xml.dist
@@ -12,17 +12,11 @@
     <testsuites>
         <testsuite name="app">
             <directory>./tests</directory>
-            <exclude>./tests/system</exclude>
         </testsuite>
     </testsuites>
 
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./system</directory>
-            <exclude>
-                <directory>./system</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+    <php>
+        <env name="app.baseURL" value="http://example.com"/>
+    </php>
 
 </phpunit>
diff --git a/admin/starter/tests/README.md b/admin/starter/tests/README.md
@@ -0,0 +1,59 @@
+# Running System Tests
+
+This is the quick-start to CodeIgniter testing. Its intent is to describe what 
+it takes to get your system setup and ready to run the system tests. 
+It is not intended to be a full description of the test features that you can 
+use to test your application, since that can be found in the documentation. 
+
+## Requirements
+
+It is recommended to use the latest version of PHPUnit. At the time of this 
+writing we are running version 7.5.1. Support for this has been built into the 
+**composer.json** file that ships with CodeIgniter, and can easily be installed 
+via [Composer](https://getcomposer.org/) if you don't already have it installed globally.
+
+	> composer install
+
+If running under OS X or Linux, you can create a symbolic link to make running tests a touch nicer.
+
+	> ln -s ./vendor/bin/phpunit ./phpunit
+
+You also need to install [XDebug](https://xdebug.org/index.php) in order
+for the unit tests to successfully complete.
+
+## Setup
+
+A number of the tests that are ran during the test suite are ran against a running database. 
+In order to setup the database used here, edit the details for the `tests` database 
+group in **app/Config/Database.php**. Make sure that you provide a database engine 
+that is currently running, and have already created a table that you can use only 
+for these tests, as it will be wiped and refreshed often while running the test suite.  
+
+A simplified PHPunit configuration file, **phpunit.dist.xml**, is provided.
+You can use it as is, or copy it to **phpunit.xml**, and tailor it to suit your
+application.
+
+## Running the tests
+
+The entire test suite can be ran by simply typing one command from the command line within the main directory.
+
+	> ./phpunit
+
+You can limit tests to those within a single test directory by specifying the 
+directory name after phpunit. 
+
+	> ./phpunit app/Models
+
+## Generating Code Coverage
+
+To generate coverage information, including HTML reports you can view in your browser, 
+you can use the following command: 
+
+	> ./phpunit --colors --coverage-text=tests/coverage.txt --coverage-html=tests/coverage/ -d memory_limit=1024m
+
+This runs all of the tests again, collecting information about how many lines, 
+functions, and files are tested, and the percent of the code that is covered by the tests. 
+It is collected in two formats: a simple text file that provides an overview, 
+as well as comprehensive collection of HTML files that show the status of every line of code in the project. 
+
+Code coverage details will be left in the **tests/coverage** folder.
diff --git a/user_guide_src/source/changelogs/index.rst b/user_guide_src/source/changelogs/index.rst
@@ -9,6 +9,24 @@ Release Date: Not Released
 
 **Next release of CodeIgniter4**
 
+Highlights:
+
+- A number of fixes & improvements, importantly for the Model and testing classes
+- Models now require a primary key
+- Generated API docs accessible at https://codeigniter4.github.io/api/
+- Validation rules have been enhanced
+- .htaccess beefed up
+
+New messages:
+
+- Database.noPrimaryKey, forFindColumnHaveMultipleColumns, Database.forEmptyInputGiven
+
+App changes:
+
+- updated app/Config/Events 
+- added app/Controllers/BaseController 
+- added tests/ folder for unit testing
+- added phpunit.xml.dist for unit testing configuration
 
 :doc:`See all the changes. </changelogs/next>`
 
diff --git a/user_guide_src/source/changelogs/next.rst b/user_guide_src/source/changelogs/next.rst
