howzit 2.0.6 → 2.0.9

data/lib/howzit/buildnote.rb

@@ -10,7 +10,7 @@ module Howzit
     def initialize(file: nil, args: [])
       @topics = []
       create_note if note_file.nil?
-      @metadata = IO.read(note_file).split(/^#/)[0].strip.get_metadata
+      @metadata = Util.read_file(note_file).split(/^#/)[0].strip.get_metadata
 
       read_help(file)
     end
@@ -89,7 +89,7 @@ module Howzit
     # Create a buildnotes skeleton
     def create_note
       trap('SIGINT') do
-        warn "\nCanceled"
+        Howzit.console.info "\nCancelled"
         exit!
       end
       default = !$stdout.isatty || Howzit.options[:default]
@@ -210,9 +210,11 @@ module Howzit
       buildnotes.reverse
     end
 
-    def is_build_notes(filename)
-      return false if filename.downcase !~ /(^howzit[^.]*|build[^.]+)/
+    def build_note?(filename)
+      return false if filename.downcase !~ /^(howzit[^.]*|build[^.]+)/
+
       return false if Howzit.config.should_ignore(filename)
+
       true
     end
 
@@ -222,7 +224,7 @@ module Howzit
       # with "build" and have an extension of txt, md, or markdown.
 
       Dir.glob('*.{txt,md,markdown}').each do |f|
-        if is_build_notes(f)
+        if build_note?(f)
           filename = f
           break
         end
@@ -262,15 +264,15 @@ module Howzit
     end
 
     def ensure_requirements(template)
-      t_leader = IO.read(template).split(/^#/)[0].strip
+      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)
-              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
@@ -330,7 +332,7 @@ module Howzit
 
       return m[0] unless File.exist?(file)
 
-      content = IO.read(file)
+      content = Util.read_file(file)
       home = ENV['HOME']
       short_path = File.dirname(file.sub(/^#{home}/, '~'))
       prefix = "#{short_path}/#{File.basename(file)}:"
@@ -344,7 +346,7 @@ module Howzit
     end
 
     def note_title(truncate = 0)
-      help = IO.read(note_file).strip
+      help = Util.read_file(note_file)
       title = help.match(/(?:^(\S.*?)(?=\n==)|^# ?(.*?)$)/)
       title = if title
                 title[1].nil? ? title[2] : title[1]
@@ -361,7 +363,7 @@ module Howzit
 
       filename = path.nil? ? note_file : path
 
-      help = IO.read(filename)
+      help = Util.read_file(filename)
 
       @title = note_title
 

data/lib/howzit/config.rb

@@ -3,6 +3,7 @@ module Howzit
   class Config
     attr_reader :options
 
+    # Configuration defaults
     DEFAULTS = {
       color: true,
       config_editor: ENV['EDITOR'] || nil,
@@ -22,18 +23,31 @@ 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)
 
-      @ignore_patterns ||= YAML.safe_load(IO.read(ignore_file))
+      @ignore_patterns ||= YAML.safe_load(Util.read_file(ignore_file))
 
       ignore = false
 
@@ -47,16 +61,29 @@ 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
 
     private
 
+    ##
+    ## Load command line options
+    ##
+    ## @return     [Hash] options with command line flags merged in
+    ##
     def load_options
       Color.coloring = $stdout.isatty
       flags = {
@@ -77,40 +104,68 @@ module Howzit
       @options = flags.merge(config)
     end
 
+    ##
+    ## Get the config directory
+    ##
+    ## @return     [String] path to config directory
+    ##
     def config_dir
       File.expand_path(CONFIG_DIR)
     end
 
+    ##
+    ## Get the config file
+    ##
+    ## @return     [String] path to config file
+    ##
     def config_file
       File.join(config_dir, CONFIG_FILE)
     end
 
+    ##
+    ## Get the ignore config file
+    ##
+    ## @return     [String] path to ignore config file
+    ##
     def ignore_file
       File.join(config_dir, IGNORE_FILE)
     end
 
-    def create_config(d)
+    ##
+    ## Create a new config file (and directory if needed)
+    ##
+    ## @param      default     [Hash] default configuration to write
+    ##
+    def create_config(default)
       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}"
-        write_config(d)
+        Howzit::ConsoleLogger.new(1).info "Writing fresh config file to #{config_file}"
+        write_config(default)
       end
       config_file
     end
 
+    ##
+    ## Load the config file
+    ##
+    ## @return     [Hash] configuration object
+    ##
     def load_config
       file = create_config(DEFAULTS)
-      config = YAML.load(IO.read(file))
+      config = YAML.load(Util.read_file(file))
       newconfig = config ? DEFAULTS.merge(config) : DEFAULTS
       write_config(newconfig)
       newconfig.dup
     end
 
-    def edit_config(d)
+    ##
+    ## Open the config in an editor
+    ##
+    def edit_config
       editor = Howzit.options.fetch(:config_editor, ENV['EDITOR'])
 
       raise 'No config_editor defined' if editor.nil?

data/lib/howzit/console_logger.rb

@@ -0,0 +1,80 @@
+# 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
+
+    ##
+    ## Init the console logging object
+    ##
+    ## @param      level  [Integer] log level
+    ##
+    def initialize(level = nil)
+      @log_level = level.to_i || Howzit.options[:log_level]
+    end
+
+    ##
+    ## Get the log level from options
+    ##
+    ## @return     [Integer] log level
+    ##
+    def reset_level
+      @log_level = Howzit.options[:log_level]
+    end
+
+    ##
+    ## Write a message to the console based on the urgency
+    ## level and user's log level setting
+    ##
+    ## @param      msg    [String] The message
+    ## @param      level  [Symbol] The level
+    ##
+    def write(msg, level = :info)
+      $stderr.puts msg if LOG_LEVELS[level] >= @log_level
+    end
+
+    ##
+    ## Write a message at debug level
+    ##
+    ## @param      msg   The message
+    ##
+    def debug(msg)
+      write msg, :debug
+    end
+
+    ##
+    ## Write a message at info level
+    ##
+    ## @param      msg   The message
+    ##
+    def info(msg)
+      write msg, :info
+    end
+
+    ##
+    ## Write a message at warn level
+    ##
+    ## @param      msg   The message
+    ##
+    def warn(msg)
+      write msg, :warn
+    end
+
+    ##
+    ## Write a message at error level
+    ##
+    ## @param      msg   The message
+    ##
+    def error(msg)
+      write msg, :error
+    end
+  end
+end

data/lib/howzit/prompt.rb

@@ -8,14 +8,15 @@ module Howzit
         return default unless $stdout.isatty
 
         return default if Howzit.options[:default]
-
-        system 'stty cbreak'
+        tty_state = `stty -g`
+        system 'stty raw -echo cbreak isig'
         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'
+        system "stty #{tty_state}"
         res.empty? ? default : res =~ /y/i
       end
 
@@ -24,12 +25,12 @@ module Howzit
         choices.each do |choice|
           case choice
           when /[A-Z]/
-            out.push(Color.template("{bg}#{choice}{xg}"))
+            out.push(Color.template("{bw}#{choice}{x}"))
           else
-            out.push(Color.template("{w}#{choice}"))
+            out.push(Color.template("{dw}#{choice}{xg}"))
           end
         end
-        Color.template("{g}[#{out.join('/')}{g}]{x}")
+        Color.template("{xg}[#{out.join('/')}{xg}]{x}")
       end
 
       def options_list(matches)
@@ -54,7 +55,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/stringutils.rb

@@ -147,7 +147,7 @@ module Howzit
 
     def extract_metadata
       if File.exist?(self)
-        leader = IO.read(self).split(/^#/)[0].strip
+        leader = Util.read_file(self).split(/^#/)[0].strip
         leader.length > 0 ? leader.get_metadata : {}
       else
         {}

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

@@ -9,6 +9,12 @@ module Howzit
 
     attr_reader :title, :tasks, :prereqs, :postreqs
 
+    ##
+    ## Initialize a topic object
+    ##
+    ## @param      title    [String] The topic title
+    ## @param      content  [String] The raw topic content
+    ##
     def initialize(title, content)
       @title = title
       @content = content
@@ -17,18 +23,29 @@ module Howzit
       @tasks = gather_tasks
     end
 
+    ##
+    ## Search title and contents for a pattern
+    ##
+    ## @param      term  [String] the search pattern
+    ##
     def grep(term)
       @title =~ /#{term}/i || @content =~ /#{term}/i
     end
 
-    # Handle run command, execute directives
+    # 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
+        60
+      end
+
       if @tasks.count.positive?
         unless @prereqs.empty?
-          puts @prereqs.join("\n\n")
-          res = Prompt.yn('This topic has prerequisites, have they been met?', default: true)
+          puts TTY::Box.frame("{by}#{@prereqs.join("\n\n").wrap(cols - 4)}{x}".c, width: cols)
+          res = Prompt.yn('Have the above prerequisites been met?', default: true)
           Process.exit 1 unless res
 
         end
@@ -42,7 +59,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,11 +98,11 @@ 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
 
-      puts postreqs.join("\n\n") unless postreqs.empty?
+      puts TTY::Box.frame("{bw}#{@postreqs.join("\n\n").wrap(cols - 4)}{x}".c, width: cols) unless @postreqs.empty?
 
       output
     end
@@ -95,21 +112,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 +136,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

@@ -1,21 +1,26 @@
+# frozen_string_literal: true
+
 module Howzit
+  # Util class
   module Util
     class << self
+      def read_file(path)
+        IO.read(path).force_encoding('utf-8').strip
+      end
+
       def valid_command?(command)
         cmd = command.split(' ')[0]
         command_exist?(cmd)
       end
-      
+
       def command_exist?(command)
         exts = ENV.fetch('PATHEXT', '').split(::File::PATH_SEPARATOR)
         if Pathname.new(command).absolute?
-          ::File.exist?(command) ||
-            exts.any? { |ext| ::File.exist?("#{command}#{ext}") }
+          ::File.exist?(command) || exts.any? { |ext| ::File.exist?("#{command}#{ext}") }
         else
           ENV.fetch('PATH', '').split(::File::PATH_SEPARATOR).any? do |dir|
             file = ::File.join(dir, command)
-            ::File.exist?(file) ||
-              exts.any? { |ext| ::File.exist?("#{file}#{ext}") }
+            ::File.exist?(file) || exts.any? { |ext| ::File.exist?("#{file}#{ext}") }
           end
         end
       end
@@ -40,7 +45,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 +83,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 +109,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.6'
+  VERSION = '2.0.9'
 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'
@@ -20,6 +21,7 @@ require 'tempfile'
 require 'yaml'
 
 require 'tty/screen'
+require 'tty/box'
 # require 'tty/prompt'
 
 CONFIG_DIR = '~/.config/howzit'
@@ -29,6 +31,7 @@ MATCHING_OPTIONS = %w[partial exact fuzzy beginswith].freeze
 MULTIPLE_OPTIONS = %w[first best all choose].freeze
 HEADER_FORMAT_OPTIONS = %w[border block].freeze
 
+# Main module for howzit
 module Howzit
   class << self
     attr_accessor :arguments, :cli_args
@@ -52,5 +55,9 @@ module Howzit
     def buildnote
       @buildnote ||= BuildNote.new
     end
+
+    def console
+      @console ||= Howzit::ConsoleLogger.new(options[:log_level])
+    end
   end
 end

data/spec/cli_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# https://github.com/thoiberg/cli-test
+describe 'CLI' do
+  include CliTest
+
+  it 'executes successfully' do
+    execute_script('bin/howzit', use_bundler: true)
+    expect(last_execution).to be_successful
+  end
+
+  it 'lists available topics' 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 3
+  end
+
+  it 'lists available tasks' do
+    execute_script('bin/howzit', use_bundler: true, args: %w[-T])
+    expect(last_execution).to be_successful
+    expect(last_execution.stdout).to match(/Topic Balogna/)
+    expect(last_execution.stdout.split(/\n/).count).to eq 2
+  end
+end

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@
 # end
 
 require 'howzit'
+require 'cli-test'
 
 RSpec.configure do |c|
   c.expect_with(:rspec) { |e| e.syntax = :expect }