Initial commit

Author: Martin Kluska

.gitignore

@@ -0,0 +1,25 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Composer template
+composer.phar
+/vendor/
+
+# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
+# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
+composer.lock
+### Laravel template
+vendor/
+node_modules/
+
+# Laravel 4 specific
+bootstrap/compiled.php
+app/storage/
+
+# Laravel 5 & Lumen specific
+public/storage
+storage/*.key
+.env.*.php
+.env.php
+.env
+
+# Rocketeer PHP task runner and deployment package. https://github.com/rocketeers/rocketeer
+.rocketeer/

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contribution or overriding
+Are welcome. To add a new provider just add a new Handler (which extends AbstractHandler). Then implement the chunk
+upload and progress.
+
+1. Fork the project.
+2. Create your bugfix/feature branch and write your (try well-commented) code.
+3. Commit your changes (and your tests) and push to your branch.
+4. Create a new pull request against this package's `master` branch.
+
+## Pull Requests
+
+- **Use the [PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md).**
+  The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer) or install dev depedency and run the `composer run-script lint` or `composer run-script lint-fix`
+
+- **Consider our release cycle.**  We try to follow [SemVer v2.0.0](http://semver.org/). 
+
+- **Document any change in behaviour.**  Make sure the `README.md` and any other relevant 
+  documentation are kept up-to-date.
+
+- **Create feature branches.**  Don't ask us to pull from your master branch.
+
+- **One pull request per feature.**  If you want to do more than one thing, send multiple pull requests.
+  
+**Thank you!**

LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2016 Martin Kluska <martin@kluska.cz>
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+> SOFTWARE.

composer.json

@@ -0,0 +1,27 @@
+{
+  "name": "pion/laravel-eloquent-position",
+  "description": "Position logic for Eloquent models with minimum setup",
+  "require": {
+    "laravel/framework": "5.1.* || 5.2.* || 5.3.*"
+  },
+  "require-dev": {
+    "squizlabs/php_codesniffer": "2.*"
+  },
+  "scripts": {
+    "lint": "./vendor/bin/phpcs --standard=PSR2 src/",
+    "lint-fix": "./vendor/bin/phpcbf --standard=PSR2 src/"
+  },
+  "autoload": {
+    "psr-4": {
+      "Pion\\Support\\Eloquent\\Position\\": "src/"
+    }
+  },
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Martin Kluska",
+      "email": "martin.kluska@imakers.cz"
+    }
+  ],
+  "minimum-stability": "stable"
+}

src/Commands/RecalculatePositionCommand.php

@@ -0,0 +1,132 @@
+<?php
+
+namespace App\Console\Commands;
+
+use Pion\Support\Eloquent\Position\Traits\PositionTrait;
+use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+
+class RecalculatePositionCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'model:position {model} ';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Recalculates given model position. You must provide full model class';
+
+    /**
+     * Create a new command instance.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        // Get the model
+        /** @var PositionTrait $modelClass */
+        $modelClass = $this->argument('model');
+
+        //
+        /**
+         * Build the model instance so we can get the settings
+         * @var PositionTrait $model
+         */
+        $model = new $modelClass();
+
+        // Check if using the PositionTrait
+        if (!method_exists($model, 'newPositionQuery')) {
+            $this->error("Model {$modelClass} is not using PositionTrait");
+            return false;
+        }
+
+        // Holds the positions for every group (defined by the values
+        $positionsByGroup = [];
+
+        // Get the group
+        $groups = $model->getPositionGroup();
+
+        // Run sorted query for every entry
+        $modelClass::sorted()->chunk(200, function (Collection $collection) use ($groups, &$positionsByGroup) {
+            /** @var PositionTrait|Model $model */
+            foreach ($collection as $model) {
+                // Builds the group key to get position
+                $groupKey = $this->buildGroupKeyForPosition($model, $groups);
+
+                // Set the new position
+                $model->setPosition($this->getPositionForGroup($groupKey, $positionsByGroup))
+                    ->save();
+            }
+        });
+
+        // Render the table layout about the positions
+        $this->table([
+            'Group', 'Last position'
+        ], collect($positionsByGroup)->map(function ($value, $key) {
+            return [$key, $value];
+        }));
+
+        return true;
+    }
+
+    /**
+     * Stores/updates the next position
+     *
+     * @param string $groupKey
+     * @param array  $positionsByGroup referenced array of currently stores positions
+     *
+     * @return mixed
+     */
+    protected function getPositionForGroup($groupKey, &$positionsByGroup)
+    {
+        if (!isset($positionsByGroup[$groupKey])) {
+            $positionsByGroup[$groupKey] = 0;
+        }
+        // Increment the position
+        $positionsByGroup[$groupKey]++;
+
+        // Return the new position
+        return $positionsByGroup[$groupKey];
+    }
+
+    /**
+     * Builds the group key from the group columns and the values form the model
+     *
+     * @param Model|PositionTrait $model
+     * @param array               $groups
+     *
+     * @return string
+     */
+    protected function buildGroupKeyForPosition($model, $groups)
+    {
+        if (is_null($groups)) {
+            return 'No group';
+        }
+
+        // Prepare array of values to create single string
+        $groupValues = [];
+
+        // Get the group column values
+        foreach ($groups as $column) {
+            $groupValues[] = $model->{$column};
+        }
+
+        // Build the key
+        return implode('_', $groupValues);
+    }
+}

