markdown_exec 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a2b550aaccca7d0752e57c39808f5d8d3b889b9d74cf3330dee6832b2f6c535
-  data.tar.gz: 1296490dd79071f78b5009cb843c911fe822257ed148b4c1a516366eb02407ca
+  metadata.gz: 95d097cfcf93e09ba3bf487989923d4be03dd9fde0521854ea0660850b157d01
+  data.tar.gz: 22bc0e8bc8cd35d0d1dd52b6275c1609fb4cb95d69bd125064f0ca16f2f931f7
 SHA512:
-  metadata.gz: 43f659be4397e4bb24811a8219de7b58e9665aa8751063281e2cfbbf94263ceda15f411a34fe31293869f0bbdba761c2afce72ea7f800b54edba75424313bd19
-  data.tar.gz: bd48ac8a5ebedbc8b92af6345743d1bd6cf50705d05769e7144ccad998ddf0f00de72366779cb654a4272c3cc2f044c4c7e46ae9df935dcb4fc486a67e54453e
+  metadata.gz: 591c09a221c0f5a34f8523d99d8e416bb022219fee38a7a05e3541600b03132e5ae3cc6aee02048eda2170a408d9e86090dedadff7c16f1f79ea98469826c27a
+  data.tar.gz: 74a76b6a6b10b165f8e79e59d25db78bcba173d730fd1a696e73c2012794bcfedd7c1b648cabe6b15d4d0a70995e5303b02c58d0b16c35a03ffbfea0b4efc5f4

data/.rubocop.yml

@@ -1,4 +1,9 @@
+require:
+ - rubocop-minitest
+ - rubocop-rake
+
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.6
 
 Metrics/AbcSize:

data/CHANGELOG.md

