feat: add contact archiving

CHANGELOG

@@ -1,5 +1,6 @@
 UNRELEASED CHANGES:
 
+* Add ability to archive a contact
 * Fix settings' sidebar links and change security icon
 * Fix CSV import
 

Makefile

@@ -101,7 +101,11 @@ docker_push_bintray: .deploy.json
 
 .PHONY: docker docker_build docker_tag docker_push docker_push_bintray
 
-build: build-dev
+build:
+	composer install --no-interaction --no-suggest --ignore-platform-reqs
+	php artisan lang:generate
+	yarn install
+	yarn run production
 
 build-prod:
 	composer install --no-interaction --no-suggest --ignore-platform-reqs --no-dev

app/Http/Controllers/Api/ApiContactController.php

@@ -49,16 +49,16 @@ public function index(Request $request)
         }
 
         try {
-            $contacts = auth()->user()->account->contacts()->real()
+            $contacts = auth()->user()->account->contacts()
+                            ->real()
+                            ->active()
                             ->orderBy($this->sort, $this->sortDirection)
                             ->paginate($this->getLimitPerPage());
         } catch (QueryException $e) {
             return $this->respondInvalidQuery();
         }
 
-        $collection = $this->applyWithParameter($contacts, $this->getWithParameter());
-
-        return $collection;
+        return $this->applyWithParameter($contacts, $this->getWithParameter());
     }
 
     /**

app/Http/Controllers/Contacts/RelationshipsController.php

@@ -22,6 +22,7 @@ public function new(Request $request, Contact $contact)
         // getting top 100 of existing contacts
         $existingContacts = auth()->user()->account->contacts()
                                     ->real()
+                                    ->active()
                                     ->select(['id', 'first_name', 'last_name'])
                                     ->sortedBy('name')
                                     ->take(100)

app/Http/Controllers/ContactsController.php

@@ -25,6 +25,28 @@ class ContactsController extends Controller
      * @return \Illuminate\Http\Response
      */
     public function index(Request $request)
+    {
+        return $this->contacts($request, true);
+    }
+
+    /**
+     * Display a listing of the resource.
+     *
+     * @param Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function archived(Request $request)
+    {
+        return $this->contacts($request, false);
+    }
+
+    /**
+     * Display contacts.
+     *
+     * @param Request $request
+     * @return \Illuminate\Http\Response
+     */
+    private function contacts(Request $request, bool $active)
     {
         $user = $request->user();
         $sort = $request->get('sort') ?? $user->contacts_sort_order;
@@ -37,10 +59,19 @@ public function index(Request $request)
         $url = '';
         $count = 1;
 
+        $contacts = $user->account->contacts()->real();
+        if ($active) {
+            $nbarchived = $contacts->count();
+            $contacts = $contacts->active();
+            $nbarchived = $nbarchived - $contacts->count();
+        } else {
+            $contacts = $contacts->notActive();
+            $nbarchived = $contacts->count();
+        }
+
         if ($request->get('no_tag')) {
             //get tag less contacts
-            $contacts = $user->account->contacts()->real()->sortedBy($sort);
-            $contacts = $contacts->tags('NONE')->get();
+            $contacts = $contacts->tags('NONE');
         } elseif ($request->get('tag1')) {
             // get contacts with selected tags
 
@@ -63,13 +94,9 @@ public function index(Request $request)
                 return redirect()->route('people.index');
             }
 
-            $contacts = $user->account->contacts()->real()->sortedBy($sort);
-
-            $contacts = $contacts->tags($tags)->get();
-        } else {
-            // get all contacts
-            $contacts = $user->account->contacts()->real()->sortedBy($sort)->get();
+            $contacts = $contacts->tags($tags);
         }
