- uses the latest Koded\Stdlib

- adds VERSION file
- updates the tests
- README clean up
- LICENSE update

Author: kodeart

LICENSE

@@ -1,7 +1,7 @@
 BSD 3-Clause License
 
 Koded - Logging
-Copyright (c) 2017, Mihail Binev
+Copyright (c) 2018, Mihail Binev
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -44,7 +44,7 @@ $log = new Log($settings);
 $log->alert('The message with {variable}', ['variable' => 'useful info']);
 
 // This message won't be processed by ErrorLog because the level is below ERROR
-// but File will handle it
+// but *File* will handle it
 $log->warning("You don't see anything");
 
 ```
@@ -53,44 +53,46 @@ Configuration
 -------------
 
 There are two ways of throwing the log messages
-- register the logger at PHP's shutdown phase with
-```php
-<?php
-
-$logger->register();
-
-// or
-register_shutdown_function([$logger, 'process']);
-
-// or
-register_shutdown_function([new Log($settings), 'process']);
-```
-somewhere in your bootstrap, at the very beginning of your project.
-**You do this only once**.
-
-- calling directly `$logger->process()` if you want immediate log messages.
-**This approach will dump all accumulated messages and clear the messages stack**,
-so at the shutdown phase (if any) the logger will be empty
+- automatically at the shutdown phase by using the `Log::process()` method somewhere in your bootstrap
+(at the very beginning of your project).  
+**You should do this only once**.
+
+    ```php
+    <?php
+    
+    $logger->register();
+    
+    // or
+    register_shutdown_function([$logger, 'process']);
+    
+    // or
+    register_shutdown_function([new Log($settings), 'process']);
+    ```
+
+- calling directly `$logger->process()` if you want immediate log messages.  
+**This call will dump all accumulated messages and clear the stack**
+(after that the logger will be empty)
 
 
 ### Log and Processor default directives
 
 Every log processor has it's own set of configuration directives.
-The table shows parameters that are always present in the classes.
+The table shows log parameters in the classes.
 
-| Param      | Type    | Required | Default     | Description                                                          |
-|:-----------|:--------|:--------:|:------------|:---------------------------------------------------------------------|
-| class      | string  | yes      |             | The name of the log processor class                                  |
-| levels     | integer | no       | -1          | Packed integer for bitwise comparison. See the constants in Logger   |
-| dateformat | string  | no       | d/m/Y H:i:s | The datetime format for the log message                              |
-| timezone   | string  | no       | UTC         | The desired timezone for the datetime log message                    |
+| Param      | Type    | Required | Default     | Description
+|:-----------|:--------|:--------:|:------------|:-----------
+| class      | string  | yes      |             | The name of the log processor class
+| levels     | integer | no       | -1          | Packed integer for bitwise comparison. See the constants in Logger class
+| dateformat | string  | no       | d/m/Y H:i:s | The datetime format for the log message
+| timezone   | string  | no       | UTC         | The desired timezone for the datetime log message
 
 
 ### Levels example
+
 The messages are filtered with bitwise operator (as packed integer). Every processor will filter out the messages as
 defined in it's **levels** directive.
 
-To log only WARNING, INFO and ERROR messages set levels to
+For instance, to log only WARNING, INFO and ERROR messages set levels to
 
 ```php
 <?php
@@ -101,29 +103,20 @@ To log only WARNING, INFO and ERROR messages set levels to
 Tips:
 - every processor is configured separately
 - if you want to process all log levels, skip the `levels` value
-- if you want to suppress the processor, set the level to 0
+- if you want to suppress a specific processor, set it's level to 0
 
 
 Processors
 ----------
 
-- **ErrorLog**
-  uses the [error_log()][error-log] function to send the message to PHP's logger
-
-- **File**
-  saves the messages on a disk. It's a slow one
-  
-- **Syslog**
-  will open the system logger and send messages using the [syslog()][syslog] function
-
-- **Cli**
-  for CLI applications, it can write the messages in the console
-
-- **Memory**
-  will store all messages in an array. Useful for unit tests if the logger is involved
-
-- **Voided**
-  is here for no particular reason and purpose. It's the fastest one tho
+| Class name | Description
+|-----------:|:-----------
+| ErrorLog   | uses the [error_log()][error-log] function to send the message to PHP's logger
+| SysLog     | will open the system logger and send messages using the [syslog()][syslog] function
+| Cli        | for CLI applications, it can write the messages in the console
+| Memory     | will store all messages in an array. Useful for unit tests if the logger is involved
+| File       | saves the messages on a disk. It's a slow one and should be avoided
+| Voided     | is here for no particular reason and purpose. It's the fastest one tho :)
 
 
 License
@@ -134,4 +127,4 @@ The code is distributed under the terms of [The 3-Clause BSD license](LICENSE).
 [psr-3]: http://www.php-fig.org/psr/psr-3/
 [composer]: https://getcomposer.org/download/
 [error-log]: http://php.net/error_log
-[syslog]: http://php.net/syslog
+[syslog]: http://php.net/syslog

Tests/LogConstructorTest.php

