markdown_exec 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f8bb9f8a7a903a6b221ed8d04a5acb445e294be4c134202b9a71ba9e9f7c7ac
-  data.tar.gz: d26a89ae33f1aeaac70b40f3e31b3090fb50c6eb48874eeba435ce89825123fc
+  metadata.gz: 160eb660362db62302a05b8b46398c6d85357c917ee55eeb89a8ce0f739eec8a
+  data.tar.gz: 706e575c290ec56d34ad58f06ca9e30127b2c0bdacf431a4c9e3f69bc30e80dc
 SHA512:
-  metadata.gz: f177057c231ef950012abc922b6c3d9611e0b423df57cee07e6ac0e68864c18ce9b6a7cf640e165dbd8409d6ecefb199a3bb31643a7c5e31d5c241f17682545e
-  data.tar.gz: 9fb1a5d4274d2443e1ed9680978cfb12c76b46416a3ba76483addd19b61238446dce86793a039cfede131bdd11a4436ae693640ad279add82e24415a544b7b53
+  metadata.gz: f540464a21a3ca2b654d89b3bc32f2172a3e610066bc64b9eae1bc29d99b8006ed3581998a50ae2327052c944656584375df55e64ffeeb77864ae05e45325e1c
+  data.tar.gz: a22c5ff757a2b5173725786bdbc399cae29f63eda891a0741149286391cb413abbcccd3799bd15ec769230ed44245b49664d434c77c12610bc2cfc138a9d3ddb

data/.reek

@@ -0,0 +1,24 @@
+---
+detectors:
+  DataClump:
+    enabled: false
+  NilCheck:
+    enabled: false
+  TooManyStatements:
+    enabled: false
+  UtilityFunction:
+    public_methods_only: true
+  ControlParameter:
+    enabled: true
+  DuplicateMethodCall:
+    enabled: true
+  FeatureEnvy:
+    enabled: false # too strict
+  InstanceVariableAssumption:
+    enabled: true
+  IrresponsibleModule:
+    enabled: true
+  LongParameterList:
+    enabled: true
+  LongYieldList:
+    enabled: true

data/CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## [ToDo]
+`reek lib/markdown_exec.rb --config .reek`
 
 - user settings
 - hidden w , w/o () in names
@@ -36,6 +37,21 @@
 - [ ] repeat to reload last doc and block
 - [ ] option to log blended, timeline; stdin, stdout, stderr; labels: prefix and blocks
 - [ ] ren logged_stdout_filename_prefix to saved_stdout_filename_prefix
+- [ ] ignore '#' in fenced code blocks
+
+## [1.2.0] - 2022-06-11
+
+### Added
+
+- Options
+    - Display document name in block selection menu
+    - Display headings (levels 1,2,3) in block selection menu
+- Trap Ctrl-C (SIGTERM) while script is executing.
+  Completes MDE processes such as saving output and reporting results.
+
+### Changed
+
+- Refactoring
 
 ## [1.1.1] - 2022-05-25
 

data/Gemfile

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

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    markdown_exec (1.1.1)
+    markdown_exec (1.2.0)
       clipboard (~> 1.3.6)
-      mrdialog (~> 1.0.3)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
       tty-prompt (~> 0.23.1)
@@ -17,8 +16,8 @@ GEM
     clipboard (1.3.6)
     erb (2.2.3)
       cgi
+    kwalify (0.7.2)
     minitest (5.15.0)
-    mrdialog (1.0.3)
     open3 (0.1.1)
     optparse (0.1.1)
     parallel (1.21.0)
@@ -28,6 +27,10 @@ GEM
       tty-color (~> 0.5)
     rainbow (3.1.1)
     rake (13.0.6)
