habitica/test/api/unit/libs/items/utils.test.js

/* eslint-disable camelcase */
import {
  validateItemPath,
  getDefaultOwnedGear,
  castItemVal,
} from '../../../../../website/server/libs/items/utils';

describe('Items Utils', () => {
  describe('getDefaultOwnedGear', () => {
    it('clones the result object', () => {
      const res1 = getDefaultOwnedGear();
      res1.extraProperty = true;

      const res2 = getDefaultOwnedGear();
      expect(res2).not.to.have.property('extraProperty');
    });
  });

  describe('validateItemPath', () => {
    it('returns false if not an item path', () => {
      expect(validateItemPath('notitems.gear.owned.item')).to.equal(false);
    });

    it('returns true if a valid schema path', () => {
      expect(validateItemPath('items.gear.equipped.weapon')).to.equal(true);
      expect(validateItemPath('items.currentPet')).to.equal(true);
      expect(validateItemPath('items.special.snowball')).to.equal(true);
    });

    it('works with owned gear paths', () => {
      expect(validateItemPath('items.gear.owned.head_armoire_crownOfHearts')).to.equal(true);
      expect(validateItemPath('items.gear.owned.head_invalid')).to.equal(false);
    });

    it('works with pets paths', () => {
      expect(validateItemPath('items.pets.Wolf-CottonCandyPink')).to.equal(true);
      expect(validateItemPath('items.pets.Wolf-Invalid')).to.equal(false);
    });

    it('works with eggs paths', () => {
      expect(validateItemPath('items.eggs.LionCub')).to.equal(true);
      expect(validateItemPath('items.eggs.Armadillo')).to.equal(true);
      expect(validateItemPath('items.eggs.NotAnArmadillo')).to.equal(false);
    });

    it('works with hatching potions paths', () => {
      expect(validateItemPath('items.hatchingPotions.Base')).to.equal(true);
      expect(validateItemPath('items.hatchingPotions.StarryNight')).to.equal(true);
      expect(validateItemPath('items.hatchingPotions.Invalid')).to.equal(false);
    });

    it('works with food paths', () => {
      expect(validateItemPath('items.food.Cake_Base')).to.equal(true);
      expect(validateItemPath('items.food.Cake_Invalid')).to.equal(false);
    });

    it('works with mounts paths', () => {
      expect(validateItemPath('items.mounts.Cactus-Base')).to.equal(true);
      expect(validateItemPath('items.mounts.Aether-Invisible')).to.equal(true);
      expect(validateItemPath('items.mounts.Aether-Invalid')).to.equal(false);
    });

    it('works with quests paths', () => {
      expect(validateItemPath('items.quests.atom3')).to.equal(true);
      expect(validateItemPath('items.quests.invalid')).to.equal(false);
    });
  });

  describe('castItemVal', () => {
    it('returns the item val untouched if not an item path', () => {
      expect(castItemVal('notitems.gear.owned.item', 'a string')).to.equal('a string');
    });

    it('returns the item val untouched if an unsupported path', () => {
      expect(castItemVal('items.gear.equipped.weapon', 'a string')).to.equal('a string');
      expect(castItemVal('items.currentPet', 'a string')).to.equal('a string');
      expect(castItemVal('items.special.snowball', 'a string')).to.equal('a string');
    });

    it('converts values for pets paths to numbers', () => {
      expect(castItemVal('items.pets.Wolf-CottonCandyPink', '5')).to.equal(5);
      expect(castItemVal('items.pets.Wolf-Invalid', '5')).to.equal(5);
    });

    it('converts values for eggs paths to numbers', () => {
      expect(castItemVal('items.eggs.LionCub', '5')).to.equal(5);
      expect(castItemVal('items.eggs.Armadillo', '5')).to.equal(5);
      expect(castItemVal('items.eggs.NotAnArmadillo', '5')).to.equal(5);
    });

    it('converts values for hatching potions paths to numbers', () => {
      expect(castItemVal('items.hatchingPotions.Base', '5')).to.equal(5);
      expect(castItemVal('items.hatchingPotions.StarryNight', '5')).to.equal(5);
      expect(castItemVal('items.hatchingPotions.Invalid', '5')).to.equal(5);
    });

    it('converts values for food paths to numbers', () => {
      expect(castItemVal('items.food.Cake_Base', '5')).to.equal(5);
      expect(castItemVal('items.food.Cake_Invalid', '5')).to.equal(5);
    });

    it('converts values for quests paths to numbers', () => {
      expect(castItemVal('items.quests.atom3', '5')).to.equal(5);
      expect(castItemVal('items.quests.invalid', '5')).to.equal(5);
    });

    it('converts values for mounts paths to true/null', () => {
      // mounts are never false but can be null (function contains more details)
      expect(castItemVal('items.mounts.Cactus-Base', 'true')).to.equal(true);
      expect(castItemVal('items.mounts.Aether-Invisible', 'null')).to.equal(null);
      expect(castItemVal('items.mounts.Aether-Invisible', 'false')).to.equal(null);
      expect(castItemVal('items.mounts.Aether-Invalid', 'true')).to.equal(true);
      expect(castItemVal('items.mounts.Aether-Invalid', 'truthy')).to.equal(true);
      expect(castItemVal('items.mounts.Aether-Invalid', 0)).to.equal(null);
    });

    it('converts values for owned gear to true/false', () => {
      expect(castItemVal('items.gear.owned.shield_warrior_0', 'true')).to.equal(true);
      expect(castItemVal('items.gear.owned.invalid', 'false')).to.equal(false);
      expect(castItemVal('items.gear.owned.invalid', 'null')).to.equal(undefined);
      expect(castItemVal('items.gear.owned.invalid', 'truthy')).to.equal(true);
      expect(castItemVal('items.gear.owned.invalid', 0)).to.equal(false);
    });
  });
});