howzit 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fba7a6b730f2aabb0e92a26b772cc06fa4182ad07edf7f8620733be70debf766
-  data.tar.gz: 60900d73ffee99002daa4e32b5970c81986756c117fec172c824d59e87e72995
+  metadata.gz: 95a5f6c56ebff1fb944ca8ea23cba45ca5b71647654a315fd2cf7e486d522309
+  data.tar.gz: f9ac61f6fad2aff412d4302d0c586e9b287f284659255215a9565c8632bdfc8c
 SHA512:
-  metadata.gz: 819083c882f7f330d050d23486e390179beb95c4f220458c4a66c496a0fe99eb69746e762d90ce4c033983764693e5dc77499779e1138ae41e64c346b3930d45
-  data.tar.gz: 38d58943e9f8a8d32794ecc638257eb64f67cf09f0a22bc9811ca367627bafb48d22ceed7091551453700fd392fa857b94e37551208735433f0cf4a39ef27f6e
+  metadata.gz: be7ac525fc55a0e199b5762830bd0c6ef41b0b099627a45f1ca2aacd4508df3574f06e803513a22d870985631520c58b7f75c9e8519b5b02cf274eaeec577d56
+  data.tar.gz: e60252f5081ae563fc7eb8c207bb6ba0674b316455247cbc886e1b386dd33ecef234cfa493c6453bc02403daa11f79afb5f514c95a2f4e080302010466a7d4a6

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 2.0.5
+
+2022-08-04 10:50
+
+#### NEW
+
+- Make any task optional when running by adding a ? (@open?(...))
+- Optional tasks default to yes when you hit enter, invert by using a ! (@open?!(...)) to make default "no"
+
+#### FIXED
+
+- Replace escaped newlines in task list output so that they don't trigger a newline in the shell
+
 ### 2.0.4
 
 2022-08-04 06:25

data/README.md

@@ -94,6 +94,18 @@ You can include commands that can be executed by howzit. Commands start at the b
 
     A block defined between @after and @end markers will be displayed after a topic is run. Use it to remind yourself of additional tasks after automated ones have been executed. The content between these markers is still included when viewing the topic, but the tags themselves do not show up in output.
 
+### Adding Titles
+
+When displaying a topic, howzit can display a title instead of the contents of a directive. Any text after the closing parenthesis will be considered the task title.
+
+```
+@run(~/scripts/deploy.sh) Deploy script
+```
+
+When the topic is displayed, it will now show "Run Deploy script" instead of the path to the script. This can be overridden with the `--show-code` flag, which will instead show the contents of the directive.
+
+For adding titles to run blocks (fenced code), see below.
+
 ### Run blocks (embedded scripts)
 
 For longer scripts you can write shell scripts and then call them with `@run(myscript.sh)`. For those in-between cases where you need a few commands but aren't motivated to create a separate file, you can use fenced code blocks with `run` as the language.
@@ -117,6 +129,12 @@ Example:
 
 Multiple blocks can be included in a topic. @commands take priority over code blocks and will be run first if they exist in the same topic.
 
+### Requiring Confirmation
+
+You can have howzit confirm whether to execute an @command at runtime by including a question mark to the directive, e.g. `@run?(...)`. This will present a yes/no dialog before running the directive, with a default response of "yes" if you just hit return. To make the default response "no," add an exclamation point, e.g. `@run?!(...)`. 
+
+This works for any directive, including `@include`, and run blocks, which can use `run?` as the language specifier.
+
 ### Variables
 
 When running commands in a topic, you can use a double dash (`--`) in the command line (surrounded by spaces) and anything after it will be interpreted as shell arguments. These can be used in commands with `$` placeholders. `$1` represents the first argument, counting up from there. Use `$@` to pass all arguments as a shell-escaped string.

data/bin/howzit

@@ -115,7 +115,7 @@ OptionParser.new do |opts|
 
     parts = key.split(/=/)
     k = parts[0].sub(/^:/, '')
-    v = parts[1..-1].join(' ')
+    v = parts[1..].join(' ')
 
     if Howzit.options.key?(k.to_sym)
       Howzit.options[k.to_sym] = v.to_config_value(Howzit.options[k.to_sym])

data/lib/howzit/hash.rb

