markdown_exec 0.0.6 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c89f954d1fc114cb22e9222ebc2c7d0575848d597899e1385edbf7b5963f08b
-  data.tar.gz: f14d0e24a3c348c303e96014b68a477d560ed1c3c707ac486173ffe19513df1d
+  metadata.gz: d9bea3a54afa348fb845a58f5878a0ffaa7c1054c3ddcb3444d67a8ab82f3f33
+  data.tar.gz: 3c305eb76fc06e013f38978144d668d864a67903d2be9a9de8eaa1e0f221c448
 SHA512:
-  metadata.gz: b78cd2cfbef3c47acd318c173fa953891f83c29ea2ac59b062dafc2e2ce8573c4f862f2e681cacb6ebd827dc77b10b984dd8a33a1349849357e9c64ab564932d
-  data.tar.gz: 8f8282f7a5a171dee4c83f9fce9974f48b7ee55b43d25651bfebaec0f46b97028c1ed58bd23ea85a796f949cd1eeae923d6899a5efb448879de96aa37287915d
+  metadata.gz: 3ba10e7a6a74ad1d13c08c3f19ec7ccde273df98a15194022fd803088bfa5c11a880a1f2b094b9b9e9f8979a998b480afd133252bf7b5e960bd2a7f856f26c2f
+  data.tar.gz: 3e031e16cf98a6301677d05caf09da89c227a32139c62f2844567e73acb5404171aa204a0bbf823844afab4e29a54894161f12a585d57e5223e304e587f96e2b

data/Gemfile.lock

@@ -1,14 +1,19 @@
 PATH
   remote: .
   specs:
-    markdown_exec (0.0.3)
+    markdown_exec (0.1.1)
+      open3 (~> 0.1.1)
+      optparse (~> 0.1.1)
       tty-prompt (~> 0.23.1)
