howzit 2.0.26 → 2.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ef20bf69eaecc6f2d2df7ac9621dfbd227af13148ce2e0465d466b6206d8a59
-  data.tar.gz: 5923dbabfc6ec5d6bc1783ebb21b1a231fbfdaaa2ecd3887582b014a9642d8ab
+  metadata.gz: 1e49b8c3399fb8c6aa96f857ea9dd77e8f91b1292783c0b25167ebf9aa380485
+  data.tar.gz: 9af75120a0e39cc371bf68f78335be3fcc8ea508e18c64fe5b94d1e9affec4a8
 SHA512:
-  metadata.gz: b5e8c29926fa85e6b52e4d8463504a474f4d0e35765a8bf85294ab46f84e11c10d9f77f002d85ed2ea0db4657edd23a9faabe03f5c7ba0796aa38407d00e1180
-  data.tar.gz: 9340eff4ab693b1e82e11b201d63da704a4dc4d647bd5443b7b2bdfa8b5f1af98dc61cf4b42f76247c2ba4adbf2651ab82ea082136f68bdf0c5ebc0c904898d5
+  metadata.gz: f13f6c1d353c0ef3f8e041a0e3b2864ad808601c5aa4f3423d2830872e26650d29c33fce7b723489ac0557e314e17de8b3aba333a9692dda4e375bd372f17988
+  data.tar.gz: 9ebc50f699029414cd72d12ac83a591d6bcbe8f18f1cab175ea6bb81e40baf19b823129c7458947d6d9806448e1018209572f73271ca5c2398ba73f3fa9b9967

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### 2.0.29
+
+2022-08-30 04:20
+
+#### NEW
+
+- --yes flag will answer yes to all prompts when executing
+- --force flag will continue executing directives after an error
+
+#### IMPROVED
+
+- A non-zero exit status on a run directive will stop processing additional directives
+- A little extra output formatting, more descriptive results logging
+
+### 2.0.28
+
+2022-08-29 18:42
+
+#### IMPROVED
+
+- If a topic runs multiple directives, stop processing them if one returns a non-zero exit status
+
+### 2.0.27
+
+2022-08-23 12:25
+
+#### IMPROVED
+
+- Code cleanup
+
 ### 2.0.26
 
 2022-08-23 11:36

data/bin/howzit

@@ -20,14 +20,16 @@ OptionParser.new do |opts|
 
   opts.separator "  Behavior:\n\n" #=================================================================== BEHAVIOR
 
-  opts.on('--ask', 'Request confirmation for all tasks when running a topic') do
-    Howzit.options[:ask] = true
-  end
+  opts.on('--ask', 'Request confirmation for all tasks when running a topic') { Howzit.options[:ask] = true }
 
   opts.on('--default', 'Answer all prompts with default response') do
+    raise '--default cannot be used with --yes' if Howzit.options[:yes]
+
     Howzit.options[:default] = true
   end
 
+  opts.on('-f', '--force', 'Continue executing after an error') { Howzit.options[:force] = true }
+
   opts.on('-m', '--matching TYPE', MATCHING_OPTIONS,
           'Topics matching type', "(#{MATCHING_OPTIONS.join(', ')})") do |c|
     Howzit.options[:matching] = c
@@ -42,6 +44,12 @@ OptionParser.new do |opts|
     Howzit.options[:include_upstream] = p
   end
 
+  opts.on('-y', '--yes', 'Answer yes to all prompts') do
+    raise '--default cannot be used with --yes' if Howzit.options[:default]
+
+    Howzit.options[:yes] = true
+  end
+
   opts.separator "\n  Listing:\n\n" #=================================================================== LISTING
 
   opts.on('-L', '--list-completions', 'List topics (completion-compatible)') do

data/lib/howzit/colors.rb

@@ -227,7 +227,7 @@ module Howzit
       def template(input)
         input = input.join(' ') if input.is_a? Array
         fmt = input.gsub(/%/, '%%')
-        fmt = fmt.gsub(/\{(\w+)\}/) do
+        fmt = fmt.gsub(/(?<!\\u)\{(\w+)\}/i) do
           Regexp.last_match(1).split('').map { |c| "%<#{c}>s" }.join('')
         end
 

data/lib/howzit/config.rb

@@ -91,6 +91,7 @@ module Howzit
         choose: false,
         default: false,
         for_topic: nil,
+        force: false,
         grep: nil,
         list_runnable: false,
         list_runnable_titles: false,
@@ -99,7 +100,8 @@ module Howzit
         quiet: false,
         run: false,
         title_only: false,
-        verbose: false
+        verbose: false,
+        yes: false
       }
 
       config = load_config

data/lib/howzit/prompt.rb

@@ -18,6 +18,8 @@ module Howzit
       def yn(prompt, default: true)
         return default unless $stdout.isatty
 
+        return true if Howzit.options[:yes]
+
         return default if Howzit.options[:default]
 
         tty_state = `stty -g`
@@ -87,60 +89,86 @@ module Howzit
         return [] if !$stdout.isatty || matches.count.zero?
 
         if Util.command_exist?('fzf')
-          height = if height == :auto
-                     matches.count + 3
-                   else
-                     TTY::Screen.rows
-                   end
-
-          settings = [
-            '-0',
-            '-1',
-            '-m',
-            "--height=#{height}",
-            '--header="Tab: add selection, ctrl-a/d: (de)select all, return: display/run"',
-            '--bind ctrl-a:select-all,ctrl-d:deselect-all,ctrl-t:toggle-all',
-            '--prompt="Select a topic > "',
-            %(--preview="howzit --no-pager --header-format block --no-color --default --multiple first {}")
-          ]
+          height = height == :auto ? matches.count + 3 : TTY::Screen.rows
+
+          settings = fzf_options(height)
           res = `echo #{Shellwords.escape(matches.join("\n"))} | fzf #{settings.join(' ')}`.strip
-          if res.nil? || res.empty?
-            Howzit.console.info 'Cancelled'
-            Process.exit 0
-          end
-          return res.split(/\n/)
+          return fzf_result(res)
+        end
+
+        tty_menu(matches)
+      end
+
+      def fzf_result(res)
+        if res.nil? || res.empty?
+          Howzit.console.info 'Cancelled'
+          Process.exit 0
         end
+        return res.split(/\n/)
+      end
+
+      def fzf_options(height)
+        [
+          '-0',
+          '-1',
+          '-m',
+          "--height=#{height}",
+          '--header="Tab: add selection, ctrl-a/d: (de)select all, return: display/run"',
+          '--bind ctrl-a:select-all,ctrl-d:deselect-all,ctrl-t:toggle-all',
+          '--prompt="Select a topic > "',
+          %(--preview="howzit --no-pager --header-format block --no-color --default --multiple first {}")
+        ]
+      end
 
+      ##
+      ## Display a numeric menu on the TTY
+      ##
+      ## @param      matches  The matches from which to select
+      ##
+      def tty_menu(matches)
         return matches if matches.count == 1
 
-        res = matches[0..9]
-        stty_save = `stty -g`.chomp
+        @stty_save = `stty -g`.chomp
 
         trap('INT') do
-          system('stty', stty_save)
+          system('stty')
           exit
         end
 
         options_list(matches)
+        read_selection(matches)
+      end
 
-        begin
-          printf("Type 'q' to cancel, enter for first item", res.length)
-          while (line = Readline.readline(': ', true))
-            if line =~ /^[a-z]/i
-              system('stty', stty_save) # Restore
-              exit
-            end
-            line = line == '' ? 1 : line.to_i
+      ##
+      ## Read a single number response from the command line
+      ##
+      ## @param      matches  The matches
+      ##
+      def read_selection(matches)
+        printf "Type 'q' to cancel, enter for first item"
+        while (line = Readline.readline(': ', true))
+          line = read_num(line)
 
-            return [matches[line - 1]] if line.positive? && line <= matches.length
+          return [matches[line - 1]] if line.positive? && line <= matches.length
 
-            puts 'Out of range'
-            options_list(matches)
-          end
-        ensure
-          system('stty', stty_save)
+          puts 'Out of range'
+          read_selection(matches)
+        end
+      ensure
+        system('stty', @stty_save)
+      end
+
+      ##
+      ## Convert a response to an Integer
+      ##
+      ## @param      line  The response to convert
+      ##
+      def read_num(line)
+        if line =~ /^[a-z]/i
+          system('stty', @stty_save) # Restore
           exit
         end
+        line == '' ? 1 : line.to_i
       end
     end
   end

data/lib/howzit/task.rb

@@ -19,6 +19,9 @@ module Howzit
     ## @option attributes :action [String] task action
     ## @option attributes :parent [String] title of nested (included) topic origin
     def initialize(attributes, optional: false, default: true)
+      @prefix = "{bw}\u{25B7}\u{25B7} {x}"
+      # arrow = "{bw}\u{279F}{x}"
+
       @type = attributes[:type] || :run
       @title = attributes[:title] || nil
       @action = attributes[:action].render_arguments || nil
@@ -49,18 +52,20 @@ module Howzit
     ## Execute a block type
     ##
     def run_block
-      Howzit.console.info "{bg}Running block {bw}#{@title}{x}".c if Howzit.options[:log_level] < 2
+      Howzit.console.info "#{@prefix}{bg}Running block {bw}#{@title}{x}".c if Howzit.options[:log_level] < 2
       block = @action
       script = Tempfile.new('howzit_script')
       begin
         script.write(block)
         script.close
         File.chmod(0o777, script.path)
