feat: add journal entry edit option (monicahq#2802)

Author: TeddyBear06

.azure/azure.sig

@@ -9,6 +9,7 @@ steps:
     TESTSUITES: "Api|Feature|Unit-Models|Unit-Services"
 
 - bash: |
+    source scripts/ci/fixsecrets.sh
     php artisan route:cache
     ulimit -S unlimited
     phpdbg -dmemory_limit=4G -qrr vendor/bin/phpunit -c phpunit.xml --log-junit ./results/junit/unit/results${SYSTEM_JOBPOSITIONINPHASE}.xml --coverage-clover ./results/coverage${SYSTEM_JOBPOSITIONINPHASE}.xml --testsuite $TESTSUITE

.azure/unit-tests-step.yml

@@ -2,6 +2,7 @@
 
 ### New features:
 
+* Add ability to edit a Journal entry
 * Add vcard photo/avatar import
 * Add ability to change the avatar of your contacts
 * Add the ablity to set a 'me' contact (only API for now)

CHANGELOG.md

@@ -79,7 +79,7 @@ public function store(ActivitiesRequest $request, Contact $contact)
         }
 
         // Log a journal entry
-        (new JournalEntry)->add($activity);
+        JournalEntry::add($activity);
 
         return redirect()->route('people.show', $contact)
             ->with('success', trans('people.activities_add_success'));

app/Http/Controllers/ActivitiesController.php

@@ -82,7 +82,7 @@ public function store(Request $request)
         }
 
         // Log a journal entry
-        (new JournalEntry)->add($activity);
+        JournalEntry::add($activity);
 
         // Now we associate the activity with each one of the attendees
         $attendeesID = $request->get('contacts');
@@ -109,6 +109,7 @@ public function store(Request $request)
     public function update(Request $request, $activityId)
     {
         try {
+            /** @var Activity */
             $activity = Activity::where('account_id', auth()->user()->account_id)
                 ->findOrFail($activityId);
         } catch (ModelNotFoundException $e) {
@@ -136,7 +137,7 @@ public function update(Request $request, $activityId)
 
         // Log a journal entry but need to delete the previous one first
         $activity->deleteJournalEntry();
-        (new JournalEntry)->add($activity);
+        JournalEntry::add($activity);
 
         // Get the attendees
         $attendeesID = $request->get('contacts');

app/Http/Controllers/Api/ApiActivityController.php

@@ -92,7 +92,7 @@ public function storeDay(DaysRequest $request)
         ]);
 
         // Log a journal entry
-        $journalEntry = (new JournalEntry)->add($day);
+        $journalEntry = JournalEntry::add($day);
 
         return [
             'id' => $journalEntry->id,
@@ -169,20 +169,68 @@ public function save(Request $request)
 
         $entry->date = $request->input('date');
         // Log a journal entry
-        (new JournalEntry)->add($entry);
+        JournalEntry::add($entry);
 
         return redirect()->route('journal.index');
     }
 
     /**
-     * Delete the reminder.
+     * Display the Edit journal entry screen.
+     *
+     * @param Entry $entry
+     * @return \Illuminate\View\View
+     */
+    public function edit(Entry $entry)
+    {
+        return view('journal.edit')
+            ->withEntry($entry);
+    }
+
+    /**
+     * Update a journal entry.
+     *
+     * @param  Request $request
+     * @return \Illuminate\Http\RedirectResponse
      */
-    public function deleteEntry(Request $request, $entryId)
+    public function update(Request $request, Entry $entry)
     {
-        $entry = Entry::where('account_id', $request->user()->account_id)
-            ->findOrFail($entryId);
+        $validator = Validator::make($request->all(), [
+            'entry' => 'required|string',
+            'date' => 'required|date',
+        ]);
+
+        if ($validator->fails()) {
+            return back()
+                ->withInput()
+                ->withErrors($validator);
+        }
+
+        $entry->post = $request->input('entry');
+
+        if ($request->input('title') != '') {
+            $entry->title = $request->input('title');
+        }
 
+        $entry->save();
+
+        // Update journal entry
+        $journalEntry = $entry->journalEntry;
+        if ($journalEntry) {
+            $entry->date = $request->input('date');
+            $journalEntry->edit($entry);
+        }
+
+        return redirect()->route('journal.index');
+    }
+
+    /**
+     * Delete the reminder.
+     */
+    public function deleteEntry(Request $request, Entry $entry)
+    {
         $entry->deleteJournalEntry();
         $entry->delete();
+
+        return ['true'];
     }
 }

app/Http/Controllers/JournalController.php

@@ -2,9 +2,36 @@
 
 namespace App\Interfaces;
 
+use Illuminate\Database\Eloquent\Relations\MorphOne;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+
 interface IsJournalableInterface
 {
+    /**
+     * Get all journal entries.
+     *
+     * @return MorphMany
+     */
+    public function journalEntries();
+
+    /**
+     * Get the journal record associated.
+     *
+     * @return MorphOne
+     */
+    public function journalEntry();
+
+    /**
+     * Get all the information of the Entry for the journal.
+     *
+     * @return array
+     */
     public function getInfoForJournalEntry();
 
+    /**
+     * Delete the Journal Entry associated with the given object.
+     *
+     * @return bool
+     */
     public function deleteJournalEntry();
 }

app/Interfaces/IsJournalableInterface.php

@@ -6,7 +6,6 @@
 use App\Helpers\DateHelper;
 use App\Traits\Journalable;
 use App\Models\Contact\Contact;
