markdown_exec 3.2.0 → 3.4.0

data/lib/fcb.rb

@@ -7,15 +7,23 @@ require_relative 'namer'
 BT_UX_FLD_REQUIRED = 'required'
 def parse_yaml_of_ux_block(
   data,
-  menu_format: nil,
   prompt: nil,
   validate: nil
 )
-  export = data['export']
-  export = data if export.nil?
-  name = export['name']
+  export = data if (export = data['export']).nil?
 
-  raise "Name is missing in UX block: #{data.inspect}" unless name.present?
+  # a single variable name is required to display a single value
+  menu_format = export['format'] || export['menu_format']
+  name = export['name']
+  # if name is missing, use the last key in the echo or exec hashes
+  if !name&.present?
+    name = if export['echo'].is_a? Hash
+             export['echo'].keys.last
+           elsif export['exec'].is_a? Hash
+             export['exec'].keys.last
+           end
+  end
+  raise "Name is missing in UX block: #{data.inspect}" unless name.present? || menu_format.present?
 
   OpenStruct.new(
     act: export['act'],
@@ -25,7 +33,7 @@ def parse_yaml_of_ux_block(
     exec: export['exec'],
     force: export['force'],
     init: export['init'],
-    menu_format: export['format'] || export['menu_format'] || menu_format,
+    menu_format: menu_format,
     name: name,
     prompt: export['prompt'] || prompt,
     readonly: export['readonly'].nil? ? false : export['readonly'],
@@ -75,14 +83,6 @@ module MarkdownExec
       full&.to_s&.pub_name(**kwargs)
     end
 
-    def body
-      @attrs[:body]
-    end
-
-    def body=(value)
-      @attrs[:body] = value
-    end
-
     def code_name_included?(*names)
       names.include?(@attrs[:oname])
     end
@@ -101,7 +101,6 @@ module MarkdownExec
     # 2024-08-04 match nickname
     # may not exist if block name is duplicated
     def delete_matching_name!(dependencies)
-      ####
       dependencies.delete(@attrs[:id]) ||
         dependencies.delete(@attrs[:dname]) ||
         dependencies.delete(@attrs[:nickname]) ||
@@ -137,6 +136,7 @@ module MarkdownExec
     # @return [Object] The modified functional code block with updated
     #  summary attributes.
     def for_menu!(
+      appopts:,
       block_calls_scan:,
       block_name_match:,
       block_name_nick_match:,
@@ -172,12 +172,19 @@ module MarkdownExec
           when Hash
             export = parse_yaml_of_ux_block(
               data,
-              menu_format: menu_format,
               prompt: prompt
             )
 
+            if !export.menu_format || export.menu_format.empty?
+              format_symbol = option_to_format_ux_block(export)
+              export.menu_format = appopts[format_symbol]
+              if !export.menu_format || export.menu_format.empty?
+                export.menu_format = appopts[:menu_ux_row_format]
+              end
+            end
+            @attrs[:oname] = oname = format(export.menu_format, export.to_h)
+
             @attrs[:center] = table_center
-            oname = @attrs[:oname] = format(export.menu_format, export.to_h)
             @attrs[:readonly] = export.readonly
           else
             # triggered by an empty or non-YAML block
@@ -190,7 +197,8 @@ module MarkdownExec
       end
 
       @attrs[:dname] = HashDelegator.indent_all_lines(
-        (yield oname, BLOCK_TYPE_COLOR_OPTIONS[@attrs[:type]]),
+        # yield the text and option name for the color
+        (yield oname, option_to_decorate_ux_block),
         @attrs[:indent]
       )
 
@@ -208,6 +216,38 @@ module MarkdownExec
       end.join("\n")
     end
 
+    def self.is_allow?(export)
+      export&.allow&.present?
+    end
+
+    def is_allow?
+      FCB.is_allow?(export)
+    end
+
+    def self.is_echo?(export)
+      export&.echo&.present?
+    end
+
+    def is_echo?
+      FCB.is_echo?(export)
+    end
+
+    def self.is_edit?(export)
+      export&.edit&.present?
+    end
+
+    def is_edit?
+      FCB.is_edit?(export)
+    end
+
+    def self.is_exec?(export)
+      export&.exec&.present?
+    end
+
+    def is_exec?
+      FCB.is_exec?(export)
+    end
+
     def self.act_source(export)
       # If `false`, the UX block is not activated.
       # If one of `:allow`, `:echo`, `:edit`, or `:exec` is specified,
@@ -215,18 +255,22 @@ module MarkdownExec
       # If not present, the default value is `:edit`.
       if export.act.nil?
         export.act = if export.init.to_s == 'false'
-                       if export.allow.present?
+                       # if export.allow.present?
+                       if FCB.is_allow?(export)
                          UxActSource::ALLOW
-                       elsif export.echo.present?
+                       # elsif export.echo.present?
+                       elsif FCB.is_echo?(export)
                          UxActSource::ECHO
-                       elsif export.edit.present?
+                       # elsif export.edit.present?
+                       elsif FCB.is_edit?(export)
                          UxActSource::EDIT
-                       elsif export.exec.present?
+                       # elsif export.exec.present?
+                       elsif FCB.is_exec?(export)
                          UxActSource::EXEC
                        else
                          UxActSource::EDIT
                        end
-                     elsif export.allow.present?
+                     elsif FCB.is_allow?(export)
                        UxActSource::ALLOW
                      else
                        UxActSource::EDIT
@@ -246,13 +290,15 @@ module MarkdownExec
       # `:allow`, `:default`, `:echo`, or `:exec` is present.
       if export.init.nil?
         export.init = case
-                      when export.allow.present?
+                      when FCB.is_allow?(export)
                         UxActSource::ALLOW
                       when export.default.present?
                         UxActSource::DEFAULT
-                      when export.echo.present?
+                      # when export.echo.present?
+                      when FCB.is_echo?(export)
                         UxActSource::ECHO
-                      when export.exec.present?
+                      # when export.exec.present?
+                      when FCB.is_exec?(export)
                         UxActSource::EXEC
                       else
                         UxActSource::FALSE
@@ -265,7 +311,8 @@ module MarkdownExec
     # :reek:ManualDispatch
     # 2024-08-04 match nickname
     def is_dependency_of?(dependency_names)
-      dependency_names.include?(@attrs[:dname]) ||
+      dependency_names.include?(@attrs[:id]) ||
+        dependency_names.include?(@attrs[:dname]) ||
         dependency_names.include?(@attrs[:nickname]) ||
         dependency_names.include?(@attrs[:oname]) ||
         dependency_names.include?(@attrs.pub_name) ||
@@ -281,12 +328,16 @@ module MarkdownExec
     end
 
     def is_named?(name)
-      @attrs[:id] == name ||
-        @attrs[:dname] == name ||
-        @attrs[:nickname] == name ||
-        @attrs[:oname] == name ||
-        @attrs.pub_name == name ||
-        @attrs[:s2title] == name
+      if /^ItrBlk/.match(name)
+        @attrs[:id] == name
+      else
+        @attrs[:id] == name ||
+          @attrs[:dname] == name ||
+          @attrs[:nickname] == name ||
+          @attrs[:oname] == name ||
+          @attrs.pub_name == name ||
+          @attrs[:s2title] == name
+      end
     end
 
     # true if this is a line split block
@@ -343,6 +394,54 @@ module MarkdownExec
         end
     end
 
+    # calc the decoration sybol for the current block
+    def option_to_decorate_ux_block
+      symbol_or_hash = BLOCK_TYPE_COLOR_OPTIONS[@attrs[:type]]
+      if @attrs[:type] == BlockType::UX
+        # only UX blocks accept a symbol or a hash
+        if symbol_or_hash.is_a? Hash
+          # default to the first symbol
+          symbol = symbol_or_hash.first.last
+          symbol_or_hash.each_key do |key|
+            if key == true
+              symbol = symbol_or_hash[key]
+              break
+            elsif symbol_or_hash[key].present? && send(key)
+              symbol = symbol_or_hash[key]
+              break
+            end
+          end
+          symbol
+        else
+          # only symbol
+          symbol_or_hash
+        end
+      else
+        # only symbol
+        symbol_or_hash
+      end
+    end
+
+    def option_to_format_ux_block(export)
+      if export.readonly
+        :menu_ux_row_format_readonly
+      else
+        case FCB.act_source(export)
+        when UxActSource::ALLOW
+          :menu_ux_row_format_allow
+        when UxActSource::ECHO
+          :menu_ux_row_format_echo
+        when UxActSource::EDIT
+          :menu_ux_row_format_edit
+        when UxActSource::EXEC
+          :menu_ux_row_format_exec
+        else
+          # this UX block does not have a format, treat as editable
+          :menu_ux_row_format_edit
+        end
+      end
+    end
+
     def respond_to_missing?(method_name, include_private = false)
       @attrs.key?(method_name.to_sym) || super
     end
@@ -392,6 +491,7 @@ module MarkdownExec
       # Replace variables in each line of `body` if `body` is present
       return unless @attrs[:body]
 
+      # save body for YAML and re-interpretation
       @attrs[:raw_body] ||= @attrs[:body]
       @attrs[:body] = @attrs[:body]&.map do |line|
         if line.empty?

data/lib/format_table.rb

@@ -141,8 +141,11 @@ module MarkdownTableFormatter
   end
 
   def format_table__hs(
-    lines:, column_count:, decorate: nil,
-    table_width: nil,
+    column_count:,
+    decorate: nil,
+    lines:,
+    max_table_width: nil,
+    table:,
     truncate: true
   )
     unless column_count.positive?
@@ -152,18 +155,33 @@ module MarkdownTableFormatter
       end
     end
 
-    rows = raw_lines_into_row_role_cells(lines, column_count)
+    rows = raw_lines_into_row_role_cells(
+      lines, column_count, delimiter: table[:delimiter]
+    )
 
     alignment_indicators, column_widths =
       calculate_column_alignment_and_widths(rows, column_count)
 
-    unless table_width.nil?
-      sum_column_widths = column_widths.sum + ((column_count * 3) + 5)
-      if sum_column_widths > table_width
-        ratio = table_width.to_f / sum_column_widths
+    unless max_table_width.nil?
+      # each column has a frame width of 3 characters
+      # border and space before and after each and 1 final border
+      borders_width = (column_count * 3) + 1
+
+      full_column_table_width = column_widths.sum + borders_width
+
+      if full_column_table_width > max_table_width
+        text_width_sum = full_column_table_width - borders_width
+        available_text_width = max_table_width - borders_width
+        ratio = available_text_width.to_f / text_width_sum
+
+        # distribute the width across the columns
         column_widths.each_with_index do |width, i|
           column_widths[i] = (width * ratio).to_i
         end
+
+        # the last column fills the remaining width
+        column_widths[column_widths.count - 1] =
+          available_text_width - column_widths.sum + column_widths.last
       end
     end
 
@@ -182,18 +200,22 @@ module MarkdownTableFormatter
     result
   end
 
-  def raw_lines_into_row_role_cells(lines, column_count)
+  def raw_lines_into_row_role_cells(
+    lines, column_count, delimiter:
+  )
     role = :header_row
     counter = -1
 
     ret = []
     lines.each do |line|
-      line += '|' unless line.end_with?('|')
+      line += delimiter unless line.end_with?(delimiter)
+
       counter += 1
 
       role = role_for_raw_row(role, line)
       counter = reset_counter_if_needed(role, counter)
-      cells = split_decorated_row_into_cells(line, column_count)
+      cells = split_decorated_row_into_cells(line, column_count,
+                                             delimiter: delimiter)
       ret << OpenStruct.new(cells: cells, role: role, counter: counter)
     end
     ret
@@ -220,8 +242,8 @@ module MarkdownTableFormatter
     end
   end
 
-  def split_decorated_row_into_cells(line, column_count)
-    cells = line.split('|').map(&:strip)[1..-1]
+  def split_decorated_row_into_cells(line, column_count, delimiter: '|')
+    cells = line.split(delimiter).map(&:strip)[1..-1]
     cells&.slice(0, column_count)&.fill('', cells.length...column_count)
   end
 end
@@ -229,6 +251,7 @@ end
 return if $PROGRAM_NAME != __FILE__
 
 require 'minitest/autorun'
+require_relative 'ww'
 
 class TestMarkdownTableFormatter < Minitest::Test
   def setup
@@ -239,11 +262,12 @@ class TestMarkdownTableFormatter < Minitest::Test
       '| Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3 |'
     ]
     @column_count = 3
+    @table = { delimiter: '|' }
   end
 
   def test_format_table
     result = MarkdownTableFormatter.format_table(
-      column_count: @column_count, lines: @lines
+      column_count: @column_count, lines: @lines, table: @table
     )
     expected = [
       '| Header 1    |  Header 2   |    Header 3 |',
@@ -259,7 +283,8 @@ class TestMarkdownTableFormatter < Minitest::Test
     result = MarkdownTableFormatter.format_table(
       column_count: @column_count,
       decorate: decorate,
-      lines: @lines
+      lines: @lines,
+      table: @table
     )
     expected = [
       '| HEADER 1    |  HEADER 2   |    HEADER 3 |',
@@ -280,7 +305,8 @@ class TestMarkdownTableFormatter < Minitest::Test
     ]
     result = MarkdownTableFormatter.format_table(
       lines: lines_with_empty,
-      column_count: @column_count
+      column_count: @column_count,
+      table: @table
     )
     expected = [
       '| Header 1    |  Header 2   |    Header 3 |',
@@ -299,7 +325,8 @@ class TestMarkdownTableFormatter < Minitest::Test
     ]
     result = MarkdownTableFormatter.format_table(
       lines: lines_with_alignment,
-      column_count: @column_count
+      column_count: @column_count,
+      table: @table
     )
     expected = [
       '| Header 1  |  Header 2  |  Header 3 |',
@@ -310,6 +337,10 @@ class TestMarkdownTableFormatter < Minitest::Test
 end
 
 class TestFormatTable < Minitest::Test
+  def setup
+    @table = { delimiter: '|' }
+  end
+
   def test_basic_formatting
     lines = [
       '| Species| Genus| Family',
@@ -326,7 +357,8 @@ class TestFormatTable < Minitest::Test
     ]
     assert_equal expected, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: column_count
+      column_count: column_count,
+      table: @table
     )
   end
 
@@ -344,7 +376,8 @@ class TestFormatTable < Minitest::Test
     ]
     assert_equal expected, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: column_count
+      column_count: column_count,
+      table: @table
     )
   end
 
@@ -358,13 +391,15 @@ class TestFormatTable < Minitest::Test
   #     "| A | B | C ",
   #     "| 1 | 2 | 3 "
   #   ]
-  #   assert_equal expected, MarkdownTableFormatter.format_table(lines, column_count)
+  #   assert_equal expected,
+  #    MarkdownTableFormatter.format_table(lines, column_count)
   # end
 
   def test_empty_input
     assert_equal [], MarkdownTableFormatter.format_table(
       lines: [],
-      column_count: 3
+      column_count: 3,
+      table: @table
     )
   end
 
@@ -382,7 +417,8 @@ class TestFormatTable < Minitest::Test
     ]
     assert_equal expected, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: column_count
+      column_count: column_count,
+      table: @table
     )
   end
 
@@ -398,12 +434,17 @@ class TestFormatTable < Minitest::Test
     ]
     assert_equal expected, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: column_count
+      column_count: column_count,
+      table: @table
     )
   end
 end
 
 class TestFormatTable2 < Minitest::Test
+  def setup
+    @table = { delimiter: '|' }
+  end
+
   def test_basic_formatting
     lines = [
       '| Name | Age | City |',
@@ -417,7 +458,8 @@ class TestFormatTable2 < Minitest::Test
     ]
     assert_equal expected_output, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: 3
+      column_count: 3,
+      table: @table
     )
   end
 
@@ -434,7 +476,8 @@ class TestFormatTable2 < Minitest::Test
     ]
     assert_equal expected_output, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: 3
+      column_count: 3,
+      table: @table
     )
   end
 
@@ -451,7 +494,8 @@ class TestFormatTable2 < Minitest::Test
     ]
     assert_equal expected_output, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: 4
+      column_count: 4,
+      table: @table
     )
   end
 
@@ -468,7 +512,8 @@ class TestFormatTable2 < Minitest::Test
     ]
     assert_equal expected_output, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: 3
+      column_count: 3,
+      table: @table
     )
   end
 
@@ -477,7 +522,8 @@ class TestFormatTable2 < Minitest::Test
     expected_output = ['| Name | Age | City |']
     assert_equal expected_output, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: 3
+      column_count: 3,
+      table: @table
     )
   end
 
@@ -486,7 +532,8 @@ class TestFormatTable2 < Minitest::Test
     expected_output = []
     assert_equal expected_output, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: 3
+      column_count: 3,
+      table: @table
     )
   end
 
@@ -501,7 +548,8 @@ class TestFormatTable2 < Minitest::Test
     ]
     assert_equal expected_output, MarkdownTableFormatter.format_table(
       lines: lines,
-      column_count: 3
+      column_count: 3,
+      table: @table
     )
   end
 end

data/lib/fout.rb

@@ -33,6 +33,11 @@ class FOut
     puts str
   end
 
+  # `puts` guarantees exactly one line break per item it prints. For each
+  # argument (and for each element when given an Array), it appends a newline
+  # only if the string does not already end with "\n". If it does, `puts`
+  # does not add another. Net effect: trailing newlines in your data are
+  # consumed rather than duplicated, so "Line\n" does not create a blank line.
   def fout_list(str)
     puts str
   end