Refactor formatTimeSlot to addLeadingZeroIfLessThanOne. Add time convenience methods to Day. Refactor

Update docs

Author: Joe Crick

docs/index.html

@@ -1,9 +1,10 @@
-import format from './format';
+import {addLeadingZeroIfLessThanTen, formatDate as format} from './format';
 import {getJsDate} from './date';
 import noOp from './no-op';
 import getRangeOfDates from './date-utils/get_range_of_dates';
 import addDays from './date-utils/adjust_days';
 import getWeekNumber from './date-utils/get_week_number';
+import {getTwelveHourTime} from './hours';
 
 /**
  * @description CONSTRUCTOR: Returns a day object, which is a JS Date, a formatted string version of the date, and some convenience
@@ -26,6 +27,22 @@ export function getDay({date, getEvents = noOp, formatDate = format, toISOString
     get formattedDate() {
       return formatDate(this.date);
     },
+    /**
+     * @return {string}
+     */
+    get twentyFourHourTime() {
+      return this.date.toTimeString().split(' ')[0];
+    },
+    /**
+     * @return {string}
+     */
+    get twelveHourTime() {
+      const date = this.date;
+      const hours = addLeadingZeroIfLessThanTen(getTwelveHourTime(date.getHours()));
+      const minutes = addLeadingZeroIfLessThanTen(date.getMinutes() );
+      const seconds = addLeadingZeroIfLessThanTen(date.getSeconds());
+      return `${hours}:${minutes}:${seconds}`;
+    },
     /**
      * @desc Convenience method
      * @return {number}

src/day.js

@@ -1,4 +1,4 @@
-import format from './format';
+import {formatDate} from './format';
 
 /**
  * @description Given a data set where events can be obtained as date properties off an object, return the set of events
@@ -13,6 +13,6 @@ import format from './format';
  */
 export default function makeEventFinder(data) {
   return function getEvents(date) {
-    return data[format(date)] || [];
+    return data[formatDate(date)] || [];
   };
 }

src/event.js

@@ -1,14 +1,20 @@
+/**
+ * @desc Formats a number with a leading zero if it is below 10
+ * @param number
+ * @return {string}
+ */
+export function addLeadingZeroIfLessThanTen (number) {
+  return number < 10 ? `0${number}` : number;
+}
+
 /**
  * @description Formats a date in International format
  * @export
  * @param {Date} date A JS Date object.
  * @returns {string} A formatted date.
  */