src/PositionObserver.php

@@ -0,0 +1,142 @@
+<?php
+namespace Pion\Support\Eloquent\Position;
+
+use Pion\Support\Eloquent\Position\Query\AbstractPositionQuery;
+use Pion\Support\Eloquent\Position\Query\LastPositionQuery;
+use Pion\Support\Eloquent\Position\Query\PositionQuery;
+use Pion\Support\Eloquent\Position\Traits\PositionTrait;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Contracts\Events\Dispatcher;
+
+/**
+ * Traits PositionObserver
+ *
+ * Listens for saved state and checks if the position should be update in
+ * related entries.
+ *
+ * @package App\Models\Traits
+ */
+class PositionObserver
+{
+    /**
+     * @var Dispatcher
+     */
+    private $events;
+
+    /**
+     * PositionObserver constructor.
+     *
+     * @param Dispatcher $events
+     */
+    public function __construct(Dispatcher $events)
+    {
+        $this->events = $events;
+    }
+
+    /**
+     * Updates the position before saving
+     *
+     * @param Model|PositionTrait $model
+     */
+    public function saving($model)
+    {
+        if (!$model->isPositionUpdateDisabled()) {
+            // Get the position for current and old value
+            $position = $model->getPosition();
+
+            // Get the old position
+            $oldPosition = $model->getOriginal($model->getPositionColumn());
+
+            // Check if the position is set
+            if (is_null($position)) {
+                $this->appendLast($model, $oldPosition);
+            } else {
+                $this->move($model, $position, $oldPosition);
+            }
+        }
+    }
+
+    /**
+     * Setups the position to be at the end
+     *
+     * @param Model|PositionTrait $model
+     * @param int                 $oldPosition
+     */
+    protected function appendLast($model, $oldPosition)
+    {
+        // Build the last position query
+        $query = new LastPositionQuery($model, $oldPosition);
+
+        // Run the query
+        $this->runQuery($query, $oldPosition);
+    }
+
+    /**
+     * Moves other entries from the given position
+     *
+     * @param Model|PositionTrait $model
+     * @param int                 $position
+     * @param int                 $oldPosition
+     */
+    protected function move($model, $position, $oldPosition)
+    {
+        // Check if the position has change and we need to recalculate
+        if ($oldPosition != $position) {
+            // Build the position query
+            $query = new PositionQuery($model, $position, $oldPosition);
+
+            // Run the position query
+            $this->runQuery($query, $oldPosition);
+        }
+    }
+
+    /**
+     * Runs the position events and query if can. If positioning event returns
+     * false, it will revert the new position to old position.
+     *
+     * @param AbstractPositionQuery $query
+     * @param int                   $oldPosition
+     */
+    protected function runQuery(AbstractPositionQuery $query, $oldPosition)
+    {
+        // Fire the validation event
+        $eventResponse = $this->firePositioningEvent($query);
+
+        // Ignore updating the position and revert the position to original value
+        if ($eventResponse !== $eventResponse && $eventResponse === false) {
+            // Update the new position to original position
+            $query->model()->setPosition($oldPosition);
+        } else {
+            // Run the query to update other entries to fix the position order
+            $query->run();
+
+            // Fire the final state
+            $this->firePositionedEvent($query->model());
+        }
+    }
+
+    /**
+     * Fire the name-spaced validating event.
+     *
+     * @param AbstractPositionQuery $query
+     *
+     * @return mixed
+     */
+    protected function firePositioningEvent($query)
+    {
+        $model = $query->model();
+        return $this->events->until('eloquent.positioning: '.get_class($model), [$model, $query]);
+    }
+
+    /**
+     * Fire the name-spaced post-validation event.
+     *
+     * @param Model $model
+     *
+     * @return void
+     */
+    protected function firePositionedEvent(Model $model)
+    {
+        $this->events->fire('eloquent.positioned: '.get_class($model), [$model]);
+    }
+}