bare-script 3.2.2 → 3.3.0

package/lib/include/pager.mds

@@ -1,235 +1,12 @@
 # Licensed under the MIT License
 # https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
 
-include <args.mds>
-
 
 # Include sentinel
 if systemGlobalGet('pagerSentinel'):
     return
 endif
-pagerSentinel = true
-
-
-# The pager model
-pagerTypes = schemaParse( \
-    'group "Pager"', \
-    '', \
-    '', \
-    '# A pager application model', \
-    'struct Pager', \
-    '', \
-    "    # The application's pages", \
-    '    PagerPage[len > 0] pages', \
-    '', \
-    '', \
-    '# A page model', \
-    'struct PagerPage', \
-    '', \
-    '    # The page name', \
-    '    string name', \
-    '', \
-    '    # If true, the page is hidden', \
-    '    optional bool hidden', \
-    '', \
-    '    # The page type', \
-    '    PagerPageType type', \
-    '', \
-    '', \
-    '# The page type', \
-    'union PagerPageType', \
-    '', \
-    '    # A function page', \
-    '    PagerPageFunction function', \
-    '', \
-    '    # A markdown resource page', \
-    '    PagerPageMarkdown markdown', \
-    '', \
-    '    # A navigation link', \
-    '    PagerPageLink link', \
-    '', \
-    '', \
-    '# A page function', \
-    'struct PagerPageFunction', \
-    '', \
-    '    # The page function', \
-    '    object function', \
-    '', \
-    '    # The page title', \
-    '    optional string title', \
-    '', \
-    '', \
-    '# A Markdown resource page', \
-    'struct PagerPageMarkdown', \
-    '', \
-    '    # The Markdown resource URL', \
-    '    string url', \
-    '', \
-    '', \
-    '# A page link', \
-    'struct PagerPageLink', \
-    '', \
-    '    # The link URL', \
-    '    string url' \
-)
-
-
-# $function: pagerValidate
-# $group: pager.mds
-# $doc: Validate a pager model
-# $arg pagerModel: The [pager model](includeModel.html#var.vName='Pager')
-# $return: The validated [pager model](includeModel.html#var.vName='Pager') or null if validation fails
-function pagerValidate(pagerModel):
-    return schemaValidate(pagerTypes, 'Pager', pagerModel)
-endfunction
-
-
-# $function: pagerMain
-# $group: pager.mds
-# $doc: The pager application main entry point
-# $arg pagerModel: The [pager model](includeModel.html#var.vName='Pager')
-# $arg options: The pager application options. The following options are available:
-# $arg options: - **arguments** - The [arguments model](includeModel.html#var.vName='ArgsArguments').
-# $arg options:   Must contain a string argument named "page".
-# $arg options: - **hideMenu** - Hide the menu links
-# $arg options: - **hideNav** - Hide the navigation links
-# $arg options: - **start** - The start page name
-async function pagerMain(pagerModel, options):
-    if options == null:
-        options = objectNew()
-    endif
-
-    # Validate the pager model
-    pagerModel = pagerValidate(pagerModel)
-    if pagerModel == null:
-        return
-    endif
-
-    # Compute the visible and navigable pages
-    pages = objectGet(pagerModel, 'pages')
-    visiblePages = arrayNew()
-    navPages = arrayNew()
-    for page in pages:
-        # Visible page?
-        if !objectGet(page, 'hidden'):
-            arrayPush(visiblePages, page)
-
-            # Navigable page?
-            pageTypeKey = arrayGet(objectKeys(objectGet(page, 'type')), 0)
-            if pageTypeKey != 'link':
-                arrayPush(navPages, page)
-            endif
-        endif
-    endfor
-
-    # Parse arguments
-    startPageName = objectGet(options, 'start', if(arrayLength(navPages), objectGet(arrayGet(navPages, 0), 'name'), null))
-    if objectHas(options, 'arguments'):
-        arguments = argsValidate(objectGet(options, 'arguments'))
-        if arguments == null:
-            return
-        endif
-    else:
-        arguments = arrayNew(objectNew('name', 'page', 'default', startPageName))
-    endif
-    args = argsParse(arguments)
-
-    # Determine the current page
-    curPage = null
-    startPage = null
-    for page in pages:
-        if objectGet(page, 'name') == objectGet(args, 'page'):
-            curPage = page
-        endif
-        if objectGet(page, 'name') == startPageName:
-            startPage = page
-        endif
-    endfor
-    if startPage == null:
-        systemLogDebug('MarkdownUp - pager.mds: Unknown start page' + if(startPageName != null, '"' + startPageName + '"', ''))
-        return
-    endif
-    if curPage == null:
-        curPage = startPage
-    endif
-
-    # Determine the current page's navigable index, if any
-    ixCurPage = -1
-    for navPage, ixNavPage in navPages:
-        if objectGet(navPage, 'name') == objectGet(curPage, 'name'):
-            ixCurPage = ixNavPage
-            break
-        endif
-    endfor
-
-    # Render the menu
-    if !objectGet(options, 'hideMenu'):
-        for page, ixPage in visiblePages:
-            pageName = objectGet(page, 'name')
-            pageType = objectGet(page, 'type')
-            pageTypeKey = arrayGet(objectKeys(pageType), 0)
-
-            # Render the menu link
-            pageNameNbsp = stringReplace(pageName, ' ', '&nbsp;')
-            separator = if(ixPage != arrayLength(visiblePages) - 1, '&nbsp;|', '')
-            if pageTypeKey == 'link':
-                pageLinkURL = objectGet(objectGet(pageType, 'link'), 'url')
-                markdownPrint('[' + markdownEscape(pageNameNbsp) + '](' + urlEncode(pageLinkURL) + ')' + separator)
-            elif pageName == objectGet(curPage, 'name'):
-                markdownPrint(markdownEscape(pageNameNbsp) + separator)
-            else:
-                markdownPrint(argsLink(arguments, pageNameNbsp, objectNew('page', pageName)) + separator)
-            endif
-        endfor
-        markdownPrint('')
-    endif
-
-    # Render the start/next/prev buttons
-    if !objectGet(options, 'hideNav') && arrayLength(navPages) > 1 && ixCurPage != -1:
-        if startPageName == objectGet(curPage, 'name'):
-            startPageName = null
-        endif
-        prevPageName = if(ixCurPage != -1 && ixCurPage - 1 >= 0, objectGet(arrayGet(navPages, ixCurPage - 1), 'name'), null)
-        nextPageName = if(ixCurPage != -1 && ixCurPage + 1 < arrayLength(navPages), objectGet(arrayGet(navPages, ixCurPage + 1), 'name'), null)
-        markdownPrint( \
-            '(&nbsp;' + if(startPageName != null, argsLink(arguments, 'Start', objectNew('page', startPageName)), 'Start') + '&nbsp;|', \
-            if(prevPageName != null, argsLink(arguments, 'Previous', objectNew('page', prevPageName)), 'Previous') + '&nbsp;|', \
-            if(nextPageName != null, argsLink(arguments, 'Next', objectNew('page', nextPageName)), 'Next') + '&nbsp;)', \
-            '' \
-        )
-    endif
-
-    # Function page?
-    curPageType = objectGet(curPage, 'type')
-    curPageTypeKey = arrayGet(objectKeys(curPageType), 0)
-    if curPageTypeKey == 'function':
-        # Set the title
-        title = objectGet(objectGet(curPageType, 'function'), 'title')
-        if title != null:
-            documentSetTitle(title)
-            markdownPrint('# ' + markdownEscape(title), '')
-        endif
 
