Added activity history to to all entities. Fixes #12

.gitignore

@@ -10,3 +10,4 @@ Homestead.yaml
 /public/uploads
 /public/bower
 /storage/images
+_ide_helper.php

app/Activity.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Oxbow;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property string key
+ * @property \User user
+ * @property \Entity entity
+ * @property string extra
+ */
+class Activity extends Model
+{
+    public function entity()
+    {
+        if($this->entity_id) {
+            return $this->morphTo('entity')->first();
+        } else {
+            return false;
+        }
+    }
+
+    public function user()
+    {
+        return $this->belongsTo('Oxbow\User');
+    }
+
+    /**
+     * Returns text from the language files, Looks up by using the
+     * activity key.
+     */
+    public function getText()
+    {
+        return trans('activities.' . $this->key);
+    }
+
+}

app/Book.php

@@ -37,4 +37,15 @@ class Book extends Entity
         return $pages->sortBy('priority');
     }
 
+    /**
+     * Gets only the most recent activity for this book
+     * @param int $limit
+     * @param int $page
+     * @return mixed
+     */
+    public function recentActivity($limit = 20, $page=0)
+    {
+        return $this->hasMany('Oxbow\Activity')->orderBy('created_at', 'desc')->skip($limit*$page)->take($limit)->get();
+    }
+
 }

app/Entity.php

@@ -34,4 +34,25 @@ class Entity extends Model
     {
         return [get_class($this), $this->id] === [get_class($entity), $entity->id];
     }
+
+    /**
+     * Gets the activity for this entity.
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function activity()
+    {
+        return $this->morphMany('Oxbow\Activity', 'entity')->orderBy('created_at', 'desc');
+    }
+
+    /**
+     * Gets only the most recent activity
+     * @param int $limit
+     * @param int $page
+     * @return mixed
+     */
+    public function recentActivity($limit = 20, $page=0)
+    {
+        return $this->activity()->skip($limit*$page)->take($limit)->get();
+    }
+
 }

app/Http/Controllers/BookController.php

@@ -2,6 +2,7 @@
 
 namespace Oxbow\Http\Controllers;
 
+use Activity;
 use Illuminate\Http\Request;
 
 use Illuminate\Support\Facades\Auth;
@@ -65,6 +66,7 @@ class BookController extends Controller
         $book->created_by = Auth::user()->id;
         $book->updated_by = Auth::user()->id;
         $book->save();
+        Activity::add($book, 'book_create', $book->id);
         return redirect('/books');
     }
 
@@ -110,6 +112,7 @@ class BookController extends Controller
         $book->slug = $this->bookRepo->findSuitableSlug($book->name, $book->id);
         $book->updated_by = Auth::user()->id;
         $book->save();
+        Activity::add($book, 'book_update', $book->id);
         return redirect($book->getUrl());
     }
 
@@ -132,7 +135,9 @@ class BookController extends Controller
      */
     public function destroy($bookSlug)
     {
+        $bookName = $this->bookRepo->getBySlug($bookSlug)->name;
         $this->bookRepo->destroyBySlug($bookSlug);
+        Activity::addMessage('book_delete', 0, $bookName);
         return redirect('/books');
     }
 }

app/Http/Controllers/ChapterController.php

@@ -2,6 +2,7 @@
 
 namespace Oxbow\Http\Controllers;
 
+use Activity;
 use Illuminate\Http\Request;
 
 use Illuminate\Support\Facades\Auth;
@@ -60,6 +61,7 @@ class ChapterController extends Controller
         $chapter->created_by = Auth::user()->id;
         $chapter->updated_by = Auth::user()->id;
         $book->chapters()->save($chapter);
+        Activity::add($chapter, 'chapter_create', $book->id);
         return redirect($book->getUrl());
     }
 
@@ -107,6 +109,7 @@ class ChapterController extends Controller
         $chapter->slug = $this->chapterRepo->findSuitableSlug($chapter->name, $book->id, $chapter->id);
         $chapter->updated_by = Auth::user()->id;
         $chapter->save();
+        Activity::add($chapter, 'chapter_update', $book->id);
         return redirect($chapter->getUrl());
     }
 
@@ -134,6 +137,7 @@ class ChapterController extends Controller
     {
         $book = $this->bookRepo->getBySlug($bookSlug);
         $chapter = $this->chapterRepo->getBySlug($chapterSlug, $book->id);
+        $chapterName = $chapter->name;
         if(count($chapter->pages) > 0) {
             foreach($chapter->pages as $page) {
                 $page->chapter_id = 0;
@@ -141,6 +145,7 @@ class ChapterController extends Controller
             }
         }
         $chapter->delete();
+        Activity::addMessage('chapter_delete', $book->id, $chapterName);
         return redirect($book->getUrl());
     }
 }

app/Http/Controllers/PageController.php

@@ -2,10 +2,10 @@
 
 namespace Oxbow\Http\Controllers;
 
+use Activity;
 use Illuminate\Http\Request;
 
 use Illuminate\Support\Facades\Auth;
-use Illuminate\Support\Str;
 use Oxbow\Http\Requests;
 use Oxbow\Repos\BookRepo;
 use Oxbow\Repos\ChapterRepo;
@@ -76,6 +76,7 @@ class PageController extends Controller
         $page->updated_by = Auth::user()->id;
         $page->save();
         $this->pageRepo->saveRevision($page);
+        Activity::add($page, 'page_create', $book->id);
         return redirect($page->getUrl());
     }
 
@@ -120,6 +121,7 @@ class PageController extends Controller
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $this->pageRepo->updatePage($page, $book->id, $request->all());
+        Activity::add($page, 'page_update', $book->id);
         return redirect($page->getUrl());
     }
 
@@ -187,6 +189,7 @@ class PageController extends Controller
             }
             $model->save();
         }
+        Activity::add($book, 'book_sort', $book->id);
         return redirect($book->getUrl());
     }
 
@@ -215,6 +218,7 @@ class PageController extends Controller
     {
         $book = $this->bookRepo->getBySlug($bookSlug);
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
+        Activity::addMessage('page_delete', $book->id, $page->name);
         $page->delete();
         return redirect($book->getUrl());
     }
@@ -254,6 +258,7 @@ class PageController extends Controller
         $page = $this->pageRepo->getBySlug($pageSlug, $book->id);
         $revision = $this->pageRepo->getRevisionById($revisionId);
         $page = $this->pageRepo->updatePage($page, $book->id, $revision->toArray());
+        Activity::add($page, 'page_restore', $book->id);
         return redirect($page->getUrl());
     }
 }

app/Providers/CustomFacadeProvider.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Oxbow\Providers;
+
+use Illuminate\Support\ServiceProvider;
+use Oxbow\Services\ActivityService;
+
+class CustomFacadeProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->bind('activity', function() {
+            return new ActivityService($this->app->make('Oxbow\Activity'));
+        });
+    }
+}

app/Services/ActivityService.php

@@ -0,0 +1,57 @@
+<?php namespace Oxbow\Services;
+
+use Illuminate\Support\Facades\Auth;
+use Oxbow\Activity;
+use Oxbow\Entity;
+
+class ActivityService
+{
+    protected $activity;
+    protected $user;
+
+    /**
+     * ActivityService constructor.
+     * @param $activity
+     */
+    public function __construct(Activity $activity)
+    {
+        $this->activity = $activity;
+        $this->user = Auth::user();
+    }
+
+
+    /**
+     * Add activity data to database.
+     * @para Entity $entity
+     * @param $activityKey
+     * @param int $bookId
+     */
+    public function add(Entity $entity, $activityKey, $bookId = 0, $extra = false)
+    {
+        $this->activity->user_id = $this->user->id;
+        $this->activity->book_id = $bookId;
+        $this->activity->key = strtolower($activityKey);
+        if($extra !== false) {
+            $this->activity->extra = $extra;
+        }
+        $entity->activity()->save($this->activity);
+    }
+
+    /**
+     * Adds a activity history with a message & without binding to a entitiy.
+     * @param $activityKey
+     * @param int $bookId
+     * @param bool|false $extra
+     */
+    public function addMessage($activityKey, $bookId = 0, $extra = false)
+    {
+        $this->activity->user_id = $this->user->id;
+        $this->activity->book_id = $bookId;
+        $this->activity->key = strtolower($activityKey);
+        if($extra !== false) {
+            $this->activity->extra = $extra;
+        }
+        $this->activity->save();
+    }
+
+}

app/Services/Facades/Activity.php

@@ -0,0 +1,14 @@
+<?php namespace Oxbow\Services\Facades;
+
+
+use Illuminate\Support\Facades\Facade;
+
+class Activity extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor() { return 'activity'; }
+}

