Code commented, cleaned and tests passed for 4.0

serversideup · Dec 11, 2018 · e481184 · e481184
1 parent c2adb10
commit e481184
Show file tree

Hide file tree

Showing 171 changed files with 10,942 additions and 7,131 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,4 @@
 dist/
 docs/
 examples/
+coverage/
diff --git a/coverage/clover.xml b/coverage/clover.xml
diff --git a/coverage/coverage-final.json b/coverage/coverage-final.json
diff --git a/coverage/lcov-report/dist/visualizations/bar.js.html b/coverage/lcov-report/dist/visualizations/bar.js.html
@@ -562,7 +562,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Dec 10 2018 08:32:52 GMT-0800 (PST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Dec 11 2018 08:07:57 GMT-0800 (PST)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/dist/visualizations/index.html b/coverage/lcov-report/dist/visualizations/index.html
@@ -90,7 +90,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Dec 10 2018 08:32:52 GMT-0800 (PST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Dec 11 2018 08:07:57 GMT-0800 (PST)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/dist/visualizations/michaelbromley.js.html b/coverage/lcov-report/dist/visualizations/michaelbromley.js.html
@@ -2251,7 +2251,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Dec 10 2018 08:32:52 GMT-0800 (PST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Dec 11 2018 08:07:57 GMT-0800 (PST)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/index.html b/coverage/lcov-report/index.html
@@ -20,24 +20,24 @@ <h1>
     </h1>
     <div class='clearfix'>
       <div class='fl pad1y space-right2'>
-        <span class="strong">50.43% </span>
+        <span class="strong">50.04% </span>
         <span class="quiet">Statements</span>
-        <span class='fraction'>1237/2453</span>
+        <span class='fraction'>1243/2484</span>
       </div>
       <div class='fl pad1y space-right2'>
-        <span class="strong">38.22% </span>
+        <span class="strong">37.59% </span>
         <span class="quiet">Branches</span>
-        <span class='fraction'>464/1214</span>
+        <span class='fraction'>468/1245</span>
       </div>
       <div class='fl pad1y space-right2'>
-        <span class="strong">57.81% </span>
+        <span class="strong">57.74% </span>
         <span class="quiet">Functions</span>
-        <span class='fraction'>259/448</span>
+        <span class='fraction'>261/452</span>
       </div>
       <div class='fl pad1y space-right2'>
-        <span class="strong">50.55% </span>
+        <span class="strong">50.2% </span>
         <span class="quiet">Lines</span>
-        <span class='fraction'>1235/2443</span>
+        <span class='fraction'>1243/2476</span>
       </div>
     </div>
   </div>
@@ -73,15 +73,15 @@ <h1>
 
 <tr>
 	<td class="file medium" data-value="src"><a href="src/index.html">src</a></td>
-	<td data-value="68.31" class="pic medium"><div class="chart"><div class="cover-fill" style="width: 68%;"></div><div class="cover-empty" style="width:32%;"></div></div></td>
-	<td data-value="68.31" class="pct medium">68.31%</td>
-	<td data-value="183" class="abs medium">125/183</td>
-	<td data-value="52" class="pct medium">52%</td>
-	<td data-value="100" class="abs medium">52/100</td>
+	<td data-value="67.91" class="pic medium"><div class="chart"><div class="cover-fill" style="width: 67%;"></div><div class="cover-empty" style="width:33%;"></div></div></td>
+	<td data-value="67.91" class="pct medium">67.91%</td>
+	<td data-value="187" class="abs medium">127/187</td>
+	<td data-value="51.92" class="pct medium">51.92%</td>
+	<td data-value="104" class="abs medium">54/104</td>
 	<td data-value="75.86" class="pct medium">75.86%</td>
 	<td data-value="58" class="abs medium">44/58</td>
-	<td data-value="68.31" class="pct medium">68.31%</td>
-	<td data-value="183" class="abs medium">125/183</td>
+	<td data-value="67.91" class="pct medium">67.91%</td>
+	<td data-value="187" class="abs medium">127/187</td>
 	</tr>
 
 <tr>
@@ -125,41 +125,41 @@ <h1>
 
 <tr>
 	<td class="file medium" data-value="src/init"><a href="src/init/index.html">src/init</a></td>
-	<td data-value="71.77" class="pic medium"><div class="chart"><div class="cover-fill" style="width: 71%;"></div><div class="cover-empty" style="width:29%;"></div></div></td>
-	<td data-value="71.77" class="pct medium">71.77%</td>
-	<td data-value="124" class="abs medium">89/124</td>
-	<td data-value="40.91" class="pct low">40.91%</td>
-	<td data-value="88" class="abs low">36/88</td>
-	<td data-value="93.33" class="pct high">93.33%</td>
-	<td data-value="15" class="abs high">14/15</td>
-	<td data-value="71.77" class="pct medium">71.77%</td>
-	<td data-value="124" class="abs medium">89/124</td>
+	<td data-value="74.4" class="pic medium"><div class="chart"><div class="cover-fill" style="width: 74%;"></div><div class="cover-empty" style="width:26%;"></div></div></td>
+	<td data-value="74.4" class="pct medium">74.4%</td>
+	<td data-value="125" class="abs medium">93/125</td>
+	<td data-value="41.3" class="pct low">41.3%</td>
+	<td data-value="92" class="abs low">38/92</td>
+	<td data-value="93.75" class="pct high">93.75%</td>
+	<td data-value="16" class="abs high">15/16</td>
+	<td data-value="74.4" class="pct medium">74.4%</td>
+	<td data-value="125" class="abs medium">93/125</td>
 	</tr>
 
 <tr>
 	<td class="file low" data-value="src/soundcloud"><a href="src/soundcloud/index.html">src/soundcloud</a></td>
-	<td data-value="10.71" class="pic low"><div class="chart"><div class="cover-fill" style="width: 10%;"></div><div class="cover-empty" style="width:90%;"></div></div></td>
-	<td data-value="10.71" class="pct low">10.71%</td>
-	<td data-value="28" class="abs low">3/28</td>
+	<td data-value="8.93" class="pic low"><div class="chart"><div class="cover-fill" style="width: 8%;"></div><div class="cover-empty" style="width:92%;"></div></div></td>
+	<td data-value="8.93" class="pct low">8.93%</td>
+	<td data-value="56" class="abs low">5/56</td>
 	<td data-value="0" class="pct low">0%</td>
-	<td data-value="8" class="abs low">0/8</td>
-	<td data-value="16.67" class="pct low">16.67%</td>
-	<td data-value="6" class="abs low">1/6</td>
-	<td data-value="10.71" class="pct low">10.71%</td>
-	<td data-value="28" class="abs low">3/28</td>
+	<td data-value="31" class="abs low">0/31</td>
+	<td data-value="22.22" class="pct low">22.22%</td>
+	<td data-value="9" class="abs low">2/9</td>
+	<td data-value="8.93" class="pct low">8.93%</td>
+	<td data-value="56" class="abs low">5/56</td>
 	</tr>
 
 <tr>
 	<td class="file high" data-value="src/utilities"><a href="src/utilities/index.html">src/utilities</a></td>
-	<td data-value="85.27" class="pic high"><div class="chart"><div class="cover-fill" style="width: 85%;"></div><div class="cover-empty" style="width:15%;"></div></div></td>
-	<td data-value="85.27" class="pct high">85.27%</td>
-	<td data-value="319" class="abs high">272/319</td>
+	<td data-value="85.22" class="pic high"><div class="chart"><div class="cover-fill" style="width: 85%;"></div><div class="cover-empty" style="width:15%;"></div></div></td>
+	<td data-value="85.22" class="pct high">85.22%</td>
+	<td data-value="318" class="abs high">271/318</td>
 	<td data-value="76.98" class="pct medium">76.98%</td>
 	<td data-value="139" class="abs medium">107/139</td>
 	<td data-value="66.13" class="pct medium">66.13%</td>
 	<td data-value="62" class="abs medium">41/62</td>
-	<td data-value="85.27" class="pct high">85.27%</td>
-	<td data-value="319" class="abs high">272/319</td>
+	<td data-value="85.22" class="pct high">85.22%</td>
+	<td data-value="318" class="abs high">271/318</td>
 	</tr>
 
 <tr>
@@ -190,15 +190,15 @@ <h1>
 
 <tr>
 	<td class="file high" data-value="tests"><a href="tests/index.html">tests</a></td>
-	<td data-value="96.2" class="pic high"><div class="chart"><div class="cover-fill" style="width: 96%;"></div><div class="cover-empty" style="width:4%;"></div></div></td>
-	<td data-value="96.2" class="pct high">96.2%</td>
-	<td data-value="79" class="abs high">76/79</td>
+	<td data-value="96.15" class="pic high"><div class="chart"><div class="cover-fill" style="width: 96%;"></div><div class="cover-empty" style="width:4%;"></div></div></td>
+	<td data-value="96.15" class="pct high">96.15%</td>
+	<td data-value="78" class="abs high">75/78</td>
 	<td data-value="100" class="pct high">100%</td>
 	<td data-value="0" class="abs high">0/0</td>
 	<td data-value="60" class="pct medium">60%</td>
 	<td data-value="10" class="abs medium">6/10</td>
-	<td data-value="96.1" class="pct high">96.1%</td>
-	<td data-value="77" class="abs high">74/77</td>
+	<td data-value="96.15" class="pct high">96.15%</td>
+	<td data-value="78" class="abs high">75/78</td>
 	</tr>
 
 </tbody>
@@ -207,7 +207,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Dec 10 2018 08:32:52 GMT-0800 (PST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Dec 11 2018 08:07:57 GMT-0800 (PST)
 </div>
 </div>
 <script src="prettify.js"></script>

diff --git a/coverage/lcov-report/src/config.js.html b/coverage/lcov-report/src/config.js.html
@@ -186,8 +186,7 @@ <h1>
 141
 142
 143
-144
-145</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+144</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -238,9 +237,8 @@ <h1>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">31x</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">31x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -348,7 +346,6 @@ <h1>
  * @property {string} 	config.active_album							- Holds the active album name. Used to check and see if the album changed and run the album changed callback.
  * @property {number} 	config.active_index							- Contains the index of the actively playing song.
  * @property {string} 	config.active_playlist					- Contains the key to the active playlist index.
- * @property {boolean}	config.autoplay									- Set to true to autoplay the song
  * @property {number} 	config.playback_speed						- Sets the initial playback speed of the song. The values for this can be 1.0, 1.5, 2.0
  * @property {object} 	config.callbacks								- The user can pass a JSON object with a key =&gt; value store of callbacks to be run at certain events.
  * @property {array} 		config.songs										- Contains all of the songs the user has passed to Amplitude to use.
@@ -382,8 +379,10 @@ <h1>
  * @property {object} 	config.analyser 								- Web Audio API Analyser
  * @property {string}		config.player_state 						- The current state of the player.
  */
+import { version } from "../package.json";
+&nbsp;
 module.exports = {
-  version: "3.3.1",
+  version: version,
 &nbsp;
   audio: new Audio(),
 &nbsp;
@@ -394,8 +393,6 @@ <h1>
   active_index: 0,
 &nbsp;
   active_playlist: null,
-&nbsp;
-  autoplay: false,
 &nbsp;
   playback_speed: 1.0,
 &nbsp;
@@ -481,7 +478,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Dec 10 2018 08:32:52 GMT-0800 (PST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Dec 11 2018 08:07:57 GMT-0800 (PST)
 </div>
 </div>
 <script src="../prettify.js"></script>

diff --git a/coverage/lcov-report/src/core/core.js.html b/coverage/lcov-report/src/core/core.js.html
@@ -330,7 +330,52 @@ <h1>
 285
 286
 287
-288</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -538,7 +583,6 @@ <h1>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -623,10 +667,28 @@ <h1>
  */
 import config from "../config.js";
 &nbsp;
+/**
+ * Imports the Checks module.
+ * @module utilities/checks
+ */
 import Checks from "../utilities/checks.js";
+&nbsp;
+/**
+ * Imports the Audio Navigation module.
+ * @module utilities/audioNavigation
+ */
 import AudioNavigation from "../utilities/audioNavigation.js";
 &nbsp;
+/**
+ * Imports the Play/Pause Visual Elements module.
+ * @module visual/playPauseElements
+ */
 import PlayPauseElements from "../visual/playPauseElements.js";
+&nbsp;
+/**
+ * Imports the Meta Data Visual Elements module.
+ * @module visual/metaDataElements
+ */
 import MetaDataElements from "../visual/metaDataElements.js";
 &nbsp;
 /**
@@ -641,7 +703,12 @@ <h1>
  */
 import Debug from "../utilities/debug.js";
 &nbsp;
+/**
+ * Import the Visualizations from the FX module.
+ * @module fx/visualizations
+ */
 import Visualizations from "../fx/visualizations.js";
+&nbsp;
 /**
  * Interacts directly with native functions of the Audio element. Logic
  * leading up to these methods are handled by click handlers which call
@@ -807,8 +874,7 @@ <h1>
 			song to the percentage the user passed in.
 		*/
     <span class="missing-if-branch" title="else path not taken" >E</span>if (!config.active_metadata.live) {
-      config.audio.currentTime =
-        config.audio.duration * (songPercentage / 100);
+      config.audio.currentTime = config.audio.duration * (songPercentage / 100);
     }
   }
 &nbsp;
@@ -910,7 +976,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Dec 10 2018 08:32:52 GMT-0800 (PST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Dec 11 2018 08:07:57 GMT-0800 (PST)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/core/index.html b/coverage/lcov-report/src/core/index.html
@@ -77,7 +77,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Dec 10 2018 08:32:52 GMT-0800 (PST)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Dec 11 2018 08:07:57 GMT-0800 (PST)
 </div>
 </div>
 <script src="../../prettify.js"></script>