Refactor goals with a "frequency" attribute

2021-02-15 09:08:28 -08:00 · 2021-02-15 09:08:28 -08:00 · 3a36f648db
parent a26a4c71d0
commit 3a36f648db
9 changed files with 83 additions and 52 deletions
--- a/app/Http/Controllers/GoalController.php
+++ b/app/Http/Controllers/GoalController.php
@ -24,8 +24,7 @@ class GoalController extends Controller
        }
        return view('goals.index')
            ->with('date', $date)
-            ->with('goals', Auth::user()->getGoalsByTime($date))
-            ->with('goalOptions', Goal::getGoalOptions());
+            ->with('goals', Auth::user()->getGoalsByTime($date));
    }

    /**
@ -61,7 +60,8 @@ class GoalController extends Controller
    {
        return view('goals.edit')
            ->with('goal', $goal)
-            ->with('goalOptions', Goal::getGoalOptions());
+            ->with('nameOptions', Goal::getNameOptions())
+            ->with('frequencyOptions', Goal::$frequencyOptions);
    }

    /**
@ -72,11 +72,11 @@ class GoalController extends Controller
        $attributes = $request->validate([
            'from' => ['nullable', 'date'],
            'to' => ['nullable', 'date'],
-            'goal' => ['required', 'string'],
-            'amount' => ['required', 'numeric'],
+            'frequency' => ['nullable', 'string'],
+            'name' => ['required', 'string'],
+            'goal' => ['required', 'numeric'],
        ]);
-        $goal->fill(array_filter($attributes))
-            ->user()->associate(Auth::user());
+        $goal->fill($attributes)->user()->associate(Auth::user());
        $goal->save();
        session()->flash('message', "Goal updated!");
        return redirect()->route('goals.show', $goal);
@ -87,9 +87,7 @@ class GoalController extends Controller
     */
    public function delete(Goal $goal): View
    {
-        return view('goals.delete')
-            ->with('goal', $goal)
-            ->with('goalOptions', Goal::getGoalOptions());
+        return view('goals.delete')->with('goal', $goal);
    }

    /**
--- a/app/Models/Goal.php
+++ b/app/Models/Goal.php
@ -14,19 +14,22 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
 * @property int $user_id
 * @property \datetime|null $from
 * @property \datetime|null $to
- * @property string $goal
- * @property float $amount
+ * @property string|null $frequency
+ * @property string $name
+ * @property float $goal
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read string $summary
 * @property-read \App\Models\User $user
 * @method static \Illuminate\Database\Eloquent\Builder|Goal newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|Goal newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|Goal query()
- * @method static \Illuminate\Database\Eloquent\Builder|Goal whereAmount($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Goal whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Goal whereFrequency($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Goal whereFrom($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Goal whereGoal($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Goal whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Goal whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Goal whereTo($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Goal whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|Goal whereUserId($value)
@ -36,14 +39,22 @@ final class Goal extends Model
 {
    use HasFactory;

+    /**
+     * Supported options for thr frequency attribute.
+     */
+    public static array $frequencyOptions = [
+        ['value' => 'daily', 'label' => 'daily'],
+    ];
+
    /**
     * @inheritdoc
     */
    protected $fillable = [
+        'frequency',
        'from',
-        'to',
        'goal',
-        'amount',
+        'name',
+        'to',
    ];

    /**
@ -51,8 +62,15 @@ final class Goal extends Model
     */
    protected $casts = [
        'from' => 'datetime:Y-m-d',
+        'goal' => 'float',
        'to' => 'datetime:Y-m-d',
-        'amount' => 'float',
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    protected $appends = [
+        'summary',
    ];

    /**
@ -62,18 +80,20 @@ final class Goal extends Model
        return $this->belongsTo(User::class);
    }

+    public function getSummaryAttribute(): string {
+        $nameOptions = self::getNameOptions();
+        return number_format($this->goal) . "{$nameOptions[$this->name]['unit']} {$nameOptions[$this->name]['label']} {$this->frequency}";
+    }
+
    /**
-     * Get options for the "goal" column.
-     *
-     * @return array
+     * Get options for the "name" column.
     */
-    public static function getGoalOptions(): array {
+    public static function getNameOptions(): array {
        $options = [];
        foreach (Nutrients::$all as $nutrient) {
-            $key = "{$nutrient['value']}_per_day";
-            $options[$key] = [
-                'value' => $key,
-                'label' => "{$nutrient['value']} per day",
+            $options[$nutrient['value']] = [
+                'value' => $nutrient['value'],
+                'label' => $nutrient['label'],
                'unit' => $nutrient['unit'],
            ];
        }
--- a/app/Models/User.php
+++ b/app/Models/User.php
@ -7,6 +7,7 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Auth;

 /**
@ -79,7 +80,7 @@ final class User extends Authenticatable
     */
    public function getGoalsByTime(?Carbon $date = null): array {
        $now = $date ?? Carbon::now();
-        $goals = ['past' => [], 'present' => [], 'future' => []];
+        $goals = ['past' => new Collection(), 'present' => new Collection(), 'future' => new Collection()];
        Goal::all()->where('user_id', Auth::user()->id)
            ->each(function ($item) use(&$goals, $now) {
                if ($item->to && $now->isAfter($item->to)) {
--- a/app/Support/Nutrients.php
+++ b/app/Support/Nutrients.php
@ -10,21 +10,21 @@ class Nutrients
    public static float $gramsPerOunce = 28.349523125;

    public static array $all = [
-        ['value' => 'calories', 'unit' => null],
-        ['value' => 'fat', 'unit' => 'g'],
-        ['value' => 'cholesterol', 'unit' => 'mg'],
-        ['value' => 'sodium', 'unit' => 'mg'],
-        ['value' => 'carbohydrates', 'unit' => 'g'],
-        ['value' => 'protein', 'unit' => 'g'],
+        ['value' => 'calories', 'label' => 'calories', 'unit' => null],
+        ['value' => 'carbohydrates', 'label' => 'carbohydrates', 'unit' => 'g'],
+        ['value' => 'cholesterol', 'label' => 'cholesterol', 'unit' => 'mg'],
+        ['value' => 'fat', 'label' => 'fat', 'unit' => 'g'],
+        ['value' => 'protein', 'label' => 'protein', 'unit' => 'g'],
+        ['value' => 'sodium', 'label' => 'sodium', 'unit' => 'mg'],
    ];

    public static array $units = [
-        ['value' => 'tsp', 'label' => 'tsp.'],
-        ['value' => 'tbsp', 'label' => 'tbsp.'],
        ['value' => 'cup', 'label' => 'cup'],
-        ['value' => 'oz', 'label' => 'oz'],
        ['value' => 'gram', 'label' => 'grams'],
+        ['value' => 'oz', 'label' => 'oz'],
        ['value' => 'serving', 'label' => 'servings'],
+        ['value' => 'tbsp', 'label' => 'tbsp.'],
+        ['value' => 'tsp', 'label' => 'tsp.'],
    ];

    /**
--- a/database/migrations/2021_02_13_052427_create_goals_table.php
+++ b/database/migrations/2021_02_13_052427_create_goals_table.php
@ -19,8 +19,9 @@ class CreateGoalsTable extends Migration
            $table->foreignIdFor(User::class)->constrained()->cascadeOnUpdate()->cascadeOnDelete();
            $table->date('from')->nullable();
            $table->date('to')->nullable();
-            $table->string('goal');
-            $table->unsignedFloat('amount');
+            $table->string('frequency')->nullable();
+            $table->string('name');
+            $table->unsignedFloat('goal');
            $table->timestamps();
            $table->index('user_id');
        });
--- a/resources/views/goals/delete.blade.php
+++ b/resources/views/goals/delete.blade.php
@ -13,7 +13,7 @@
                        @method('delete')
                        @csrf
                        <div class="text-lg pb-3">
-                            Are you sure what to delete your <span class="font-extrabold">{{ $goalOptions[$goal->goal]['label'] }}</span> goal?
+                            Are you sure what to delete your <span class="font-extrabold">{{ $goal->summary }}</span> goal?
                        </div>
                        <x-inputs.button class="bg-red-800 hover:bg-red-700">
                            Yes, delete
--- a/resources/views/goals/edit.blade.php
+++ b/resources/views/goals/edit.blade.php
@ -32,24 +32,36 @@
                                                    :value="old('to', $goal->to)" />
                                </div>

-                                <!-- Amount -->
+                                <!-- Frequency -->
                                <div class="flex-auto">
-                                    <x-inputs.label for="amount" value="Amount" />
-                                    <x-inputs.input name="amount"
-                                                    type="number"
-                                                    step="any"
-                                                    class="block w-full"
-                                                    :value="old('amount', $goal->amount)"/>
+                                    <x-inputs.label for="frequency" value="Frequency" />
+                                    <x-inputs.select name="frequency"
+                                                     class="block w-full"
+                                                     :options="$frequencyOptions"
+                                                     :selectedValue="old('frequency', $goal->frequency)">
+                                    </x-inputs.select>
+                                </div>
+
+                                <!-- Name -->
+                                <div class="flex-auto">
+                                    <x-inputs.label for="name" value="Trackable" />
+                                    <x-inputs.select name="name"
+                                                     class="block w-full"
+                                                     :options="$nameOptions"
+                                                     :selectedValue="old('name', $goal->name)"
+                                                     required>
+                                    </x-inputs.select>
                                </div>

                                <!-- Goal -->
                                <div class="flex-auto">
                                    <x-inputs.label for="goal" value="Goal" />
-                                    <x-inputs.select name="goal"
-                                                     class="block w-full"
-                                                     :options="$goalOptions"
-                                                     :selectedValue="old('goal', $goal->goal)">
-                                    </x-inputs.select>
+                                    <x-inputs.input name="goal"
+                                                    type="number"
+                                                    step="any"
+                                                    class="block w-full"
+                                                    :value="old('goal', $goal->goal)"
+                                                    required />
                                </div>
                            </div>
                        </div>
--- a/resources/views/goals/index.blade.php
+++ b/resources/views/goals/index.blade.php
@ -36,10 +36,9 @@
        <div class="max-w-7xl mx-auto sm:px-6 lg:px-8">
            <div class="bg-white overflow-hidden shadow-sm sm:rounded-lg">
                <div class="p-6 bg-white border-b border-gray-200">
-                    <h3 class="text-xl font-semibold text-gray-800">Goals</h3>
                    @forelse($goals['present'] as $goal)
                        <details>
-                            <summary>{{ number_format($goal->amount, 0) }}{{ $goalOptions[$goal->goal]['unit'] }} {{ $goalOptions[$goal->goal]['label'] }}</summary>
+                            <summary>{{ $goal->summary }}</summary>
                            TODO: Details for the day!
                            <div class="flex">
                                <a class="text-gray-500 hover:text-gray-700 hover:border-gray-300 text-sm"
--- a/resources/views/goals/show.blade.php
+++ b/resources/views/goals/show.blade.php
@ -1,7 +1,7 @@
 <x-app-layout>
    <x-slot name="header">
        <h2 class="font-semibold text-xl text-gray-800 leading-tight flex flex-auto">
-            TODO: GOAL NAME
+            {{ $goal->summary }}
            <a class="ml-2 text-gray-500 hover:text-gray-700 hover:border-gray-300 text-sm"
               href="{{ route('goals.edit', $goal) }}">
                <svg class="h-6 w-6" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor">