howzit 2.1.18 → 2.1.21

data/lib/howzit/prompt.rb

@@ -83,21 +83,24 @@ module Howzit
       ##                      number of options, anything
       ##                      else gets max height for
       ##                      terminal)
+      ## @param      query    [String] The search term to display in prompt
       ##
       ## @return     [Array] the selected results
       ##
-      def choose(matches, height: :auto)
-        return [] if !$stdout.isatty || matches.count.zero?
+      def choose(matches, height: :auto, query: nil)
+        return [] if matches.count.zero?
+        return matches if matches.count == 1
+        return [] unless $stdout.isatty
 
         if Util.command_exist?('fzf')
           height = height == :auto ? matches.count + 3 : TTY::Screen.rows
 
-          settings = fzf_options(height)
+          settings = fzf_options(height, query: query)
           res = `echo #{Shellwords.escape(matches.join("\n"))} | fzf #{settings.join(' ')}`.strip
           return fzf_result(res)
         end
 
-        tty_menu(matches)
+        tty_menu(matches, query: query)
       end
 
       def fzf_result(res)
@@ -108,7 +111,12 @@ module Howzit
         res.split(/\n/)
       end
 
-      def fzf_options(height)
+      def fzf_options(height, query: nil)
+        prompt = if query
+                   "Select a topic for \\`#{query}\\` > "
+                 else
+                   'Select a topic > '
+                 end
         [
           '-0',
           '-1',
@@ -116,7 +124,7 @@ module Howzit
           "--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 > "',
+          "--prompt=\"#{prompt}\"",
           %(--preview="howzit --no-pager --header-format block --no-color --default --multiple first {}")
         ]
       end
@@ -125,8 +133,9 @@ module Howzit
       ## Display a numeric menu on the TTY
       ##
       ## @param      matches  The matches from which to select
+      ## @param      query    [String] The search term to display
       ##
-      def tty_menu(matches)
+      def tty_menu(matches, query: nil)
         return matches if matches.count == 1
 
         @stty_save = `stty -g`.chomp
@@ -136,6 +145,9 @@ module Howzit
           exit
         end
 
+        if query
+          puts "\nSelect a topic for `#{query}`:"
+        end
         options_list(matches)
         read_selection(matches)
       end

data/lib/howzit/run_report.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Howzit
+  # Formatter for task run summaries
+  module RunReport
+    module_function
+
+    def reset
+      Howzit.run_log = []
+    end
+
+    def log(entry)
+      Howzit.run_log = [] if Howzit.run_log.nil?
+      Howzit.run_log << entry
+    end
+
+    def entries
+      Howzit.run_log || []
+    end
+
+    def format
+      return '' if entries.empty?
+
+      lines = entries.map { |entry| format_line(entry, Howzit.multi_topic_run) }
+      lines.map! { |line| line.rstrip }
+      widths = lines.map { |line| line.uncolor.length }
+      width = widths.max
+      top = '=' * width
+      bottom = '-' * width
+      output_lines = [top] + lines + [bottom]
+      result = output_lines.join("\n")
+      result = result.gsub(/\n[ \t]+\n/, "\n")
+      result.gsub(/\n{2,}/, "\n")
+    end
+
+    def format_line(entry, prefix_topic)
+      bullet_start = '{mb}- [{x}'
+      bullet_end = '{mb}] {x}'
+      symbol = entry[:success] ? '{bg}✓{x}' : '{br}X{x}'
+      parts = []
+      parts << "#{bullet_start}#{symbol}#{bullet_end}"
+      parts << "{bl}#{entry[:topic]}{x}: " if prefix_topic && entry[:topic] && !entry[:topic].empty?
+      parts << "{by}#{entry[:task]}{x}"
+      unless entry[:success]
+        reason = entry[:exit_status] ? "exit code #{entry[:exit_status]}" : 'failed'
+        parts << " {br}(Failed: #{reason}){x}"
+      end
+      parts.join.c
+    end
+  end
+end

data/lib/howzit/stringutils.rb

@@ -183,7 +183,9 @@ module Howzit
 
     # Just strip out color codes when requested
     def uncolor
-      gsub(/\e\[[\d;]+m/, '').gsub(/\e\]1337;SetMark/, '')
+      # force UTF-8 and remove invalid characters, then remove color codes
+      # and iTerm markers
+      gsub(Howzit::Color::COLORED_REGEXP, "").gsub(/\e\]1337;SetMark/, "")
     end
 
     # Wrap text at a specified width.

data/lib/howzit/task.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require 'English'
+
 module Howzit
   # Task object
   class Task
-    attr_reader :type, :title, :action, :arguments, :parent, :optional, :default
+    attr_reader :type, :title, :action, :arguments, :parent, :optional, :default, :last_status
 
     ##
     ## Initialize a Task object
@@ -31,6 +33,7 @@ module Howzit
 
       @optional = optional
       @default = default
+      @last_status = nil
     end
 
     ##
@@ -68,6 +71,7 @@ module Howzit
         script.unlink
       end
 
+      update_last_status(res ? 0 : 1)
       res
     end
 
@@ -86,6 +90,7 @@ module Howzit
       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)
+      @last_status = nil
       [output, matches[0].tasks.count]
     end
 
@@ -96,7 +101,9 @@ module Howzit
       title = Howzit.options[:show_all_code] ? @action : @title
       Howzit.console.info("#{@prefix}{bg}Running {bw}#{title}{x}".c)
       ENV['HOWZIT_SCRIPTS'] = File.expand_path('~/.config/howzit/scripts')
-      system(@action)
+      res = system(@action)
+      update_last_status(res ? 0 : 1)
+      res
     end
 
     ##
@@ -106,6 +113,7 @@ module Howzit
       title = Howzit.options[:show_all_code] ? @action : @title
       Howzit.console.info("#{@prefix}{bg}Copied {bw}#{title}{bg} to clipboard{x}".c)
       Util.os_copy(@action)
+      @last_status = 0
       true
     end
 
@@ -127,12 +135,23 @@ module Howzit
                 run_copy
               when :open
                 Util.os_open(@action)
+                @last_status = 0
+                true
               end
             end
 
       [output, tasks, res]
     end
 
+    def update_last_status(default = nil)
+      status = if defined?($CHILD_STATUS) && $CHILD_STATUS
+                 $CHILD_STATUS.exitstatus
+               else
+                 default
+               end
+      @last_status = status
+    end
+
     ##
     ## Output terminal-formatted list item
     ##

data/lib/howzit/topic.rb

@@ -104,6 +104,8 @@ module Howzit
 
             break unless Howzit.options[:force]
           end
+
+          log_task_result(task, success)
         end
 
         total = "{bw}#{@results[:total]}{by} #{@results[:total] == 1 ? 'task' : 'tasks'}".c
@@ -119,7 +121,7 @@ module Howzit
         Howzit.console.warn "{r}--run: No {br}@directive{xr} found in {bw}#{@title}{x}".c
       end
 
-      output.push(@results[:message]) if Howzit.options[:log_level] < 2 && !nested
+      output.push(@results[:message]) if Howzit.options[:log_level] < 2 && !nested && !Howzit.options[:run]
 
       puts TTY::Box.frame("{bw}#{@postreqs.join("\n\n").wrap(cols - 4)}{x}".c, width: cols) unless @postreqs.empty?
 
@@ -324,6 +326,27 @@ module Howzit
     ##
     ## @return     [Array] array of Task objects
     ##
+    def log_task_result(task, success)
+      return unless Howzit.options[:run]
+      return if task.type == :include
+
+      Howzit.run_log ||= []
+
+      title = (task.title || '').strip
+      if title.empty?
+        action = (task.action || '').strip
+        title = action.split(/\n/).first.to_s.strip
+      end
+      title = task.type.to_s.capitalize if title.nil? || title.empty?
+
+      Howzit.run_log << {
+        topic: @title,
+        task: title,
+        success: success ? true : false,
+        exit_status: task.last_status
+      }
+    end
+
     def gather_tasks
       runnable = []
       @prereqs = @content.scan(/(?<=@before\n).*?(?=\n@end)/im).map(&:strip)