@@ -32,4 +32,24 @@ class ::Hash
   def deep_thaw!
     replace deep_thaw
   end
+
+  # Turn all keys into string
+  #
+  # Return a copy of the hash where all its keys are strings
+  def stringify_keys
+    each_with_object({}) { |(k, v), hsh| hsh[k.to_s] = v.is_a?(Hash) ? v.stringify_keys : v }
+  end
+
+  def stringify_keys!
+  	replace stringify_keys
+  end
+
+  # Turn all keys into symbols
+  def symbolize_keys
+    each_with_object({}) { |(k, v), hsh| hsh[k.to_sym] = v.is_a?(Hash) ? v.symbolize_keys : v }
+  end
+
+  def symbolize_keys!
+  	replace symbolize_keys
+  end
 end

data/lib/howzit/task.rb

@@ -2,13 +2,15 @@
 
 module Howzit
   class Task
-    attr_reader :type, :title, :action, :parent
+    attr_reader :type, :title, :action, :parent, :optional, :default
 
-    def initialize(type, title, action, parent = nil)
+    def initialize(type, title, action, parent = nil, optional: false, default: true)
       @type = type
       @title = title
       @action = action.render_arguments
       @parent = parent
+      @optional = optional
+      @default = default
     end
 
     def to_s
@@ -16,7 +18,7 @@ module Howzit
     end
 
     def to_list
-      "    * #{@type}: #{@title}"
+      "    * #{@type}: #{@title.gsub(/\\n/, '\​n')}"
     end
   end
 end

data/lib/howzit/topic.rb

@@ -28,12 +28,19 @@ module Howzit
       if @tasks.count.positive?
         unless @prereqs.empty?
           puts @prereqs.join("\n\n")
-          res = Prompt.yn('This task has prerequisites, have they been met?', default: true)
+          res = Prompt.yn('This topic has prerequisites, have they been met?', default: true)
           Process.exit 1 unless res
 
         end
 
         @tasks.each do |task|
