markdown_exec 2.8.2 → 2.8.4

data/docs/dev/block-type-ux-echo-hash.md

@@ -0,0 +1,72 @@
+/ This automatic block sets multiple variables and displays the first variable.
+```ux :[document_ux_BASENAME]
+default: :echo
+echo:
+  BASENAME: "$(basename `pwd`)"
+  DOCUMENTS: "${BASENAME%%_*}"
+  OPERATION: "${BASENAME##*_}"
+name: BASENAME
+readonly: true
+```
+/ This block displays the second variable in the first block.
+```ux :[DOCUMENTS]
+name: DOCUMENTS
+readonly: true
+```
+/ This block displays the third variable in the first block.
+```ux :[OPERATION]
+name: OPERATION
+readonly: true
+```
+/ Multiple UX blocks to set many variables for a specific name.
+```ux
+echo:
+  Species: Pongo tapanuliensis
+  Genus: Pongo
+  Family: Hominidae
+  Order: Primates
+  Class: Mammalia
+  Phylum: Chordata
+  Kingdom: Animalia
+  Domain: Eukaryota
+  Year_Discovered: 2017
+menu_format: 'Load %{name}'
+name: Tapanuli Orangutan
+```
+```ux
+echo:
+  Species: Histiophryne psychedelica
+  Genus: Histiophryne
+  Family: Antennariidae
+  Order: Lophiiformes
+  Class: Actinopterygii
+  Phylum: Chordata
+  Kingdom: Animalia
+  Domain: Eukaryota
+  Year_Discovered: 2009
+menu_format: 'Load %{name}'
+name: Psychedelic Frogfish
+```
+/ Start a table to format the output of UX blocks
+| Variable| Value
+| -| -
+/ A read-only variable in a UX block in a table
+```ux
+menu_format: '| %{name}| ${%{name}}'
+name: Species
+readonly: true
+```
+/ A table row displays one variable in a table
+| Genus| ${Genus}
+/ An editable variable in a UX block in a table
+```ux
+menu_format: '| %{name}| ${%{name}}'
+name: Family
+```
+@import bats-document-configuration.md
+```opts :(document_opts)
+# menu_ux_row_format: '| %{name}| ${%{name}}'
+screen_width: 64
+table_center: false
+ux_auto_load_force_default: true
+```

data/docs/dev/block-type-ux-echo.md

@@ -0,0 +1,21 @@
+/ This automatic block sets VAR and displays the current value in the menu.
+```ux :[document_ux_VAR]
+default: :echo
+echo: $(basename `pwd`)
+name: VAR
+```
+/ This block is not visible. Execute to display the inherited lines for testing.
+```opts :(menu_with_inherited_lines)
+menu_with_inherited_lines: true
+```
+/ This block is not visible. Execute to set a new value, displayed by the block above.
+```ux :(VAR_has_count)
+echo: $(basename `pwd` | wc -c)
+name: VAR
+```
+/ This block is visible. Execute to set a new value, displayed by the block above.
+```ux :[IAB_has_count]
+echo: $VAR$VAR
+name: IAB
+```
+@import bats-document-configuration.md

data/docs/dev/block-type-ux-hidden.md

@@ -0,0 +1,21 @@
+/ a UX block requires a shell block and another UX block
+``` :(shell)
+ENTITY='Pongo tapanuliensis,Pongo'
+```
+```ux :[SPECIES] +(shell) +(GENUS)
+echo: "${ENTITY%%,*}"
+name: SPECIES
+```
+/ required ux block requires another
+```ux :(GENUS) +[NAME]
+echo: "${ENTITY##*,}"
+name: GENUS
+readonly: true
+```
+/ executed in context of prior ux blocks, uses their values
+```ux :[NAME]
+echo: "$SPECIES - $GENUS"
+name: NAME
+readonly: true
+```
+@import bats-document-configuration.md

data/docs/dev/block-type-ux-invalid.md

@@ -0,0 +1,5 @@
+/ automatic block is invalid YAML
+```ux :[document_ux_SPECIES]
+invalid
+```
+@import bats-document-configuration.md

data/docs/dev/block-type-ux-preconditions.md

@@ -0,0 +1,9 @@
+/ an automatic UX block that has a precondition that must be met before it is executed
+```ux :[document_ux_SPECIES]
+default: :exec
+exec: printf "$MISSING_VARIABLE"
+name: SPECIES
+preconditions:
+- MISSING_VARIABLE
+```
+@import bats-document-configuration.md

data/docs/dev/block-type-ux-readonly.md

@@ -0,0 +1,7 @@
+/ This automatic block sets VAR and displays the current value in the menu.
+```ux :[document_ux_VAR]
+default: Pongo tapanuliensis
+name: SPECIES
+readonly: true
+```
+@import bats-document-configuration.md

data/docs/dev/block-type-ux-require.md

@@ -4,25 +4,29 @@ ENTITY='Pongo tapanuliensis,Pongo'
 ```
 ```ux :[document_ux_SPECIES] +(shell) +[ux_GENUS]
 default: :exec