data/lib/howzit/util.rb

@@ -145,7 +145,11 @@ module Howzit
         end
 
         read_io.close
-        write_io.write(text)
+        begin
+          write_io.write(text)
+        rescue Errno::EPIPE
+          # User quit pager before we finished writing, ignore
+        end
         write_io.close
 
         _, status = Process.waitpid2(pid)

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -41,6 +41,7 @@ require_relative 'howzit/config'
 require_relative 'howzit/task'
 require_relative 'howzit/topic'
 require_relative 'howzit/buildnote'
+require_relative 'howzit/run_report'
 
 require 'tty/screen'
 require 'tty/box'
@@ -49,7 +50,7 @@ require 'tty/box'
 # Main module for howzit
 module Howzit
   class << self
-    attr_accessor :arguments, :named_arguments, :cli_args
+    attr_accessor :arguments, :named_arguments, :cli_args, :run_log, :multi_topic_run
 
     ##
     ## Holds a Configuration object with methods and a @settings hash
@@ -88,10 +89,18 @@ module Howzit
       @console ||= Howzit::ConsoleLogger.new(options[:log_level])
     end
 
+    def run_log
+      @run_log ||= []
+    end
+
+    def multi_topic_run
+      @multi_topic_run ||= false
+    end
+
     def has_read_upstream
       @has_read_upstream ||= false
     end
 
-    attr_writer :has_read_upstream
+    attr_writer :has_read_upstream, :run_log
   end
 end

data/spec/buildnote_spec.rb

@@ -62,6 +62,12 @@ describe Howzit::BuildNote do
       expect(matches.count).to eq 0
     end
 
+    it "matches topics containing colon even without space" do
+      matches = how.find_topic('git:clean')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'Git: Clean Repo'
+    end
+
     it "Handles multiple matches with best match" do
       Howzit.options[:matching] = 'fuzzy'
       Howzit.options[:multiple_matches] = :best
@@ -70,12 +76,62 @@ describe Howzit::BuildNote do
     end
   end
 
+  describe ".find_topic_exact" do
+    it "finds exact whole-word match" do
+      matches = how.find_topic_exact('Topic Tropic')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'Topic Tropic'
+    end
+
+    it "finds exact match case-insensitively" do
+      matches = how.find_topic_exact('topic tropic')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'Topic Tropic'
+    end
+
+    it "does not match partial phrases" do
+      matches = how.find_topic_exact('topic trop')
+      expect(matches.count).to eq 0
+    end
+
+    it "does not match single word when phrase has multiple words" do
+      matches = how.find_topic_exact('topic')
+      expect(matches.count).to eq 0
+    end
+
+    it "matches single-word topics" do
+      matches = how.find_topic_exact('Happy Bgagngagnga')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'Happy Bgagngagnga'
+    end
+
+    it "matches topics with colons" do
+      matches = how.find_topic_exact('Git: Clean Repo')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'Git: Clean Repo'
+    end
+  end
+
   describe ".topics" do
-    it "contains 4 topics" do
-      expect(how.list_topics.count).to eq 4
+    it "contains 7 topics" do
+      expect(how.list_topics.count).to eq 7
     end
     it "outputs a newline-separated string for completion" do
-      expect(how.list_completions.scan(/\n/).count).to eq 3
+      expect(how.list_completions.scan(/\n/).count).to eq 6
+    end
+  end
+
+  describe "#topic_search_terms_from_cli" do
+    after { Howzit.cli_args = [] }
+
+    it "respects separators found inside topics" do
+      Howzit.cli_args = ['git:clean:blog:update post']
+      expect(how.send(:topic_search_terms_from_cli)).to eq(['git:clean', 'blog:update post'])
+    end
+
+    it "keeps comma inside matching topics" do
+      Howzit.cli_args = ['release, deploy,topic balogna']
+      expect(how.send(:topic_search_terms_from_cli)).to eq(['release, deploy', 'topic balogna'])
     end
   end
 end

