howzit 2.0.15 → 2.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb673909d87ac094a2111c1f6fa364fb54183059267e009886562c89a81310d7
-  data.tar.gz: ec766bf5d2f3b3454a289f429e28c12f19545a79dfe6f10d29f0afb04abdc9b2
+  metadata.gz: 16fc4dc237a8f226da219e66cbaee59984e8931bfe8e03fe5b0126451fb0d0d0
+  data.tar.gz: a169f5a88a1a6b345b6732c4782d166d7c933a6ce986a66b14e9df35602e1b7b
 SHA512:
-  metadata.gz: b5f2e3624bad256848b1c2d8a4bc95dcbbee5d8cf0e2c63efa79b139ca3a330ce773edb2e68375ea72158de0ce69ffaedd7673f36cbee5cd937c255ccaa3e5fe
-  data.tar.gz: f024cd0ffb6b41ab6184cf36ef65e644e90f5ab7e5c57b8a2c9cc1be404802f992f708464a3a2ab984122fddb4880ec704cda85dd371aeee735b417e15d942c2
+  metadata.gz: d197932f7a501e0a4ffb5eb76ca60660223b98cee1346c573028922b05790652a8e8c08a4624c72645423145d342d0b3866580d9b05552fe72a87edda47b4a08
+  data.tar.gz: 4e318240e7db8d6117fec620fd5505afab5ba35427b391e6a1dc90b4eccb978f6865054d300d00dad574ea4edc5ccb006c74112fca78f00dce14dc07c55095da

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+### 2.0.18
+
+2022-08-08 03:48
+
+#### NEW
+
+- Use --ask to require confirmation of all tasks when running a topic
+
+### 2.0.17
+
+2022-08-07 06:09
+
+### 2.0.16
+
+2022-08-07 06:05
+
+#### NEW
+
+- --edit-template NAME will open a template in your editor, offering to create it if missing
+
+#### FIXED
+
+- If --show-code is given (or :show_all_code: is set to true), show content of @directives instead of title
+
 ### 2.0.15
 
 2022-08-05 17:16

data/bin/howzit

@@ -20,6 +20,10 @@ 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('--default', 'Answer all prompts with default response') do
     Howzit.options[:default] = true
   end
@@ -94,6 +98,11 @@ OptionParser.new do |opts|
     Process.exit 0
   end
 
+  opts.on('--edit-template NAME', 'Create or edit a template') do |template|
+    Howzit.buildnote.edit_template(template)
+    Process.exit 0
+  end
+
   opts.on('--config-get [KEY]', 'Display the configuration settings or setting for a specific key') do |k|
     if k.nil?
       Howzit::Config::DEFAULTS.sort_by { |key, _| key }.each do |key, _|

data/lib/howzit/buildnote.rb

@@ -11,23 +11,15 @@ module Howzit
     ## Initialize a build note
     ##
     ## @param      file  [String] The path to the build note file
-    ## @param      args  [Array] additional args
     ##
-    def initialize(file: nil, args: [])
+    def initialize(file: nil)
       @topics = []
-      if note_file.nil?
-        res = Prompt.yn('No build notes file found, create one?', default: true)
+      create_note(prompt: true) if note_file.nil?
 
-        create_note if res
-        Process.exit 0
-      end
       content = Util.read_file(note_file)
-      if content.nil? || content.empty?
-        Howzit.console.error("{br}No content found in build note (#{note_file}){x}".c)
-        Process.exit 1
-      else
-        @metadata = content.split(/^#/)[0].strip.get_metadata
-      end
+      raise "{br}No content found in build note (#{note_file}){x}".c if content.nil? || content.empty?
+
+      @metadata = content.split(/^#/)[0].strip.get_metadata
 
       read_help(file)
     end
@@ -55,6 +47,17 @@ module Howzit
       edit_note
     end
 
+    ##
+    ## Public method to open a template in the editor
+    ##
+    ## @param      template  [String] The template title
+    ##
+    def edit_template(template)
+      file = template.sub(/(\.md)?$/i, '.md')
+      file = File.join(Howzit.config.template_folder, file)
+      edit_template_file(file)
+    end
+
     ##
     ## Find a topic based on a fuzzy match
     ##
@@ -62,6 +65,7 @@ module Howzit
     ##
     def find_topic(term = nil)
       return @topics if term.nil?
+
       @topics.filter do |topic|
         rx = term.to_rx
         topic.title.downcase =~ rx
@@ -137,15 +141,14 @@ module Howzit
       find_topic(Howzit.options[:for_topic]).each do |topic|
         s_out = []
 
-        topic.tasks.each do |task|
-          s_out.push(task.to_list)
-        end
+        topic.tasks.each { |task| s_out.push(task.to_list) }
 
-        unless s_out.empty?
-          output.push("- {bw}#{topic.title}{x}".c)
-          output.push(s_out.join("\n"))
-        end
+        next if s_out.empty?
+
+        output.push("- {bw}#{topic.title}{x}".c)
+        output.push(s_out.join("\n"))
       end
+
       output.join("\n")
     end
 
@@ -158,22 +161,75 @@ module Howzit
       read_help_file(file)
     end
 
+    ##
+    ## Create a template file
+    ##
+    ## @param      file    [String] file path
+    ## @param      prompt  [Boolean] confirm file creation?
+    ##
+    def create_template_file(file, prompt: false)
+      trap('SIGINT') do
+        Howzit.console.info "\nCancelled"
+        exit!
+      end
+
+      default = !$stdout.isatty || Howzit.options[:default]
+
+      if prompt && !default && !File.exist?(file)
+        res = Prompt.yn("{bg}Template {bw}#{File.basename(file)}{bg} not found, create it?{x}".c, default: true)
+        Process.exit 0 unless res
+      end
+
+      title = File.basename(file, '.md')
+
+      note = <<~EOBUILDNOTES
+        # #{title}
+
+        ## Template Topic
+
+      EOBUILDNOTES
+
+      if File.exist?(file) && !default
+        file = "{by}#{file}".c
+        unless Prompt.yn("Are you sure you want to overwrite #{file}", default: false)
+          puts 'Cancelled'
+          Process.exit 0
+        end
+      end
+
+      File.open(file, 'w') do |f|
+        f.puts note
+        puts "{by}Template {bw}#{title}{by} written to {bw}#{file}{x}".c
+      end
+
+      if File.exist?(file) && !default && Prompt.yn("{bg}Do you want to open {bw}#{file} {bg}for editing?{x}".c,
+                                                     default: false)
+        edit_template_file(file)
+      end
+
+      Process.exit 0
+    end
+
     # Create a buildnotes skeleton
-    def create_note
+    def create_note(prompt: false)
       trap('SIGINT') do
         Howzit.console.info "\nCancelled"
         exit!
       end
+
       default = !$stdout.isatty || Howzit.options[:default]
+
+      if prompt && !default
+        res = Prompt.yn('No build notes file found, create one?', default: true)
+        Process.exit 0 unless res
+      end
+
       # First make sure there isn't already a buildnotes file
       if note_file
         fname = "{by}#{note_file}{bw}".c
         unless default
           res = Prompt.yn("#{fname} exists and appears to be a build note, continue anyway?", default: false)
-          unless res
-            puts 'Canceled'
-            Process.exit 0
-          end
+          Process.exit 0 unless res
         end
       end
 
@@ -228,9 +284,7 @@ module Howzit
 
       if File.exist?(fname) && !default
         file = "{by}#{fname}".c
-        res = Prompt.yn("Are you absolutely sure you want to overwrite #{file}", default: false)
-
-        unless res
+        unless Prompt.yn("Are you absolutely sure you want to overwrite #{file}", default: false)
           puts 'Canceled'
           Process.exit 0
         end
@@ -238,13 +292,12 @@ module Howzit
 
       File.open(fname, 'w') do |f|
         f.puts note
-        puts "{by}Build notes for #{title} written to #{fname}".c
+        puts "{by}Build notes for {bw}#{title}{by} written to {bw}#{fname}{x}".c
       end
 
-      if File.exist?(fname) && !default
-        res = Prompt.yn("{bg}Do you want to open {bw}#{file} {bg}for editing?{x}".c, default: false)
-
-        edit_note if res
+      if File.exist?(fname) && !default && Prompt.yn("{bg}Do you want to open {bw}#{fname} {bg}for editing?{x}".c,
+                                                     default: false)
+        edit_note
       end
 
       Process.exit 0
@@ -261,6 +314,139 @@ module Howzit
 
     private
 
+    ##
+    ## Import the contents of a filename as new topics
+    ##
+    ## @param      mtch  [MatchData] the filename match from
+    ##                   the include directive
+    ##
+    def include_file(mtch)
+      file = File.expand_path(mtch[1])
+
+      return mtch[0] unless File.exist?(file)
+
+      content = Util.read_file(file)
+      home = ENV['HOME']
+      short_path = File.dirname(file.sub(/^#{home}/, '~'))
+      prefix = "#{short_path}/#{File.basename(file)}:"
+      parts = content.split(/^##+/)
+      parts.shift
+      if parts.empty?
+        content
+      else
+        "## #{parts.join('## ')}".gsub(/^(##+ *)(?=\S)/, "\\1#{prefix}")
+      end
+    end
+
+    ##
+    ## Test to ensure that any `required` metadata in a
+    ## template is fulfilled by the build note
+    ##
+    ## @param      template  [String] The template to read
+    ##                       from
+    ##
+    def ensure_requirements(template)
+      t_leader = Util.read_file(template).split(/^#/)[0].strip
+      if t_leader.length > 0
+        t_meta = t_leader.get_metadata
+        if t_meta.key?('required')
+          required = t_meta['required'].strip.split(/\s*,\s*/)
+          required.each do |req|
+            unless @metadata.keys.include?(req.downcase)
+              Howzit.console.error %({bRw}ERROR:{xbr} Missing required metadata key from template '{bw}#{File.basename(template, '.md')}{xr}'{x}).c
+              Howzit.console.error %({br}Please define {by}#{req.downcase}{xr} in build notes{x}).c
+              Process.exit 1
+            end
+          end
+        end
+      end
+    end
+
+    ##
+    ## Test a template string for bracketed subtopics
+    ##
+    ## @param      template  [String] The template name
+    ##
+    ## @return     [Array] [[String] updated template name, [Array]
+    ##             subtopic titles]
+    ##
+    def detect_subtopics(template)
+      subtopics = nil
+
+      if template =~ /\[(.*?)\]$/
+        subtopics = Regexp.last_match[1].split(/\s*\|\s*/).map { |t| t.gsub(/\*/, '.*?')}
+        template.sub!(/\[.*?\]$/, '').strip
+      end
+
+      [template, subtopics]
+    end
+
+    ##
+    ## Enumerate templates and read their associated files
+    ## into topics
+    ##
+    ## @param      templates  [Array] The templates to read
+    ##
+    ## @return     [Array] template topics
+    ##
+    def gather_templates(templates)
+      template_topics = []
+
+      templates.each do |template|
+        template, subtopics = detect_subtopics(template)
+
+        file = template.sub(/(\.md)?$/i, '.md')
+        file = File.join(Howzit.config.template_folder, file)
+
+        next unless File.exist?(file)
+
+        ensure_requirements(file)
+
+        template_topics.concat(read_template(template, file, subtopics))
+      end
+
+      template_topics
+    end
+
+    ##
+    ## Filter topics based on subtopic titles
+    ##
+    ## @param      note       [BuildNote] The note
+    ## @param      subtopics  [Array] The subtopics to
+    ##                        extract
+    ##
+    ## @return     [Array] extracted subtopics
+    ##
+    def extract_subtopics(note, subtopics)
+      template_topics = []
+
+      subtopics.each do |subtopic|
+        note.topics.each { |topic| template_topics.push(topic) if topic.title =~ /^(.*?:)?#{subtopic}$/i }
+      end
+
+      template_topics
+    end
+
+    ##
+    ## Read a template file
+    ##
+    ## @param      template   [String] The template title
+    ## @param      file       [String] The file path
+    ## @param      subtopics  [Array] The subtopics to
+    ##                        extract, nil to return all
+    ##
+    ## @return     [Array] extracted topics
+    ##
+    def read_template(template, file, subtopics = nil)
+      note = BuildNote.new(file: file)
+
+      template_topics = subtopics.nil? ? note.topics : extract_subtopics(note, subtopics)
+      template_topics.map do |topic|
+        topic.parent = template
+        topic
+      end
+    end
+
     ##
     ## Traverse up directory tree looking for build notes
     ##
@@ -341,30 +527,6 @@ module Howzit
       topics_dict
     end
 
-    ##
-    ## Test to ensure that any `required` metadata in a
-    ## template is fulfilled by the build note
-    ##
-    ## @param      template  [String] The template to read
-    ##                       from
-    ##
-    def ensure_requirements(template)
-      t_leader = Util.read_file(template).split(/^#/)[0].strip
-      if t_leader.length > 0
-        t_meta = t_leader.get_metadata
-        if t_meta.key?('required')
-          required = t_meta['required'].strip.split(/\s*,\s*/)
-          required.each do |req|
-            unless @metadata.keys.include?(req.downcase)
-              Howzit.console.error %({bRw}ERROR:{xbr} Missing required metadata key from template '{bw}#{File.basename(template, '.md')}{xr}'{x}).c
-              Howzit.console.error %({br}Please define {by}#{req.downcase}{xr} in build notes{x}).c
-              Process.exit 1
-            end
-          end
-        end
-      end
-    end
-
     ##
     ## Read a list of topics from an included template
     ##
@@ -375,87 +537,17 @@ module Howzit
 
       template_topics = []
 
-      if leader.length > 0
-        data = leader.get_metadata
-
-        if data.key?('template')
-          templates = data['template'].strip.split(/\s*,\s*/)
-          templates.each do |t|
-            tasks = nil
-            if t =~ /\[(.*?)\]$/
-              tasks = Regexp.last_match[1].split(/\s*,\s*/).map {|t| t.gsub(/\*/, '.*?')}
-              t = t.sub(/\[.*?\]$/, '').strip
-            end
-
-            t_file = t.sub(/(\.md)?$/, '.md')
-            template = File.join(Howzit.config.template_folder, t_file)
-            if File.exist?(template)
-              ensure_requirements(template)
-
-              t_topics = BuildNote.new(file: template)
-              if tasks
-                tasks.each do |task|
-                  t_topics.topics.each do |topic|
-                    if topic.title =~ /^(.*?:)?#{task}$/i
-                      topic.parent = t
-                      template_topics.push(topic)
-                    end
-                  end
-                end
-              else
-                t_topics.topics.map! do |topic|
-                  topic.parent = t
-                  topic
-                end
-
-                template_topics.concat(t_topics.topics)
-              end
-            end
-          end
-        end
-      end
-      template_topics
-    end
+      return template_topics if leader.empty?
 
-    ##
-    ## Import the contents of a filename as new topics
-    ##
-    ## @param      mtch  [MatchData] the filename match from
-    ##                   the include directive
-    ##
-    def include_file(mtch)
-      file = File.expand_path(mtch[1])
+      data = leader.get_metadata
 
-      return mtch[0] unless File.exist?(file)
+      if data.key?('template')
+        templates = data['template'].strip.split(/\s*,\s*/)
 
-      content = Util.read_file(file)
-      home = ENV['HOME']
-      short_path = File.dirname(file.sub(/^#{home}/, '~'))
-      prefix = "#{short_path}/#{File.basename(file)}:"
-      parts = content.split(/^##+/)
-      parts.shift
-      if parts.empty?
-        content
-      else
-        "## #{parts.join('## ')}".gsub(/^(##+ *)(?=\S)/, "\\1#{prefix}")
+        template_topics.concat(gather_templates(templates))
       end
-    end
-
-    ##
-    ## Get the title of the build note (top level header)
-    ##
-    ## @param      truncate  [Integer] Truncate to width
-    ##
-    def note_title(truncate = 0)
-      help = Util.read_file(note_file)
-      title = help.match(/(?:^(\S.*?)(?=\n==)|^# ?(.*?)$)/)
-      title = if title
-                title[1].nil? ? title[2] : title[1]
-              else
-                note_file.sub(/(\.\w+)?$/, '')
-              end
 
-      title && truncate.positive? ? title.trunc(truncate) : title
+      template_topics
     end
 
     # Read in the build notes file and output a hash of
@@ -477,7 +569,7 @@ module Howzit
         Process.exit 1
       end
 
-      @title = note_title
+      @title = help.note_title(filename)
 
       help.gsub!(/@include\((.*?)\)/) do
         include_file(Regexp.last_match)
@@ -547,14 +639,33 @@ module Howzit
 
       raise "Invalid editor (#{editor})" unless Util.valid_command?(editor)
 
-      if note_file.nil?
-        res = Prompt.yn('No build notes file found, create one?', default: true)
+      create_note(prompt: true) if note_file.nil?
+      `#{editor} "#{note_file}"`
+    end
 
-        create_note if res
-        edit_note
-      else
-        `#{editor} "#{note_file}"`
-      end
+    ##
+    ## Public method to create a new template
+    ##
+    ## @param      template  [String] The template name
+    ##
+    def create_template(template)
+      file = template.sub(/(\.md)?$/i, '.md')
+      file = File.join(Howzit.config.template_folder, file)
+      create_template_file(file, prompt: false)
+    end
+
+    ##
+    ## Open template in editor
+    ##
+    def edit_template_file(file)
+      editor = Howzit.options.fetch(:editor, ENV['EDITOR'])
+
+      raise 'No editor defined' if editor.nil?
+
+      raise "Invalid editor (#{editor})" unless Util.valid_command?(editor)
+
+      create_template_file(file, prompt: true) unless File.exist?(file)
+      `#{editor} "#{file}"`
     end
 
     ##
@@ -589,17 +700,11 @@ module Howzit
       unless note_file
         Process.exit 0 if Howzit.options[:list_runnable_titles] || Howzit.options[:list_topic_titles]
 
-        # clear the buffer
-        ARGV.length.times do
-          ARGV.shift
-        end
-        res = yn("No build notes file found, create one?", false)
-        create_note if res
-        Process.exit 1
+        create_note(prompt: true)
       end
 
       if Howzit.options[:title_only]
-        out = note_title(20)
+        out = Util.read_file(note_file).note_title(note_file, 20)
         $stdout.print(out.strip)
         Process.exit(0)
       elsif Howzit.options[:output_title] && !Howzit.options[:run]

data/lib/howzit/config.rb

@@ -87,6 +87,7 @@ module Howzit
     def load_options
       Color.coloring = $stdout.isatty
       flags = {
+        ask: false,
         choose: false,
         default: false,
         for_topic: nil,

data/lib/howzit/prompt.rb

@@ -75,16 +75,24 @@ module Howzit
       ## options and accepts a numeric response
       ##
       ## @param      matches  [Array] The options list
+      ## @param      height   [Symbol] height of fzf menu
+      ##                      (:auto adjusts height to
+      ##                      number of options, anything
+      ##                      else gets max height for
+      ##                      terminal)
       ##
       ## @return     [Array] the selected results
       ##
       def choose(matches, height: :auto)
-        height = if height == :auto
-                   matches.count + 3
-                 else
-                   TTY::Screen.rows
-                 end
+        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',
@@ -102,6 +110,8 @@ module Howzit
           return res.split(/\n/)
         end
 
+        return matches if matches.count == 1
+
         res = matches[0..9]
         stty_save = `stty -g`.chomp
 
@@ -126,7 +136,7 @@ module Howzit
             puts 'Out of range'
             options_list(matches)
           end
-        rescue Interrupt
+        ensure
           system('stty', stty_save)
           exit
         end

data/lib/howzit/stringutils.rb

@@ -16,6 +16,22 @@ module Howzit
       true
     end
 
+    ##
+    ## Get the title of the build note (top level header)
+    ##
+    ## @param      truncate  [Integer] Truncate to width
+    ##
+    def note_title(file, truncate = 0)
+      title = match(/(?:^(\S.*?)(?=\n==)|^# ?(.*?)$)/)
+      title = if title
+                title[1].nil? ? title[2] : title[1]
+              else
+                file.sub(/(\.\w+)?$/, '')
+              end
+
+      title && truncate.positive? ? title.trunc(truncate) : title
+    end
+
     ##
     ## Replace slash escaped characters in a string with a
     ## zero-width space that will prevent a shell from
@@ -275,9 +291,9 @@ module Howzit
       data = {}
       meta.each do |k, v|
         case k
-        when /^templ\w+$/
+        when /^te?m?pl(ate)?s?$/
           data['template'] = v
-        when /^req\w+$/
+        when /^req\w*$/
           data['required'] = v
         else
           data[k] = v

data/lib/howzit/task.rb

@@ -8,11 +8,21 @@ module Howzit
     ##
     ## Initialize a Task object
     ##
-    def initialize(params, optional: false, default: true)
-      @type = params[:type]
-      @title = params[:title]
-      @action = params[:action].render_arguments
-      @parent = params[:parent] || nil
+    ## @param      attributes  [Hash] the task attributes
+    ## @param      optional    [Boolean] Task requires
+    ##                         confirmation
+    ## @param      default     [Boolean] Default response
+    ##                         for confirmation dialog
+    ##
+    ## @option attributes :type [Symbol] task type (:block, :run, :include, :copy)
+    ## @option attributes :title [String] task title
+    ## @option attributes :action [String] task action
+    ## @option attributes :parent [String] title of nested (included) topic origin
+    def initialize(attributes, optional: false, default: true)
+      @type = attributes[:type] || :run
+      @title = attributes[:title] || nil
+      @action = attributes[:action].render_arguments || nil
+      @parent = attributes[:parent] || nil
       @optional = optional
       @default = default
     end
@@ -56,16 +66,16 @@ module Howzit
     ##
     ## Execute an include task
     ##
-    ## @return     [Integer] number of tasks executed
+    ## @return     [Array] [[Array] output, [Integer] number of tasks executed]
     ##
     def run_include
       output = []
       matches = Howzit.buildnote.find_topic(@action)
       raise "Topic not found: #{@action}" if matches.empty?
 
-      $stderr.puts "{by}Running tasks from {bw}#{matches[0].title}{x}".c if Howzit.options[:log_level] < 2
+      Howzit.console.info("{by}Running tasks from {bw}#{matches[0].title}{x}".c)
       output.concat(matches[0].run(nested: true))
-      $stderr.puts "{by}End include: #{matches[0].tasks.count} tasks{x}".c if Howzit.options[:log_level] < 2
+      Howzit.console.info("{by}End include: #{matches[0].tasks.count} tasks{x}".c)
       [output, matches[0].tasks.count]
     end
 
@@ -74,7 +84,7 @@ module Howzit
     ##
     def run_run
       title = Howzit.options[:show_all_code] ? @action : @title
-      $stderr.puts "{bg}Running {bw}#{title}{x}".c if Howzit.options[:log_level] < 2
+      Howzit.console.info("{bg}Running {bw}#{title}{x}".c)
       system(@action)
     end
 
@@ -83,7 +93,7 @@ module Howzit
     ##
     def run_copy
       title = Howzit.options[:show_all_code] ? @action : @title
-      $stderr.puts "{bg}Copied {bw}#{title}{bg} to clipboard{x}".c if Howzit.options[:log_level] < 2
+      Howzit.console.info("{bg}Copied {bw}#{title}{bg} to clipboard{x}".c)
       os_copy(@action)
     end
 
@@ -97,21 +107,21 @@ module Howzit
       out = "{bg}Copying {bw}#{string}".c
       case os
       when /darwin.*/i
-        $stderr.puts "#{out} (macOS){x}".c if Howzit.options[:log_level].zero?
+        Howzit.console.debug("#{out} (macOS){x}".c)
         `echo #{Shellwords.escape(string)}'\\c'|pbcopy`
       when /mingw|mswin/i
-        $stderr.puts "#{out} (Windows){x}".c if Howzit.options[:log_level].zero?
+        Howzit.console.debug("#{out} (Windows){x}".c)
         `echo #{Shellwords.escape(string)} | clip`
       else
         if 'xsel'.available?
-          $stderr.puts "#{out} (Linux, xsel){x}".c if Howzit.options[:log_level].zero?
+          Howzit.console.debug("#{out} (Linux, xsel){x}".c)
           `echo #{Shellwords.escape(string)}'\\c'|xsel -i`
         elsif 'xclip'.available?
-          $stderr.puts "#{out} (Linux, xclip){x}".c if Howzit.options[:log_level].zero?
+          Howzit.console.debug("#{out} (Linux, xclip){x}".c)
           `echo #{Shellwords.escape(string)}'\\c'|xclip -i`
         else
-          $stderr.puts out if Howzit.options[:log_level].zero?
-          $stderr.puts 'Unable to determine executable for clipboard.'
+          Howzit.console.debug(out)
+          Howzit.console.warn('Unable to determine executable for clipboard.')
         end
       end
     end

data/lib/howzit/topic.rb

@@ -51,7 +51,7 @@ module Howzit
         end
 
         @tasks.each do |task|
-          if task.optional
+          if task.optional || Howzit.options[:ask]
             note = if task.type == :include
                      task_count = Howzit.buildnote.find_topic(task.action)[0].tasks.count
                      " (#{task_count} tasks)"
@@ -137,6 +137,7 @@ module Howzit
           cmd = m[:cmd]
           obj = m[:action]
           title = m[:title].empty? ? obj : m[:title].strip
+          title = Howzit.options[:show_all_code] ? obj : title
           optional = m[:optional] =~ /[?!]+/ ? true : false
           default = m[:optional] =~ /!/ ? false : true
           option = if optional
@@ -222,7 +223,7 @@ module Howzit
           default = c[:optional] =~ /!/ ? false : true
           obj = c[:action]
           title = c[:title].nil? ? obj : c[:title].strip
-
+          title = Howzit.options[:show_all_code] ? obj : title
           case cmd
           when /include/i
             # matches = Howzit.buildnote.find_topic(obj)

data/lib/howzit/util.rb

@@ -116,6 +116,11 @@ module Howzit
 
       # Paginate the output
       def page(text)
+        unless $stdout.isatty
+          puts text
+          return
+        end
+
         read_io, write_io = IO.pipe
 
         input = $stdin

data/lib/howzit/version.rb

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

data/spec/prompt_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Howzit::Prompt do
+  subject(:prompt) { Howzit::Prompt }
+
+  describe '.yn' do
+    it 'returns default response' do
+      Howzit.options[:default] = true
+      expect(prompt.yn('Test prompt', default: true)).to be_truthy
+      expect(prompt.yn('Test prompt', default: false)).not_to be_truthy
+    end
+  end
+
+  describe '.color_single_options' do
+    it 'returns uncolored string' do
+      Howzit::Color.coloring = false
+      expect(prompt.color_single_options(%w[y n])).to eq "[y/n]"
+    end
+  end
+
+  describe '.options_list' do
+    it 'creates a formatted list of options' do
+      options = %w[one two three four five].each_with_object([]) do |x, arr|
+        arr << "Option item #{x}"
+      end
+      expect { prompt.options_list(options) }.to output(/ 2 \) Option item two/).to_stdout
+    end
+  end
+
+  describe '.choose' do
+    it 'returns a single match' do
+      expect(prompt.choose(['option 1']).count).to eq 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,11 @@
-# require 'simplecov'
+# frozen_string_literal: true
 
-# SimpleCov.start
-
-# if ENV['CI'] == 'true'
-#   require 'codecov'
-#   SimpleCov.formatter = SimpleCov::Formatter::Codecov
-# else
-#   SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
-# end
+unless ENV['CI'] == 'true'
+  # SimpleCov::Formatter::Codecov # For CI
+  require 'simplecov'
+  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+  SimpleCov.start
+end
 
 require 'howzit'
 require 'cli-test'

data/spec/task_spec.rb

@@ -6,8 +6,7 @@ describe Howzit::Task do
   subject(:task) do
     Howzit::Task.new({ type: :run,
                        title: 'List Directory',
-                       action: 'ls',
-                       parent: nil })
+                       action: 'ls &> /dev/null' })
   end
 
   describe ".new" do

data/spec/topic_spec.rb

@@ -7,14 +7,14 @@ describe Howzit::Topic do
   content = 'Test Content'
   subject(:topic) { Howzit::Topic.new(title, content) }
 
-  describe ".new" do
-    it "makes a new topic instance" do
+  describe '.new' do
+    it 'makes a new topic instance' do
       expect(topic).to be_a Howzit::Topic
     end
-    it "has the correct title" do
+    it 'has the correct title' do
       expect(topic.title).to eq title
     end
-    it "has the correct content" do
+    it 'has the correct content' do
       expect(topic.content).to eq content
     end
   end
@@ -23,34 +23,49 @@ end
 describe Howzit::Topic do
   subject(:topic) { @hz.find_topic('Topic Balogna')[0] }
 
-  describe ".title" do
-    it "has the correct title" do
-      expect(topic.title).to match /Topic Balogna/
+  describe '.title' do
+    it 'has the correct title' do
+      expect(topic.title).to match(/Topic Balogna/)
     end
   end
 
-  describe ".tasks" do
-    it "has 2 tasks" do
+  describe '.tasks' do
+    it 'has 2 tasks' do
       expect(topic.tasks.count).to eq 2
     end
   end
 
-  describe ".prereqs" do
-    it "has prereq" do
+  describe '.prereqs' do
+    it 'has prereq' do
       expect(topic.prereqs.count).to eq 1
     end
-    it "has postreq" do
+  end
+
+  describe '.postreqs' do
+    it 'has postreq' do
       expect(topic.postreqs.count).to eq 1
     end
   end
 
-  describe ".run" do
+  describe '.grep' do
+    it 'returns true for matching pattern in content' do
+      expect(topic.grep('prereq.*?ite')).to be_truthy
+    end
+    it 'returns true for matching pattern in title' do
+      expect(topic.grep('bal.*?na')).to be_truthy
+    end
+    it 'fails on bad pattern' do
+      expect(topic.grep('xxx+')).to_not be_truthy
+    end
+  end
+
+  describe '.run' do
     Howzit.options[:default] = true
-    it "shows prereq and postreq" do
+    it 'shows prereq and postreq' do
       expect { topic.run }.to output(/prerequisite/).to_stdout
       expect { topic.run }.to output(/postrequisite/).to_stdout
     end
-    it "Copies to clipboard" do
+    it 'Copies to clipboard' do
       expect {
         ENV['RUBYOPT'] = '-W1'
         Howzit.options[:log_level] = 0
@@ -58,4 +73,19 @@ describe Howzit::Topic do
       }.to output(/Copied/).to_stderr
     end
   end
+
+  describe '.print_out' do
+    Howzit.options[:header_format] = :block
+    Howzit.options[:color] = false
+    it 'prints the topic title' do
+      expect(topic.print_out({single: true, header: true}).join("\n").uncolor).to match(/▌Topic Balogna/)
+    end
+    it 'prints a task title' do
+      expect(topic.print_out({single: true, header: true}).join("\n").uncolor).to match(/▶ Null Output/)
+    end
+    it 'prints task action with --show-code' do
+      Howzit.options[:show_all_code] = true
+      expect(topic.print_out({single: true, header: true}).join("\n").uncolor).to match(/▶ ls -1/)
+    end
+  end
 end

data/spec/util_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Howzit::Util do
+  subject(:util) { Howzit::Util }
+
+  describe '.read_file' do
+    it 'reads file to a string' do
+      buildnote = util.read_file('builda.md')
+      expect(buildnote).not_to be_empty
+      expect(buildnote).to be_a String
+    end
+  end
+
+  describe '.valid_command?' do
+    it 'finds a command' do
+      expect(util.command_exist?('ls')).to be_truthy
+    end
+    it 'validates a command' do
+      expect(util.valid_command?('ls -1')).to be_truthy
+    end
+  end
+
+  describe '.which_highlighter' do
+    it 'finds mdless' do
+      Howzit.options[:highlighter] = 'mdless'
+      expect(util.which_highlighter).to eq 'mdless'
+    end
+  end
+
+  describe '.which_pager' do
+    it 'finds the more utility' do
+      Howzit.options[:pager] = 'more'
+      expect(util.which_pager).to eq 'more'
+      Howzit.options[:pager] = 'auto'
+      expect(util.which_pager).to_not eq 'more'
+    end
+  end
+
+  describe '.show' do
+    it 'prints output' do
+      buildnote = util.read_file('builda.md')
+      expect { util.show(buildnote) }.to output(/Balogna/).to_stdout
+    end
+
+    it 'pages output' do
+      buildnote = util.read_file('builda.md')
+      expect { util.page(buildnote) }.to output(/Balogna/).to_stdout
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.15
+  version: 2.0.18
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -331,10 +331,12 @@ files:
 - spec/.rubocop.yml
 - spec/buildnote_spec.rb
 - spec/cli_spec.rb
+- spec/prompt_spec.rb
 - spec/ruby_gem_spec.rb
 - spec/spec_helper.rb
 - spec/task_spec.rb
 - spec/topic_spec.rb
+- spec/util_spec.rb
 - update_readmes.rb
 homepage: https://github.com/ttscoff/howzit
 licenses:
@@ -364,7 +366,9 @@ test_files:
 - spec/.rubocop.yml
 - spec/buildnote_spec.rb
 - spec/cli_spec.rb
+- spec/prompt_spec.rb
 - spec/ruby_gem_spec.rb
 - spec/spec_helper.rb
 - spec/task_spec.rb
 - spec/topic_spec.rb
+- spec/util_spec.rb