Initial commit

Author: jfrosorio

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+### Description
+
+Explain what are you submitting.
+
+### Fixes
+
+Enter the issue you are fixing (e.g. This fixes #1.).
+
+
+
+

.gitignore

@@ -1,23 +1 @@
-/vendor/
-node_modules/
-npm-debug.log
-yarn-error.log
-
-# Laravel 4 specific
-bootstrap/compiled.php
-app/storage/
-
-# Laravel 5 & Lumen specific
-public/storage
-public/hot
-
-# Laravel 5 & Lumen specific with changed public path
-public_html/storage
-public_html/hot
-
-storage/*.key
-.env
-Homestead.yaml
-Homestead.json
-/.vagrant
-.phpunit.result.cache
+/.idea

README.md

@@ -1 +1,50 @@
-# laravel-loggable
+# Laravel Publishable
+
+Laravel package to log CRUD operations.
+
+
+## Installation
+
+Add the package to your Laravel app using composer
+
+```
+composer require codetech/laravel-loggable
+```
+
+
+### Service Provider
+
+Register the package's service provider in config/app.php. In Laravel versions 5.5 and beyond, this step can be skipped if package auto-discovery is enabled.
+
+```
+'providers' => [
+
+    ...
+    CodeTech\Loggable\Providers\LoggableServiceProvider::class,
+    ...
+
+];
+```
+
+
+### Migrations
+
+Execute the next Artisan command to run the migrations.
+
+```
+php artisan migrate
+
+```
+
+
+## How to use
+
+To start logging CRUD operations simply use the trait on your models.
+
+```
+class Post extends Model
+{
+    use Loggable;
+
+    ...
+```

composer.json

@@ -0,0 +1,37 @@
+{
+  "name": "codetech/laravel-loggable",
+  "description": "Laravel package for handling publishable resources.",
+  "keywords": [
+    "codetech",
+    "laravel-loggable",
+    "laravel",
+    "crud",
+    "logging"
+  ],
+  "authors": [
+    {
+      "name": "José Osório",
+      "email": "jfrosorio@gmail.com",
+      "role": "Developer"
+    }
+  ],
+  "license": "MIT",
+  "require": {
+    "php": "^7.2",
+    "laravel/framework": "~6.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "CodeTech\\Loggable\\": "src/"
+    }
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "extra": {
+    "laravel": {
+      "providers": [
+        "CodeTech\\Loggable\\Providers\\LoggableServiceProvider"
+      ]
+    }
+  }
+}

src/ModelLog.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace CodeTech\Loggable\ModelLog;
+
+use CodeTechCMS\Modules\Users\Models\User;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+class ModelLog extends Model
+{
+    protected $fillable = [
+        'loggable_id',
+        'loggable_type',
+        'operation',
+        'user_id'
+    ];
+
+
+    /*
+    |--------------------------------------------------------------------------
+    | Scopes
+    |--------------------------------------------------------------------------
+    */
+
+    /**
+     * Scope a query to only include created operations.
+     *
+     * @param Builder $query
+     * @return Builder
+     */
+    public function scopeCreated(Builder $query)
+    {
+        return $query->where('operation', 'created');
+    }
+
+    /**
+     * Scope a query to only include updated operations.
+     *
+     * @param Builder $query
+     * @return Builder
+     */
+    public function scopeUpdated(Builder $query)
+    {
+        return $query->where('operation', 'updated');
+    }
+
+    /**
+     * Scope a query to only include deleted operations.
+     *
+     * @param Builder $query
+     * @return Builder
+     */
+    public function scopeDeleted(Builder $query)
+    {
+        return $query->where('operation', 'deleted');
+    }
+
+
+    /*
+    |--------------------------------------------------------------------------
+    | Relations
+    |--------------------------------------------------------------------------
+    */
+
+    /**
+     * Get the owning log model.
+     */
+    public function loggable()
+    {
+        return $this->morphTo();
+    }
+
+    /**
+     * Get the user that owns this model log.
+     *
+     * @return User
+     */
+    public function user()
+    {
+        return $this->belongsTo(User::class);
+    }
+}

src/Observers/LoggableObserver.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace CodeTech\Loggable\Observers;
+
+use CodeTech\Loggable\ModelLog\ModelLog;
+use Illuminate\Database\Eloquent\Model;
+
+class LoggableObserver
+{
+    /**
+     * Listen to the created event.
+     *
+     * @param Model $model
+     */
+    public function created(Model $model): void
+    {
+        $this->saveLog($model, 'created');
+    }
+
+    /**
+     * Listen to the updated event.
+     *
+     * @param Model $model
+     */
+    public function updated(Model $model): void
+    {
+        $this->saveLog($model, 'updated');
+    }
+
+    /**
+     * Listen to the deleted event.
+     *
+     * @param Model $model
+     */
+    public function deleted(Model $model): void
+    {
+        $this->saveLog($model, 'deleted');
+    }
+
+
+    /**
+     * Saves the action on the database.
+     *
+     * @param Model $model
+     * @param string $action
+     */
+    private function saveLog(Model $model, string $action): void
+    {
+        ModelLog::create(
+            [
+                'loggable_id'   => $model->id,
+                'loggable_type' => get_class($model),
+                'operation'     => $action,
+                'user_id'       => auth()->check() ? auth()->id() : null
+            ]
+        );
+    }
+}

src/Providers/LoggableServiceProvider.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace CodeTech\Loggable\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class LoggableServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //
+    }
+
+    /**
+     * Bootstrap services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        // Load migrations from custom path
+        $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
+    }
+}