Add initial version (#1)

* Add initial version of the Notification

* Update change log

* Update .scrutinizer.yml

Author: slavcodev

.editorconfig

@@ -14,7 +14,7 @@ max_line_length = 120
 [*.{diff,md}]
 trim_trailing_whitespace = false
 
-[*.{html,js,rb,scss,xml,yml,yaml,json}]
+[*.{html,js,rb,scss,xml,yml,yaml,json,yaml,yml}]
 indent_size = 2
 
 [*.txt]

.scrutinizer.yml

@@ -1,23 +1,104 @@
 filter:
-  excluded_paths: [tests/*]
+  excluded_paths:
+    - build/*
+    - tests/*
+    - vendor/*
 
 checks:
-  php:
-    remove_extra_empty_lines: true
-    remove_php_closing_tag: true
-    remove_trailing_whitespace: true
-    fix_use_statements:
-      remove_unused: true
-      preserve_multiple: false
-      preserve_blanklines: true
-      order_alphabetically: true
-    fix_php_opening_tag: true
-    fix_linefeed: true
-    fix_line_ending: true
-    fix_identation_4spaces: true
-    fix_doc_comments: true
-    code_rating: true
-    duplication: true
+   php:
+     verify_property_names: true
+     verify_argument_usable_as_reference: true
+     verify_access_scope_valid: true
+     variable_existence: true
+     useless_calls: true
+     use_statement_alias_conflict: true
+     unused_variables: true
+     unused_properties: true
+     unused_parameters: true
+     unused_methods: true
+     unreachable_code: true
+     too_many_arguments: true
+     symfony_request_injection: false
+     switch_fallthrough_commented: true
+     sql_injection_vulnerabilities: true
+     simplify_boolean_return: true
+     security_vulnerabilities: true
+     return_in_constructor: true
+     return_doc_comments: true
+     return_doc_comment_if_not_inferrable: true
+     require_scope_for_methods: true
+     require_php_tag_first: true
+     remove_extra_empty_lines: true
+     property_assignments: true
+     properties_in_camelcaps: true
+     precedence_mistakes: true
+     precedence_in_conditions: true
+     phpunit_assertions: true
+     parse_doc_comments: true
+     parameters_in_camelcaps: true
+     parameter_non_unique: true
+     parameter_doc_comments: true
+     param_doc_comment_if_not_inferrable: true
+     overriding_private_members: true
+     overriding_parameter: true
+     non_commented_empty_catch_block: true
+     no_trait_type_hints: true
+     no_trailing_whitespace: true
+     no_short_variable_names:
+       minimum: '3'
+     no_short_open_tag: true
+     no_short_method_names:
+       minimum: '3'
+     no_property_on_interface: true
+     no_non_implemented_abstract_methods: true
+     no_long_variable_names:
+       maximum: '20'
+     no_goto: true
+     no_exit: true
+     no_eval: true
+     no_error_suppression: true
+     no_debug_code: true
+     more_specific_types_in_doc_comments: true
+     missing_arguments: true
+     method_calls_on_non_object: true
+     instanceof_class_exists: true
+     foreach_usable_as_reference: true
+     foreach_traversable: true
+     fix_use_statements:
+       remove_unused: true
+       preserve_multiple: false
+       preserve_blanklines: false
+       order_alphabetically: true
+     fix_line_ending: true
+     fix_doc_comments: true
+     encourage_shallow_comparison: true
+     duplication: true
+     deprecated_code_usage: true
+     deadlock_detection_in_loops: true
+     comparison_always_same_result: true
+     code_rating: true
+     closure_use_not_conflicting: true
+     closure_use_modifiable: true
+     check_method_contracts:
+       verify_interface_like_constraints: true
+       verify_documented_constraints: true
+       verify_parent_constraints: true
+     catch_class_exists: true
+     call_to_parent_method: true
+     avoid_superglobals: true
+     avoid_length_functions_in_loops: true
+     avoid_entity_manager_injection: true
+     avoid_duplicate_types: true
+     avoid_closing_tag: true
+     assignment_of_null_return: true
+     argument_type_checks: true
+
+build:
+   nodes:
+     analysis:
+       tests:
+         override:
+           - php-scrutinizer-run
 
 tools:
   external_code_coverage:

CHANGELOG.md

@@ -17,3 +17,7 @@ Security - in case of vulnerabilities.
 ## [Unreleased]
 
 _TBD_
+
+## [0.1.0] 2018-05-26
+
+Initial release.

src/Error.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ * This file is part of Zee Project.
+ *
+ * @see https://github.com/zee/
+ */
+
+declare(strict_types=1);
+
+namespace Zee\Errors;
+
+/**
+ * Class Error.
+ */
+final class Error
+{
+    /**
+     * @var string
+     */
+    private $message;
+
+    /**
+     * @var array
+     */
+    private $context;
+
+    /**
+     * @param string $message
+     * @param array $context
+     */
+    public function __construct(string $message, array $context)
+    {
+        $this->message = $message;
+        $this->context = $context;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function __toString(): string
+    {
+        return $this->getMessage();
+    }
+
+    /**
+     * @return string
+     */
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+
+    /**
+     * @return array
+     */
+    public function getContext(): array
+    {
+        return $this->context;
+    }
+}

src/Notification.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * This file is part of Zee Project.
+ *
+ * @see https://github.com/zee/
+ */
+
+declare(strict_types=1);
+
+namespace Zee\Errors;
+
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use Traversable;
+
+/**
+ * Class Notification.
+ */
+final class Notification implements Countable, IteratorAggregate
+{
+    private $errors = [];
+
+    /**
+     * Adds new error to the notification.
+     *
+     * @param string $message
+     * @param array $context
+     */
+    public function addError(string $message, array $context = []): void
+    {
+        $this->errors[] = new Error($message, $context);
+    }
+
+    /**
+     * Returns whether the notification has any errors.
+     *
+     * @return bool
+     */
+    public function hasErrors(): bool
+    {
+        return !empty($this->errors);
+    }
+
+    /**
+     * Clear the notification errors.
+     */
+    public function clearErrors(): void
+    {
+        $this->errors = [];
+    }
+
+    /**
+     * @return array
+     */
+    public function getErrorMessages(): array
+    {
+        return array_map(
+            function (Error $error) {
+                return $error->getMessage();
+            },
+            $this->errors
+        );
+    }
+
+    /**
+     * Counts the errors.
+     *
+     * @inheritdoc
+     */
+    public function count(): int
+    {
+        return count($this->errors);
+    }
+
+    /**
+     * Builds the iterator by errors.
+     *
+     * @inheritdoc
+     *
+     * @return Traversable|Error[]
+     */
+    public function getIterator(): Traversable
+    {
+        return new ArrayIterator($this->errors);
+    }
+}

tests/ErrorTest.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * This file is part of Zee Project.
+ *
+ * @see https://github.com/zee/
+ */
+
+declare(strict_types=1);
+
+namespace Zee\Errors\Tests;
+
+use Zee\Errors\Error;
+
+/**
+ * Class ErrorTest.
+ */
+final class ErrorTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @return Error
+     */
+    public function errorContainsMessageAndItsContextData(): Error
+    {
+        $error = new Error('Something went wrong', ['foo' => 'bar']);
+
+        self::assertSame('Something went wrong', $error->getMessage());
+        self::assertSame(['foo' => 'bar'], $error->getContext());
+
+        return $error;
+    }
+
+    /**
+     * @test
+     * @depends errorContainsMessageAndItsContextData
+     *
+     * @param Error $error
+     */
+    public function canBeCastedToString(Error $error)
+    {
+        self::assertSame('Something went wrong', (string) $error);
+    }
+}