+    reek (6.1.1)
+      kwalify (~> 0.7.0)
+      parser (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
     regexp_parser (2.2.1)
     rexml (3.2.5)
     rubocop (1.26.0)
@@ -70,8 +73,8 @@ DEPENDENCIES
   erb
   markdown_exec!
   minitest (~> 5.0)
-  mrdialog (~> 1.0.3)
   rake (~> 13.0)
+  reek
   rubocop (~> 1.21)
   rubocop-minitest
   rubocop-rake

data/README.md

@@ -203,6 +203,10 @@ export ACTIVITY=asleep
 echo "$TIME -> $ACTIVITY"
 ```
 
+``` :sleep
+sleep 10
+```
+
 # License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -5,8 +5,6 @@ require 'rake/testtask'
 require 'erb'
 require 'yaml'
 
-require_relative 'lib/shared'
-
 Rake::TestTask.new(:test) do |task|
   task.libs << 'test'
   task.libs << 'lib'
@@ -15,6 +13,11 @@ end
 
 require 'rubocop/rake_task'
 
+require_relative 'lib/shared'
+require_relative 'lib/tap'
+
+include Tap # rubocop:disable Style/MixinUsage
+
 RuboCop::RakeTask.new do |task|
   task.requires << 'rubocop-minitest'
 end
@@ -26,12 +29,13 @@ end
 
 require_relative 'lib/markdown_exec/version'
 
-task default: %i[test rubocop rubocopminitest]
+task default: %i[test reek rubocop rubocopminitest]
 
 # task :default => :build
 
 desc 'gem build'
 task :build do
+  Rake::Task['update_tab_completion'].execute
   system "gem build #{MarkdownExec::GEM_NAME}.gemspec"
 end
 
@@ -55,13 +59,29 @@ task :clean do
   system 'rm *.gem'
 end
 
+desc 'reek'
+task :reek do
+  `reek --config .reek .`
+end
+
 private
 
 BF = 'bin'
 
+# format for use in array in bash script
+# `opts=<%= mde_tab_completions %>`
+#
+def words_list(words)
+  words.map do |word|
+    %("#{word}")
+  end.join ' '
+end
+
+# write tab_completion.sh with erb
+#
 def update_tab_completion(target)
   words = `#{File.join BF, MarkdownExec::BIN_NAME} --tab-completions`.split("\n")
-  mde_tab_completions = '(' + (words.map { |s| "\"#{s}\"" }).join(' ') + ')'
+  mde_tab_completions = "(#{words_list(words)})"
   mde_help = `#{File.join BF, MarkdownExec::BIN_NAME} --help`.split("\n")
   menu_export_yaml = `#{File.join BF, MarkdownExec::BIN_NAME} --menu-export`
 

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.1.1"
+  echo "1.2.0"
 }
 
 _mde() {
@@ -42,6 +42,10 @@ _mde() {
             
               --logged-stdout-filename-prefix) COMPREPLY="mde"; return 0 ;;
             
+              --menu-blocks-with-docname) COMPREPLY="0"; return 0 ;;
+            
+              --menu-blocks-with-headings) COMPREPLY="0"; return 0 ;;
+            
               --output-execution-summary) COMPREPLY="0"; return 0 ;;
             
               --output-script) COMPREPLY="0"; return 0 ;;