-        # Call the page function
-        pageFn = objectGet(objectGet(curPageType, 'function'), 'function')
-        pageFn(args)
-    elif curPageTypeKey == 'markdown':
-        # Fetch the Markdown text
-        url = objectGet(objectGet(curPageType, 'markdown'), 'url')
-        markdownText = systemFetch(url)
-        if markdownText == null:
-            markdownPrint('**Error:** Failed to load "' + url + '"')
-        else:
-            # Compute and set the page title
-            markdownModel = markdownParse(markdownText)
-            title = markdownTitle(markdownModel)
-            if title == null:
-                title = 'No Title'
-            endif
-            documentSetTitle(title)
 
-            # Render the Markdown text
-            markdownPrint('', markdownText)
-        endif
-    endif
-endfunction
+systemLog('MarkdownUp - pager.mds: pager.mds is now pager.bare - please update before 2025-06-01')
+include 'pager.bare'

package/lib/include/unittest.bare

@@ -0,0 +1,229 @@
+# Licensed under the MIT License
+# https://github.com/craigahobbs/markdown-up/blob/main/LICENSE
+
+
+# Include sentinel
+if systemGlobalGet('unittestSentinel'):
+    return
+endif
+unittestSentinel = true
+
+
+include 'diff.bare'
+
+
+# Test statistics
+unittestTests = objectNew()
+unittestWarnings = arrayNew()
+
+
+# $function: unittestRunTest
+# $group: unittest.bare
+# $doc: Run a unit test
+# $arg testName: The test function name
+function unittestRunTest(testName):
+    testFn = unittestRunTestHelper(testName)
+    if testFn:
+        testFn()
+        systemGlobalSet('unittestTestName', null)
+    endif
+endfunction
+
+
+# $function: unittestRunTestAsync
+# $group: unittest.bare
+# $doc: Run an asyncronous unit test
+# $arg testName: The test function name
+async function unittestRunTestAsync(testName):
+    testFn = unittestRunTestHelper(testName)
+    if testFn:
+        testFn()
+        systemGlobalSet('unittestTestName', null)
+    endif
+endfunction
+
+
+# unittestRunTest helper function
+function unittestRunTestHelper(testName):
+    # Single test argument?
+    if vTest != null && vTest != testName:
+        return null
+    endif
+
+    # Test run multiple times?
+    if objectHas(unittestTests, testName):
+        arrayPush(unittestWarnings, 'Test "' + testName + '" run multiple times')
+        return null
+    endif
+
+    # Get the test func
+    testFn = systemGlobalGet(testName)
+    if testFn == null:
+        arrayPush(unittestWarnings, 'Test "' + testName + '" not found')
+        return null
+    endif
+
+    # Add the unit test result array
+    testFailures = arrayNew()
+    objectSet(unittestTests, testName, testFailures)
+    systemGlobalSet('unittestTestName', testName)
+
+    return testFn
+endfunction
+
+
+# $function: unittestReport
+# $group: unittest.bare
+# $doc: Render the unit test report
+# $return: The number of unit test failures
+function unittestReport():
+    # Compute test statistics
+    testNames = arraySort(objectKeys(unittestTests))
+    testCount = arrayLength(testNames)
+    testFailCount = 0
+    for testName in testNames:
+        testFailures = objectGet(unittestTests, testName)
+        if arrayLength(testFailures):
+            testFailCount = testFailCount + 1
+        endif
+    endfor
+    testPassCount = testCount - testFailCount
+
+    # Report statistics
+    markdownPrint('', 'Ran ' + testCount + ' tests - ' + testPassCount + ' passed, ' + testFailCount + ' failed')
+    if vTest != null:
+        testURL = if(vTestArgs != null, '#' + vTestArgs, '#var=')
+        markdownPrint('([all tests](' + testURL + '))')
+    endif
+
+    # Report any warnings
+    testWarningCount = arrayLength(unittestWarnings)
+    if testWarningCount:
+        markdownPrint('', '## Warnings')
+        for warning in unittestWarnings:
+            markdownPrint('', '- ' + markdownEscape(warning))
+        endfor
+    endif
+
+    # Report the failing tests
+    if testFailCount:
+        markdownPrint('', '## Failing Tests')
+        for testName in testNames:
+            testFailures = objectGet(unittestTests, testName)
+            if arrayLength(testFailures):
+                testURL = '#' + if(vTestArgs != null, vTestArgs + '&', '') + "var.vTest='" + urlEncodeComponent(testName) + "'"
+                failureLines = arrayNew('', '[' + markdownEscape(testName) + '](' + testURL + ") - FAIL")
+                for errorLines in testFailures:
+                    for errorLine, ixErrorLine in errorLines:
+                        if ixErrorLine == 0:
+                            arrayPush(failureLines, '')
+                            arrayPush(failureLines, '- ' + errorLine)
+                        else:
+                            arrayPush(failureLines, if(errorLine, '  ' + errorLine, ''))
+                        endif
+                    endfor
+                endfor
+                markdownPrint(failureLines)
+            endif
+        endfor
+    endif
+
+    # Report the passing tests
+    if testPassCount:
+        markdownPrint('', '## Passing Tests')
+        for testName in testNames:
+            testFailures = objectGet(unittestTests, testName)
+            if !arrayLength(testFailures):
+                testURL = '#' + if(vTestArgs != null, vTestArgs + '&', '') + "var.vTest='" + urlEncodeComponent(testName) + "'"
+                markdownPrint('', '[' + markdownEscape(testName) + '](' + testURL + ") - OK")
+            endif
+        endfor
+    endif
+
+    return testWarningCount + testFailCount
+endfunction
+
+
+# $function: unittestEqual
+# $group: unittest.bare
+# $doc: Assert an actual value is equal to the expected value
+# $arg actual: The actual value
+# $arg expected: The expected value
+# $arg description: The description of the assertion
+function unittestEqual(actual, expected, description):
+    if actual == expected:
+        return
+    endif
+
+    # Add the test failure error lines
+    testFailures = objectGet(unittestTests, unittestTestName)
+    errorLines = arrayNew( \
+        'Equal:', \
+        '', \
+        '```', \
+        jsonStringify(actual), \
+        '```', \
+        '', \
+        '```', \
+        jsonStringify(expected), \
+        '```' \
+    )
+    if description != null:
+        arrayPush(testFailures, arrayExtend(arrayNew(markdownEscape(description), errorLines)))
+    else:
+        arrayPush(testFailures, errorLines)
+    endif
+endfunction
+
+
+# $function: unittestDeepEqual
+# $group: unittest.bare
+# $doc: Assert an actual value is *deeply* equal to the expected value
+# $arg actual: The actual value
+# $arg expected: The expected value
+# $arg description: The description of the assertion
+function unittestDeepEqual(actual, expected, description):
+    # Serialize as JSON
+    actualJSON = if(systemType(actual) == 'string', actual, jsonStringify(actual, 4))
+    expectedJSON = if(systemType(expected) == 'string', expected, jsonStringify(expected, 4))
+    if actualJSON == expectedJSON:
+        return
+    endif
+
+    # Compute the difference lines
+    errorLines = arrayNew()
+    diffErrorLines = arrayNew()
+    for diff in diffLines(actualJSON, expectedJSON):
+        diffType = objectGet(diff, 'type')
+        if diffType == 'Remove':
+            for diffLine in objectGet(diff, 'lines'):
+                arrayPush(diffErrorLines, '--- ' + diffLine)
+            endfor
+        elif diffType == 'Add':
+            for diffLine in objectGet(diff, 'lines'):
+                arrayPush(diffErrorLines, '+++ ' + diffLine)
+            endfor
+        else:
+            # diffType == 'Identical'
+            if diffErrorLines:
+                arrayExtend(errorLines, arrayNew('Deep-equal:', '', '```'))
+                arrayExtend(errorLines, diffErrorLines)
+                arrayPush(errorLines, '```')
+                diffErrorLines = arrayNew()
+            endif
+        endif
+    endfor
+    if diffErrorLines:
+        arrayExtend(errorLines, arrayNew('Deep-equal:', '', '```'))
+        arrayExtend(errorLines, diffErrorLines)
+        arrayPush(errorLines, '```')
+    endif
+
+    # Add the test failure error lines
+    testFailures = objectGet(unittestTests, unittestTestName)
+    if description != null:
+        arrayPush(testFailures, arrayExtend(arrayNew(markdownEscape(description), errorLines)))
+    else:
+        arrayPush(testFailures, errorLines)
+    endif
+endfunction

package/lib/include/unittest.mds

@@ -6,186 +6,7 @@
 if systemGlobalGet('unittestSentinel'):
     return
 endif
-unittestSentinel = true
 
 
-# Test statistics
-unittestTests = objectNew()
-unittestWarnings = arrayNew()
-
-
-# $function: unittestRunTest
-# $group: unittest.mds
-# $doc: Run a unit test
-# $arg testName: The test function name
-function unittestRunTest(testName):
-    testFn = unittestRunTestHelper(testName)
-    if testFn:
-        testFn()
-        systemGlobalSet('unittestTestName', null)
-    endif
-endfunction
-
-
-# $function: unittestRunTestAsync
-# $group: unittest.mds
-# $doc: Run an asyncronous unit test
-# $arg testName: The test function name
-async function unittestRunTestAsync(testName):
-    testFn = unittestRunTestHelper(testName)
-    if testFn:
-        testFn()
-        systemGlobalSet('unittestTestName', null)
-    endif
-endfunction
-
-
-# unittestRunTest helper function
-function unittestRunTestHelper(testName):
-    # Single test argument?
-    if vTest != null && vTest != testName:
-        return null
-    endif
-
-    # Test run multiple times?
-    if objectHas(unittestTests, testName):
-        arrayPush(unittestWarnings, 'Test "' + testName + '" run multiple times')
-        return null
-    endif
-
-    # Get the test func
-    testFn = systemGlobalGet(testName)
-    if testFn == null:
-        arrayPush(unittestWarnings, 'Test "' + testName + '" not found')
-        return null
-    endif
-
-    # Add the unit test result array
-    testFailures = arrayNew()
-    objectSet(unittestTests, testName, testFailures)
-    systemGlobalSet('unittestTestName', testName)
-
-    return testFn
-endfunction
-
-
-# $function: unittestReport
-# $group: unittest.mds
-# $doc: Render the unit test report
-# $return: The number of unit test failures
-function unittestReport():
-    # Compute test statistics
-    testNames = arraySort(objectKeys(unittestTests))
-    testCount = arrayLength(testNames)
-    testFailCount = 0
-    for testName in testNames:
-        testFailures = objectGet(unittestTests, testName)
-        if arrayLength(testFailures):
-            testFailCount = testFailCount + 1
-        endif
-    endfor
-    testPassCount = testCount - testFailCount
-
-    # Report statistics
-    markdownPrint('', 'Ran ' + testCount + ' tests - ' + testPassCount + ' passed, ' + testFailCount + ' failed')
-    if vTest != null:
-        testURL = if(vTestArgs != null, '#' + vTestArgs, '#var=')
-        markdownPrint('([all tests](' + testURL + '))')
-    endif
-
-    # Report any warnings
-    testWarningCount = arrayLength(unittestWarnings)
-    if testWarningCount:
-        markdownPrint('', '## Warnings')
-        for warning in unittestWarnings:
-            markdownPrint('', '- ' + markdownEscape(warning))
-        endfor
-    endif
-
-    # Report the failing tests
-    if testFailCount:
-        markdownPrint('', '## Failing Tests')
-        for testName in testNames:
-            testFailures = objectGet(unittestTests, testName)
-            if arrayLength(testFailures):
-                testURL = '#' + if(vTestArgs != null, vTestArgs + '&', '') + "var.vTest='" + urlEncodeComponent(testName) + "'"
-                failureLines = arrayNew('', '[' + markdownEscape(testName) + '](' + testURL + ") - FAIL")
-                for errorLines in testFailures:
-                    for errorLine, ixErrorLine in errorLines:
-                        if ixErrorLine == 0:
-                            arrayPush(failureLines, '')
-                            arrayPush(failureLines, '- ' + errorLine)
-                        else:
-                            arrayPush(failureLines, '  ' + errorLine)
-                        endif
-                    endfor
-                endfor
-                markdownPrint(failureLines)
-            endif
-        endfor
-    endif
-
-    # Report the passing tests
-    if testPassCount:
-        markdownPrint('', '## Passing Tests')
-        for testName in testNames:
-            testFailures = objectGet(unittestTests, testName)
-            if !arrayLength(testFailures):
-                testURL = '#' + if(vTestArgs != null, vTestArgs + '&', '') + "var.vTest='" + urlEncodeComponent(testName) + "'"
-                markdownPrint('', '[' + markdownEscape(testName) + '](' + testURL + ") - OK")
-            endif
-        endfor
-    endif
-
-    return testWarningCount + testFailCount
-endfunction
-
-
-# $function: unittestEqual
-# $group: unittest.mds
-# $doc: Assert an actual value is equal to the expected value
-# $arg actual: The actual value
-# $arg expected: The expected value
-# $arg description: The description of the assertion
-function unittestEqual(actual, expected, description):
-    if actual != expected:
-        unittestRecordError(jsonStringify(actual), jsonStringify(expected), description)
-    endif
-endfunction
-
-
-# $function: unittestDeepEqual
-# $group: unittest.mds
-# $doc: Assert an actual value is *deeply* equal to the expected value
-# $arg actual: The actual value
-# $arg expected: The expected value
-# $arg description: The description of the assertion
-function unittestDeepEqual(actual, expected, description):
-    actualJSON = jsonStringify(actual)
-    expectedJSON = jsonStringify(expected)
-    if actualJSON != expectedJSON:
-        unittestRecordError(actualJSON, expectedJSON, description)
-    endif
-endfunction
-
-
-# Helper function to record a unit test error
-function unittestRecordError(actualStr, expectedStr, description):
-    testFailures = objectGet(unittestTests, unittestTestName)
-    errorLines = arrayNew( \
-        '~~~', \
-        actualStr, \
-        '~~~', \
-        '', \
-        '!=', \
-        '', \
-        '~~~', \
-        expectedStr, \
-        '~~~' \
-    )
-    if description != null:
-        arrayPush(testFailures, arrayExtend(arrayNew(markdownEscape(description), errorLines)))
-    else:
-        arrayPush(testFailures, errorLines)
-    endif
-endfunction
+systemLog('MarkdownUp - unittest.mds: unittest.mds is now unittest.bare - please update before 2025-06-01')
+include 'unittest.bare'