Merge pull request #1402 from CachetHQ/collapse-component-group-default

Allow component groups to be collapsed by default
2016-01-29 16:37:18 +00:00
parent d907d1eecc da7af1fca0
commit 2358f54c3c
16 changed files with 141 additions and 34 deletions
--- a/app/Bus/Commands/ComponentGroup/AddComponentGroupCommand.php
+++ b/app/Bus/Commands/ComponentGroup/AddComponentGroupCommand.php
@@ -27,14 +27,22 @@ final class AddComponentGroupCommand
     */
    public $order;

+    /**
+     * Is the component group collapsed?
+     *
+     * @var bool
+     */
+    public $collapsed;
+
    /**
     * The validation rules.
     *
     * @var string[]
     */
    public $rules = [
-        'name'  => 'required|string',
-        'order' => 'int',
+        'name'      => 'required|string',
+        'order'     => 'int',
+        'collapsed' => 'bool',
    ];

    /**
@@ -42,12 +50,14 @@ final class AddComponentGroupCommand
     *
     * @param string $name
     * @param int    $order
+     * @param bool   $collapsed
     *
     * @return void
     */
-    public function __construct($name, $order)
+    public function __construct($name, $order, $collapsed)
    {
        $this->name = $name;
        $this->order = (int) $order;
+        $this->collapsed = $collapsed;
    }
 }
--- a/app/Bus/Commands/ComponentGroup/UpdateComponentGroupCommand.php
+++ b/app/Bus/Commands/ComponentGroup/UpdateComponentGroupCommand.php
@@ -36,14 +36,22 @@ final class UpdateComponentGroupCommand
     */
    public $order;

+    /**
+     * Is the component group collapsed?
+     *
+     * @var bool
+     */
+    public $collapsed;
+
    /**
     * The validation rules.
     *
     * @var string[]
     */
    public $rules = [
-        'name'  => 'string',
-        'order' => 'int',
+        'name'      => 'string',
+        'order'     => 'int',
+        'collapsed' => 'bool',
    ];

    /**
@@ -52,13 +60,15 @@ final class UpdateComponentGroupCommand
     * @param \CachetHQ\Cachet\Models\ComponentGroup $group
     * @param string                                 $name
     * @param int                                    $order
+     * @param bool                                   $collapsed
     *
     * @return void
     */
-    public function __construct(ComponentGroup $group, $name, $order)
+    public function __construct(ComponentGroup $group, $name, $order, $collapsed)
    {
        $this->group = $group;
        $this->name = $name;
        $this->order = (int) $order;
+        $this->collapsed = $collapsed;
    }
 }
--- a/app/Bus/Handlers/Commands/ComponentGroup/AddComponentGroupCommandHandler.php
+++ b/app/Bus/Handlers/Commands/ComponentGroup/AddComponentGroupCommandHandler.php
@@ -27,8 +27,9 @@ class AddComponentGroupCommandHandler
    public function handle(AddComponentGroupCommand $command)
    {
        $group = ComponentGroup::create([
-            'name'  => $command->name,
-            'order' => $command->order,
+            'name'      => $command->name,
+            'order'     => $command->order,
+            'collapsed' => $command->collapsed,
        ]);

        event(new ComponentGroupWasAddedEvent($group));
--- a/app/Bus/Handlers/Commands/ComponentGroup/UpdateComponentGroupCommandHandler.php
+++ b/app/Bus/Handlers/Commands/ComponentGroup/UpdateComponentGroupCommandHandler.php
@@ -26,13 +26,30 @@ class UpdateComponentGroupCommandHandler
    public function handle(UpdateComponentGroupCommand $command)
    {
        $group = $command->group;
-        $group->update([
-            'name'  => $command->name,
-            'order' => $command->order,
-        ]);
+        $group->update($this->filter($command));

        event(new ComponentGroupWasUpdatedEvent($group));

        return $group;
    }
+
+    /**
+     * Filter the command data.
+     *
+     * @param \CachetHQ\Cachet\Bus\Commands\ComponentGroup\UpdateComponentGroupCommand $command
+     *
+     * @return array
+     */
+    protected function filter(UpdateComponentGroupCommand $command)
+    {
+        $params = [
+            'name'      => $command->name,
+            'order'     => $command->order,
+            'collapsed' => $command->collapsed,
+        ];
+
+        return array_filter($params, function ($val) {
+            return $val !== null;
+        });
+    }
 }
