howzit 2.0.14 → 2.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ce43666235573b6b74c77d0dcb6e1f4c1a45fb8b9cd516747698f56cc3723d
-  data.tar.gz: c13702a3d4b7b2ad707890d3f9d8c2a75e92fba1c732689f1930b511254db742
+  metadata.gz: bb673909d87ac094a2111c1f6fa364fb54183059267e009886562c89a81310d7
+  data.tar.gz: ec766bf5d2f3b3454a289f429e28c12f19545a79dfe6f10d29f0afb04abdc9b2
 SHA512:
-  metadata.gz: 586fcb6d9e5bfd901a3e4d33ff9044c57ae50a97cb0a19e8c2d9e5b57dec6771b432e0dc83e28a924824cc04a758ce4397d0f74b7efb2d343181c262f92c636b
-  data.tar.gz: 5f0eac9f6e53ed64ea159630e0f979f9cc8d8734b95186316b924e1e75e752b7a189d02eb1c178c15050676988356b391cfbc19f3da9eacb61d21051b474188e
+  metadata.gz: b5f2e3624bad256848b1c2d8a4bc95dcbbee5d8cf0e2c63efa79b139ca3a330ce773edb2e68375ea72158de0ce69ffaedd7673f36cbee5cd937c255ccaa3e5fe
+  data.tar.gz: f024cd0ffb6b41ab6184cf36ef65e644e90f5ab7e5c57b8a2c9cc1be404802f992f708464a3a2ab984122fddb4880ec704cda85dd371aeee735b417e15d942c2

data/.travis.yml

@@ -13,4 +13,4 @@ install:
 script: "bundle exec rspec spec --exclude-pattern 'cli*'"
 branches:
   only:
-  - master
+  - main

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 2.0.15
+
+2022-08-05 17:16
+
+#### IMPROVED
+
+- -R can take an argument to filter results
+- Show a topic preview when using fzf to select from available topics
+- Paginate help output
+- Refactor Topic.run
+
+#### FIXED
+
+- Invalid options for more pager
+- Error running grep command
+- Show method not accepting paginate option
+
 ### 2.0.14
 
 2022-08-05 13:24

data/bin/howzit

@@ -49,7 +49,8 @@ OptionParser.new do |opts|
     Howzit.options[:list_topics] = true
   end
 
-  opts.on('-R', '--list-runnable', 'List topics containing @ directives (verbose)') do
+  opts.on('-R', '--list-runnable [PATTERN]', 'List topics containing @ directives (verbose)') do |pat|
+    Howzit.options[:for_topic] = pat
     Howzit.options[:list_runnable] = true
   end
 
@@ -201,7 +202,7 @@ OptionParser.new do |opts|
   opts.separator("\n  Misc:\n\n") #=================================================================== MISC
 
   opts.on('-h', '--help', 'Display this screen') do
-    puts opts
+    Howzit::Util.page opts.to_s
     Process.exit 0
   end
 

data/lib/howzit/buildnote.rb

@@ -32,6 +32,11 @@ module Howzit
       read_help(file)
     end
 
+    ##
+    ## Inspect
+    ##
+    ## @return     description
+    ##
     def inspect
       puts "#<Howzit::BuildNote @topics=[#{@topics.count}]>"
     end
@@ -55,7 +60,8 @@ module Howzit
     ##
     ## @param      term  [String] The search term
     ##
-    def find_topic(term)
+    def find_topic(term = nil)
+      return @topics if term.nil?
       @topics.filter do |topic|
         rx = term.to_rx
         topic.title.downcase =~ rx
@@ -127,7 +133,8 @@ module Howzit
     def list_runnable
       output = []
       output.push(%({bg}"Runnable" Topics:{x}\n).c)
-      @topics.each do |topic|
+
+      find_topic(Howzit.options[:for_topic]).each do |topic|
         s_out = []
 
         topic.tasks.each do |task|
