bare-script 3.8.9__tar.gz → 3.8.11__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. {bare_script-3.8.9/src/bare_script.egg-info → bare_script-3.8.11}/PKG-INFO +1 -1
  2. {bare_script-3.8.9 → bare_script-3.8.11}/setup.cfg +1 -1
  3. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/baredoc.bare +30 -14
  4. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/dataLineChart.bare +1 -1
  5. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/markdownUp.bare +10 -29
  6. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/schemaDoc.bare +2 -2
  7. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/unittestMock.bare +11 -22
  8. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/library.py +9 -9
  9. {bare_script-3.8.9 → bare_script-3.8.11/src/bare_script.egg-info}/PKG-INFO +1 -1
  10. {bare_script-3.8.9 → bare_script-3.8.11}/LICENSE +0 -0
  11. {bare_script-3.8.9 → bare_script-3.8.11}/README.md +0 -0
  12. {bare_script-3.8.9 → bare_script-3.8.11}/pyproject.toml +0 -0
  13. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/__init__.py +0 -0
  14. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/__main__.py +0 -0
  15. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/bare.py +0 -0
  16. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/baredoc.py +0 -0
  17. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/data.py +0 -0
  18. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/__init__.py +0 -0
  19. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/args.bare +0 -0
  20. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/dataTable.bare +0 -0
  21. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/diff.bare +0 -0
  22. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/forms.bare +0 -0
  23. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/pager.bare +0 -0
  24. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/include/unittest.bare +0 -0
  25. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/model.py +0 -0
  26. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/options.py +0 -0
  27. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/parser.py +0 -0
  28. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/runtime.py +0 -0
  29. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script/value.py +0 -0
  30. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script.egg-info/SOURCES.txt +0 -0
  31. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script.egg-info/dependency_links.txt +0 -0
  32. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script.egg-info/entry_points.txt +0 -0
  33. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script.egg-info/requires.txt +0 -0
  34. {bare_script-3.8.9 → bare_script-3.8.11}/src/bare_script.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: bare-script
3
- Version: 3.8.9
3
+ Version: 3.8.11
4
4
  Summary: bare-script
5
5
  Home-page: https://github.com/craigahobbs/bare-script
6
6
  Author: Craig A. Hobbs
@@ -1,6 +1,6 @@
1
1
  [metadata]
2
2
  name = bare-script
3
- version = 3.8.9
3
+ version = 3.8.11
4
4
  url = https://github.com/craigahobbs/bare-script
5
5
  author = Craig A. Hobbs
6
6
  author_email = craigahobbs@gmail.com
@@ -90,14 +90,31 @@ async function baredocMain(url, title, menuLinks, groupURLs):
90
90
  return
91
91
  endif
92
92
 
93
+ # Fetch the group content URLs
94
+ groupContent = {}
95
+ if groupURLs != null:
96
+ # Fetch the content URLs
97
+ groupURLArray = []
98
+ groupNames = arraySort(objectKeys(groupURLs))
99
+ for groupName in groupNames:
100
+ arrayPush(groupURLArray, objectGet(groupURLs, groupName))
101
+ endfor
102
+ groupContentArray = systemFetch(groupURLArray)
103
+
104
+ # Assign the group contents
105
+ for groupName, ixGroupName in groupNames:
106
+ objectSet(groupContent, groupName, arrayGet(groupContentArray, ixGroupName))
107
+ endfor
108
+ endif
109
+
93
110
  # Render the page
94
111
  title = if(title != null && !objectHas(args, 'url'), title, url)
95
112
  if group != null:
96
- baredocGroupPage(args, title, groupURLs, groups, group)
113
+ baredocGroupPage(args, title, groupURLs, groupContent, groups, group)
97
114
  elif single:
98
- baredocSinglePage(args, title, menuLinks, groupURLs, groups)
115
+ baredocSinglePage(args, title, menuLinks, groupURLs, groupContent, groups)
99
116
  else:
100
- baredocIndexPage(args, title, menuLinks, groupURLs, groups)
117
+ baredocIndexPage(args, title, menuLinks, groupURLs, groupContent, groups)
101
118
  endif
102
119
  endfunction
103
120
 
@@ -122,7 +139,7 @@ endfunction
122
139
 
123
140
 
124
141
  # Render a library documentation index page
125
- async function baredocIndexPage(args, title, menuLinks, groupURLs, groups):
142
+ function baredocIndexPage(args, title, menuLinks, groupURLs, groupContent, groups):
126
143
  publish = objectGet(args, 'publish')
127
144
 
128
145
  # Render the menu and title
