SoftDeletes fixes

Author: markusjwetzel

src/Builder.php

@@ -4,8 +4,7 @@
 
 use Illuminate\Database\Eloquent\Builder as BaseBuilder;
 
-class Builder extends BaseBuilder {
-
+class Builder extends BaseBuilder
+{
     use BuilderTrait;
-
 }

src/BuilderTrait.php

@@ -2,8 +2,10 @@
 
 namespace ProAI\Versioning;
 
-trait BuilderTrait {
+use Exception;
 
+trait BuilderTrait
+{
     /**
      * Insert a new record into the database.
      *
@@ -18,7 +20,7 @@ public function insert(array $values)
 
         // set version, ref_id and latest_version
         $values[$this->model->getLatestVersionColumn()] = 1;
-        $versionValues[$this->model->getVersionKeyName()] = $this->getKey();
+        $versionValues[$this->model->getVersionKeyName()] = $this->model->getKey();
         $versionValues[$this->model->getVersionColumn()] = 1;
 
         // insert main table record
@@ -88,17 +90,8 @@ public function update(array $values)
             return false;
         }
 
-        // update all versions in case primary key value has been changed
-        $db = $this->model->getConnection();
-        if ($this->model->getKey() && $this->model->getKey() != $this->model->getOriginal($this->model->getKeyName())) {
-            if(! $db->table($this->model->getVersionTable())
-                ->where($this->model->getVersionKeyName(), '=', $this->model->getOriginal($this->model->getKeyName()))
-                ->update([$this->model->getVersionKeyName() => $this->model->getKey()])) {
-                return false;
-            }
-        }
-
         // update version table records
+        $db = $this->model->getConnection();
         foreach ($affectedRecords as $record) {
             // get versioned values from record
             foreach($this->model->getVersionedAttributeNames() as $key) {
@@ -188,9 +181,18 @@ protected function getAffectedRecords()
      */
     protected function getValues(array $values)
     {
-        $versionedKeys = $this->model->getVersionedAttributeNames();
+        $array = [];
 
-        $array = array_diff_key($values, array_flip($versionedKeys));
+        $versionedKeys = array_merge(
+            $this->model->getVersionedAttributeNames(),
+            [$this->model->getLatestVersionColumn(), $this->model->getVersionColumn(), $this->model->getVersionKeyName()]
+        );
+
+        foreach ($values as $key => $value) {
+            if (! $this->isVersionedKey($key, $versionedKeys)) {
+                $array[$key] = $value;
+            }
+        }
 
         return $array;
     }
@@ -203,12 +205,43 @@ protected function getValues(array $values)
      */
     protected function getVersionValues(array $values)
     {
+        $array = [];
+
         $versionedKeys = $this->model->getVersionedAttributeNames();
 
-        $array = array_intersect_key($values, array_flip($versionedKeys));
-        $array[$this->model->getVersionKeyName()] = $this->model->getKey();
+        foreach ($values as $key => $value) {
+            if ($newKey = $this->isVersionedKey($key, $versionedKeys)) {
+                $array[$newKey] = $value;
+            }
+        }
 
         return $array;
     }
 
+    /**
+     * Check if key is in versioned keys.
+     *
+     * @param  string  $key
+     * @param  array  $versionedKeys
+     * @return string|null
+     */
+    protected function isVersionedKey($key, array $versionedKeys)
+    {
+        $keyFractions = explode(".",$key);
+
+        if (count($keyFractions) > 2) {
+            throw new Exception("Key '".$key."' has too many fractions.");
+        }
+
+        if (count($keyFractions) == 1 && in_array($keyFractions[0], $versionedKeys)) {
+            return $keyFractions[0];
+        }
+
+        if (count($keyFractions) == 2 && $keyFractions[0] == $this->model->getVersionTable() && in_array($keyFractions[1], $versionedKeys)) {
+            return $keyFractions[1];
+        }
+
+        return null;
+    }
+
 }

src/SoftDeletes.php

@@ -4,8 +4,8 @@
 
 use Illuminate\Database\Eloquent\SoftDeletes as SoftDeletesTrait;
 
-trait SoftDeletes {
-
+trait SoftDeletes
+{
     use SoftDeletesTrait;
 
     /**

src/SoftDeletingScope.php

@@ -7,14 +7,14 @@
 use Illuminate\Database\Eloquent\ScopeInterface;
 use Illuminate\Database\Query\JoinClause;
 
-class VersioningScope implements ScopeInterface {
-
+class VersioningScope implements ScopeInterface
+{
     /**
      * All of the extensions to be added to the builder.
      *
      * @var array
      */
-    protected $extensions = ['Version', 'GetAllVersions', 'FindAllVersions'];
+    protected $extensions = ['Version', 'AllVersions'];
 
     /**
      * Apply the scope to a given Eloquent query builder.
@@ -89,46 +89,23 @@ protected function addVersion(Builder $builder)
     }
 
     /**
-     * Add the version extension to the builder.
-     *
-     * @param  \Illuminate\Database\Eloquent\Builder  $builder
-     * @return void
-     */
-    protected function addGetAllVersions(Builder $builder)
-    {
-        $builder->macro('getAllVersions', function(Builder $builder) {
-            $model = $builder->getModel();
-
-            $this->remove($builder, $builder->getModel());
-
-            $builder->join($model->getVersionTable(), function($join) use ($model) {
-                $join->on($model->getQualifiedKeyName(), '=', $model->getQualifiedVersionKeyName());
-            });
-
-            return $builder->get();
-        });
-    }
-
-    /**
-     * Add the version extension to the builder.
+     * Add the allVersions extension to the builder.
      *
      * @param  \Illuminate\Database\Eloquent\Builder  $builder
      * @return void
      */
-    protected function addFindAllVersions(Builder $builder)
+    protected function addAllVersions(Builder $builder)
     {
-        $builder->macro('findAllVersions', function(Builder $builder, $id) {
+        $builder->macro('allVersions', function(Builder $builder) {
             $model = $builder->getModel();
 
             $this->remove($builder, $builder->getModel());
 
-            $builder->getQuery()->where($model->getQualifiedKeyName(), '=', $id);
-
             $builder->join($model->getVersionTable(), function($join) use ($model) {
                 $join->on($model->getQualifiedKeyName(), '=', $model->getQualifiedVersionKeyName());
             });
 
-            return $builder->get();
+            return $builder;
         });
     }