howzit 1.2.14 → 1.2.17

data/lib/howzit/util.rb

@@ -0,0 +1,149 @@
+module Howzit
+  module Util
+    class << self
+      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}") }
+        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}") }
+          end
+        end
+      end
+
+      # If either mdless or mdcat are installed, use that for highlighting
+      # markdown
+      def which_highlighter
+        if Howzit.options[:highlighter] =~ /auto/i
+          highlighters = %w[mdcat mdless]
+          highlighters.delete_if(&:nil?).select!(&:available?)
+          return nil if highlighters.empty?
+
+          hl = highlighters.first
+          args = case hl
+                 when 'mdless'
+                   '--no-pager'
+                 end
+
+          [hl, args].join(' ')
+        else
+          hl = Howzit.options[:highlighter].split(/ /)[0]
+          if hl.available?
+            Howzit.options[:highlighter]
+          else
+            warn Color.template("{Rw}Error:{xbw} Specified highlighter (#{Howzit.options[:highlighter]}) not found, switching to auto")
+            Howzit.options[:highlighter] = 'auto'
+            which_highlighter
+          end
+        end
+      end
+
+      # When pagination is enabled, find the best (in my opinion) option,
+      # favoring environment settings
+      def which_pager
+        if Howzit.options[:pager] =~ /auto/i
+          pagers = [ENV['PAGER'], ENV['GIT_PAGER'],
+                    'bat', 'less', 'more', 'pager']
+          pagers.delete_if(&:nil?).select!(&:available?)
+          return nil if pagers.empty?
+
+          pg = pagers.first
+          args = case pg
+                 when 'delta'
+                   '--pager="less -FXr"'
+                 when /^(less|more)$/
+                   '-FXr'
+                 when 'bat'
+                   if Howzit.options[:highlight]
+                     '--language Markdown --style plain --pager="less -FXr"'
+                   else
+                     '--style plain --pager="less -FXr"'
+                   end
+                 else
+                   ''
+                 end
+
+          [pg, args].join(' ')
+        else
+          pg = Howzit.options[:pager].split(/ /)[0]
+          if pg.available?
+            Howzit.options[:pager]
+          else
+            warn Color.template("{Rw}Error:{xbw} Specified pager (#{Howzit.options[:pager]}) not found, switching to auto")
+            Howzit.options[:pager] = 'auto'
+            which_pager
+          end
+        end
+      end
+
+      # Paginate the output
+      def page(text)
+        read_io, write_io = IO.pipe
+
+        input = $stdin
+
+        pid = Kernel.fork do
+          write_io.close
+          input.reopen(read_io)
+          read_io.close
+
+          # Wait until we have input before we start the pager
+          IO.select [input]
+
+          pager = which_pager
+
+          begin
+            exec(pager)
+          rescue SystemCallError => e
+            @log.error(e)
+            exit 1
+          end
+        end
+
+        read_io.close
+        write_io.write(text)
+        write_io.close
+
+        _, status = Process.waitpid2(pid)
+
+        status.success?
+      end
+
+      # print output to terminal
+      def show(string, opts = {})
+        options = {
+          color: true,
+          highlight: false,
+          wrap: 0
+        }
+
+        options.merge!(opts)
+
+        string = string.uncolor unless options[:color]
+
+        pipes = ''
+        if options[:highlight]
+          hl = which_highlighter
+          pipes = "|#{hl}" if hl
+        end
+
+        output = `echo #{Shellwords.escape(string.strip)}#{pipes}`.strip
+
+        if Howzit.options[:paginate]
+          page(output)
+        else
+          puts output
+        end
+      end
+    end
+  end
+end

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -1,8 +1,17 @@
-require 'howzit/version'
-require 'howzit/prompt'
-require 'howzit/colors'
-require 'howzit/buildnotes'
-require 'howzit/stringutils'
+# frozen_string_literal: true
+
+require_relative 'howzit/version'
+require_relative 'howzit/prompt'
+require_relative 'howzit/colors'
+require_relative 'howzit/stringutils'
+
+require_relative 'howzit/util'
+require_relative 'howzit/hash'
+require_relative 'howzit/config'
+require_relative 'howzit/task'
+require_relative 'howzit/topic'
+require_relative 'howzit/buildnote'
+
 require 'optparse'
 require 'shellwords'
 require 'pathname'
@@ -17,3 +26,30 @@ CONFIG_FILE = 'howzit.yaml'
 IGNORE_FILE = 'ignore.yaml'
 MATCHING_OPTIONS = %w[partial exact fuzzy beginswith].freeze
 MULTIPLE_OPTIONS = %w[first best all choose].freeze
+HEADER_FORMAT_OPTIONS = %w[border block].freeze
+
+module Howzit
+  class << self
+    attr_accessor :arguments, :cli_args
+    ##
+    ## Holds a Configuration object with methods and a @settings hash
+    ##
+    ## @return     [Configuration] Configuration object
+    ##
+    def config
+      @config ||= Config.new
+    end
+
+    def inclusions
+      @inclusions ||= []
+    end
+
+    def options
+      config.options
+    end
+
+    def buildnote
+      @buildnote ||= BuildNote.new
+    end
+  end
+end

