howzit 2.0.7 → 2.0.10

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
@@ -85,7 +102,7 @@ module Howzit
       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

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

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -21,15 +21,28 @@ require 'tempfile'
 require 'yaml'
 
 require 'tty/screen'
+require 'tty/box'
 # require 'tty/prompt'
 
+# Main config dir
 CONFIG_DIR = '~/.config/howzit'
+
+# Config file name
 CONFIG_FILE = 'howzit.yaml'
+
+# Ignore file name
 IGNORE_FILE = 'ignore.yaml'
+
+# Available options for matching method
 MATCHING_OPTIONS = %w[partial exact fuzzy beginswith].freeze
+
+# Available options for multiple_matches method
 MULTIPLE_OPTIONS = %w[first best all choose].freeze
+
+# Available options for header formatting
 HEADER_FORMAT_OPTIONS = %w[border block].freeze
 
+# Main module for howzit
 module Howzit
   class << self
     attr_accessor :arguments, :cli_args

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 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.10
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: cli-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -240,6 +254,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: tty-box
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Command line project documentation and task runner
 email:
 - me@brettterpstra.com
@@ -269,7 +297,6 @@ files:
 - lib/.rubocop.yml
 - lib/howzit.rb
 - lib/howzit/buildnote.rb
-- lib/howzit/buildnotes.rb
 - lib/howzit/colors.rb
 - lib/howzit/config.rb
 - lib/howzit/console_logger.rb
@@ -283,6 +310,7 @@ files:
 - spec/.rubocop.yml
 - spec/buildnote_spec.rb
 - spec/buildnotes.md.bak
+- spec/cli_spec.rb
 - spec/ruby_gem_spec.rb
 - spec/spec_helper.rb
 - spec/task_spec.rb
@@ -316,6 +344,7 @@ test_files:
 - spec/.rubocop.yml
 - spec/buildnote_spec.rb
 - spec/buildnotes.md.bak
+- spec/cli_spec.rb
 - spec/ruby_gem_spec.rb
 - spec/spec_helper.rb
 - spec/task_spec.rb