markdown_exec 1.3.2 → 1.3.3.1

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (1.3.2)
+# MDE - Markdown Executor (1.3.3.1)
 ---
 - :arg_name: NAME
   :compreply: false
@@ -101,6 +101,12 @@
   :long_name: pwd
   :opt_name: pwd
   :procname: val_as_bool
+- :arg_name: BOOL
+  :default: false
+  :description: Display only blocks of type "bash"
+  :env_var: MDE_BASH_ONLY
+  :opt_name: bash_only
+  :procname: val_as_bool
 - :arg_name: INT.0-3
   :default: 1
   :description: Output display level (0 to 3 [data, +context, +info])
@@ -108,6 +114,32 @@
   :long_name: display-level
   :opt_name: display_level
   :procname: val_as_int
+- :arg_name: REGEX
+  :default:
+  :description: Exclude blocks with name matching
+  :env_var: MDE_EXCLUDE_BY_NAME_REGEX
+  :opt_name: exclude_by_name_regex
+  :procname: val_as_str
+- :arg_name: REGEX
+  :default:
+  :description: Exclude blocks with shell matching
+  :env_var: MDE_EXCLUDE_BY_SHELL_REGEX
+  :opt_name: exclude_by_shell_regex
+  :procname: val_as_str
+- :arg_name: BOOL
+  :default: true
+  :description: Hide all blocks of type "expect"
+  :env_var: MDE_EXCLUDE_EXPECT_BLOCKS
+  :opt_name: exclude_expect_blocks
+  :procname: val_as_bool
+- :arg_name: BOOL
+  :default: true
+  :description: |-
+    Exclude blocks with name matching expression " \
+           "`block_name_hidden_match`
+  :env_var: MDE_HIDE_BLOCKS_BY_NAME
+  :opt_name: hide_blocks_by_name
+  :procname: val_as_bool
 - :arg_name: INT.1-
   :default: 32
   :description: Max. items to return in list
@@ -133,6 +165,18 @@
   :env_var: MDE_MENU_BLOCKS_WITH_HEADINGS
   :opt_name: menu_blocks_with_headings
   :procname: val_as_bool
+- :arg_name: BOOL
+  :default: true
+  :description: Display Exit option at top of menu
+  :env_var: MDE_MENU_EXIT_AT_TOP
+  :opt_name: menu_exit_at_top
+  :procname: val_as_bool
+- :arg_name: BOOL
+  :default: true
+  :description: Display Exit option in menu
+  :env_var: MDE_MENU_WITH_EXIT
+  :opt_name: menu_with_exit
+  :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
   :description: Display summary for execution
@@ -140,6 +184,12 @@
   :long_name: output-execution-summary
   :opt_name: output_execution_summary
   :procname: val_as_bool
+- :arg_name: BOOL
+  :default: false
+  :description: Output saved script filename at end of execution
+  :env_var: MDE_OUTPUT_SAVED_SCRIPT_FILENAME
+  :opt_name: output_saved_script_filename
+  :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
   :description: Display script prior to execution
@@ -206,6 +256,18 @@
   :env_var: MDE_SAVED_STDOUT_GLOB
   :opt_name: saved_stdout_glob
   :procname: val_as_str
+- :arg_name: REGEX
+  :default:
+  :description: Select blocks with name matching
+  :env_var: MDE_SELECT_BY_NAME_REGEX
+  :opt_name: select_by_name_regex
+  :procname: val_as_str
+- :arg_name: REGEX
+  :default:
+  :description: Select blocks with shell matching
+  :env_var: MDE_SELECT_BY_SHELL_REGEX
+  :opt_name: select_by_shell_regex
+  :procname: val_as_str
 - :default: "^[\\(\\[].*[\\)\\]]$"
   :description: Pattern for blocks to hide from user-selection
   :env_var: MDE_BLOCK_NAME_HIDDEN_MATCH
@@ -223,11 +285,11 @@
   :env_var: MDE_BLOCK_REQUIRED_SCAN
   :opt_name: block_required_scan
   :procname: val_as_str
-- :default: "<(?<full>(?<type>\\$)?(?<name>[A-Za-z]\\S*))"
+- :default: "<(?<full>(?<type>\\$)?(?<name>[A-Za-z_\\-\\.\\w]+))"
   :env_var: MDE_BLOCK_STDIN_SCAN
   :opt_name: block_stdin_scan
   :procname: val_as_str
-- :default: ">(?<full>(?<type>\\$)?(?<name>[A-Za-z]\\S*))"
+- :default: ">(?<full>(?<type>\\$)?(?<name>[A-Za-z_\\-\\.\\w]+))"
   :env_var: MDE_BLOCK_STDOUT_SCAN
   :opt_name: block_stdout_scan
   :procname: val_as_str
