markdown_exec 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d9976af006093768c7673d5ef0abeff6766539ff86029179d45db0530a4e203
-  data.tar.gz: c2814cf1b85ba80352819c2866862e40a9185874469edc65e0673485e0ca4f7e
+  metadata.gz: 7a2b550aaccca7d0752e57c39808f5d8d3b889b9d74cf3330dee6832b2f6c535
+  data.tar.gz: 1296490dd79071f78b5009cb843c911fe822257ed148b4c1a516366eb02407ca
 SHA512:
-  metadata.gz: 9720f8af38d17eba836b73407dedf71848c19663fa017277d3a62e003e19da36a3cad881796ce58e7b84d3d03a94a3a130d6876ac41c908d4694dadc80b53c6b
-  data.tar.gz: 707486f6a6e424787ee7ef05336d5a7290375844f477f369aa7dce2dc72d7f0343d425d83ac778d6b12859b4e155c6fea0ed0acb0cc3719b2d42b5fbf99f2c7b
+  metadata.gz: 43f659be4397e4bb24811a8219de7b58e9665aa8751063281e2cfbbf94263ceda15f411a34fe31293869f0bbdba761c2afce72ea7f800b54edba75424313bd19
+  data.tar.gz: bd48ac8a5ebedbc8b92af6345743d1bd6cf50705d05769e7144ccad998ddf0f00de72366779cb654a4272c3cc2f044c4c7e46ae9df935dcb4fc486a67e54453e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [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.

data/README.md

@@ -25,9 +25,11 @@ Displays help information.
 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`
 Select a block to execute from `my.md`.
 
 `mde -p .`
+`mde .`
 Select a markdown file in the current folder. Select a block to execute from that file.
 
 `mde --list-blocks`
@@ -52,31 +54,26 @@ e.g. Use to set the default file for the current folder.
 
 # 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

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.1'
 end

data/lib/markdown_exec.rb

@@ -123,28 +123,35 @@ module MarkdownExec
             #
 
             lm = line.match(/^`{3,}([^`\s]*) *(.*)$/)
-
             do1 = false
             if opts[:bash_only]
               do1 = true if lm && (lm[1] == 'bash')
-            elsif opts[:exclude_expect_blocks]
-              do1 = true unless lm && (lm[1] == 'expect')
             else
               do1 = true
+              do1 = !(lm && (lm[1] == 'expect')) if opts[:exclude_expect_blocks]
+
+              #             if do1 && opts[:exclude_matching_block_names]
+              # puts " MW a4"
+              # puts " MW a4 #{(lm[2].match %r{^:\(.+\)$})}"
+              #               do1 = !(lm && (lm[2].match %r{^:\(.+\)$}))
+              #             end
             end
 
+            in_block = true
             if do1 && (!opts[:title_match] || (lm && lm[2] && lm[2].match(opts[:title_match])))
               current = []
-              in_block = true
               block_title = (lm && lm[2])
             end
-
           end
         elsif current
           current += [line.chomp]
         end
       end
       blocks.tap { |ret| puts "list_blocks_in_file() ret: #{ret.inspect}" if $pdebug }
+      # blocks.map do |block|
+      #   next if opts[:exclude_matching_block_names] && block[:name].match(%r{^\(.+\)$})
+      #   block
+      # end.compact.tap { |ret| puts "list_blocks_in_file() ret: #{ret.inspect}" if $pdebug }
     end
 
     def list_files_per_options(options)
@@ -184,6 +191,15 @@ module MarkdownExec
       Dir.glob(File.join(options[:folder], '*.md'))
     end
 
+    def list_named_blocks_in_file(call_options = {}, &options_block)
+      opts = optsmerge call_options, options_block
+      list_blocks_in_file(opts).map do |block|
+        next if opts[:exclude_matching_block_names] && block[:name].match(/^\(.+\)$/)
+
+        block
+      end.compact.tap { |ret| puts "list_named_blocks_in_file() ret: #{ret.inspect}" if $pdebug }
+    end
+
     def code(table, block)
       all = [block[:name]] + recursively_required(table, block[:reqs])
       all.reverse.map do |req|
@@ -217,7 +233,17 @@ module MarkdownExec
     def make_block_labels(call_options = {})
       opts = options.merge(call_options)
       list_blocks_in_file(opts).map do |block|
+        # next if opts[:exclude_matching_block_names] && block[:name].match(%r{^:\(.+\)$})
+
         make_block_label block, opts
+      end.compact.tap { |ret| puts "make_block_labels() ret: #{ret.inspect}" if $pdebug }
+    end
+
+    def option_exclude_blocks(opts, blocks)
+      if opts[:exclude_matching_block_names]
+        blocks.reject { |block| block[:name].match(/^\(.+\)$/) }
+      else
+        blocks
       end
     end
 
@@ -278,7 +304,7 @@ module MarkdownExec
         executable_name = File.basename($PROGRAM_NAME)
         opts.banner = [
           "#{MarkdownExec::APP_NAME} - #{MarkdownExec::APP_DESC} (#{MarkdownExec::VERSION})",
-          "Usage: #{executable_name} [options]"
+          "Usage: #{executable_name} [filename or path] [options]"
         ].join("\n")
 
         ## menu top: items appear in reverse order added
@@ -293,7 +319,7 @@ module MarkdownExec
           options[:filename] = value
         end
 
-        opts.on('-p PATH', '--folder', 'Path to documents') do |value|
+        opts.on('-p PATH', '--path', 'Path to documents') do |value|
           options[:folder] = value
         end
 
@@ -328,9 +354,17 @@ module MarkdownExec
       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)
+      rest = option_parser.parse! # (into: options)
       options_finalize.call options
 
+      if rest.fetch(0, nil)&.present?
+        if Dir.exist?(rest[0])
+          options[:folder] = rest[0]
+        elsif File.exist?(rest[0])
+          options[:filename] = rest[0]
+        end
+      end
+
       ## process
       #
       options.merge!(
@@ -339,6 +373,7 @@ module MarkdownExec
           bash: true,
           display: true,
           exclude_expect_blocks: true,
+          exclude_matching_block_names: true,
           execute: true,
           prompt: 'Execute',
           struct: true
@@ -375,8 +410,14 @@ module MarkdownExec
       prompt = TTY::Prompt.new(interrupt: :exit)
       pt = "#{opts.fetch(:prompt, nil) || 'Pick one'}:"
 
+      # blocks.map do |block|
+      #   next if opts[:exclude_matching_block_names] && block[:name].match(%r{^\(.+\)$})
+      #   block
+      # end.compact.tap { |ret| puts "list_blocks_in_file() ret: #{ret.inspect}" if $pdebug }
+
       blocks.each { |block| block.merge! label: make_block_label(block, opts) }
-      block_labels = blocks.map { |block| block[:label] }
+      # block_labels = blocks.map { |block| block[:label] }
+      block_labels = option_exclude_blocks(opts, blocks).map { |block| block[:label] }
 
       if opts[:preview_options]
         select_per_page = 3
@@ -406,8 +447,6 @@ module MarkdownExec
       selected = get_block_by_name blocks, sel
       if allow && opts[:execute]
 
-        ## process in script, to handle line continuations
-        #
         cmd2 = cbs.flatten.join("\n")
 
         Open3.popen3(cmd2) do |stdin, stdout, stderr|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Fareed Stevenson