-exec: printf "${ENTITY%%,*}"
+exec: echo "${ENTITY%%,*}"
 name: SPECIES
+transform: :chomp
 ```
 / required ux block requires another
 ```ux :[ux_GENUS] +[ux_NAME]
 default: :exec
-exec: printf "${ENTITY##*,}"
+exec: echo "${ENTITY##*,}"
 name: GENUS
+transform: :chomp
 ```
 / executed in context of prior ux blocks, uses their initial values
 ```ux :[ux_NAME]
 default: :exec
-exec: printf "$SPECIES - $GENUS"
+exec: echo "$SPECIES - $GENUS"
 name: NAME
+transform: :chomp
 ```
 / executed after other ux blocks, uses their initial values
 ```ux :[document_ux_NAME2]
 default: :exec
-exec: printf "$NAME"
+exec: echo "$NAME"
 name: NAME2
+transform: :chomp
 ```
 @import bats-document-configuration.md

data/docs/dev/indented-block-type-vars.md

@@ -0,0 +1,6 @@
+/ All lines of an indented block must have equal indents.
+  ```vars
+  Species: Pongo tapanuliensis
+  Genus: Pongo
+  ```
+@import bats-document-configuration.md

data/docs/dev/indented-multi-line-output.md

@@ -0,0 +1,11 @@
+/ Retain whitespace in output from shell blocks
+``` :[make-output]
+echo 'Species'
+echo -e " Genus\n  Family\tOrder"
+```
+@import bats-document-configuration.md
+```opts :(document_opts)
+line_decor_pre:
+  - :color_method: :ansi_38_2_200_200_33__48_2_60_60_32__0
+    :pattern: '%([^_]{0,64})%'
+```

data/docs/dev/line-decor-dynamic.md

@@ -0,0 +1,10 @@
+/ Demonstrate dynamic color names
+/ line_decor_pre is performed before line_decor_main and line_decor_post
+%Species%
+@import bats-document-configuration.md
+```opts :(document_opts)
+line_decor_pre:
+  # bold italicized bright yellow text on light yellow background
+  - :color_method: :ansi_1__3__38_2_200_200_33__48_2_60_60_32__22_23_0
+    :pattern: '%([^_]{0,64})%'
+```

data/docs/dev/variable-expansion-multiline.md

@@ -0,0 +1,31 @@
+/ assign a multiline string
+```vars :(document_vars)
+Genus2: |
+  Pongo
+  Pongo
+```
+/
+/ display the variable
+__UX block__:
+```ux
+name: Genus2
+readonly: true
+```
+/
+/ Confirm the string contains a newline `0a`
+__Command substitution__:
+Genus2 hex: $(printf "$Genus2" | hexdump -C)
+/
+/ output with substitution
+__Command substitution__:
+Genus2 text: $(printf "$Genus2")
+/
+/ output with substitution
+__Command substitution__:
+$(ls -1 G*)
+/
+/ output with expansion
+__Variable expansion__:
+Genus2 text: ${Genus2}
+/
+@import bats-document-configuration.md

data/lib/ansi_formatter.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/ansi_string.rb

@@ -14,6 +14,15 @@ class AnsiString < String
   def method_missing(method_name, *args, &block)
     if dynamic_color_method?(method_name)
       case method_name.to_s
+      when /^ansi_/
+        segments = $'.split('__')
+        codes = ''
+        segments[0..-2].each do |segment|
+          codes += "\033[#{segment.split('_').join(';')}m"
+        end
+        codes += to_s
+        codes += "\033[#{segments.last.split('_').join(';')}m"
+        self.class.new(codes)
       when /^fg_bg_rgb_/
         bytes = $'.split('_')
         fg_bg_rgb_color(bytes[0..2].join(';'), bytes[3..5].join(';'))
@@ -148,6 +157,6 @@ class AnsiString < String
   # @param method_name [Symbol] The name of the method being checked.
   # @return [Boolean] True if the method name matches a dynamic color method.
   def dynamic_color_method?(method_name)
-    method_name.to_s =~ /^(fg_bg_rgb_|fg_bg_rgbh_|fg_rgb_|fg_rgbh_)/
+    method_name.to_s =~ /^(ansi_|fg_bg_rgb_|fg_bg_rgbh_|fg_rgb_|fg_rgbh_)/
   end
 end

data/lib/array.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/array_util.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/block_label.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/cached_nested_file_reader.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/constants.rb

@@ -103,6 +103,24 @@ end
 BlockSelection = Struct.new(:id)
 SelectedBlockMenuState = Struct.new(:block, :source, :state)
 
+# user responses to prompts to choose
+class SelectResponse
+  def initialize(value)
+    @value = value
+  end
+
+  def continue?
+    @value == :ok
+  end
+
+  def self.continue?(value)
+    !value.is_a?(SelectResponse) || value.continue?
+  end
+end
+
+SelectResponse::BACK = SelectResponse.new(:back)
+SelectResponse::OK = SelectResponse.new(:ok)
+
 class TtyMenu
   ENABLE = nil
   DISABLE = ''

data/lib/directory_searcher.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/exceptions.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/fcb.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8
@@ -20,11 +20,13 @@ def parse_yaml_of_ux_block(
   OpenStruct.new(
     allowed: export['allowed'],
     default: export['default'],
+    echo: export['echo'],
     exec: export['exec'],
     menu_format: export['menu_format'] || menu_format,
     name: name,
     preconditions: export['preconditions'],
     prompt: export['prompt'] || prompt,
+    readonly: export['readonly'].nil? ? false : export['readonly'],
     transform: export['transform'],
     validate: export['validate'] || validate
   )
@@ -72,6 +74,19 @@ module MarkdownExec
       @attrs.delete(key)
     end
 
+    # Removes and returns the first matching name from dependencies collection
+    # Checks nickname, oname, pub_name and s2title
+    # 2024-08-04 match oname for long block names
+    # 2024-08-04 match nickname
+    # may not exist if block name is duplicated
+    def delete_matching_name!(dependencies)
+      dependencies.delete(@attrs[:dname]) ||
+        dependencies.delete(@attrs[:nickname]) ||
+        dependencies.delete(@attrs[:oname]) ||
+        dependencies.delete(@attrs.pub_name) ||
+        dependencies.delete(@attrs[:s2title])
+    end
+
     # Derives a title from the body of an FCB object.
     # @param fcb [Object] The FCB object whose title is to be derived.
     # @return [String] The derived title.
@@ -137,9 +152,10 @@ module MarkdownExec
 
           @attrs[:center] = table_center
           oname = @attrs[:oname] = format(export.menu_format, export.to_h)
+          @attrs[:readonly] = export.readonly
         else
-          # triggered by an empty block
-          raise "Invalid data type: #{data.inspect}"
+          # triggered by an empty or non-YAML block
+          return NullResult.new(message: 'Invalid YAML', data: data)
         end
       end
 
@@ -147,9 +163,9 @@ module MarkdownExec
         (yield oname, BLOCK_TYPE_COLOR_OPTIONS[@attrs[:type]]),
         @attrs[:indent]
       )
-    end
 
-    private
+      SuccessResult.instance
+    end
 
     # Formats multiline body content as a title string.
     # indents all but first line with two spaces
@@ -162,6 +178,24 @@ module MarkdownExec
       end.join("\n") << "\n"
     end
 
+    # :reek:ManualDispatch
+    # 2024-08-04 match nickname
+    def is_dependency_of?(dependency_names)
+      dependency_names.include?(@attrs[:dname]) ||
+        dependency_names.include?(@attrs[:nickname]) ||
+        dependency_names.include?(@attrs[:oname]) ||
+        dependency_names.include?(@attrs.pub_name) ||
+        dependency_names.include?(@attrs[:s2title])
+    end
+
+    def is_named?(name)
+      @attrs[:dname] == name ||
+        @attrs[:nickname] == name ||
+        @attrs[:oname] == name ||
+        @attrs.pub_name == name ||
+        @attrs[:s2title] == name
+    end
+
     # :reek:ManualDispatch
     def method_missing(method, *args, &block)
       method_name = method.to_s
@@ -180,7 +214,16 @@ module MarkdownExec
       raise err
     end
 
-    public
+    def name_in_menu!(indented_multi_line)
+      # Indent has been extracted from the first line,
+      # remove indent from the remaining lines.
+      @attrs[:dname] =
+        if @attrs[:indent].empty?
+          indented_multi_line
+        else
+          indented_multi_line.gsub("\n#{@attrs[:indent]}", "\n")
+        end
+    end
 
     def respond_to_missing?(method_name, include_private = false)
       @attrs.key?(method_name.to_sym) || super
@@ -256,8 +299,8 @@ if $PROGRAM_NAME == __FILE__
   end
 
   def sort_hash_recursively(hash)
-    hash.each_with_object({}) do |(k, v), new_hash|
-      new_hash[k] = v.is_a?(Hash) ? sort_hash_recursively(v) : v
+    hash.transform_values do |v|
+      v.is_a?(Hash) ? sort_hash_recursively(v) : v
     end.sort.to_h
   end
 

data/lib/filter.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8
@@ -123,12 +123,12 @@ module MarkdownExec
     #
     def self.apply_other_filters(options, filters, fcb)
       name = fcb.oname
-      shell = fcb.shell
       filters[:fcb_chrome] = fcb.fetch(:chrome, false)
       filters[:shell_default] = (fcb.type == BlockType::SHELL)
 
-      if options[:block_disable_match].present? &&
-         fcb.start_line =~ Regexp.new(options[:block_disable_match])
+      if fcb.readonly ||
+         (options[:block_disable_match].present? &&
+          fcb.start_line =~ Regexp.new(options[:block_disable_match]))
         fcb.disabled = TtyMenu::DISABLE
       end
       return unless name.present?

data/lib/format_table.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 require 'ostruct'

data/lib/fout.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/hash.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # encoding=utf-8