@@ -76,7 +80,7 @@ _mde() {
   # present matching option names
   #
   if [[ ${cur} == -* ]] ; then
-    opts=("--list-blocks" "--list-default-env" "--list-default-yaml" "--list-docs" "--list-recent-output" "--list-recent-scripts" "--pwd" "--run-last-script" "--select-recent-output" "--select-recent-script" "--menu-export" "--tab-completions" "--help" "--version" "--exit" "--config" "--debug" "--display-level" "--block-name" "--filename" "--list-count" "--logged-stdout-filename-prefix" "--output-execution-summary" "--output-script" "--output-stdout" "--path" "--save-executed-script" "--save-execution-output" "--saved-script-chmod" "--saved-script-filename-prefix" "--saved-script-folder" "--saved-script-glob" "--saved-stdout-folder" "--saved-stdout-glob" "--user-must-approve")
+    opts=("--list-blocks" "--list-default-env" "--list-default-yaml" "--list-docs" "--list-recent-output" "--list-recent-scripts" "--pwd" "--run-last-script" "--select-recent-output" "--select-recent-script" "--menu-export" "--tab-completions" "--help" "--version" "--exit" "--config" "--debug" "--display-level" "--block-name" "--filename" "--list-count" "--logged-stdout-filename-prefix" "--menu-blocks-with-docname" "--menu-blocks-with-headings" "--output-execution-summary" "--output-script" "--output-stdout" "--path" "--save-executed-script" "--save-execution-output" "--saved-script-chmod" "--saved-script-filename-prefix" "--saved-script-folder" "--saved-script-glob" "--saved-stdout-folder" "--saved-stdout-glob" "--user-must-approve")
     COMPREPLY=( $(compgen -W "$(printf "'%s' " "${opts[@]}")" -- "${cur}") )
 
     return 0
@@ -103,6 +107,10 @@ _mde() {
         
           --logged-stdout-filename-prefix) COMPREPLY=".PREFIX."; return 0 ;;
         
+          --menu-blocks-with-docname) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --menu-blocks-with-headings) COMPREPLY=".BOOL."; return 0 ;;
+        
           --output-execution-summary) COMPREPLY=".BOOL."; return 0 ;;
         
           --output-script) COMPREPLY=".BOOL."; return 0 ;;
@@ -140,4 +148,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2022-05-26 01:40:10 UTC"
+# echo "Updated: 2022-06-12 20:31:36 UTC"

data/lib/colorize.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+# │0  │ to restore default    │
+# │   │ color                 │
+# ├───┼───────────────────────┤
+# │   │                       │
+# │1  │ for brighter colors   │
+# ├───┼───────────────────────┤
+# │   │                       │
+# │4  │ for underlined text   │
+# ├───┼───────────────────────┤
+# │   │                       │
+# │5  │ for flashing text
+class String
+  def black
+    "\033[30m#{self}\033[0m"
+  end
+
+  def red
+    "\033[31m#{self}\033[0m"
+  end
+
+  def bred
+    "\033[1;31m#{self}\033[0m"
+  end
+
+  def green
+    "\033[32m#{self}\033[0m"
+  end
+
+  def bgreen
+    "\033[1;32m#{self}\033[0m"
+  end
+
+  def yellow
+    "\033[33m#{self}\033[0m"
+  end
+
+  def byellow
+    "\033[1;33m#{self}\033[0m"
+  end
+
+  def blue
+    "\033[34m#{self}\033[0m"
+  end
+
+  def magenta
+    "\033[35m#{self}\033[0m"
+  end
+
+  def cyan
+    "\033[36m#{self}\033[0m"
+  end
+
+  def white
+    "\033[37m#{self}\033[0m"
+  end
+
+  def bwhite
+    "\033[1;37m#{self}\033[0m"
+  end
+end

data/lib/env.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+# utility functions to read environment variables
+#
+module Env
+  # :reek:BooleanParameter
+  # :reek:DataClump
+  # :reek:NilCheck
+  # :reek:UtilityFunction
+  def env_bool(name, default: false)
+    return default if name.nil? || (val = ENV[name]).nil?
+    return false if val.empty? || val == '0'
+
+    true
+  end
+
+  # skip :reek:DataClump
+  # skip :reek:NilCheck
+  # skip :reek:UtilityFunction
+  def env_int(name, default: 0)
+    return default if name.nil? || (val = ENV[name]).nil?
+    return default if val.empty?
+
+    val.to_i
+  end
+
+  # skip :reek:DataClump
+  # skip :reek:NilCheck
+  # skip :reek:UtilityFunction
+  def env_str(name, default: '')
+    return default if name.nil? || (val = ENV[name]).nil?
+
+    val || default
+  end
+end

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.1'
+  VERSION = '1.2.0'
 end