first commit

Author: leeqvip

.gitignore

@@ -0,0 +1,9 @@
+/vendor/
+
+composer.lock
+
+.idea/
+*.iml
+
+# coverage report
+/build

.travis.yml

@@ -0,0 +1,20 @@
+language: php
+matrix:
+  fast_finish: true
+  include:
+    - php: 5.6
+    - php: 7.0
+    - php: 7.1
+    - php: 7.2
+    - php: 7.3
+    - php: 7.4snapshot
+
+install:
+ - composer install --prefer-dist --dev --no-interaction
+
+script:
+ - mkdir -p build/logs
+ - vendor/bin/phpunit
+
+after_script:
+ - travis_retry vendor/bin/php-coveralls -v

README.md

@@ -1,2 +1,48 @@
-# psr3-bridge
-This library provides a PSR-3 compliant bridge for Casbin Logger.
+# PSR-3 Bridge
+
+[![Build Status](https://travis-ci.org/php-casbin/psr3-bridge.svg?branch=master)](https://travis-ci.org/php-casbin/psr3-bridge)
+[![Coverage Status](https://coveralls.io/repos/github/php-casbin/psr3-bridge/badge.svg)](https://coveralls.io/github/php-casbin/psr3-bridge)
+[![Latest Stable Version](https://poser.pugx.org/casbin/psr3-bridge/v/stable)](https://packagist.org/packages/casbin/psr3-bridge)
+[![Total Downloads](https://poser.pugx.org/casbin/psr3-bridge/downloads)](https://packagist.org/packages/casbin/psr3-bridge)
+[![License](https://poser.pugx.org/casbin/psr3-bridge/license)](https://packagist.org/packages/casbin/psr3-bridge)
+
+This library provides a PSR-3 compliant bridge for `PHP-Casbin` Logger.
+
+[Casbin](https://github.com/php-casbin/php-casbin) is a powerful and efficient open-source access control library.
+
+### Installation
+
+Via [Composer](https://getcomposer.org/).
+
+```
+composer require casbin/psr3-bridge
+```
+
+### Usage
+
+Here is an example of using `Monolog`, `Monolog` implements the PSR-3 interface.
+
+You can use any other library that implements PSR-3 interface.
+
+```php
+
+use Casbin\Bridge\Logger\LoggerBridge;
+use Casbin\Log\Log;
+use Monolog\Logger;
+use Monolog\Handler\StreamHandler;
+
+
+$log = new Logger('name');
+$log->pushHandler(new StreamHandler('path/to/your.log', Logger::WARNING));
+
+
+Log::setLogger(new LoggerBridge($log));
+```
+
+### Getting Help
+
+- [php-casbin](https://github.com/php-casbin/php-casbin)
+
+### License
+
+This project is licensed under the [Apache 2.0 license](LICENSE).

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "casbin/psr3-bridge",
+    "keywords": [
+        "casbin",
+        "psr-3",
+        "logger",
+        "rbac",
+        "permission",
+        "acl"
+    ],
+    "description": "This library provides a PSR-3 compliant bridge for Casbin Logger.",
+    "authors": [
+        {
+            "name": "TechLee",
+            "email": "[email protected]"
+        }
+    ],
+    "license": "Apache-2.0",
+    "require": {
+        "casbin/casbin": "^1.0",
+        "psr/log": "^1.1"        
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~5.7|~6.0|~7.0",
+        "mockery/mockery": "^1.2",
+        "php-coveralls/php-coveralls": "^2.1"
+    },
+    "autoload": {
+        "psr-4": {
+            "Casbin\\Bridge\\Logger\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Casbin\\Bridge\\Logger\\Tests\\": "tests/"
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Application Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+        <log type="coverage-html" target="build/html"/>
+    </logging>
+    <php>
+        <env name="DB_DATABASE" value="casbin"/>
+    </php>
+</phpunit>

src/LoggerBridge.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace Casbin\Bridge\Logger;
+
+use Casbin\Log\Logger as LoggerContract;
+use Psr\Log\LoggerInterface;
+
+class LoggerBridge implements LoggerContract
+{
+    public $enable = false;
+
+    /**
+     * The log level.
+     *
+     * @var mixed
+     */
+    protected $defaultLevel;
+
+    /**
+     * The logger instance.
+     *
+     * @var LoggerInterface
+     */
+    protected $logger;
+
+    /**
+     * LoggerBridge constructor.
+     *
+     * @param LoggerInterface $logger
+     * @param string          $defaultLevel
+     */
+    public function __construct(LoggerInterface $logger, $defaultLevel = 'info')
+    {
+        $this->logger = $logger;
+        $this->defaultLevel = $defaultLevel;
+    }
+
+    /**
+     * controls whether print the message.
+     *
+     * @param bool $enable
+     */
+    public function enableLog($enable)
+    {
+        $this->enable = $enable;
+    }
+
+    /**
+     * returns if logger is enabled.
+     *
+     * @return bool
+     */
+    public function isEnabled()
+    {
+        return $this->enable;
+    }
+
+    /**
+     * formats using the default formats for its operands and logs the message.
+     *
+     * @param mixed ...$v
+     *
+     * @return mixed
+     */
+    public function write(...$v)
+    {
+        if (!$this->enable) {
+            return;
+        }
+
+        $content = '';
+
+        foreach ($v as $value) {
+            if (\is_array($value) || \is_object($value)) {
+                $value = json_encode($value);
+            }
+
+            $content .= $value;
+        }
+
+        $this->logger->log($this->defaultLevel, $content);
+    }
+
+    /**
+     * formats according to a format specifier and logs the message.
+     *
+     * @param $format
+     * @param mixed ...$v
+     *
+     * @return mixed
+     */
+    public function writef($format, ...$v)
+    {
+        if (!$this->enable) {
+            return;
+        }
+
+        $this->logger->log($this->defaultLevel, sprintf($format, ...$v));
+    }
+}

tests/LoggerBrdgeTest.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Casbin\Bridge\Logger\Tests;
+
+use Mockery;
+use Casbin\Bridge\Logger\LoggerBridge;
+use PHPUnit\Framework\TestCase;
+
+class LoggerTest extends TestCase
+{
+    public function testEnableLogger()
+    {
+        $testLog = Mockery::mock(TestLogger::class);
+
+        $defaultLevel = 'info';
+
+        $logger = new LoggerBridge($testLog, $defaultLevel);
+        $this->assertFalse($logger->isEnabled());
+
+        $logger->enableLog(true);
+        $this->assertTrue($logger->isEnabled());
+
+        $testLog->shouldReceive('log')->once()->with($defaultLevel, 'foo');
+        $logger->write('foo');
+
+        $testLog->shouldReceive('log')->once()->with($defaultLevel, 'foo1foo2');
+        $logger->write('foo1', 'foo2');
+
+        $testLog->shouldReceive('log')->once()->with($defaultLevel, json_encode(['foo1', 'foo2']));
+        $logger->write(['foo1', 'foo2']);
+
+        $testLog->shouldReceive('log')->once()->with($defaultLevel, sprintf('There are %u million cars in %s.', 2, 'Shanghai'));
+        $logger->writef('There are %u million cars in %s.', 2, 'Shanghai');
+
+        $testLog = Mockery::mock(TestLogger::class);
+
+        $logger = new LoggerBridge($testLog);
+
+        $logger->enableLog(false);
+
+        $testLog->shouldNotHaveReceived('log');
+        $logger->write(['foo1', 'foo2']);
+
+        $testLog->shouldNotHaveReceived('log');
+        $logger->writef('There are %u million cars in %s.', 2, 'Shanghai');
+    }
+
+    public function testDisableLogger()
+    {
+        $testLog = Mockery::mock(TestLogger::class);
+
+        $defaultLevel = 'info';
+
+        $logger = new LoggerBridge($testLog, $defaultLevel);
+
+        $logger->enableLog(false);
+        $this->assertFalse($logger->isEnabled());
+
+        $logger->enableLog(false);
+
+        $testLog->shouldNotHaveReceived('log');
+        $logger->write(['foo1', 'foo2']);
+
+        $testLog->shouldNotHaveReceived('log');
+        $logger->writef('There are %u million cars in %s.', 2, 'Shanghai');
+    }
+}