@@ -239,7 +301,7 @@
   :env_var: MDE_FENCED_START_AND_END_MATCH
   :opt_name: fenced_start_and_end_match
   :procname: val_as_str
-- :default: "^`{3,}(?<shell>[^`\\s]*) *(?<name>.*)$"
+- :default: "^`{3,}(?<shell>[^`\\s]*) *:?(?<name>[^\\s]*) *(?<rest>.*) *$"
   :env_var: MDE_FENCED_START_EX_MATCH
   :opt_name: fenced_start_ex_match
   :procname: val_as_str
@@ -255,6 +317,10 @@
   :env_var: MDE_HEADING3_MATCH
   :opt_name: heading3_match
   :procname: val_as_str
+- :default: "^ *@import (.+)$"
+  :env_var: MDE_IMPORT_PATTERN
+  :opt_name: import_pattern
+  :procname: val_as_str
 - :default: "*.[Mm][Dd]"
   :env_var: MDE_MD_FILENAME_GLOB
   :opt_name: md_filename_glob

data/lib/object_present.rb

@@ -1,7 +1,21 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # encoding=utf-8
 
+# version 2023-10-02
+
+require 'bundler/setup'
+Bundler.require(:default)
+
+class FalseClass
+  unless defined?(blank?)
+    def present?
+      true
+    end
+  end
+end
+
 # is the value empty?
 #
 class String
@@ -37,3 +51,33 @@ class Object
     end
   end
 end
+
+if $PROGRAM_NAME == __FILE__
+  require 'minitest/autorun'
+
+  class TestStringMethods < Minitest::Test
+    def test_blank
+      assert "".blank?
+      assert " ".blank?
+      assert "\t\n\r".blank?
+      refute "foo".blank?
+    end
+
+    def test_present
+      assert "foo".present?
+      refute "".present?
+    end
+  end
+
+  class TestObjectMethods < Minitest::Test
+    def test_present
+      assert "foo".present?
+      refute "".present?
+      assert Object.new.present?
+      assert 123.present?
+      assert true.present?
+      assert false.present?
+      refute nil.present?
+    end
+  end
+end

data/lib/rspec_helpers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# output standard header for file load during testing
+#
+def spec_source(file, env_var_name = 'SPEC_DEBUG')
+  if (->(val) { val.nil? ? false : !(val.empty? || val == '0') })
+     .call(ENV.fetch(env_var_name, nil))
+    puts "#{env_var_name}: #{file}"
+  end
+end

data/lib/tap.rb

@@ -5,16 +5,44 @@
 require 'json'
 require 'yaml'
 
-require_relative 'env'
-require_relative 'object_present'
+# is the value a non-empty string or a binary?
+#
+# :reek:ManualDispatch ### temp
+class Object
+  unless defined?(present?)
+    def present?
+      case self.class.to_s
+      when 'FalseClass', 'TrueClass'
+        true
+      else
+        self && (!respond_to?(:empty?) || !empty?)
+      end
+    end
+  end
+end
 
-include Env
+unless defined?(Env)
+  # utility functions to read environment variables
+  #
+  module Env
+    # :reek:UtilityFunction
+    def env_int(name, default: 0)
+      return default if name.nil? || (val = ENV.fetch(name, nil)).nil?
+      return default if val.empty?
+
+      val.to_i
+    end
+  end
+end
 
 # rubocop:disable Metrics/ParameterLists
 
 ## application-level debug control
 #
+# :reek:TooManyConstants
 module Tap
+  include Env
+
   DN = 'return'
   NONE = 0x0
   T1 = 1 # RESULT
@@ -49,6 +77,8 @@ module Tap
   $tap_enable = false
   $tap_mask = ALL2
 
+  # :reek:BooleanParameter
+  # :reek:ControlParameter
   def tap_config(enable: true, envvar: nil, value: nil)
     $tap_enable = false
     if envvar
@@ -66,7 +96,10 @@ module Tap
     self
   end
 
-  def tap_inspect(name_ = nil, caller0: nil, mask: TDD, name: DN, source: nil, type: nil)
+  # :reek:ControlParameter
+  # :reek:LongParameterList
+  def tap_inspect(name_ = nil, caller_first: nil, mask: TDD, name: DN, source: nil,
+                  type: nil)
     return self unless $tap_enable
     return self unless (mask & $tap_mask).positive?
 
@@ -74,7 +107,7 @@ module Tap
     outs = []
     outs.push(source.to_s) if source.present?
 
