markdown_exec 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34e8e9ff237ed338e50c0a03dfbb8c4bbd10e49f1f6ee54f54607ce19b96632
-  data.tar.gz: 54f0ce617360be38233ed974f2cb8d5656e1b9f7671ed9f2ac819c2d66843eb1
+  metadata.gz: 0f8bb9f8a7a903a6b221ed8d04a5acb445e294be4c134202b9a71ba9e9f7c7ac
+  data.tar.gz: d26a89ae33f1aeaac70b40f3e31b3090fb50c6eb48874eeba435ce89825123fc
 SHA512:
-  metadata.gz: e14f9203dd2c07b0b0fef5a71ebec355d1e1988c798bc0f5811bf6b97a0f8cd52066ff4dee2372c522248a920add287e3ac8567b3a68d7b885a3ec42266faa30
-  data.tar.gz: b843ddd2e4b7b1b8eda9b4eb19823a32f758a422e27f84a779372e22321f4b16ce3307f51abb45e7bdbf92d14311ceedd110a1999203ffcf03ccb0ffa8f93b7e
+  metadata.gz: f177057c231ef950012abc922b6c3d9611e0b423df57cee07e6ac0e68864c18ce9b6a7cf640e165dbd8409d6ecefb199a3bb31643a7c5e31d5c241f17682545e
+  data.tar.gz: 9fb1a5d4274d2443e1ed9680978cfb12c76b46416a3ba76483addd19b61238446dce86793a039cfede131bdd11a4436ae693640ad279add82e24415a544b7b53

data/CHANGELOG.md

@@ -34,9 +34,20 @@
 
 - [ ] re-exec last script v re-run named block in last script
 - [ ] repeat to reload last doc and block
-- [ ] option to output mixed stdin, stdout, stderr; labels: prefix and blocks
+- [ ] option to log blended, timeline; stdin, stdout, stderr; labels: prefix and blocks
+- [ ] ren logged_stdout_filename_prefix to saved_stdout_filename_prefix
 
-## [1.0.1] - 2022-05-21
+## [1.1.1] - 2022-05-25
+
+### Added
+
+- Post-install instructions to add tab completions permanently to the shell.
+
+### Changed
+
+- Improve handling of threads ending while executing scripts.
+
+## [1.1.0] - 2022-05-21
 
 ### Added
 
@@ -53,14 +64,13 @@
 ### Changed
 
 - Exit option is at top of each menu.
-- Single-stage tab completion, defaut
+- Single-stage tab completion, default
     - Presents matching options when current word starts with `-`
     - Presents directories and files otherwise.
 - Two-stage tab completion for option arguments.
     - When prior word is an option and current word is empty
     - Presents option type on first tab, eg `.BOOL.` for a boolean option.
     - Presents option default value on second tab, eg `0` for false.
-- Use 'bash' shell instead of default
 - Write STDOUT, STDERR, STDIN in sections to saved output file.
 
 ## [1.0.0] - 2022-04-26

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 gem 'clipboard'
 gem 'erb'
 gem 'minitest', '~> 5.0'
+gem 'mrdialog', '~> 1.0.3'
 gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.21'
 gem 'rubocop-minitest', require: false

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    markdown_exec (1.1.0)
+    markdown_exec (1.1.1)
       clipboard (~> 1.3.6)
+      mrdialog (~> 1.0.3)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
       tty-prompt (~> 0.23.1)
@@ -17,6 +18,7 @@ GEM
     erb (2.2.3)
       cgi
     minitest (5.15.0)
+    mrdialog (1.0.3)
     open3 (0.1.1)
     optparse (0.1.1)
     parallel (1.21.0)
@@ -68,6 +70,7 @@ DEPENDENCIES
   erb
   markdown_exec!
   minitest (~> 5.0)
+  mrdialog (~> 1.0.3)
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-minitest

data/README.md