@@ -8,7 +8,7 @@
 class LogConstructorTest extends TestCase
 {
 
-    public function testConstructionWithConfigArray()
+    public function test_construction_with_config_array()
     {
         $log = new Log([
             'timezone' => 'Europe/Berlin',
@@ -22,7 +22,7 @@ public function testConstructionWithConfigArray()
         $this->assertAttributeSame('Europe/Berlin', 'timezone', $log);
     }
 
-    public function testConstructionWithoutConfig()
+    public function test_construction_without_config()
     {
         $log = new Log([]);
         $this->assertAttributeSame('d/m/Y H:i:s', 'dateFormat', $log);

Tests/LogTest.php

@@ -14,7 +14,7 @@ class LogTest extends TestCase
      */
     private $SUT;
 
-    public function testAttachAndDetach()
+    public function test_attach_and_detach()
     {
         $processor = new Memory([]);
         $this->assertAttributeCount(0, 'processors', $this->SUT);
@@ -26,14 +26,14 @@ public function testAttachAndDetach()
         $this->assertAttributeCount(0, 'processors', $this->SUT);
     }
 
-    public function testMessagesStack()
+    public function test_messages_stack()
     {
         $this->assertAttributeCount(0, 'messages', $this->SUT);
         $this->SUT->alert('Hello');
         $this->assertAttributeCount(1, 'messages', $this->SUT);
     }
 
-    public function testMessageBlock()
+    public function test_message_block()
     {
         $this->SUT->alert('Hello {you}', ['you' => 'the most awesome person in the universe']);
         $message = $this->getMessages()[0];
@@ -44,7 +44,7 @@ public function testMessageBlock()
         $this->assertInternalType('string', $message['timestamp']);
     }
 
-    public function testUnsupportedLevelShouldPassToDefaultLevel()
+    public function test_unsupported_level_should_pass_to_default_level()
     {
         $this->SUT->log('', '');
         $message = $this->getMessages()[0];
@@ -53,14 +53,14 @@ public function testUnsupportedLevelShouldPassToDefaultLevel()
         $this->assertSame('LOG', $message['levelname']);
     }
 
-    public function testExceptionAttribute()
+    public function test_exception_attribute()
     {
         $processor = new Memory([]);
         $this->SUT->exception(new Exception('The message', 1), $processor);
         $this->assertAttributeContains('ALERT: The message', 'formatted', $processor);
     }
 
-    public function testLogSuppression()
+    public function test_log_suppression()
     {
         $processor = new Memory([
             'levels' => 0 // suppress the logger completely
@@ -78,7 +78,7 @@ public function testLogSuppression()
         $this->assertSame('', $processor->formatted());
     }
 
-    public function testRegister()
+    public function test_register()
     {
         $mock = $this
             ->getMockBuilder(Log::class)

Tests/Processors/CliTest.php

@@ -8,7 +8,7 @@
 class CliTest extends TestCase
 {
 
-    public function testFormatting()
+    public function test_formatting()
     {
         $processor = new Cli([]);
 

Tests/Processors/DefaultProcessorPropertiesTest.php

@@ -8,15 +8,15 @@
 class DefaultProcessorPropertiesTest extends TestCase
 {
 
-    public function testDefaults()
+    public function test_defaults()
     {
         $processor = new Voided([]);
         $this->assertAttributeSame(-1, 'levels', $processor);
         $this->assertAttributeSame('[timestamp] levelname: message', 'format', $processor);
         $this->assertAttributeSame('', 'formatted', $processor);
     }
 
-    public function testConstructorSettings()
+    public function test_constructor_settings()
     {
         $processor = new Memory([
             'levels' => Logger::ALERT | Logger::NOTICE | Logger::WARNING,

Tests/Processors/ErrorLogTest.php

@@ -8,7 +8,7 @@
 class ErrorLogTest extends TestCase
 {
 
-    public function testFormatting()
+    public function test_formatting()
     {
         $processor = new ErrorLog([]);
 

Tests/Processors/FileTest.php

@@ -19,7 +19,7 @@ class FileTest extends TestCase
      * @dataProvider dataMessage
      * @param $message
      */
-    public function testFormatting($message)
+    public function test_formatting($message)
     {
         $subdirectory = date('Y/m');
         $file = date('d') . '.log';
@@ -37,7 +37,7 @@ public function testFormatting($message)
      * @dataProvider dataMessage
      * @param $message
      */
-    public function testWhenDirectoryDoesNotExist($message)
+    public function test_when_directory_does_not_exist($message)
     {
         $dir = $this->dir->url() . '/nonexistent';
 
@@ -52,7 +52,7 @@ public function testWhenDirectoryDoesNotExist($message)
      * @dataProvider dataMessage
      * @param $message
      */
-    public function testWhenDirectoryIsNotWritable($message)
+    public function test_when_directory_is_not_writable($message)
     {
         $dir = $this->dir->url();
 

Tests/Processors/MemoryTest.php

@@ -7,7 +7,7 @@
 class MemoryTest extends TestCase
 {
 
-    public function testFormatting()
+    public function test_formatting()
     {
         $processor = new Memory([]);
 

Tests/Processors/SyslogTest.php

@@ -8,7 +8,7 @@
 class SyslogTest extends TestCase
 {
 
-    public function testFormatting()
+    public function test_formatting()
     {
         $processor = new Syslog([]);