markdown_exec 2.8.3 → 2.8.5

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-require.md

@@ -1,32 +1,23 @@
-/ an automatic UX block requires a shell block and another UX block
+/ This is an hidden shell block that is required by UX blocks.
 ``` :(shell)
 ENTITY='Pongo tapanuliensis,Pongo'
 ```
-```ux :[document_ux_SPECIES] +(shell) +[ux_GENUS]
-default: :exec
-exec: echo "${ENTITY%%,*}"
+```ux +(shell)
+echo: "${ENTITY%%,*}"
 name: SPECIES
-transform: :chomp
 ```
-/ required ux block requires another
-```ux :[ux_GENUS] +[ux_NAME]
-default: :exec
-exec: echo "${ENTITY##*,}"
+```ux +(shell)
+echo: "${ENTITY##*,}"
 name: GENUS
-transform: :chomp
 ```
 / executed in context of prior ux blocks, uses their initial values
-```ux :[ux_NAME]
-default: :exec
-exec: echo "$SPECIES - $GENUS"
+```ux
+echo: "$SPECIES - $GENUS"
 name: NAME
-transform: :chomp
 ```
 / executed after other ux blocks, uses their initial values
-```ux :[document_ux_NAME2]
-default: :exec
-exec: echo "$NAME"
+```ux
+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/line-decor-dynamic.md

@@ -4,6 +4,7 @@
 @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
+  # 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

@@ -20,7 +20,7 @@ class AnsiString < String
         segments[0..-2].each do |segment|
           codes += "\033[#{segment.split('_').join(';')}m"
         end
-        codes += self.to_s
+        codes += to_s
         codes += "\033[#{segments.last.split('_').join(';')}m"
         self.class.new(codes)
       when /^fg_bg_rgb_/

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
@@ -48,6 +48,7 @@ module MarkdownExec
         call: nil,
         dname: nil,
         headings: [],
+        id: object_id,
         indent: '',
         name: nil,
         nickname: nil,
@@ -62,6 +63,15 @@ module MarkdownExec
       }.merge(options)
     end
 
+    def pub_name(**kwargs)
+      self.class.pub_name(@attrs, **kwargs)
+    end
+
+    def self.pub_name(attrs, **kwargs)
+      full = attrs.fetch(:nickname, nil) || attrs.fetch(:oname, nil)
+      full&.to_s&.pub_name(**kwargs)
+    end
+
     def code_name_included?(*names)
       names.include?(@attrs[:oname])
     end
@@ -74,6 +84,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.
@@ -141,8 +164,8 @@ module MarkdownExec
           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
 
@@ -150,6 +173,8 @@ module MarkdownExec
         (yield oname, BLOCK_TYPE_COLOR_OPTIONS[@attrs[:type]]),
         @attrs[:indent]
       )
+
+      SuccessResult.instance
     end
 
     # Formats multiline body content as a title string.
@@ -163,6 +188,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
@@ -181,8 +224,6 @@ 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.
@@ -300,13 +341,15 @@ if $PROGRAM_NAME == __FILE__
     end
 
     def test_to_h_method
-      assert_equal_hash @fcb_data.merge({ random: @fcb.random }), @fcb.to_h
+      assert_equal_hash @fcb_data.merge(
+        { id: @fcb.id, random: @fcb.random }
+      ), @fcb.to_h
     end
 
     def test_to_yaml_method
-      assert_equal_hash YAML.load(@fcb_data.merge({ random: @fcb.random })
-                                           .to_yaml),
-                        YAML.load(@fcb.to_yaml)
+      assert_equal_hash YAML.load(@fcb_data.merge(
+        { id: @fcb.id, random: @fcb.random }
+      ).to_yaml), YAML.load(@fcb.to_yaml)
     end
 
     def test_method_missing_getter

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,7 +123,6 @@ 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)
 

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