Merge patch commit

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeremyckahn/farmhand",
-  "version": "1.17.0",
+  "version": "1.17.1",
   "publishConfig": {
     "access": "public"
   },

src/components/Cellar/Keg.js

@@ -17,6 +17,7 @@ import { FERMENTED_CROP_NAME } from '../../templates'
 import AnimatedNumber from '../AnimatedNumber'
 
 import './Keg.sass'
+import { getKegSpoilageRate } from '../../utils/getKegSpoilageRate'
 
 /**
  * @param {Object} props
@@ -54,6 +55,9 @@ export function Keg({ keg }) {
   const kegValue =
     getKegValue(keg) * getSalePriceMultiplier(completedAchievements)
 
+  const spoilageRate = getKegSpoilageRate(keg)
+  const spoilageRateDisplayValue = Number((spoilageRate * 100).toPrecision(2))
+
   return (
     <Card className="Keg">
       <CardHeader
@@ -69,18 +73,19 @@ export function Keg({ keg }) {
         subheader={
           <>
             {canBeSold ? (
-              <p>Days since ready: {Math.abs(keg.daysUntilMature)}</p>
+              <>
+                <p>Days since ready: {Math.abs(keg.daysUntilMature)}</p>
+                <p>
+                  Current value:{' '}
+                  <AnimatedNumber
+                    {...{ number: kegValue, formatter: moneyString }}
+                  />
+                </p>
+                <p>Potential for spoilage: {spoilageRateDisplayValue}%</p>
+              </>
             ) : (
               <p>Days until ready: {keg.daysUntilMature}</p>
             )}
-            {canBeSold ? (
-              <p>
-                Current value:{' '}
-                <AnimatedNumber
-                  {...{ number: kegValue, formatter: moneyString }}
-                />
-              </p>
-            ) : null}
           </>
         }
       ></CardHeader>

src/constants.js

@@ -254,3 +254,4 @@ export const COW_TRADE_TIMEOUT = 10000
 export const WEEDS_SPAWN_CHANCE = 0.15
 
 export const KEG_INTEREST_RATE = 0.02
+export const KEG_SPOILAGE_RATE_MULTIPLIER = 0.001

src/data/crops/carrot.js

@@ -1,11 +1,13 @@
+/** @typedef {import("../../index").farmhand.item} item */
+
 import { crop, fromSeed } from '../crop'
 import { cropLifeStage, cropType } from '../../enums'
 
 const { SEED, GROWING } = cropLifeStage
 
 /**
  * @property farmhand.module:items.carrotSeed
- * @type {farmhand.item}
+ * @type {item}
  */
 export const carrotSeed = crop({
   cropType: cropType.CARROT,
@@ -21,7 +23,7 @@ export const carrotSeed = crop({
 
 /**
  * @property farmhand.module:items.carrot
- * @type {farmhand.item}
+ * @type {item}
  */
 export const carrot = crop({
   ...fromSeed(carrotSeed, { canBeFermented: true }),

src/game-logic/reducers/processCellar.js

@@ -1,10 +1,13 @@
 /** @typedef {import("../../components/Farmhand/Farmhand").farmhand.state} state */
 
+import { processCellarSpoilage } from './processCellarSpoilage'
+
 /**
  * @param {state} state
  * @returns state
  */
 export const processCellar = state => {
+  state = processCellarSpoilage(state)
   const { cellarInventory } = state
 
   const newCellarInventory = [...cellarInventory]

src/game-logic/reducers/processCellarSpoilage.js

@@ -0,0 +1,40 @@
+/** @typedef {import("../../components/Farmhand/Farmhand").farmhand.state} state */
+
+import { randomNumberService } from '../../common/services/randomNumber'
+import { KEG_SPOILED_MESSAGE } from '../../templates'
+import { getKegSpoilageRate } from '../../utils/getKegSpoilageRate'
+
+import { removeKegFromCellar } from './removeKegFromCellar'
+
+/**
+ * @param {state} state
+ * @returns state
+ */
+export const processCellarSpoilage = state => {
+  const { cellarInventory } = state
+
+  const newCellarInventory = [...cellarInventory]
+
+  for (let i = newCellarInventory.length - 1; i > -1; i--) {
+    const keg = newCellarInventory[i]
+    const spoilageRate = getKegSpoilageRate(keg)
+
+    if (randomNumberService.isRandomNumberLessThan(spoilageRate)) {
+      state = removeKegFromCellar(state, keg.id)
+      state = {
+        ...state,
+        newDayNotifications: [
+          ...state.newDayNotifications,
+          {
+            message: KEG_SPOILED_MESSAGE`${keg}`,
+            severity: 'error',
+          },
+        ],
+      }
+    }
+  }
+
+  state = { ...state }
+
+  return state
+}

src/game-logic/reducers/processCellarSpoilage.test.js

@@ -0,0 +1,60 @@
+import { randomNumberService } from '../../common/services/randomNumber'
+import { KEG_SPOILED_MESSAGE } from '../../templates'
+import { getKegStub } from '../../test-utils/stubs/getKegStub'
+
+import { processCellarSpoilage } from './processCellarSpoilage'
+
+describe('processCellarSpoilage', () => {
+  test('does not remove kegs that have not spoiled', () => {
+    jest
+      .spyOn(randomNumberService, 'isRandomNumberLessThan')
+      .mockReturnValueOnce(false)
+
+    const keg = getKegStub()
+    const cellarInventory = [keg]
+    const newDayNotifications = []
+    const expectedState = processCellarSpoilage({
+      cellarInventory,
+      newDayNotifications,
+    })
+
+    expect(expectedState.cellarInventory).toHaveLength(1)
+  })
+
+  test('removes kegs that have spoiled', () => {
+    jest
+      .spyOn(randomNumberService, 'isRandomNumberLessThan')
+      .mockReturnValueOnce(true)
+
+    const keg = getKegStub()
+    const cellarInventory = [keg]
+    const newDayNotifications = []
+    const expectedState = processCellarSpoilage({
+      cellarInventory,
+      newDayNotifications,
+    })
+
+    expect(expectedState.cellarInventory).toHaveLength(0)
+  })
+
+  test('shows notification for kegs that have spoiled', () => {
+    jest
+      .spyOn(randomNumberService, 'isRandomNumberLessThan')
+      .mockReturnValueOnce(true)
+
+    const keg = getKegStub()
+    const cellarInventory = [keg]
+    const newDayNotifications = []
+    const expectedState = processCellarSpoilage({
+      cellarInventory,
+      newDayNotifications,
+    })
+
+    expect(expectedState.newDayNotifications).toEqual([
+      {
+        message: KEG_SPOILED_MESSAGE`${keg}`,
+        severity: 'error',
+      },
+    ])
+  })
+})

src/templates.js

@@ -1,4 +1,7 @@
-/** @typedef {import("./index").farmhand.item} farmhand.item */
+/**
+ * @typedef {import("./index").farmhand.item} farmhand.item
+ * @typedef {import("./index").farmhand.keg} keg
+ */
 
 /**
  * @module farmhand.templates
@@ -335,3 +338,11 @@ export const SHOVELED_PLOT = (_, item) => `Shoveled plot of ${item.name}`
  * @returns {string}
  */
 export const FERMENTED_CROP_NAME = (_, item) => `Fermented ${item.name}`
+
+/**
+ * @param {string} _
+ * @param {keg} keg
+ * @returns {string}
+ */
+export const KEG_SPOILED_MESSAGE = (_, keg) =>
+  `Oh no! Your ${FERMENTED_CROP_NAME`${itemsMap[keg.itemId]}`} has spoiled!`

src/test-utils/stubs/getKegStub.js

@@ -0,0 +1,18 @@
+/** @typedef {import("../../index").farmhand.keg} keg */
+
+import { v4 as uuid } from 'uuid'
+
+import { carrot } from '../../data/crops'
+
+/**
+ * @param {Partial<keg>} overrides
+ * @returns keg
+ */
+export const getKegStub = overrides => {
+  return {
+    id: uuid(),
+    itemId: carrot.id,
+    daysUntilMature: carrot.daysToFerment,
+    ...overrides,
+  }
+}

src/utils/getKegSpoilageRate.js

@@ -0,0 +1,18 @@
+/** @typedef {import("../index").farmhand.keg} keg */
+
+import { KEG_SPOILAGE_RATE_MULTIPLIER } from '../constants'
+
+/**
+ * @param {keg} keg
+ * @returns number
+ */
+export const getKegSpoilageRate = keg => {
+  if (keg.daysUntilMature > 0) {
+    return 0
+  }
+
+  const spoilageRate =
+    Math.abs(keg.daysUntilMature) * KEG_SPOILAGE_RATE_MULTIPLIER
+
+  return spoilageRate
+}

src/utils/getKegSpoilageRate.test.js

@@ -0,0 +1,27 @@
+import { getKegStub } from '../test-utils/stubs/getKegStub'
+
+import { getKegSpoilageRate } from './getKegSpoilageRate'
+
+describe('getKegSpoilageRate', () => {
+  test('handles kegs that are not mature', () => {
+    const keg = getKegStub()
+    expect(getKegSpoilageRate(keg)).toEqual(0)
+  })
+
+  test('handles kegs that are mature', () => {
+    const keg = getKegStub({ daysUntilMature: 0 })
+    expect(getKegSpoilageRate(keg)).toEqual(0)
+  })
+
+  test.each([
+    [-1, 0.001],
+    [-10, 0.01],
+    [-100, 0.1],
+  ])(
+    'handles kegs that are beyond mature',
+    (daysUntilMature, expectedSpoilageRate) => {
+      const keg = getKegStub({ daysUntilMature })
+      expect(getKegSpoilageRate(keg)).toEqual(expectedSpoilageRate)
+    }
+  )
+})