@@ -1,4 +1,135 @@
-## [Unreleased]
+# Changelog
+
+## [ToDo]
+
+- pipe stdin to script
+- yes/no/write/clipboard/record/edit/history
+- present timestamp, result of last exec for each command
+- user settings
+- hidden w , w/o () in names
+- fix regexp in pathnames
+- tab completion from md file
+- read file once to allow for tempdoc stream
+- include md or blocks file
+
+- tree display
+
+- mde options in md file or included file
+
+- include blocks from local md file
+
+- chmod a+x logged script
+
+- add shebang to saved script
+
+## [0.2.5] - 2022-04
+
+### Added
+
+- Command `--list-default-env` to show default configuration as environment variables.
+- Command `--list-default-yaml` to show default configuration as YAML.
+- Option to exit program when selecting files or blocks.
+
+### Changed
+
+- Composition of menu to facilitate reports.
+- List default values in menu help.
+
+## [0.2.4] - 2022-04-01
+
+### Added
+
+- Command `--list-recent-scripts` to list the last *N* saved scripts.
+- Command `--run-last-script` to re-run the last saved script.
+- Command `--select-recent-script` to select and execute a recently saved script.
+
+| YAML Name | Environment Variable | Option Name | Default | Purpose |
+| :--- | :--- | :--- | :--- | :--- |
+| list_count | MDE_LIST_COUNT | `--list-count` | `16` | Max. items to return in list |
+| logged_stdout_filename_prefix | MDE_LOGGED_STDOUT_FILENAME_PREFIX | | `mde` | Name prefix for stdout files |
+| save_execution_output | MDE_SAVE_EXECUTION_OUTPUT | `--save-execution-output` | False | Save standard output of the executed script |
+| saved_script_filename_prefix | MDE_SAVED_SCRIPT_FILENAME_PREFIX | | `mde` | Name prefix for saved scripts |
+| saved_script_folder | MDE_SAVED_SCRIPT_FOLDER | `--saved-script-folder` | `logs` | Saved script folder |
+| saved_script_glob | MDE_SAVED_SCRIPT_GLOB | | `mde_*.sh` | Glob matching saved scripts |
+| saved_stdout_folder | MDE_SAVED_STDOUT_FOLDER | `--saved-stdout-folder` | `logs` | Saved stdout folder |
+
+### Changed
+
+- Fix saving of executed script.
+- Sort configuration keys output by `-0` (Show configuration.)
+
+## [0.2.3] - 2022-03-29
+
+### Added
+
+- `rubocop` checks.
+- Added optional command-line positional arguments:
+  1. document file
+  2. block name
+
+	e.g. `mde doc1 block1` will execute the block named `block1` in file `doc1`.
+
+### Changed
+
+- Naming saved script files: The file name contains the time stamp, document name, and block name.
+- Renamed folder with fixtures.
+- Command options:
+
+| YAML Name | Environment Variable | Option Name | Default | Purpose |
+| :--- | :--- | :--- | :--- | :--- |
+| debug | MDE_DEBUG | `--debug` | False | Output debugging information (verbose) |
+| filename | MDE_FILENAME | `--filename` | `README.md`* | File name of document |
+| output_execution_summary | MDE_OUTPUT_STDOUT_SUMMARY | `--output-execution-summary` | False | Display summary for execution |
+| output_script | MDE_OUTPUT_SCRIPT | `--output-script` | False | Display script |
+| output_stdout | MDE_OUTPUT_EXECUTION | `--output-stdout` | True | Display standard output from execution |
+| path | MDE_PATH | `--path` | `.` | Path to document(s) |
+| save_executed_script | MDE_SAVE_EXECUTED_SCRIPT | `--save-executed-script` | False | Save executed script |
+| saved_script_folder | MDE_SAVED_SCRIPT_FOLDER | `--saved-script-folder` | `logs` | Saved script folder |
+| select_page_height | MDE_SELECT_PAGE_HEIGHT |  | `12` | Menu page height (maximum) |
+| user_must_approve | MDE_USER_MUST_APPROVE | `--user-must-approve` | True | Pause to approve execution |
+
+- Configuration options:
+
+| YAML Name | Environment Variable | Default |
+| :--- | :--- | :--- |
+| block_name_excluded_match | MDE_BLOCK_NAME_EXCLUDED_MATCH  | `^\(.+\)$` |
+| block_name_match | MDE_BLOCK_NAME_MATCH  | `:(?<title>\S+)( \|$)` |
+| block_required_scan | MDE_BLOCK_REQUIRED_SCAN  | `\+\S+` |
+| fenced_start_and_end_match | MDE_FENCED_START_AND_END_MATCH  | ``^`{3,}`` |
+| fenced_start_ex_match | MDE_FENCED_START_EX_MATCH  | ``^`{3,}(?<shell>[^`\s]*) *(?<name>.*)$`` |
+| heading1_match | MDE_HEADING1_MATCH  | `^# *(?<name>[^#]*?) *$` |
+| heading2_match | MDE_HEADING2_MATCH  | `^## *(?<name>[^#]*?) *$` |
+| heading3_match | MDE_HEADING3_MATCH  | `^### *(?<name>.+?) *$` |
+| md_filename_glob | MDE_MD_FILENAME_GLOB  | `*.[Mm][Dd]` |
+| md_filename_match | MDE_MD_FILENAME_MATCH  | `.+\\.md` |
+
+Most options can be configured in multiple ways. In order of use (earliest superceded by last):
+1. environment variables
+2. the configuration file `.mde.yml` in the current folder
+3. command line arguments
+
+#### Representing boolean values
+
+Boolean values for options are specified as strings and interpreted as:
+| Value | Boolean |
+| :---: | :---: |
+| *empty string* | False |
+| `0` | False |
+| `1` | True |
+| *anything else* | True |
+
+E.g. `opt1=1` will set option `opt1` to True.
+
+Boolean options configured with environment variables:
+- Set to `1` or non-empty value to save executed scripts; empty or `0` to disable saving.
+  e.g. `export MDE_SAVE_EXECUTED_SCRIPT=1`
+  e.g. `export MDE_SAVE_EXECUTED_SCRIPT=`
+- Specify variable on command line.
+  e.g. `MDE_SAVE_EXECUTED_SCRIPT=1 mde`
+
+## [0.2.2] - 2022-03-17
+
+- Update documentation.
 
 ## [0.2.1] - 2022-03-12
 

data/Gemfile

@@ -10,3 +10,5 @@ gem 'rake', '~> 13.0'
 gem 'minitest', '~> 5.0'
 
 gem 'rubocop', '~> 1.21'
+gem 'rubocop-minitest', require: false
+gem 'rubocop-rake', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (0.1.1)
+    markdown_exec (0.2.5)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
       tty-prompt (~> 0.23.1)
@@ -34,6 +34,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.16.0)
       parser (>= 3.1.1.0)
+    rubocop-minitest (0.18.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
@@ -57,6 +61,8 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)
+  rubocop-minitest
+  rubocop-rake
 
 BUNDLED WITH
    2.2.32

data/README.md

@@ -1,56 +1,146 @@
 # MarkdownExec
 
-This gem allows you to interactively select and run code blocks in markdown files.
+Interactively select and execute fenced code blocks in markdown files. Build complex scripts by naming and requiring blocks. Log resulting scripts and output. Re-run scripts.
 
-* Code blocks may be named.
+* Code blocks may be named. Named blocks can be required by other blocks.
 
-* Named blocks can be required by other blocks.
+* The user-selected code block, and all required blocks, are arranged into a script in the order they appear in the markdown file. The script can be presented for approval prior to execution.
 
-* The user-selected code block, and all required blocks, are arranged in the order they appear in the markdown file.
+* Executed scripts can be saved. Saved scripts can be listed, selected, and executed.
 
-* The code is presented for approval prior to execution.
+* Output from executed scripts can be saved.
+
+## Screenshots
+
+### Select a file
+
+![Select a file](/assets/select_a_file.png)
+
+### Select a block
+
+![Select a block](/assets/select_a_block.png)
+
+### Approve code
+
+![Approve code](/assets/approve_code.png)
+
+### Output
+
+![Output of execution](/assets/output_of_execution.png)
+
+### Example blocks
+
+![Example blocks](/assets/example_blocks.png)
 
 ## Installation
 
 Install:
-
     $ gem install markdown_exec
 
 ## Usage
 
-`mde --help`
+### Help
+
+#### `mde --help`
+
 Displays help information.
 
-`mde`
+### Basic
+
+#### `mde`
+
 Process `README.md` file in the current folder. Displays all the blocks in the file and allows you to select using [up], [down], and [return]. Press [ctrl]-c to abort selection.
 
-`mde -f my.md`
-`mde my.md`
+#### `mde my.md` or `mde -f my.md`
+
 Select a block to execute from `my.md`.
 
-`mde -p .`
-`mde .`
+#### `mde .` or `mde -p .`
+
 Select a markdown file in the current folder. Select a block to execute from that file.
 
-`mde --list-blocks`
+### Report documents and blocks
+
+#### `mde --list-blocks`
+
 List all blocks in the all the markdown documents in the current folder.
 
-`mde --list-docs`
+#### `mde --list-docs`
+
 List all markdown documents in the current folder.
 
+### Configuration
+
+#### `mde --list-default-env` or `mde --list-default-yaml`
+
+List default values that can be set in configuration file, environment, and command line.
+
+#### `mde -0`
+
+Show current configuation values that will be applied to the current run. Does not interrupt processing.
+
+### Save scripts
+
+#### `mde --save-executed-script 1`
+
+Save executed script in saved script folder.
+
+#### `mde --list-recent-scripts`
+
+List recent saved scripts in saved script folder.
+
+#### `mde --select-recent-script`
+
+Select and execute a recently saved script in saved script folder.
+
+### Save output
+
+#### `mde --save-execution-output 1`
+
+Save execution output in saved output folder.
+
 ## Behavior
+
 * If no file and no folder are specified, blocks within `./README.md` are presented.
 * If a file is specified, its blocks are presented.
 * If a folder is specified, its files are presented. When a file is selected, its blocks are presented.
 
 ## Configuration
 
-While starting up, reads the YAML configuration file `.mde.yml` in the current folder if it exists.
+### Environment Variables
 
-e.g. Use to set the default file for the current folder.
+When executed, `mde` reads the current environment.
+* Configuration in current and children shells, e.g. `export MDE_SAVE_EXECUTED_SCRIPT=1`.
+* Configuration for the current command, e.g. `MDE_SAVE_EXECUTED_SCRIPT=1 mde`.
 
-* `filename: CHANGELOG.md` sets the file to open.
-* `folder: documents` sets the folder to search for default or specified files.
+### Configuration Files
+
+* Configuration in all shells, e.g. environment variables set in your user's `~/.bashrc` or `~/.bash_profile` files.
+* Configuration in the optional file `.mde.yml` in the current folder. .e.g. `save_executed_script: true`
+* Configuration in a YAML file and read while parsing the inputs, e.g. `--config my_path/my_file.yml`
+
+### Program Arguments
+
+* Configuration in command options, e.g. `mde --save-executed-script 1`
+
+## Representing boolean values
+
+Boolean values expressed as strings are interpreted as:
+| String | Boolean |
+| :---: | :---: |
+| *empty string* | False |
+| `0` | False |
+| `1` | True |
+| *anything else* | True |
+
+E.g. `opt1=1` will set option `opt1` to True.
+
+Boolean options configured with environment variables:
+- Set to `1` or non-empty value to save executed scripts; empty or `0` to disable saving.
+  e.g. `export MDE_SAVE_EXECUTED_SCRIPT=1`
+  e.g. `export MDE_SAVE_EXECUTED_SCRIPT=`
+- Specify variable on command line.
+  e.g. `MDE_SAVE_EXECUTED_SCRIPT=1 mde`
 
 # Example blocks
 
@@ -76,20 +166,16 @@ export ACTIVITY=asleep
 echo "$TIME -> $ACTIVITY"
 ```
 
-## Example blocks
-![Sample blocks](/assets/blocks.png)
-
-## Selecting a file
-![Selecting a file](/assets/select_file.png)
-
-## Selecting a block
-![Selecting a block](/assets/select.png)
-
-## Approving code
-![Approving code](/assets/approve.png)
+``` :missing_command
+fail
+```
 
-## Output
-![Output of execution](/assets/executed.png)
+``` :exit_value
+echo "a"
+echo "b"
+echo "c" >>/dev/stderr
+grep nx Gemfile
+```
 
 # License
 

data/Rakefile

@@ -3,38 +3,50 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+Rake::TestTask.new(:test) do |task|
+  task.libs << 'test'
+  task.libs << 'lib'
+  task.test_files = FileList['test/**/*_test.rb']
 end
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  # task.requires << 'rubocop-minitest'
+end
+
+desc 'named task because minitest not included in rubocop tests'
+task :rubocopminitest do
+  `rubocop --require rubocop-minitest`
+end
 
 require_relative 'lib/markdown_exec/version'
 
-task default: %i[test rubocop]
+task default: %i[test rubocop rubocopminitest]
 
 # task :default => :build
 
+desc 'gem build'
 task :build do
   system "gem build #{MarkdownExec::GEM_NAME}.gemspec"
 end
 
+desc 'gem install'
 task install: :build do
   system "gem install #{MarkdownExec::GEM_NAME}-#{MarkdownExec::VERSION}.gem"
 end
 
+desc 'gem publish'
 task publish: :build do
   system "gem push #{MarkdownExec::GEM_NAME}-#{MarkdownExec::VERSION}.gem"
 end
 
+desc 'gem uninstall'
 task uninstall: :build do
   system "gem uninstall #{MarkdownExec::GEM_NAME}"
 end
 
+desc 'gem build clean'
 task :clean do
   system 'rm *.gem'
 end

data/fixtures/bash1.md

@@ -0,0 +1,12 @@
+``` :one
+a
+```
+```bash :two +one
+b
+```
+```bash :three +two +one
+c
+```
+```bash :four +three
+d
+```

data/fixtures/bash2.md

@@ -0,0 +1,15 @@
+``` :one
+a
+```
+``` :two +one
+b
+```
+``` :three +two
+c
+```
+``` :four
+d
+```
+``` :five +four +one
+e
+```

data/fixtures/exclude1.md

@@ -0,0 +1,6 @@
+``` :one
+a
+```
+```expect
+b
+```

data/fixtures/exclude2.md

@@ -0,0 +1,9 @@
+``` :one
+a
+```
+``` :(two)
+b
+```
+``` :three
+c
+```

data/fixtures/exec1.md

@@ -0,0 +1,8 @@
+```bash ls
+ls
+```
+
+```bash two-three
+echo "TWO"
+echo "THREE"
+```

data/fixtures/heading1.md

@@ -0,0 +1,19 @@
+``` :one
+a
+```
+# h1
+``` :two
+b
+```
+## h2
+``` :three
+c
+```
+### h3
+``` :four
+d
+```
+### h4
+``` :five
+e
+```

data/fixtures/sample1.md

@@ -0,0 +1,9 @@
+#
+##
+``` one
+a
+```
+
+```bash two
+b
+```

data/fixtures/title1.md

@@ -0,0 +1,6 @@
+```
+no name
+```
+``` :name1
+with name
+```

data/lib/markdown_exec/version.rb

@@ -2,7 +2,7 @@
 
 module MarkdownExec
   APP_NAME = 'MDE'
-  APP_DESC = 'Markdown block executor'
+  APP_DESC = 'Markdown Executor'
   GEM_NAME = 'markdown_exec'
-  VERSION = '0.2.1'
+  VERSION = '0.2.5'
 end