howzit 2.0.5 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95a5f6c56ebff1fb944ca8ea23cba45ca5b71647654a315fd2cf7e486d522309
-  data.tar.gz: f9ac61f6fad2aff412d4302d0c586e9b287f284659255215a9565c8632bdfc8c
+  metadata.gz: a199c0d74513fee2be1dcd71390927d7776cecf50bd6b075504f9ed82fc548b0
+  data.tar.gz: d3668793cf618dc1d785cab3a7c87b93c3f5cc4edc546ab20b0c10de8986f7a1
 SHA512:
-  metadata.gz: be7ac525fc55a0e199b5762830bd0c6ef41b0b099627a45f1ca2aacd4508df3574f06e803513a22d870985631520c58b7f75c9e8519b5b02cf274eaeec577d56
-  data.tar.gz: e60252f5081ae563fc7eb8c207bb6ba0674b316455247cbc886e1b386dd33ecef234cfa493c6453bc02403daa11f79afb5f514c95a2f4e080302010466a7d4a6
+  metadata.gz: cdc109a75df7f9757c3870092b3d3550dba228d4ddc9ff0d58befc5cb1174676808f4a29c8e0805b3e5150bf2c425b8f1d5ccebef226b6fffc96085562094f07
+  data.tar.gz: 394947ec4f9a437af899a4806e2daa60a1ffbd040785ff249dffe258030e88426a594a0b1afbea413839a72173daaf4cfbda4ef8643049296627c7928677fd68

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+### 2.0.8
+
+2022-08-04 13:28
+
+#### FIXED
+
+- Bugfixes
+
+### 2.0.7
+
+2022-08-04 13:04
+
+#### NEW
+
+- --debug flag (shortcut for :log_level: 0)
+
+#### IMPROVED
+
+- Console output now gets log levels, so :log_level: config option and --quiet/verbose have more utility
+
+### 2.0.6
+
+2022-08-04 11:08
+
 ### 2.0.5
 
 2022-08-04 10:50

data/README.md

@@ -273,17 +273,21 @@ Some of the command line options can be set as defaults. The first time you run
 
     ---
     :color: true
+    :config_editor: subl
+    :editor: subl
+    :header_format: block
     :highlight: true
-    :paginate: true
-    :wrap: 80
+    :highlighter: mdcat
+    :include_upstream: true
+    :log_level: 0
+    :matching: fuzzy
+    :multiple_matches: choose
     :output_title: false
-    :highlighter: auto
     :pager: auto
-    :matching: partial
-    :include_upstream: false
-    :log_level: 1
-    :multiple_matches: choose
-    :header_format: border
+    :paginate: true
+    :show_all_code: false
+    :show_all_on_error: false
+    :wrap: 0
 
 If `:color:` is false, output will not be colored, and markdown highlighting will be bypassed.
 
@@ -354,6 +358,12 @@ If set to `auto` howzit will look for markdown highlighters in this order, using
 
 If you're combining a highlighter with howzit's pagination, include any flags needed to disable the highlighter's pagination (e.g. `mdless --no-pager`).
 
+### Configuring from the Command Line
+
+You can get and set config options from the command line using `--config-get` and `--config-set`. If you run `--config-get` with no argument, it will display all config options. If you add a key (exact match required) you can get just the value for that key.
+
+Using `--config-set` requires an argument in the format `key=value`. The type of the value (boolean, integer, string, symbol) will be automatically determined and converted. To change your highlighter, for example, use `howzit --config-set highlighter=mdcat`.
+
 ## Shell Integration
 
 I personally like to alias `bld` to `howzit -r`. If you define a function in your shell, you can have it default to "build" but accept an alternate argument. There's an example for Fish included, and in Bash it would be as simple as `howzit -r ${1:build}`.

data/bin/howzit

@@ -74,11 +74,18 @@ OptionParser.new do |opts|
   end
 
   opts.on('-q', '--quiet', 'Silence info message') do
-    Howzit.options[:log_level] = 3
+    Howzit.options[:log_level] = 4
+    Howzit.console.reset_level
   end
 
   opts.on('-v', '--verbose', 'Show all messages') do
+    Howzit.options[:log_level] = 1
+    Howzit.console.reset_level
+  end
+
+  opts.on('-d', '--debug', 'Show debug messages (and all messages)') do
     Howzit.options[:log_level] = 0
+    Howzit.console.reset_level
   end
 
   opts.on('-u', '--[no-]upstream', 'Traverse up parent directories for additional build notes') do |p|
@@ -114,8 +121,8 @@ OptionParser.new do |opts|
     raise 'Argument must be KEY=VALUE' unless key =~ /\S=\S/
 
     parts = key.split(/=/)
-    k = parts[0].sub(/^:/, '')
-    v = parts[1..].join(' ')
+    k = parts.shift.sub(/^:/, '')
+    v = parts.join(' ')
 
     if Howzit.options.key?(k.to_sym)
       Howzit.options[k.to_sym] = v.to_config_value(Howzit.options[k.to_sym])