@@ -139,9 +156,9 @@ async function baredocIndexPage(args, title, menuLinks, groupURLs, groups):
139
156
  markdownPrint('# ' + markdownEscape(title))
140
157
 
141
158
  # Render the index Markdown, if any
142
- if groupURLs != null && objectHas(groupURLs, ''):
159
+ if objectHas(groupContent, ''):
143
160
  rootURL = objectGet(groupURLs, '')
144
- rootMarkdown = systemFetch(rootURL)
161
+ rootMarkdown = objectGet(groupContent, '')
145
162
  markdownPrint('', if(rootMarkdown != null, rootMarkdown, '**Error:** Failed to load "' + markdownEscape(rootURL) + '"'))
146
163
  endif
147
164
 
@@ -159,7 +176,7 @@ endfunction
159
176
 
160
177
 
161
178
  # Render the single-page library documentation
162
- async function baredocSinglePage(args, title, menuLinks, groupURLs, groups):
179
+ function baredocSinglePage(args, title, menuLinks, groupURLs, groupContent, groups):
163
180
  publish = objectGet(args, 'publish')
164
181
 
165
182
  # Render the menu and title
@@ -176,9 +193,9 @@ async function baredocSinglePage(args, title, menuLinks, groupURLs, groups):
176
193
  markdownPrint('# ' + markdownEscape(title))
177
194
 
178
195
  # Render the index Markdown, if any
179
- if groupURLs != null && objectHas(groupURLs, ''):
196
+ if objectHas(groupContent, ''):
180
197
  rootURL = objectGet(groupURLs, '')
181
- rootMarkdown = systemFetch(rootURL)
198
+ rootMarkdown = objectGet(groupContent, '')
182
199
  markdownPrint('', if(rootMarkdown != null, rootMarkdown, '**Error:** Failed to load "' + markdownEscape(rootURL) + '"'))
183
200
  endif
184
201
 
@@ -196,13 +213,13 @@ async function baredocSinglePage(args, title, menuLinks, groupURLs, groups):
196
213
  # Render the library function index
197
214
  for groupName in arraySort(objectKeys(groups)):
198
215
  markdownPrint('', '---', '')
199
- baredocGroupPage(args, title, groupURLs, groups, groupName)
216
+ baredocGroupPage(args, title, groupURLs, groupContent, groups, groupName)
200
217
  endfor
201
218
  endfunction
202
219
 
203
220
 
204
221
  # Render a library documentation group page
205
- async function baredocGroupPage(args, title, groupURLs, groups, groupName):
222
+ function baredocGroupPage(args, title, groupURLs, groupContent, groups, groupName):
206
223
  publish = objectGet(args, 'publish')
207
224
  single = objectGet(args, 'single')
208
225
  baseHeader = if(single, '##', '#')
@@ -227,11 +244,10 @@ async function baredocGroupPage(args, title, groupURLs, groups, groupName):
227
244
  markdownPrint('', argsLink(baredocArguments, 'Back to top', null, false, '_top'))
228
245
  endif
229
246
 
230
-
231
247
  # Render the group Markdown, if any
232
- if groupURLs != null && objectHas(groupURLs, groupName):
248
+ if objectHas(groupContent, groupName):
233
249
  groupURL = objectGet(groupURLs, groupName)
234
- groupMarkdown = systemFetch(groupURL)
250
+ groupMarkdown = objectGet(groupContent, groupName)
235
251
  markdownPrint('', if(groupMarkdown != null, groupMarkdown, '**Error:** Failed to load "' + markdownEscape(groupURL) + '"'))
236
252
  endif
