markdown_exec 2.5.0 → 2.6.0

data/examples/bash-blocks.md

@@ -50,7 +50,7 @@ The hidden block "(taxonomy)" prints "taxonomy".
     echo "taxonomy"
     ```
 
-```opts :(document_options)
+```opts :(document_opts)
 execute_in_own_window: false
 output_execution_report: false
 output_execution_summary: false

data/examples/block-names.md

@@ -54,7 +54,7 @@ The hidden block "(success)" is required above. It prints "Success".
 echo "Success"
 ```
 
-```opts :(document_options)
+```opts :(document_opts)
 execute_in_own_window: false
 output_execution_report: false
 output_execution_summary: false

data/examples/block-types.md

@@ -16,7 +16,7 @@ Specified block types.
         a: 1
         ```
 
-```opts :(document_options)
+```opts :(document_opts)
 bash_only: false
 execute_in_own_window: false
 output_execution_report: false

data/examples/data-files.md

@@ -1,6 +1,6 @@
 # Demonstrate data blocks
 
-```opts :(document_options)
+```opts :(document_opts)
 pause_after_script_execution: true
 ```
 

data/examples/document_options.md

@@ -1,8 +1,8 @@
 This document demonstrates the automatic loading of options in a block with a reserved name.
 
-```opts :(document_options)
+```opts :(document_opts)
 menu_divider_format: "=> %{line} == %{line} <="
 ```
 
-The divider below is named "Divider #1". Notice the "(document_options)" block sets the "menu_divider_format" option to duplicate the divider name when it is displayed.
+The divider below is named "Divider #1". Notice the "(document_opts)" block sets the "menu_divider_format" option to duplicate the divider name when it is displayed.
 ::: Divider #1

data/examples/indent.md

@@ -4,12 +4,12 @@ Indentation is either leading spaces or tabs.
 Tabs are interpreted as 4 spaces.
 
 ## Related MDE options
+divider_match                |  Pattern for topics/dividers in block selection menu
 fenced_start_and_end_regex   |  Matches the start and end of a fenced code block
 fenced_start_extended_regex  |  Match the start of a fenced block
 heading1_match               |  MDE_HEADING1_MATCH
 heading2_match               |  MDE_HEADING2_MATCH
 heading3_match               |  MDE_HEADING3_MATCH
-menu_divider_match           |  Pattern for topics/dividers in block selection menu
 menu_note_match              |  Pattern for notes in block selection menu
 menu_task_match              |  Pattern for tasks
 

data/examples/interrupt.md

@@ -1,4 +1,4 @@
-```opts :(document_options)
+```opts :(document_opts)
 pause_after_script_execution: false
 ```
 ```bash

data/examples/link-blocks-vars.md

@@ -1,5 +1,5 @@
 # Demonstrate link blocks set variables
-```opts :(document_options)
+```opts :(document_opts)
 execute_in_own_window: false
 menu_with_inherited_lines: true
 output_execution_report: false

data/examples/linked.md

@@ -1,6 +1,6 @@
 Demonstrate setting variable values interactively for use in generated scripts.
 
-```opts :(document_options)
+```opts :(document_opts)
 menu_with_inherited_lines: true
 pause_after_script_execution: false
 user_must_approve: false

data/examples/linked1.md

@@ -1,6 +1,6 @@
 # Demo document linking
 
-```opts :(document_options)
+```opts :(document_opts)
 dump_inherited_lines: true
 pause_after_script_execution: false
 user_must_approve: false

data/examples/nickname.md

@@ -1,6 +1,6 @@
 # Demo block nicknames
 
-```opts :(document_options)
+```opts :(document_opts)
 pause_after_script_execution: true
 ```
 

data/examples/opts-blocks-require.md

@@ -1,5 +1,5 @@
 # Demonstrate requiring blocks
-```opts :(document_options) +(custom) +[custom]
+```opts :(document_opts) +(custom) +[custom]
 menu_divider_color: red     # color to indicate failure
 ```
 ```opts :(custom)

