Add switch to exclude new category weight

Callisto13 · Callisto13 · commit b981a97541a0 · 2021-02-06T12:43:17.000Z
The weight exclusion of custom categories is not grouped with "Worn" or
"Consumable" in the view's "Weight Breakdown" but added to a "Other excluded"
count which is only shown when pack has items in custom excluded category.
diff --git a/api/controllers/item.js b/api/controllers/item.js
@@ -89,9 +89,9 @@ router.get('', async (req, res) => {
 });
 
 // create or retrieve category
-async function fetchCategory(categoryId) {
+async function fetchCategory(categoryId, excludeWeight) {
     let newCat = null;
-    const category = { name: categoryId, level: 'USER' };
+    const category = { name: categoryId, level: 'USER', exclude_weight: excludeWeight };
     try {
         newCat = await models.Category.create(category);
     } catch (err) {
@@ -106,12 +106,12 @@ async function fetchCategory(categoryId) {
 
 // Create
 router.post('', authenticate, async (req, res) => {
-    const { newCategory } = req.body;
+    const { newCategory, excludeWeight } = req.body;
     const { payload } = itemPayload(req.body);
 
     let newCat = null;
     if (newCategory) {
-        const { category, err } = await fetchCategory(payload.categoryId);
+        const { category, err } = await fetchCategory(payload.categoryId, excludeWeight);
         if (err) {
             return res.status(400).json(err);
         }
@@ -132,7 +132,8 @@ router.put('', authenticate, async (req, res) => {
 
     let newCat = null;
     if (newCategory) {
-        const { category, err } = await fetchCategory(payload.categoryId);
+        // hardcoding false here while I figure out how to do update
+        const { category, err } = await fetchCategory(payload.categoryId, false);
         if (err) {
             return res.status(400).json(err);
         }
@@ -162,4 +163,4 @@ router.post('/delete', authenticate, (req, res) => {
 });
 
 
-module.exports = router;
+module.exports = router;
diff --git a/frontend/src/app/components/CategoryTable/index.tsx b/frontend/src/app/components/CategoryTable/index.tsx
@@ -25,8 +25,10 @@ const CategoryChart: React.FC<CategoryTableProps> = ({ data, unit }) => {
     const totalWeight = data.reduce((acc: number, cur: CategoryItemSpecs) => acc + cur.total.value, 0);
     const excludedWeight = data.reduce((acc: number, cur: CategoryItemSpecs) => acc + cur.excluded.value, 0);
     const consumables = data.find(c => c.name === 'Consumables');
+    const customExcludedCategories = data.find(c => c.level === 'USER' && c.exclude_weight === true);
+    const customExcludedWeight = customExcludedCategories ? customExcludedCategories.total.value : 0;
     const consumablesWeight = consumables ? consumables.total.value : 0;
-    const wornWeight = excludedWeight - consumablesWeight;
+    const wornWeight = excludedWeight - consumablesWeight - customExcludedWeight;
     const baseWeight = totalWeight - excludedWeight;
 
     return (
@@ -47,6 +49,12 @@ const CategoryChart: React.FC<CategoryTableProps> = ({ data, unit }) => {
                 <div>Worn</div>
                 <div>{wornWeight.toFixed(2)} {unit}</div>
             </CatRow>
+            {customExcludedCategories &&
+            <CatRow className="totals">
+                <div>Other Excluded</div>
+                <div>{customExcludedWeight.toFixed(2)} {unit}</div>
+            </CatRow>
+            }
             <CatRow className="totals highlight">
                 <div>Base Weight</div>
                 <div>{baseWeight.toFixed(2)} {unit}</div>
@@ -55,4 +63,4 @@ const CategoryChart: React.FC<CategoryTableProps> = ({ data, unit }) => {
     )
 };
 
-export default React.memo(CategoryChart);
+export default React.memo(CategoryChart);
diff --git a/frontend/src/app/components/FormFields/index.js b/frontend/src/app/components/FormFields/index.js
@@ -2,5 +2,6 @@ export { default as Input } from './Input';
 export { default as Textarea } from './Textarea';
 export { default as Select } from './Select'
 export { default as SelectCreatable } from './SelectCreatable'
+export { default as SwitchInput } from './SwitchInput'
 export { Option } from './types';
-export { Label } from './styles';
+export { Label } from './styles';
diff --git a/frontend/src/app/components/ItemForm/ItemForm.tsx b/frontend/src/app/components/ItemForm/ItemForm.tsx
@@ -3,15 +3,15 @@ import * as Yup from 'yup';
 import FileDownload from 'js-file-download';
 import { Formik, FormikProps } from "formik";
 import { Row, Col, Button } from "antd";
-import { Input, Select, SelectCreatable, Option } from '../FormFields';
+import { Input, Select, SelectCreatable, Option, SwitchInput } from "../FormFields";
 
 import { AppContext } from 'AppContext';
 import { CreateItem, ItemConstants } from "types/item";
 import { FormSpecs } from "./types";
 
 import withApi from 'app/components/higher-order/with-api';
 import { categoryOptions, weightUnitOptions } from "lib/utils/form";
-import { categorySelectValue } from "lib/utils/categories";
+import { categorySelectValue, categorySelectIfNew } from "lib/utils/categories";
 
 import UploadModal from 'app/Inventory/UploadModal';
 import { alertError, alertSuccess } from "../Notifications";
@@ -41,7 +41,8 @@ const ItemForm: React.FC<FormSpecs.Props> = ({ createItem, exportCsv, onSubmit }
                 weight_unit: default_weight_unit,
                 price: undefined,
                 product_url: '',
-                newCategory: false
+                newCategory: false,
+                excludeWeight: false
             }}
             validationSchema={Yup.object().shape({
                 name: Yup.string().required('Item name is required'),
@@ -69,6 +70,7 @@ const ItemForm: React.FC<FormSpecs.Props> = ({ createItem, exportCsv, onSubmit }
                 const wasSubmitted = submitCount > 0;
                 const weightUnit = values.weight_unit;
                 const categoryValue = categorySelectValue(app.categories, values.categoryId);
+                let isNewCategory = categorySelectIfNew(app.categories, values.categoryId);
 
                 return (
                     <SidebarContainer>
@@ -87,14 +89,24 @@ const ItemForm: React.FC<FormSpecs.Props> = ({ createItem, exportCsv, onSubmit }
                             value={categoryValue || null}
                             onChange={(option: Option<number>) => {
                                 const value = option ? option.value : undefined;
-                                const isNewCategory = Boolean(option && option.__isNew__);
+                                isNewCategory = Boolean(option && option.__isNew__);
                                 setFieldValue('categoryId', value);
                                 setFieldValue('newCategory', isNewCategory);
                             }}
                             error={wasSubmitted && !!errors.categoryId}
                             errorMsg={errors.categoryId}
                             clearable={true}
                         />
+                        {isNewCategory &&
+                           <SwitchInput
+                                    label="Exclude category from base weight"
+                                    checked = {values.excludeWeight}
+                                    checkedText="Yes"
+                                    uncheckedText="No"
+                                    tip="All items added to this category will be exluded from base weight"
+                                    onChange={v => setFieldValue('excludeWeight', v)}
+                            ></SwitchInput>
+                        }
                         <Input
                             label="Product Name"
                             value={values.product_name || ''}
@@ -172,4 +184,4 @@ const ItemFormWithProps = withApi<FormSpecs.ApiProps>(api => ({
     exportCsv: api.ItemService.exportCSV
 }))(ItemForm);
 
-export default ItemFormWithProps;
+export default ItemFormWithProps;
diff --git a/frontend/src/lib/utils/categories.ts b/frontend/src/lib/utils/categories.ts
@@ -29,4 +29,9 @@ export const categorySelectValue = (categories: Category[], value: number | stri
         value: currentCategory ? currentCategory.id : value,
         label: currentCategory ? currentCategory.name : value.toString()
     };
-};
+};
+
+export const categorySelectIfNew = (categories: Category[], value: number | string | undefined): boolean => {
+    if (!value) return false;
+    return categories.find(cat => cat.id === value) ? false : true;
+};
diff --git a/frontend/src/types/item.ts b/frontend/src/types/item.ts
@@ -21,6 +21,7 @@ export interface Item extends BaseItem {
 export type CreateItem = Omit<BaseItem, 'categoryId'> & {
     categoryId?: number;
     newCategory: boolean;
+    excludeWeight: boolean;
 }
 
 export type UpdateItem = Omit<BaseItem, 'categoryId'> & {
@@ -57,4 +58,4 @@ export enum ItemConstants {
     name = 200,
     product_name = 500,
     product_url = 500
-}
+}
