@haskou/value-objects 1.0.1

package/tests/value-objects/time/Hour.spec.ts

@@ -0,0 +1,197 @@
+import { Hour, InvalidHourError, InvalidMinutesError } from '../../../src';
+
+describe('Hour', () => {
+  describe('constructor', () => {
+    describe('when value is a string', () => {
+      it('should return a Hour instance', () => {
+        const hour = new Hour('23:59');
+        expect(hour).toBeInstanceOf(Hour);
+      });
+
+      it('should throw error if hour is invalid', () => {
+        expect(() => new Hour('24:00')).toThrow('Invalid hour');
+        expect(() => new Hour('24:00')).toThrow(InvalidHourError);
+      });
+
+      it('should throw error if minutes is invalid', () => {
+        expect(() => new Hour('23:60')).toThrow('Invalid minutes');
+        expect(() => new Hour('23:60')).toThrow(InvalidMinutesError);
+      });
+
+      it('should work with 0 hour', () => {
+        expect(new Hour('00:00').toString()).toEqual('00:00');
+      });
+    });
+
+    describe('when receives 2 numbers', () => {
+      it('should return a Hour instance', () => {
+        const hour = new Hour(23, 59);
+        expect(hour).toBeInstanceOf(Hour);
+      });
+
+      it('should throw error if hour is invalid', () => {
+        expect(() => new Hour(24, 0)).toThrow('Invalid hour');
+        expect(() => new Hour(24, 0)).toThrow(InvalidHourError);
+      });
+
+      it('should throw error if minutes is invalid', () => {
+        expect(() => new Hour(23, 60)).toThrow('Invalid minutes');
+        expect(() => new Hour(23, 60)).toThrow(InvalidMinutesError);
+      });
+
+      it('should work with 0 hour', () => {
+        const hour = new Hour(0, 0).toString();
+        expect(hour).toEqual('00:00');
+      });
+    });
+  });
+
+  describe('addMinutes', () => {
+    it('should add minutes to hour', () => {
+      expect(new Hour('23:59').addMinutes(1).toString()).toEqual('00:00');
+    });
+  });
+
+  describe('toString', () => {
+    it('should return string value', () => {
+      expect(new Hour('23:59').toString()).toEqual('23:59');
+    });
+  });
+
+  describe('isEqual', () => {
+    it('should return true if value is equal', () => {
+      expect(new Hour('23:59').isEqual(new Hour('23:59'))).toBeTrue();
+    });
+
+    it('should return false if value is not equal', () => {
+      expect(new Hour('23:59').isEqual(new Hour('00:00'))).toBeFalse();
+    });
+  });
+
+  describe('with some values', () => {
+    it('should not throw error', () => {
+      expect(() => new Hour('23:59')).not.toThrow();
+    });
+
+    it('should add trail zero to hours', () => {
+      expect(new Hour('1:59').toString()).toEqual('01:59');
+    });
+
+    it('should add trail zero to minutes', () => {
+      expect(new Hour('23:9').toString()).toEqual('23:09');
+    });
+
+    it('should add minutes to hours', () => {
+      expect(new Hour('23:59').addMinutes(1).toString()).toEqual('00:00');
+    });
+
+    it('should add hours to hours', () => {
+      expect(new Hour('23:59').addMinutes(60).toString()).toEqual('00:59');
+    });
+
+    it('should subtract hours to hours', () => {
+      expect(new Hour('23:59').addMinutes(-60).toString()).toEqual('22:59');
+    });
+
+    it('should subtract minutes to hours', () => {
+      expect(new Hour('00:00').addMinutes(-1).toString()).toEqual('23:59');
+    });
+
+    it('should add more than 2 hours', () => {
+      expect(new Hour('23:59').addMinutes(120).toString()).toEqual('01:59');
+    });
+  });
+
+  describe('diffInMinutes', () => {
+    it('should return diff in minutes when jump the hour day', () => {
+      expect(new Hour('23:59').diffInMinutes(new Hour('00:00'))).toEqual(1);
+    });
+
+    it('should return diff in minutes in total', () => {
+      expect(new Hour('00:00').diffInMinutes(new Hour('23:59'))).toEqual(1439);
+    });
+
+    it('should return 60 minutes when diff is 1 hour', () => {
+      expect(new Hour('00:00').diffInMinutes(new Hour('01:00'))).toEqual(60);
+    });
+
+    it('should return 1380 minutes when diff is 23 hours', () => {
+      expect(new Hour('01:00').diffInMinutes(new Hour('00:00'))).toEqual(1380);
+    });
+
+    it('should return 1439 minutes when diff is -1 minute from start', () => {
+      expect(new Hour('01:05').diffInMinutes(new Hour('01:04'))).toEqual(1439);
+    });
+  });
+
+  describe('getMinutes', () => {
+    it('should return minutes', () => {
+      expect(new Hour('23:59').getMinutes()).toEqual(59);
+    });
+  });
+
+  describe('getHours', () => {
+    it('should return hours', () => {
+      expect(new Hour('23:59').getHours()).toEqual(23);
+    });
+  });
+
+  describe('isGreaterThan', () => {
+    it('should return true if the hour is greater', () => {
+      const hour1 = new Hour('12:30');
+      const hour2 = new Hour('10:45');
+      expect(hour1.isGreaterThan(hour2)).toBeTrue();
+    });
+
+    it('should return false if the hour is equal', () => {
+      const hour1 = new Hour('12:30');
+      const hour2 = new Hour('12:30');
+      expect(hour1.isGreaterThan(hour2)).toBeFalse();
+    });
+
+    it('should return false if the hour is less', () => {
+      const hour1 = new Hour('12:30');
+      const hour2 = new Hour('14:45');
+      expect(hour1.isGreaterThan(hour2)).toBeFalse();
+    });
+
+    it('should return true if the hour is greater with minutes', () => {
+      const hour1 = new Hour('12:30');
+      const hour2 = new Hour('12:15');
+      expect(hour1.isGreaterThan(hour2)).toBeTrue();
+    });
+
+    it('should return false if the hour is less with minutes', () => {
+      const hour1 = new Hour('12:30');
+      const hour2 = new Hour('12:45');
+      expect(hour1.isGreaterThan(hour2)).toBeFalse();
+    });
+  });
+  describe('isLessThan', () => {
+    it('should return true if the hour is less', () => {
+      const hour1 = new Hour('10:45');
+      const hour2 = new Hour('12:30');
+      expect(hour1.isLessThan(hour2)).toBeTrue();
+    });
+    it('should return false if the hour is equal', () => {
+      const hour1 = new Hour('12:30');
+      const hour2 = new Hour('12:30');
+      expect(hour1.isLessThan(hour2)).toBeFalse();
+    });
+    it('should return false if the hour is greater', () => {
+      const hour1 = new Hour('14:45');
+      const hour2 = new Hour('12:30');
+      expect(hour1.isLessThan(hour2)).toBeFalse();
+    });
+    it('should return true if the hour is less with minutes', () => {
+      const hour1 = new Hour('12:15');
+      const hour2 = new Hour('12:30');
+      expect(hour1.isLessThan(hour2)).toBeTrue();
+    });
+    it('should return false if the hour is greater with minutes', () => {
+      const hour1 = new Hour('12:45');
+      const hour2 = new Hour('12:30');
+      expect(hour1.isLessThan(hour2)).toBeFalse();
+    });
+  });
+});