data/spec/cli_spec.rb

@@ -15,7 +15,7 @@ describe 'CLI' do
     execute_script('bin/howzit', use_bundler: true, args: %w[-L])
     expect(last_execution).to be_successful
     expect(last_execution.stdout).to match(/Topic Balogna/)
-    expect(last_execution.stdout.split(/\n/).count).to eq 4
+    expect(last_execution.stdout.split(/\n/).count).to eq 7
   end
 
   it 'lists available tasks' do

data/spec/run_report_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Howzit::RunReport do
+  before do
+    Howzit.run_log = []
+    Howzit.multi_topic_run = false
+  end
+
+  after do
+    Howzit::RunReport.reset
+    Howzit.multi_topic_run = false
+  end
+
+  it 'renders a bordered summary for single topic runs' do
+    Howzit::RunReport.log({ topic: 'Git: Config', task: 'Run Git Origin', success: true, exit_status: 0 })
+    plain = Howzit::RunReport.format.uncolor
+    expect(plain).to include('- [✓] Run Git Origin')
+    expect(plain).not_to include('Git: Config:')
+    top, line, bottom = plain.split("\n")
+    expect(top).to eq('=' * line.length)
+    expect(bottom).to eq('-' * line.length)
+  end
+
+  it 'prefixes topic titles and shows failures when multiple topics run' do
+    Howzit.multi_topic_run = true
+    Howzit::RunReport.log({ topic: 'Git: Config', task: 'Run Git Origin', success: true, exit_status: 0 })
+    Howzit::RunReport.log({ topic: 'Git: Clean Repo', task: 'Clean Git Repo', success: false, exit_status: 12 })
+    plain = Howzit::RunReport.format.uncolor
+    expect(plain).to include('- [✓] Git: Config: Run Git Origin')
+    expect(plain).to include('- [X] Git: Clean Repo: Clean Git Repo (Failed: exit code 12)')
+  end
+end
+

data/spec/spec_helper.rb

@@ -18,6 +18,8 @@ RSpec.configure do |c|
     save_buildnote
     Howzit.options[:include_upstream] = false
     Howzit.options[:default] = true
+    Howzit.options[:matching] = 'partial'
+    Howzit.options[:multiple_matches] = 'choose'
     @hz = Howzit.buildnote
   end
 
@@ -67,6 +69,18 @@ def save_buildnote
     ## Happy Bgagngagnga
 
     This one is just to throw things off
+
+    ## Git: Clean Repo
+
+    Keep Git projects tidy.
+
+    ## Blog: Update Post
+
+    Publish the latest article updates.
+
+    ## Release, Deploy
+
+    Prep and deploy the latest release.
   EONOTE
   File.open('builda.md', 'w') { |f| f.puts note }
   # puts "Saved to builda.md: #{File.exist?('builda.md')}"

data/spec/topic_spec.rb

@@ -82,8 +82,11 @@ describe Howzit::Topic do
   end
 
   describe '.print_out' do
-    Howzit.options[:header_format] = :block
-    Howzit.options[:color] = false
+    before do
+      Howzit.options[:header_format] = :block
+      Howzit.options[:color] = false
+      Howzit.options[:show_all_code] = false
+    end
 
     it 'prints the topic title' do
       expect(topic.print_out({ single: true, header: true }).join("\n").uncolor).to match(/▌Topic Balogna/)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.18
+  version: 2.1.21
 platform: ruby
 authors:
 - Brett Terpstra
 bindir: bin
 cert_chain: []
-date: 2025-01-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -275,15 +275,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/FUNDING.yml"
-- ".gitignore"
-- ".howzit.taskpaper.bak"
-- ".irbrc"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -304,7 +295,6 @@ files:
 - fish/completions/howzit.fish
 - fish/functions/bld.fish
 - howzit.gemspec
-- lib/.rubocop.yml
 - lib/howzit.rb
 - lib/howzit/buildnote.rb
 - lib/howzit/colors.rb