237
253
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  # The line chart model
6
6
  dataLineChartTypes = schemaParse( \
7
- 'group "Line Chart"', \
7
+ 'group "data"', \
8
8
  '', \
9
9
  '', \
10
10
  '# A line chart model', \
@@ -441,6 +441,16 @@ endfunction
441
441
  #
442
442
 
443
443
 
444
+ # $function: markdownElements
445
+ # $group: Markdown
446
+ # $doc: Generate an element model from a Markdown model
447
+ # $arg markdownModel: The [Markdown model](https://craigahobbs.github.io/markdown-model/model/#var.vName='Markdown')
448
+ # $arg generic: Optional (default is false). If true, render markdown elements in a generic context.
449
+ # $return: The rendered Markdown [element model](https://github.com/craigahobbs/element-model#readme)
450
+ function markdownElements():
451
+ endfunction
452
+
453
+
444
454
  # $function: markdownEscape
445
455
  # $group: markdownUp.bare: markdown
446
456
  # $doc: Escape text for inclusion in Markdown text
@@ -509,35 +519,6 @@ function markdownTitle():
509
519
  endfunction
510
520
 
511
521
 
512
- #
513
- # Schema functions
514
- #
515
-
516
-
517
- # $function: schemaElements
518
- # $group: markdownUp.bare: schema
519
- # $doc: Get a schema type's documentation [element model](https://github.com/craigahobbs/element-model#readme).
520
- # $doc: Render the element model with the [elementModelRender](#var.vName='elementModelRender') function.
521
- # $arg types: The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
522
- # $arg typeName: The type name
523
- # $arg actionURLs: Optional (default is null). The
524
- # $arg actionURLs: [action URL overrides](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='ActionURL').
525
- # $arg actionCustom: Optional (default is false). If true, the action has a custom response.
526
- # $return: The schema type's documentation [element model](https://github.com/craigahobbs/element-model#readme)
527
- function schemaElements(types, typeName):
528
- userType = objectGet(types, typeName)
529
- userTypeKey = arrayGet(objectKeys(userType), 0)
530
- if userTypeKey == 'struct' && objectGet(objectGet(userType, 'struct'), 'union'):
531
- userTypeKey = 'union'
532
- endif
533
- return [ \
534
- [ \
535
- {'html': 'h1', 'elem': {'text': userTypeKey + ' ' + typeName}} \
536
- ] \
537
- ]
538
- endfunction
539
-
540
-
541
522
  #
542
523
  # Session storage functions
543
524
  #
@@ -141,10 +141,10 @@ schemaDocArguments = argsValidate([ \
141
141
  # $function: schemaDocMarkdown
142
142
  # $group: schemaDoc.bare
143
143
  # $doc: Generate the Schema Markdown user type documentation as an array of Markdown text lines
144
- # $arg types: The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
144
+ # $arg types: The [type model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
145
145
  # $arg typeName: The type name
146
146
  # $arg options: Optional (default is null). The options object with optional members:
147
- # $arg options: - **actionURLs** - The [action URLs](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='ActionURL') override
147
+ # $arg options: - **actionURLs** - The [action URLs](https://craigahobbs.github.io/bare-script/model/#var.vName='ActionURL'&var.vURL='') override
148
148
  # $arg options: - **actionCustom** - If true, the action has a custom response (default is false)
149
149
  # $arg options: - **headerPrefix** - The top-level header prefix string (default is "#")
150
150
  # $arg options: - **hideReferenced** - If true, referenced types are not rendered (default is false)
@@ -31,6 +31,7 @@ unittestMockState = objectCopy(unittestMockStateDefault)
31
31
  # $arg data: Optional (default is null). The map of function name to mock function data.
32
32
  # $arg data: The following functions make use of mock data:
33
33
  # $arg data: - **documentInputValue** - map of id to return value
34
+ # $arg data: - **markdownElements** - array of return values
34
35
  # $arg data: - **markdownParse** - array of return values
35
36
  # $arg data: - **markdownTitle** - array of return values
36
37
  # $arg data: - **systemFetch** - map of URL to response text
@@ -80,15 +81,13 @@ function unittestMockAll(data):
80
81
  unittestMockOne('localStorageSet', unittestMock_localStorageSet)
81
82
 
82
83
  # Markdown
84
+ unittestMockOne('markdownElements', systemPartial(unittestMock_markdownElements, if(data != null, objectGet(data, 'markdownElements'))))
83
85
  unittestMockOne('markdownEscape', unittestMock_markdownEscape)
84
86
  unittestMockOne('markdownHeaderId', unittestMock_markdownHeaderId)
85
87
  unittestMockOne('markdownParse', systemPartial(unittestMock_markdownParse, if(data != null, objectGet(data, 'markdownParse'))))
86
88
  unittestMockOneGeneric('markdownPrint')
87
89
  unittestMockOne('markdownTitle', systemPartial(unittestMock_markdownTitle, if(data != null, objectGet(data, 'markdownTitle'))))
88
90
 
89
- # Schema
90
- unittestMockOne('schemaElements', unittestMock_schemaElements)
91
-
92
91
  # Session Storage
93
92
  unittestMockOne('sessionStorageClear', unittestMock_sessionStorageClear)
94
93
  unittestMockOne('sessionStorageGet', unittestMock_sessionStorageGet)
@@ -287,6 +286,15 @@ endfunction
287
286
  #
288
287
 
289
288
 
289
+ function unittestMock_markdownElements(data, args...):
290
+ # Record the mocked function call
291
+ arrayPush(unittestMockCalls, ['markdownElements', args])
292
+
293
+ # Return the mocked markdownElements response
294
+ return if(data != null, arrayShift(data))
295
+ endfunction
296
+
297
+
290
298
  function unittestMock_markdownEscape(text):
291
299
  return regexReplace(unittestMock_markdownEscapeRegex, text, '\\$1')
292
300
  endfunction
@@ -326,25 +334,6 @@ function unittestMock_markdownTitle(data, args...):
326
334
  endfunction
327
335
 
328
336
 
329
- #
330
- # Schema functions
331
- #
332
-
333
-
334
- function unittestMock_schemaElements(types, typeName):
335
- userType = objectGet(types, typeName)
336
- userTypeKey = arrayGet(objectKeys(userType), 0)
337
- if userTypeKey == 'struct' && objectGet(objectGet(userType, 'struct'), 'union'):
338
- userTypeKey = 'union'
339
- endif
340
- return [ \
341
- [ \
342
- {'html': 'h1', 'elem': {'text': userTypeKey + ' ' + typeName}} \
343
- ] \
344
- ]
345
- endfunction
346
-
347
-
348
337
  #
349
338
  # Session Storage functions
350
339
  #
@@ -1483,7 +1483,7 @@ _REGEX_SPLIT_ARGS = value_args_model([
1483
1483
  # $doc: Parse the [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/) text
1484
1484
  # $arg lines...: The [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/)
1485
1485
  # $arg lines...: text lines (may contain nested arrays of un-split lines)
1486
- # $return: The schema's [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
1486
+ # $return: The schema's [type model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='')
1487
1487
  def _schema_parse(args, unused_options):
1488
1488
  return parse_schema_markdown(args)
1489
1489
 
@@ -1493,9 +1493,9 @@ def _schema_parse(args, unused_options):
1493
1493
  # $doc: Parse the [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/) text with options
1494
1494
  # $arg lines: The array of [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/)
1495
1495
  # $arg lines: text lines (may contain nested arrays of un-split lines)
1496
- # $arg types: Optional. The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types').
1496
+ # $arg types: Optional. The [type model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='').
1497
1497
  # $arg filename: Optional (default is ""). The file name.
1498
- # $return: The schema's [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
1498
+ # $return: The schema's [type model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='')
1499
1499
  def _schema_parse_ex(args, unused_options):
1500
1500
  lines, types, filename = value_args_validate(_SCHEMA_PARSE_EX_ARGS, args)
1501
1501
  lines_type = value_type(lines)
@@ -1514,8 +1514,8 @@ _SCHEMA_PARSE_EX_ARGS = value_args_model([
1514
1514
 
1515
1515
  # $function: schemaTypeModel
1516
1516
  # $group: schema
1517
- # $doc: Get the [Schema Markdown Type Model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
1518
- # $return: The [Schema Markdown Type Model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
1517
+ # $doc: Get the [Schema Markdown Type Model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='')
1518
+ # $return: The [Schema Markdown Type Model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='')
1519
1519
  def _schema_type_model(unused_args, unused_options):
1520
1520
  return TYPE_MODEL
1521
1521
 
@@ -1523,7 +1523,7 @@ def _schema_type_model(unused_args, unused_options):
1523
1523
  # $function: schemaValidate
1524
1524
  # $group: schema
1525
1525
  # $doc: Validate an object to a schema type
1526
- # $arg types: The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
1526
+ # $arg types: The [type model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='')
1527
1527
  # $arg typeName: The type name
1528
1528
  # $arg value: The object to validate
1529
1529
  # $return: The validated object or null if validation fails
@@ -1541,9 +1541,9 @@ _SCHEMA_VALIDATE_ARGS = value_args_model([
1541
1541
 
1542
1542
  # $function: schemaValidateTypeModel
1543
1543
  # $group: schema
1544
- # $doc: Validate a [Schema Markdown Type Model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
1545
- # $arg types: The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types') to validate
1546
- # $return: The validated [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
1544
+ # $doc: Validate a [Schema Markdown Type Model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='')
1545
+ # $arg types: The [type model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='') to validate
1546
+ # $return: The validated [type model](https://craigahobbs.github.io/bare-script-py/model/#var.vName='Types'&var.vURL='')
1547
1547
  def _schema_validate_type_model(args, unused_options):
1548
1548
  types, = value_args_validate(_SCHEMA_VALIDATE_TYPE_MODEL_ARGS, args)
1549
1549
  return validate_type_model(types)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: bare-script
3
- Version: 3.8.9
3
+ Version: 3.8.11
4
4
  Summary: bare-script
5
5
  Home-page: https://github.com/craigahobbs/bare-script
6
6
  Author: Craig A. Hobbs
File without changes
File without changes
File without changes