markdown_exec 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 631d15d315eeb3a40ef3458f9b0577d4b2f5f9eeddbcdd3ad26c9d2cb1e28c3a
-  data.tar.gz: f1fdebc4461fb7b5f3b37ebd2f8d369cbe804621cc42ca8c672baec5ea0c4f74
+  metadata.gz: 0103a836804fd50f493ec31ad7899a7b1235c1b26feb2ce30b8f2738657f820f
+  data.tar.gz: 0b2cbd8e447e0dab4c6f63c3d23cd1c952841a713414df49193cef0495d0fca4
 SHA512:
-  metadata.gz: f597613ff0bd0c556e0c205168d32653b4a4cd71cd93c24549b0b9f3f18dd8551ca301ac618f191fa005dfdbfaceef6263e4fe18cb229244c20c989b8fb99ac4
-  data.tar.gz: c890e7187a1394e37f56a81e7f3a2a64dbd3ec0fe8f6d9b904089b9d7b3d10a89c7df476aac2ff3bc437c50137d89f28bea8f4711995f2b1ed8f660785dd76ae
+  metadata.gz: df473dc9a66adae26932f11268f2a9d7fd4faae7949a0ab8b97a148916f41a679173d1500696e3d822ff49c9d730a7e9e28ac7601e19fb9c6edd513c042da05f
+  data.tar.gz: 8bb208972a34a57a9e2008a081e957e6e11a1e4d2e69aae28575e8af6afb3d8199116799b324e202706c909b3760f0b4c92d7c8f1b6a332ce98e00c01f560464

data/.rubocop.yml

@@ -1,6 +1,36 @@
 AllCops:
   TargetRubyVersion: 2.6
 
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# Metrics/LayoutLength:
+#   Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes

data/Gemfile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in markdown_exec.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "minitest", "~> 5.0"
+gem 'minitest', '~> 5.0'
 