+          if task.optional
+            q = %({bg}#{task.type.to_s.capitalize} {xw}"{bw}#{task.title}{xw}"{x}).c
+            res = Prompt.yn(q, default: task.default)
+            next unless res
+
+          end
+
           if task.type == :block
             warn "{bg}Running block {bw}#{title}{x}".c if Howzit.options[:log_level] < 2
             block = task.action
@@ -74,7 +81,7 @@ module Howzit
           end
         end
       else
-        warn "{r}--run: No {br}@directive{xr} found in {bw}#{key}{x}".c
+        warn "{r}--run: No {br}@directive{xr} found in {bw}#{@title}{x}".c
       end
       output.push("{bm}Ran #{tasks} #{tasks == 1 ? 'task' : 'tasks'}{x}".c) if Howzit.options[:log_level] < 2 && !nested
 
@@ -139,49 +146,57 @@ module Howzit
         output.push('')
       end
       topic = @content.dup
-      topic.gsub!(/(?mi)^(`{3,})run *([^\n]*)[\s\S]*?\n\1\s*$/, '@@@run \2') unless Howzit.options[:show_all_code]
+      topic.gsub!(/(?mi)^(`{3,})run([?!]*) *([^\n]*)[\s\S]*?\n\1\s*$/, '@@@run\2 \3') unless Howzit.options[:show_all_code]
       topic.split(/\n/).each do |l|
         case l
         when /@(before|after|prereq|end)/
           next
-        when /@include\((.*?)\)/
-          m = Regexp.last_match
-          matches = Howzit.buildnote.find_topic(m[1])
+        when /@include(?<optional>[!?]{1,2})?\((?<action>.*?)\)/
+          m = Regexp.last_match.named_captures.symbolize_keys
+          matches = Howzit.buildnote.find_topic(m[:action])
           unless matches.empty?
-            if opt[:single]
-              title = "From #{matches[0].title}:"
-              color = '{Kyd}'
-              rule = '{kKd}'
-            else
-              title = "Include #{matches[0].title}"
-              color = '{Kyd}'
-              rule = '{kKd}'
-            end
-            unless Howzit.inclusions.include?(matches[0])
-              output.push("#{'> ' * @nest_level}#{title}".format_header({ color: color, hr: '.', border: rule }))
+            i_topic = matches[0]
+            rule = '{kKd}'
+            color = '{Kyd}'
+            option = if i_topic.tasks.empty?
+                       ''
+                     else
+                       optional = m[:optional] =~ /[?!]+/ ? true : false
+                       default = m[:optional] =~ /!/ ? false : true
+                       if optional
+                         default ? " {xKk}[{gbK}Y{xKk}/{dbwK}n{xKk}]{x}#{color}".c : " {xKk}[{dbwK}y{xKk}/{bgK}N{xKk}]{x}#{color}".c
+                       else
+                         ''
+                       end
+                     end
+            title = "#{opt[:single] ? 'From' : 'Include'} #{i_topic.title}#{option}:"
+            options = { color: color, hr: '.', border: rule }
+            unless Howzit.inclusions.include?(i_topic)
+              output.push("#{'> ' * @nest_level}#{title}".format_header(options))
             end
 
-            if opt[:single]
-              if Howzit.inclusions.include?(matches[0])
-                output.push("#{'> ' * @nest_level}#{title} included above".format_header({
-                  color: color, hr: '.', border: rule }))
-              else
-                @nest_level += 1
-                output.concat(matches[0].print_out({ single: true, header: false }))
-                @nest_level -= 1
-              end
-              unless Howzit.inclusions.include?(matches[0])
-                output.push("#{'> ' * @nest_level}...".format_header({ color: color, hr: '.', border: rule }))
-              end
+            if opt[:single] && Howzit.inclusions.include?(i_topic)
+              output.push("#{'> ' * @nest_level}#{title} included above".format_header(options))
+            elsif opt[:single]
+              @nest_level += 1
+              output.concat(i_topic.print_out({ single: true, header: false }))
+              output.push("#{'> ' * @nest_level}...".format_header(options))
+              @nest_level -= 1
             end
-            Howzit.inclusions.push(matches[0])
+            Howzit.inclusions.push(i_topic)
           end
-
-        when /@(run|copy|open|url|include)\((.*?)\)(.*?)$/
-          m = Regexp.last_match
-          cmd = m[1]
-          obj = m[2]
-          title = m[3].empty? ? obj : m[3]
+        when /@(?<cmd>run|copy|open|url|include)(?<optional>[?!]{1,2})?\((?<action>.*?)\) *(?<title>.*?)$/
+          m = Regexp.last_match.named_captures.symbolize_keys
+          cmd = m[:cmd]
+          obj = m[:action]
+          title = m[:title].empty? ? obj : m[:title].strip
+          optional = m[:optional] =~ /[?!]+/ ? true : false
+          default = m[:optional] =~ /!/ ? false : true
+          option = if optional
+                     default ? ' {xk}[{g}Y{xk}/{dbw}n{xk}]{x}'.c : ' {xk}[{dbw}y{xk}/{g}N{xk}]{x}'.c
+                   else
+                     ''
+                   end
           icon = case cmd
                  when 'run'
                    "\u{25B6}"
@@ -191,14 +206,28 @@ module Howzit
                    "\u{279A}"
                  end
 
-          output.push("{bmK}#{icon} {bwK}#{title.gsub(/\\n/, '\​n')}{x}".c)
-        when /(`{3,})run *(.*?)$/i
-          m = Regexp.last_match
-          desc = m[2].length.positive? ? "Block: #{m[2]}" : 'Code Block'
+          output.push("{bmK}#{icon} {bwK}#{title.gsub(/\\n/, '\​n')}{x}#{option}".c)
+        when /(?<fence>`{3,})run(?<optional>[!?]{1,2})? *(?<title>.*?)$/i
+          m = Regexp.last_match.named_captures.symbolize_keys
+          optional = m[:optional] =~ /[?!]+/ ? true : false
+          default = m[:optional] =~ /!/ ? false : true
+          option = if optional
+                     default ? ' {xk}[{g}Y{xk}/{dbw}n{xk}]{x}'.c : ' {xk}[{dbw}y{xk}/{g}N{xk}]{x}'.c
+                   else
+                     ''
+                   end
+          desc = m[:title].length.positive? ? "Block: #{m[:title]}#{option}" : "Code Block#{option}"
           output.push("{bmK}\u{25B6} {bwK}#{desc}{x}\n```".c)
-        when /@@@run *(.*?)$/i
-          m = Regexp.last_match
-          desc = m[1].length.positive? ? "Block: #{m[1]}" : 'Code Block'
+        when /@@@run(?<optional>[!?]{1,2})? *(?<title>.*?)$/i
+          m = Regexp.last_match.named_captures.symbolize_keys
+          optional = m[:optional] =~ /[?!]+/ ? true : false
+          default = m[:optional] =~ /!/ ? false : true
+          option = if optional
+                     default ? ' {xk}[{g}Y{xk}/{dbw}n{xk}]{x}'.c : ' {xk}[{dbw}y{xk}/{g}N{xk}]{x}'.c
+                   else
+                     ''
+                   end
+          desc = m[:title].length.positive? ? "Block: #{m[:title]}#{option}" : "Code Block#{option}"
           output.push("{bmK}\u{25B6} {bwK}#{desc}{x}".c)
         else
           l.wrap!(Howzit.options[:wrap]) if Howzit.options[:wrap].positive?
@@ -215,18 +244,27 @@ module Howzit
       @prereqs = @content.scan(/(?<=@before\n).*?(?=\n@end)/im).map(&:strip)
       @postreqs = @content.scan(/(?<=@after\n).*?(?=\n@end)/im).map(&:strip)
 
-      rx = /(?:@(include|run|copy|open|url)\((.*?)\) *(.*?)(?=$)|(`{3,})run(?: +([^\n]+))?(.*?)\4)/mi
-      directives = @content.scan(rx)
+      rx = /(?mix)(?:
+            @(?<cmd>include|run|copy|open|url)(?<optional>[!?]{1,2})?\((?<action>[^)]*?)\)(?<title>[^\n]+)?
+            |(?<fence>`{3,})run(?<optional2>[!?]{1,2})?(?<title2>[^\n]+)?(?<block>.*?)\k<fence>
+            )/
+      matches = []
+      @content.scan(rx) { matches << Regexp.last_match }
+      matches.each do |m|
+        c = m.named_captures.symbolize_keys
 
-      directives.each do |c|
-        if c[0].nil?
-          title = c[4] ? c[4].strip : ''
-          block = c[5].strip
-          runnable << Howzit::Task.new(:block, title, block)
+        if c[:cmd].nil?
+          optional = c[:optional2] =~ /[?!]{1,2}/ ? true : false
+          default = c[:optional2] =~ /!/ ? false : true
+          title = c[:title2].nil? ? '' : c[:title2].strip
+          block = c[:block]&.strip
+          runnable << Howzit::Task.new(:block, title, block, optional: optional, default: default)
         else
-          cmd = c[0]
-          obj = c[1]
-          title = c[3] || obj
+          cmd = c[:cmd]
+          optional = c[:optional] =~ /[?!]{1,2}/ ? true : false
+          default = c[:optional] =~ /!/ ? false : true
+          obj = c[:action]
+          title = c[:title].nil? ? obj : c[:title].strip
 
           case cmd
           when /include/i
@@ -239,17 +277,15 @@ module Howzit
             #   end
             #   runnable.concat(tasks)
             # end
-            title = c[3] || obj
-            runnable << Howzit::Task.new(:include, title, obj)
+            runnable << Howzit::Task.new(:include, title, obj, optional: optional, default: default)
           when /run/i
-            title = c[3] || obj
             # warn "{bg}Running {bw}#{obj}{x}".c if Howzit.options[:log_level] < 2
-            runnable << Howzit::Task.new(:run, title, obj)
+            runnable << Howzit::Task.new(:run, title, obj, optional: optional, default: default)
           when /copy/i
             # warn "{bg}Copied {bw}#{obj}{bg} to clipboard{x}".c if Howzit.options[:log_level] < 2
-            runnable << Howzit::Task.new(:copy, title, Shellwords.escape(obj))
+            runnable << Howzit::Task.new(:copy, title, Shellwords.escape(obj), optional: optional, default: default)
           when /open|url/i
-            runnable << Howzit::Task.new(:open, title, obj)
+            runnable << Howzit::Task.new(:open, title, obj, optional: optional, default: default)
           end
         end
       end

data/lib/howzit/version.rb

@@ -3,5 +3,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '2.0.4'
+  VERSION = '2.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Brett Terpstra