markdown_exec 2.0.8.4 → 2.2.0

data/lib/saved_assets.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 # encoding=utf-8
+require_relative 'namer'
 
 module MarkdownExec
   # SavedAsset
@@ -12,23 +13,49 @@ module MarkdownExec
   # method derives a name for stdout redirection.
   #
   class SavedAsset
-    FNR11 = %r{[^!#%&()\+,\-0-9=A-Z_a-z~]}.freeze
-    # / !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
-    FNR12 = '_'
     DEFAULT_FTIME = '%F-%H-%M-%S'
+    FILE_BLOCK_SEP = ','
+    JOIN_STR = '_'
+    MARK_STR = '~'
 
-    # Generates a formatted script name based on the provided parameters.
-    def self.script_name(filename:, prefix:, time:, blockname:, ftime: DEFAULT_FTIME, join_str: '_', pattern: FNR11, replace: FNR12, exts: '.sh')
-      fne = filename.gsub(pattern, replace)
-      bne = blockname.gsub(pattern, replace)
-      "#{[prefix, time.strftime(ftime), fne, ',', bne].join(join_str)}#{exts}"
+    # @param filename [String] the name of the file
+    # @param prefix [String] the prefix to use
+    # @param time [Time] the time object for formatting
+    # @param blockname [String] the block name to include
+    # @param ftime [String] the time format (default: DEFAULT_FTIME)
+    # @param exts [String] the extension to append (default: '.sh')
+    def initialize(
+      saved_asset_format:, filename: nil, prefix: nil, time: nil, blockname: nil,
+      ftime: DEFAULT_FTIME, exts: nil,
+      mark: nil, join_str: nil
+    )
+      @filename = filename ? filename.pub_name : '*' # [String] the name of the file
+      @prefix = prefix || '*' # [String] the prefix to use
+      @time = time ? time.strftime(ftime) : '*' # [Time] the time object for formatting
+      @blockname = blockname ? blockname.pub_name : '*' # [String] the block name to include
+      # @ftime = ftime # [String] the time format (default: DEFAULT_FTIME)
+      @exts = exts || '.*' # [String] the extension to append (default: '.sh')
+      @mark = mark || MARK_STR
+      @join_str = join_str || JOIN_STR
+      @saved_asset_format = saved_asset_format
     end
 
-    # Generates a formatted stdout name based on the provided parameters.
-    def self.stdout_name(filename:, prefix:, time:, blockname:, ftime: DEFAULT_FTIME, join_str: '_', pattern: FNR11, replace: FNR12, exts: '.out.txt')
-      fne = filename.gsub(pattern, replace)
-      bne = blockname.gsub(pattern, replace)
-      "#{[prefix, time.strftime(ftime), fne, ',', bne].join(join_str)}#{exts}"
+    # Generates a formatted name based on the provided parameters.
+    #
+    # @return [String] the generated formatted name
+    def generate_name
+      format(
+        @saved_asset_format,
+        {
+          blockname: @blockname,
+          exts: @exts,
+          filename: @filename,
+          join: @join_str,
+          mark: @mark,
+          prefix: @prefix,
+          time: @time
+        }
+      )
     end
   end
 end
@@ -61,4 +88,76 @@ class SavedAssetTest < Minitest::Test
       filename: filename, prefix: prefix, time: time, blockname: blockname
     )
   end
+
+  def test_wildcard_name_with_all_parameters
+    filename = 'sample.txt'
+    prefix = 'test'
+    time = Time.new(2023, 1, 1, 12, 0, 0)
+    blockname = 'block/1:2'
+    expected_wildcard = 'test_2023-01-01-12-00-00_sample_txt_,_block_1_2.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_missing_time
+    filename = 'sample.txt'
+    prefix = 'test'
+    time = nil
+    blockname = 'block/1:2'
+    expected_wildcard = 'test_*_sample_txt_,_block_1_2.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_missing_filename
+    filename = nil
+    prefix = 'test'
+    time = Time.new(2023, 1, 1, 12, 0, 0)
+    blockname = 'block/1:2'
+    expected_wildcard = 'test_2023-01-01-12-00-00_*_,_block_1_2.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_missing_prefix
+    filename = 'sample.txt'
+    prefix = nil
+    time = Time.new(2023, 1, 1, 12, 0, 0)
+    blockname = 'block/1:2'
+    expected_wildcard = '*_2023-01-01-12-00-00_sample_txt_,_block_1_2.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_missing_blockname
+    filename = 'sample.txt'
+    prefix = 'test'
+    time = Time.new(2023, 1, 1, 12, 0, 0)
+    blockname = nil
+    expected_wildcard = 'test_2023-01-01-12-00-00_sample_txt_,_*.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_all_missing
+    filename = nil
+    prefix = nil
+    time = nil
+    blockname = nil
+    expected_wildcard = '*_*_*_,_*.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
 end

data/lib/streams_out.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+class StreamsOut
+  attr_accessor :streams
+
+  def initialize
+    @streams = []
+  end
+
+  def append_stream_line(stream, line)
+    @streams << { stream: stream, line: line, timestamp: Time.now }
+  end
+
+  def write_execution_output_to_file(filespec)
+    FileUtils.mkdir_p File.dirname(filespec)
+
+    output = @streams.map do |entry|
+      case entry[:stream]
+      when ExecutionStreams::STD_OUT
+        entry[:line]
+        # "OUT: #{entry[:line]}"
+      when ExecutionStreams::STD_ERR
+        entry[:line]
+        # "ERR: #{entry[:line]}"
+      when ExecutionStreams::STD_IN
+        entry[:line]
+        # " IN: #{entry[:line]}"
+      end
+    end.join("\n")
+
+    File.write(filespec, output)
+  end
+end

data/lib/string_util.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 # encoding=utf-8
-
 module StringUtil
   # Splits the given string on the first occurrence of the specified character.
   # Returns an array containing the portion of the string before the character and the rest of the string.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.0.8.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -113,8 +113,11 @@ files:
 - bin/setup
 - bin/tab_completion.sh
 - bin/tab_completion.sh.erb
+- examples/bash-blocks.md
+- examples/block-names.md
 - examples/block_names.md
 - examples/colors.md
+- examples/data-files.md
 - examples/document_options.md
 - examples/duplicate_block.md
 - examples/import0.md
@@ -124,6 +127,9 @@ files:
 - examples/index.md
 - examples/interrupt.md
 - examples/line-wrapping.md
+- examples/link-blocks-block.md
+- examples/link-blocks-load-save.md
+- examples/link-blocks-vars.md
 - examples/linked.md
 - examples/linked1.md
 - examples/linked2.md
@@ -134,13 +140,16 @@ files:
 - examples/load2.sh
 - examples/load_code.md
 - examples/nickname.md
-- examples/opts.md
-- examples/pass-through.md
+- examples/opts-blocks-require.md
+- examples/opts-blocks.md
+- examples/opts_output_execution.md
+- examples/pass-through-arguments.md
 - examples/pause-after-execution.md
 - examples/plant.md
-- examples/port.md
+- examples/port-blocks.md
+- examples/save.md
 - examples/search.md
-- examples/vars.md
+- examples/vars-blocks.md
 - examples/wrap.md
 - lib/ansi_formatter.rb
 - lib/array.rb
@@ -170,8 +179,10 @@ files:
 - lib/mdoc.rb
 - lib/menu.src.yml
 - lib/menu.yml
+- lib/namer.rb
 - lib/object_present.rb
 - lib/option_value.rb
+- lib/poly.rb
 - lib/regexp.rb
 - lib/resize_terminal.rb
 - lib/rspec_helpers.rb
@@ -179,6 +190,7 @@ files:
 - lib/saved_files_matcher.rb
 - lib/shared.rb
 - lib/std_out_err_logger.rb
+- lib/streams_out.rb
 - lib/string_util.rb
 - lib/tap.rb
 homepage: https://rubygems.org/gems/markdown_exec

data/examples/vars.md

@@ -1,20 +0,0 @@
-```bash :(defaults)
-: ${VAULT:=default}
-```
-```bash :show_vars +(defaults)
-source bin/colorize_env_vars.sh
-colorize_env_vars '' VAULT
-```
-```vars :set
-VAULT: 11
-```
-```vars :set_with_show +show_vars
-VAULT: 22
-```
-```bash :(hidden)
-colorize_env_vars '' NOTHING
-```
-```bash :show_with_set +set
-source bin/colorize_env_vars.sh
-colorize_env_vars '' VAULT
-```