--- a/app/Http/Controllers/Api/ComponentGroupController.php
+++ b/app/Http/Controllers/Api/ComponentGroupController.php
@@ -56,7 +56,8 @@ class ComponentGroupController extends AbstractApiController
        try {
            $group = dispatch(new AddComponentGroupCommand(
                Binput::get('name'),
-                Binput::get('order', 0)
+                Binput::get('order', 0),
+                Binput::get('collapsed')
            ));
        } catch (QueryException $e) {
            throw new BadRequestHttpException();
@@ -78,7 +79,8 @@ class ComponentGroupController extends AbstractApiController
            $group = dispatch(new UpdateComponentGroupCommand(
                $group,
                Binput::get('name'),
-                Binput::get('order', 0)
+                Binput::get('order', 0),
+                Binput::get('collapsed')
            ));
        } catch (QueryException $e) {
            throw new BadRequestHttpException();
--- a/app/Http/Controllers/Dashboard/ComponentController.php
+++ b/app/Http/Controllers/Dashboard/ComponentController.php
@@ -276,7 +276,8 @@ class ComponentController extends Controller
        try {
            $group = dispatch(new AddComponentGroupCommand(
                Binput::get('name'),
-                Binput::get('order', 0)
+                Binput::get('order', 0),
+                Binput::get('collapsed')
            ));
        } catch (ValidationException $e) {
            return Redirect::route('dashboard.components.groups.add')
@@ -302,7 +303,8 @@ class ComponentController extends Controller
            $group = dispatch(new UpdateComponentGroupCommand(
                $group,
                Binput::get('name'),
-                Binput::get('order', 0)
+                Binput::get('order', 0),
+                Binput::get('collapsed')
            ));
        } catch (ValidationException $e) {
            return Redirect::route('dashboard.components.groups.edit', ['id' => $group->id])
--- a/app/Models/ComponentGroup.php
+++ b/app/Models/ComponentGroup.php
@@ -26,8 +26,9 @@ class ComponentGroup extends Model implements HasPresenter
     * @var string[]
     */
    protected $casts = [
-        'name'  => 'string',
-        'order' => 'int',
+        'name'      => 'string',
+        'order'     => 'int',
+        'collapsed' => 'bool',
    ];

    /**
@@ -35,7 +36,7 @@ class ComponentGroup extends Model implements HasPresenter
     *
     * @var string[]
     */
-    protected $fillable = ['name', 'order'];
+    protected $fillable = ['name', 'order', 'collapsed'];

    /**
     * The validation rules.
@@ -43,8 +44,9 @@ class ComponentGroup extends Model implements HasPresenter
     * @var string[]
     */
    public $rules = [
-        'name'  => 'required|string',
-        'order' => 'int',
+        'name'      => 'required|string',
+        'order'     => 'int',
+        'collapsed' => 'bool',
    ];

    /**
--- a/database/factories/ModelFactory.php
+++ b/database/factories/ModelFactory.php
@@ -32,8 +32,9 @@ $factory->define(Component::class, function ($faker) {

 $factory->define(ComponentGroup::class, function ($faker) {
    return [
-        'name'  => $faker->words(2, true),
-        'order' => 0,
+        'name'      => $faker->words(2, true),
+        'order'     => 0,
+        'collapsed' => false,
    ];
 });

--- a/database/migrations/2016_01_29_154937_AlterTableComponentGroupsAddCollapsedColumn.php
+++ b/database/migrations/2016_01_29_154937_AlterTableComponentGroupsAddCollapsedColumn.php
@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AlterTableComponentGroupsAddCollapsedColumn extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('component_groups', function (Blueprint $table) {
+            $table->boolean('collapsed')->after('order')->default(false);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('component_groups', function (Blueprint $table) {
+            $table->dropColumn('collapsed');
+        });
+    }
+}
--- a/resources/lang/en/forms.php
+++ b/resources/lang/en/forms.php
@@ -68,7 +68,8 @@ return [
        'enabled'     => 'Component enabled?',

        'groups' => [
-            'name' => 'Name',
+            'name'      => 'Name',
+            'collapsed' => 'Collapse the group by default?',
        ],
    ],

--- a/resources/views/dashboard/components/groups/add.blade.php
+++ b/resources/views/dashboard/components/groups/add.blade.php
@@ -18,9 +18,16 @@
                    <input type="hidden" name="_token" value="{{ csrf_token() }}">
                    <fieldset>
                        <div class="form-group">
-                            <label for="incident-name">{{ trans('forms.components.groups.name') }}</label>
+                            <label>{{ trans('forms.components.groups.name') }}</label>
                            <input type="text" class="form-control" name="name" id="group-name" required>
                        </div>
+                        <div class="form-group">
+                            <label>
+                                <input type="hidden" value="0" name="collapsed">
+                                <input type="checkbox" value="1" name="collapsed">
+                                {{ trans('forms.components.groups.collapsed') }}
+                            </label>
+                        </div>
                    </fieldset>

                    <div class="btn-group">
--- a/resources/views/dashboard/components/groups/edit.blade.php
+++ b/resources/views/dashboard/components/groups/edit.blade.php
@@ -18,9 +18,16 @@
                    <input type="hidden" name="_token" value="{{ csrf_token() }}">
                    <fieldset>
                        <div class="form-group">
-                            <label for="incident-name">{{ trans('forms.components.groups.name') }}</label>
+                            <label>{{ trans('forms.components.groups.name') }}</label>
                            <input type="text" class="form-control" name="name" id="group-name" value="{{ $group->name }}" required>
                        </div>
+                        <div class="form-group">
+                            <label>
+                                <input type="hidden" value="0" name="collapsed">
+                                <input type="checkbox" value="1" name="collapsed" {{ $group->collapsed ? "checked" : null }}>
+                                {{ trans('forms.components.groups.collapsed') }}
+                            </label>
+                        </div>
                    </fieldset>

                    <div class="btn-group">
--- a/resources/views/partials/components.blade.php
+++ b/resources/views/partials/components.blade.php
@@ -11,7 +11,7 @@
        </div>
    </li>

-    <div class="group-items">
+    <div class="group-items {{ $componentGroup->collapsed ? "hide" : null }}">
    @foreach($componentGroup->enabled_components()->orderBy('order')->get() as $component)
    @include('partials.component', compact($component))
    @endforeach
--- a/tests/Api/ComponentGroupTest.php
+++ b/tests/Api/ComponentGroupTest.php
@@ -56,10 +56,11 @@ class ComponentGroupTest extends AbstractApiTestCase
        $this->beUser();

        $this->post('/api/v1/components/groups', [
-            'name'  => 'Foo',
-            'order' => 1,
+            'name'      => 'Foo',
+            'order'     => 1,
+            'collapsed' => true,
        ]);
-        $this->seeJson(['name' => 'Foo']);
+        $this->seeJson(['name' => 'Foo', 'order' => 1, 'collapsed' => true]);
        $this->assertResponseOk();
    }

--- a/tests/Bus/Commands/ComponentGroup/AddComponentGroupCommandTest.php
+++ b/tests/Bus/Commands/ComponentGroup/AddComponentGroupCommandTest.php
@@ -28,9 +28,9 @@ class AddComponentGroupCommandTest extends AbstractTestCase

    protected function getObjectAndParams()
    {
-        $params = ['name' => 'Test', 'order' => 0];
+        $params = ['name' => 'Test', 'order' => 0, 'collapsed' => true];

-        $object = new AddComponentGroupCommand($params['name'], $params['order']);
+        $object = new AddComponentGroupCommand($params['name'], $params['order'], $params['collapsed']);

        return compact('params', 'object');
    }
--- a/tests/Bus/Commands/ComponentGroup/UpdateComponentGroupCommandTest.php
+++ b/tests/Bus/Commands/ComponentGroup/UpdateComponentGroupCommandTest.php
@@ -29,8 +29,13 @@ class UpdateComponentGroupCommandTest extends AbstractTestCase

    protected function getObjectAndParams()
    {
-        $params = ['group' => new ComponentGroup(), 'name' => 'Foo', 'order' => 1];
-        $object = new UpdateComponentGroupCommand($params['group'], $params['name'], $params['order']);
+        $params = ['group' => new ComponentGroup(), 'name' => 'Foo', 'order' => 1, 'collapsed' => true];
+        $object = new UpdateComponentGroupCommand(
+            $params['group'],
+            $params['name'],
+            $params['order'],
+            $params['collapsed']
+        );

        return compact('params', 'object');
    }