-use App\Models\Journal\JournalEntry;
 use App\Interfaces\IsJournalableInterface;
 use App\Models\ModelBindingHasher as Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
@@ -80,14 +79,6 @@ public function type()
         return $this->belongsTo(ActivityType::class, 'activity_type_id');
     }
 
-    /**
-     * Get all of the activities journal entries.
-     */
-    public function journalEntries()
-    {
-        return $this->morphMany(JournalEntry::class, 'journalable');
-    }
-
     /**
      * Return the markdown parsed body.
      *

app/Models/Account/Activity.php

@@ -6,8 +6,9 @@
 use App\Helpers\DateHelper;
 use App\Traits\Journalable;
 use App\Models\Account\Account;
-use Illuminate\Database\Eloquent\Model;
+use App\Models\ModelBinding as Model;
 use App\Interfaces\IsJournalableInterface;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 class Entry extends Model implements IsJournalableInterface
 {
@@ -35,12 +36,26 @@ class Entry extends Model implements IsJournalableInterface
 
     /**
      * Get the account record associated with the entry.
+     *
+     * @return BelongsTo
      */
     public function account()
     {
         return $this->belongsTo(Account::class);
     }
 
+    /**
+     * Get the Entry date.
+     *
+     * @param  string  $value
+     * @return \Carbon\Carbon
+     */
+    public function getDateAttribute($value)
+    {
+        // Default to created_at, but show journalEntry->date if the entry type is JournalEntry
+        return $this->journalEntry ? $this->journalEntry->date : $this->created_at;
+    }
+
     /**
      * Get the Entry post.
      *
@@ -58,19 +73,17 @@ public function getPostAttribute($value)
      */
     public function getInfoForJournalEntry()
     {
-        // Default to created_at, but show journalEntry->date if the entry type is JournalEntry
-        $entryDate = $this->journalEntry ? $this->journalEntry->date : $this->created_at;
-
         return [
             'type' => 'entry',
             'id' => $this->id,
             'title' => $this->title,
             'post' => $this->post,
-            'day' => $entryDate->day,
-            'day_name' => mb_convert_case(DateHelper::getShortDay($entryDate), MB_CASE_TITLE, 'UTF-8'),
-            'month' => $entryDate->month,
-            'month_name' => mb_convert_case(DateHelper::getShortMonth($entryDate), MB_CASE_UPPER, 'UTF-8'),
-            'year' => $entryDate->year,
+            'day' => $this->date->day,
+            'day_name' => mb_convert_case(DateHelper::getShortDay($this->date), MB_CASE_TITLE, 'UTF-8'),
+            'month' => $this->date->month,
+            'month_name' => mb_convert_case(DateHelper::getShortMonth($this->date), MB_CASE_UPPER, 'UTF-8'),
+            'year' => $this->date->year,
+            'date' => $this->date,
         ];
     }
 }

app/Models/Journal/Entry.php

@@ -5,6 +5,8 @@
 use App\Models\Contact\Entry;
 use App\Models\Account\Account;
 use App\Models\ModelBinding as Model;
+use App\Interfaces\IsJournalableInterface;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
@@ -28,14 +30,16 @@ class JournalEntry extends Model
 
     /**
      * Get all of the owning "journal-able" models.
+     *
+     * @return MorphTo
      */
     public function journalable()
     {
         return $this->morphTo();
     }
 
     /**
-     * Get the account record associated with the invitation.
+     * Get the account record associated with the journal entry.
      *
      * @return BelongsTo
      */
@@ -46,35 +50,52 @@ public function account()
 
     /**
      * Adds a new entry in the journal.
-     * @param mixed $resourceToLog
+     *
+     * @param \App\Interfaces\IsJournalableInterface $resourceToLog
+     * @return self
      */
-    public function add($resourceToLog)
+    public static function add(IsJournalableInterface $resourceToLog) : self
     {
-        $this->account_id = $resourceToLog->account_id;
-        $this->date = now();
+        $journal = new self;
+        $journal->account_id = $resourceToLog->account_id;
+        $journal->date = now();
         if ($resourceToLog instanceof \App\Models\Account\Activity) {
-            $this->date = $resourceToLog->date_it_happened;
+            $journal->date = $resourceToLog->date_it_happened;
+        } elseif ($resourceToLog instanceof \App\Models\Journal\Entry) {
+            $journal->date = $resourceToLog->attributes['date'];
         }
+        $journal->save();
+        $resourceToLog->journalEntries()->save($journal);
+
+        return $journal;
+    }
+
+    /**
+     * Update an entry in the journal.
+     *
+     * @param \App\Interfaces\IsJournalableInterface $resourceToLog
+     * @return self
+     */
+    public function edit(IsJournalableInterface $resourceToLog) : self
+    {
         if ($resourceToLog instanceof \App\Models\Journal\Entry) {
-            $this->date = $resourceToLog->date;
+            $this->date = $resourceToLog->attributes['date'];
         }
-        $this->journalable_id = $resourceToLog->id;
-        $this->journalable_type = get_class($resourceToLog);
         $this->save();
 
         return $this;
     }
 
     /**
      * Get the information about the object represented by the Journal Entry.
+     *
      * @return array
      */
     public function getObjectData()
     {
-        $type = $this->journalable_type;
-
         // Instantiating the object
-        $correspondingObject = (new $type)->findOrFail($this->journalable_id);
+        /** @var IsJournalableInterface */
+        $correspondingObject = $this->journalable;
 
         return $correspondingObject->getInfoForJournalEntry();
     }