howzit 1.2.5 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f2fa88b6f75dba8846894028f457fa1515d104bb41c77307bd0b22835afeed8
-  data.tar.gz: 64a7169ae4968d94f0193d784924a6a36bf36d3389cefdd8dc15a1d916292548
+  metadata.gz: 311a04719d7aa7de00e54224eda363bc249dd6f8e3fdd31ad5d2a625eaa8bff8
+  data.tar.gz: 87f632ce5ac4855880b5d7ddade20983c42b252fa51bbf7fd0b654cf389970ff
 SHA512:
-  metadata.gz: 52e107f32837a775c115a9f2051a8347458e9194972f36fd1af42888e70d567ddc48bc51411335ad037d497c0d86abe38171f7b1064945c7b77671cb4a7a3afb
-  data.tar.gz: 9c67de8ad8748e365753194d59f4cbc1a73a590f0291289ab20e1558077114d531fe3b6b957d38204dfaace53e7d5e84a2c4743ee3ae33d4fa160828d97478fb
+  metadata.gz: 3ef0f06a0d408c652ae516e92d78dbb7d6bd6bf48260cb21dd66e63f4ecf27c38eed30eae42b79c53f87a824e8622b93416aef7e29feae25d2003ed00827332d
+  data.tar.gz: 16025164eb7fb5550058e361fd478b7b37e4e560cbb1b06965c79a9f091df2862d0387cd908cdfcc11456a7b358f3f507ee876036f95190971acdaa610aa979a

data/CHANGELOG.md