data/spec/ruby_gem_spec.rb

@@ -1,40 +1,110 @@
 require 'spec_helper'
 
-describe Howzit::BuildNotes do
-  subject(:ruby_gem) { Howzit::BuildNotes.new([]) }
+describe Howzit::BuildNote do
+  subject(:buildnote) { Howzit.buildnote }
 
   describe ".new" do
     it "makes a new instance" do
-      expect(ruby_gem).to be_a Howzit::BuildNotes
+      expect(buildnote).to be_a Howzit::BuildNote
     end
   end
 end
 
-describe Howzit::BuildNotes do
+describe Howzit::Task do
+  subject(:task) { Howzit::Task.new(:run, 'List Directory', 'ls') }
+
+  describe ".new" do
+    it "makes a new task instance" do
+      expect(task).to be_a Howzit::Task
+    end
+  end
+end
+
+describe Howzit::Topic do
+  title = 'Test Title'
+  content = 'Test Content'
+  subject(:topic) { Howzit::Topic.new(title, content) }
+
+  describe ".new" do
+    it "makes a new topic instance" do
+      expect(topic).to be_a Howzit::Topic
+    end
+    it "has the correct title" do
+      expect(topic.title).to eq title
+    end
+    it "has the correct content" do
+      expect(topic.content).to eq content
+    end
+  end
+end
+
+describe Howzit::BuildNote do
   Dir.chdir('spec')
-  how = Howzit::BuildNotes.new(['--no-upstream', '--default'])
-  how.create_note
-  subject { how }
+  Howzit.options[:include_upstream] = false
+  Howzit.options[:default] = true
+  hz = Howzit.buildnote
+
+  hz.create_note
+  subject(:how) { hz }
 
   describe ".note_file" do
     it "locates a build note file" do
-      expect(subject.note_file).not_to be_empty
+      expect(how.note_file).not_to be_empty
+    end
+  end
+
+  describe ".grep" do
+    it "finds topic containing 'editable'" do
+      expect(how.grep('editable').map { |topic| topic.title }).to include('File Structure')
+    end
+    it "does not return non-matching topic" do
+      expect(how.grep('editable').map { |topic| topic.title }).not_to include('Build')
     end
   end
 
-  describe ".grep_topics" do
-    it "finds editable" do
-      expect(subject.grep_topics('editable')).to include('File Structure')
-      expect(subject.grep_topics('editable')).not_to include('Build')
+  describe ".find_topic" do
+    it "finds the File Structure topic" do
+      matches = how.find_topic('file struct')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'File Structure'
+    end
+    it "fuzzy matches" do
+      Howzit.options[:matching] = 'fuzzy'
+      matches = how.find_topic('flestct')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'File Structure'
+    end
+    it "succeeds with partial match" do
+      Howzit.options[:matching] = 'partial'
+      matches = how.find_topic('structure')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'File Structure'
+    end
+    it "succeeds with beginswith match" do
+      Howzit.options[:matching] = 'beginswith'
+      matches = how.find_topic('file')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'File Structure'
+    end
+    it "succeeds with exact match" do
+      Howzit.options[:matching] = 'exact'
+      matches = how.find_topic('file structure')
+      expect(matches.count).to eq 1
+      expect(matches[0].title).to eq 'File Structure'
+    end
+    it "fails with incomplete exact match" do
+      Howzit.options[:matching] = 'exact'
+      matches = how.find_topic('file struct')
+      expect(matches.count).to eq 0
     end
   end
 
-  describe ".list_topic_titles" do
-    it "finds 4 topics" do
-      expect(subject.topics.keys.count).to eq 4
+  describe ".topics" do
+    it "contains 4 topics" do
+      expect(how.list_topics.count).to eq 4
     end
-    it "outputs a newline-separated string" do
-      expect(subject.list_topic_titles.scan(/\n/).count).to eq 3
+    it "outputs a newline-separated string for completion" do
+      expect(how.list_completions.scan(/\n/).count).to eq 3
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 1.2.14
+  version: 1.2.17
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -268,10 +268,16 @@ files:
 - howzit.gemspec
 - lib/.rubocop.yml
 - lib/howzit.rb
+- lib/howzit/buildnote.rb
 - lib/howzit/buildnotes.rb
 - lib/howzit/colors.rb
+- lib/howzit/config.rb
+- lib/howzit/hash.rb
 - lib/howzit/prompt.rb
 - lib/howzit/stringutils.rb
+- lib/howzit/task.rb
+- lib/howzit/topic.rb
+- lib/howzit/util.rb
 - lib/howzit/version.rb
 - spec/.rubocop.yml
 - spec/ruby_gem_spec.rb