@@ -243,6 +250,11 @@ module Howzit
       Process.exit 0
     end
 
+    ##
+    ## Accessor method for note_file (path to located build note)
+    ##
+    ## @return     [String] path
+    ##
     def note_file
       @note_file ||= find_note_file
     end
@@ -581,7 +593,7 @@ module Howzit
         ARGV.length.times do
           ARGV.shift
         end
-        res = yn("No build notes file found, create one?", true)
+        res = yn("No build notes file found, create one?", false)
         create_note if res
         Process.exit 1
       end
@@ -620,15 +632,15 @@ module Howzit
 
       topic_matches = []
       if Howzit.options[:grep]
-        matches = grep_topics(Howzit.options[:grep])
+        matches = grep(Howzit.options[:grep])
         case Howzit.options[:multiple_matches]
         when :all
-          topic_matches.concat(matches.sort)
+          topic_matches.concat(matches.sort_by(&:title))
         else
-          topic_matches.concat(Prompt.choose(matches))
+          topic_matches.concat(Prompt.choose(matches.map(&:title), height: :max))
         end
       elsif Howzit.options[:choose]
-        titles = Prompt.choose(list_topics)
+        titles = Prompt.choose(list_topics, height: :max)
         titles.each { |title| topic_matches.push(find_topic(title)[0]) }
       # If there are arguments use those to search for a matching topic
       elsif !Howzit.cli_args.empty?

data/lib/howzit/colors.rb

@@ -243,6 +243,7 @@ module Howzit
 
     ATTRIBUTES.each do |c, v|
       new_method = <<-EOSCRIPT
+        # Color string as #{c}
         def #{c}(string = nil)
           result = ''
           result << "\e[#{v}m" if Howzit::Color.coloring?
@@ -266,6 +267,7 @@ module Howzit
 
       # Accept brightwhite in addition to boldwhite
       new_method = <<-EOSCRIPT
+        # color string as #{c}
         def #{c.to_s.sub(/bold/, 'bright')}(string = nil)
           result = ''
           result << "\e[#{v}m" if Howzit::Color.coloring?
@@ -286,6 +288,13 @@ module Howzit
       module_eval(new_method)
     end
 
+    ##
+    ## Generate escape codes for hex colors
+    ##
+    ## @param      hex   [String] The hexadecimal color code
+    ##
+    ## @return     [String] ANSI escape string
+    ##
     def rgb(hex)
       is_bg = hex.match(/^bg?#/) ? true : false
       hex_string = hex.sub(/^([fb]g?)?#/, '')

data/lib/howzit/config.rb

@@ -89,6 +89,7 @@ module Howzit
       flags = {
         choose: false,
         default: false,
+        for_topic: nil,
         grep: nil,
         list_runnable: false,
         list_runnable_titles: false,

data/lib/howzit/prompt.rb

@@ -78,15 +78,21 @@ module Howzit
       ##
       ## @return     [Array] the selected results
       ##
-      def choose(matches)
+      def choose(matches, height: :auto)
+        height = if height == :auto
+                   matches.count + 3
+                 else
+                   TTY::Screen.rows
+                 end
         if Util.command_exist?('fzf')
           settings = [
             '-0',
             '-1',
             '-m',
-            "--height=#{matches.count + 3}",
+            "--height=#{height}",
             '--header="Use tab to mark multiple selections, enter to display/run"',
-            '--prompt="Select a section > "'
+            '--prompt="Select a section > "',
+            '--preview="howzit {}"'
           ]
           res = `echo #{Shellwords.escape(matches.join("\n"))} | fzf #{settings.join(' ')}`.strip
           if res.nil? || res.empty?

data/lib/howzit/task.rb

@@ -17,14 +17,160 @@ module Howzit
       @default = default
     end
 
+    ##
+    ## Inspect
+    ##
+    ## @return     [String] description
+    ##
     def inspect
       %(<#Howzit::Task @type=:#{@type} @title="#{@title}" @block?=#{@action.split(/\n/).count > 1}>)
     end
 
+    ##
+    ## Output string representation
+    ##
+    ## @return     [String] string representation of the object.
+    ##
     def to_s
       @title
     end
 
+    ##
+    ## Execute a block type
+    ##
+    def run_block
+      Howzit.console.info "{bg}Running block {bw}#{@title}{x}".c if Howzit.options[:log_level] < 2
+      block = @action
+      script = Tempfile.new('howzit_script')
+      begin
+        script.write(block)
+        script.close
+        File.chmod(0o777, script.path)
+        system(%(/bin/sh -c "#{script.path}"))
+      ensure
+        script.close
+        script.unlink
+      end
+    end
+
+    ##
+    ## Execute an include task
+    ##
+    ## @return     [Integer] number of tasks executed
+    ##
+    def run_include
+      output = []
+      matches = Howzit.buildnote.find_topic(@action)
+      raise "Topic not found: #{@action}" if matches.empty?
+
+      $stderr.puts "{by}Running tasks from {bw}#{matches[0].title}{x}".c if Howzit.options[:log_level] < 2
+      output.concat(matches[0].run(nested: true))
+      $stderr.puts "{by}End include: #{matches[0].tasks.count} tasks{x}".c if Howzit.options[:log_level] < 2
+      [output, matches[0].tasks.count]
+    end
+
+    ##
+    ## Execute a run task
+    ##
+    def run_run
+      title = Howzit.options[:show_all_code] ? @action : @title
+      $stderr.puts "{bg}Running {bw}#{title}{x}".c if Howzit.options[:log_level] < 2
+      system(@action)
+    end
+
+    ##
+    ## Execute a copy task
+    ##
+    def run_copy
+      title = Howzit.options[:show_all_code] ? @action : @title
+      $stderr.puts "{bg}Copied {bw}#{title}{bg} to clipboard{x}".c if Howzit.options[:log_level] < 2
+      os_copy(@action)
+    end
+
+    ##
+    ## Platform-agnostic copy-to-clipboard
+    ##
+    ## @param      string  [String] The string to copy
+    ##
+    def os_copy(string)
+      os = RbConfig::CONFIG['target_os']
+      out = "{bg}Copying {bw}#{string}".c
+      case os
+      when /darwin.*/i
+        $stderr.puts "#{out} (macOS){x}".c if Howzit.options[:log_level].zero?
+        `echo #{Shellwords.escape(string)}'\\c'|pbcopy`
+      when /mingw|mswin/i
+        $stderr.puts "#{out} (Windows){x}".c if Howzit.options[:log_level].zero?
+        `echo #{Shellwords.escape(string)} | clip`
+      else
+        if 'xsel'.available?
+          $stderr.puts "#{out} (Linux, xsel){x}".c if Howzit.options[:log_level].zero?
+          `echo #{Shellwords.escape(string)}'\\c'|xsel -i`
+        elsif 'xclip'.available?
+          $stderr.puts "#{out} (Linux, xclip){x}".c if Howzit.options[:log_level].zero?
+          `echo #{Shellwords.escape(string)}'\\c'|xclip -i`
+        else
+          $stderr.puts out if Howzit.options[:log_level].zero?
+          $stderr.puts 'Unable to determine executable for clipboard.'
+        end
+      end
+    end
+
+    ##
+    ## Platform-agnostic open command
+    ##
+    ## @param      command  [String] The command
+    ##
+    def os_open(command)
+      os = RbConfig::CONFIG['target_os']
+      out = "{bg}Opening {bw}#{command}".c
+      case os
+      when /darwin.*/i
+        Howzit.console.debug "#{out} (macOS){x}".c if Howzit.options[:log_level] < 2
+        `open #{Shellwords.escape(command)}`
+      when /mingw|mswin/i
+        Howzit.console.debug "#{out} (Windows){x}".c if Howzit.options[:log_level] < 2
+        `start #{Shellwords.escape(command)}`
+      else
+        if 'xdg-open'.available?
+          Howzit.console.debug "#{out} (Linux){x}".c if Howzit.options[:log_level] < 2
+          `xdg-open #{Shellwords.escape(command)}`
+        else
+          Howzit.console.debug out if Howzit.options[:log_level] < 2
+          Howzit.console.debug 'Unable to determine executable for `open`.'
+        end
+      end
+    end
+
+    ##
+    ## Execute the task
+    ##
+    def run
+      output = []
+      tasks = 1
+      if @type == :block
+        run_block
+      else
+        case @type
+        when :include
+          output, tasks = run_include
+        when :run
+          run_run
+        when :copy
+          run_copy
+        when :open
+          os_open(@action)
+        end
+      end
+
+      [output, tasks]
+    end
+
+    ##
+    ## Output terminal-formatted list item
+    ##
+    ## @return     [String] List representation of the object.
+    ##
     def to_list
       "    * #{@type}: #{@title.preserve_escapes}"
     end

data/lib/howzit/topic.rb

@@ -56,52 +56,16 @@ module Howzit
                      task_count = Howzit.buildnote.find_topic(task.action)[0].tasks.count
                      " (#{task_count} tasks)"
                    else
-                     ""
+                     ''
                    end
             q = %({bg}#{task.type.to_s.capitalize} {xw}"{bw}#{task.title}{xw}"#{note}{x}).c
             res = Prompt.yn(q, default: task.default)
             next unless res
 
           end
-
-          if task.type == :block
-            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
-              script.write(block)
-              script.close
-              File.chmod(0777, script.path)
-              system(%(/bin/sh -c "#{script.path}"))
-              tasks += 1
-            ensure
-              script.close
-              script.unlink
-            end
-          else
-            title = Howzit.options[:show_all_code] ? task.action : task.title
-            case task.type
-            when :include
-              matches = Howzit.buildnote.find_topic(task.action)
-              raise "Topic not found: #{task.action}" if matches.empty?
-
-              $stderr.puts "{by}Running tasks from {bw}#{matches[0].title}{x}".c if Howzit.options[:log_level] < 2
-              output.push(matches[0].run(nested: true))
-              $stderr.puts "{by}End include: #{matches[0].tasks.count} tasks{x}".c if Howzit.options[:log_level] < 2
-              tasks += matches[0].tasks.count
-            when :run
-              $stderr.puts "{bg}Running {bw}#{title}{x}".c if Howzit.options[:log_level] < 2
-              system(task.action)
-              tasks += 1
-            when :copy
-              $stderr.puts "{bg}Copied {bw}#{title}{bg} to clipboard{x}".c if Howzit.options[:log_level] < 2
-              os_copy(task.action)
-              tasks += 1
-            when :open
-              os_open(task.action)
-              tasks += 1
-            end
-          end
+          run_output, total = task.run
+          output.concat(run_output)
+          tasks += total
         end
       else
         Howzit.console.warn "{r}--run: No {br}@directive{xr} found in {bw}#{@title}{x}".c
@@ -113,61 +77,6 @@ module Howzit
       output
     end
 
-    ##
-    ## Platform-agnostic copy-to-clipboard
-    ##
-    ## @param      string  [String] The string to copy
-    ##
-    def os_copy(string)
-      os = RbConfig::CONFIG['target_os']
-      out = "{bg}Copying {bw}#{string}".c
-      case os
-      when /darwin.*/i
-        $stderr.puts "#{out} (macOS){x}".c if Howzit.options[:log_level].zero?
-        `echo #{Shellwords.escape(string)}'\\c'|pbcopy`
-      when /mingw|mswin/i
-        $stderr.puts "#{out} (Windows){x}".c if Howzit.options[:log_level].zero?
-        `echo #{Shellwords.escape(string)} | clip`
-      else
-        if 'xsel'.available?
-          $stderr.puts "#{out} (Linux, xsel){x}".c if Howzit.options[:log_level].zero?
-          `echo #{Shellwords.escape(string)}'\\c'|xsel -i`
-        elsif 'xclip'.available?
-          $stderr.puts "#{out} (Linux, xclip){x}".c if Howzit.options[:log_level].zero?
-          `echo #{Shellwords.escape(string)}'\\c'|xclip -i`
-        else
-          $stderr.puts out if Howzit.options[:log_level].zero?
-          $stderr.puts 'Unable to determine executable for clipboard.'
-        end
-      end
-    end
-
-    ##
-    ## Platform-agnostic open command
-    ##
-    ## @param      command  [String] The command
-    ##
-    def os_open(command)
-      os = RbConfig::CONFIG['target_os']
-      out = "{bg}Opening {bw}#{command}".c
-      case os
-      when /darwin.*/i
-        Howzit.console.debug "#{out} (macOS){x}".c if Howzit.options[:log_level] < 2
-        `open #{Shellwords.escape(command)}`
-      when /mingw|mswin/i
-        Howzit.console.debug "#{out} (Windows){x}".c if Howzit.options[:log_level] < 2
-        `start #{Shellwords.escape(command)}`
-      else
-        if 'xdg-open'.available?
-          Howzit.console.debug "#{out} (Linux){x}".c if Howzit.options[:log_level] < 2
-          `xdg-open #{Shellwords.escape(command)}`
-        else
-          Howzit.console.debug out if Howzit.options[:log_level] < 2
-          Howzit.console.debug 'Unable to determine executable for `open`.'
-        end
-      end
-    end
-
     # Output a topic with fancy title and bright white text.
     #
     # @param      options  [Hash] The options

data/lib/howzit/util.rb

@@ -4,7 +4,6 @@ module Howzit
   # Util class
   module Util
     class << self
-
       ##
       ## Read a file with UTF-8 encoding and
       ## leading/trailing whitespace removed
@@ -90,7 +89,7 @@ module Howzit
           args = case pg
                  when 'delta'
                    '--pager="less -FXr"'
-                 when /^(less|more)$/
+                 when 'less'
                    '-FXr'
                  when 'bat'
                    if Howzit.options[:highlight]
@@ -153,6 +152,7 @@ module Howzit
         options = {
           color: true,
           highlight: false,
+          paginate: true,
           wrap: 0
         }
 
@@ -168,7 +168,7 @@ module Howzit
 
         output = `echo #{Shellwords.escape(string.strip)}#{pipes}`.strip
 
-        if Howzit.options[:paginate]
+        if options[:paginate] && Howzit.options[:paginate]
           page(output)
         else
           puts output

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -55,18 +55,30 @@ module Howzit
       @config ||= Config.new
     end
 
+    ##
+    ## Array for tracking inclusions and avoiding duplicates in output
+    ##
     def inclusions
       @inclusions ||= []
     end
 
+    ##
+    ## Module storage for Howzit::Config.options
+    ##
     def options
       config.options
     end
 
+    ##
+    ## Module storage for buildnote
+    ##
     def buildnote
       @buildnote ||= BuildNote.new
     end
 
+    ##
+    ## Convenience method for logging with Howzit.console.warn, etc.
+    ##
     def console
       @console ||= Howzit::ConsoleLogger.new(options[:log_level])
     end

data/spec/task_spec.rb

@@ -15,4 +15,10 @@ describe Howzit::Task do
       expect(task).to be_a Howzit::Task
     end
   end
+
+  describe ".to_s" do
+    it "outputs title string" do
+      expect(task.to_s).to match(/List Directory/)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.14
+  version: 2.0.15
 platform: ruby
 authors:
 - Brett Terpstra