data/examples/opts-blocks.md

@@ -19,7 +19,7 @@ menu_note_match: "^\\+ +(?<line>.+?) *$"
 menu_task_color: fg_rgb_127_127_255
 ```
 
-```opts :(document_options)
+```opts :(document_opts)
 menu_divider_color: green
 menu_link_color: fg_rgbh_88_cc_66
 menu_note_color: yellow

data/examples/opts_output_execution.md

@@ -1,7 +1,7 @@
 # Demo options: output_execution_report, output_execution_summary
 
 ::: Options are initially True
-```opts :(document_options) +[document_options]
+```opts :(document_opts) +[document_options]
 output_execution_report: true
 output_execution_summary: true
 pause_after_script_execution: true

data/examples/pass-through-arguments.md

@@ -1,4 +1,4 @@
-```opts :(document_options)
+```opts :(document_opts)
 execute_in_own_window: false
 pause_after_script_execution: true
 save_executed_script: true

data/examples/pause-after-execution.md

@@ -1,6 +1,6 @@
 # Demonstrate pause for user approval before returning to the menu
 Controlled by option `pause_after_script_execution`.
-```opts :(document_options)
+```opts :(document_opts)
 pause_after_script_execution: true
 ```
 

data/examples/port-blocks.md

@@ -1,6 +1,6 @@
 # Demo variable porting
 
-```opts :(document_options)
+```opts :(document_opts)
 dump_inherited_lines: true
 execute_in_own_window: false
 output_execution_report: false

data/examples/save.md

@@ -1,5 +1,5 @@
 # Demonstrate custom file names
-```opts :(document_options) +[custom]
+```opts :(document_opts) +[custom]
 pause_after_script_execution: true  # for interactive demos
 save_executed_script:         true  # demonstrate saved scripts
 save_execution_output:        true  # demonstrate saved output

data/examples/text-markup.md

@@ -47,7 +47,7 @@ line_decor_post  |  Line-oriented text decoration (Post)
 line_decor_pre   |  Line-oriented text decoration (Pre)
 menu_note_match  |  Pattern for notes in block selection menu
 
-```opts :(document_options)
+```opts :(document_opts)
 line_decor_post:
   - :color_method: blue
     :pattern: '!([^!]{0,64})!blue!'

data/examples/variable-expansion.md

@@ -68,7 +68,9 @@ glob: ${ALPHA}.sh
 ```
 
 / import bats-document-configuration.md
-```opts :(document_options)
+```opts :(document_opts)
+divider4_center: false
+
 dump_blocks_in_file: false     # Dump BlocksInFile (stage 1)
 dump_delegate_object: false    # Dump @delegate_object
 dump_inherited_lines: false    # Dump inherited lines
@@ -88,7 +90,9 @@ script_execution_frame_color: plain
 script_execution_head:
 script_execution_tail:
 
+table_center: false
+
 user_must_approve: false
 
 clear_screen_for_select_block: false
-```
+```

data/examples/vars-blocks.md

@@ -1,4 +1,4 @@
-```opts :(document_options)
+```opts :(document_opts)
 execute_in_own_window: false
 output_execution_report: false
 output_execution_summary: false

data/examples/wrap.md

@@ -100,7 +100,7 @@ shell_code_label_format_above: "#  -^-"
 shell_code_label_format_below: "#  -v-  +%{block_name}  -o-  %{document_filename}  -o-  %{time_now_date}  -v-"
 ```
 
-```opts :(document_options)
+```opts :(document_opts)
 execute_in_own_window: false
 output_execution_report: false
 output_execution_summary: false

data/lib/block_types.rb

