Merge pull request #189 from MarcinOrlowski/dev

Release v9.2.1

Author: MarcinOrlowski

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,22 +8,23 @@ assignees: ''
 ---
 
 **What's wrong?**
-A clear and concise description of what the bug is.
+Please put a clear and concise description of what the bug is.
 
 **Steps to reproduce the behavior:**
-1. 
-2. 
-3. 
-4. 
+ 1. 
+ 1. 
+ 1. 
+ 1. 
 
 **Expected behavior**
 A clear and concise description of what you expected to happen
-instead of currently observed behaviour..
+instead of currently observed behaviour.
 
 **Runtime environment**
  - Name and version of OS: [i.e. Windows 10, Ubuntu 19.04, etc]
  - PHP version [i.e. 7.2]
- - Laravel version [e.g. 6.0.0]
+ - Laravel version [i.e. 6.0.0]
+ - ResponseBuilder version used [i.e. 9.0.1]
 
 **Notes**
 Any additional information that may be helpful diagnosing the problem.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,13 +8,13 @@ assignees: ''
 ---
 
 **Please describe the problem**
-A clear and concise description of what your request is about.
+Please put a clear and concise description of what your request is about.
 
 **Describe the solution you'd like to see**
-A clear and concise description of what you want to happen once
-your request is implemented. In other words, describe desired
-behaviour. If possible, consider adding pseudo-code if that would
-better illustrated your request.
+A clear and concise description of what you want to happen once your request
+is implemented. In other words, describe desired behavior. If possible, please
+consider adding pseudo-code if that would better illustrate your request.
 
 **Notes**
 Add any other context or screenshots about the feature request here.
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,17 +1,18 @@
 ### This pull request...
 
-* [ ] Fixes a bug.
+* [ ] Fixes a bug. Closes #TICKET-NUMBER
 * [ ] Adds new feature or improves existing behaviour.
 * [ ] Documentation change.
 
 ### Checklist:
 
 * [ ] I have opened the issue ticket that this pull request is part of.
-* [ ] This pull request title contains `Fixes: #{$ISSUE_NO}` that closes ticket.
+* [ ] This pull request title contains `(#TICKET-NUMBER)` for reference..
+* [ ] This pull request description contains `Closes #{$ISSUE_NO}` that closes ticket.
 * [ ] This pull request is all my own work - I have not plagiarized.
 * [ ] This contribution is licensed under MIT or compatible license.
 * [ ] All code is covered in unit tests and all tests pass.
-* [ ] I have updated the documentation that covers all the changes this pull request makes.
+* [ ] I have updated the docs to cover PR's changes (if applicable).
 * [ ] All functions and variable names follow project naming conventions.
 * [ ] All function parameters and return values are annotated with PHP [type hints](https://www.php.net/manual/en/language.oop5.typehinting.php).
 * [ ] All functions have [PHPDocs](https://docs.phpdoc.org/3.0/guide/references/phpdoc/index.html) blocks.

README.md

@@ -56,5 +56,5 @@
 
 ## License ##
 
- * Written and copyrighted &copy;2016-2020 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
+ * Written and copyrighted &copy;2016-2021 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
  * ResponseBuilder is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

composer.json

@@ -2,7 +2,7 @@
   "name": "marcin-orlowski/laravel-api-response-builder",
   "description": "Helps building nice, normalized and easy to consume Laravel REST API.",
   "homepage": "https://github.com/MarcinOrlowski/laravel-api-response-builder",
-  "version": "9.2.0",
+  "version": "9.2.1",
   "keywords": [
     "laravel",
     "json",

config/response_builder.php

@@ -6,7 +6,7 @@
  * See docs/config.md for detailed documentation
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2020 Marcin Orlowski
+ * @copyright 2016-2021 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

docs/CHANGES.md

@@ -8,6 +8,9 @@
 
 ## CHANGE LOG ##
 
+* v9.2.1 (2021-01-18)
+   * [RB-186] ExceptionHandler now expects `\Throwable` instead of `\Exception`.
+
 * v9.2.0 (2020-12-27)
    * Updated Travis config to run tests on PHP 8 too.
    * Added Arabic translation (thanks to @mustafa-online)

docs/exceptions.md

@@ -13,6 +13,12 @@
      * [Possible Exception Handler conflicts](#possible-exception-handler-conflicts)
      * [ApiCodes](#apicodes)
 
+---
+
+ > ![WARNING](img/warning.png) Use of provided `ExceptionHandler` helper **requires** additional, **manual**
+ > installation steps to be made, otherwise Laravel's built-in handler will be used instead. See the details
+ > documented below.
+
 ---
 
 # Exception Handling with Response Builder #
@@ -41,7 +47,7 @@ use MarcinOrlowski\ResponseBuilder\ExceptionHandlerHelper;
  Default handler as of Laravel 5.2 has been significantly simplified and by default it looks like this:
 
 ```php
-public function render($request, Exception $e)
+public function render($request, Throwable $e)
 {
     return parent::render($request, $e);
 }
@@ -50,7 +56,7 @@ public function render($request, Exception $e)
  After your edit it shall look like this:
 
 ```php
-public function render($request, Exception $e)
+public function render($request, Throwable $e)
 {
     return ExceptionHandlerHelper::render($request, $e);
 }

src/ApiCodesHelpers.php

@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2020 Marcin Orlowski
+ * @copyright 2016-2021 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

src/BaseApiCodes.php

@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2020 Marcin Orlowski
+ * @copyright 2016-2021 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */