fix incorrect docs on stub method

rokucommunity · Mar 21, 2019 · 18581b8 · 18581b8
1 parent 498ca5c
commit 18581b8
Show file tree

Hide file tree

Showing 12 changed files with 196 additions and 194 deletions.
diff --git a/docs/Rooibos.brs.html b/docs/Rooibos.brs.html
@@ -75,7 +75,8 @@ <h1 class="page-title">Rooibos.brs</h1>
   screen.show()
 
   m.global = screen.getGlobalNode()
-
+  m.global.addFields({"testsScene": scene})
+
   if (preTestSetup &lt;> invalid)
     preTestSetup(screen)
   end if
@@ -121,7 +122,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 Mon Feb 04 2019 15:06:15 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 15:09:23 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
diff --git a/docs/Rooibos_CommonUtils.brs.html b/docs/Rooibos_CommonUtils.brs.html
@@ -54,7 +54,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains XMLElement interface, else return false
 '  */
-function RBS_CMN_IsXmlElement(value as dynamic) as boolean
+function RBS_CMN_IsXmlElement(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifXMLElement") &lt;> invalid
 end function
 
@@ -66,7 +66,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains Function interface, else return false
 '  */
-function RBS_CMN_IsFunction(value as dynamic) as boolean
+function RBS_CMN_IsFunction(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifFunction") &lt;> invalid
 end function
 
@@ -140,7 +140,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains Boolean interface, else return false
 '  */
-function RBS_CMN_IsBoolean(value as dynamic) as boolean
+function RBS_CMN_IsBoolean(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifBoolean") &lt;> invalid
 end function
 
@@ -152,7 +152,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value type equals Integer, else return false
 '  */
-function RBS_CMN_IsInteger(value as dynamic) as boolean
+function RBS_CMN_IsInteger(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifInt") &lt;> invalid and (Type(value) = "roInt" or Type(value) = "roInteger" or Type(value) = "Integer")
 end function
 
@@ -164,7 +164,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains Float interface, else return false
 '  */
-function RBS_CMN_IsFloat(value as dynamic) as boolean
+function RBS_CMN_IsFloat(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifFloat") &lt;> invalid
 end function
 
@@ -176,7 +176,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains Double interface, else return false
 '  */
-function RBS_CMN_IsDouble(value as dynamic) as boolean
+function RBS_CMN_IsDouble(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifDouble") &lt;> invalid
 end function
 
@@ -188,7 +188,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains LongInteger interface, else return false
 '  */
-function RBS_CMN_IsLongInteger(value as dynamic) as boolean
+function RBS_CMN_IsLongInteger(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifLongInt") &lt;> invalid
 end function
 
@@ -200,7 +200,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value is number, else return false
 '  */
-function RBS_CMN_IsNumber(value as dynamic) as boolean
+function RBS_CMN_IsNumber(value ) as boolean
   return RBS_CMN_IsLongInteger(value) or RBS_CMN_IsDouble(value) or RBS_CMN_IsInteger(value) or RBS_CMN_IsFloat(value)
 end function
 
@@ -212,7 +212,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains List interface, else return false
 '  */
-function RBS_CMN_IsList(value as dynamic) as boolean
+function RBS_CMN_IsList(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifList") &lt;> invalid
 end function
 
@@ -224,7 +224,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains Array interface, else return false
 '  */
-function RBS_CMN_IsArray(value as dynamic) as boolean
+function RBS_CMN_IsArray(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifArray") &lt;> invalid
 end function
 
@@ -236,7 +236,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains AssociativeArray interface, else return false
 '  */
-function RBS_CMN_IsAssociativeArray(value as dynamic) as boolean
+function RBS_CMN_IsAssociativeArray(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifAssociativeArray") &lt;> invalid
 end function
 
@@ -248,7 +248,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains SGNodeChildren interface, else return false
 '  */
-function RBS_CMN_IsSGNode(value as dynamic) as boolean
+function RBS_CMN_IsSGNode(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifSGNodeChildren") &lt;> invalid
 end function
 
@@ -260,7 +260,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains String interface, else return false
 '  */
-function RBS_CMN_IsString(value as dynamic) as boolean
+function RBS_CMN_IsString(value ) as boolean
   return RBS_CMN_IsValid(value) and GetInterface(value, "ifString") &lt;> invalid
 end function
 
@@ -272,7 +272,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains String interface and length more 0, else return false
 '  */
-function RBS_CMN_IsNotEmptyString(value as dynamic) as boolean
+function RBS_CMN_IsNotEmptyString(value ) as boolean
   return RBS_CMN_IsString(value) and len(value) > 0
 end function
 
@@ -284,7 +284,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value contains DateTime interface, else return false
 '  */
-function RBS_CMN_IsDateTime(value as dynamic) as boolean
+function RBS_CMN_IsDateTime(value ) as boolean
   return RBS_CMN_IsValid(value) and (GetInterface(value, "ifDateTime") &lt;> invalid or Type(value) = "roDateTime")
 end function
 
@@ -296,11 +296,11 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value initialized and not equal invalid, else return false
 '  */
-function RBS_CMN_IsValid(value as dynamic) as boolean
+function RBS_CMN_IsValid(value ) as boolean
   return not RBS_CMN_IsUndefined(value) and value &lt;> invalid
 end function
 
-function RBS_CMN_IsUndefined(value as dynamic) as boolean
+function RBS_CMN_IsUndefined(value ) as boolean
   return type(value) = "" or Type(value) = "&lt;uninitialized>"
 end function
 
@@ -312,7 +312,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {String} - value if his contains String interface else return empty string
 '  */
-function RBS_CMN_ValidStr(obj as object) as string
+function RBS_CMN_ValidStr(obj ) as string
   if obj &lt;> invalid and GetInterface(obj, "ifString") &lt;> invalid
     return obj
   else
@@ -328,7 +328,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} input - value to check
 '  * @returns {String} - converted string
 '  */
-function RBS_CMN_AsString(input as dynamic) as string
+function RBS_CMN_AsString(input ) as string
   if RBS_CMN_IsValid(input) = false
     return ""
   else if RBS_CMN_IsString(input)
@@ -364,7 +364,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} input - value to check
 '  * @returns {Integer} - converted Integer
 '  */
-function RBS_CMN_AsInteger(input as dynamic) as integer
+function RBS_CMN_AsInteger(input ) as integer
   if RBS_CMN_IsValid(input) = false
     return 0
   else if RBS_CMN_IsString(input)
@@ -386,7 +386,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} input - value to check
 '  * @returns {Integer} - converted LongInteger
 '  */
-function RBS_CMN_AsLongInteger(input as dynamic) as longinteger
+function RBS_CMN_AsLongInteger(input ) as longinteger
   if RBS_CMN_IsValid(input) = false
     return 0
   else if RBS_CMN_IsString(input)
@@ -406,7 +406,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} input - value to check
 '  * @returns {Float} - converted Float
 '  */
-function RBS_CMN_AsFloat(input as dynamic) as float
+function RBS_CMN_AsFloat(input ) as float
   if RBS_CMN_IsValid(input) = false
     return 0.0
   else if RBS_CMN_IsString(input)
@@ -428,7 +428,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} input - value to check
 '  * @returns {Float} - converted Double
 '  */
-function RBS_CMN_AsDouble(input as dynamic) as double
+function RBS_CMN_AsDouble(input ) as double
   if RBS_CMN_IsValid(input) = false
     return 0.0
   else if RBS_CMN_IsString(input)
@@ -448,7 +448,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} input - value to check
 '  * @returns {Boolean} - converted boolean
 '  */
-function RBS_CMN_AsBoolean(input as dynamic) as boolean
+function RBS_CMN_AsBoolean(input ) as boolean
   if RBS_CMN_IsValid(input) = false
     return false
   else if RBS_CMN_IsString(input)
@@ -470,7 +470,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Array} - converted array
 '  */
-function RBS_CMN_AsArray(value as object) as object
+function RBS_CMN_AsArray(value ) as object
   if RBS_CMN_IsValid(value)
     if not RBS_CMN_IsArray(value)
       return [value]
@@ -493,7 +493,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - value to check
 '  * @returns {Boolean} - true if value is null or empty string, else return false
 '  */
-function RBS_CMN_IsNullOrEmpty(value as dynamic) as boolean
+function RBS_CMN_IsNullOrEmpty(value ) as boolean
   if RBS_CMN_IsString(value)
     return Len(value) = 0
   else
@@ -516,7 +516,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Boolean} caseSensitive - indicates if comparisons are case sensitive
 '  * @returns {Integer} - element index if array contains a value, else return -1
 '  */
-function RBS_CMN_FindElementIndexInArray(array as object, value as object, compareAttribute = invalid as dynamic, caseSensitive = false as boolean) as integer
+function RBS_CMN_FindElementIndexInArray(array , value , compareAttribute = invalid , caseSensitive = false ) as integer
   if RBS_CMN_IsArray(array)
     for i = 0 to RBS_CMN_AsArray(array).Count() - 1
       compareValue = array[i]
@@ -525,11 +525,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
         compareValue = compareValue.LookupCI(compareAttribute)
       end if
 
-      if RBS_CMN_IsString(compareValue) and RBS_CMN_IsString(value) and not caseSensitive
-        if LCase(compareValue) = LCase(value)
-          return i
-        end if
-      else if compareValue = value
+      if RBS_BTS_EqValues(compareValue, value)
         return i
       end if
 
@@ -549,7 +545,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} compareAttribute - attribute to compare on
 '  * @returns {Boolean} - true if array contains a value, else return false
 '  */
-function RBS_CMN_ArrayContains(array as object, value as object, compareAttribute = invalid as dynamic) as boolean
+function RBS_CMN_ArrayContains(array , value , compareAttribute = invalid ) as boolean
   return (RBS_CMN_FindElementIndexInArray(array, value, compareAttribute) > -1)
 end function
 
@@ -567,7 +563,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - child to search for
 '  * @returns {Integer} - element index if node contains a value, else return -1
 '  */
-function RBS_CMN_FindElementIndexInNode(node as object, value as object) as integer
+function RBS_CMN_FindElementIndexInNode(node , value ) as integer
   if type(node) = "roSGNode"
     for i = 0 to node.getChildCount() - 1
       compareValue = node.getChild(i)
@@ -587,7 +583,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 '  * @param {Dynamic} value - child to look for
 '  * @returns {Boolean} - true if node contains a value, else return false
 '  */
-function RBS_CMN_NodeContains(node as object, value as object) as boolean
+function RBS_CMN_NodeContains(node , value ) as boolean
   return (RBS_CMN_FindElementIndexInNode(node, value) > -1)
 end function
 </code></pre>
@@ -602,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 Mon Feb 04 2019 15:06:15 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 15:09:23 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 Mon Feb 04 2019 15:06:15 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 15:09:23 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
@@ -207,7 +207,7 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
       testSuite.global = nodeContext.global
       testSuite.top = nodeContext.top
     end if
-    
+
     if (RBS_CMN_IsFunction(testUtilsDecorator))
       testUtilsDecorator(testSuite)
     end if
@@ -240,7 +240,7 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
     end if
 
     if (runtimeConfig.hasSoloTests)
-      if (not itGroup.hasSoloTests)
+      if (itGroup.hasSoloTests &lt;> true)
         if (config.logLevel = 2)
           ? "Ignoring itGroup " ; itGroup.name ; " Because it has no solo tests"
         end if
@@ -299,9 +299,9 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
 
     testStatObj.metaTestCase.testResult = testSuite.currentResult
 
-    if (metaTestCase.isParamTest)
-      testCaseParams = metaTestCase.rawParams
-      if (metaTestCase.isParamsValid)
+    if (metaTestCase.isParamsValid)
+      if (metaTestCase.isParamTest)
+        testCaseParams = metaTestCase.rawParams
         'up to 6 param args supported for now
         if (metaTestCase.expectedNumberOfParams = 1)
           testSuite.testCase(testCaseParams[0])
@@ -317,10 +317,10 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
           testSuite.testCase(testCaseParams[0], testCaseParams[1], testCaseParams[2], testCaseParams[3], testCaseParams[4], testCaseParams[5])
         end if
       else
-        testSuite.Fail("Could not parse args for test ")
+        testSuite.testCase()
       end if
     else
-      testSuite.testCase()
+      testSuite.Fail("Could not parse args for test ")
     end if
     if testSuite.isAutoAssertingMocks = true
       testSuite.AssertMocks()
@@ -415,7 +415,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 Mon Feb 04 2019 15:06:15 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 15:09:23 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 Mon Feb 04 2019 15:06:15 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 15:09:23 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>