@@ -312,17 +302,18 @@ files:
 - lib/howzit/console_logger.rb
 - lib/howzit/hash.rb
 - lib/howzit/prompt.rb
+- lib/howzit/run_report.rb
 - lib/howzit/stringutils.rb
 - lib/howzit/task.rb
 - lib/howzit/topic.rb
 - lib/howzit/util.rb
 - lib/howzit/version.rb
 - scripts/runtests.sh
-- spec/.rubocop.yml
 - spec/buildnote_spec.rb
 - spec/cli_spec.rb
 - spec/prompt_spec.rb
 - spec/ruby_gem_spec.rb
+- spec/run_report_spec.rb
 - spec/spec_helper.rb
 - spec/task_spec.rb
 - spec/topic_spec.rb
@@ -347,16 +338,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Provides a way to access Markdown project notes by topic with query capabilities
   and the ability to execute the tasks it describes.
 test_files:
-- spec/.rubocop.yml
 - spec/buildnote_spec.rb
 - spec/cli_spec.rb
 - spec/prompt_spec.rb
 - spec/ruby_gem_spec.rb
+- spec/run_report_spec.rb
 - spec/spec_helper.rb
 - spec/task_spec.rb
 - spec/topic_spec.rb

data/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-indent_style = space
-indent_size = 2

data/.github/FUNDING.yml

@@ -1,2 +0,0 @@
-github: [ttscoff]
-custom: ['https://brettterpstra.com/support/', 'https://brettterpstra.com/donate/']

data/.gitignore

@@ -1,45 +0,0 @@
-# Parts of this file were adapted from
-# GitHub’s collection of .gitignore file templates
-# which are Copyright (c) 2016 GitHub, Inc.
-# and released under the MIT License.
-# For more details, visit the project page:
-# https://github.com/github/gitignore
-
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-results.log
-html

data/.howzit.taskpaper.bak

@@ -1,27 +0,0 @@
-Inbox:
-	- Topic summaries @na
-		Maybe in square brackets on line after topic title, or as a blockquote. When doing a list of available topics, include its summary in the output. Ignore or specially style summary when viewing full topic.
-	- Named positional arguments for topics @na
-		Parenthesis after title like a function (arg1, arg2). Variables can have default values (arg1 = testing) and are available as [%var1] replacements in scripts
-howzit:
-	New Features:
-	Ideas:
-		- Nested topics @maybe @na
-			Allow increased header levels to nest topics within a parent
-			Running/viewing a parent includes all nested subtopics
-			All topics still available via search
-			When reading file, set a base level from first header, then test each additional topic title to see whether it's greater than the current level. If so, change current level and begin collecting subtopics at the same level
-			Howzit::Topic has a subtopic attribute, consisting of an array of Topics. Each of these Topics also has a subtopics attr. These are collected and assigned during initila reading of note file
-			When read in, a topic is added to the top level build notes topic, as well as appended to its parent's subtopics if it's a higher level than the base
-			just need methods to determine base level (first # match) and check the current headers level when discovering a topic (count #)
-			
-			no, wait. topics should read in their own children. Determine base header level, split topics at that level, then recurse each topic the same way
-			include statements will need to be adjusted to allow includes as children. Multiple at symbols could indicate the level to nest at, two symbols would indicate that the include belonged to the last parent. When importing, adjust base header levels appropriately (increase 1).
-	Bugs:
-Archive:
-	- Add a preview when selecting topic with fzf @priority(3) @na @done(2022-08-06) @project(Inbox)
-Search Definitions:
-	Top Priority @search(@priority = 5 and not @done)
-	High Priority @search(@priority > 3 and not @done)
-	Maybe @search(@maybe)
-	Next @search(@na and not @done and not project = "Archive")

data/.irbrc

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-IRB.conf[:AUTO_INDENT] = true
-
-require "irb/completion"
-require_relative "lib/conductor"
-
-# rubocop:disable Style/MixinUsage
-include Howzit # standard:disable all
-# rubocop:enable Style/MixinUsage
-
-require "awesome_print"
-AwesomePrint.irb!

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color