markdown_exec 0.1.3 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf18f8937c1601bf8e6d19698d74c327c16ebfce07868249ebacddf0d7397dad
-  data.tar.gz: 6b8bb53ad8c9f21aa4c267984ff8ab02154c617a6b3f5de230763dbb81436131
+  metadata.gz: 7ec074d1854ef0150cf60852fd39d7db7bc88461f7d9f5ae6547fe009142ffb4
+  data.tar.gz: 8d6eb3c7759bf180b996f8a68ec8b52d0e52a230365b163f06528e9c11627e42
 SHA512:
-  metadata.gz: 15a0d5aba4cc5b88b4f586bb59313f61c9d461564252f8653c71696f1f6d2e3ea32c72c3ca8a9b70e5ebe74c398ddba97758b460e0770f7cd2b3da7ae15be4ba
-  data.tar.gz: adf64d06a15ef0e2259557ac79e5ec4ead8a4dfa36ed15f706f19a9169a1006388fcdd4ee19ec790f3f6b0f350044b29b7cf002fb82a0ce019f9b1062a948603
+  metadata.gz: '095584193734695c29729060ca4ccd424088ca59cdd8bf539dda5a6b914d7fd71d373304f071e46b49072bf01b09ae2a1f0cf86bf314f3d79ace9acd166a3531'
+  data.tar.gz: c8e55fa064fe9bc8c170c9431dd1a5dc9fd3f20f1fe42925c00c4f2ed5113d597f457ecdba225cf4533563cd0c3f14f35ebc1ad096e8a89f8ec654a5cd87cd8c

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,5 +1,120 @@
+# Changelog
+
+## [ToDo]
+
+- pipe stdin to script
+- yes/no/write/clipboard/record/edit/history
+- add confirm block to generated file
+- present timestamp, result of last exec for each command
+- user settings
+- hidden w , w/o () in names
+- exit in menus
+- 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
+
+- save outputs, errors
+
+- chmod a+x logged script
+
+- exec most recent logged scripts
+
+- cmd to list last n
+- cmd to repeat last
+
 ## [Unreleased]
 
+## [0.2.3] - 2022-03
+
+### 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
+
+- Improve processing of file and path sepcs.
+
 ## [0.1.0] - 2022-03-06
 
 - Initial release

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.3)
       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,43 +1,98 @@
 # 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 can be named.
+* Code blocks may be named.
 
 * Named blocks can be required by other blocks.
 
-* The selected code block, and all required blocks, are collected in the order they appear in the markdown file.
+* The user-selected code block, and all required blocks, are arranged in the order they appear in the 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`
-Process `README.md` file in the current directory. Displays all the blocks in the file and allows you to select using [up], [down], and [return]. Press [ctrl]-c to abort selection.
+### `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 my.md` or `mde -f my.md`
+Select a block to execute from `my.md`.
+
+### `mde .` or `mde -p .`
+
+Select a markdown file in the current folder. Select a block to execute from that file.
+
+### `mde --list-blocks`
+List all blocks in the all the markdown documents in the current folder.
+
+### `mde --list-docs`
+List all markdown documents in the current 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.
+
+e.g. Use to set the default file for the current folder.
+
+* `filename: CHANGELOG.md` sets the file to open.
+* `folder: documents` sets the folder to search for default or specified files.
+
+# Example blocks
+When prompted, select either the `awake` or `asleep` block.
+
+``` :(day)
+export TIME=early
+```
 
-`mde -f my.md`
-Process `my.md` file in the current directory.
+``` :(night)
+export TIME=late
+```
 
-`mde -p child`
-Process markdown files in the `child` directory.
+``` :awake +(day) +(report)
+export ACTIVITY=awake
+```
 
-`mde --list-blocks`
-List all blocks in the selected files.
+``` :asleep +(night) +(report)
+export ACTIVITY=asleep
+```
 
-`mde --list-docs`
-List all markdown documents in the selected folder.
+``` :(report)
+echo "$TIME -> $ACTIVITY"
+```
 
-## License
+# License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+# 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).

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.1.3'
+  VERSION = '0.2.3'
 end