-        system(%(/bin/sh -c "#{script.path}"))
+        res = system(%(/bin/sh -c "#{script.path}"))
       ensure
         script.close
         script.unlink
       end
+
+      res
     end
 
     ##
@@ -73,7 +78,7 @@ module Howzit
       matches = Howzit.buildnote.find_topic(@action)
       raise "Topic not found: #{@action}" if matches.empty?
 
-      Howzit.console.info("{by}Running tasks from {bw}#{matches[0].title}{x}".c)
+      Howzit.console.info("#{@prefix}{by}Running tasks from {bw}#{matches[0].title}{x}".c)
       output.concat(matches[0].run(nested: true))
       Howzit.console.info("{by}End include: #{matches[0].tasks.count} tasks{x}".c)
       [output, matches[0].tasks.count]
@@ -84,8 +89,8 @@ module Howzit
     ##
     def run_run
       title = Howzit.options[:show_all_code] ? @action : @title
-      Howzit.console.info("{bg}Running {bw}#{title}{x}".c)
-      system(@action)
+      Howzit.console.info("#{@prefix}{bg}Running {bw}#{title}{x}".c)
+      return system(@action)
     end
 
     ##
@@ -93,8 +98,9 @@ module Howzit
     ##
     def run_copy
       title = Howzit.options[:show_all_code] ? @action : @title
-      Howzit.console.info("{bg}Copied {bw}#{title}{bg} to clipboard{x}".c)
+      Howzit.console.info("#{@prefix}{bg}Copied {bw}#{title}{bg} to clipboard{x}".c)
       Util.os_copy(@action)
+      return true
     end
 
     ##
@@ -103,22 +109,22 @@ module Howzit
     def run
       output = []
       tasks = 1
-      if @type == :block
-        run_block
-      else
-        case @type
-        when :include
-          output, tasks = run_include
-        when :run
-          run_run
-        when :copy
-          run_copy
-        when :open
-          Util.os_open(@action)
-        end
-      end
+      res = if @type == :block
+              run_block
+            else
+              case @type
+              when :include
+                output, tasks = run_include
+              when :run
+                run_run
+              when :copy
+                run_copy
+              when :open
+                Util.os_open(@action)
+              end
+            end
 
-      [output, tasks]
+      [output, tasks, res]
     end
 
     ##

data/lib/howzit/topic.rb

@@ -7,7 +7,7 @@ module Howzit
 
     attr_accessor :content
 
-    attr_reader :title, :tasks, :prereqs, :postreqs
+    attr_reader :title, :tasks, :prereqs, :postreqs, :results
 
     ##
     ## Initialize a topic object
@@ -21,6 +21,7 @@ module Howzit
       @parent = nil
       @nest_level = 0
       @tasks = gather_tasks
+      @results = { total: 0, success: 0, errors: 0, message: ''.c }
     end
 
     ##
@@ -35,7 +36,7 @@ module Howzit
     # Handle run command, execute directives in topic
     def run(nested: false)
       output = []
-      tasks = 0
+
       cols = begin
         TTY::Screen.columns > 60 ? 60 : TTY::Screen.columns
       rescue StandardError
@@ -63,14 +64,36 @@ module Howzit
             next unless res
 
           end
-          run_output, total = task.run
+          run_output, total, success = task.run
+
           output.concat(run_output)
-          tasks += total
+          @results[:total] += total
+
+          if success
+            @results[:success] += total
+          else
+            Howzit.console.warn %({bw}\u{2297} {br}Error running task {bw}"#{task.title}"{x}).c
+
+            @results[:errors] += total
+
+            break unless Howzit.options[:force]
+          end
         end
+
+        total = "{bw}#{@results[:total]}{by} #{@results[:total] == 1 ? 'task' : 'tasks'}".c
+        errors = "{bw}#{@results[:errors]}{by} #{@results[:errors] == 1 ? 'error' : 'errors'}".c
+        @results[:message] += if @results[:errors].zero?
+                                "{bg}\u{2713} {by}Ran #{total}{x}"
+                              elsif Howzit.options[:force]
+                                "{br}\u{2715} {by}Completed #{total} with #{errors}{x}".c
+                              else
+                                "{br}\u{2715} {by}Ran #{total}, terminated due to error{x}".c
+                              end
       else
         Howzit.console.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
+
+      output.push(@results[:message]) if Howzit.options[:log_level] < 2 && !nested
 
       puts TTY::Box.frame("{bw}#{@postreqs.join("\n\n").wrap(cols - 4)}{x}".c, width: cols) unless @postreqs.empty?
 

data/lib/howzit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.26
+  version: 2.0.29
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler