doing 2.1.39 → 2.1.42

data/lib/doing/prompt/choose.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Doing
+  # Methods for creating interactive menus of options and items
+  module PromptChoose
+    ##
+    ## Generate a menu of options and allow user selection
+    ##
+    ## @return     [String] The selected option
+    ##
+    ## @param      options   [Array] The options from which to choose
+    ## @param      prompt    [String] The prompt
+    ## @param      multiple  [Boolean] If true, allow multiple selections
+    ## @param      sorted    [Boolean] If true, sort selections alphanumerically
+    ## @param      fzf_args  [Array] Additional fzf arguments
+    ##
+    def choose_from(options, prompt: 'Make a selection: ', multiple: false, sorted: true, fzf_args: [])
+      return nil unless $stdout.isatty
+
+      # fzf_args << '-1' # User is expecting a menu, and even if only one it seves as confirmation
+      default_args = []
+      default_args << %(--prompt="#{prompt}")
+      default_args << "--height=#{options.count + 2}"
+      default_args << '--info=inline'
+      default_args << '--multi' if multiple
+      header = "esc: cancel,#{multiple ? ' tab: multi-select, ctrl-a: select all,' : ''} return: confirm"
+      default_args << %(--header="#{header}")
+      default_args.concat(fzf_args)
+      options.sort! if sorted
+
+      res = `echo #{Shellwords.escape(options.join("\n"))}|#{fzf} #{default_args.join(' ')}`
+      return false if res.strip.size.zero?
+
+      res
+    end
+
+    ##
+    ## Create an interactive menu to select from a set of Items
+    ##
+    ## @param      items            [Array] list of items
+    ## @param      opt              Additional options
+    ##
+    ## @option opt [Boolean] :include_section Include section name for each item in menu
+    ## @option opt [String] :header A custom header string
+    ## @option opt [String] :prompt A custom prompt string
+    ## @option opt [String] :query Initial query
+    ## @option opt [Boolean] :show_if_single Show menu even if there's only one option
+    ## @option opt [Boolean] :menu Show menu
+    ## @option opt [Boolean] :sort Sort options
+    ## @option opt [Boolean] :multiple Allow multiple selections
+    ## @option opt [Symbol] :case (:sensitive, :ignore, :smart)
+    ##
+    def choose_from_items(items, **opt)
+      return items unless $stdout.isatty
+
+      return nil unless items.count.positive?
+
+      case_sensitive = opt.fetch(:case, :smart).normalize_case
+      header = opt.fetch(:header, 'Arrows: navigate, tab: mark for selection, ctrl-a: select all, enter: commit')
+      prompt = opt.fetch(:prompt, 'Select entries to act on > ')
+      query = opt.fetch(:query) { opt.fetch(:search, '') }
+      include_section = opt.fetch(:include_section, false)
+
+      pad = items.length.to_s.length
+      options = items.map.with_index do |item, i|
+        out = [
+          format("%#{pad}d", i),
+          ') ',
+          format('%16s', item.date.strftime('%Y-%m-%d %H:%M')),
+          ' | ',
+          item.title
+        ]
+        if include_section
+          out.concat([
+            ' (',
+            item.section,
+            ') '
+          ])
+        end
+        out.join('')
+      end
+
+      fzf_args = [
+        %(--header="#{header}"),
+        %(--prompt="#{prompt.sub(/ *$/, ' ')}"),
+        opt.fetch(:multiple) ? '--multi' : '--no-multi',
+        '-0',
+        '--bind ctrl-a:select-all',
+        %(-q "#{query}"),
+        '--info=inline'
+      ]
+      fzf_args.push('-1') unless opt.fetch(:show_if_single, false)
+      fzf_args << case case_sensitive
+                  when :sensitive
+                    '+i'
+                  when :ignore
+                    '-i'
+                  end
+      fzf_args << '-e' if opt.fetch(:exact, false)
+
+
+      unless opt.fetch(:menu)
+        raise InvalidArgument, "Can't skip menu when no query is provided" unless query && !query.empty?
+
+        fzf_args.concat([%(--filter="#{query}"), opt.fetch(:sort) ? '' : '--no-sort'])
+      end
+      res = `echo #{Shellwords.escape(options.join("\n"))}|#{fzf} #{fzf_args.join(' ')}`
+
+      selected = []
+      res.split(/\n/).each do |item|
+        idx = item.match(/^ *(\d+)\)/)[1].to_i
+        selected.push(items[idx])
+      end
+
+      opt.fetch(:multiple) ? selected : selected[0]
+    end
+  end
+end