-gem "rubocop", "~> 1.21"
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    markdown_exec (0.0.3)
+      tty-prompt (~> 0.23.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.26.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unicode-display_width (2.1.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  markdown_exec!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.2.32

data/Rakefile

@@ -1,37 +1,37 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+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"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
 task default: %i[test rubocop]
 
-GEM_NAME = "pagekey"
-GEM_VERSION = "0.0.0"
+GEM_NAME = 'markdown_exec'
+GEM_VERSION = '0.0.3'
 
 # task :default => :build
 
 task :build do
-  system "gem build " + GEM_NAME + ".gemspec"
+  system "gem build #{GEM_NAME}.gemspec"
 end
 
-task :install => :build do
-  system "gem install " + GEM_NAME + "-" + GEM_VERSION + ".gem"
+task install: :build do
+  system "gem install #{GEM_NAME}-#{GEM_VERSION}.gem"
 end
 
-task :publish => :build do
-  system 'gem push ' + GEM_NAME + "-" + GEM_VERSION + ".gem"
+task publish: :build do
+  system "gem push #{GEM_NAME}-#{GEM_VERSION}.gem"
 end
 
 task :clean do
-  system "rm *.gem"
+  system 'rm *.gem'
 end

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "markdown_exec"
+require 'bundler/setup'
+require 'markdown_exec'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require "markdown_exec"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/mde

@@ -2,21 +2,22 @@
 # frozen_string_literal: true
 
 # encoding=utf-8
+# rubocop:disable Style/GlobalVars
 
-env_debug = ENV["MARKDOWN_EXEC_DEBUG"]
-$pdebug = !(env_debug || "").empty?
+env_debug = ENV['MARKDOWN_EXEC_DEBUG']
+$pdebug = !(env_debug || '').empty?
 
-APP_NAME = "MDExec"
-APP_DESC = "Markdown block executor"
-VERSION = "0.0.2"
+APP_NAME = 'MDExec'
+APP_DESC = 'Markdown block executor'
+VERSION = '0.0.3'
 
-require "markdown_exec"
+require 'markdown_exec'
 # puts MarkdownExec::MDExec.echo(ARGV[0])
 
-require "optparse"
-require "pathname"
-require "tty-prompt"
-require "yaml"
+require 'optparse'
+require 'pathname'
+require 'tty-prompt'
+require 'yaml'
 
 # require_relative 'mdlib'
 # #!/usr/bin/env ruby
@@ -26,12 +27,8 @@ require "yaml"
 # env_debug = ENV['MARKDOWN_EXEC_DEBUG']
 # $pdebug = !(env_debug || '').empty?
 
-require "open3"
-require "tty-prompt"
-# require 'yaml'
-# require_relative 'deep_merge'
-# require_relative 'object_odig'
-# require_relative 'present'
+require 'open3'
+# require 'tty-prompt'
 
 BLOCK_SIZE = 1024
 SELECT_PAGE_HEIGHT = 12
@@ -56,7 +53,7 @@ class MarkParse
   def find_files
     puts "pwd: #{`pwd`}" if $pdebug
     # `ls -1 *.md`.split("\n").tap { |ret| puts "find_files() ret: #{ret.inspect}" if $pdebug }
-    `ls -1 #{File.join options[:mdfolder], "*.md"}`.split("\n").tap do |ret|
+    `ls -1 #{File.join options[:mdfolder], '*.md'}`.split("\n").tap do |ret|
       puts "find_files() ret: #{ret.inspect}" if $pdebug
     end
   end
@@ -109,7 +106,7 @@ class MarkParse
     blocks = []
     current = nil
     in_block = false
-    block_title = ""
+    block_title = ''
 
     headings = []
     File.readlines(opts[:mdfilename]).each do |line|
@@ -117,11 +114,11 @@ class MarkParse
       continue unless line
 
       if opts[:mdheadings]
-        if lm = line.match(/^### *(.+?) *$/)
+        if (lm = line.match(/^### *(.+?) *$/))
           headings = [headings[0], headings[1], lm[1]]
-        elsif lm = line.match(/^## *([^#]*?) *$/)
+        elsif (lm = line.match(/^## *([^#]*?) *$/))
           headings = [headings[0], lm[1]]
-        elsif lm = line.match(/^# *([^#]*?) *$/)
+        elsif (lm = line.match(/^# *([^#]*?) *$/))
           headings = [lm[1]]
         end
         puts "get_blocks() headings: #{headings.inspect}" if $pdebug
@@ -129,17 +126,17 @@ class MarkParse
 
       if line.match(/^`{3,}/)
         if in_block
-          puts "get_blocks() in_block" if $pdebug
+          puts 'get_blocks() in_block' if $pdebug
           if current
 
             # block_title ||= current.join(' ').gsub(/  +/, ' ')[0..64]
-            block_title = current.join(" ").gsub(/  +/, " ")[0..64] if block_title.nil? || block_title.empty?
+            block_title = current.join(' ').gsub(/  +/, ' ')[0..64] if block_title.nil? || block_title.empty?
 
             blocks += block_summary opts, headings, block_title, current
             current = nil
           end
           in_block = false
-          block_title = ""
+          block_title = ''
         else
           ## new block
           #
@@ -149,9 +146,9 @@ class MarkParse
 
           do1 = false
           if opts[:bash_only]
-            do1 = true if lm && (lm[1] == "bash")
+            do1 = true if lm && (lm[1] == 'bash')
           elsif opts[:exclude_expect_blocks]
-            do1 = true unless lm && (lm[1] == "expect")
+            do1 = true unless lm && (lm[1] == 'expect')
           else
             do1 = true
           end
@@ -180,7 +177,7 @@ class MarkParse
     puts "make_block_label() opts: #{opts.inspect}" if $pdebug
     puts "make_block_label() block: #{block.inspect}" if $pdebug
     if opts[:mdheadings]
-      heads = block.fetch(:headings, []).compact.join(" # ")
+      heads = block.fetch(:headings, []).compact.join(' # ')
       "#{block[:title]} [#{heads}] (#{opts[:mdfilename]})"
     else
       "#{block[:title]} (#{opts[:mdfilename]})"
@@ -201,7 +198,7 @@ class MarkParse
     puts "select_block() blocks: #{blocks.to_yaml}" if $pdebug
 
     prompt = TTY::Prompt.new(interrupt: :exit)
-    pt = "#{opts.fetch(:prompt, nil) || "Pick one"}:"
+    pt = "#{opts.fetch(:prompt, nil) || 'Pick one'}:"
     puts "select_block() pt: #{pt.inspect}" if $pdebug
 
     blocks.each { |block| block.merge! label: make_block_label(block, opts) }
@@ -226,9 +223,9 @@ class MarkParse
     #   puts "InputInterrupt"
     # end
 
-    block = blocks.select { |block| block[:label] == sel }.fetch(0, nil)
-    puts "select_block() block: #{block.inspect}" if $pdebug
-    sel = block[:name]
+    label_block = blocks.select { |block| block[:label] == sel }.fetch(0, nil)
+    puts "select_block() label_block: #{label_block.inspect}" if $pdebug
+    sel = label_block[:name]
     puts "select_block() sel: #{sel.inspect}" if $pdebug
 
     cbs = code_blocks(blocks, sel)
@@ -239,9 +236,9 @@ class MarkParse
     cbs.each { |cb| fout cb } if opts[:display] || opts[:approve]
 
     allow = true
-    allow = prompt.yes? "Process?" if opts[:approve]
+    allow = prompt.yes? 'Process?' if opts[:approve]
 
-    selected = table_block blocks, sel
+    selected = block_by_name blocks, sel
     puts "select_block() selected: #{selected.inspect}" if $pdebug
     if allow && opts[:execute]
 
@@ -249,7 +246,6 @@ class MarkParse
       #
       cmd2 = cbs.flatten.join("\n")
       fout "$ #{cmd2.to_yaml}"
-      cnt = 0
 
       # Open3.popen3(cmd2) do |stdin, stdout, stderr, wait_thr|
       #   cnt += 1
@@ -257,7 +253,7 @@ class MarkParse
       #   # stdin.close                # we're done
       #   stdout_str = stdout.read   # read stdout to string. note that this will block until the command is done!
       #   stderr_str = stderr.read   # read stderr to string
-      #   status = wait_thr.value    # will block until the command finishes; returns status that responds to .success? etc
+      #   status = wait_thr.value    # will block until the command finishes; returns status that responds to .success?
       #   fout "#{stdout_str}"
       #   fout "#{cnt}: err: #{stderr_str}" if stderr_str != ''
       #   # fout "#{cnt}: stt: #{status}"
@@ -278,15 +274,13 @@ class MarkParse
             # exceptions = ready[2]
 
             readable.each do |f|
-              fileno = f.fileno
-
-              begin
-                data = f.read_nonblock(BLOCK_SIZE)
-                # fout "- fileno: #{fileno}\n#{data}"
-                fout data
-              rescue EOFError => e
-                # fout "fileno: #{fileno} EOF"
-              end
+              # fileno = f.fileno
+
+              data = f.read_nonblock(BLOCK_SIZE)
+              # fout "- fileno: #{fileno}\n#{data}"
+              fout data
+            rescue EOFError #=> e
+              # fout "fileno: #{fileno} EOF"
             end
           end
         rescue IOError => e
@@ -315,7 +309,7 @@ class MarkParse
       end
 
       prompt = TTY::Prompt.new
-      sel = prompt.select("#{opts.fetch(:prompt, "Pick one")}:", files, per_page: select_per_page)
+      sel = prompt.select("#{opts.fetch(:prompt, 'Pick one')}:", files, per_page: select_per_page)
     end
 
     sel
@@ -334,25 +328,29 @@ class MarkParse
     puts "code() all: #{all.inspect}" if $pdebug
     all.reverse.map do |req|
       puts "code() req: #{req.inspect}" if $pdebug
-      table_block(table, req).fetch(:body, "")
-    end.flatten(1).tap { |ret| puts "code() ret: #{ret.inspect}" if $pdebug }
+      block_by_name(table, req).fetch(:body, '')
+    end
+       .flatten(1)
+       .tap { |ret| puts "code() ret: #{ret.inspect}" if $pdebug }
   end
 
-  def table_block(table, name, default = {})
+  def block_by_name(table, name, default = {})
     table.select { |block| block[:name] == name }.fetch(0, default)
   end
 
   def code_blocks(table, name)
     puts "code_blocks() table: #{table.inspect}" if $pdebug
     puts "code_blocks() name: #{name.inspect}" if $pdebug
-    block = table_block(table, name)
-    puts "code_blocks() block: #{block.inspect}" if $pdebug
-    all = [block[:name]] + unroll(table, block[:reqs])
+    name_block = block_by_name(table, name)
+    puts "code_blocks() name_block: #{name_block.inspect}" if $pdebug
+    all = [name_block[:name]] + unroll(table, name_block[:reqs])
     puts "code_blocks() all: #{all.inspect}" if $pdebug
-    all.reverse.map do |req|
-      puts "code_blocks() req: #{req.inspect}" if $pdebug
-      table_block(table, req).fetch(:body, "")
-    end.flatten(1).tap { |ret| puts "code_blocks() ret: #{ret.inspect}" if $pdebug }
+
+    # in order of appearance in document
+    table.select { |block| all.include? block[:name] }
+         .map { |block| block.fetch(:body, '') }
+         .flatten(1)
+         .tap { |ret| puts "code_blocks() ret: #{ret.inspect}" if $pdebug }
   end
 
   def unroll(table, reqs)
@@ -368,12 +366,13 @@ class MarkParse
 
         all += [req]
         puts "unrol() all: #{all.inspect}" if $pdebug
-        table_block(table, req).fetch(:reqs, [])
-      end.compact.flatten(1).tap { |_ret| puts "unroll() rem: #{rem.inspect}" if $pdebug }
+        block_by_name(table, req).fetch(:reqs, [])
     end
-    all.tap { |ret| puts "unroll() ret: #{ret.inspect}" if $pdebug }
+               .compact
+               .flatten(1)
+               .tap { |_ret| puts "unroll() rem: #{rem.inspect}" if $pdebug }
   end
-end
+    all.tap { |ret| puts "unroll() ret: #{ret.inspect}" if $pdebug }
 
 $stderr.sync = true
 $stdout.sync = true
@@ -386,10 +385,10 @@ end
 #
 def read_configuration!(options, configuration_path)
   if Pathname.new(configuration_path).exist?
-  	# rubocop:disable Security/YAMLLoad
-    options.merge!((YAML::load(open(configuration_path)) || {})
+    # rubocop:disable Security/YAMLLoad
+    options.merge!((YAML.load(File.open(configuration_path)) || {})
       .transform_keys(&:to_sym))
-  	# rubocop:enable Security/YAMLLoad
+    # rubocop:enable Security/YAMLLoad
   end
   options
 end
@@ -400,8 +399,8 @@ options = {
   mdheadings: true,
   list_blocks: false,
   list_docs: false,
-  mdfilename: "README.md",
-  mdfolder: "."
+  mdfilename: 'README.md',
+  mdfolder: '.'
 }
 
 def options_finalize!(options); end
@@ -415,58 +414,60 @@ read_configuration! options, ".#{APP_NAME.downcase}.yml"
 # load_resources! options
 # puts "q31 options: #{options.to_yaml}" if $pdebug
 
+# rubocop:disable Metrics/BlockLength
 option_parser = OptionParser.new do |opts|
   executable_name = File.basename($PROGRAM_NAME)
   opts.banner = [
-    APP_VDESC = "#{APP_NAME} - #{APP_DESC} (#{VERSION})",
+    "#{APP_NAME} - #{APP_DESC} (#{VERSION})".freeze,
     "Usage: #{executable_name} [options]"
   ].join("\n")
 
   ## menu top: on_head appear in reverse order added
   #
-  opts.on("--config PATH", "Read configuration file") do |value|
+  opts.on('--config PATH', 'Read configuration file') do |value|
     read_configuration! options, value
   end
 
   ## menu body: items appear in order added
   #
-  opts.on("-f RELATIVE", "--mdfilename", "Name of document") do |value|
+  opts.on('-f RELATIVE', '--mdfilename', 'Name of document') do |value|
     options[:mdfilename] = value
   end
 
-  opts.on("-p PATH", "--mdfolder", "Path to documents") do |value|
+  opts.on('-p PATH', '--mdfolder', 'Path to documents') do |value|
     options[:mdfolder] = value
   end
 
-  opts.on("--list-blocks", "List blocks") do |_value|
+  opts.on('--list-blocks', 'List blocks') do |_value|
     options[:list_blocks] = true
   end
 
-  opts.on("--list-docs", "List docs in current folder") do |_value|
+  opts.on('--list-docs', 'List docs in current folder') do |_value|
     options[:list_docs] = true
   end
 
   ## menu bottom: items appear in order added
   #
-  opts.on_tail("-h", "--help", "App help") do |_value|
+  opts.on_tail('-h', '--help', 'App help') do |_value|
     puts option_parser.help
     exit
   end
 
-  opts.on_tail("-v", "--version", "App version") do |_value|
+  opts.on_tail('-v', '--version', 'App version') do |_value|
     puts VERSION
     exit
   end
 
-  opts.on_tail("-x", "--exit", "Exit app") do |_value|
+  opts.on_tail('-x', '--exit', 'Exit app') do |_value|
     exit
   end
 
-  opts.on_tail("-0", "Show configuration") do |_v|
+  opts.on_tail('-0', 'Show configuration') do |_v|
     options_finalize! options
     puts options.to_yaml
   end
 end
+# rubocop:enable Metrics/BlockLength
 
 option_parser.load # filename defaults to basename of the program without suffix in a directory ~/.options
 option_parser.environment # env defaults to the basename of the program.
@@ -475,6 +476,7 @@ options_finalize! options
 
 ## process
 #
+# rubocop:disable Metrics/BlockLength
 loop do # once
   mp = MarkParse.new options
   options.merge!(
@@ -482,8 +484,9 @@ loop do # once
       approve: true,
       bash: true,
       display: true,
+      exclude_expect_blocks: true,
       execute: true,
-      prompt: "Execute",
+      prompt: 'Execute',
       struct: true
     }
   )
@@ -506,6 +509,7 @@ loop do # once
   #
   mp.select_block(bash: true, struct: true) if options[:mdfilename]
 
+  # rubocop:disable Style/BlockComments
 =begin
   # rescue ArgumentError => e
   #   puts "User abort: #{e}"
@@ -517,5 +521,9 @@ loop do # once
   # ensure
   #   exit
 =end
-  break unless false
+  # rubocop:enable Style/BlockComments
+
+  break unless false # rubocop:disable Lint/LiteralAsCondition
 end
+# rubocop:enable Metrics/BlockLength
+# rubocop:enable Style/GlobalVars

data/lib/markdown_exec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MarkdownExec
-  VERSION = "0.0.1"
+  VERSION = '0.0.3'
 end

data/lib/markdown_exec.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "markdown_exec/version"
+require_relative 'markdown_exec/version'
 
 module MarkdownExec
   class Error < StandardError; end
-  # Your code goes here...
 
+  # Markdown Exec
   class MDExec
-    def self.echo(str = "")
+    def self.echo(str = '')
       "#{str}#{str}"
     end
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
-dependencies: []
+date: 2022-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
 description: Execute shell blocks in markdown files. Name blocks and require named
   blocks.
 email:
@@ -22,6 +36,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -30,11 +45,11 @@ files:
 - bin/setup
 - lib/markdown_exec.rb
 - lib/markdown_exec/version.rb
-homepage: https://rubygems.org/gems/markdown_executor
+homepage: https://rubygems.org/gems/markdown_exec
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://rubygems.org/gems/markdown_executor
+  homepage_uri: https://rubygems.org/gems/markdown_exec
 post_install_message:
 rdoc_options: []
 require_paths: