bare-script 3.8.23__tar.gz → 4.0.0__tar.gz

{bare_script-3.8.23/src/bare_script.egg-info → bare_script-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bare-script
-Version: 3.8.23
+Version: 4.0.0
 Summary: bare-script
 Home-page: https://github.com/craigahobbs/bare-script
 Author: Craig A. Hobbs
@@ -48,7 +48,6 @@ confident that BareScript will execute the same regardless of the underlying run
 
 - [The BareScript Language](https://craigahobbs.github.io/bare-script-py/language/)
 - [The BareScript Library](https://craigahobbs.github.io/bare-script-py/library/)
-- [The BareScript Expression Library](https://craigahobbs.github.io/bare-script-py/library/expression.html)
 - [API Documentation](https://craigahobbs.github.io/bare-script-py/)
 - [Source code](https://github.com/craigahobbs/bare-script-py)
 
@@ -118,7 +117,7 @@ print(execute_script(script, {'fetchFn': fetch_http}))
 This outputs:
 
 ```
-The BareScript Library has 186 functions
+The BareScript Library has 209 functions
 ```
 
 

{bare_script-3.8.23 → bare_script-4.0.0}/README.md

@@ -23,7 +23,6 @@ confident that BareScript will execute the same regardless of the underlying run
 
 - [The BareScript Language](https://craigahobbs.github.io/bare-script-py/language/)
 - [The BareScript Library](https://craigahobbs.github.io/bare-script-py/library/)
-- [The BareScript Expression Library](https://craigahobbs.github.io/bare-script-py/library/expression.html)
 - [API Documentation](https://craigahobbs.github.io/bare-script-py/)
 - [Source code](https://github.com/craigahobbs/bare-script-py)
 
@@ -93,7 +92,7 @@ print(execute_script(script, {'fetchFn': fetch_http}))
 This outputs:
 
 ```
-The BareScript Library has 186 functions
+The BareScript Library has 209 functions
 ```
 
 

{bare_script-3.8.23 → bare_script-4.0.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = bare-script
-version = 3.8.23
+version = 4.0.0
 url = https://github.com/craigahobbs/bare-script
 author = Craig A. Hobbs
 author_email = craigahobbs@gmail.com
@@ -32,7 +32,6 @@ install_requires =
 [options.entry_points]
 console_scripts = 
 	bare = bare_script.bare:main
-	baredoc = bare_script.baredoc:main
 
 [options.package_data]
 bare_script = 

{bare_script-3.8.23 → bare_script-4.0.0}/src/bare_script/__init__.py

@@ -5,24 +5,17 @@
 bare-script package
 """
 
-from .data import \
-    add_calculated_field, \
-    aggregate_data, \
-    filter_data, \
-    join_data, \
-    sort_data, \
-    top_data, \
-    validate_data
-
 from .model import \
     lint_script, \
     validate_expression, \
     validate_script
 
 from .options import \
+    FETCH_SYSTEM_PREFIX, \
     fetch_http, \
     fetch_read_only, \
     fetch_read_write, \
+    fetch_system, \
     log_stdout, \
     url_file_relative
 

{bare_script-3.8.23 → bare_script-4.0.0}/src/bare_script/bare.py

@@ -7,16 +7,13 @@ bare-script command-line interface (CLI)
 
 import argparse
 from functools import partial
-import importlib.resources
-import os
 import sys
 import time
 
-from .library import SYSTEM_GLOBAL_INCLUDES_NAME
 from .model import lint_script
-from .options import fetch_read_write, log_stdout, url_file_relative
+from .options import FETCH_SYSTEM_PREFIX, fetch_read_write, fetch_system, log_stdout, url_file_relative
 from .parser import parse_expression, parse_script
-from .runtime import evaluate_expression, execute_script
+from .runtime import SYSTEM_GLOBAL_INCLUDES_NAME, evaluate_expression, execute_script
 from .value import value_boolean
 
 
@@ -33,7 +30,9 @@ def main(argv=None):
     parser.add_argument('file', nargs='*', action=_FileScriptAction, help='files to process')
     parser.add_argument('-c', '--code', action=_InlineScriptAction, help='execute the BareScript code')
     parser.add_argument('-d', '--debug', action='store_true', help='enable debug mode')
-    parser.add_argument('-m', '--markdown-up', action='store_true', help='run with MarkdownUp stubs')
+    markdown_up_group = parser.add_mutually_exclusive_group()
+    markdown_up_group.add_argument('-l', '--html', action='store_true', help='run with MarkdownUp HTML output')
+    markdown_up_group.add_argument('-m', '--markdown', action='store_true', help='run with MarkdownUp text output')
     parser.add_argument('-s', '--static', dest='static', action='store_const', const='s', help='perform static analysis')
     parser.add_argument('-x', '--staticx', dest='static', action='store_const', const='x', help='perform static analysis with execution')
     parser.add_argument('-v', '--var', nargs=2, action='append', metavar=('VAR', 'EXPR'), default = [],
@@ -54,9 +53,22 @@ def main(argv=None):
         # Get the scripts to run
         scripts = args.scripts
         ix_user_script = 0
-        if args.markdown_up:
-            scripts = [('code', 'include <markdownUp.bare>'), *scripts]
-            ix_user_script = 1
+        if args.html or args.markdown:
+            # HTML or Markdown Text render?
+            if args.html:
+                scripts = [
+                    ('code', 'include <markdownUp.bare>'),
+                    ('code', 'markdownUpHTMLBegin()'),
+                    *scripts,
+                    ('code', 'markdownUpHTMLEnd()')
+                ]
+                ix_user_script = 2
+            else:
+                scripts = [
+                    ('code', 'include <markdownUp.bare>'),
+                    *scripts
+                ]
+                ix_user_script = 1
 
             # Add unittest.bare argument globals
             globals_['vUnittestReport'] = True
@@ -101,10 +113,10 @@ def main(argv=None):
                 time_begin = time.time()
                 result = execute_script(script, {
                     'debug': args.debug or False,
-                    'fetchFn': _fetch_include,
+                    'fetchFn': lambda request: fetch_system(fetch_read_write, request),
                     'globals': static_globals,
                     'logFn': log_stdout,
-                    'systemPrefix': _FETCH_INCLUDE_PREFIX,
+                    'systemPrefix': FETCH_SYSTEM_PREFIX,
                     'urlFn': partial(url_file_relative, script_value) if script_type == 'file' else None
                 })
                 if isinstance(result, (int, float)) and int(result) == result and 0 <= result <= 255:
@@ -140,20 +152,6 @@ def main(argv=None):
     sys.exit(status_code)
 
 
-def _fetch_include(request):
-    # Is this a bare system include?
-    url = request['url']
-    if url.startswith(_FETCH_INCLUDE_PREFIX):
-        path = url[len(_FETCH_INCLUDE_PREFIX):]
-        with importlib.resources.files('bare_script.include').joinpath(path).open('rb') as cm_inc:
-            return cm_inc.read().decode(encoding='utf-8')
-
-    return fetch_read_write(request)
-
-
-_FETCH_INCLUDE_PREFIX = f':bare-include:{os.sep}'
-
-
 class _InlineScriptAction(argparse.Action):
     def __call__(self, parser, namespace, values, option_string=None):
         if 'scripts' not in namespace:

{bare_script-3.8.23 → bare_script-4.0.0}/src/bare_script/include/args.bare

@@ -1,6 +1,8 @@
 # Licensed under the MIT License
 # https://github.com/craigahobbs/bare-script/blob/main/LICENSE
 
+include <markdown.bare>
+
 
 # The URL arguments model
 argsTypes = schemaParse( \

{bare_script-3.8.23 → bare_script-4.0.0}/src/bare_script/include/baredoc.bare

@@ -2,6 +2,9 @@
 # https://github.com/craigahobbs/bare-script/blob/main/LICENSE
 
 include <args.bare>
+include <markdown.bare>
+include <dataUtil.bare>
+include <dataTable.bare>
 include <schemaDoc.bare>
 
 
@@ -23,7 +26,7 @@ async function baredocMain(url, title, menuLinks, groupURLs):
     # Render library JSON documentation page?
     if objectGet(args, 'doc'):
         documentSetTitle('Library')
-        markdownPrint(schemaDocMarkdown(baredocTypes, 'Library'))
+        markdownPrint(schemaDocMarkdown(baredocTypes, 'BaredocLibrary'))
         return
     endif
 
@@ -32,7 +35,7 @@ async function baredocMain(url, title, menuLinks, groupURLs):
     urls = if(systemType(url) == 'array', url, [url])
     for libraryJSON, ixLibrary in systemFetch(urls):
         libraryPart = if(libraryJSON != null, jsonParse(libraryJSON))
-        libraryPart = if(libraryPart != null, schemaValidate(baredocTypes, 'Library', libraryPart))
+        libraryPart = if(libraryPart != null, schemaValidate(baredocTypes, 'BaredocLibrary', libraryPart))
         if libraryPart == null:
             libraryURL = arrayGet(urls, ixLibrary)
             markdownPrint('**Error:** Failed to fetch library documentation resource "' + markdownEscape(libraryURL) + '"')
@@ -294,38 +297,44 @@ endfunction
 
 # The library documentation schema
 baredocTypes = schemaParse( \
+    'group "baredoc.bare"', \
+    '', \
+    '', \
     '# A library documentation model', \
-    'struct Library', \
+    'struct BaredocLibrary', \
     '', \
     '    # The library functions', \
-    '    Function[len > 0] functions', \
+    '    BaredocFunction[] functions', \
     '', \
     '', \
     '# A library function', \
-    'struct Function', \
+    'struct BaredocFunction', \
     '', \
     '    # The function name', \
-    '    string(len > 0) name', \
+    '    string name', \
     '', \
     '    # The function group (e.g. "Math")', \
-    '    string(len > 0) group', \
+    '    string group', \
     '', \
     "    # The function's documentation Markdown lines", \
-    '    string[len > 0] doc', \
+    '    string[] doc', \
     '', \
     '    # The function arguments', \
-    '    optional FunctionArgument[len > 0] args', \
+    '    optional BaredocFunctionArgument[] args', \
     '', \
     "    # The function return's documentation Markdown lines", \
-    '    optional string[len > 0] return', \
+    '    optional string[] return', \
+    '', \
+    '    # If true, ignore the function', \
+    '    optional bool ignore', \
     '', \
     '', \
     '# A function argument', \
-    'struct FunctionArgument', \
+    'struct BaredocFunctionArgument', \
     '', \
     '    # The argument name', \
-    '    string(len > 0) name', \
+    '    string name', \
     '', \
     "    # The argument's documentation Markdown lines", \
-    '    string[len > 0] doc' \
+    '    string[] doc' \
 )

bare_script-4.0.0/src/bare_script/include/baredocCLI.bare

@@ -0,0 +1,246 @@
+# Licensed under the MIT License
+# https://github.com/craigahobbs/bare-script/blob/main/LICENSE
+
+include <args.bare>
+
+
+# $function: baredocCLIMain
+# $group: baredocCLI.bare
+# $doc: The BareScript documentation tool main entry point
+# $return: The exit status code
+async function baredocCLIMain():
+    # Command line arguments
+    args = argsParse(baredocCLIMainArguments)
+    if objectGet(args, 'help'):
+        markdownPrint(argsHelp(baredocCLIMainArguments))
+        return 1
+    endif
+    output = objectGet(args, 'output')
+    files = jsonParse(objectGet(args, 'files'))
+    if files == null || systemType(files) != 'array':
+        markdownPrint('**Error:** Invalid input file list JSON')
+        return 1
+    endif
+
+    # Parse each source file
+    functions = {}
+    errors = []
+    for filename in files:
+        # Read the source file
+        source = systemFetch(filename)
+        if source == null:
+            arrayPush(errors, 'Failed to load "' + filename + '"')
+            continue
+        endif
+
+        # Parse documentation comments
+        arrayExtend(errors, baredocCLIParse(functions, source, filename))
+    endfor
+
+    # Create the library documentation model - sort functions by name
+    libraryFunctions = []
+    for funcName in arraySort(objectKeys(functions)):
+        arrayPush(libraryFunctions, objectGet(functions, funcName))
+    endfor
+    library = {'functions': libraryFunctions}
+    libraryJSON = jsonStringify(library)
+
+    # No library functions?
+    if !libraryFunctions:
+        arrayPush(errors, 'error: No library functions')
+    endif
+
+    # Errors?
+    if errors:
+        markdownPrint('```', arrayJoin(errors, '\n'), '```')
+        return 1
+    endif
+
+    # Output to stdout?
+    status = 0
+    if output == '-':
+        systemLog(libraryJSON)
+    else:
+        # Output to file
+        if !systemFetch({'url': output, 'body': libraryJSON}):
+            markdownPrint('**Error:** Failed to write "' + output + '"')
+            status = 1
+        endif
+    endif
+    return status
+endfunction
+
+
+# baredocCLI application arguments
+baredocCLIMainArguments = argsValidate([ \
+    {'name': 'files', 'type': 'string', 'default': '[]', 'description': 'The JSON-encoded list of input source code filenames'}, \
+    {'name': 'help', 'type': 'bool', 'description': 'Show argument help'}, \
+    {'name': 'output', 'type': 'string', 'default': '-', 'description': 'The output file'} \
+])
+
+
+# $function: baredocCLIParse
+# $group: baredocCLI.bare
+# $doc: Parse source code for baredoc documentation comments
+# $arg functions: The map of function name to [function documentation model](model.html#var.vName='BaredocFunction')
+# $arg source: The source code string
+# $arg filename: The source filename string
+# $return: The array of errors
+function baredocCLIParse(functions, source, filename):
+    errors = []
+
+    # Process documentation comments line-by-line
+    func = null
+    for line, ixLine in stringSplitLines(source):
+        # function/group/doc/return documentation keywords?
+        matchKey = regexMatch(baredocCLIMainRegexKey, line)
+        if matchKey != null:
+            groupsKey = objectGet(matchKey, 'groups')
+            key = objectGet(groupsKey, 'key')
+            text = objectGet(groupsKey, 'text')
+            textTrim = stringTrim(text)
+
+            # Keyword used outside of function?
+            if key != 'function' && func == null:
+                arrayPush(errors, filename + ':' + (ixLine + 1) + ': ' + key + ' keyword outside function')
+                continue
+            endif
+
+            # Process the keyword
+            if key == 'group':
+                if textTrim == '':
+                    arrayPush(errors, filename + ':' + (ixLine + 1) + ': Invalid function group name "' + textTrim + '"')
+                    continue
+                endif
+                if objectHas(func, 'group'):
+                    arrayPush(errors, filename + ':' + (ixLine + 1) + ': Function "' + objectGet(func, 'name') + '" group redefinition')
+                    continue
+                endif
+
+                # Set the function group
+                objectSet(func, 'group', textTrim)
+
+            elif key == 'doc' || key == 'return':
+                # Add the documentation line - don't add leading blank lines
+                funcDoc = objectGet(func, key)
+                if funcDoc != null || textTrim != '':
+                    if funcDoc == null:
+                        funcDoc = []
+                        objectSet(func, key, funcDoc)
+                    endif
+                    arrayPush(funcDoc, text)
+                endif
+
+            elif key == 'ignore':
+                # Ignore the function?
+                if textTrim != 'true' && textTrim != 'false':
+                    arrayPush(errors, filename + ':' + (ixLine + 1) + ': Invalid ignore value "' + textTrim + '"')
+                    continue
+                endif
+                objectSet(func, key, text == 'true')
+
+            else:
+                # key == 'function'
+                if textTrim == '':
+                    arrayPush(errors, filename + ':' + (ixLine + 1) + ': Invalid function name "' + textTrim + '"')
+                    continue
+                endif
+                if objectHas(functions, textTrim):
+                    arrayPush(errors, filename + ':' + (ixLine + 1) + ': Function "' + textTrim + '" redefinition')
+                    continue
+                endif
+
+                # Add the function
+                func = {'name': textTrim}
+                objectSet(functions, textTrim, func)
+            endif
+
+            continue
+        endif
+
+        # arg keyword?
+        matchArg = regexMatch(baredocCLIMainRegexArg, line)
+        if matchArg != null:
+            groupsArg = objectGet(matchArg, 'groups')
+            name = objectGet(groupsArg, 'name')
+            text = objectGet(groupsArg, 'text')
+            textTrim = stringTrim(text)
+
+            # Keyword used outside of function?
+            if func == null:
+                arrayPush(errors, filename + ':' + (ixLine + 1) + ': Function argument "' + name + '" outside function')
+                continue
+            endif
+
+            # Get the function argument model, if it exists
+            funcArgs = objectGet(func, 'args')
+            funcArg = null
+            if funcArgs != null:
+                for findArg in funcArgs:
+                    if objectGet(findArg, 'name') == name:
+                        funcArg = findArg
+                        break
+                    endif
+                endfor
+            endif
+
+            # Ignore leading argument documentation blank lines
+            if funcArg == null && textTrim == '':
+                continue
+            endif
+
+            # Add the function model arguments member, if necessary
+            if funcArgs == null:
+                funcArgs = []
+                objectSet(func, 'args', funcArgs)
+            endif
+
+            # Add the function argument model, if necessary
+            if funcArg == null:
+                funcArg = {'name': name, 'doc': []}
+                arrayPush(funcArgs, funcArg)
+            endif
+
+            # Add the function argument documentation line
+            arrayPush(objectGet(funcArg, 'doc'), text)
+            continue
+        endif
+
+        # Unknown documentation comment?
+        matchUnknown = regexMatch(baredocCLIMainRegexUnknown, line)
+        if matchUnknown != null:
+            groupsUnknown = objectGet(matchUnknown, 'groups')
+            unknown = objectGet(groupsUnknown, 'unknown')
+            arrayPush(errors, filename + ':' + (ixLine + 1) + ': Invalid documentation comment "' + unknown + '"')
+            continue
+        endif
+    endfor
+
+    # Create the sorted function model array
+    libraryFunctions = []
+    for funcName in arraySort(objectKeys(functions)):
+        arrayPush(libraryFunctions, objectGet(functions, funcName))
+    endfor
+
+    # Validate the library documentation model
+    for funcObj in libraryFunctions:
+        funcName = objectGet(funcObj, 'name')
+        if !objectHas(funcObj, 'group'):
+            arrayPush(errors, 'error: Function "' + funcName + '" missing group')
+        endif
+        if !objectHas(funcObj, 'doc'):
+            arrayPush(errors, 'error: Function "' + funcName + '" missing documentation')
+        endif
+        if objectGet(funcObj, 'ignore'):
+            objectDelete(functions, funcName)
+        endif
+    endfor
+
+    return errors
+endfunction
+
+
+# baredocCLIParse regular expressions
+baredocCLIMainRegexKey = regexNew('^\\s*(?:\\/\\/|#)\\s*\\$(?<key>function|group|doc|return|ignore):\\s?(?<text>.*)$')
+baredocCLIMainRegexArg = regexNew('^\\s*(?:\\/\\/|#)\\s*\\$arg\\s+(?<name>[A-Za-z_][A-Za-z0-9_]*(?:\\.\\.\\.)?):\\s?(?<text>.*)$')
+baredocCLIMainRegexUnknown = regexNew('^\\s*(?:\\/\\/|#)\\s*\\$(?<unknown>[^:]+):')