howzit 2.0.28 → 2.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a724cc90c349de14afa896512a32d69bcf2fa44575f69e74b0a6f96d615ebb
-  data.tar.gz: 73c54a8893fa66784575235d329ad698da6e7a34a2741e09d2d93149b118f68a
+  metadata.gz: 26dd07092f365cd21cb4d077f0bc50fca533af0a887254e3086aa9151bb6a45a
+  data.tar.gz: e015fc62c9540593afd17f8b134c1e0bedbd7ee14424ec02f9d8a7de419219c5
 SHA512:
-  metadata.gz: 4d4c9e0c7e5c78f10479cea93dffa09fdf768d335210897feb127f849040bced7a05924a60f6621173ececb1fde116fe5a3ecc79270767c12718b1a1f9742281
-  data.tar.gz: ff2c18f91883cf4f3b6035b8b304a23575381fd1b9a74333781db8ac000b13d03eb43969bb80d964e3dafeec3556a2152392b2eb074a34561981753233e1fc9e
+  metadata.gz: 549a57df5cd0e0760ba579dea70c82d08db6cc743b5bcf3e659058534f01dfd2536ebf1fd0f3f47dac2e9275ed82ebef8353c630c961424797dc281931a4fc22
+  data.tar.gz: f9fe0d54b25137ec1d89dfcd5ead0ee9814dd5b74af0a4797743c4e1f28e793aee4d018bfc1d1774470f5d7979dd9866aea80539a0bccc462f0fc0e53e413f77

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### 2.0.31
+
+2022-08-31 07:17
+
+#### FIXED
+
+- Color template formatting of task output
+
+### 2.0.30
+
+2022-08-31 07:15
+
+#### FIXED
+
+- Formatting of --help and --version commands
+
+### 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

data/bin/howzit

@@ -11,7 +11,7 @@ args = parts[0] ? Shellwords.shellsplit(parts[0]) : []
 Howzit.arguments = parts[1] ? Shellwords.shellsplit(parts[1]) : []
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: #{__FILE__} [OPTIONS] [TOPIC]"
+  opts.banner = "Usage: #{File.basename(__FILE__)} [OPTIONS] [TOPIC]"
   opts.separator ''
   opts.separator 'Show build notes for the current project (buildnotes.md).
   Include a topic name to see just that topic, or no argument to display all.'
@@ -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
@@ -225,7 +233,7 @@ OptionParser.new do |opts|
   end
 
   opts.on('-v', '--version', 'Display version number') do
-    puts "how v#{Howzit::VERSION}"
+    puts "#{File.basename(__FILE__)} v#{Howzit::VERSION}"
     Process.exit 0
   end
 end.parse!(args)

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`

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,7 +52,7 @@ 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
@@ -75,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]
@@ -86,7 +89,7 @@ module Howzit
     ##
     def run_run
       title = Howzit.options[:show_all_code] ? @action : @title
-      Howzit.console.info("{bg}Running {bw}#{title}{x}".c)
+      Howzit.console.info("#{@prefix}{bg}Running {bw}#{title}{x}".c)
       return system(@action)
     end
 
@@ -95,7 +98,7 @@ 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

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
@@ -66,17 +67,33 @@ module Howzit
           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
 
-          unless success
-            Howzit.console.warn '{br}Error running task{bw} - non-zero exit, ending processing{x}'.c
-            break
+            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}".c
+                              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.28'
+  VERSION = '2.0.31'
 end

metadata

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