From 55b980c12db37a9d6989a818e2700451eda6c7f2 Mon Sep 17 00:00:00 2001 From: Timm Friebe Date: Sat, 22 Aug 2015 14:49:28 +0200 Subject: [PATCH 1/3] Implement %d token, inserting date in YYYY-MM-DD format --- README.md | 1 + src/main/php/util/log/layout/PatternLayout.class.php | 4 +++- src/test/php/util/log/unittest/PatternLayoutTest.class.php | 5 +++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 508d63a..fd50c12 100755 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ supported: * `%c` - Category name * `%l` - Log level - lowercase * `%L` - Log level - uppercase +* `%d` - Date in YYYY-MM-DD * `%t` - Time in HH:MM:SS * `%p` - Process ID * `%%` - A literal percent sign (%) diff --git a/src/main/php/util/log/layout/PatternLayout.class.php b/src/main/php/util/log/layout/PatternLayout.class.php index 74dd955..e72aa76 100755 --- a/src/main/php/util/log/layout/PatternLayout.class.php +++ b/src/main/php/util/log/layout/PatternLayout.class.php @@ -13,6 +13,7 @@ *
  • %c - Category name
    • *
  • %l - Log level - lowercase
    • *
  • %L - Log level - uppercase
    • + *
  • %d - Date in YYYY-MM-DD
    • *
  • %t - Time in HH:MM:SS
    • *
  • %p - Process ID
    • *
  • %% - A literal percent sign (%)
    • @@ -46,7 +47,7 @@ public function __construct($format) { break; } default: { // Any other character - verify it's supported - if (!strspn($format{$i}, 'mclLtpx')) { + if (!strspn($format{$i}, 'mclLtdpx')) { throw new \lang\IllegalArgumentException('Unknown format token "'.$format{$i}.'"'); } $this->format[]= '%'.$format{$i}; @@ -70,6 +71,7 @@ public function format(\util\log\LoggingEvent $event) { switch ($token) { case '%m': $out.= implode(' ', array_map([$this, 'stringOf'], $event->getArguments())); break; case '%t': $out.= gmdate('H:i:s', $event->getTimestamp()); break; + case '%d': $out.= gmdate('Y-m-d', $event->getTimestamp()); break; case '%c': $out.= $event->getCategory()->identifier; break; case '%l': $out.= strtolower(\util\log\LogLevel::nameOf($event->getLevel())); break; case '%L': $out.= strtoupper(\util\log\LogLevel::nameOf($event->getLevel())); break; diff --git a/src/test/php/util/log/unittest/PatternLayoutTest.class.php b/src/test/php/util/log/unittest/PatternLayoutTest.class.php index 3ac96fe..53b5829 100644 --- a/src/test/php/util/log/unittest/PatternLayoutTest.class.php +++ b/src/test/php/util/log/unittest/PatternLayoutTest.class.php @@ -55,6 +55,11 @@ public function uppercase_loglevel() { $this->assertEquals('WARN', (new PatternLayout('%L'))->format($this->newLoggingEvent())); } + #[@test] + public function date_in_YYYY_MM_DD() { + $this->assertEquals('2009-11-20', (new PatternLayout('%d'))->format($this->newLoggingEvent())); + } + #[@test] public function time_in_HH_MM_SS() { $this->assertEquals('16:08:04', (new PatternLayout('%t'))->format($this->newLoggingEvent())); From 04de198e75c2a51dbca0f016b3452b6fe51457a7 Mon Sep 17 00:00:00 2001 From: Timm Friebe Date: Sat, 22 Aug 2015 14:55:20 +0200 Subject: [PATCH 2/3] Refactor and simplify code --- .../log/unittest/PatternLayoutTest.class.php | 47 ++++++++----------- 1 file changed, 19 insertions(+), 28 deletions(-) diff --git a/src/test/php/util/log/unittest/PatternLayoutTest.class.php b/src/test/php/util/log/unittest/PatternLayoutTest.class.php index 53b5829..263971f 100644 --- a/src/test/php/util/log/unittest/PatternLayoutTest.class.php +++ b/src/test/php/util/log/unittest/PatternLayoutTest.class.php @@ -10,19 +10,20 @@ class PatternLayoutTest extends \unittest\TestCase { /** - * Creates a new logging event + * Formats a given logging event * + * @param string $pattern * @param util.log.LogCategory $cat - * @return util.log.LoggingEvent + * @return string */ - private function newLoggingEvent($cat= null) { - return new LoggingEvent( + private function format($pattern, $cat= null) { + return (new PatternLayout($pattern))->format(new LoggingEvent( $cat ?: new LogCategory('default'), 1258733284, 1214, LogLevel::WARN, ['Hello'] - ); + )); } #[@test, @expect(IllegalArgumentException::class)] @@ -37,52 +38,52 @@ public function unterminated_format_token() { #[@test] public function message() { - $this->assertEquals('Hello', (new PatternLayout('%m'))->format($this->newLoggingEvent())); + $this->assertEquals('Hello', $this->format('%m')); } #[@test] public function category_name() { - $this->assertEquals('default', (new PatternLayout('%c'))->format($this->newLoggingEvent())); + $this->assertEquals('default', $this->format('%c')); } #[@test] public function lowercase_loglevel() { - $this->assertEquals('warn', (new PatternLayout('%l'))->format($this->newLoggingEvent())); + $this->assertEquals('warn', $this->format('%l')); } #[@test] public function uppercase_loglevel() { - $this->assertEquals('WARN', (new PatternLayout('%L'))->format($this->newLoggingEvent())); + $this->assertEquals('WARN', $this->format('%L')); } #[@test] public function date_in_YYYY_MM_DD() { - $this->assertEquals('2009-11-20', (new PatternLayout('%d'))->format($this->newLoggingEvent())); + $this->assertEquals('2009-11-20', $this->format('%d')); } #[@test] public function time_in_HH_MM_SS() { - $this->assertEquals('16:08:04', (new PatternLayout('%t'))->format($this->newLoggingEvent())); + $this->assertEquals('16:08:04', $this->format('%t')); } #[@test] public function process_id() { - $this->assertEquals('1214', (new PatternLayout('%p'))->format($this->newLoggingEvent())); + $this->assertEquals('1214', $this->format('%p')); } #[@test] public function literal_percent() { - $this->assertEquals('100%', (new PatternLayout('100%%'))->format($this->newLoggingEvent())); + $this->assertEquals('100%', $this->format('100%%')); } #[@test] public function line_break() { - $this->assertEquals("\n", (new PatternLayout('%n'))->format($this->newLoggingEvent())); + $this->assertEquals("\n", $this->format('%n')); } #[@test] public function context_when_not_available() { - $this->assertEquals('', (new PatternLayout('%x'))->format($this->newLoggingEvent())); + $this->assertEquals('', $this->format('%x')); } #[@test] @@ -90,26 +91,16 @@ public function context() { $context= new MappedLogContext(); $context->put('key1', 'val1'); - $this->assertEquals( - 'key1=val1', - (new PatternLayout('%x'))->format($this->newLoggingEvent(new LogCategory('default', LogLevel::ALL, $context))) - ); + $this->assertEquals('key1=val1', $this->format('%x', new LogCategory('default', LogLevel::ALL, $context))); } #[@test] public function simple_format() { - $this->assertEquals( - 'WARN [default] Hello', - (new PatternLayout('%L [%c] %m'))->format($this->newLoggingEvent()) - ); + $this->assertEquals('WARN [default] Hello', $this->format('%L [%c] %m')); } #[@test] public function default_format() { - $this->assertEquals( - '[16:08:04 1214 warn] Hello', - (new PatternLayout('[%t %p %l] %m'))->format($this->newLoggingEvent()) - ); + $this->assertEquals('[16:08:04 1214 warn] Hello', $this->format('[%t %p %l] %m')); } - } \ No newline at end of file From 9c0aa61d4dadb119d783772fc6a6cb14a58e552d Mon Sep 17 00:00:00 2001 From: Timm Friebe Date: Sat, 22 Aug 2015 15:05:27 +0200 Subject: [PATCH 3/3] QA: Import classes, use short names in class body --- .../util/log/layout/PatternLayout.class.php | 40 ++++++++++--------- 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/src/main/php/util/log/layout/PatternLayout.class.php b/src/main/php/util/log/layout/PatternLayout.class.php index e72aa76..55c1ec9 100755 --- a/src/main/php/util/log/layout/PatternLayout.class.php +++ b/src/main/php/util/log/layout/PatternLayout.class.php @@ -1,5 +1,9 @@ - *
  • %m - Message
    • - *
  • %c - Category name
    • - *
  • %l - Log level - lowercase
    • - *
  • %L - Log level - uppercase
    • - *
  • %d - Date in YYYY-MM-DD
    • - *
  • %t - Time in HH:MM:SS
    • - *
  • %p - Process ID
    • - *
  • %% - A literal percent sign (%)
    • - *
  • %n - A line break
    • - *
  • %x - Context information, if available
    • - * + * + * - %m - Message + * - %c - Category name + * - %l - Log level - lowercase + * - %L - Log level - uppercase + * - %d - Date in YYYY-MM-DD + * - %t - Time in HH:MM:SS + * - %p - Process ID + * - %% - A literal percent sign (%) + * - %n - A line break + * - %x - Context information, if available * * @test xp://net.xp_framework.unittest.logging.PatternLayoutTest */ @@ -29,13 +32,14 @@ class PatternLayout extends \util\log\Layout { /** * Creates a new pattern layout * - * @param string format + * @param string $format + * @throws lang.IllegalArgumentException */ public function __construct($format) { for ($i= 0, $s= strlen($format); $i < $s; $i++) { if ('%' === $format{$i}) { if (++$i >= $s) { - throw new \lang\IllegalArgumentException('Not enough input at position '.($i - 1)); + throw new IllegalArgumentException('Not enough input at position '.($i - 1)); } switch ($format{$i}) { case '%': { // Literal percent @@ -48,7 +52,7 @@ public function __construct($format) { } default: { // Any other character - verify it's supported if (!strspn($format{$i}, 'mclLtdpx')) { - throw new \lang\IllegalArgumentException('Unknown format token "'.$format{$i}.'"'); + throw new IllegalArgumentException('Unknown format token "'.$format{$i}.'"'); } $this->format[]= '%'.$format{$i}; } @@ -65,7 +69,7 @@ public function __construct($format) { * @param util.log.LoggingEvent event * @return string */ - public function format(\util\log\LoggingEvent $event) { + public function format(LoggingEvent $event) { $out= ''; foreach ($this->format as $token) { switch ($token) { @@ -73,8 +77,8 @@ public function format(\util\log\LoggingEvent $event) { case '%t': $out.= gmdate('H:i:s', $event->getTimestamp()); break; case '%d': $out.= gmdate('Y-m-d', $event->getTimestamp()); break; case '%c': $out.= $event->getCategory()->identifier; break; - case '%l': $out.= strtolower(\util\log\LogLevel::nameOf($event->getLevel())); break; - case '%L': $out.= strtoupper(\util\log\LogLevel::nameOf($event->getLevel())); break; + case '%l': $out.= strtolower(LogLevel::nameOf($event->getLevel())); break; + case '%L': $out.= strtoupper(LogLevel::nameOf($event->getLevel())); break; case '%p': $out.= $event->getProcessId(); break; case '%x': $out.= null == ($context= $event->getContext()) ? '' : $context->format(); break; default: $out.= $token;