doc update

rokucommunity · Apr 27, 2019 · e9d7a40 · e9d7a40
1 parent 67527eb
commit e9d7a40
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 22 deletions.
diff --git a/docs/Rooibos.brs.html b/docs/Rooibos.brs.html
@@ -55,20 +55,24 @@ <h1 class="page-title">Rooibos.brs</h1>
 '  *                   Use this to add things like, rodash, common test utils, etc
 '  * @param testsSceneName as string - name of scene to create. All unit tests run in the scene thread
 '  *                   and therefore require a screen and scene are created.
+'  * @param nodeContext as object - this is the global scope of your tests - so where anonymous methods will run from. This should be m
 '  */
-function Rooibos__Init(preTestSetup = invalid,  testUtilsDecoratorMethodName = invalid, testSceneName = "TestsScene") as void
+function Rooibos__Init(preTestSetup = invalid,  testUtilsDecoratorMethodName = invalid, testSceneName = invalid, nodeContext = invalid) as void
   args = {}
   if createObject("roAPPInfo").IsDev() &lt;> true then
     ? " not running in dev mode! - rooibos tests only support sideloaded builds - aborting"
     return
   end if
 
   args.testUtilsDecoratorMethodName = testUtilsDecoratorMethodName
+  args.nodeContext = nodeContext
 
   screen = CreateObject("roSGScreen")
   m.port = CreateObject("roMessagePort")
   screen.setMessagePort(m.port)
-
+  if testSceneName = invalid
+    testSceneName = "TestsScene"
+  end if
   ? "Starting test using test scene with name TestsScene" ; testSceneName
   scene = screen.CreateScene(testSceneName)
   scene.id = "ROOT"
@@ -122,7 +126,7 @@ <h1 class="page-title">Rooibos.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Rooibos_BaseTestSuite.brs.html b/docs/Rooibos_BaseTestSuite.brs.html
@@ -2003,7 +2003,7 @@ <h1 class="page-title">Rooibos_BaseTestSuite.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Rooibos_CommonUtils.brs.html b/docs/Rooibos_CommonUtils.brs.html
@@ -598,7 +598,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Rooibos_ItemGenerator.brs.html b/docs/Rooibos_ItemGenerator.brs.html
@@ -273,7 +273,7 @@ <h1 class="page-title">Rooibos_ItemGenerator.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Rooibos_TestRunner.brs.html b/docs/Rooibos_TestRunner.brs.html
@@ -55,6 +55,7 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
 function RBS_TR_TestRunner(args = {}) as object
   this = {}
   this.testScene = args.testScene
+  this.nodeContext = args.nodeContext
   fs = CreateObject("roFileSystem")
   defaultConfig = {
     logLevel : 1,
@@ -183,7 +184,7 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
       if (metaTestSuite.hasIgnoredTests)
         totalStatObj.IgnoredTestNames.push("|-" + metaTestSuite.name)
       end if
-      RBS_RT_RunItGroups(metaTestSuite, totalStatObj, m.testUtilsDecoratorMethodName, m.config, m.runtimeConfig)
+      RBS_RT_RunItGroups(metaTestSuite, totalStatObj, m.testUtilsDecoratorMethodName, m.config, m.runtimeConfig, m.nodeContext)
     end if
     skipSuite:
   end for
@@ -301,17 +302,18 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
 
     if (metaTestCase.isParamsValid)
       if (metaTestCase.isParamTest)
-        testCaseParams = metaTestCase.rawParams
-        for paramIndex = 0 to testCaseParams.count()
-          paramValue = testCaseParams[paramIndex]
-          if type(paramValue) = "roString" and len(paramValue) > 8 and left(paramValue, 8 ) = "#RBSNode"
+        testCaseParams = []
+        for paramIndex = 0 to metaTestCase.rawParams.count()
+          paramValue = metaTestCase.rawParams[paramIndex]
+          if type(paramValue) = "roString" and len(paramValue) >= 8 and left(paramValue, 8) = "#RBSNode"
             nodeType = "ContentNode"
-            paramDirectiveArgs = split(paramValue, "|")
-            if paramDirectiveArgs.count() > 0
+            paramDirectiveArgs = paramValue.split("|")
+            if paramDirectiveArgs.count() > 1
               nodeType = paramDirectiveArgs[1]
             end if
-            testCaseParams[paramIndex] = createObject("roSGnode", paramDirectiveArgs)
+            paramValue = createObject("roSGNode", nodeType)
           end if
+          testCaseParams.push(paramValue)
         end for
         'up to 6 param args supported for now
         if (metaTestCase.expectedNumberOfParams = 1)
@@ -426,7 +428,7 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -57,7 +57,7 @@
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-BaseTestSuite.html b/docs/module-BaseTestSuite.html
@@ -12420,7 +12420,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-CommonUtils.html b/docs/module-CommonUtils.html
@@ -5062,7 +5062,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-ItemGenerator.html b/docs/module-ItemGenerator.html
@@ -1442,7 +1442,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-TestRunner.html b/docs/module-TestRunner.html
@@ -651,7 +651,7 @@ <h4 class="name" id="Run"><span class="type-signature"></span>Run<span class="si
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-rooibosh.html b/docs/module-rooibosh.html
@@ -75,7 +75,7 @@ <h3 class="subsection-title">Methods</h3>
 
 
 
-    <h4 class="name" id=".Rooibos__Init"><span class="type-signature">(static) </span>Rooibos__Init<span class="signature">(preTestSetup, testUtilsDecorator, testsSceneName)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".Rooibos__Init"><span class="type-signature">(static) </span>Rooibos__Init<span class="signature">(preTestSetup, testUtilsDecorator, testsSceneName, nodeContext)</span><span class="type-signature"></span></h4>
 
 
 
@@ -236,6 +236,27 @@ <h5>Parameters:</h5>
         </tr>
 
 
+
+        <tr>
+
+                <td class="name"><code>nodeContext</code></td>
+
+
+            <td class="type">
+
+            </td>
+
+
+
+
+
+            <td class="description last">
+                <p>as object - this is the global scope of your tests - so where anonymous methods will run from. This should be m</p>
+
+            </td>
+        </tr>
+
+
     </tbody>
 </table>
 
@@ -273,7 +294,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 13:36:16 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 26 2019 22:57:27 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>