markdown_exec 2.7.5 → 2.8.1

data/lib/hash_delegator.rb

@@ -92,6 +92,10 @@ module HashDelegatorSelf
     blocks.find { |item| item.send(msg) == value } || default
   end
 
+  def block_match(blocks, msg, value, default = nil)
+    blocks.select { |item| value =~ item.send(msg) }
+  end
+
   def block_select(blocks, msg, value, default = nil)
     blocks.select { |item| item.send(msg) == value }
   end
@@ -297,14 +301,16 @@ module HashDelegatorSelf
         truncate: $table_cell_truncate
       )
 
-      truncated_table_cell = false
+      exceeded_table_cell = false # any cell in table is exceeded
+      truncated_table_cell = false # any cell in table is truncated
       table__hs.each do |table_hs|
         table_hs.substrings.each do |substrings|
           substrings.each do |node|
-            if node[:text].class == TrackedString
-              truncated_table_cell = node[:text].truncated
-              break if truncated_table_cell
-            end
+            next unless node[:text].class == TrackedString
+
+            exceeded_table_cell ||= node[:text].exceeded
+            truncated_table_cell = node[:text].truncated
+            break if truncated_table_cell
           end
           break if truncated_table_cell
         end
@@ -337,9 +343,9 @@ module HashDelegatorSelf
 
         if ind.zero?
           fcb.truncated_table_cell = truncated_table_cell
-          # if truncated_table_cell
-          fcb.delete_key(:disabled)
-          # end
+          if exceeded_table_cell
+            fcb.delete_key(:disabled)
+          end
         end
       end
     end
@@ -588,6 +594,7 @@ module MarkdownExec
       @prompt = HashDelegator.tty_prompt_without_disabled_symbol
 
       @opts_most_recent_filename = nil
+      @ux_most_recent_filename = nil
       @vars_most_recent_filename = nil
       @pass_args = []
       @run_state = OpenStruct.new(
@@ -865,7 +872,6 @@ module MarkdownExec
       blocks = []
       iter_blocks_from_nested_files do |btype, fcb|
         count += 1
-
         case btype
         when :blocks
           if @delegate_object[:bash]
@@ -873,7 +879,10 @@ module MarkdownExec
               block_calls_scan: @delegate_object[:block_calls_scan],
               block_name_match: @delegate_object[:block_name_match],
               block_name_nick_match: @delegate_object[:block_name_nick_match],
-              id: "#{source_id}_bfnf_b_#{count}"
+              id: "#{source_id}_bfnf_b_#{count}",
+              menu_format: @delegate_object[:menu_ux_row_format],
+              prompt: @delegate_object[:prompt_ux_enter_a_value],
+              table_center: @delegate_object[:table_center]
             ) do |oname, color|
               apply_block_type_color_option(oname, color)
             end
@@ -925,7 +934,12 @@ module MarkdownExec
       end
     end
 
-    # private
+    def build_menu_options(exit_option, display_mode_option,
+                           menu_entries, display_format)
+      [exit_option,
+       display_mode_option,
+       *menu_entries.map(&display_format)].compact
+    end
 
     def build_replacement_dictionary(
       commands, link_state,
@@ -935,7 +949,7 @@ module MarkdownExec
         (link_state&.inherited_lines_block || ''), commands,
         initial_code_required: initial_code_required,
         key_format: key_format
-      ) # !!t
+      )
     end
 
     def calc_logged_stdout_filename(block_name:)
@@ -1008,6 +1022,136 @@ module MarkdownExec
       ]
     end
 
+    def neval(export_exec, inherited_code)
+      # ww0 export_exec
+      # ww0 inherited_code
+      code = (inherited_code || []) + [export_exec]
+      filespec = generate_temp_filename
+      File.write filespec, HashDelegator.join_code_lines(code)
+      File.chmod 0o755, filespec
+      # ww0 File.read(filespec)
+      ret = `#{filespec}`
+      File.delete filespec
+      ret
+    end
+
+    # sets ENV
+    def code_from_ux_block_to_set_environment_variables(
+      selected, mdoc, inherited_code: nil, force: true, only_default: false
+    )
+      # ww0 inherited_code
+      # ww0 mdoc
+      exit_prompt = @delegate_object[:prompt_filespec_back]
+
+      required = mdoc.collect_recursively_required_code(
+        anyname: selected.pub_name,
+        label_format_above: @delegate_object[:shell_code_label_format_above],
+        label_format_below: @delegate_object[:shell_code_label_format_below],
+        block_source: block_source
+      )
+
+      code_lines = []
+      case data = YAML.load(selected.body.join("\n"))
+      when Hash
+        export = parse_yaml_of_ux_block(
+          data,
+          prompt: @delegate_object[:prompt_ux_enter_a_value],
+          validate: '^(?<name>[^ ].*)$'
+        )
+
+        exportable = true
+        if only_default
+          value = case export.default
+                  # exec > default
+                  when :exec
+                    raise unless export.exec.present?
+
+                    n1 = neval(export.exec,
+                               (inherited_code || []) + required[:code])
+
+                    if export.transform.present?
+                      if export.transform.is_a? Symbol
+                        n1.send(export.transform)
+                      else
+                        format(
+                          export.transform,
+                          NamedCaptureExtractor.extract_named_groups(
+                            n1, export.validate
+                          )
+                        )
+                      end
+                    else
+                      n1
+                    end
+
+                  # default
+                  else
+                    export.default.to_s
+                  end
+        else
+          caps = nil
+          value = nil
+
+          # exec > allowed
+          if export.exec
+            value = neval(export.exec, (inherited_code || []) + required[:code])
+            caps = NamedCaptureExtractor.extract_named_groups(value,
+                                                              export.validate)
+
+          # allowed > prompt
+          elsif export.allowed && export.allowed.count.positive?
+            case (choice = prompt_select_code_filename(
+              [exit_prompt] + export.allowed,
+              string: export.prompt,
+              color_sym: :prompt_color_after_script_execution
+            ))
+            when exit_prompt
+              exportable = false
+            else
+              value = choice
+              caps = NamedCaptureExtractor.extract_named_groups(value,
+                                                                export.validate)
+            end
+
+          # prompt > default
+          elsif export.prompt.present?
+            begin
+              while true
+                print "#{export.prompt} [#{export.default}]: "
+                value = gets.chomp
+                value = export.default.to_s if value.empty?
+                caps = NamedCaptureExtractor.extract_named_groups(value,
+                                                                  export.validate)
+                break if caps
+
+                # invalid input, retry
+
+              end
+            rescue Interrupt
+              exportable = false
+            end
+
+          # default
+          else
+            value = export.default
+          end
+
+          if exportable && export.transform.present?
+            value = format(export.transform, caps)
+          end
+        end
+
+        if exportable
+          ENV[export.name] = value.to_s
+          code_lines.push code_line_safe_assign(export.name, value,
+                                                force: force)
+        end
+      else
+        raise "Invalid data type: #{data.inspect}"
+      end
+      code_lines
+    end
+
     # sets ENV
     def code_from_vars_block_to_set_environment_variables(selected)
       code_lines = []
@@ -1027,6 +1171,14 @@ module MarkdownExec
       code_lines
     end
 
+    def code_line_safe_assign(name, value, force:)
+      if force
+        "#{name}=#{Shellwords.escape(value)}"
+      else
+        "[[ -z $#{name} ]] && #{name}=#{Shellwords.escape(value)}"
+      end
+    end
+
     def collect_line_decor_patterns(delegate_object)
       extract_patterns = lambda do |key|
         return [] unless delegate_object[key].present?
@@ -1412,7 +1564,7 @@ module MarkdownExec
                         @delegate_object[criteria[:color]].to_sym,
           decor_patterns:
             @decor_patterns_from_delegate_object_for_block_create,
-          disabled: fcb.truncated_table_cell.nil? && !(criteria[:collapsible] && @delegate_object[criteria[:collapsible]]),
+          disabled: !(criteria[:collapsible] && @delegate_object[criteria[:collapsible]]),
           fcb: fcb,
           id: "#{id}.#{index}",
           format_option: criteria[:format] &&
@@ -1790,6 +1942,18 @@ module MarkdownExec
         )
         next_state_set_code(selected, link_state, required_lines)
 
+      elsif selected.type == BlockType::UX
+        debounce_reset
+        next_state_append_code(
+          selected,
+          link_state,
+          code_from_ux_block_to_set_environment_variables(
+            selected,
+            @dml_mdoc,
+            inherited_code: @dml_link_state.inherited_lines
+          )
+        )
+
       elsif selected.type == BlockType::VARS
         debounce_reset
         next_state_append_code(selected, link_state,
@@ -1822,19 +1986,23 @@ module MarkdownExec
         block_source: block_source
       )
 
-      # if the same menu is being displayed, collect the display name
-      #  of the selected menu item for use as the default item
-      [lfls.link_state,
-       lfls.load_file == LoadFile::LOAD ? nil : selected.dname,
-       # 2024-08-22 true to quit
-       lfls.load_file == LoadFile::EXIT]
+      # dname is not fixed for some block types, use block id
+      if lfls.load_file != LoadFile::LOAD &&
+         [BlockType::HEADING, BlockType::TEXT,
+          BlockType::UX].include?(selected.type)
+        block_selection = BlockSelection.new(selected.id)
+      end
+
+      { link_state: lfls.link_state,
+        block_selection: block_selection,
+        quit: lfls.load_file == LoadFile::EXIT }
     end
 
     def execute_block_in_state(block_name)
       @dml_block_state = block_state_for_name_from_cli(block_name)
       dump_and_warn_block_state(name: block_name,
                                 selected: @dml_block_state.block)
-      @dml_link_state, @dml_menu_default_dname, quit =
+      next_block_state =
         execute_block_for_state_and_name(
           selected: @dml_block_state.block,
           mdoc: @dml_mdoc,
@@ -1846,7 +2014,10 @@ module MarkdownExec
             )
           }
         )
-      :break if quit
+
+      @dml_link_state = next_block_state[:link_state]
+      @dml_block_selection = next_block_state[:block_selection]
+      :break if next_block_state[:quit]
     end
 
     def execute_block_type_history_ux(
@@ -1993,6 +2164,7 @@ module MarkdownExec
           block_data['glob'] || glob
         )
       )
+      dirs.sort_by! { |f| File.mtime(f) }.reverse!
 
       if !contains_glob?(block_data['directory']) &&
          !contains_glob?(block_data['glob'])
@@ -2003,7 +2175,7 @@ module MarkdownExec
         end
       elsif selected_option = select_option_with_metadata(
         prompt_title,
-        [exit_prompt] + dirs.sort.map do |file|
+        [exit_prompt] + dirs.map do |file|
           { name: format(
             block_data['view'] || view,
             NamedCaptureExtractor.extract_named_group_match_data(
@@ -2167,41 +2339,25 @@ module MarkdownExec
     )
       # repeat select+display until user exits
 
-      pause_now = false
-      row_attrib = :row
-      loop do
-        if pause_now && (prompt_select_continue == MenuState::EXIT)
-          break
-        end
-
-        # menu with Back and Facet options at top
-        case (name = prompt_select_code_filename(
-          [exit_prompt,
-           @delegate_object[:prompt_filespec_facet]] +
-           files_table_rows.map(&row_attrib),
-          string: @delegate_object[:prompt_select_history_file],
-          color_sym: :prompt_color_after_script_execution
-        ))
-        when exit_prompt
-          break
-        when @delegate_object[:prompt_filespec_facet]
-          row_attrib = row_attrib == :row ? :file : :row
-          pause_now = false
-        else
-          file = files_table_rows.select { |ftr| ftr.row == name }&.first
-          info = file_info(file.file)
-          stream.puts "#{file.file} - #{info[:lines]} lines / " \
-                      "#{info[:size]} bytes"
-          stream.puts(
-            File.readlines(file.file,
-                           chomp: false).map.with_index do |line, ind|
-              format(' %s.  %s',
-                     AnsiString.new(format('% 4d', ind + 1)).send(:violet),
-                     line)
-            end
-          )
-          pause_now = pause_refresh
-        end
+      interactive_menu_with_display_modes(
+        files_table_rows,
+        display_formats: [:row, :file],
+        display_mode_option: @delegate_object[:prompt_filespec_facet],
+        exit_option: exit_prompt,
+        menu_title: @delegate_object[:prompt_select_history_file],
+        pause_after_selection: pause_refresh
+      ) do |file|
+        info = file_info(file.file)
+        stream.puts "#{file.file} - #{info[:lines]} lines / " \
+                    "#{info[:size]} bytes"
+        stream.puts(
+          File.readlines(file.file,
+                         chomp: false).map.with_index do |line, ind|
+            format(' %s.  %s',
+                   AnsiString.new(format('% 4d', ind + 1)).send(:violet),
+                   line)
+          end
+        )
       end
     end
 
@@ -2296,7 +2452,7 @@ module MarkdownExec
 
       variable_counts = count_named_group_occurrences(blocks, pattern,
                                                       group_name: group_name)
-      return if variable_counts.nil?
+      return if variable_counts.nil? || variable_counts == {}
 
       echo_commands = generate_echo_commands(variable_counts, echo_format)
 
@@ -2307,6 +2463,7 @@ module MarkdownExec
       )
 
       return if replacements.nil?
+      return if replacements == EvaluateShellExpression::StatusFail
 
       expand_blocks_with_replacements(blocks, replacements)
     end
@@ -2519,6 +2676,56 @@ module MarkdownExec
       }
     end
 
+    def interactive_menu_with_display_modes(
+      menu_entries,
+      display_formats:,
+      display_mode_option:,
+      exit_option:,
+      menu_title:,
+      pause_after_selection:
+    )
+      pause_menu = false
+      current_display_format = display_formats.first
+
+      loop do
+        break if pause_menu && (prompt_select_continue == MenuState::EXIT)
+
+        menu_options = build_menu_options(
+          exit_option, display_mode_option,
+          menu_entries, current_display_format
+        )
+
+        selection = prompt_select_code_filename(
+          menu_options,
+          string: menu_title,
+          color_sym: :prompt_color_after_script_execution
+        )
+
+        case selection
+        when exit_option
+          break
+        when display_mode_option
+          current_display_format = next_item(
+            display_formats, current_display_format
+          )
+          pause_menu = false
+        else
+          handle_selection(menu_entries, selection,
+                           current_display_format) do |item|
+            yield item if block_given?
+          end
+          pause_menu = pause_after_selection
+        end
+      end
+    end
+
+    def handle_selection(menu_entries, selection, current_display_format)
+      selected_item = menu_entries.find do |entry|
+        entry.send(current_display_format) == selection
+      end
+      yield selected_item if selected_item
+    end
+
     # Iterates through blocks in a file, applying the provided block to each line.
     # The iteration only occurs if the file exists.
     # @yield [Symbol] :filter Yields to obtain selected messages for processing.
@@ -2723,6 +2930,37 @@ module MarkdownExec
       true
     end
 
+    def load_auto_ux_block(
+      all_blocks,
+      mdoc,
+      block_name: @delegate_object[:document_load_ux_block_name]
+    )
+      unless block_name.present? &&
+             @ux_most_recent_filename != @delegate_object[:filename]
+        return
+      end
+
+      blocks = HashDelegator.block_select(all_blocks, :oname, block_name)
+      if blocks.empty?
+        blocks = HashDelegator.block_match(all_blocks, :nickname,
+                                           Regexp.new(block_name))
+      end
+      return if blocks.empty?
+
+      @ux_most_recent_filename = @delegate_object[:filename]
+
+      (blocks.each.with_object([]) do |block, merged_options|
+        merged_options.push(
+          code_from_ux_block_to_set_environment_variables(
+            block,
+            mdoc,
+            force: @delegate_object[:ux_auto_load_force_default],
+            only_default: true
+          )
+        )
+      end).to_a
+    end
+
     def load_auto_vars_block(all_blocks,
                              block_name: @delegate_object[:document_load_vars_block_name])
       unless block_name.present? &&
@@ -2871,6 +3109,16 @@ module MarkdownExec
         reload_blocks = true
       end
 
+      # load document ux block
+      #
+      if code_lines = load_auto_ux_block(all_blocks, mdoc)
+        new_code = HashDelegator.code_merge(link_state.inherited_lines,
+                                            code_lines)
+        next_state_set_code(nil, link_state, new_code)
+        link_state.inherited_lines = new_code
+        reload_blocks = true
+      end
+
       # load document vars block
       #
       if code_lines = load_auto_vars_block(all_blocks)
@@ -2924,7 +3172,6 @@ module MarkdownExec
       HashDelegator.tables_into_columns!(menu_blocks, @delegate_object,
                                          screen_width_for_table)
 
-
       [all_blocks, menu_blocks, mdoc]
     end
 
@@ -2988,7 +3235,6 @@ module MarkdownExec
     def menu_toggle_collapsible_block(selected)
       # return true if @compress_ids.key?(fcb.id) && !!@compress_ids[fcb.id]
       # return false if @expand_ids.key?(fcb.id) && !!@expand_ids[fcb.id]
-      # binding.irb
       if @compressed_ids.key?(selected.id) && !!@compressed_ids[selected.id]
         @compressed_ids.delete(selected.id)
         @expanded_ids[selected.id] = selected.level
@@ -3010,6 +3256,13 @@ module MarkdownExec
       end
     end
 
+    def next_item(list, current_item)
+      index = list.index(current_item)
+      return nil unless index # Return nil if the item is not in the list
+
+      list[(index + 1) % list.size] # Get the next item, wrap around if at the end
+    end
+
     def next_state_append_code(selected, link_state, code_lines)
       next_state_set_code(
         selected,
@@ -3705,15 +3958,17 @@ module MarkdownExec
     end
 
     def screen_width
-      if @delegate_object[:screen_width] && @delegate_object[:screen_width].positive?
-        @delegate_object[:screen_width]
+      width = @delegate_object[:screen_width]
+      if width && width.positive?
+        width
       else
         @delegate_object[:console_width]
       end
     end
 
     def screen_width_for_table
-      screen_width - prompt_margin_left_width - prompt_margin_right_width - 2 # prompt is symbol + space (width: 2)
+      # menu adds newline after some lines if sized to the edge
+      screen_width - prompt_margin_left_width - prompt_margin_right_width - 3 # menu prompt symbol (1) + space (1) + gap (1)
     end
 
     def screen_width_for_wrapping
@@ -3910,7 +4165,7 @@ module MarkdownExec
       disabled = if fcb_title_groups.fetch(:type, '') == BlockType::YAML
                    TtyMenu::DISABLE
                  else
-                   nil
+                   TtyMenu::ENABLE
                  end
 
       MarkdownExec::FCB.new(
@@ -4036,11 +4291,11 @@ module MarkdownExec
       @delegate_object.merge!(options)
     end
 
-    def vux_await_user_selection
+    def vux_await_user_selection(prior_answer: @dml_block_selection)
       @dml_block_state = load_cli_or_user_selected_block(
         all_blocks: @dml_blocks_in_file,
         menu_blocks: @dml_menu_blocks,
-        prior_answer: @dml_menu_default_dname
+        prior_answer: prior_answer
       )
       if !@dml_block_state
         # HashDelegator.error_handler('block_state missing', { abort: true })
@@ -4194,7 +4449,7 @@ module MarkdownExec
         @dml_link_state.block_name.present?
       @cli_block_name = @dml_link_state.block_name
       @dml_now_using_cli = @run_state.source.block_name_from_cli
-      @dml_menu_default_dname = nil
+      @dml_block_selection = nil
       @dml_block_state = SelectedBlockMenuState.new
       @doc_saved_lines_files = []
 
@@ -4512,7 +4767,9 @@ module MarkdownExec
       else
         # puts "? - Select a block to execute (or type #{$texit}
         #  to exit):"
-        return :break if vux_await_user_selection == :break
+        return :break if vux_await_user_selection(
+          prior_answer: @dml_block_selection
+        ) == :break
         return :break if @dml_block_state.block.nil? # no block matched
       end
       # puts "! - Executing block: #{data}"
@@ -4562,7 +4819,13 @@ module MarkdownExec
                             block.dname.include?(prior_answer)
                           end&.name
                         when Struct
-                          prior_answer.index || prior_answer.name
+                          if prior_answer.id
+                            menu_items.find_index do |block|
+                              block[:id] == prior_answer.id
+                            end + 1
+                          else
+                            prior_answer.index || prior_answer.name
+                          end
                         end
       # prior_answer value may not match if color is different from
       # originating menu (opts changed while processing)

data/lib/hierarchy_string.rb

@@ -3,10 +3,11 @@
 require_relative 'ansi_string'
 
 class TrackedString < String
-  attr_accessor :truncated
+  attr_accessor :exceeded, :truncated
 
   def initialize(str)
-    super(str)
+    super
+    @exceeded = false
     @truncated = false
   end
 end

data/lib/markdown_exec/version.rb

@@ -7,5 +7,5 @@ module MarkdownExec
   BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
   TAP_DEBUG = 'MDE_DEBUG'
-  VERSION = '2.7.5'
+  VERSION = '2.8.1'
 end

data/lib/markdown_exec.rb

@@ -256,7 +256,7 @@ module MarkdownExec
                         block_name_nick_match)
       return unless line.match(fenced_start_and_end_regex)
 
-      bm = NamedCaptureExtractor::extract_named_groups(line, block_name_match)
+      bm = NamedCaptureExtractor.extract_named_groups(line, block_name_match)
       return if bm.nil?
 
       name = bm[:title]
@@ -282,7 +282,6 @@ module MarkdownExec
     include StringUtil
 
     def initialize(options = {})
-      # ww0 'options', options, caller.deref
       @option_parser = nil
 
       @options = HashDelegator.new(options)
@@ -405,7 +404,7 @@ module MarkdownExec
     ## Executes the block specified in the options
     #
     def execute_block_with_error_handling
-      @options.register_console_attributes(@options)    
+      @options.register_console_attributes(@options)
       finalize_cli_argument_processing
       execute_initial_commands_and_main_loop(@options, @options.run_state)
     rescue FileMissingError
@@ -430,11 +429,9 @@ module MarkdownExec
     def execute_simple_commands(options, stage: nil)
       # !!p stage
       simple_commands(options).each do |key, (cstage, proc)|
-        if @options[key].is_a?(TrueClass) || @options[key].present?
-          if stage && stage == cstage
-            proc.call
-            return true
-          end
+        if (@options[key].is_a?(TrueClass) || @options[key].present?) && (stage && stage == cstage)
+          proc.call
+          return true
         end
       end
       false