Wizardy.test.ts

import {Prompt} from './Prompt';
import {Wizardy} from './Wizardy';

describe('Wizardy', () => {
  describe('constructor', () => {
    it('supports IDs for later identification', () => {
      const firstWizard = new Wizardy('Account Creation');
      const secondWizard = new Wizardy('Hardware Setup');
      expect(firstWizard.id).not.toBe(secondWizard.id);
    });
  });

  describe('TOPIC', () => {
    it('publishes all answers when a questionnaire has been completed', done => {
      const questionnaire: Prompt<string | number>[] = [
        {
          answerKey: 'category',
          answerValue: (answer: string): string => {
            const menu = ['burger', 'pizza', 'veggie burger'];
            answer = answer.toLowerCase();
            if (menu.includes(answer)) {
              return answer;
            } else {
              throw Error(
                `Sorry, we only offer: ${menu
                  .map(category => category.charAt(0).toUpperCase() + category.substr(1))
                  .join(', ')}.`
              );
            }
          },
          question: 'What kind of food do you want to order?',
          response: 'Good choice!',
        },
        {
          answerKey: 'quantity',
          answerValue: (answer: string): number => {
            try {
              return parseInt(answer.match(/(\d+)/)![0], 10);
            } catch (error) {
              throw Error('Please write down the amount as number.');
            }
          },
          question: `How much do you want?`,
          response: 'Thanks. We will prepare your order.',
        },
      ];

      const wizard = new Wizardy();

      wizard.on(Wizardy.TOPIC.END, answers => {
        expect(answers).toEqual({
          category: 'pizza',
          quantity: 7,
        });
        done();
      });

      wizard.addQuestions(questionnaire);

      expect(wizard.ask()).toBe('What kind of food do you want to order?');
      expect(wizard.answer('Fajitas')).toBe('Sorry, we only offer: Burger, Pizza, Veggie burger.');

      expect(wizard.ask()).toBe('What kind of food do you want to order?');
      expect(wizard.answer('Pizza')).toBe('Good choice!');

      expect(wizard.ask()).toBe('How much do you want?');
      expect(wizard.answer('Seven')).toBe('Please write down the amount as number.');

      expect(wizard.ask()).toBe('How much do you want?');
      expect(wizard.answer('I would like to have 7.')).toBe('Thanks. We will prepare your order.');
    });
  });

  describe('answer', () => {
    it('triggers the answer value validation', done => {
      const questionnaire: Prompt<string>[] = [
        {
          answerKey: 'firstName',
          answerValue: (firstName: string): string => firstName,
          question: `What's your first name?`,
          response: 'Ok.',
        },
        {
          answerKey: 'lastName',
          answerValue: (lastName: string, answers: Record<string, string>): string => {
            expect(lastName).withContext('Check current answer value').toBe('Neugebauer');
            expect(answers['firstName']).withContext('Receive all previous answers').toBe('Benny');
            done();
            return lastName;
          },
          question: `What's your last name?`,
          response: 'Nice to meet you.',
        },
      ];

      const wizard = new Wizardy();
      wizard.addQuestions(questionnaire);

      wizard.ask();
      wizard.answer('Benny');

      wizard.ask();
      wizard.answer('Neugebauer');
    });

    it('catches unknown errors', () => {
      const question = {
        answerKey: 'firstName',
        answerValue: (): string => {
          throw 'not an error instance';
        },
        question: `What's your first name?`,
        response: 'Ok.',
      };
      const wizard = new Wizardy();
      wizard.addQuestions([question]);
      const errorMessage = wizard.answer('Benny');
      expect(errorMessage).toBe('Unknown error without an error message.');
    });
  });

  describe('step', () => {
    it('returns the progress of the questionnaire', () => {
      const questionnaire: Prompt<string | number>[] = [
        {
          answerKey: 'item',
          answerValue: input => input.trim(),
          question: `What would you like to order?`,
          response: () => `Lucky you! We have '${wizard.answers.item}' in stock.`,
        },
        {
          answerKey: 'quantity',
          answerValue: input => parseInt(input, 10),
          question: () => `How many '${wizard.answers.item}' do you want to buy?`,
          response: () =>
            `Great, we will prepare your order and deliver ${wizard.answers.quantity} ${wizard.answers.item} as soon as possible.`,
        },
      ];

      const wizard = new Wizardy();
      wizard.addQuestions(questionnaire);
      expect(wizard.step).toBe(0);

      wizard.ask();
      wizard.answer('iPhones');
      expect(wizard.step).toBe(1);

      wizard.ask();
      wizard.answer('13');
      expect(wizard.step).toBe(2);

      expect(() => {
        wizard.ask();
      }).toThrow();

      wizard.reset();
      expect(wizard.step).toBe(0);
    });
  });

  describe('inConversation', () => {
    it('shows if the wizard has a running conversation with a user', done => {
      const questionnaire: Prompt<string | number>[] = [
        {
          answerKey: 'item',
          answerValue: input => input.trim(),
          question: `What would you like to order?`,
          response: () => `Lucky you! We have '${wizard.answers.item}' in stock.`,
        },
        {
          answerKey: 'quantity',
          answerValue: input => parseInt(input, 10),
          question: () => `How many '${wizard.answers.item}' do you want to buy?`,
          response: () =>
            `Great, we will prepare your order and deliver ${wizard.answers.quantity} ${wizard.answers.item} as soon as possible.`,
        },
      ];

      const wizard = new Wizardy();

      wizard.on(Wizardy.TOPIC.END, () => {
        expect(wizard.inConversation).toBe(false);
        done();
      });

      wizard.addQuestions(questionnaire);
      expect(wizard.inConversation).toBe(false);

      wizard.ask();
      expect(wizard.inConversation).toBe(true);

      wizard.answer('iPhones');
      expect(wizard.inConversation).toBe(true);

      wizard.ask();
      expect(wizard.inConversation).toBe(true);

      wizard.answer('13');
    });
  });
});