data/lib/doing/prompt/fzf.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Doing
+  # Methods for working installing/using FuzzyFileFinder
+  module PromptFZF
+    ##
+    ## Get path to fzf binary, installing if needed
+    ##
+    ## @return     [String] Path to fzf binary
+    ##
+    def fzf
+      @fzf ||= install_fzf
+    end
+
+    ##
+    ## Remove fzf binary
+    ##
+    def uninstall_fzf
+      fzf_bin = File.join(File.dirname(__FILE__), '../../helpers/fzf/bin/fzf')
+      FileUtils.rm_f(fzf_bin) if File.exist?(fzf_bin)
+      Doing.logger.warn('fzf:', "removed #{fzf_bin}")
+    end
+
+    ##
+    ## Return the path to the fzf binary
+    ##
+    ## @return     [String] Path to fzf
+    ##
+    def which_fzf
+      fzf_dir = File.join(File.dirname(__FILE__), '../../helpers/fzf')
+      fzf_bin = File.join(fzf_dir, 'bin/fzf')
+      return fzf_bin if File.exist?(fzf_bin)
+
+      Doing.logger.debug('fzf:', 'Using user-installed fzf')
+      TTY::Which.which('fzf')
+    end
+
+    ##
+    ## Install fzf on the current system. Installs to a
+    ## subdirectory of the gem
+    ##
+    ## @param      force  [Boolean] If true, reinstall if
+    ##                    needed
+    ##
+    ## @return     [String] Path to fzf binary
+    ##
+    def install_fzf(force: false)
+      if force
+        uninstall_fzf
+      elsif which_fzf
+        return which_fzf
+      end
+
+      fzf_dir = File.join(File.dirname(__FILE__), '../../helpers/fzf')
+      FileUtils.mkdir_p(fzf_dir) unless File.directory?(fzf_dir)
+      fzf_bin = File.join(fzf_dir, 'bin/fzf')
+      return fzf_bin if File.exist?(fzf_bin)
+
+      prev_level = Doing.logger.level
+      Doing.logger.adjust_verbosity({ log_level: :info })
+      Doing.logger.log_now(:warn, 'fzf:', 'Compiling and installing fzf -- this will only happen once')
+      Doing.logger.log_now(:warn, 'fzf:', 'fzf is copyright Junegunn Choi, MIT License <https://github.com/junegunn/fzf/blob/master/LICENSE>')
+
+      silence_std
+      `'#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null`
+      unless File.exist?(fzf_bin)
+        restore_std
+        Doing.logger.log_now(:warn, 'Error installing, trying again as root')
+        silence_std
+        `sudo '#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null`
+      end
+      restore_std
+      unless File.exist?(fzf_bin)
+        Doing.logger.error('fzf:', 'unable to install fzf. You can install manually and Doing will use the system version.')
+        Doing.logger.error('fzf:', 'see https://github.com/junegunn/fzf#installation')
+        raise RuntimeError.new('Error installing fzf, please report at https://github.com/ttscoff/doing/issues')
+      end
+
+      Doing.logger.info('fzf:', "installed to #{fzf}")
+      Doing.logger.adjust_verbosity({ log_level: prev_level })
+      fzf_bin
+    end
+  end
+end

data/lib/doing/prompt/input.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Doing
+  # Methods for requesting user text input
+  module PromptInput
+    ##
+    ## Request single-line input
+    ##
+    ## @param      prompt            [String] The prompt
+    ## @param      default_response  [String] The default
+    ##                               response returned if
+    ##                               :default_answer is
+    ##                               true
+    ##
+    ## @return     [String] The user response
+    ##
+    ## @deprecated Use {#read_line} instead
+    ##
+    def enter_text(prompt, default_response: '')
+      $stdin.reopen('/dev/tty')
+      return default_response if @default_answer
+
+      print "#{yellow(prompt).sub(/:?$/, ':')} #{reset}"
+      $stdin.gets.strip
+    end
+
+    ##
+    ## Request single-line input using Readline. Allows
+    ## for control sequences and tab completions
+    ##
+    ## @param      prompt            [String] The prompt
+    ## @param      completions       [Array] Array of tab
+    ##                               completions
+    ## @param      default_response  [String] The default
+    ##                               response returned if
+    ##                               :default_answer is
+    ##                               true
+    ##
+    ## @return     [String] User input string
+    ##
+    def read_line(prompt: 'Enter text', completions: [], default_response: '')
+      $stdin.reopen('/dev/tty')
+      return default_response if @default_answer
+
+      unless completions.empty?
+        completions.sort!
+        comp = proc { |s| completions.grep(/^#{Regexp.escape(s)}/) }
+        Readline.completion_append_character = ' '
+        Readline.completion_proc = comp
+      end
+
+      begin
+        Readline.readline("#{yellow(prompt).sub(/:?$/, ':')} #{reset}", true).strip
+      rescue Interrupt
+        raise UserCancelled
+      end
+    end
+
+    ##
+    ## Request multi-line input using Readline. Allows for
+    ## control sequences and tab completion
+    ##
+    ## @param      prompt            [String] The prompt
+    ## @param      completions       [Array] Array of tab
+    ##                               completions
+    ## @param      default_response  [String] The default
+    ##                               response returned if
+    ##                               :default_answer is
+    ##                               true
+    ##
+    ## @return     [String] Multi-line result, joined with newlines
+    ##
+    def read_lines(prompt: 'Enter text', completions: [], default_response: '')
+      $stdin.reopen('/dev/tty')
+      return default_response if @default_answer
+
+      completions.sort!
+      comp = proc { |s| completions.grep(/^#{Regexp.escape(s)}/) }
+      Readline.completion_append_character = ' '
+      Readline.completion_proc = comp
+      puts format(['%<promptcolor>s%<prompt>s %<textcolor>sEnter a blank line',
+        '(%<keycolor>sreturn twice%<textcolor>s)',
+        'to end editing and save,',
+        '%<keycolor>sCTRL-C%<textcolor>s to cancel%<reset>s'].join(' '),
+        { promptcolor: boldgreen, prompt: prompt.sub(/:?$/, ':'),
+          textcolor: yellow, keycolor: boldwhite, reset: reset })
+
+      res = []
+
+      begin
+        while (line = Readline.readline('> ', true))
+          break if line.strip.empty?
+
+          res << line.chomp
+        end
+      rescue Interrupt
+        return nil
+      end
+
+      res.join("\n").strip
+    end
+
+    ##
+    ## Request multi-line input
+    ##
+    ## @param      prompt            [String] The prompt
+    ## @param      default_response  [String] The default
+    ##                               response, returned if
+    ##                               :default_answer is
+    ##                               true
+    ##
+    ## @deprecated Use {#read_lines} instead
+    def request_lines(prompt: 'Enter text', default_response: '')
+      $stdin.reopen('/dev/tty')
+      return default_response if @default_answer
+
+      ask_note = []
+      reader = TTY::Reader.new(interrupt: -> { raise Errors::UserCancelled }, track_history: false)
+      puts "#{boldgreen(prompt.sub(/:?$/, ':'))} #{yellow('Hit return for a new line, ')}#{boldwhite('enter a blank line (')}#{boldyellow('return twice')}#{boldwhite(') to end editing')}"
+      loop do
+        res = reader.read_line(green('> '))
+        break if res.strip.empty?
+
+        ask_note.push(res)
+      end
+      ask_note.join("\n").strip
+    end
+  end
+end

data/lib/doing/prompt/prompt.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'choose'
+require_relative 'fzf'
+require_relative 'input'
+require_relative 'std'
+require_relative 'yn'
+
+module Doing
+  # Terminal Prompt methods
+  module Prompt
+    class << self
+      attr_writer :force_answer, :default_answer
+
+      include Color
+      include PromptSTD
+      include PromptInput
+      include PromptYN
+      include PromptFZF
+      include PromptChoose
+
+      ##
+      ## Value to return if prompt is skipped
+      ##
+      ## @return     Force answer value
+      ##
+      def force_answer
+        @force_answer ||= nil
+      end
+
+      ##
+      ## If true, always return the default answer without prompting
+      ##
+      ## @return     [Boolean] default answer
+      ##
+      def default_answer
+        @default_answer ||= false
+      end
+    end
+  end
+end

data/lib/doing/prompt/std.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Doing
+  # STDOUT and STDERR methods
+  module PromptSTD
+    ##
+    ## Clear the terminal screen
+    ##
+    def clear_screen(msg = nil)
+      puts "\e[H\e[2J" if $stdout.tty?
+      puts msg if msg.good?
+    end
+
+    ##
+    ## Redirect STDOUT and STDERR to /dev/null or file
+    ##
+    ## @param      file  [String] a file path to redirect to
+    ##
+    def silence_std(file = '/dev/null')
+      $stdout = File.new(file, 'w')
+      $stderr = File.new(file, 'w')
+    end
+
+    ##
+    ## Restore silenced STDOUT and STDERR
+    ##
+    def restore_std
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+  end
+end

data/lib/doing/prompt/yn.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Doing
+  # Request Yes/No answers on command line
+  module PromptYN
+    ##
+    ## Ask a yes or no question in the terminal
+    ##
+    ## @param      question          [String] The question
+    ##                               to ask
+    ## @param      default_response  [Boolean]   default
+    ##                               response if no input
+    ##
+    ## @return     [Boolean] yes or no
+    ##
+    def yn(question, default_response: false)
+      return @force_answer == :yes ? true : false unless @force_answer.nil?
+
+      $stdin.reopen('/dev/tty')
+
+      default = if default_response.is_a?(String)
+                  default_response =~ /y/i ? true : false
+                else
+                  default_response
+                end
+
+      # if global --default is set, answer default
+      return default if @default_answer
+
+      # if this isn't an interactive shell, answer default
+      return default unless $stdout.isatty
+
+      # clear the buffer
+      if ARGV&.length
+        ARGV.length.times do
+          ARGV.shift
+        end
+      end
+      system 'stty cbreak'
+
+      cw = white
+      cbw = boldwhite
+      cbg = boldgreen
+      cd = Color.default
+
+      options = unless default.nil?
+                  "#{cw}[#{default ? "#{cbg}Y#{cw}/#{cbw}n" : "#{cbw}y#{cw}/#{cbg}N"}#{cw}]#{cd}"
+                else
+                  "#{cw}[#{cbw}y#{cw}/#{cbw}n#{cw}]#{cd}"
+                end
+      $stdout.syswrite "#{cbw}#{question.sub(/\?$/, '')} #{options}#{cbw}?#{cd} "
+      res = $stdin.sysread 1
+      puts
+      system 'stty cooked'
+
+      res.chomp!
+      res.downcase!
+
+      return default if res.empty?
+
+      res =~ /y/i ? true : false
+    end
+  end
+end

data/lib/doing/section.rb

@@ -17,6 +17,10 @@ module Doing
                   end
     end
 
+    def equal?(other)
+      @title == other.title
+    end
+
     # Outputs section title
     def to_s
       @title

data/lib/doing/string/highlight.rb

@@ -2,7 +2,7 @@
 
 module Doing
   ## Tag and search highlighting
-  class ::String
+  module StringHighlight
     ## @param (see #highlight_tags)
     def highlight_tags!(color = 'yellow', last_color: nil)
       replace highlight_tags(color)

data/lib/doing/string/query.rb

@@ -2,7 +2,7 @@
 
 module Doing
   ## Handling of search and regex strings
-  class ::String
+  module StringQuery
     ##
     ## Determine whether case should be ignored for string
     ##

data/lib/doing/string/string.rb

@@ -1,8 +1,26 @@
 # frozen_string_literal: true
 
+require_relative 'highlight'
+require_relative 'query'
+require_relative 'tags'
+require_relative 'transform'
+require_relative 'truncate'
+require_relative 'url'
+
 class ::String
   include Doing::Color
+  include Doing::StringHighlight
+  include Doing::StringQuery
+  include Doing::StringTags
+  include Doing::StringTransform
+  include Doing::StringTruncate
+  include Doing::StringURL
 
+  ##
+  ## Force UTF-8 encoding if available
+  ##
+  ## @return     [String] UTF-8 encoded string
+  ##
   def utf8
     if String.method_defined? :force_encoding
       dup.force_encoding('utf-8')
@@ -11,10 +29,3 @@ class ::String
     end
   end
 end
-
-require_relative 'highlight'
-require_relative 'query'
-require_relative 'tags'
-require_relative 'transform'
-require_relative 'truncate'
-require_relative 'url'

data/lib/doing/string/tags.rb

@@ -2,7 +2,7 @@
 
 module Doing
   # Handling of @tags in strings
-  class ::String
+  module StringTags
     ##
     ## Add @ prefix to string if needed, maintains +/- prefix
     ##
@@ -21,6 +21,17 @@ module Doing
       strip.sub(/^([+-]*)@?/, '\1')
     end
 
+    ##
+    ## Split a string of tags, remove @ symbols, with or
+    ## without @ symbols, with or without parenthetical
+    ## values
+    ##
+    ## @return     [Array] array of tags without @ symbols
+    ##
+    def split_tags
+      gsub(/ *, */, ' ').scan(/(@?(?:\S+(?:\(.+\)))|@?(?:\S+))/).map(&:first).map(&:remove_at).sort.uniq
+    end
+
     ##
     ## Convert a list of tags to an array. Tags can be with
     ## or without @ symbols, separated by any character, and
@@ -29,7 +40,7 @@ module Doing
     ## @return     [Array] array of tags including @ symbols
     ##
     def to_tags
-      arr = gsub(/ *, */, ' ').scan(/(@?(?:\S+(?:\(.+\)))|@?(?:\S+))/).map(&:first).sort.uniq.map(&:add_at)
+      arr = split_tags.map(&:add_at)
       if block_given?
         yield arr
       else
@@ -38,7 +49,7 @@ module Doing
     end
 
     ##
-    ## @brief      Adds tags to a string
+    ## Adds tags to a string
     ##
     ## @param      tags    [String or Array] List of tags to add. @ symbol optional
     ## @param      remove  [Boolean] remove tags instead of adding

data/lib/doing/string/transform.rb

@@ -4,7 +4,7 @@ module Doing
   ##
   ## String helpers
   ##
-  class ::String
+  module StringTransform
     # Compress multiple spaces to single space
     def compress
       gsub(/ +/, ' ').strip
@@ -164,5 +164,11 @@ module Doing
         end
       end
     end
+
+    def titlecase
+      tr('_', ' ').
+      gsub(/\s+/, ' ').
+      gsub(/\b\w/){ $`[-1,1] == "'" ? $& : $&.upcase }
+    end
   end
 end

data/lib/doing/string/truncate.rb

@@ -4,7 +4,7 @@ module Doing
   ##
   ## String truncation
   ##
-  class ::String
+  module StringTruncate
     ##
     ## Truncate to nearest word
     ##

data/lib/doing/string/url.rb

@@ -4,7 +4,7 @@ module Doing
   ##
   ## URL linking and formatting
   ##
-  class ::String
+  module StringURL
     ##
     ## Turn raw urls into HTML links
     ##

data/lib/doing/time.rb

@@ -3,18 +3,31 @@ module Doing
   ## Date helpers
   ##
   class ::Time
+    # Format time as a relative date. Dates from today get
+    # just a time, from the last week get a time and day,
+    # from the last year get a month/day/time, and older
+    # entries get month/day/year/time
+    #
+    # @return     [String] formatted date
+    #
     def relative_date
       if self > Date.today.to_time
         strftime('%_I:%M%P')
       elsif self > (Date.today - 6).to_time
         strftime('%a %_I:%M%P')
-      elsif self.year == Date.today.year || (self.year + 1 == Date.today.year && self.month > Date.today.month)
+      elsif year == Date.today.year || (year + 1 == Date.today.year && month > Date.today.month)
         strftime('%m/%d %_I:%M%P')
       else
         strftime('%m/%d/%y %_I:%M%P')
       end
     end
 
+    ##
+    ## Format seconds as a natural language string
+    ##
+    ## @param      seconds  [Integer] number of seconds
+    ##
+    ## @return [String] Date formatted as "X days, X hours, X minutes, X seconds"
     def humanize(seconds)
       s = seconds
       m = (s / 60).floor
@@ -32,6 +45,11 @@ module Doing
       output.join(', ')
     end
 
+    ##
+    ## Format date as "X hours ago"
+    ##
+    ## @return     [String] Formatted date
+    ##
     def time_ago
       if self > Date.today.to_time
         output = humanize(Time.now - self)