na 1.2.29 → 1.2.31

data/lib/na/array.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ::Array
+  ##
+  ## Like Array#compact -- removes nil items, but also
+  ## removes empty strings, zero or negative numbers and FalseClass items
+  ##
+  ## @return     [Array] Array without "bad" elements
+  ##
+  def remove_bad
+    compact.map { |x| x.is_a?(String) ? x.strip : x }.select(&:good?)
+  end
+end

data/lib/na/help_monkey_patch.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module GLI
+  module Commands
+    # Help Command Monkeypatch for paginated output
+    class Help < Command
+      def show_help(global_options, options, arguments, out, error)
+        NA::Pager.paginate = true
+
+        command_finder = HelpModules::CommandFinder.new(@app, arguments, error)
+        if options[:c]
+          help_output = HelpModules::HelpCompletionFormat.new(@app, command_finder, arguments).format
+          out.puts help_output unless help_output.nil?
+        elsif arguments.empty? || options[:c]
+          NA::Pager.page HelpModules::GlobalHelpFormat.new(@app, @sorter, @text_wrapping_class).format
+        else
+          name = arguments.shift
+          command = command_finder.find_command(name)
+          unless command.nil?
+            NA::Pager.page HelpModules::CommandHelpFormat.new(
+              command,
+              @app,
+              @sorter,
+              @synopsis_formatter_class,
+              @text_wrapping_class
+            ).format
+          end
+        end
+      end
+    end
+  end
+end

data/lib/na/next_action.rb

@@ -512,7 +512,7 @@ module NA
             end
           end
         end
-        puts out.join("\n")
+        NA::Pager.page out.join("\n")
       else
         template = if files.count.positive?
                      if files.count == 1
@@ -533,7 +533,8 @@ module NA
 
         files.map { |f| notify("{dw}#{f}", debug: true) } if files
 
-        puts(actions.map { |action| action.pretty(template: { output: template }, regexes: regexes, notes: notes) })
+        output = actions.map { |action| action.pretty(template: { output: template }, regexes: regexes, notes: notes) }
+        NA::Pager.page(output.join("\n"))
       end
     end
 

data/lib/na/pager.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module NA
+  # Pagination
+  module Pager
+    class << self
+      # Boolean determines whether output is paginated
+      def paginate
+        @paginate ||= false
+      end
+
+      # Enable/disable pagination
+      #
+      # @param      should_paginate  [Boolean] true to paginate
+      def paginate=(should_paginate)
+        @paginate = should_paginate
+      end
+
+      # Page output. If @paginate is false, just dump to
+      # STDOUT
+      #
+      # @param      text  [String] text to paginate
+      #
+      def page(text)
+        unless @paginate
+          puts text
+          return
+        end
+
+        pager = which_pager
+
+        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]
+
+          begin
+            NA.notify("{dw}Pager #{pager}", debug: true)
+            exec(pager)
+          rescue SystemCallError => e
+            raise Errors::DoingStandardError, "Pager error, #{e}"
+          end
+        end
+
+        begin
+          read_io.close
+          write_io.write(text)
+          write_io.close
+        rescue SystemCallError # => e
+          # raise Errors::DoingStandardError, "Pager error, #{e}"
+        end
+
+        _, status = Process.waitpid2(pid)
+        status.success?
+      end
+
+      private
+
+      def git_pager
+        TTY::Which.exist?('git') ? `#{TTY::Which.which('git')} config --get-all core.pager` : nil
+      end
+
+      def pagers
+        [
+          ENV['PAGER'],
+          'less -FXr',
+          ENV['GIT_PAGER'],
+          git_pager,
+          'more -r'
+        ].remove_bad
+      end
+
+      def find_executable(*commands)
+        execs = commands.empty? ? pagers : commands
+        execs
+          .remove_bad.uniq
+          .find { |cmd| TTY::Which.exist?(cmd.split.first) }
+      end
+
+      def which_pager
+        @which_pager ||= find_executable(*pagers)
+      end
+    end
+  end
+end

data/lib/na/string.rb

@@ -2,6 +2,16 @@
 
 # String helpers
 class ::String
+  ##
+  ## Tests if object is nil or empty
+  ##
+  ## @return     [Boolean] true if object is defined and
+  ##             has content
+  ##
+  def good?
+    !strip.empty?
+  end
+
   def read_file
     file = File.expand_path(self)
     raise "Missing file #{file}" unless File.exist?(file)

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.2.29'
+  VERSION = '1.2.31'
 end

data/lib/na.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'na/version'
+require 'na/pager'
 require 'time'
 require 'fileutils'
 require 'shellwords'
@@ -11,6 +12,7 @@ require 'tty-which'
 require 'na/hash'
 require 'na/colors'
 require 'na/string'
+require 'na/array'
 require 'na/project'
 require 'na/action'
 require 'na/next_action'

data/src/_README.md

@@ -9,7 +9,7 @@
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-The current version of `na` is <!--VER-->1.2.28<!--END VER-->.
+The current version of `na` is <!--VER-->1.2.29<!--END VER-->.
 
 `na` ("next action") is a command line tool designed to make it easy to see what your next actions are for any project, right from the command line. It works with TaskPaper-formatted files (but any plain text format will do), looking for `@na` tags (or whatever you specify) in todo files in your current folder. 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.2.29
+  version: 1.2.31
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -210,6 +210,7 @@ files:
 - bin/commands/archive.rb
 - bin/commands/changes.rb
 - bin/commands/complete.rb
+- bin/commands/completed.rb
 - bin/commands/edit.rb
 - bin/commands/find.rb
 - bin/commands/init.rb
@@ -223,9 +224,12 @@ files:
 - bin/na
 - lib/na.rb
 - lib/na/action.rb
+- lib/na/array.rb
 - lib/na/colors.rb
 - lib/na/hash.rb
+- lib/na/help_monkey_patch.rb
 - lib/na/next_action.rb
+- lib/na/pager.rb
 - lib/na/project.rb
 - lib/na/prompt.rb
 - lib/na/string.rb