@@ -156,15 +156,28 @@ Append a command to load the completion script to your shell configuration file.
 echo "source $(mde --pwd)/bin/tab_completion.sh" >> ~/.bash_profile
 ```
 
+### Behavior
+
+Press tab for completions appropriate to the current input.
+`mde <...> <prior word> <current word>`
+
+Completions are calculated based on the current word and the prior word. 
+1. If the current word starts with `-`, present matching options, eg `--version` for the current word `--v`.
+2. Else, if the current word is empty and the prior word is an option that takes an argument, present the type of the argument, eg `.BOOL.` for the option `--user-must-approve`.
+3. Else, if the current word is the type of argument, from the rule above, present the default value for the option. e.g. `1` for the type `.BOOL.` for the option `--user-must-approve`.
+4. Else, if the current word is non-empty, list matching files and folders.
+
 ### Example Completions
 
-Type tab at end of any of the following commands to see the options.
-- `mde `
-- `mde -`
-- `mde --`
-- `mde --o`
-- `mde --filename my.md -`
-- `mde --filename my.md --`
+In the table below, tab is indicated by `!`
+| Input | Completions |
+| :---: | :---: |
+| `mde !` | local files and folders |
+| `mde -!` | all options |
+| `mde --!` | all options |
+| `mde --v!` | `mde --version` |
+| `mde --user-must-approve !` | `mde --user-must-approve .BOOL.`|
+| `mde --user-must-approve .BOOL.!` | `mde --user-must-approve 1` |
 
 ## Example Blocks
 
@@ -197,34 +210,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 # Code of Conduct
 
 Everyone interacting in the MarkdownExec project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/markdown_exec/blob/master/CODE_OF_CONDUCT.md).
-
-###
-i made a tool to help me execute shell commands for ansible, aws, etc.
-
-normally the scripts have a base configuration followed by one or more blocks of commands that must be executed with the base configuration.
-
-by storing the shell scripts in a markdown file, there is room for both code and explanatory text. the tool provides the interface that names all the code blocks in the file and allows the the user to select and preview the code to execute.
-
-i use it regularly to manage deployment processes that require dozens of steps with ease and re-playablity.
-
-the gem is hosted at `https://github.com/fareedst/markdown_exec`.
-
-please install the Ruby gem with `gem install markdown_exec` and let me know how the installation goes for you. i would like to see if your current deployment scripts can fit into this model.
-
-```bash :test1
-files="$(ls -A .)"
-PS3='?'
-select filename in ${files}; do echo "You selected ${filename}"; break; done
-
-echo "-1"
-echo $0
-echo 'AA'
-echo 'name? '
-read name
-echo 'type? '
-read type
-echo 'BB'
-echo "name: $name"
-echo "type: $type"
-echo 'CC'
-```

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.1.0"
+  echo "1.1.1"
 }
 
 _mde() {
@@ -140,4 +140,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2022-05-21 16:42:10 UTC"
+# echo "Updated: 2022-05-26 01:40:10 UTC"

data/lib/markdown_exec/version.rb

@@ -5,5 +5,5 @@ module MarkdownExec
   APP_NAME = 'MDE'
   BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/lib/markdown_exec.rb

@@ -5,6 +5,7 @@
 
 require 'English'
 require 'clipboard'
+require 'mrdialog'
 require 'open3'
 require 'optparse'
 require 'tty-prompt'
@@ -179,6 +180,8 @@ module MarkdownExec
             print line if opts[:output_stdout]
             yield nil, line, nil, exec_thr if block_given?
           end
+        rescue IOError => e
+          # thread killed, do nothing
         end
 
         t2 = Thread.new do
@@ -187,6 +190,8 @@ module MarkdownExec
             print line if opts[:output_stdout]
             yield nil, nil, line, exec_thr if block_given?
           end
+        rescue IOError => e
+          # thread killed, do nothing
         end
 
         in_thr = Thread.new do
@@ -247,6 +252,118 @@ module MarkdownExec
         list_recent_output: -> { fout_list list_recent_output },
         list_recent_scripts: -> { fout_list list_recent_scripts },
         pwd: -> { fout File.expand_path('..', __dir__) },
+        pwd3: lambda {
+               text = 'A B C'
+               items = []
+               Struct.new('BuildListData', :tag, :item, :status)
+               data = Struct::BuildListData.new
+
+               data.tag = '1'
+               data.item = 'Item number 1'
+               data.status = true
+               items.push(data.to_a)
+
+               data = Struct::BuildListData.new
+               data.tag = '2'
+               data.item = 'Item number 2'
+               data.status = false
+               items.push(data.to_a)
+
+               data = Struct::BuildListData.new
+               data.tag = '3'
+               data.item = 'Item number 3'
+               data.status = false
+               items.push(data.to_a)
+
+               data = Struct::BuildListData.new
+               data.tag = '4'
+               data.item = 'Item number 4'
+               data.status = true
+               items.push(data.to_a)
+
+               data = Struct::BuildListData.new
+               data.tag = '5'
+               data.item = 'Item number 5'
+               data.status = false
+               items.push(data.to_a)
+
+               data = Struct::BuildListData.new
+               data.tag = '6'
+               data.item = 'Item number 6'
+               data.status = true
+               items.push(data.to_a)
+
+               dialog = MRDialog.new
+               dialog.clear = true
+               dialog.shadow = false
+               dialog.title = 'BUILDLIST'
+               # dialog.logger = Logger.new(ENV["HOME"] + "/dialog_" + ME + ".log")
+
+               height = 0
+               width = 0
+               listheight = 0
+
+               selected_items = dialog.buildlist(text, items, height, width, listheight)
+               exit_code = dialog.exit_code
+               puts "Exit code: #{exit_code}"
+               puts 'Selecetd tags:'
+               selected_items.each do |item|
+                 puts " '#{item}'"
+               end
+             },
+        pwd1: lambda {
+                dialog = MRDialog.new
+                dialog.clear = true
+                dialog.title = 'YES/NO BOX'
+                puts "yesno: #{dialog.yesno('ABC', 0, 0)}"
+              },
+        pwd2: lambda {
+                dialog = MRDialog.new
+                # dialog.logger = Logger.new(ENV["HOME"] + "/dialog_" + ME + ".log")
+                dialog.clear = true
+                dialog.title = 'MENU BOX'
+                text = 'textextst'
+                items = []
+                menu_data = Struct.new(:tag, :item)
+                data = menu_data.new
+                data.tag = 'Linux'
+                data.item = 'The Great Unix Clone for 386/486'
+                items.push(data.to_a)
+
+                data = menu_data.new
+                data.tag = 'NetBSD'
+                data.item = 'Another free Unix Clone for 386/486'
+                items.push(data.to_a)
+
+                data = menu_data.new
+                data.tag = 'OS/2'
+                data.item = 'IBM OS/2'
+                items.push(data.to_a)
+
+                data = menu_data.new
+                data.tag = 'WIN NT'
+                data.item = 'Microsoft Windows NT'
+                items.push(data.to_a)
+
+                data = menu_data.new
+                data.tag = 'PCDOS'
+                data.item = 'IBM PC DOS'
+                items.push(data.to_a)
+
+                data = menu_data.new
+                data.tag = 'MSDOS'
+                data.item = 'Microsoft DOS'
+                items.push(data.to_a)
+
+                height = 0
+                width = 0
+                menu_height = 4
+
+                selected_item = dialog.menu(text, items, height, width, menu_height)
+
+                puts "Selected item: #{selected_item}"
+              },
+        # pwd: -> { fout `dialog --yesno "ABC" 99 99` },
         run_last_script: -> { run_last_script },
         select_recent_output: -> { select_recent_output },
         select_recent_script: -> { select_recent_script },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: mrdialog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: open3
   requirement: !ruby/object:Gem::Requirement
@@ -120,7 +134,14 @@ metadata:
   homepage_uri: https://rubygems.org/gems/markdown_exec
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/fareedst/markdown_exec
-post_install_message:
+post_install_message: |2+
+
+  To install tab completion:
+  - Append a command to load the completion script to your shell configuration file.
+  - This gem must be installed and executable for the command to be composed correctly.
+
+  echo "source $(mde --pwd)/bin/tab_completion.sh" >> ~/.bash_profile
+
 rdoc_options: []
 require_paths:
 - lib
@@ -140,3 +161,4 @@ signing_key:
 specification_version: 4
 summary: Interactively select and execute fenced code blocks in markdown files.
 test_files: []
+...