From 30bce3dd9b2d82c108a438f69fe6c3fd68e7b32b Mon Sep 17 00:00:00 2001
From: "Christopher C. Wells" <git@chris-wells.net>
Date: Sun, 21 Mar 2021 14:37:57 -0700
Subject: [PATCH] Document some javascript functionality

---
 .../components/ingredient-picker.blade.php    | 24 ++++++++++++++++++-
 .../partials/entry-item-input.blade.php       |  6 +++++
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/resources/views/components/ingredient-picker.blade.php b/resources/views/components/ingredient-picker.blade.php
index 7e00401..71988b2 100644
--- a/resources/views/components/ingredient-picker.blade.php
+++ b/resources/views/components/ingredient-picker.blade.php
@@ -62,9 +62,14 @@
                     searching: false,
                     results: [],
                     search: {
+                        /**
+                         * Executes a search from the input.
+                         *
+                         * @param {object} $event Input event triggering the search.
+                         */
                         ['@input.debounce.400ms']($event) {
                             if ($event.target.value !== '') {
-                                fetch('{{ route('ingredient-picker.search') }}?term=' + $event.target.value)
+                                fetch(`{{ route('ingredient-picker.search') }}?term=${$event.target.value}`)
                                     .then(response => response.json())
                                     .then(data => {
                                         this.results = data;
@@ -75,22 +80,39 @@
                                 this.searching = false;
                             }
                         },
+
+                        /**
+                         * Cancels a search on focus out.
+                         */
                         ['@focusout.debounce.200ms']() {
                             this.searching = false;
                         }
                     },
                     ingredient: {
+                        /**
+                         * Handles a "picked" ingredient.
+                         *
+                         * @param {object} $event Click event for the pick.
+                         */
                         ['@click']($event) {
                             let selected = $event.target;
                             if (selected.dataset.id) {
                                 const ingredient = this.results.find(result => result.id === Number(selected.dataset.id));
+
+                                // Dispatch an event indicating which ingredient
+                                // the was picked.
                                 this.$el.dispatchEvent(new CustomEvent('ingredient-picked', {
                                     detail: { ingredient: ingredient },
                                     bubbles: true
                                 }));
+
+                                // Set the relevant field values for the picked
+                                // ingredient.
                                 this.$refs.ingredients.value = ingredient.id;
                                 this.$refs.ingredients_type.value = ingredient.type;
                                 this.$refs.ingredients_name.value = ingredient.name + (ingredient.detail ? `, ${ingredient.detail}` : '');
+
+                                // Clear search results.
                                 this.searching = false;
                                 this.results = [];
                             }
diff --git a/resources/views/journal-entries/partials/entry-item-input.blade.php b/resources/views/journal-entries/partials/entry-item-input.blade.php
index cc87e43..56b70a3 100644
--- a/resources/views/journal-entries/partials/entry-item-input.blade.php
+++ b/resources/views/journal-entries/partials/entry-item-input.blade.php
@@ -77,11 +77,17 @@
                 const entryItem = e.target.closest('.entry-item');
                 const ingredient = e.detail.ingredient;
                 let servingSize, servingUnit;
+
+                // Always set recipes to a default of 1 serving.
                 if (ingredient.type === 'App\\Models\\Recipe') {
                     servingSize = 1;
                     servingUnit = 'serving';
                 } else if (ingredient.type === 'App\\Models\\Food') {
                     servingUnit = ingredient.serving_unit ?? 'serving'
+
+                    // Any food with a unit of "serving" (or no unit) defaults
+                    // to 1 serving. This accounts for food with configurations
+                    // like "2 scoops" using a custom serving unit.
                     if (servingUnit === 'serving') {
                         servingSize = 1;
                     } else {