(pkg) init commit

Author: troublete

.gitignore

@@ -0,0 +1,2 @@
+vendor
+composer.lock

.travis.yml

@@ -0,0 +1,7 @@
+language: php
+php:
+  - '7.0'
+  - '7.1'
+before_script: composer install --dev
+script:
+  - composer test

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 25.10.2017
+
+### [Added]
+* `PredictExceptionTrait` with a `predictException` Method that checks if a capture throws a specific Kind of exception
+* Docs
+* Tests

README.md

@@ -0,0 +1,54 @@
+# predict-exception
+
+> Simplified predictions if a piece of codes throws an Exception
+
+[![Build Status](https://travis-ci.org/try-php/predict-exception.svg?branch=master)](https://travis-ci.org/try-php/predict-exception)
+
+## Install
+
+```bash
+$ composer require try/predict-exception
+```
+
+## Usage
+
+```php
+<?php
+require_once '/path/to/autoload.php';
+
+use TryPhp\PredictExeptionTrait;
+
+$assertions = new class() {
+	use PredictExeptionTrait();
+} 
+
+$assertions->predictException(function () {
+	throw new \RuntimeException('Oooops. Something broke.')
+}, \RuntimeException::class); // won't throw an exception
+
+$assertions->predictException(function () {
+}, \Exception::class); // will throw an exception
+
+$assertions->predictException(function () {
+	throw new \RuntimeException('something else happened.');
+}, \Exception::class); // will throw an exception
+```
+
+## API
+
+### Methods
+
+#### `predictException($capture, $exceptionClass)`
+
+Method to check if a given piece of code throws an Exception of the expected type.
+
+##### Arguments
+
+| Arguments | Type | Description |
+|---|---|---|
+| $capture | `callable` | Closure in which the Exception shall be thrown. |
+| $exceptionClass | `string` | Class of the Exception that is expected to be thrown. |
+
+## License
+
+GPL-2.0 © Willi Eßer

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "try/predict-exception",
+    "description": "Simplified predictions if a piece of codes throws an Exception",
+    "type": "library",
+    "license": "GPL-2.0",
+    "authors": [
+        {
+            "name": "Willi Eßer",
+            "email": "willi.esser@troublete.com"
+        }
+    ],
+    "minimum-stability": "stable",
+    "autoload": {
+    	"psr-4": {
+    		"TryPhp\\": "./src"
+    	}
+    },
+    "scripts": {
+    	"test": "@php test.php"
+    },
+    "require": {}
+}

src/PredictExceptionFailure.php

@@ -0,0 +1,7 @@
+<?php
+namespace TryPhp;
+
+class PredictExceptionFailure extends \Exception
+{
+	
+}

src/PredictExceptionTrait.php

@@ -0,0 +1,30 @@
+<?php
+namespace TryPhp;
+
+trait PredictExceptionTrait
+{
+	/**
+	 * Method to assure that a piece of code executed inside of a capture 
+	 * throws an exception and compare the type of it with a given class name
+	 * @param callable $capture
+	 * @param string $exceptionClass
+	 * @throws PredictExceptionFailure
+	 */
+	public function predictException(callable $capture, string $exceptionClass) 
+	{
+		try {
+			call_user_func($capture);
+			throw new PredictExceptionFailure("Capture was expected to throw '$exceptionClass' but did not.");
+		} catch (\Exception $ex) {	
+			$actualExceptionClass = get_class($ex);
+
+			if ($actualExceptionClass === PredictExceptionFailure::class) {
+				throw $ex;
+			}
+
+			if ($actualExceptionClass !== $exceptionClass) {
+				throw new PredictExceptionFailure("Capture threw an Exception. Expected '$exceptionClass', but got '$actualExceptionClass'.");
+			}
+		}
+	}
+}

test.php

@@ -0,0 +1,36 @@
+<?php
+require_once __DIR__ . '/vendor/autoload.php';
+
+use TryPhp\PredictExceptionTrait;
+
+$executionClass = new class() {
+	use PredictExceptionTrait;
+};
+
+try {
+	$executionClass->predictException(function () {
+	}, \Exception::class);
+	trigger_error('test failed', E_USER_ERROR);
+} catch (\Exception $ex) {
+	if ($ex->getMessage() !== "Capture was expected to throw 'Exception' but did not.") {
+		trigger_error('test failed', E_USER_ERROR);
+	}
+}
+
+try {
+	$executionClass->predictException(function () {
+		throw new Exception('something happened');
+	}, \Exception::class);	
+} catch (\Exception $ex) {
+	trigger_error('test failed', E_USER_ERROR);
+}
+
+try {
+	$executionClass->predictException(function () {
+		throw new Exception('something happened');
+	}, \RuntimeException::class);	
+} catch (\Exception $ex) {
+	if ($ex->getMessage() !== "Capture threw an Exception. Expected 'RuntimeException', but got 'Exception'.") {
+		trigger_error('test failed', E_USER_ERROR);
+	}
+}