data/lib/howzit/buildnote.rb

@@ -89,7 +89,7 @@ module Howzit
     # Create a buildnotes skeleton
     def create_note
       trap('SIGINT') do
-        warn "\nCanceled"
+        Howzit.console.info "\nCanceled"
         exit!
       end
       default = !$stdout.isatty || Howzit.options[:default]
@@ -269,8 +269,8 @@ module Howzit
           required = t_meta['required'].strip.split(/\s*,\s*/)
           required.each do |req|
             unless @metadata.keys.include?(req.downcase)
-              warn %({xr}ERROR: Missing required metadata key from template '{bw}#{File.basename(template, '.md')}{xr}'{x}).c
-              warn %({xr}Please define {by}#{req.downcase}{xr} in build notes{x}).c
+              Howzit.console.error %({xr}ERROR: Missing required metadata key from template '{bw}#{File.basename(template, '.md')}{xr}'{x}).c
+              Howzit.console.error %({xr}Please define {by}#{req.downcase}{xr} in build notes{x}).c
               Process.exit 1
             end
           end

data/lib/howzit/config.rb

@@ -22,14 +22,27 @@ module Howzit
       wrap: 0
     }.deep_freeze
 
+    ##
+    ## Initialize a config object
+    ##
     def initialize
       load_options
     end
 
+    ##
+    ## Write a config to a file
+    ##
+    ## @param      config  The configuration
+    ##
     def write_config(config)
       File.open(config_file, 'w') { |f| f.puts config.to_yaml }
     end
 
+    ##
+    ## Test if a file should be ignored based on YAML file
+    ##
+    ## @param      filename  The filename to test
+    ##
     def should_ignore(filename)
       return false unless File.exist?(ignore_file)
 
@@ -47,10 +60,18 @@ module Howzit
       ignore
     end
 
+    ##
+    ## Find the template folder
+    ##
+    ## @return     [String] path to template folder
+    ##
     def template_folder
       File.join(config_dir, 'templates')
     end
 
+    ##
+    ## Initiate the editor for the config
+    ##
     def editor
       edit_config(DEFAULTS)
     end
@@ -91,12 +112,12 @@ module Howzit
 
     def create_config(d)
       unless File.directory?(config_dir)
-        warn "Creating config directory at #{config_dir}"
+        Howzit::ConsoleLogger.new(1).info "Creating config directory at #{config_dir}"
         FileUtils.mkdir_p(config_dir)
       end
 
       unless File.exist?(config_file)
-        warn "Writing fresh config file to #{config_file}"
+        Howzit::ConsoleLogger.new(1).info "Writing fresh config file to #{config_file}"
         write_config(d)
       end
       config_file

data/lib/howzit/console_logger.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+LOG_LEVELS = {
+  debug: 0,
+  info: 1,
+  warn: 2,
+  error: 3
+}.deep_freeze
+
+module Howzit
+  # Console logging
+  class ConsoleLogger
+    attr_accessor :log_level
+
+    def initialize(level = nil)
+      @log_level = level.to_i || Howzit.options[:log_level]
+    end
+
+    def reset_level
+      @log_level = Howzit.options[:log_level]
+    end
+
+    def write(msg, level = :info)
+      $stderr.puts msg if LOG_LEVELS[level] >= @log_level
+    end
+
+    def debug(msg)
+      write msg, :debug
+    end
+
+    def info(msg)
+      write msg, :info
+    end
+
+    def warn(msg)
+      write msg, :warn
+    end
+
+    def error(msg)
+      write msg, :error
+    end
+  end
+end

data/lib/howzit/prompt.rb

@@ -54,7 +54,7 @@ module Howzit
           ]
           res = `echo #{Shellwords.escape(matches.join("\n"))} | fzf #{settings.join(' ')}`.strip
           if res.nil? || res.empty?
-            warn 'Cancelled'
+            Howzit.console.info 'Cancelled'
             Process.exit 0
           end
           return res.split(/\n/)

data/lib/howzit/task.rb

@@ -13,6 +13,10 @@ module Howzit
       @default = default
     end
 
