@@ -13,12 +13,12 @@ |
||
13 | 13 | */ |
14 | 14 | interface LoggerAwareInterface |
15 | 15 | { |
16 | - /** |
|
17 | - * Sets a logger instance on the object. |
|
18 | - * |
|
19 | - * @param LoggerInterface $logger |
|
20 | - * |
|
21 | - * @return void |
|
22 | - */ |
|
23 | - public function setLogger(LoggerInterface $logger); |
|
16 | + /** |
|
17 | + * Sets a logger instance on the object. |
|
18 | + * |
|
19 | + * @param LoggerInterface $logger |
|
20 | + * |
|
21 | + * @return void |
|
22 | + */ |
|
23 | + public function setLogger(LoggerInterface $logger); |
|
24 | 24 | } |
@@ -13,12 +13,12 @@ |
||
13 | 13 | */ |
14 | 14 | class LogLevel |
15 | 15 | { |
16 | - const EMERGENCY = 'emergency'; |
|
17 | - const ALERT = 'alert'; |
|
18 | - const CRITICAL = 'critical'; |
|
19 | - const ERROR = 'error'; |
|
20 | - const WARNING = 'warning'; |
|
21 | - const NOTICE = 'notice'; |
|
22 | - const INFO = 'info'; |
|
23 | - const DEBUG = 'debug'; |
|
16 | + const EMERGENCY = 'emergency'; |
|
17 | + const ALERT = 'alert'; |
|
18 | + const CRITICAL = 'critical'; |
|
19 | + const ERROR = 'error'; |
|
20 | + const WARNING = 'warning'; |
|
21 | + const NOTICE = 'notice'; |
|
22 | + const INFO = 'info'; |
|
23 | + const DEBUG = 'debug'; |
|
24 | 24 | } |
@@ -18,19 +18,19 @@ |
||
18 | 18 | */ |
19 | 19 | class NullLogger extends AbstractLogger |
20 | 20 | { |
21 | - /** |
|
22 | - * Logs with an arbitrary level. |
|
23 | - * |
|
24 | - * @param mixed $level |
|
25 | - * @param string $message |
|
26 | - * @param array $context |
|
27 | - * |
|
28 | - * @return void |
|
29 | - * |
|
30 | - * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
31 | - */ |
|
32 | - public function log($level, $message, array $context = array()) |
|
33 | - { |
|
34 | - // noop |
|
35 | - } |
|
21 | + /** |
|
22 | + * Logs with an arbitrary level. |
|
23 | + * |
|
24 | + * @param mixed $level |
|
25 | + * @param string $message |
|
26 | + * @param array $context |
|
27 | + * |
|
28 | + * @return void |
|
29 | + * |
|
30 | + * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
31 | + */ |
|
32 | + public function log($level, $message, array $context = array()) |
|
33 | + { |
|
34 | + // noop |
|
35 | + } |
|
36 | 36 | } |
@@ -18,131 +18,131 @@ |
||
18 | 18 | */ |
19 | 19 | trait LoggerTrait |
20 | 20 | { |
21 | - /** |
|
22 | - * System is unusable. |
|
23 | - * |
|
24 | - * @param string $message |
|
25 | - * @param array $context |
|
26 | - * |
|
27 | - * @return void |
|
28 | - */ |
|
29 | - public function emergency($message, array $context = array()) |
|
30 | - { |
|
31 | - $this->log(LogLevel::EMERGENCY, $message, $context); |
|
32 | - } |
|
21 | + /** |
|
22 | + * System is unusable. |
|
23 | + * |
|
24 | + * @param string $message |
|
25 | + * @param array $context |
|
26 | + * |
|
27 | + * @return void |
|
28 | + */ |
|
29 | + public function emergency($message, array $context = array()) |
|
30 | + { |
|
31 | + $this->log(LogLevel::EMERGENCY, $message, $context); |
|
32 | + } |
|
33 | 33 | |
34 | - /** |
|
35 | - * Action must be taken immediately. |
|
36 | - * |
|
37 | - * Example: Entire website down, database unavailable, etc. This should |
|
38 | - * trigger the SMS alerts and wake you up. |
|
39 | - * |
|
40 | - * @param string $message |
|
41 | - * @param array $context |
|
42 | - * |
|
43 | - * @return void |
|
44 | - */ |
|
45 | - public function alert($message, array $context = array()) |
|
46 | - { |
|
47 | - $this->log(LogLevel::ALERT, $message, $context); |
|
48 | - } |
|
34 | + /** |
|
35 | + * Action must be taken immediately. |
|
36 | + * |
|
37 | + * Example: Entire website down, database unavailable, etc. This should |
|
38 | + * trigger the SMS alerts and wake you up. |
|
39 | + * |
|
40 | + * @param string $message |
|
41 | + * @param array $context |
|
42 | + * |
|
43 | + * @return void |
|
44 | + */ |
|
45 | + public function alert($message, array $context = array()) |
|
46 | + { |
|
47 | + $this->log(LogLevel::ALERT, $message, $context); |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * Critical conditions. |
|
52 | - * |
|
53 | - * Example: Application component unavailable, unexpected exception. |
|
54 | - * |
|
55 | - * @param string $message |
|
56 | - * @param array $context |
|
57 | - * |
|
58 | - * @return void |
|
59 | - */ |
|
60 | - public function critical($message, array $context = array()) |
|
61 | - { |
|
62 | - $this->log(LogLevel::CRITICAL, $message, $context); |
|
63 | - } |
|
50 | + /** |
|
51 | + * Critical conditions. |
|
52 | + * |
|
53 | + * Example: Application component unavailable, unexpected exception. |
|
54 | + * |
|
55 | + * @param string $message |
|
56 | + * @param array $context |
|
57 | + * |
|
58 | + * @return void |
|
59 | + */ |
|
60 | + public function critical($message, array $context = array()) |
|
61 | + { |
|
62 | + $this->log(LogLevel::CRITICAL, $message, $context); |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * Runtime errors that do not require immediate action but should typically |
|
67 | - * be logged and monitored. |
|
68 | - * |
|
69 | - * @param string $message |
|
70 | - * @param array $context |
|
71 | - * |
|
72 | - * @return void |
|
73 | - */ |
|
74 | - public function error($message, array $context = array()) |
|
75 | - { |
|
76 | - $this->log(LogLevel::ERROR, $message, $context); |
|
77 | - } |
|
65 | + /** |
|
66 | + * Runtime errors that do not require immediate action but should typically |
|
67 | + * be logged and monitored. |
|
68 | + * |
|
69 | + * @param string $message |
|
70 | + * @param array $context |
|
71 | + * |
|
72 | + * @return void |
|
73 | + */ |
|
74 | + public function error($message, array $context = array()) |
|
75 | + { |
|
76 | + $this->log(LogLevel::ERROR, $message, $context); |
|
77 | + } |
|
78 | 78 | |
79 | - /** |
|
80 | - * Exceptional occurrences that are not errors. |
|
81 | - * |
|
82 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
83 | - * that are not necessarily wrong. |
|
84 | - * |
|
85 | - * @param string $message |
|
86 | - * @param array $context |
|
87 | - * |
|
88 | - * @return void |
|
89 | - */ |
|
90 | - public function warning($message, array $context = array()) |
|
91 | - { |
|
92 | - $this->log(LogLevel::WARNING, $message, $context); |
|
93 | - } |
|
79 | + /** |
|
80 | + * Exceptional occurrences that are not errors. |
|
81 | + * |
|
82 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
83 | + * that are not necessarily wrong. |
|
84 | + * |
|
85 | + * @param string $message |
|
86 | + * @param array $context |
|
87 | + * |
|
88 | + * @return void |
|
89 | + */ |
|
90 | + public function warning($message, array $context = array()) |
|
91 | + { |
|
92 | + $this->log(LogLevel::WARNING, $message, $context); |
|
93 | + } |
|
94 | 94 | |
95 | - /** |
|
96 | - * Normal but significant events. |
|
97 | - * |
|
98 | - * @param string $message |
|
99 | - * @param array $context |
|
100 | - * |
|
101 | - * @return void |
|
102 | - */ |
|
103 | - public function notice($message, array $context = array()) |
|
104 | - { |
|
105 | - $this->log(LogLevel::NOTICE, $message, $context); |
|
106 | - } |
|
95 | + /** |
|
96 | + * Normal but significant events. |
|
97 | + * |
|
98 | + * @param string $message |
|
99 | + * @param array $context |
|
100 | + * |
|
101 | + * @return void |
|
102 | + */ |
|
103 | + public function notice($message, array $context = array()) |
|
104 | + { |
|
105 | + $this->log(LogLevel::NOTICE, $message, $context); |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * Interesting events. |
|
110 | - * |
|
111 | - * Example: User logs in, SQL logs. |
|
112 | - * |
|
113 | - * @param string $message |
|
114 | - * @param array $context |
|
115 | - * |
|
116 | - * @return void |
|
117 | - */ |
|
118 | - public function info($message, array $context = array()) |
|
119 | - { |
|
120 | - $this->log(LogLevel::INFO, $message, $context); |
|
121 | - } |
|
108 | + /** |
|
109 | + * Interesting events. |
|
110 | + * |
|
111 | + * Example: User logs in, SQL logs. |
|
112 | + * |
|
113 | + * @param string $message |
|
114 | + * @param array $context |
|
115 | + * |
|
116 | + * @return void |
|
117 | + */ |
|
118 | + public function info($message, array $context = array()) |
|
119 | + { |
|
120 | + $this->log(LogLevel::INFO, $message, $context); |
|
121 | + } |
|
122 | 122 | |
123 | - /** |
|
124 | - * Detailed debug information. |
|
125 | - * |
|
126 | - * @param string $message |
|
127 | - * @param array $context |
|
128 | - * |
|
129 | - * @return void |
|
130 | - */ |
|
131 | - public function debug($message, array $context = array()) |
|
132 | - { |
|
133 | - $this->log(LogLevel::DEBUG, $message, $context); |
|
134 | - } |
|
123 | + /** |
|
124 | + * Detailed debug information. |
|
125 | + * |
|
126 | + * @param string $message |
|
127 | + * @param array $context |
|
128 | + * |
|
129 | + * @return void |
|
130 | + */ |
|
131 | + public function debug($message, array $context = array()) |
|
132 | + { |
|
133 | + $this->log(LogLevel::DEBUG, $message, $context); |
|
134 | + } |
|
135 | 135 | |
136 | - /** |
|
137 | - * Logs with an arbitrary level. |
|
138 | - * |
|
139 | - * @param mixed $level |
|
140 | - * @param string $message |
|
141 | - * @param array $context |
|
142 | - * |
|
143 | - * @return void |
|
144 | - * |
|
145 | - * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
146 | - */ |
|
147 | - abstract public function log($level, $message, array $context = array()); |
|
136 | + /** |
|
137 | + * Logs with an arbitrary level. |
|
138 | + * |
|
139 | + * @param mixed $level |
|
140 | + * @param string $message |
|
141 | + * @param array $context |
|
142 | + * |
|
143 | + * @return void |
|
144 | + * |
|
145 | + * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
146 | + */ |
|
147 | + abstract public function log($level, $message, array $context = array()); |
|
148 | 148 | } |
@@ -62,92 +62,92 @@ |
||
62 | 62 | */ |
63 | 63 | class TestLogger extends AbstractLogger |
64 | 64 | { |
65 | - /** |
|
66 | - * @var array |
|
67 | - */ |
|
68 | - public $records = []; |
|
65 | + /** |
|
66 | + * @var array |
|
67 | + */ |
|
68 | + public $records = []; |
|
69 | 69 | |
70 | - public $recordsByLevel = []; |
|
70 | + public $recordsByLevel = []; |
|
71 | 71 | |
72 | - /** |
|
73 | - * @inheritdoc |
|
74 | - */ |
|
75 | - public function log($level, $message, array $context = []) |
|
76 | - { |
|
77 | - $record = [ |
|
78 | - 'level' => $level, |
|
79 | - 'message' => $message, |
|
80 | - 'context' => $context, |
|
81 | - ]; |
|
72 | + /** |
|
73 | + * @inheritdoc |
|
74 | + */ |
|
75 | + public function log($level, $message, array $context = []) |
|
76 | + { |
|
77 | + $record = [ |
|
78 | + 'level' => $level, |
|
79 | + 'message' => $message, |
|
80 | + 'context' => $context, |
|
81 | + ]; |
|
82 | 82 | |
83 | - $this->recordsByLevel[$record['level']][] = $record; |
|
84 | - $this->records[] = $record; |
|
85 | - } |
|
83 | + $this->recordsByLevel[$record['level']][] = $record; |
|
84 | + $this->records[] = $record; |
|
85 | + } |
|
86 | 86 | |
87 | - public function hasRecords($level) |
|
88 | - { |
|
89 | - return isset($this->recordsByLevel[$level]); |
|
90 | - } |
|
87 | + public function hasRecords($level) |
|
88 | + { |
|
89 | + return isset($this->recordsByLevel[$level]); |
|
90 | + } |
|
91 | 91 | |
92 | - public function hasRecord($record, $level) |
|
93 | - { |
|
94 | - if (is_string($record)) { |
|
95 | - $record = ['message' => $record]; |
|
96 | - } |
|
97 | - return $this->hasRecordThatPasses(function ($rec) use ($record) { |
|
98 | - if ($rec['message'] !== $record['message']) { |
|
99 | - return false; |
|
100 | - } |
|
101 | - if (isset($record['context']) && $rec['context'] !== $record['context']) { |
|
102 | - return false; |
|
103 | - } |
|
104 | - return true; |
|
105 | - }, $level); |
|
106 | - } |
|
92 | + public function hasRecord($record, $level) |
|
93 | + { |
|
94 | + if (is_string($record)) { |
|
95 | + $record = ['message' => $record]; |
|
96 | + } |
|
97 | + return $this->hasRecordThatPasses(function ($rec) use ($record) { |
|
98 | + if ($rec['message'] !== $record['message']) { |
|
99 | + return false; |
|
100 | + } |
|
101 | + if (isset($record['context']) && $rec['context'] !== $record['context']) { |
|
102 | + return false; |
|
103 | + } |
|
104 | + return true; |
|
105 | + }, $level); |
|
106 | + } |
|
107 | 107 | |
108 | - public function hasRecordThatContains($message, $level) |
|
109 | - { |
|
110 | - return $this->hasRecordThatPasses(function ($rec) use ($message) { |
|
111 | - return strpos($rec['message'], $message) !== false; |
|
112 | - }, $level); |
|
113 | - } |
|
108 | + public function hasRecordThatContains($message, $level) |
|
109 | + { |
|
110 | + return $this->hasRecordThatPasses(function ($rec) use ($message) { |
|
111 | + return strpos($rec['message'], $message) !== false; |
|
112 | + }, $level); |
|
113 | + } |
|
114 | 114 | |
115 | - public function hasRecordThatMatches($regex, $level) |
|
116 | - { |
|
117 | - return $this->hasRecordThatPasses(function ($rec) use ($regex) { |
|
118 | - return preg_match($regex, $rec['message']) > 0; |
|
119 | - }, $level); |
|
120 | - } |
|
115 | + public function hasRecordThatMatches($regex, $level) |
|
116 | + { |
|
117 | + return $this->hasRecordThatPasses(function ($rec) use ($regex) { |
|
118 | + return preg_match($regex, $rec['message']) > 0; |
|
119 | + }, $level); |
|
120 | + } |
|
121 | 121 | |
122 | - public function hasRecordThatPasses(callable $predicate, $level) |
|
123 | - { |
|
124 | - if (!isset($this->recordsByLevel[$level])) { |
|
125 | - return false; |
|
126 | - } |
|
127 | - foreach ($this->recordsByLevel[$level] as $i => $rec) { |
|
128 | - if (call_user_func($predicate, $rec, $i)) { |
|
129 | - return true; |
|
130 | - } |
|
131 | - } |
|
132 | - return false; |
|
133 | - } |
|
122 | + public function hasRecordThatPasses(callable $predicate, $level) |
|
123 | + { |
|
124 | + if (!isset($this->recordsByLevel[$level])) { |
|
125 | + return false; |
|
126 | + } |
|
127 | + foreach ($this->recordsByLevel[$level] as $i => $rec) { |
|
128 | + if (call_user_func($predicate, $rec, $i)) { |
|
129 | + return true; |
|
130 | + } |
|
131 | + } |
|
132 | + return false; |
|
133 | + } |
|
134 | 134 | |
135 | - public function __call($method, $args) |
|
136 | - { |
|
137 | - if (preg_match('/(.*)(Debug|Info|Notice|Warning|Error|Critical|Alert|Emergency)(.*)/', $method, $matches) > 0) { |
|
138 | - $genericMethod = $matches[1] . ('Records' !== $matches[3] ? 'Record' : '') . $matches[3]; |
|
139 | - $level = strtolower($matches[2]); |
|
140 | - if (method_exists($this, $genericMethod)) { |
|
141 | - $args[] = $level; |
|
142 | - return call_user_func_array([$this, $genericMethod], $args); |
|
143 | - } |
|
144 | - } |
|
145 | - throw new \BadMethodCallException('Call to undefined method ' . get_class($this) . '::' . $method . '()'); |
|
146 | - } |
|
135 | + public function __call($method, $args) |
|
136 | + { |
|
137 | + if (preg_match('/(.*)(Debug|Info|Notice|Warning|Error|Critical|Alert|Emergency)(.*)/', $method, $matches) > 0) { |
|
138 | + $genericMethod = $matches[1] . ('Records' !== $matches[3] ? 'Record' : '') . $matches[3]; |
|
139 | + $level = strtolower($matches[2]); |
|
140 | + if (method_exists($this, $genericMethod)) { |
|
141 | + $args[] = $level; |
|
142 | + return call_user_func_array([$this, $genericMethod], $args); |
|
143 | + } |
|
144 | + } |
|
145 | + throw new \BadMethodCallException('Call to undefined method ' . get_class($this) . '::' . $method . '()'); |
|
146 | + } |
|
147 | 147 | |
148 | - public function reset() |
|
149 | - { |
|
150 | - $this->records = []; |
|
151 | - $this->recordsByLevel = []; |
|
152 | - } |
|
148 | + public function reset() |
|
149 | + { |
|
150 | + $this->records = []; |
|
151 | + $this->recordsByLevel = []; |
|
152 | + } |
|
153 | 153 | } |
@@ -20,125 +20,125 @@ |
||
20 | 20 | */ |
21 | 21 | abstract class LoggerInterfaceTest extends TestCase |
22 | 22 | { |
23 | - /** |
|
24 | - * @return LoggerInterface |
|
25 | - */ |
|
26 | - abstract public function getLogger(); |
|
27 | - |
|
28 | - /** |
|
29 | - * This must return the log messages in order. |
|
30 | - * |
|
31 | - * The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>". |
|
32 | - * |
|
33 | - * Example ->error('Foo') would yield "error Foo". |
|
34 | - * |
|
35 | - * @return string[] |
|
36 | - */ |
|
37 | - abstract public function getLogs(); |
|
38 | - |
|
39 | - public function testImplements() |
|
40 | - { |
|
41 | - $this->assertInstanceOf('GravityView\Psr\Log\LoggerInterface', $this->getLogger()); |
|
42 | - } |
|
43 | - |
|
44 | - /** |
|
45 | - * @dataProvider provideLevelsAndMessages |
|
46 | - */ |
|
47 | - public function testLogsAtAllLevels($level, $message) |
|
48 | - { |
|
49 | - $logger = $this->getLogger(); |
|
50 | - $logger->{$level}($message, array('user' => 'Bob')); |
|
51 | - $logger->log($level, $message, array('user' => 'Bob')); |
|
52 | - |
|
53 | - $expected = array( |
|
54 | - $level.' message of level '.$level.' with context: Bob', |
|
55 | - $level.' message of level '.$level.' with context: Bob', |
|
56 | - ); |
|
57 | - $this->assertEquals($expected, $this->getLogs()); |
|
58 | - } |
|
59 | - |
|
60 | - public function provideLevelsAndMessages() |
|
61 | - { |
|
62 | - return array( |
|
63 | - LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), |
|
64 | - LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'), |
|
65 | - LogLevel::CRITICAL => array(LogLevel::CRITICAL, 'message of level critical with context: {user}'), |
|
66 | - LogLevel::ERROR => array(LogLevel::ERROR, 'message of level error with context: {user}'), |
|
67 | - LogLevel::WARNING => array(LogLevel::WARNING, 'message of level warning with context: {user}'), |
|
68 | - LogLevel::NOTICE => array(LogLevel::NOTICE, 'message of level notice with context: {user}'), |
|
69 | - LogLevel::INFO => array(LogLevel::INFO, 'message of level info with context: {user}'), |
|
70 | - LogLevel::DEBUG => array(LogLevel::DEBUG, 'message of level debug with context: {user}'), |
|
71 | - ); |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * @expectedException \GravityView\Psr\Log\InvalidArgumentException |
|
76 | - */ |
|
77 | - public function testThrowsOnInvalidLevel() |
|
78 | - { |
|
79 | - $logger = $this->getLogger(); |
|
80 | - $logger->log('invalid level', 'Foo'); |
|
81 | - } |
|
82 | - |
|
83 | - public function testContextReplacement() |
|
84 | - { |
|
85 | - $logger = $this->getLogger(); |
|
86 | - $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar')); |
|
87 | - |
|
88 | - $expected = array('info {Message {nothing} Bob Bar a}'); |
|
89 | - $this->assertEquals($expected, $this->getLogs()); |
|
90 | - } |
|
91 | - |
|
92 | - public function testObjectCastToString() |
|
93 | - { |
|
94 | - if (method_exists($this, 'createPartialMock')) { |
|
95 | - $dummy = $this->createPartialMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
96 | - } else { |
|
97 | - $dummy = $this->getMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
98 | - } |
|
99 | - $dummy->expects($this->once()) |
|
100 | - ->method('__toString') |
|
101 | - ->will($this->returnValue('DUMMY')); |
|
102 | - |
|
103 | - $this->getLogger()->warning($dummy); |
|
104 | - |
|
105 | - $expected = array('warning DUMMY'); |
|
106 | - $this->assertEquals($expected, $this->getLogs()); |
|
107 | - } |
|
108 | - |
|
109 | - public function testContextCanContainAnything() |
|
110 | - { |
|
111 | - $closed = fopen('php://memory', 'r'); |
|
112 | - fclose($closed); |
|
113 | - |
|
114 | - $context = array( |
|
115 | - 'bool' => true, |
|
116 | - 'null' => null, |
|
117 | - 'string' => 'Foo', |
|
118 | - 'int' => 0, |
|
119 | - 'float' => 0.5, |
|
120 | - 'nested' => array('with object' => new DummyTest), |
|
121 | - 'object' => new \DateTime, |
|
122 | - 'resource' => fopen('php://memory', 'r'), |
|
123 | - 'closed' => $closed, |
|
124 | - ); |
|
125 | - |
|
126 | - $this->getLogger()->warning('Crazy context data', $context); |
|
127 | - |
|
128 | - $expected = array('warning Crazy context data'); |
|
129 | - $this->assertEquals($expected, $this->getLogs()); |
|
130 | - } |
|
131 | - |
|
132 | - public function testContextExceptionKeyCanBeExceptionOrOtherValues() |
|
133 | - { |
|
134 | - $logger = $this->getLogger(); |
|
135 | - $logger->warning('Random message', array('exception' => 'oops')); |
|
136 | - $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail'))); |
|
137 | - |
|
138 | - $expected = array( |
|
139 | - 'warning Random message', |
|
140 | - 'critical Uncaught Exception!' |
|
141 | - ); |
|
142 | - $this->assertEquals($expected, $this->getLogs()); |
|
143 | - } |
|
23 | + /** |
|
24 | + * @return LoggerInterface |
|
25 | + */ |
|
26 | + abstract public function getLogger(); |
|
27 | + |
|
28 | + /** |
|
29 | + * This must return the log messages in order. |
|
30 | + * |
|
31 | + * The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>". |
|
32 | + * |
|
33 | + * Example ->error('Foo') would yield "error Foo". |
|
34 | + * |
|
35 | + * @return string[] |
|
36 | + */ |
|
37 | + abstract public function getLogs(); |
|
38 | + |
|
39 | + public function testImplements() |
|
40 | + { |
|
41 | + $this->assertInstanceOf('GravityView\Psr\Log\LoggerInterface', $this->getLogger()); |
|
42 | + } |
|
43 | + |
|
44 | + /** |
|
45 | + * @dataProvider provideLevelsAndMessages |
|
46 | + */ |
|
47 | + public function testLogsAtAllLevels($level, $message) |
|
48 | + { |
|
49 | + $logger = $this->getLogger(); |
|
50 | + $logger->{$level}($message, array('user' => 'Bob')); |
|
51 | + $logger->log($level, $message, array('user' => 'Bob')); |
|
52 | + |
|
53 | + $expected = array( |
|
54 | + $level.' message of level '.$level.' with context: Bob', |
|
55 | + $level.' message of level '.$level.' with context: Bob', |
|
56 | + ); |
|
57 | + $this->assertEquals($expected, $this->getLogs()); |
|
58 | + } |
|
59 | + |
|
60 | + public function provideLevelsAndMessages() |
|
61 | + { |
|
62 | + return array( |
|
63 | + LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), |
|
64 | + LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'), |
|
65 | + LogLevel::CRITICAL => array(LogLevel::CRITICAL, 'message of level critical with context: {user}'), |
|
66 | + LogLevel::ERROR => array(LogLevel::ERROR, 'message of level error with context: {user}'), |
|
67 | + LogLevel::WARNING => array(LogLevel::WARNING, 'message of level warning with context: {user}'), |
|
68 | + LogLevel::NOTICE => array(LogLevel::NOTICE, 'message of level notice with context: {user}'), |
|
69 | + LogLevel::INFO => array(LogLevel::INFO, 'message of level info with context: {user}'), |
|
70 | + LogLevel::DEBUG => array(LogLevel::DEBUG, 'message of level debug with context: {user}'), |
|
71 | + ); |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * @expectedException \GravityView\Psr\Log\InvalidArgumentException |
|
76 | + */ |
|
77 | + public function testThrowsOnInvalidLevel() |
|
78 | + { |
|
79 | + $logger = $this->getLogger(); |
|
80 | + $logger->log('invalid level', 'Foo'); |
|
81 | + } |
|
82 | + |
|
83 | + public function testContextReplacement() |
|
84 | + { |
|
85 | + $logger = $this->getLogger(); |
|
86 | + $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar')); |
|
87 | + |
|
88 | + $expected = array('info {Message {nothing} Bob Bar a}'); |
|
89 | + $this->assertEquals($expected, $this->getLogs()); |
|
90 | + } |
|
91 | + |
|
92 | + public function testObjectCastToString() |
|
93 | + { |
|
94 | + if (method_exists($this, 'createPartialMock')) { |
|
95 | + $dummy = $this->createPartialMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
96 | + } else { |
|
97 | + $dummy = $this->getMock('GravityView\GravityView\Psr\Log\Test\DummyTest', array('__toString')); |
|
98 | + } |
|
99 | + $dummy->expects($this->once()) |
|
100 | + ->method('__toString') |
|
101 | + ->will($this->returnValue('DUMMY')); |
|
102 | + |
|
103 | + $this->getLogger()->warning($dummy); |
|
104 | + |
|
105 | + $expected = array('warning DUMMY'); |
|
106 | + $this->assertEquals($expected, $this->getLogs()); |
|
107 | + } |
|
108 | + |
|
109 | + public function testContextCanContainAnything() |
|
110 | + { |
|
111 | + $closed = fopen('php://memory', 'r'); |
|
112 | + fclose($closed); |
|
113 | + |
|
114 | + $context = array( |
|
115 | + 'bool' => true, |
|
116 | + 'null' => null, |
|
117 | + 'string' => 'Foo', |
|
118 | + 'int' => 0, |
|
119 | + 'float' => 0.5, |
|
120 | + 'nested' => array('with object' => new DummyTest), |
|
121 | + 'object' => new \DateTime, |
|
122 | + 'resource' => fopen('php://memory', 'r'), |
|
123 | + 'closed' => $closed, |
|
124 | + ); |
|
125 | + |
|
126 | + $this->getLogger()->warning('Crazy context data', $context); |
|
127 | + |
|
128 | + $expected = array('warning Crazy context data'); |
|
129 | + $this->assertEquals($expected, $this->getLogs()); |
|
130 | + } |
|
131 | + |
|
132 | + public function testContextExceptionKeyCanBeExceptionOrOtherValues() |
|
133 | + { |
|
134 | + $logger = $this->getLogger(); |
|
135 | + $logger->warning('Random message', array('exception' => 'oops')); |
|
136 | + $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail'))); |
|
137 | + |
|
138 | + $expected = array( |
|
139 | + 'warning Random message', |
|
140 | + 'critical Uncaught Exception!' |
|
141 | + ); |
|
142 | + $this->assertEquals($expected, $this->getLogs()); |
|
143 | + } |
|
144 | 144 | } |
@@ -17,8 +17,8 @@ |
||
17 | 17 | */ |
18 | 18 | class DummyTest |
19 | 19 | { |
20 | - public function __toString() |
|
21 | - { |
|
22 | - return 'DummyTest'; |
|
23 | - } |
|
20 | + public function __toString() |
|
21 | + { |
|
22 | + return 'DummyTest'; |
|
23 | + } |
|
24 | 24 | } |
@@ -25,107 +25,107 @@ |
||
25 | 25 | */ |
26 | 26 | interface LoggerInterface |
27 | 27 | { |
28 | - /** |
|
29 | - * System is unusable. |
|
30 | - * |
|
31 | - * @param string $message |
|
32 | - * @param mixed[] $context |
|
33 | - * |
|
34 | - * @return void |
|
35 | - */ |
|
36 | - public function emergency($message, array $context = array()); |
|
28 | + /** |
|
29 | + * System is unusable. |
|
30 | + * |
|
31 | + * @param string $message |
|
32 | + * @param mixed[] $context |
|
33 | + * |
|
34 | + * @return void |
|
35 | + */ |
|
36 | + public function emergency($message, array $context = array()); |
|
37 | 37 | |
38 | - /** |
|
39 | - * Action must be taken immediately. |
|
40 | - * |
|
41 | - * Example: Entire website down, database unavailable, etc. This should |
|
42 | - * trigger the SMS alerts and wake you up. |
|
43 | - * |
|
44 | - * @param string $message |
|
45 | - * @param mixed[] $context |
|
46 | - * |
|
47 | - * @return void |
|
48 | - */ |
|
49 | - public function alert($message, array $context = array()); |
|
38 | + /** |
|
39 | + * Action must be taken immediately. |
|
40 | + * |
|
41 | + * Example: Entire website down, database unavailable, etc. This should |
|
42 | + * trigger the SMS alerts and wake you up. |
|
43 | + * |
|
44 | + * @param string $message |
|
45 | + * @param mixed[] $context |
|
46 | + * |
|
47 | + * @return void |
|
48 | + */ |
|
49 | + public function alert($message, array $context = array()); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Critical conditions. |
|
53 | - * |
|
54 | - * Example: Application component unavailable, unexpected exception. |
|
55 | - * |
|
56 | - * @param string $message |
|
57 | - * @param mixed[] $context |
|
58 | - * |
|
59 | - * @return void |
|
60 | - */ |
|
61 | - public function critical($message, array $context = array()); |
|
51 | + /** |
|
52 | + * Critical conditions. |
|
53 | + * |
|
54 | + * Example: Application component unavailable, unexpected exception. |
|
55 | + * |
|
56 | + * @param string $message |
|
57 | + * @param mixed[] $context |
|
58 | + * |
|
59 | + * @return void |
|
60 | + */ |
|
61 | + public function critical($message, array $context = array()); |
|
62 | 62 | |
63 | - /** |
|
64 | - * Runtime errors that do not require immediate action but should typically |
|
65 | - * be logged and monitored. |
|
66 | - * |
|
67 | - * @param string $message |
|
68 | - * @param mixed[] $context |
|
69 | - * |
|
70 | - * @return void |
|
71 | - */ |
|
72 | - public function error($message, array $context = array()); |
|
63 | + /** |
|
64 | + * Runtime errors that do not require immediate action but should typically |
|
65 | + * be logged and monitored. |
|
66 | + * |
|
67 | + * @param string $message |
|
68 | + * @param mixed[] $context |
|
69 | + * |
|
70 | + * @return void |
|
71 | + */ |
|
72 | + public function error($message, array $context = array()); |
|
73 | 73 | |
74 | - /** |
|
75 | - * Exceptional occurrences that are not errors. |
|
76 | - * |
|
77 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
78 | - * that are not necessarily wrong. |
|
79 | - * |
|
80 | - * @param string $message |
|
81 | - * @param mixed[] $context |
|
82 | - * |
|
83 | - * @return void |
|
84 | - */ |
|
85 | - public function warning($message, array $context = array()); |
|
74 | + /** |
|
75 | + * Exceptional occurrences that are not errors. |
|
76 | + * |
|
77 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
78 | + * that are not necessarily wrong. |
|
79 | + * |
|
80 | + * @param string $message |
|
81 | + * @param mixed[] $context |
|
82 | + * |
|
83 | + * @return void |
|
84 | + */ |
|
85 | + public function warning($message, array $context = array()); |
|
86 | 86 | |
87 | - /** |
|
88 | - * Normal but significant events. |
|
89 | - * |
|
90 | - * @param string $message |
|
91 | - * @param mixed[] $context |
|
92 | - * |
|
93 | - * @return void |
|
94 | - */ |
|
95 | - public function notice($message, array $context = array()); |
|
87 | + /** |
|
88 | + * Normal but significant events. |
|
89 | + * |
|
90 | + * @param string $message |
|
91 | + * @param mixed[] $context |
|
92 | + * |
|
93 | + * @return void |
|
94 | + */ |
|
95 | + public function notice($message, array $context = array()); |
|
96 | 96 | |
97 | - /** |
|
98 | - * Interesting events. |
|
99 | - * |
|
100 | - * Example: User logs in, SQL logs. |
|
101 | - * |
|
102 | - * @param string $message |
|
103 | - * @param mixed[] $context |
|
104 | - * |
|
105 | - * @return void |
|
106 | - */ |
|
107 | - public function info($message, array $context = array()); |
|
97 | + /** |
|
98 | + * Interesting events. |
|
99 | + * |
|
100 | + * Example: User logs in, SQL logs. |
|
101 | + * |
|
102 | + * @param string $message |
|
103 | + * @param mixed[] $context |
|
104 | + * |
|
105 | + * @return void |
|
106 | + */ |
|
107 | + public function info($message, array $context = array()); |
|
108 | 108 | |
109 | - /** |
|
110 | - * Detailed debug information. |
|
111 | - * |
|
112 | - * @param string $message |
|
113 | - * @param mixed[] $context |
|
114 | - * |
|
115 | - * @return void |
|
116 | - */ |
|
117 | - public function debug($message, array $context = array()); |
|
109 | + /** |
|
110 | + * Detailed debug information. |
|
111 | + * |
|
112 | + * @param string $message |
|
113 | + * @param mixed[] $context |
|
114 | + * |
|
115 | + * @return void |
|
116 | + */ |
|
117 | + public function debug($message, array $context = array()); |
|
118 | 118 | |
119 | - /** |
|
120 | - * Logs with an arbitrary level. |
|
121 | - * |
|
122 | - * @param mixed $level |
|
123 | - * @param string $message |
|
124 | - * @param mixed[] $context |
|
125 | - * |
|
126 | - * @return void |
|
127 | - * |
|
128 | - * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
129 | - */ |
|
130 | - public function log($level, $message, array $context = array()); |
|
119 | + /** |
|
120 | + * Logs with an arbitrary level. |
|
121 | + * |
|
122 | + * @param mixed $level |
|
123 | + * @param string $message |
|
124 | + * @param mixed[] $context |
|
125 | + * |
|
126 | + * @return void |
|
127 | + * |
|
128 | + * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
129 | + */ |
|
130 | + public function log($level, $message, array $context = array()); |
|
131 | 131 | } |
@@ -2,19 +2,19 @@ |
||
2 | 2 | // autoload.php @generated by Strauss |
3 | 3 | |
4 | 4 | if ( file_exists( __DIR__ . '/autoload-classmap.php' ) ) { |
5 | - $class_map = include __DIR__ . '/autoload-classmap.php'; |
|
6 | - if ( is_array( $class_map ) ) { |
|
7 | - spl_autoload_register( |
|
8 | - function ( $classname ) use ( $class_map ) { |
|
9 | - if ( isset( $class_map[ $classname ] ) && file_exists( $class_map[ $classname ] ) ) { |
|
10 | - require_once $class_map[ $classname ]; |
|
11 | - } |
|
12 | - } |
|
13 | - ); |
|
14 | - } |
|
15 | - unset( $class_map ); |
|
5 | + $class_map = include __DIR__ . '/autoload-classmap.php'; |
|
6 | + if ( is_array( $class_map ) ) { |
|
7 | + spl_autoload_register( |
|
8 | + function ( $classname ) use ( $class_map ) { |
|
9 | + if ( isset( $class_map[ $classname ] ) && file_exists( $class_map[ $classname ] ) ) { |
|
10 | + require_once $class_map[ $classname ]; |
|
11 | + } |
|
12 | + } |
|
13 | + ); |
|
14 | + } |
|
15 | + unset( $class_map ); |
|
16 | 16 | } |
17 | 17 | |
18 | 18 | if ( file_exists( __DIR__ . '/autoload-files.php' ) ) { |
19 | - require_once __DIR__ . '/autoload-files.php'; |
|
19 | + require_once __DIR__ . '/autoload-files.php'; |
|
20 | 20 | } |
21 | 21 | \ No newline at end of file |