-export default function formatDate(date) {
-  // TODO: Prettify
-  const _date = date.getDate();
-  const day = _date <= 9 ? `0${_date}` : _date;
-  let month = date.getMonth() + 1;
-  month = month <= 9 ? `0${month}` : month;
+export function formatDate(date) {
+  const day = addLeadingZeroIfLessThanTen(date.getDate());
+  const month = addLeadingZeroIfLessThanTen(date.getMonth() + 1);
   return `${day}/${month}/${date.getFullYear()}`;
 }

src/format.js

@@ -1,11 +1,13 @@
+import {addLeadingZeroIfLessThanTen} from './format';
+
 /**
  * @desc Returns 24 time slots, from 12:00 AM - 12:00 PM
  * @returns {[string]} An array of time slots corresponding to 12-hour time.
  */
 export function getTwelveHourTimeSlots() {
   const timeSlots = ['12:00 AM'];
   for(let slot = 1; slot < 24; slot++) {
-    timeSlots.push(`${formatTimeSlot(getTwelveHourTime(slot))}:00 ${getTimePeriod(slot)}`);
+    timeSlots.push(`${addLeadingZeroIfLessThanTen(getTwelveHourTime(slot))}:00 ${getTimePeriod(slot)}`);
   }
   return timeSlots;
 }
@@ -17,7 +19,7 @@ export function getTwelveHourTimeSlots() {
 export function getTwentyFourHourTimeSlots() {
   const timeSlots = [];
   for(let slot=0; slot < 24; slot++) {
-    timeSlots.push(`${formatTimeSlot(slot)}:00`);
+    timeSlots.push(`${addLeadingZeroIfLessThanTen(slot)}:00`);
   }
   return timeSlots;
 }
@@ -41,15 +43,6 @@ export function getTimePeriod(slot) {
   return slot < 12 && slot > 0 ? 'AM' : 'PM';
 }
 
-/**
- * @desc Formats a number with a leading zero, if it is below 10
- * @param {number} slot A number
- * @returns {string} If the number is below 10, it will be padded with a leading 0.
- */
-export function formatTimeSlot(slot) {
-  return slot < 10 ? `0${slot}` : slot;
-}
-
 /**
  * @desc Converts 24 hour time to 12 hour time.
  * @param {string} time A valid 24-hour time value 'hh:mm'.
@@ -59,5 +52,5 @@ export function formatTimeSlot(slot) {
 export function twentyFourToTwelveHourTime(time) {
   const slot = time.substring(0,2) >> 0;
   const timePeriod = getTimePeriod(slot);
-  return `${formatTimeSlot(getTwelveHourTime(slot))}:00 ${timePeriod}`;
+  return `${addLeadingZeroIfLessThanTen(getTwelveHourTime(slot))}:00 ${timePeriod}`;
 }

src/hours.js

@@ -2,4 +2,5 @@ import './test/day.test';
 import './test/week.test';
 import './test/month.test';
 import './test/integration.test';
-import './test/hour.test';
+import './test/hour.test';
+import './test/format.test';

test.js

@@ -1,7 +1,7 @@
 import test from 'tape';
 import {getDay, getNDays} from '../src/day';
 
-const TEST_DAY = '12.28.2016';
+const TEST_DAY = '12.28.2016 14:24:05';
 
 test('Calendar Model: Day', nest => {
   nest.test('Returns a Day Object when Asked for a Day Provided a String Date', assert => {
@@ -24,11 +24,31 @@ test('Calendar Model: Day', nest => {
     assert.ok(day.weekOfYear === 52, 'should be 52');
     assert.end();
   });
+  nest.test('Returns a 24-hour time', assert => {
+    const day = getDay({date: TEST_DAY});
+    assert.ok(day.twentyFourHourTime === '14:24:05', 'should be 14:24:05');
+    assert.end();
+  });
+  nest.test('Returns a 12-hour time', assert => {
+    const day = getDay({date: TEST_DAY});
+    assert.ok(day.twelveHourTime === '02:24:05', 'should be 02:24:05');
+    assert.end();
+  });
   nest.test('Returns a one-based month number', assert => {
     const day = getDay({date: TEST_DAY});
     assert.ok(day.month === 12, 'should be 12');
     assert.end();
   });
+  nest.test('Returns a formatted date', assert => {
+    const day = getDay({date: TEST_DAY});
+    assert.ok(day.formattedDate === '28/12/2016', 'should be 28/12/2016');
+    assert.end();
+  });
+  nest.test('Returns an ISO formatted date', assert => {
+    const day = getDay({date: TEST_DAY});
+    assert.ok(day.month === 12, 'should be 12');
+    assert.end();
+  });
   nest.test('Returns a set of days, given a start date and a count', assert => {
     const daySet = getNDays({startDate: TEST_DAY, numOfDays: 4});
     assert.ok(daySet.length === 5, 'should be 5 days');

test/day.test.js

@@ -0,0 +1,9 @@
+import test from 'tape';
+import {addLeadingZeroIfLessThanTen} from '../src/format';
+
+test('Calendar Model: Format', nest => {
+  nest.test('Should format a time value under 10 with a leading zero', assert => {
+    assert.ok(addLeadingZeroIfLessThanTen(9) === '09', 'should have a leading zero');
+    assert.end();
+  });
+});

test/format.test.js

@@ -2,10 +2,6 @@ import test from 'tape';
 import * as hours from '../src/hours';
 
 test('Calendar Model: Hours', nest => {
-  nest.test('Should format a time value under 10 with a leading zero', assert => {
-    assert.ok(hours.formatTimeSlot(9) === '09', 'should have a leading zero');
-    assert.end();
-  });
   nest.test('Should return the correct value for a twelve hour clock', assert => {
     assert.ok(hours.getTwelveHourTime(14) === 2, 'should be 2');
     assert.end();

test/hour.test.js

@@ -5,11 +5,10 @@ import makeEventFinder from '../src/event';
 const TEST_DATE = '03/01/2017';
 
 test('Calendar Model: Events', nest => {
-    nest.test('Returns a set of days with populated events', assert => {
-        const getEvents = makeEventFinder({ '01/03/2017': ['one', 'two', 'three'] });
-        const week = getNWeeks({ startDate: TEST_DATE, getEvents, numOfWeeks: 0 });
-        assert.comment('events: ' + week[3].events);
-        assert.ok(week[3].events, 'should not be empty');
-        assert.end();
-    });
+  nest.test('Returns a set of days with populated events', assert => {
+    const getEvents = makeEventFinder({'01/03/2017': ['one', 'two', 'three']});
+    const week = getNWeeks({startDate: TEST_DATE, getEvents, numOfWeeks: 0});
+    assert.ok(week[3].events, 'should not be empty');
+    assert.end();
+  });
 });