package/tests/value-objects/time/MonthOfYear.spec.ts

@@ -0,0 +1,111 @@
+import {
+  MonthOfYear,
+  Month,
+  Year,
+  ValueNotInEnumError,
+  InvalidIntegerError,
+} from '../../../src';
+
+describe('MonthOfYear', () => {
+  describe('constructor', () => {
+    it('should create a Month instance', () => {
+      const month = new MonthOfYear(1, 2022);
+      expect(month).toMatchObject({
+        month: Month.JANUARY,
+        year: new Year(2022),
+      });
+    });
+    it('should throw error if the Month is negative', () => {
+      expect(() => new MonthOfYear(-1, 2022)).toThrow(ValueNotInEnumError);
+    });
+    it('should throw error if the Month is not integer', () => {
+      expect(() => new MonthOfYear(1.1, 2022)).toThrow(ValueNotInEnumError);
+    });
+    it('should throw error if the Month is greater than 12', () => {
+      expect(() => new MonthOfYear(13, 2022)).toThrow(ValueNotInEnumError);
+    });
+    it('should throw error if the Year is not integer', () => {
+      expect(() => new MonthOfYear(1, 2022.1)).toThrow(InvalidIntegerError);
+    });
+  });
+
+  describe('getYear', () => {
+    it('should return the year', () => {
+      const month = new MonthOfYear(1, 2022);
+      expect(month.getYear()).toStrictEqual(new Year(2022));
+    });
+  });
+
+  describe('getDays', () => {
+    it('should return the number of days in the month', () => {
+      const month = new MonthOfYear(1, 2022);
+      expect(month.getNumberOfDays()).toBe(31);
+    });
+    it('should return the correct number of days for February', () => {
+      const month = new MonthOfYear(2, 2022);
+      expect(month.getNumberOfDays()).toBe(28);
+    });
+  });
+
+  describe('getTimestampInterval', () => {
+    it('should return the timestamp interval for the month', () => {
+      const month = new MonthOfYear(1, 2022);
+      const interval = month.getTimestampInterval();
+      expect(interval.getStart().valueOf()).toBe(1640995200000);
+      expect(interval.getEnd().valueOf()).toBe(1643587200000);
+    });
+  });
+  describe('getMonth', () => {
+    it('should return a Month instance with the correct month value', () => {
+      const monthOfYear = new MonthOfYear(5, 2022);
+      const month = monthOfYear.getMonth();
+      expect(month).toStrictEqual(Month.MAY);
+    });
+  });
+  describe('fromTimestamp', () => {
+    it('should create a MonthOfYear instance from a valid Timestamp', () => {
+      const timestamp = { getMonth: () => 5, getYear: () => 2022 } as any;
+      const monthOfYear = MonthOfYear.fromTimestamp(timestamp);
+      expect(monthOfYear.getMonth().valueOf()).toBe(5);
+      expect(monthOfYear.getYear()).toStrictEqual(new Year(2022));
+    });
+
+    it('should throw an error if the Timestamp has an invalid month', () => {
+      const timestamp = { getMonth: () => 13, getYear: () => 2022 } as any;
+      expect(() => MonthOfYear.fromTimestamp(timestamp)).toThrow(
+        ValueNotInEnumError,
+      );
+    });
+  });
+  describe('fromString', () => {
+    it('should create a MonthOfYear instance from a valid string', () => {
+      const monthOfYear = MonthOfYear.fromString('2022/05');
+      expect(monthOfYear.getMonth().valueOf()).toBe(5);
+      expect(monthOfYear.getYear()).toStrictEqual(new Year(2022));
+    });
+
+    it('should pad single digit months correctly', () => {
+      const monthOfYear = MonthOfYear.fromString('2022/1');
+      expect(monthOfYear.getMonth().valueOf()).toBe(1);
+      expect(monthOfYear.getYear()).toStrictEqual(new Year(2022));
+    });
+
+    it('should throw error for invalid month', () => {
+      expect(() => MonthOfYear.fromString('2022/13')).toThrow(
+        ValueNotInEnumError,
+      );
+    });
+
+    it('should throw error for invalid year', () => {
+      expect(() => MonthOfYear.fromString('2022.1/05')).toThrow(
+        InvalidIntegerError,
+      );
+    });
+
+    it('should throw error for malformed string', () => {
+      expect(() => MonthOfYear.fromString('2022')).toThrow();
+      expect(() => MonthOfYear.fromString('')).toThrow();
+      expect(() => MonthOfYear.fromString('2022/')).toThrow();
+    });
+  });
+});