@@ -2,7 +2,10 @@
 
 class BlockType
   ALL = [
+    CHROME = 'chrome',
+    DIVIDER = 'divider',
     EDIT = 'edit',
+    HEADING = 'heading',
     HISTORY = 'history',
     LINK = 'link',
     LOAD = 'load',
@@ -10,6 +13,7 @@ class BlockType
     PORT = 'port',
     SAVE = 'save',
     SHELL = 'shell',
+    TEXT = 'text',
     VARS = 'vars',
     VIEW = 'view',
     YAML = 'yaml'

data/lib/cached_nested_file_reader.rb

@@ -39,11 +39,13 @@ class CachedNestedFileReader
     )
   end
 
-  def readlines(filename, depth = 0, context: '', import_paths: nil, indention: '', &block)
+  def readlines(filename, depth = 0, context: '', import_paths: nil,
+                indention: '', &block)
     if @file_cache.key?(filename)
       @file_cache[filename].each(&block) if block
       return @file_cache[filename]
     end
+    raise Errno::ENOENT, filename unless filename
 
     directory_path = File.dirname(filename)
     processed_lines = []
@@ -60,6 +62,8 @@ class CachedNestedFileReader
                                File.join(directory_path, name_strip)
                              end
 
+        raise Errno::ENOENT, name_strip unless included_file_path
+
         processed_lines += readlines(included_file_path, depth + 1,
                                      context: "#{filename}:#{ind + 1}",
                                      import_paths: import_paths,
@@ -73,9 +77,8 @@ class CachedNestedFileReader
     end
 
     @file_cache[filename] = processed_lines
-  rescue Errno::ENOENT
-    # Exceptions.error_handler('readlines', { abort: true })
-    warn_format('readlines', "No such file -- #{filename} @@ #{context}",
+  rescue Errno::ENOENT => err_filename
+    warn_format('readlines', "#{err_filename} @@ #{context}",
                 { abort: true })
   end
 end

data/lib/collapser.rb

@@ -0,0 +1,302 @@
+require_relative 'constants'
+
+class Collapser
+  attr_accessor :options, :state
+
+  def initialize(
+    collapsed_level: nil,
+    collapsible_types: COLLAPSIBLE_TYPES,
+    options: {},
+    state: Hash.new(nil)
+  )
+    @collapsed_level = collapsed_level
+    @collapsible_types = collapsible_types.dup
+    @options = options.dup
+    @state = state.dup # do not dup
+  end
+
+  def collapse_per_options?(fcb, options: @options)
+    criteria = options["#{fcb.type}#{fcb.level}_collapse".to_sym]
+    return false if criteria.nil?
+
+    criteria
+  end
+
+  def collapse_per_state?(fcb, default: false, state: @state)
+    return false if state.nil?
+
+    criteria = state[fcb.id]
+    return default if criteria.nil?
+
+    !!criteria
+  end
+
+  def collapse_per_token?(fcb)
+    fcb.token == COLLAPSIBLE_TOKEN_COLLAPSE
+  end
+
+  def collapsible_per_options?(fcb, options: @options)
+    criteria = options["#{fcb.type}#{fcb.level}_collapsible".to_sym]
+    return false if criteria.nil?
+
+    criteria
+  end
+
+  def collapsible_per_type?(fcb, collapsible_types: @collapsible_types)
+    @collapsible_types.nil? || @collapsible_types.include?(fcb.type)
+  end
+
+  def collapse?(fcb, initialize: false)
+    if initialize
+      (collapse_per_options?(fcb) || collapse_per_token?(fcb)) && !expand_per_token?(fcb)
+    else
+      collapse_per_state?(fcb, default: false)
+    end
+  end
+
+  def collapsible?(fcb)
+    collapsible_per_options?(fcb)
+  end
+
+  def expand_per_token?(fcb)
+    fcb.token == COLLAPSIBLE_TOKEN_EXPAND
+  end
+
+  def hide?(fcb,
+            collapsed_level: @collapsed_level,
+            collapsible_types: @collapsible_types,
+            initialize: true)
+
+    fcb.collapsible = collapsible?(fcb)
+    if collapsed_level.nil?
+      # is not collapsing
+      fcb.collapse = collapse?(fcb, initialize: initialize)
+      collapsed_level = fcb.level if fcb.collapse
+      fcb.hide = false
+
+    elsif fcb.level.nil?
+      fcb.hide = true
+
+    elsif fcb.level > collapsed_level
+      # Currently collapsed; evaluate for the current block
+      fcb.collapse = collapse?(fcb, initialize: initialize)
+      collapsed_level = fcb.level if fcb.collapse
+      fcb.hide = true # block is at a deeper level thus hidden
+
+    else
+      # Currently expanded; evaluate for the current block
+      if fcb.collapsible
+        fcb.collapse = collapse?(fcb, initialize: initialize)
+        collapsed_level = fcb.collapse ? fcb.level : nil
+        fcb.hide = false
+      elsif collapsible_per_type?(fcb)
+        fcb.collapsible = false
+        fcb.collapse = false
+        fcb.hide = false
+      else
+        fcb.hide = true
+      end
+    end
+    @state[fcb.id] = fcb.level if fcb.collapse
+
+    collapsed_level
+  end
+
+  # Reject rows that should be hidden based on the hierarchy
+  def reject(fcbs, initialize: true, &block)
+    analyze(fcbs, initialize: initialize, reject: true, &block)
+  end
+
+  # Reject rows that should be hidden based on the hierarchy
+  def analyze(fcbs, initialize: true, reject: false, &block)
+    fcbs.reject do |fcb|
+      @collapsed_level = hide?(fcb, initialize: initialize)
+      block.call fcb, @collapsed_level if block
+
+      reject && fcb.hide
+    end
+  end
+end
+
+return if $PROGRAM_NAME != __FILE__
+
+require 'minitest/autorun'
+require_relative 'ww'
+
+# Updated FCB struct with an id for testing
+FCB = Struct.new(:id, :type, :level, :token, :collapse, :collapsible, :hide)
+OPTIONS = {
+  divider4_collapse: false,
+  divider4_collapsible: true,
+  heading1_collapse: false,
+  heading1_collapsible: false,
+  heading2_collapse: true,
+  heading2_collapsible: true,
+  heading3_collapse: false,
+  heading3_collapsible: true
+}.freeze
+STATE = {}.freeze
+
+class CollapserTest < Minitest::Test
+  def setup
+    @collapser = Collapser.new(collapsible_types: COLLAPSIBLE_TYPES.dup,
+                               options: OPTIONS.dup,
+                               state: STATE).dup
+  end
+
+  def test_analyze
+    # Define test scenarios as arrays of FCB objects and expected filtered results
+
+    # :id, :type, :level, :token
+    ff_h1a = ['h1a', 'heading', 1, '']
+    ff_h1b = ['h1b', 'heading', 1, '']
+    ff_h2a = ['h2a', 'heading', 2, '']
+    ff_h2b = ['h2b', 'heading', 2, '']
+    ff_t1 = ['t1', 'text', nil, '']
+    ff_t2 = ['t2', 'text', nil, '']
+    ff_t3 = ['t3', 'text', nil, '']
+    ff_t4 = ['t4', 'text', nil, '']
+    ff_h1a_collapse = ['h1a', 'heading', 1, COLLAPSIBLE_TOKEN_COLLAPSE]
+    ff_h1a_expand = ['h1a', 'heading', 1, COLLAPSIBLE_TOKEN_EXPAND]
+    ff_h1b_expand = ['h1b', 'heading', 1, COLLAPSIBLE_TOKEN_EXPAND]
+
+    # :collapse, :collapsible, :hide
+    cc_init = [false, false, false]
+    cc_collapse = [true, false, false]
+    cc_collapse_collapsible = [true, true, false]
+    cc_collapsible = [false, true, false]
+    cc_collapsible_hide = [false, true, true]
+    cc_hide = [false, false, true]
+    cc_undefined_hide = [nil, nil, false]
+
+    fc_h1a__init = FCB.new(*ff_h1a, *cc_init)
+    fc_h1b__init = FCB.new(*ff_h1b, *cc_init)
+    fc_h2a__init = FCB.new(*ff_h2a, *cc_init)
+    fc_h2b__init = FCB.new(*ff_h2b, *cc_init)
+    fc_t1__init = FCB.new(*ff_t1, *cc_init)
+    fc_t2__init = FCB.new(*ff_t2, *cc_init)
+    fc_t3__init = FCB.new(*ff_t3, *cc_init)
+    fc_t4__init = FCB.new(*ff_t4, *cc_init)
+
+    fc_h1a__collapse = FCB.new(*ff_h1a, *cc_collapse)
+
+    fc_h1a__collapse_collapsible = FCB.new(*ff_h1a, *cc_collapse_collapsible)
+    fc_h2a__collapse_collapsible = FCB.new(*ff_h2a, *cc_collapse_collapsible)
+
+    fc_h1a__collapsible = FCB.new(*ff_h1a, *cc_collapsible)
+    fc_h2a__collapsible = FCB.new(*ff_h2a, *cc_collapsible)
+
+    fc_h1a__collapsible_hide = FCB.new(*ff_h1a, *cc_collapsible_hide)
+
+    fc_t1__hide = FCB.new(*ff_t1, *cc_hide)
+    fc_t2__hide = FCB.new(*ff_t2, *cc_hide)
+    fc_h2a__hide = FCB.new(*ff_h2a, *cc_hide)
+
+    analyze_cases = {
+      with_token: [
+        { name: 'collapse',
+          fcbs: [FCB.new(*ff_h1a_collapse, *cc_init)],
+          expected: [FCB.new(*ff_h1a_collapse, *cc_collapse)] },
+        { name: 'expand',
+          fcbs: [FCB.new(*ff_h1a_expand, *cc_init)],
+          expected: [FCB.new(*ff_h1a_expand, *cc_init)] },
+        { name: 'collapse, against options',
+          fcbs: [FCB.new(*ff_h1a_collapse, *cc_init)],
+          options: { heading1_collapse: false },
+          expected: [FCB.new(*ff_h1a_collapse, *cc_collapse)] },
+        { name: 'expand, against options',
+          fcbs: [FCB.new(*ff_h1a_expand, *cc_init)],
+          options: { heading1_collapse: true },
+          expected: [FCB.new(*ff_h1a_expand, *cc_init)] },
+      ],
+
+      with_no_state: [
+        { name: ' ',
+          fcbs: [FCB.new(*ff_h1a_expand, *cc_init), fc_t1__init, fc_h2a__init, fc_t2__init, FCB.new(*ff_h1b_expand, *cc_init), fc_t3__init, fc_h2b__init, fc_t4__init],
+          options: { heading2_collapse: true },
+          expected: [FCB.new(*ff_h1a_expand, *cc_init), fc_t1__init, FCB.new(*ff_h2a, *cc_collapse), FCB.new(*ff_h1b_expand, *cc_init), fc_t3__init, FCB.new(*ff_h2b, *cc_collapse)] },
+
+        { name: 'not collapsible',
+          fcbs: [fc_h1a__init],
+          options: {},
+          expected: [fc_h1a__init] },
+
+        { name: 'collapse, not collapsible',
+          fcbs: [fc_h1a__init],
+          options: { heading1_collapse: true },
+          expected: [fc_h1a__collapse] },
+
+        { name: 'collapsible, not collapsed',
+          fcbs: [fc_h1a__init],
+          options: { heading1_collapsible: true },
+          expected: [fc_h1a__collapsible] },
+
+        { name: 'collapsible, not collapsed, with a dependent',
+          fcbs: [fc_h1a__init, fc_t1__init],
+          options: { heading1_collapsible: true },
+          expected: [fc_h1a__init, fc_t1__init] },
+
+        { name: 'collapsible, collapsed',
+          fcbs: [fc_h1a__init],
+          options: { heading1_collapse: true,
+                     heading1_collapsible: true },
+          expected: [fc_h1a__collapse_collapsible] },
+
+        { name: 'collapsible, collapsed, with a dependent',
+          fcbs: [fc_h1a__init, fc_t1__init],
+          options: { heading1_collapse: true,
+                     heading1_collapsible: true },
+          expected: [fc_h1a__collapse_collapsible,
+                     fc_t1__hide] },
+
+        { name: 'collapsible, collapsed, with a dependent and lower levels',
+          fcbs: [fc_h1a__init, fc_t1__init, fc_h2a__init],
+          options: { heading1_collapse: true,
+                     heading1_collapsible: true },
+          expected: [fc_h1a__collapse_collapsible,
+                     fc_t1__hide,
+                     fc_h2a__hide] },
+
+        { name: 'collapsible, collapsed, with a dependent and higher levels',
+          fcbs: [fc_h1a__init, fc_h2a__init, fc_t1__init],
+          options: { heading2_collapse: true,
+                     heading2_collapsible: true },
+          expected: [fc_h1a__init,
+                     fc_h2a__collapse_collapsible,
+                     fc_t1__hide] },
+      ],
+
+      with_empty_state: [
+        { name: 'expanded remains expanded',
+          fcbs: [fc_h1a__init],
+          options: { heading1_collapsible: true },
+          initialize: false,
+          expected: [fc_h1a__collapsible] },
+      ],
+
+      with_collapsed_state: [
+        { name: 'collapsed remains collapsed',
+          fcbs: [fc_h1a__collapse_collapsible],
+          options: { heading1_collapsible: true },
+          state: { "h1a" => 1 },
+          initialize: false,
+          expected: [fc_h1a__collapse_collapsible] },
+      ]
+    }
+
+    analyze_cases.each do |name, test_cases|
+      test_cases.each_with_index do |test_case, index|
+        @collapser = Collapser.new(collapsed_level: test_case[:collapsed_level],
+                                   collapsible_types: test_case[:collapsible_types] || COLLAPSIBLE_TYPES,
+                                   options: (test_case[:options] || OPTIONS).dup,
+                                   state: (test_case[:state] || STATE).dup)
+        analysis = @collapser.analyze(
+          test_case[:fcbs],
+          initialize: test_case[:initialize].nil? ? true : test_case[:initialize]
+        )
+        assert_equal test_case[:expected], analysis,
+                     "Failed on test case #{index + 1} #{name} #{test_case[:name]}"
+      end
+    end
+  end
+end

data/lib/constants.rb

@@ -30,6 +30,16 @@ BLOCK_TYPE_COLOR_OPTIONS = {
   BlockType::VARS => :menu_vars_color
 }.freeze
 
+
+COLLAPSIBLE_SYMBOL_COLLAPSED = '⬢' # '<+>' # '∆'
+COLLAPSIBLE_SYMBOL_EXPANDED = '⬡' # '< >' # '…' 
+
+# in regexp (?<collapse>[+-~]?)
+COLLAPSIBLE_TOKEN_COLLAPSE = '+'
+COLLAPSIBLE_TOKEN_EXPAND = '-'
+
+COLLAPSIBLE_TYPES = [BlockType::DIVIDER, BlockType::HEADING].freeze
+
 class ExecutionStreams
   STD_ERR = :stderr
   STD_IN  = :stdin

data/lib/evaluate_shell_expressions.rb

@@ -21,11 +21,9 @@ def evaluate_shell_expressions(initial_code, expressions, shell: '/bin/bash',
     script << "\necho #{token}#{index}\n"
     script << expression << "\n"
   end
-  # !!v script
 
   # Execute
   stdout_str, stderr_str, status = Open3.capture3(shell, "-c", script)
-  # !!v stdout_str, stderr_str, status
 
   unless status.success?
     raise "Shell script execution failed: #{stderr_str}"
@@ -38,7 +36,6 @@ def evaluate_shell_expressions(initial_code, expressions, shell: '/bin/bash',
       result_hash[sprintf(key_format, key)] = output_parts[index].chomp
     end
   end
-  # !!v result_hash
 
   result_hash
 end