@@ -1,10 +1,173 @@
-# Change Log
+### 1.2.9
 
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
-This change log follows the conventions of
-[keep a CHANGELOG](http://keepachangelog.com/).
+2022-08-01 07:09
 
-## [Unreleased]
+### 1.2.8
 
-[Unreleased]: https://github.com/ttscoff/howzit/compare/v1.2.4...HEAD
+2022-08-01 07:01
+
+#### FIXED
+
+- Frozen string error
+
+### 1.2.6
+
+2022-08-01 06:09
+
+#### NEW
+
+- Use @before...@end and @after...@end to specify prerequisites and a post-run message. Topics with @before will require y/n verification before running
+
+#### FIXED
+
+- ITerm markers weren't being inserted when paging was off
+
+### 1.2.3
+
+2022-07-31 14:20
+
+#### IMPROVED
+
+- Don't include a topic multiple times in one display
+- Don't execute nested topics more than once
+- Indicate nested includes in headers
+- Code cleanup
+
+### 1.2.2
+
+2022-07-31 08:56
+
+- Add -F option to pager setup (quit if less than one screen)
+
+### 1.2.1
+
+2022-07-31 05:12
+
+- Add handling for delta pager to not clear screen on exit
+
+### 1.2.0
+
+2022-07-31 04:59
+
+- Add grep feature, searches topic/content for pattern and displays matches (selection menu if multiple matches)
+
+### 1.1.27
+
+2022-01-17 11:45
+
+#### NEW
+
+- Use fzf for menus if available
+- "@run() TITLE" will show TITLE instead of command when listing runnable topics
+- @include(FILENAME) will import an external file if the path exists
+
+### 1.1.26
+
+- Fix for error in interactive build notes creation
+
+### 1.1.25
+
+- Hide run block contents by default
+- :show_all_code: config setting to include run block contents
+- --show-code flag to display run block contents at runtime
+- Modify include display
+
+### 1.1.24
+
+- Use ~/.config/howzit/ignore.yaml to ignore patterns when scanning for build notes
+- Use `required` and `optional` keys in templates to request that metadata be defined when importing
+- Allow templates to include other templates
+
+### 1.1.23
+
+- Add flags to allow content to stay onscreen after exiting pager (less and bat)
+
+### 1.1.21
+
+- Merge directive and block handling so execution order is sequential
+
+### 1.1.20
+
+- Template functionality for including common tasks/topics
+
+### 1.1.19
+
+- Add `--upstream` option to traverse up parent directories for additional build notes
+
+### 1.1.15
+
+- Code refactoring/cleanup
+- Rename "sections" to "topics"
+- If no match found for topic search, only show error (`:show_all_on_error: false` option)
+
+### 1.1.14
+
+- Fix removal of non-alphanumeric characters from titles
+- -s/--select option to display a menu of all available topics
+- Allow arguments to be passed after `--` for variable substitution
+- Allow --matching TYPE to match first non-ambigous keyword match
+
+### 1.1.13
+
+- --matching [fuzzy,beginswith,partial,exact] flag
+- --edit-config flag
+- sort flags in help
+
+### 1.1.12
+
+- After consideration, remove full fuzzy matching. Too many positives for shorter strings.
+
+### 1.1.11
+
+- Add full fuzzy matching for topic titles
+- Add `@include(TOPIC)` command to import another topic's tasks
+
+### 1.1.10
+
+- Add config file for default options
+
+### 1.1.9
+
+- Use `system` instead of `exec` to allow multiple @run commands
+- Add code block runner
+
+### 1.1.8
+
+- Add `-e/--edit` flag to open build notes in $EDITOR
+
+### 1.1.7
+
+- Use `exec` for @run commands to allow interactive processes (e.g. vim)
+
+### 1.1.6
+
+- Add option for outputting title with notes
+- Add option for outputting note title only
+
+### 1.1.4
+
+- Fix for "topic not found" when run with no arguments
+
+### 1.1.1
+
+- Reorganize and rename long output options
+- Fix wrapping long lines without spaces
+
+### 1.1.0
+
+- Add -R switch for listing "runnable" topics
+- Add -T switch for completion-compatible listing of "runnable" topics
+- Add -L switch for completion-compatible listing of all topics
+
+### 1.0.1
+
+- Allow topic matching within title, not just at start
+- Remove formatting of topic text for better compatibility with mdless/mdcat
+- Add @run() syntax to allow executable commands
+- Add @copy() syntax to copy text to clipboard
+- Add @url/@open() syntax to open urls/files, OS agnostic (hopefully)
+- Add support for mdless/mdcat
+- Add support for pager
+- Offer to create skeleton buildnotes if none found
+- Set iTerm 2 marks for navigation when paging is disabled
+- Wrap output with option to specify width (default 80, 0 to disable)

data/README.md

@@ -2,10 +2,6 @@
 
 [![Gem](https://img.shields.io/gem/v/howzit.svg)](https://rubygems.org/gems/howzit)
 [![GitHub license](https://img.shields.io/github/license/ttscoff/howzit.svg)](./LICENSE.txt)
-[![Gemnasium](https://img.shields.io/gemnasium/ttscoff/howzit.svg)](https://gemnasium.com/ttscoff/howzit)
-[![Travis](https://img.shields.io/travis/ttscoff/howzit.svg)](https://travis-ci.org/ttscoff/howzit)
-[![Codecov](https://img.shields.io/codecov/c/github/ttscoff/howzit.svg)](https://codecov.io/github/ttscoff/howzit)
-[![Code Climate](https://img.shields.io/codeclimate/github/ttscoff/howzit.svg)](https://codeclimate.com/github/ttscoff/howzit)
 
 A command-line reference tool for tracking project build systems
 
@@ -91,6 +87,12 @@ You can include commands that can be executed by howzit. Commands start at the b
 - `@include(TOPIC)`
 
     Includes all tasks from another topic, matching the name (partial match allowed) and returning first match.
+- `@before...@end`
+    
+    A block defined between @before and @end markers will be considered prerequisite for any task the topic can run. If one or more of these blocks exist in the topic, they will be displayed before running and a yes/no dialog will request confirmation that the prerequisites have been met. The content between these markers is still included when viewing the topic, but the tags themselves do not show up in output.
+- `@after...@end`
+
+    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.
 
 ### Run blocks (embedded scripts)
 

data/howzit.gemspec

@@ -39,4 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'github-markup', '~> 1.3'
 
   spec.add_runtime_dependency 'mdless', '~> 1.0', '>= 1.0.28'
+  spec.add_runtime_dependency 'tty-screen', '~> 0.8'
 end

data/lib/howzit/buildnotes.rb

@@ -1,6 +1,8 @@
 module Howzit
   # Primary Class for this module
   class BuildNotes
+    include Prompt
+
     attr_accessor :arguments, :metadata
 
     def topics
@@ -108,7 +110,6 @@ module Howzit
       options = {
         color: true,
         highlight: false,
-        paginate: false,
         wrap: 0
       }
 
@@ -124,14 +125,17 @@ module Howzit
 
       output = `echo #{Shellwords.escape(string.strip)}#{pipes}`
 
-      if options[:paginate]
+      if @options[:paginate]
         page(output)
       else
-        output.gsub!(/^╌/, '\e]1337;SetMark\a╌') if ENV['TERM_PROGRAM'] =~ /^iTerm/ && !options[:run]
         puts output
       end
     end
 
+    def iterm_marker
+      "\e]1337;SetMark\a\n" if ENV['TERM_PROGRAM'] =~ /^iTerm/ && !@options[:run] && !@options[:paginate]
+    end
+
     def color_single_options(choices = %w[y n])
       out = []
       choices.each do |choice|
@@ -153,16 +157,9 @@ module Howzit
       end
       # First make sure there isn't already a buildnotes file
       if note_file
-        system 'stty cbreak'
         fname = "\e[1;33m#{note_file}\e[1;37m"
-        yn = color_single_options(%w[y N])
-        $stdout.syswrite "#{fname} exists and appears to be a build note, continue anyway #{yn}\e[1;37m? \e[0m"
-        res = $stdin.sysread 1
-        res.chomp!
-        puts
-        system 'stty cooked'
-
-        unless res =~ /y/i
+        res = yn("#{fname} exists and appears to be a build note, continue anyway?", false)
+        unless res
           puts 'Canceled'
           Process.exit 0
         end
@@ -209,16 +206,10 @@ module Howzit
       EOBUILDNOTES
 
       if File.exist?(filename)
-        system 'stty cbreak'
-        yn = color_single_options(%w[y N])
         file = "\e[1;33m#{filename}"
-        $stdout.syswrite "\e[1;37mAre you absolutely sure you want to overwrite #{file} #{yn}\e[1;37m? \e[0m"
-        res = $stdin.sysread 1
-        res.chomp!
-        puts
-        system 'stty cooked'
+        res = yn("Are you absolutely sure you want to overwrite #{file}", false)
 
-        unless res =~ /y/i
+        unless res
           puts 'Canceled'
           Process.exit 0
         end
@@ -240,11 +231,11 @@ module Howzit
 
       options.merge!(opts)
 
-      cols = `tput cols`.strip.to_i
+      cols = TTY::Screen.columns
       cols = @options[:wrap] if (@options[:wrap]).positive? && cols > @options[:wrap]
       title = "\e[#{options[:border]}m#{options[:hr]}#{options[:hr]}( \e[#{options[:color]}m#{title}\e[#{options[:border]}m )"
       tail = options[:hr] * (cols - title.uncolor.length)
-      "#{title}#{tail}\e[0m"
+      options[:hr] =~ /╌/ ? "#{iterm_marker}#{title}#{tail}\e[0m" : "#{title}#{tail}\e[0m"
     end
 
     def os_open(command)
@@ -283,6 +274,15 @@ module Howzit
       output = []
       tasks = 0
       if topics[key] =~ /(@(include|run|copy|open|url)\((.*?)\)|`{3,}run)/i
+        prereqs = topics[key].scan(/(?<=@before\n).*?(?=\n@end)/im).map(&:strip)
+        postreqs = topics[key].scan(/(?<=@after\n).*?(?=\n@end)/im).map(&:strip)
+
+        unless prereqs.empty?
+          puts prereqs.join("\n\n")
+          res = yn('This task has prerequisites, have they been met?', true)
+          Process.exit 1 unless res
+
+        end
         directives = topics[key].scan(/(?:@(include|run|copy|open|url)\((.*?)\)|(`{3,})run(?: +([^\n]+))?(.*?)\3)/mi)
 
         tasks += directives.length
@@ -333,6 +333,8 @@ module Howzit
         warn "\e[0;31m--run: No \e[1;31m@directive\e[0;31;40m found in \e[1;37m#{key}\e[0m"
       end
       output.push("Ran #{tasks} #{tasks == 1 ? 'task' : 'tasks'}") if @options[:log_level] < 2
+
+      puts postreqs.join("\n\n")
     end
 
     # Output a topic with fancy title and bright white text.
@@ -349,6 +351,8 @@ module Howzit
       topic.gsub!(/(?mi)^(`{3,})run *([^\n]*)[\s\S]*?\n\1\s*$/, '@@@run \2') unless @options[:show_all_code]
       topic.split(/\n/).each do |l|
         case l
+        when /@(before|after|prereq|end)/
+          next
         when /@include\((.*?)\)/
 
           m = Regexp.last_match
@@ -837,14 +841,9 @@ module Howzit
       raise 'No EDITOR variable defined in environment' if ENV['EDITOR'].nil?
 
       if note_file.nil?
-        system 'stty cbreak'
-        yn = color_single_options(%w[Y n])
-        $stdout.syswrite "No build notes file found, create one #{yn}? "
-        res = $stdin.sysread 1
-        puts
-        system 'stty cooked'
-
-        create_note if res.chomp =~ /^y?$/i
+        res = yn("No build notes file found, create one?", true)
+
+        create_note if res
         edit_note
       else
         `#{ENV['EDITOR']} "#{note_file}"`
@@ -1064,14 +1063,8 @@ module Howzit
         ARGV.length.times do
           ARGV.shift
         end
-        system 'stty cbreak'
-        yn = color_single_options(%w[Y n])
-        $stdout.syswrite "No build notes file found, create one #{yn}? "
-        res = $stdin.sysread 1
-        puts
-        system 'stty cooked'
-
-        create_note if res.chomp =~ /^y?$/i
+        res = yn("No build notes file found, create one?", true)
+        create_note if res
         Process.exit 1
       end
 

data/lib/howzit/prompt.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Howzit
+  module Prompt
+  	def yn(prompt, default = true)
+    	system 'stty cbreak'
+    	yn = color_single_options(default ? %w[Y n] : %w[y N])
+    	$stdout.syswrite "\e[1;37m#{prompt} #{yn}\e[1;37m? \e[0m"
+    	res = $stdin.sysread 1
+    	res.chomp!
+    	puts
+    	system 'stty cooked'
+    	res =~ /y/i
+    end
+  end
+end

data/lib/howzit/stringutils.rb

@@ -5,7 +5,7 @@ module Howzit
   module StringUtils
     # Just strip out color codes when requested
     def uncolor
-      gsub(/\e\[[\d;]+m/, '')
+      gsub(/\e\[[\d;]+m/, '').gsub(/\e]1337;SetMark/,'')
     end
 
     # Adapted from https://github.com/pazdera/word_wrap/,
@@ -49,11 +49,11 @@ module Howzit
     # Truncate string to nearest word
     # @param len <number> max length of string
     def trunc(len)
-      split(/ /).each_with_object('') do |x, ob|
-        break ob unless ob.length + ' '.length + x.length <= len
+      split(/ /).each_with_object([]) do |x, ob|
+        break ob unless ob.join(' ').length + ' '.length + x.length <= len
 
-        ob << (" #{x}")
-      end.strip
+        ob.push(x)
+      end.join(' ').strip
     end
 
     def trunc!(len)

data/lib/howzit/version.rb

@@ -2,5 +2,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '1.2.5'.freeze
+  VERSION = '1.2.9'.freeze
 end

data/lib/howzit.rb

@@ -1,4 +1,5 @@
 require 'howzit/version'
+require 'howzit/prompt'
 require 'howzit/buildnotes'
 require 'howzit/stringutils'
 require 'optparse'
@@ -8,6 +9,8 @@ require 'readline'
 require 'tempfile'
 require 'yaml'
 
+require 'tty/screen'
+
 CONFIG_DIR = '~/.config/howzit'
 CONFIG_FILE = 'howzit.yaml'
 IGNORE_FILE = 'ignore.yaml'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.9
 platform: ruby
 authors:
 - Brett Terpstra
@@ -240,6 +240,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.28
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Command line project documentation and task runner
 email:
 - me@brettterpstra.com
@@ -269,6 +283,7 @@ files:
 - lib/.rubocop.yml
 - lib/howzit.rb
 - lib/howzit/buildnotes.rb
+- lib/howzit/prompt.rb
 - lib/howzit/stringutils.rb
 - lib/howzit/version.rb
 - spec/.rubocop.yml