+    def inspect
+      %(<#Howzit::Task @type=:#{@type} @title="#{@title}" @block?=#{@action.split(/\n/).count > 1}>)
+    end
+
     def to_s
       @title
     end

data/lib/howzit/topic.rb

@@ -42,7 +42,7 @@ module Howzit
           end
 
           if task.type == :block
-            warn "{bg}Running block {bw}#{title}{x}".c if Howzit.options[:log_level] < 2
+            Howzit.console.info "{bg}Running block {bw}#{title}{x}".c if Howzit.options[:log_level] < 2
             block = task.action
             script = Tempfile.new('howzit_script')
             begin
@@ -81,7 +81,7 @@ module Howzit
           end
         end
       else
-        warn "{r}--run: No {br}@directive{xr} found in {bw}#{@title}{x}".c
+        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
 
@@ -95,21 +95,21 @@ module Howzit
       out = "{bg}Copying {bw}#{string}".c
       case os
       when /darwin.*/i
-        warn "#{out} (macOS){x}".c if Howzit.options[:log_level] < 2
+        $stderr.puts "#{out} (macOS){x}".c if Howzit.options[:log_level].zero?
         `echo #{Shellwords.escape(string)}'\\c'|pbcopy`
       when /mingw|mswin/i
-        warn "#{out} (Windows){x}".c if Howzit.options[:log_level] < 2
+        $stderr.puts "#{out} (Windows){x}".c if Howzit.options[:log_level].zero?
         `echo #{Shellwords.escape(string)} | clip`
       else
         if 'xsel'.available?
-          warn "#{out} (Linux, xsel){x}".c if Howzit.options[:log_level] < 2
+          $stderr.puts "#{out} (Linux, xsel){x}".c if Howzit.options[:log_level].zero?
           `echo #{Shellwords.escape(string)}'\\c'|xsel -i`
         elsif 'xclip'.available?
-          warn "#{out} (Linux, xclip){x}".c if Howzit.options[:log_level] < 2
+          $stderr.puts "#{out} (Linux, xclip){x}".c if Howzit.options[:log_level].zero?
           `echo #{Shellwords.escape(string)}'\\c'|xclip -i`
         else
-          warn out if Howzit.options[:log_level] < 2
-          warn 'Unable to determine executable for clipboard.'
+          $stderr.puts out if Howzit.options[:log_level].zero?
+          $stderr.puts 'Unable to determine executable for clipboard.'
         end
       end
     end
@@ -119,18 +119,18 @@ module Howzit
       out = "{bg}Opening {bw}#{command}".c
       case os
       when /darwin.*/i
-        warn "#{out} (macOS){x}".c if Howzit.options[:log_level] < 2
+        Howzit.console.debug "#{out} (macOS){x}".c if Howzit.options[:log_level] < 2
         `open #{Shellwords.escape(command)}`
       when /mingw|mswin/i
-        warn "#{out} (Windows){x}".c if Howzit.options[:log_level] < 2
+        Howzit.console.debug "#{out} (Windows){x}".c if Howzit.options[:log_level] < 2
         `start #{Shellwords.escape(command)}`
       else
         if 'xdg-open'.available?
-          warn "#{out} (Linux){x}".c if Howzit.options[:log_level] < 2
+          Howzit.console.debug "#{out} (Linux){x}".c if Howzit.options[:log_level] < 2
           `xdg-open #{Shellwords.escape(command)}`
         else
-          warn out if Howzit.options[:log_level] < 2
-          warn 'Unable to determine executable for `open`.'
+          Howzit.console.debug out if Howzit.options[:log_level] < 2
+          Howzit.console.debug 'Unable to determine executable for `open`.'
         end
       end
     end

data/lib/howzit/util.rb

@@ -40,7 +40,7 @@ module Howzit
           if hl.available?
             Howzit.options[:highlighter]
           else
-            warn Color.template("{Rw}Error:{xbw} Specified highlighter (#{Howzit.options[:highlighter]}) not found, switching to auto")
+            Howzit.console.error Color.template("{Rw}Error:{xbw} Specified highlighter (#{Howzit.options[:highlighter]}) not found, switching to auto")
             Howzit.options[:highlighter] = 'auto'
             which_highlighter
           end
@@ -78,7 +78,7 @@ module Howzit
           if pg.available?
             Howzit.options[:pager]
           else
-            warn Color.template("{Rw}Error:{xbw} Specified pager (#{Howzit.options[:pager]}) not found, switching to auto")
+            Howzit.console.error Color.template("{Rw}Error:{xbw} Specified pager (#{Howzit.options[:pager]}) not found, switching to auto")
             Howzit.options[:pager] = 'auto'
             which_pager
           end
@@ -104,7 +104,7 @@ module Howzit
           begin
             exec(pager)
           rescue SystemCallError => e
-            @log.error(e)
+            Howzit.console.error(e)
             exit 1
           end
         end

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -5,8 +5,9 @@ require_relative 'howzit/prompt'
 require_relative 'howzit/colors'
 require_relative 'howzit/stringutils'
 
-require_relative 'howzit/util'
 require_relative 'howzit/hash'
+require_relative 'howzit/console_logger'
+require_relative 'howzit/util'
 require_relative 'howzit/config'
 require_relative 'howzit/task'
 require_relative 'howzit/topic'
@@ -52,5 +53,9 @@ module Howzit
     def buildnote
       @buildnote ||= BuildNote.new
     end
+
+    def console
+      @console ||= Howzit::ConsoleLogger.new(options[:log_level])
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.8
 platform: ruby
 authors:
 - Brett Terpstra
@@ -272,6 +272,7 @@ files:
 - lib/howzit/buildnotes.rb
 - lib/howzit/colors.rb
 - lib/howzit/config.rb
+- lib/howzit/console_logger.rb
 - lib/howzit/hash.rb
 - lib/howzit/prompt.rb
 - lib/howzit/stringutils.rb