markdown_exec 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d9976af006093768c7673d5ef0abeff6766539ff86029179d45db0530a4e203
-  data.tar.gz: c2814cf1b85ba80352819c2866862e40a9185874469edc65e0673485e0ca4f7e
+  metadata.gz: 2336bb2091df5bf018181e832fb9c5e7a5b7ee542b6f71cde38a3afb3aa88ab4
+  data.tar.gz: '072654942ddf5897784c71724a7f9fa6fb5bea9b395d54ca18a3f3fd9b02c5af'
 SHA512:
-  metadata.gz: 9720f8af38d17eba836b73407dedf71848c19663fa017277d3a62e003e19da36a3cad881796ce58e7b84d3d03a94a3a130d6876ac41c908d4694dadc80b53c6b
-  data.tar.gz: 707486f6a6e424787ee7ef05336d5a7290375844f477f369aa7dce2dc72d7f0343d425d83ac778d6b12859b4e155c6fea0ed0acb0cc3719b2d42b5fbf99f2c7b
+  metadata.gz: 2f28a18aea943a7fec92b16d232b8c3722a30f6960fbd32bf84e95762b4ac322f0fb53f75563118a15136da72e49f16c580a8c7fbf05d2001857e068403834ef
+  data.tar.gz: 8bb762715d790e37906d61cf8834e86dfe7e4f9611b8f7477da508d2ff658d496c6e1e0c89fc42e9e5f2cf937e29dae3cddf062cabda867f3a5bb1466986f2c3

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,106 @@
-## [Unreleased]
+# Changelog
+
+
+## [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
+
+- Accept file or folder as first optional positional argument.
+- Hide blocks with parentheses in the name, like "(name)". This is useful for blocks that are to be required and not selected to execute alone.
 
 ## [0.2.0] - 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.4)
       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,6 +1,6 @@
 # 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.
 
 * Code blocks may be named.
 
@@ -10,30 +10,47 @@ This gem allows you to interactively select and run code blocks in markdown file
 
 * The code is presented for approval prior to execution.
 
+## 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`
+### `mde --help`
 Displays help information.
 
-`mde`
+### `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` or `mde -f my.md`
 Select a block to execute from `my.md`.
 
-`mde -p .`
+### `mde .` or `mde -p .`
+
 Select a markdown file in the current folder. Select a block to execute from that file.
 
-`mde --list-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.
 
 ## Behavior
@@ -42,7 +59,6 @@ List all markdown documents in the current folder.
 * 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.
 
 e.g. Use to set the default file for the current folder.
@@ -51,49 +67,28 @@ e.g. Use to set the default file for the current folder.
 * `folder: documents` sets the folder to search for default or specified files.
 
 # Example blocks
-
-When prompted, select either the `awake` or `asleep` block. The standard output confirms which required were blocks were included. Naming "hidden" blocks with parentheses "(" and ")" is a convention used here to re-inforce the purpose of the named blocks.
+When prompted, select either the `awake` or `asleep` block.
 
 ``` :(day)
-# block named "(day)", required by other blocks
-export MYTIME=early
+export TIME=early
 ```
 
 ``` :(night)
-# block named "(night)", required by other blocks
-export MYTIME=late
+export TIME=late
 ```
 
 ``` :awake +(day) +(report)
-# block named "awake", select to see result
 export ACTIVITY=awake
 ```
 
 ``` :asleep +(night) +(report)
-# block named "asleep", select to see result
 export ACTIVITY=asleep
 ```
 
 ``` :(report)
-# block named "(report)", required by other blocks
-echo "time: $MYTIME, activity: $ACTIVITY"
+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)
-
-## Output
-![Output of execution](/assets/executed.png)
-
 # License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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

@@ -4,5 +4,5 @@ module MarkdownExec
   APP_NAME = 'MDE'
   APP_DESC = 'Markdown block executor'
   GEM_NAME = 'markdown_exec'
-  VERSION = '0.2.0'
+  VERSION = '0.2.4'
 end