Initial commit.

prwater · prwater · commit f2377ede55ea · 2016-04-15T21:30:21.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+.idea/
+bin/
+composer.lock
+vendor/
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,15 @@
+language: php
+php:
+  - '5.4'
+  - '5.5'
+  - '5.6'
+  - '7.0'
+  - hhvm
+  - nightly
+  
+install:
+  - composer self-update
+  - composer install
+    
+script: 
+  - ./bin/phing unit
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Set Based IT Consultancy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,4 @@
+# Exceptions with format string
+
+This package provides exceptions with messages according a format string like 
+[sprintf](http://php.net/manual/en/function.sprintf.php).
diff --git a/build.xml b/build.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="php-affirm" default="build" basedir=".">
+    <target name="build">
+    </target>
+
+    <!-- Runs all unit tests -->
+    <target name="unit">
+        <exec command="bin/phpunit --bootstrap=test/bootstrap.php test" passthru="true" checkreturn="true"/>
+    </target>
+</project>
diff --git a/composer.json b/composer.json
@@ -0,0 +1,24 @@
+{
+  "name": "setbased/php-affirm",
+  "description": "Exceptions with format string",
+  "keywords": [
+    "Exception"
+  ],
+  "type": "library",
+  "license": "MIT",
+  "require": {
+    "php": ">=5.4.0"
+  },
+  "require-dev": {
+    "phing/phing": "2.*",
+    "phpunit/phpunit": ">=4.0 <6.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "SetBased\\Exception\\": "src/"
+    }
+  },
+  "config": {
+    "bin-dir": "bin"
+  }
+}
diff --git a/src/ErrorException.php b/src/ErrorException.php
@@ -0,0 +1,39 @@
+<?php
+//----------------------------------------------------------------------------------------------------------------------
+namespace SetBased\Exception;
+
+//----------------------------------------------------------------------------------------------------------------------
+/**
+ * Class for PHP errors.
+ */
+class ErrorException extends \ErrorException implements NamedException
+{
+  protected static $ourNames = [E_COMPILE_ERROR     => 'PHP Compile Error',
+                                E_COMPILE_WARNING   => 'PHP Compile Warning',
+                                E_CORE_ERROR        => 'PHP Core Error',
+                                E_CORE_WARNING      => 'PHP Core Warning',
+                                E_DEPRECATED        => 'PHP Deprecated Warning',
+                                E_ERROR             => 'PHP Fatal Error',
+                                E_NOTICE            => 'PHP Notice',
+                                E_PARSE             => 'PHP Parse Error',
+                                E_RECOVERABLE_ERROR => 'PHP Recoverable Error',
+                                E_STRICT            => 'PHP Strict Warning',
+                                E_USER_DEPRECATED   => 'PHP User Deprecated Warning',
+                                E_USER_ERROR        => 'PHP User Error',
+                                E_USER_NOTICE       => 'PHP User Notice',
+                                E_USER_WARNING      => 'PHP User Warning',
+                                E_WARNING           => 'PHP Warning'];
+
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * {@inheritdoc}
+   */
+  public function getName()
+  {
+    return isset(self::$ourNames[$this->getCode()]) ? self::$ourNames[$this->getCode()] : 'Error';
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------
diff --git a/src/FallenException.php b/src/FallenException.php
@@ -0,0 +1,48 @@
+<?php
+//----------------------------------------------------------------------------------------------------------------------
+namespace SetBased\Exception;
+
+//----------------------------------------------------------------------------------------------------------------------
+/**
+ * Class for situations where PHP code has fallen through a switch statement or a combination of if-elseif statements.
+ */
+class FallenException extends RuntimeException
+{
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Object constructor.
+   *
+   * @param string $theName  The name or description of the variable of expression.
+   * @param string $theValue The actual value that.
+   *
+   * Example:
+   * ```
+   *  $size = 'xxl';
+   *  switch ($size)
+   *  {
+   *    case 'S':
+   *      echo 'small';
+   *      break;
+   *
+   *    case 'M':
+   *      echo 'medium';
+   *      break;
+   *
+   *    case 'L':
+   *      echo 'small';
+   *      break;
+   *
+   *    default:
+   *      throw new FallenException('size', $size);
+   *  }
+   * ```
+   */
+  public function __construct($theName, $theValue)
+  {
+    parent::__construct("Unknown or unexpected value '%s' for '%s'.", $theValue, $theName);
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------
diff --git a/src/FormattedException.php b/src/FormattedException.php
@@ -0,0 +1,50 @@
+<?php
+//----------------------------------------------------------------------------------------------------------------------
+namespace SetBased\Exception;
+
+//----------------------------------------------------------------------------------------------------------------------
+trait FormattedException
+{
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Object constructor.
+   *
+   * @param string|array $format    The format string of the error message, see
+   *                                [sprintf](http://php.net/manual/function.sprintf.php).
+   * @param mixed        $param,... The arguments for the format string. However, if the first argument is an exception
+   *                                it will be used as the [previous](http://php.net/manual/exception.construct.php)
+   *                                exception for the exception chaining.
+   */
+  public function __construct($format)
+  {
+    $code     = 0;
+    $previous = null;
+
+    $args = func_get_args();
+    array_shift($args);
+
+    if (is_array($format))
+    {
+      $special = $format;
+      $format  = array_shift($args);
+
+      if (isset($special[0]))
+      {
+        if ($special[0] instanceof \Exception) $previous = $special[0];
+        elseif (is_int($special[0])) $code = $special[0];
+      }
+
+      if (isset($special[1]))
+      {
+        if ($special[1] instanceof \Exception) $previous = $special[1];
+        elseif (is_int($special[1])) $code = $special[1];
+      }
+    }
+
+    parent::__construct(vsprintf($format, $args), $code, $previous);
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------
diff --git a/src/LogicException.php b/src/LogicException.php
@@ -0,0 +1,26 @@
+<?php
+//----------------------------------------------------------------------------------------------------------------------
+namespace SetBased\Exception;
+
+//----------------------------------------------------------------------------------------------------------------------
+/**
+ * Parent class for errors in the program logic.
+ */
+class LogicException extends \LogicException implements NamedException
+{
+  //--------------------------------------------------------------------------------------------------------------------
+  use FormattedException;
+
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * {@inheritdoc}
+   */
+  public function getName()
+  {
+    return 'Programming Error';
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------
diff --git a/src/NamedException.php b/src/NamedException.php
@@ -0,0 +1,22 @@
+<?php
+//----------------------------------------------------------------------------------------------------------------------
+namespace SetBased\Exception;
+
+//----------------------------------------------------------------------------------------------------------------------
+/**
+ * Interface for exceptions with user-friendly names.
+ */
+interface NamedException
+{
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Returns a user-friendly name of this exception.
+   *
+   * @return string
+   */
+  public function getName();
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------
diff --git a/src/RuntimeException.php b/src/RuntimeException.php
@@ -0,0 +1,26 @@
+<?php
+//----------------------------------------------------------------------------------------------------------------------
+namespace SetBased\Exception;
+
+//----------------------------------------------------------------------------------------------------------------------
+/**
+ * Class for runtime exceptions.
+ */
+class RuntimeException extends \RuntimeException implements NamedException
+{
+  //--------------------------------------------------------------------------------------------------------------------
+  use FormattedException;
+
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * {@inheritdoc}
+   */
+  public function getName()
+  {
+    return 'Error';
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------
diff --git a/test/ErrorExceptionTest.php b/test/ErrorExceptionTest.php
@@ -0,0 +1,43 @@
+<?php
+//----------------------------------------------------------------------------------------------------------------------
+use SetBased\Exception\ErrorException;
+
+//----------------------------------------------------------------------------------------------------------------------
+class ErrorExceptionTest extends PHPUnit_Framework_TestCase
+{
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Test ErrorException with valid code.
+   */
+  public function test1()
+  {
+    try
+    {
+      throw new ErrorException('Something went wrong', E_WARNING);
+    }
+    catch (ErrorException $e)
+    {
+      $this->assertSame('PHP Warning', $e->getName());
+    }
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Test ErrorException with invalid code.
+   */
+  public function test2()
+  {
+    try
+    {
+      throw new ErrorException('Something went wrong', 123456);
+    }
+    catch (ErrorException $e)
+    {
+      $this->assertSame('Error', $e->getName());
+    }
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------
diff --git a/test/ExceptionTestBase.php b/test/ExceptionTestBase.php
diff --git a/test/FallenExceptionTest.php b/test/FallenExceptionTest.php
diff --git a/test/LogicExceptionTest.php b/test/LogicExceptionTest.php
diff --git a/test/RuntimeExceptionTest.php b/test/RuntimeExceptionTest.php
diff --git a/test/bootstrap.php b/test/bootstrap.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +.idea/
 +bin/
 +composer.lock
 +vendor/