+      yaml (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     minitest (5.15.0)
+    open3 (0.1.1)
+    optparse (0.1.1)
     parallel (1.21.0)
     parser (3.1.1.0)
       ast (~> 2.4.1)
@@ -42,6 +47,7 @@ GEM
     tty-screen (0.8.1)
     unicode-display_width (2.1.0)
     wisper (2.0.1)
+    yaml (0.2.0)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -1,38 +1,38 @@
 # MarkdownExec
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/markdown_exec`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem allows you to run code blocks in markdown files.
 
-TODO: Delete this and the text above, and describe your gem
+* Code blocks can be named.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'markdown_exec'
-```
+* Named blocks can be required by other blocks.
 
-And then execute:
+* The selected code block, and all required blocks, are collected in the order they appear in the markdown file.
 
-    $ bundle install
+## Installation
 
-Or install it yourself as:
+Install:
 
     $ gem install markdown_exec
 
 ## Usage
 
-TODO: Write usage instructions here
+`mde --help`
+Displays help information.
 
-## Development
+`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.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+`mde -f my.md`
+Process `my.md` file in the current directory.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`mde -p child`
+Process markdown files in the `child` directory.
 
-## Contributing
+`mde --list-blocks`
+List all blocks in the selected files.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/markdown_exec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/markdown_exec/blob/master/CODE_OF_CONDUCT.md).
+`mde --list-docs`
+List all markdown documents in the selected folder.
 
 ## License
 
@@ -41,24 +41,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## 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).
-
-# 2022-03-06
-```
-gem build markdown_exec.gemspec
-```
-```expect
-  Successfully built RubyGem
-  Name: markdown_exec
-  Version: 0.0.1
-  File: markdown_exec-0.0.1.gem
-```
-```
-gem install ./markdown_exec-0.0.1.gem
-```
-```
-gem list | grep exec
-```
-```
-gem uninstall markdown_exec
-```
-pusher api key: rubygems_8c4b38ef685484719858c53c3161a124c15d7a9bec6cb65a

data/Rakefile

@@ -13,27 +13,26 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[test rubocop]
+require_relative 'lib/markdown_exec/version'
 
-GEM_NAME = 'markdown_exec'
-GEM_VERSION = '0.0.6'
+task default: %i[test rubocop]
 
 # task :default => :build
 
 task :build do
-  system "gem build #{GEM_NAME}.gemspec"
+  system "gem build #{MarkdownExec::GEM_NAME}.gemspec"
 end
 
 task install: :build do
-  system "gem install #{GEM_NAME}-#{GEM_VERSION}.gem"
+  system "gem install #{MarkdownExec::GEM_NAME}-#{MarkdownExec::VERSION}.gem"
 end
 
 task publish: :build do
-  system "gem push #{GEM_NAME}-#{GEM_VERSION}.gem"
+  system "gem push #{MarkdownExec::GEM_NAME}-#{MarkdownExec::VERSION}.gem"
 end
 
 task uninstall: :build do
-  system "gem uninstall #{GEM_NAME}"
+  system "gem uninstall #{MarkdownExec::GEM_NAME}"
 end
 
 task :clean do

data/bin/mde

@@ -3,8 +3,6 @@
 
 # encoding=utf-8
 
-require 'markdown_exec'
+require_relative '../lib/markdown_exec'
 
-mp = MarkdownExec::MarkParse.new
-mp.fout Time.now
-# mp.run
+MarkdownExec::MarkParse.new.run

data/lib/markdown_exec/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
 module MarkdownExec
-  VERSION = '0.0.6'
+  APP_NAME = 'MDE'
+  APP_DESC = 'Markdown block executor'
+  GEM_NAME = 'markdown_exec'
+  VERSION = '0.1.2'
 end

data/lib/markdown_exec.rb

@@ -1,38 +1,17 @@
-# frozen_string_literal: true
-
-require_relative 'markdown_exec/version'
-
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # encoding=utf-8
-# rubocop:disable Style/GlobalVars
-
-env_debug = ENV['MARKDOWN_EXEC_DEBUG']
-$pdebug = !(env_debug || '').empty?
 
-# APP_NAME = 'MDExec'
-# APP_DESC = 'Markdown block executor'
-# VERSION = '0.0.6'
-
-# require 'markdown_exec'
-# # puts MarkdownExec::MarkParse.echo(ARGV[0])
+# rubocop:disable Style/GlobalVars
+$pdebug = !(ENV['MARKDOWN_EXEC_DEBUG'] || '').empty?
 
+require 'open3'
 require 'optparse'
-require 'pathname'
+# require 'pathname'
 require 'tty-prompt'
 require 'yaml'
-
-# require_relative 'mdlib'
-# #!/usr/bin/env ruby
-# # frozen_string_literal: true
-# # encoding=utf-8
-
-# env_debug = ENV['MARKDOWN_EXEC_DEBUG']
-# $pdebug = !(env_debug || '').empty?
-
-require 'open3'
-# require 'tty-prompt'
+require_relative 'markdown_exec/version'
 
 BLOCK_SIZE = 1024
 SELECT_PAGE_HEIGHT = 12
@@ -40,12 +19,6 @@ SELECT_PAGE_HEIGHT = 12
 module MarkdownExec
   class Error < StandardError; end
 
-  # Markdown Exec
-  # class MarkParse
-  #   def self.echo(str = '')
-  #     "#{str}#{str}"
-  #   end
-  # end
   ##
   #
   class MarkParse
@@ -183,7 +156,7 @@ module MarkdownExec
         end
       end
       blocks.tap { |ret| puts "get_blocks() ret: #{ret.inspect}" if $pdebug }
-    end
+    end # get_blocks
 
     def make_block_label(block, call_options = {})
       opts = options.merge(call_options)
@@ -303,7 +276,7 @@ module MarkdownExec
       end
 
       selected[:name]
-    end
+    end # select_block
 
     def select_md_file
       opts = options
@@ -387,150 +360,160 @@ module MarkdownExec
       end
       all.tap { |ret| puts "unroll() ret: #{ret.inspect}" if $pdebug }
     end
-  end
 
-  # $stderr.sync = true
-  # $stdout.sync = true
+    # $stderr.sync = true
+    # $stdout.sync = true
 
-  def fout(str)
-    puts str # to stdout
-  end
-
-  ## configuration file
-  #
-  def read_configuration!(options, configuration_path)
-    if Pathname.new(configuration_path).exist?
-      # rubocop:disable Security/YAMLLoad
-      options.merge!((YAML.load(File.open(configuration_path)) || {})
-        .transform_keys(&:to_sym))
-      # rubocop:enable Security/YAMLLoad
+    ## configuration file
+    #
+    def read_configuration!(options, configuration_path)
+      if File.exist?(configuration_path)
+        # rubocop:disable Security/YAMLLoad
+        options.merge!((YAML.load(File.open(configuration_path)) || {})
+          .transform_keys(&:to_sym))
+        # rubocop:enable Security/YAMLLoad
+      end
+      options
     end
-    options
-  end
 
-  def run
-    ## default configuration
-    #
-    options = {
-      mdheadings: true,
-      list_blocks: false,
-      list_docs: false,
-      mdfilename: 'README.md',
-      mdfolder: '.'
-    }
+    def run
+      ## default configuration
+      #
+      options = {
+        mdheadings: true,
+        list_blocks: false,
+        list_docs: false,
+        mdfilename: 'README.md',
+        mdfolder: '.'
+      }
 
-    def options_finalize!(options); end
+      def options_finalize!(options); end
 
-    # read local configuration file
-    #
-    read_configuration! options, ".#{APP_NAME.downcase}.yml"
+      # puts "MDE run() ARGV: #{ARGV.inspect}"
 
-    ## read current details for aws resources from app_data_file
-    #
-    # 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_NAME} - #{APP_DESC} (#{VERSION})".freeze,
-        "Usage: #{executable_name} [options]"
-      ].join("\n")
-
-      ## menu top: on_head appear in reverse order added
+      # read local configuration file
       #
-      opts.on('--config PATH', 'Read configuration file') do |value|
-        read_configuration! options, value
-      end
+      read_configuration! options, ".#{MarkdownExec::APP_NAME.downcase}.yml"
 
-      ## menu body: items appear in order added
+      ## read current details for aws resources from app_data_file
       #
-      opts.on('-f RELATIVE', '--mdfilename', 'Name of document') do |value|
-        options[:mdfilename] = value
-      end
-
-      opts.on('-p PATH', '--mdfolder', 'Path to documents') do |value|
-        options[:mdfolder] = value
-      end
+      # 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 = [
+          "#{MarkdownExec::APP_NAME} - #{MarkdownExec::APP_DESC} (#{MarkdownExec::VERSION})",
+          "Usage: #{executable_name} [options]"
+        ].join("\n")
+
+        ## menu top: on_head appear in reverse order added
+        #
+        opts.on('--config PATH', 'Read configuration file') do |value|
+          read_configuration! options, value
+        end
 
-      opts.on('--list-blocks', 'List blocks') do |_value|
-        options[:list_blocks] = true
-      end
+        ## menu body: items appear in order added
+        #
+        opts.on('-f RELATIVE', '--mdfilename', 'Name of document') do |value|
+          options[:mdfilename] = value
+        end
 
-      opts.on('--list-docs', 'List docs in current folder') do |_value|
-        options[:list_docs] = true
-      end
+        opts.on('-p PATH', '--mdfolder', 'Path to documents') do |value|
+          options[:mdfolder] = value
+        end
 
-      ## menu bottom: items appear in order added
-      #
-      opts.on_tail('-h', '--help', 'App help') do |_value|
-        puts option_parser.help
-        exit
-      end
+        opts.on('--list-blocks', 'List blocks') do |_value|
+          options[:list_blocks] = true
+        end
 
-      opts.on_tail('-v', '--version', 'App version') do |_value|
-        puts VERSION
-        exit
-      end
+        opts.on('--list-docs', 'List docs in current folder') do |_value|
+          options[:list_docs] = true
+        end
 
-      opts.on_tail('-x', '--exit', 'Exit app') do |_value|
-        exit
-      end
+        ## menu bottom: items appear in order added
+        #
+        opts.on_tail('-h', '--help', 'App help') do |_value|
+          puts option_parser.help
+          exit
+        end
 
-      opts.on_tail('-0', 'Show configuration') do |_v|
-        options_finalize! options
-        puts options.to_yaml
-      end
-    end
-    # rubocop:enable Metrics/BlockLength
+        opts.on_tail('-v', '--version', 'App version') do |_value|
+          puts MarkdownExec::VERSION
+          exit
+        end
 
-    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.
-    option_parser.parse! # (into: options)
-    options_finalize! options
+        opts.on_tail('-x', '--exit', 'Exit app') do |_value|
+          exit
+        end
 
-    ## process
-    #
-    # rubocop:disable Metrics/BlockLength
-    loop do # once
-      mp = MarkParse.new options
-      options.merge!(
-        {
-          approve: true,
-          bash: true,
-          display: true,
-          exclude_expect_blocks: true,
-          execute: true,
-          prompt: 'Execute',
-          struct: true
-        }
-      )
-
-      ## show
-      #
-      if options[:list_docs]
-        fout mp.find_files
-        break
-      end
+        opts.on_tail('-0', 'Show configuration') do |_v|
+          options_finalize! options
+          puts options.to_yaml
+        end
+      end # OptionParser
+      # rubocop:enable Metrics/BlockLength
 
-      if options[:list_blocks]
-        fout (mp.find_files.map do |file|
-                mp.make_block_labels(mdfilename: file, struct: true)
-              end).flatten(1).to_yaml
-        break
-      end
+      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.
+      option_parser.parse! # (into: options)
+      options_finalize! options
 
       ## process
       #
-      mp.select_block(bash: true, struct: true) if options[:mdfilename]
+      # rubocop:disable Metrics/BlockLength
+      loop do # once
+        mp = MarkParse.new options
+        options.merge!(
+          {
+            approve: true,
+            bash: true,
+            display: true,
+            exclude_expect_blocks: true,
+            execute: true,
+            prompt: 'Execute',
+            struct: true
+          }
+        )
+
+        ## show
+        #
+        if options[:list_docs]
+          fout mp.find_files
+          break
+        end
 
-      # rubocop:disable Style/BlockComments
-      # rubocop:enable Style/BlockComments
+        if options[:list_blocks]
+          fout (mp.find_files.map do |file|
+                  mp.make_block_labels(mdfilename: file, struct: true)
+                end).flatten(1).to_yaml
+          break
+        end
+
+        ## process
+        #
+        mp.select_block(bash: true, struct: true) if options[:mdfilename]
+
+# rubocop:disable Style/BlockComments
+=begin
+  # rescue ArgumentError => e
+  #   puts "User abort: #{e}"
+
+  # rescue StandardError => e
+  #   puts "ERROR: #{e}"
+  #   raise StandardError, e
+
+  # ensure
+  #   exit
+=end
+        # rubocop:enable Style/BlockComments
+
+        break unless false # rubocop:disable Lint/LiteralAsCondition
+      end # loop
+    end # run
+  end # class MarkParse
 
-      break unless false # rubocop:disable Lint/LiteralAsCondition
-    end
-  end
   # rubocop:enable Metrics/BlockLength
   # rubocop:enable Style/GlobalVars
-end
+end # module MarkdownExec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.2
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.1
-- !ruby/object:Gem::Dependency
-  name: pathname
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement