init 1.0

.gitignore

@@ -1,2 +1,3 @@
 composer.lock
-vendor
+vendor
+.idea

.travis.yml

@@ -6,7 +6,10 @@ php:
   - 5.6
   - hhvm
 
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer install --prefer-source --no-interaction --dev
+
 script:
-  - mkdir -p build/logs
-  - phpunit --coverage-text
+  - ./vendor/bin/phpspec run -v
   - ./vendor/bin/phpcs src --standard=psr2

README.md

@@ -0,0 +1,270 @@
+# Sofa/Revisionable
+
+[![Code quality](https://scrutinizer-ci.com/g/jarektkaczyk/revisionable/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/jarektkaczyk/revisionable) [![Latest Stable Version](https://poser.pugx.org/sofa/revisionable/v/stable.svg)](https://packagist.org/packages/sofa/revisionable) [![Downloads](https://poser.pugx.org/sofa/revisionable/downloads.svg)](https://packagist.org/packages/sofa/revisionable)
+
+Nice and easy way to handle revisions of your db.
+
+* Handles the revisions in **bulk** - one entry covers all the created/updated fields, what makes it really **easy to eg. compare 2 given versions** or get all the data changed during single action. 
+
+
+## Requirements
+
+* This package requires PHP 5.4+
+* Currently it works out of the box with Laravel5 + generic Illuminate Guard OR cartalyst/sentry 2
+
+
+## Example display
+
+## Usage (Laravel5 basic example - see Customization below as well)
+
+### 1. Download the package or require in your `composer.json`:
+
+```
+    "require": {
+        ...
+        "sofa/revisionable": "~1.0@dev",
+        ...
+    },
+
+```
+
+### 2. Add the service provider to your `app/config/app.php`:
+
+```
+    'providers' => array(
+
+        ...
+
+        'Sofa\Revisionable\Laravel\ServiceProvider',
+    ),
+```
+
+### 3. Publish the package config file:
+
+```
+~$ php artisan vendor:publish [--provider="Sofa\Revisionable\Laravel\ServiceProvider"]
+```
+
+this will create `config/sofa_revisionable.php` file, where you can adjust a few settings:
+
+```
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | User provider (auth) implementation.
+    |--------------------------------------------------------------------------
+    |
+    | By default Laravel generic Illuminate\Auth\Guard.
+    |
+    | Supported options:
+    |  - illuminate
+    |  - sentry
+    */
+    'userprovider' => 'illuminate',
+
+
+    /*
+    |--------------------------------------------------------------------------
+    | User field to be saved as the author of tracked action.
+    |--------------------------------------------------------------------------
+    |
+    | By default:
+    |
+    |  - id for illuminate
+    |  - login field (email) for sentry
+    */
+    'userfield'    => null,
+
+
+    /*
+    |--------------------------------------------------------------------------
+    | Table used for the revisions.
+    |--------------------------------------------------------------------------
+    */
+    'table'        => 'revisions',
+
+];
+```
+
+
+### 4. Run the migration in order to create the revisions table:
+
+```
+~$ php artisan migrate [--database=custom_connection]
+```
+
+You can provide additional `--database` param if you want the migration to be run using non-default db connection.
+
+
+### 5. Add revisionable trait and contract to the models you wish to keep track of:
+
+```
+<?php namespace App;
+
+use Sofa\Revisionable\Laravel\RevisionableTrait; // trait
+use Sofa\Revisionable\Revisionable; // interface
+
+class User extends \Eloquent implements Revisionable {
+
+    use RevisionableTrait;
+
+    /*
+     * Set revisionable whitelist - only changes to any
+     * of these fields will be tracked during updates.
+     */
+    protected $revisionable = [
+        'email',
+        'name',
+    ];
+```
+
+
+And that's all to get your started!
+
+
+## Customization in L5
+
+**Default behaviour**:
+```
+namespace App\Models;
+
+use Sofa\Revisionable\Revisionable;
+use Sofa\Revisionable\Laravel\RevisionableTrait;
+
+
+class Ticket extends \Eloquent implements Revisionable {
+
+    use RevisionableTrait;
+}
+```
+
+
+```
+$ php artisan tinker
+
+>>> $ticket = App\Models\Ticket::first();
+=> <App\Models\Ticket>
+
+>>> $revision = $ticket->latestRevision;
+=> <Sofa\Revisionable\Laravel\Revision>
+
+>>> $revision->getDiff();
+=> [
+       "customer_id"    => [
+           "old" => "1",
+           "new" => "101"
+       ],
+       "item_id"        => [
+           "old" => "2",
+           "new" => "1"
+       ],
+       "responsible_id" => [
+           "old" => "8",
+           "new" => "2"
+       ]
+   ]
+
+>>> $revision->old('item_id');
+=> "2"
+
+>>> $revision->new('item_id');
+=> "1"
+
+>>> $revision->isUpdated('item_id');
+=> true
+
+>>> $revision->isUpdated('note');
+=> false
+
+>>> $revision->label('item_id');
+=> "item_id"
+
+>>> $revision->old;
+=> [
+       "defect"         => "nie dziala",
+       "note"           => "wrocilo na gwarancji",
+       "customer_id"    => "1",
+       "item_id"        => "2",
+       "responsible_id" => "8",
+       "status_id"      => "6"
+   ]
+
+>>> $revision->action;
+=> "updated"
+```
+
+But here's where you can leverage bundled `Presenter` in order to make useful adjustments:
+
+```
+namespace App\Models;
+
+use Sofa\Revisionable\Revisionable;
+use Sofa\Revisionable\Laravel\RevisionableTrait;
+
+
+class Ticket extends \Eloquent implements Revisionable {
+
+    use RevisionableTrait;
+
+    protected $revisionPresenter = 'App\Presenters\Revisions\Ticket';
+}
+```
+
+```
+namespace App\Presenters\Revisions;
+
+use Sofa\Revisionable\Laravel\Presenter;
+
+class Ticket extends Presenter {
+
+    protected $labels = [
+        'item_id'        => 'Przedmiot',
+        'customer_id'    => 'Klient',
+        'status_id'      => 'Status',
+        'responsible_id' => 'Serwisant',
+        'defect'         => 'Usterka',
+        'note'           => 'Uwagi',
+    ];
+
+    protected $passThrough = [
+        'item_id'        => 'item.name',
+        'customer_id'    => 'customer.name',
+        'responsible_id' => 'serviceman.name',
+        'status_id'      => 'status.name',
+    ];
+
+    protected $actions = [
+        'created'  => 'utworzony',
+        'updated'  => 'edytowany',
+        'deleted'  => 'usunięty',
+        'restored' => 'przywrócony',
+    ];
+
+}
+```
+
+then
+```
+$ php artisan tinker
+
+>>> $ticket = App\Models\Ticket::first();
+=> <App\Models\Ticket>
+
+>>> $revision = $ticket->latestRevision; // automatically wrapped in presenter
+=> <App\Presenters\Revisions\Ticket>
+
+>>> $revision->old('item_id'); // value fetched from the relationship
+=> "komputer pc"
+
+>>> $revision->new('item_id'); // value fetched from the relationship
+=> "laptop acer"
+
+>>> $revision->label('item_id'); // custom label defined in the presenter
+=> "Przedmiot"
+
+>>> $revision->action; // custom action name defined in the presenter
+=> "edytowany"
+```

composer.json

@@ -14,18 +14,25 @@
         "php": ">=5.4"
     },
     "require-dev": {
+        "phpspec/phpspec": "~2.0@dev",
         "phpunit/phpunit": "~4.0",
-        "mockery/mockery": "~0.9",
-        "squizlabs/php_codesniffer": "~1.5"
+        "mockery/mockery": "*",
+        "squizlabs/php_codesniffer": "~2.0",
+        "illuminate/database": "~5.0",
+        "illuminate/auth": "~5.0",
+        "cartalyst/sentry": "~2.0"
     },
     "autoload": {
+        "classmap": [
+            "src/migrations"
+        ],
         "psr-4": {
             "Sofa\\Revisionable\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Sofa\\Revisionable\\Test\\": "test"
+            "Sofa\\Revisionable\\Tests\\": "tests"
         }
     }
 }