Merge pull request #2 from OnrampLab/issue-1-feat-can-log-classpath-to-context

can log classpath to context

Close #1

Author: koshuang

.circleci/config.yml

@@ -0,0 +1,49 @@
+version: 2.1
+
+commands:
+  run_test:
+    description: "Run test"
+    steps:
+      - checkout
+      - restore_cache:
+          key: dependency-cache-composer-{{ checksum "composer.json" }}
+      - run:
+          name: Install php extensions
+          command: |
+            sudo docker-php-ext-configure pdo_mysql --with-pdo-mysql=mysqlnd
+            sudo docker-php-ext-install pcntl pdo_mysql
+      - run:
+          name: Install composer packages
+          command: |
+            composer install
+      - save_cache:
+          key: dependency-cache-composer-{{ checksum "composer.json" }}
+          paths:
+            - ~/app/vendor
+      - run:
+          name: Do static analysis
+          command: |
+            vendor/bin/phpstan
+      - run:
+          name: Test
+          command: |
+            vendor/bin/phpunit -d memory_limit=386M
+
+jobs:
+  run_test:
+    working_directory: ~/app
+    docker:
+      - image: circleci/php:7.4.3
+    steps:
+      - run_test
+
+workflows:
+  version: 2
+  build-deploy:
+    jobs:
+      - run_test:
+          filters:
+            tags:
+              only: /^v.*/
+            branches:
+              only: /.*/

.gitignore

@@ -4,4 +4,5 @@
 /composer.lock
 /.DS_Store
 /.idea
-/.php_cs.cache
+/.php_cs.cache
+/.phpunit.result.cache

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "onramplab/laravel-log-enhancement",
-    "description": "Your Package Description here",
+    "description": "An enhanced logging package for Laravel",
     "type": "library",
     "license": "MIT",
     "keywords": [],
@@ -14,13 +14,15 @@
     "prefer-stable":true,
     "require": {},
     "require-dev": {
-        "symfony/thanks": "^1.0",
-        "phpunit/phpunit": "^7.4@dev",
-        "mockery/mockery": "^1.0@dev",
-        "orchestra/testbench": "^3.8@dev",
-        "orchestra/database": "^3.8@dev",
-        "illuminate/support": "^5.8@dev",
-        "fzaninotto/faker": "^1.9@dev"
+        "fzaninotto/faker": "^1.9@dev",
+        "illuminate/support": "^7.0",
+        "mockery/mockery": "^1.3.2",
+        "orchestra/database": "^5.0",
+        "orchestra/testbench": "^5.0",
+        "phpstan/phpstan": "^0.12.64",
+        "phpunit/phpunit": "^8.0",
+        "sempro/phpunit-pretty-print": "1.2.2",
+        "symfony/thanks": "^1.0"
     },
     "autoload": {
         "psr-4": {

phpstan.neon

@@ -0,0 +1,20 @@
+includes:
+    - ./vendor/nunomaduro/larastan/extension.neon
+
+parameters:
+
+    paths:
+        - src
+
+    # The level 8 is the highest level
+    level: 0
+
+    # ignoreErrors:
+    #    - '#Unsafe usage of new static#'
+
+    excludes_analyse:
+        - ./*/*/Tests/*.php
+        - ./*/*/factories/*.php
+        - ./*/*/Migrations/*.php
+
+    checkMissingIterableValueType: false

phpunit.xml

@@ -2,6 +2,7 @@
 <phpunit bootstrap="vendor/autoload.php"
          backupGlobals="false"
          backupStaticAttributes="false"
+         printerClass="Sempro\PHPUnitPrettyPrinter\PrettyPrinter"
          colors="true"
          verbose="true"
          convertErrorsToExceptions="true"
@@ -30,4 +31,4 @@
         <env name="DB_CONNECTION" value="sqlite"/>
         <env name="DB_DATABASE" value=":memory:"/>
     </php>
-</phpunit>
+</phpunit>

src/Concerns/LogWithClassPath.php

@@ -0,0 +1,57 @@
+<?php
+namespace Onramplab\LaravelLogEnhancement\Concerns;
+
+use Illuminate\Support\Facades\Log;
+
+trait LogWithClassPath {
+    public function debug(string $message, array $context = [])
+    {
+        $this->log('debug', $message, $context);
+    }
+
+    public function info(string $message, array $context = [])
+    {
+        $this->log('info', $message, $context);
+    }
+
+    public function notice(string $message, array $context = [])
+    {
+        $this->log('notice', $message, $context);
+    }
+
+    public function warning(string $message, array $context = [])
+    {
+        $this->log('warning', $message, $context);
+    }
+
+    public function error(string $message, array $context = [])
+    {
+        $this->log('error', $message, $context);
+    }
+
+    public function critical(string $message, array $context = [])
+    {
+        $this->log('critical', $message, $context);
+    }
+
+
+    public function alert(string $message, array $context = [])
+    {
+        $this->log('alert', $message, $context);
+    }
+
+    public function emergency(string $message, array $context = [])
+    {
+        $this->log('emergency', $message, $context);
+    }
+
+    protected function log(string $logLevel, string $message, array $context = [])
+    {
+        $className = get_class($this);
+        $context = array_merge($context, [
+            'class_path' => $className,
+        ]);
+
+        Log::log($logLevel, $message, $context);
+    }
+}

tests/Feature/ExampleTest.php

@@ -11,12 +11,12 @@ public function setup() : void
     {
         parent::setUp();
         $this->withoutExceptionHandling();
-        $this->artisan('migrate', ['--database' => 'testing']);
+        // $this->artisan('migrate', ['--database' => 'testing']);
 
-        $this->loadMigrationsFrom(__DIR__ . '/../src/database/migrations');
-        $this->loadLaravelMigrations(['--database' => 'testing']);
+        // $this->loadMigrationsFrom(__DIR__ . '/../src/database/migrations');
+        // $this->loadLaravelMigrations(['--database' => 'testing']);
 
-        $this->withFactories(__DIR__.'/../src/database/factories');
+        // $this->withFactories(__DIR__.'/../src/database/factories');
     }
 
     protected function getEnvironmentSetUp($app)

tests/TestCase.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement\Tests\Unit\Concerns;
+
+use Onramplab\LaravelLogEnhancement\Tests\TestCase;
+use Illuminate\Support\Facades\Log;
+use Onramplab\LaravelLogEnhancement\Concerns\LogWithClassPath;
+
+class LogWithClassPathTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @return void
+     */
+    public function log_should_include_class_path_in_context()
+    {
+      $this->object = new Fake();
+      Log::spy();
+
+      $this->object->run();
+
+      Log
+        ::shouldHaveReceived('log', function ($logLevel, $message, $context) {
+          return $logLevel === 'info'
+            && $message === 'Test'
+            && $context['class_path'] === 'Onramplab\LaravelLogEnhancement\Tests\Unit\Concerns\Fake';
+        })
+        ->once();
+    }
+}
+
+class Fake {
+  use LogWithClassPath;
+
+  public function run()
+  {
+    $this->info('Test');
+  }
+}