+        $contacts = $contacts->sortedBy($sort)->get();
 
         // starred contacts
         $starredContacts = $contacts->filter(function ($item) {
@@ -84,6 +111,8 @@ public function index(Request $request)
             ->withContacts($contacts->unique('id'))
             ->withUnstarredContacts($unstarredContacts)
             ->withStarredContacts($starredContacts)
+            ->withActive($active)
+            ->withHasArchived($nbarchived > 0)
             ->withTags($tags)
             ->withUserTags(auth()->user()->account->tags)
             ->withUrl($url)
@@ -562,4 +591,21 @@ public function favorite(Request $request, Contact $contact)
             'is_starred' => $bool,
         ];
     }
+
+    /**
+     * Toggle archive of a contact.
+     *
+     * @param  Request $request
+     * @param  Contact $contact
+     * @return array
+     */
+    public function archive(Request $request, Contact $contact)
+    {
+        $contact->is_active = ! $contact->is_active;
+        $contact->save();
+
+        return [
+            'is_active' => $contact->is_active,
+        ];
+    }
 }

app/Http/Controllers/DashboardController.php

@@ -27,13 +27,18 @@ public function index()
             )->with('debts.contact')
             ->first();
 
-        if ($account->contacts()->count() === 0) {
+        if ($account->contacts()->real()->active()->count() === 0) {
             return view('dashboard.blank');
         }
 
         // Fetch last updated contacts
         $lastUpdatedContactsCollection = collect([]);
-        $lastUpdatedContacts = $account->contacts()->where('is_partial', false)->latest('updated_at')->limit(10)->get();
+        $lastUpdatedContacts = $account->contacts()
+            ->real()
+            ->active()
+            ->latest('updated_at')
+            ->limit(10)
+            ->get();
         foreach ($lastUpdatedContacts as $contact) {
             $data = [
                 'id' => $contact->hashID(),
@@ -60,7 +65,7 @@ public function index()
 
         $data = [
             'lastUpdatedContacts' => $lastUpdatedContactsCollection,
-            'number_of_contacts' => $account->contacts()->real()->count(),
+            'number_of_contacts' => $account->contacts()->real()->active()->count(),
             'number_of_reminders' => $account->reminders_count,
             'number_of_notes' => $account->notes_count,
             'number_of_activities' => $account->activities_count,

app/Http/Resources/Contact/Contact.php

@@ -27,6 +27,7 @@ public function toArray($request)
             'gender' => $this->gender->name,
             'is_starred' => (bool) $this->is_starred,
             'is_partial' => (bool) $this->is_partial,
+            'is_active' => (bool) $this->is_active,
             'is_dead' => (bool) $this->is_dead,
             'last_called' => $this->when(! $this->is_partial, $this->getLastCalled()),
             'last_activity_together' => $this->when(! $this->is_partial, $this->getLastActivityDate()),

app/Http/Resources/Contact/ContactWithContactFields.php

@@ -26,6 +26,7 @@ public function toArray($request)
             'gender' => $this->gender->name,
             'is_starred' => (bool) $this->is_starred,
             'is_partial' => (bool) $this->is_partial,
+            'is_active' => (bool) $this->is_active,
             'is_dead' => (bool) $this->is_dead,
             'last_called' => $this->when(! $this->is_partial, $this->getLastCalled()),
             'last_activity_together' => $this->when(! $this->is_partial, $this->getLastActivityDate()),

app/Models/Contact/Contact.php

@@ -115,6 +115,7 @@ class Contact extends Model
         'is_dead' => 'boolean',
         'has_avatar' => 'boolean',
         'is_starred' => 'boolean',
+        'is_active' => 'boolean',
     ];
 
     /**
@@ -413,6 +414,28 @@ public function scopeReal($query)
         return $query->where('is_partial', 0);
     }
 
+    /**
+     * Scope a query to only include contacts who are active.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder $query
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeActive($query)
+    {
+        return $query->where('is_active', 1);
+    }
+
+    /**
+     * Scope a query to only include contacts who are not active.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder $query
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeNotActive($query)
+    {
+        return $query->where('is_active', 0);
+    }
+
     /**
      * Get the first name of the contact.
      *

database/migrations/2018_09_02_150531_contact_archiving.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class ContactArchiving extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('contacts', function (Blueprint $table) {
+            $table->boolean('is_active')->default(1)->after('is_partial');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('contacts', function ($table) {
+            $table->dropColumn('is_active');
+        });
+    }
+}

database/migrations/2018_10_19_173805_changelog_about_archiving.php

@@ -0,0 +1,31 @@
+<?php
+
+use App\Models\Instance\Instance;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Database\Migrations\Migration;
+
+class ChangelogAboutArchiving extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        $description = '
+**New feature: archiving contact**
+
+You can now archive a contact to no longer see it in the Dashboard, or in the searchs. Archived contacts can still be found on the Contacts board.
+
+![image](/img/changelogs/2018-10-19-archiving.png)';
+
+        $id = DB::table('changelogs')->insertGetId([
+            'description' => $description,
+            'created_at' => '2018-10-19',
+        ]);
+
+        $instance = Instance::first();
+        $instance->addUnreadChangelogEntry($id);
+    }
+}

public/mix-manifest.json

@@ -1,7 +1,7 @@
 {
-    "/js/app.js": "/js/app.js?id=06cf7d3943c971315cac",
-    "/css/app-ltr.css": "/css/app-ltr.css?id=aeed1bc1277811d4283c",
-    "/css/app-rtl.css": "/css/app-rtl.css?id=ebbe907f4e5cf0c8bd1a",
+    "/js/app.js": "/js/app.js?id=be1081f3aade4d748c86",
+    "/css/app-ltr.css": "/css/app-ltr.css?id=c31157ff6b8b03764087",
+    "/css/app-rtl.css": "/css/app-rtl.css?id=34ddbd8de0120976f96b",
     "/css/stripe.css": "/css/stripe.css?id=64c68c04c4e475fcc7c6",
     "/js/vendor.js": "/js/vendor.js?id=490bf428af4c7224b600",
     "/js/stripe.js": "/js/stripe.js?id=e2284957ba723a52a4b7",

resources/assets/js/app.js

@@ -110,6 +110,10 @@ Vue.component(
     'contact-favorite',
     require('./components/people/SetFavorite.vue')
 );
+Vue.component(
+    'contact-archive',
+    require('./components/people/Archive.vue')
+);
 
 Vue.component(
     'contact-address',

resources/assets/js/components/people/Archive.vue

@@ -0,0 +1,62 @@
+<style scoped>
+</style>
+
+<template>
+    <div>
+        <notifications group="archive" position="top middle" duration=5000 width="400" />
+
+        <a class="btn btn-special" @click="toggle" :title="$t('people.contact_archive_help')">{{ isActive ? $t('people.contact_archive') : $t('people.contact_unarchive') }}</a>
+    </div>
+</template>
+
+<script>
+    export default {
+        /*
+         * The component's data.
+         */
+        data() {
+            return {
+                isActive: false,
+            };
+        },
+
+        /**
+         * Prepare the component (Vue 2.x).
+         */
+        mounted() {
+            this.prepareComponent();
+        },
+
+        props: {
+            hash: {
+                type: String,
+            },
+            active: {
+                type: Boolean,
+            },
+        },
+
+        methods: {
+            /**
+             * Prepare the component.
+             */
+            prepareComponent() {
+                this.isActive = this.active;
+            },
+
+            toggle() {
+                axios.put('/people/' + this.hash + '/archive')
+                    .then(response => {
+                        this.isActive = response.data.is_active
+
+                        this.$notify({
+                            group: 'archive',
+                            title: this.$t('app.default_save_success'),
+                            text: '',
+                            type: 'success'
+                        });
+                    });
+            },
+        }
+    }
+</script>

resources/assets/js/components/people/SetFavorite.vue

@@ -63,7 +63,7 @@
                           this.isFavorite = response.data.is_starred
 
                           this.$notify({
-                              group: 'main',
+                              group: 'favorite',
                               title: this.$t('app.default_save_success'),
                               text: '',
                               type: 'success'