composer.json

@@ -7,7 +7,8 @@
     "require": {
         "php": ">=5.5.9",
         "laravel/framework": "5.1.*",
-        "intervention/image": "^2.3"
+        "intervention/image": "^2.3",
+        "barryvdh/laravel-ide-helper": "^2.1"
     },
     "require-dev": {
         "fzaninotto/faker": "~1.4",

config/app.php

@@ -141,6 +141,8 @@ return [
          * Third Party
          */
         Intervention\Image\ImageServiceProvider::class,
+        Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
+
 
         /*
          * Application Service Providers...
@@ -148,6 +150,7 @@ return [
         Oxbow\Providers\AppServiceProvider::class,
         Oxbow\Providers\EventServiceProvider::class,
         Oxbow\Providers\RouteServiceProvider::class,
+        Oxbow\Providers\CustomFacadeProvider::class,
 
     ],
 
@@ -203,6 +206,12 @@ return [
 
         'ImageTool' => Intervention\Image\Facades\Image::class,
 
+        /**
+         * Custom
+         */
+
+        'Activity' => Oxbow\Services\Facades\Activity::class,
+
     ],
 
 ];

database/migrations/2015_08_16_142133_create_activities_table.php

@@ -0,0 +1,36 @@
+<?php
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateActivitiesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('activities', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('key');
+            $table->text('extra');
+            $table->integer('book_id')->indexed();
+            $table->integer('user_id');
+            $table->integer('entity_id');
+            $table->string('entity_type');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::drop('activities');
+    }
+}

resources/assets/sass/styles.scss

@@ -424,3 +424,9 @@ body.dragging, body.dragging * {
     color: #EEE;
   }
 }
+
+.activity-list-item {
+  padding: $-s 0;
+  color: #888;
+  border-bottom: 1px solid #EEE;
+}

resources/lang/en/activities.php

@@ -0,0 +1,26 @@
+<?php
+
+return [
+
+    /**
+     * Activity text strings.
+     * Is used for all the text within activity logs.
+     */
+
+    // Pages
+    'page_create' => 'created page',
+    'page_update' => 'updated page',
+    'page_delete' => 'deleted page',
+    'page_restore' => 'restored page',
+
+    // Chapters
+    'chapter_create' => 'created chapter',
+    'chapter_update' => 'updated chapter',
+    'chapter_delete' => 'deleted chapter',
+
+    // Books
+    'book_create' => 'created book',
+    'book_update' => 'updated book',
+    'book_delete' => 'deleted book',
+
+];

resources/views/books/show.blade.php

@@ -15,6 +15,9 @@
         </div>
     </div>
 
+    <div class="row">
+        <div class="col-md-6 col-md-offset-1">
+
             <div class="page-content">
                 <h1>{{$book->name}}</h1>
                 <p class="text-muted">{{$book->description}}</p>
@@ -57,6 +60,17 @@
 
             </div>
 
+        </div>
+
+        <div class="col-md-3 col-md-offset-1">
+            <div class="margin-top large"><br></div>
+            <h3>Recent Activity</h3>
+            @include('partials/activity-list', ['entity' => $book])
+        </div>
+    </div>
+
+
+
 
     <script>
         $(function() {

resources/views/partials/activity-item.blade.php

@@ -0,0 +1,16 @@
+
+{{--Requires an Activity item with the name $activity passed in--}}
+
+@if($activity->user) {{$activity->user->name}} @endif
+
+{{ $activity->getText() }}
+
+@if($activity->entity())
+    <a href="{{ $activity->entity()->getUrl() }}">{{ $activity->entity()->name }}</a>
+@endif
+
+@if($activity->extra) "{{$activity->extra}}" @endif
+
+<br>
+
+<span class="text-muted"><small><i class="zmdi zmdi-time"></i>{{ $activity->created_at->diffForHumans() }}</small></span>

resources/views/partials/activity-list.blade.php

@@ -0,0 +1,12 @@
+
+{{--Requires an entity to be passed with the name $entity--}}
+
+@if(count($entity->recentActivity()) > 0)
+    <div class="activity-list">
+        @foreach($entity->recentActivity() as $activity)
+            <div class="activity-list-item">
+                @include('partials/activity-item')
+            </div>
+        @endforeach
+    </div>
+@endif