Add comments to bubble, list and parser

Author: sbstjn

src/bubble.js

@@ -1,21 +1,27 @@
+// A bubble represents the colorized area with a start date, end date and a
+// label. Tags will be added as HTML classes for custom colors.
 export default class Bubble {
-  constructor(start, end, label) {
+  constructor(start, end, label, tags) {
     this.label = label;
+    this.tags = tags || [];
 
     this.date = {
       start: Date.parse(start),
       end: Date.parse(end)
     };
   }
 
+  // Label returns the Bubble's label text
   Label() {
     return this.label;
   }
 
+  // Start returns the Bubble's start date object
   Start() {
     return this.date.start;
   }
 
+  // End returns the Bubble's end date object
   End() {
     return this.date.end;
   }

src/list.js

@@ -1,4 +1,8 @@
+// List is a basic wrapper for Array access
 export default class List {
+
+  // When initializing a new List item you can pass a custom function to sort
+  // the items stored in the List
   constructor(sort) {
     this.storage = [];
     this.position = 0;
@@ -13,12 +17,18 @@ export default class List {
     this.storage.sort(this.sorter)
   }
 
+  // Next increase the position pointer and return the current element
   Next() {
     this.position++;
 
+    if (this.position > this.storage.length) {
+      return null;
+    }
+
     return this.storage[this.position-1];
   }
 
+  // Add can receive one or multiple parameters which are added to the List
   Add() {
     for (var i = 0, m = arguments.length; i < m; i++) {
       this.storage.push(arguments[i])
@@ -27,22 +37,27 @@ export default class List {
     this.sort();
   }
 
+  // Walk is an alias for forEach
   Walk(func) {
     return this.storage.forEach(func);
   }
 
+  // First returns the first item of the List
   First() {
     return this.storage[0]
   }
 
+  // Last returns the last item of the List
   Last() {
     return this.storage[this.Size()-1]
   }
 
+  // Get returns all items in the List
   Get() {
     return this.storage;
   }
 
+  // Size returns the length of the List
   Size() {
     return this.storage.length;
   }

src/parser.js

@@ -1,38 +1,53 @@
 import Bubble from './bubble.js'
 import List from './list.js'
 
-export default class Parser {
-  constructor() {
+// CLASS_MAIN identifies the main timesheet container
+const CLASS_MAIN = 'timesheet';
 
-  }
+// CLASS_ITEM stores the HTML class name which indicates an item for timesheet
+const CLASS_ITEM = 'timesheet-item';
 
-  parse(html) {
-    var list = new List((a, b) {
+// CLASS_ITEM_DATE_START identifies the start date of an item
+const CLASS_ITEM_DATE_START = 'timesheet-item--date-start';
+
+// CLASS_ITEM_DATE_END identifies the end date of an item
+const CLASS_ITEM_DATE_END = 'timesheet-item--date-end';
+
+// CLASS_ITEM_LABEL identifies the label of an item
+const CLASS_ITEM_LABEL = 'timesheet-item--label';
+
+// Parser is used to parse the HTML DOM into timesheet data
+export default class Parser {
+  constructor() {
+    this.list = new List((a, b) {
       return a.Start() < b.Start() ? -1 : 1
     });
+  }
 
-    if (!html.classList.contains('timesheet')) {
-      return list;
-    }
-
-    var items = html.querySelectorAll('.timesheet-item');
-    if (items.length === 0) {
-      return list;
+  parse(html) {
+    // Return an empty List if the passed element does not have the needed
+    // timesheet class.
+    if (!html.classList.contains(CLASS_MAIN)) {
+      return this.list;
     }
 
-
+    // Get all items with timesheet-item class from the list
+    var items = html.querySelectorAll('.' + CLASS_ITEM);
     for (var i = 0, m = items.length; i < m; i++) {
       var item = items[i];
 
-      var dateStart = item.querySelector('.timesheet-item--date-start')
-        , dateEnd = item.querySelector('.timesheet-item--date-end')
-        , label = item.querySelector('.timesheet-item--label');
+      // Get needed elements from timsheet item
+      var dateStart = item.querySelector('.' + CLASS_ITEM_DATE_START)
+        , dateEnd = item.querySelector('.' + CLASS_ITEM_DATE_END)
+        , label = item.querySelector('.' + CLASS_ITEM_LABEL);
 
+      // Skip the item if not all needed elements are found
       if (dateStart === null || dateEnd === null || label === null) {
         continue;
       }
 
-      list.Add(new Bubble(
+      // Add the parsed Bubble to the List
+      this.list.Add(new Bubble(
         dateStart ? dateStart.innerHTML : null,
         dateEnd ? dateEnd.innerHTML : null,
         label ? label.innerHTML : null