-    vs = (caller0 || caller[0]).scan(/in `?(\S+)'$/).fetch(0, []).fetch(0, '')
+    vs = (caller_first || caller[0]).scan(/in `?(\S+)'$/).fetch(0, []).fetch(0, '')
     outs.push("#{vs}()") if vs.present?
 
     outs.push(tap_named_value(name_ || name, method(fn).call))
@@ -91,6 +124,14 @@ module Tap
     self
   end
 
+  def tap_pry
+    return self unless $tap_enable
+
+    binding.pry
+    self
+  end
+
+  # :reek:ControlParameter
   def tap_puts(name_ = nil, mask: TDD, name: nil)
     return self unless $tap_enable
     return self unless (mask & $tap_mask).positive?
@@ -99,8 +140,11 @@ module Tap
     self
   end
 
-  def tap_yaml(name_ = nil, caller0: nil, mask: TDD, name: DN, source: nil)
-    tap_inspect name_, caller0: (caller0 || caller[0]), mask: mask, name: name, source: source, type: :yaml
+  # :reek:ControlParameter
+  # :reek:LongParameterList
+  def tap_yaml(name_ = nil, caller_first: nil, mask: TDD, name: DN, source: nil)
+    tap_inspect name_, caller_first: (caller_first || caller[0]),
+                       mask: mask, name: name, source: source, type: :yaml
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3.1
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -110,19 +110,19 @@ files:
 - bin/setup
 - bin/tab_completion.sh
 - bin/tab_completion.sh.erb
+- lib/cached_nested_file_reader.rb
 - lib/cli.rb
 - lib/colorize.rb
 - lib/env.rb
 - lib/env_opts.rb
 - lib/environment_opt_parse.rb
-- lib/globfiles.rb
 - lib/markdown_exec.rb
 - lib/markdown_exec/version.rb
 - lib/menu.yml
 - lib/object_present.rb
+- lib/rspec_helpers.rb
 - lib/shared.rb
 - lib/tap.rb
-- lib/yaml_env_opts.rb
 homepage: https://rubygems.org/gems/markdown_exec
 licenses:
 - MIT

data/lib/globfiles.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-# encoding=utf-8
-
-# require 'json'
-# require 'yaml'
-
-# require_relative 'env'
-# include Env
-
-## directory listing of saved files matching glob
-#
-class Globfiles
-  def initialize(folder, glob)
-    @folder = folder
-    @glob = glob
-  end
-
-  def list_all
-    Dir.glob(File.join(@folder, @glob)).tap_inspect
-  end
-
-  ## single most recent item
-  #
-  def most_recent(arr = nil)
-    arr = list_all if arr.nil?
-    return if arr.count < 1
-
-    arr.max.tap_inspect
-  end
-
-  ## multiple recent items
-  #
-  def most_recent_list(list_count, arr = nil)
-    arr = list_all if arr.nil?
-    return if (ac = arr.count) < 1
-
-    arr.sort[-[ac, list_count].min..].reverse.tap_inspect
-  end
-end # class Globfiles

data/lib/yaml_env_opts.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-# encoding=utf-8
-
-require 'yaml'
-
-require_relative 'env_opts'
-require_relative 'object_present'
-require_relative 'tap'
-
-include Tap #; tap_config
-
-# read configuration YAML file during initalization
-# value priority: menu default < configuration file < environment variable < command argument
-#
-class YamlEnvOpts < EnvOpts
-  def initialize(opts_raw = {}, argv: ARGV, configuration_yaml_filespec: '', values: nil)
-    super(opts_raw || {}, nil)
-    per_values(values)
-    configure_yaml_filespec(configuration_yaml_filespec)
-    set_keys_value_per_environment_as_cast(opts_raw)
-    parse(argv)
-
-    self # rubocop:disable Lint/Void
-  end
-
-  private
-
-  def apply_configuration(settings)
-    settings.tap_inspect 'settings'
-    return if settings.nil?
-
-    settings.each do |name, value|
-      set_key_value_as_cast(name, value)
-    end.tap_inspect
-  end
-
-  def configure_yaml_filespec(configuration_yaml_filespec)
-    apply_configuration(read_configuration_yaml(configuration_yaml_filespec))
-  end
-
-  def per_values(settings)
-    settings.tap_inspect 'settings'
-    return self if settings.nil?
-    return self if settings.count.zero?
-
-    settings.each do |name, value|
-      set_key_value_as_cast(name, value)
-    end
-
-    self
-  end
-
-  def read_configuration_yaml(configuration_yaml_filespec)
-    configuration_yaml_filespec.tap_inspect 'configuration_yaml_filespec'
-    return unless configuration_yaml_filespec.present?
-
-    YAML.safe_load(File.read(configuration_yaml_filespec) || '').tap_inspect
-  end
-end