doing 2.0.22 → 2.1.0pre

data/lib/doing/note.rb

@@ -5,12 +5,27 @@ module Doing
   ## This class describes an item note.
   ##
   class Note < Array
+
+    ##
+    ## Initializes a new note
+    ##
+    ## @param      note  [Array] Initial note, can be string
+    ##                   or array
+    ##
     def initialize(note = [])
       super()
 
       add(note) if note
     end
 
+    ##
+    ## Add note contents, optionally replacing existing note
+    ##
+    ## @param      note     [Array] The note to add, can be
+    ##                      string or array (Note)
+    ## @param      replace  [Boolean] replace existing
+    ##                      content
+    ##
     def add(note, replace: false)
       clear if replace
       if note.is_a?(String)
@@ -20,11 +35,22 @@ module Doing
       end
     end
 
+    ##
+    ## Append an array of strings to note
+    ##
+    ## @param      lines  [Array] Array of strings
+    ##
     def append(lines)
       concat(lines)
       replace compress
     end
 
+    ##
+    ## Append a string to the note content
+    ##
+    ## @param      input  [String] The input string,
+    ##                    newlines will be split
+    ##
     def append_string(input)
       concat(input.split(/\n/).map(&:strip))
       replace compress
@@ -34,6 +60,11 @@ module Doing
       replace compress
     end
 
+    ##
+    ## Remove blank lines and comment lines (#)
+    ##
+    ## @return     [Array] compressed array
+    ##
     def compress
       delete_if { |l| l =~ /^\s*$/ || l =~ /^#/ }
     end
@@ -42,14 +73,35 @@ module Doing
       replace strip_lines
     end
 
+    ##
+    ## Remove leading/trailing whitespace for
+    ##             every line of note
+    ##
+    ## @return     [Array] Stripped note
+    ##
     def strip_lines
       map(&:strip)
     end
 
+    ##
+    ## Note as multi-line string
     def to_s
-      compress.strip_lines.join("\n")
+      compress.strip_lines.map { |l| "\t\t#{l}" }.join("\n")
+    end
+
+    # @private
+    def inspect
+      "<Doing::Note - characters:#{compress.strip_lines.join(' ').length} lines:#{count}>"
     end
 
+    ##
+    ## Test if a note is equal (compare string
+    ##             representations)
+    ##
+    ## @param      other  [Note] The other Note
+    ##
+    ## @return     [Boolean] true if equal
+    ##
     def equal?(other)
       return false unless other.is_a?(Note)
 

data/lib/doing/pager.rb

@@ -1,23 +1,36 @@
 # frozen_string_literal: true
+require 'pathname'
 
 module Doing
   # 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
+        Doing.logger.debug('Pager:', "Using #{pager}")
+
         read_io, write_io = IO.pipe
 
         input = $stdin
@@ -30,10 +43,8 @@ module Doing
           # Wait until we have input before we start the pager
           IO.select [input]
 
-          pager = which_pager
-          Doing.logger.debug('Pager:', "Using #{pager}")
           begin
-            exec(pager.join(' '))
+            exec(pager)
           rescue SystemCallError => e
             raise Errors::DoingStandardError, "Pager error, #{e}"
           end
@@ -51,44 +62,44 @@ module Doing
         status.success?
       end
 
-      def which_pager
-        pagers = [ENV['GIT_PAGER'], ENV['PAGER']]
-
-        if Util.exec_available('git')
-          git_pager = `git config --get-all core.pager || true`.split.first
-          git_pager && pagers.push(git_pager)
-        end
-
-        pagers.concat(%w[bat less more pager])
-
-        pagers.select! do |f|
-          if f
-            if f.strip =~ /[ |]/
-              f
-            elsif f == 'most'
-              Doing.logger.warn('most not allowed as pager')
-              false
-            else
-              system "which #{f}", out: File::NULL, err: File::NULL
-            end
-          else
-            false
+      private
+
+      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
+
+      def git_pager
+        command_exist?("git") ? `git config --get-all core.pager` : nil
+      end
 
-        pg = pagers.first
-        args = case pg
-               when /^more$/
-                 ' -r'
-               when /^less$/
-                 ' -Xr'
-               when /^bat$/
-                 ' -p --pager="less -Xr"'
-               else
-                 ''
-               end
-
-        [pg, args]
+      def pagers
+        [ENV['GIT_PAGER'], ENV['PAGER'], git_pager,
+         'bat -p --pager="less -Xr"', 'less -Xr', 'more -r'].compact
+      end
+
+      def find_executable(*commands)
+        execs = commands.empty? ? pagers : commands
+        execs
+          .compact.map(&:strip).reject(&:empty?).uniq
+          .find { |cmd| command_exist?(cmd.split.first) }
+      end
+
+      def exec_available?(*commands)
+        !find_executable(*commands).nil?
+      end
+
+      def which_pager
+        @which_pager ||= find_executable(*pagers)
       end
     end
   end

data/lib/doing/plugins/export/markdown_export.rb

@@ -41,11 +41,11 @@ module Doing
       all_items = []
       items.each do |i|
         if String.method_defined? :force_encoding
-          title = i.title.force_encoding('utf-8').link_urls({format: :markdown})
-          note = i.note.map { |line| line.force_encoding('utf-8').strip.link_urls({format: :markdown}) } if i.note
+          title = i.title.force_encoding('utf-8').link_urls(format: :markdown)
+          note = i.note.map { |line| line.force_encoding('utf-8').strip.link_urls(format: :markdown) } if i.note
         else
-          title = i.title.link_urls({format: :markdown})
-          note = i.note.map { |line| line.strip.link_urls({format: :markdown}) } if i.note
+          title = i.title.link_urls(format: :markdown)
+          note = i.note.map { |line| line.strip.link_urls(format: :markdown) } if i.note
         end
 
         title = "#{title} @project(#{i.section})" unless variables[:is_single]

data/lib/doing/plugins/export/template_export.rb

@@ -23,10 +23,10 @@ module Doing
       out = ''
       items.each do |item|
         if opt[:highlight] && item.title =~ /@#{wwid.config['marker_tag']}\b/i
-          flag = Doing::Color.send(wwid.config['marker_color'])
+          # flag = Doing::Color.send(wwid.config['marker_color'])
           reset = Doing::Color.default
         else
-          flag = ''
+          # flag = ''
           reset = ''
         end
 

data/lib/doing/plugins/import/calendar_import.rb

@@ -27,7 +27,7 @@ module Doing
       options[:no_overlap] ||= false
       options[:autotag] ||= wwid.auto_tag
 
-      wwid.add_section(section) unless wwid.content.key?(section)
+      wwid.content.add_section(section) unless wwid.content.section?(section)
 
       tags = options[:tag] ? options[:tag].split(/[ ,]+/).map { |t| t.sub(/^@?/, '') } : []
       prefix = options[:prefix] || '[Calendar.app]'
@@ -59,7 +59,7 @@ module Doing
         title += " @done(#{end_time.strftime('%Y-%m-%d %H:%M')})"
         title.gsub!(/ +/, ' ')
         title.strip!
-        new_entry = { 'title' => title, 'date' => start_time, 'section' => section }
+        new_entry = Item.new(start_time, title, section)
         new_entry.note = entry['notes'].split(/\n/).map(&:chomp) if entry.key?('notes')
         new_items.push(new_entry)
       end
@@ -69,11 +69,11 @@ module Doing
       filtered = total - new_items.count
       Doing.logger.debug('Skipped:' , %(#{filtered} items that didn't match filter criteria)) if filtered.positive?
 
-      new_items = wwid.dedup(new_items, options[:no_overlap])
+      new_items = wwid.dedup(new_items, no_overlap: options[:no_overlap])
       dups = filtered - new_items.count
       Doing.logger.info(%(Skipped #{dups} items with overlapping times)) if dups.positive?
 
-      wwid.content[section][:items].concat(new_items)
+      wwid.content.concat(new_items)
       Doing.logger.info(%(Imported #{new_items.count} items to #{section}))
     end
 

data/lib/doing/plugins/import/doing_import.rb

@@ -34,9 +34,7 @@ module Doing
       tags = options[:tag] ? options[:tag].split(/[ ,]+/).map { |t| t.sub(/^@?/, '') } : []
       prefix = options[:prefix] || ''
 
-      @old_items = []
-
-      wwid.content.each { |_, v| @old_items.concat(v[:items]) }
+      @old_items = wwid.content.dup
 
       new_items = read_doing_file(path)
 
@@ -46,7 +44,7 @@ module Doing
       new_items = wwid.filter_items(new_items, opt: options)
 
       skipped = total - new_items.count
-      Doing.logger.debug('Skipped:' , %(#{skipped} items that didn't match filter criteria)) if skipped.positive?
+      Doing.logger.debug('Skipped:', %(#{skipped} items that didn't match filter criteria)) if skipped.positive?
 
       imported = []
 
@@ -76,13 +74,13 @@ module Doing
       dups = new_items.count - imported.count
       Doing.logger.info('Skipped:', %(#{dups} duplicate items)) if dups.positive?
 
-      imported = wwid.dedup(imported, !options[:overlap])
+      imported = wwid.dedup(imported, no_overlap: !options[:overlap])
       overlaps = new_items.count - imported.count - dups
       Doing.logger.debug('Skipped:', "#{overlaps} items with overlapping times") if overlaps.positive?
 
       imported.each do |item|
-        wwid.add_section(item.section) unless wwid.content.key?(item.section)
-        wwid.content[item.section][:items].push(item)
+        wwid.content.add_section(item.section) unless wwid.content.section?(item.section)
+        wwid.content.push(item)
       end
 
       Doing.logger.info('Imported:', "#{imported.count} items")

data/lib/doing/plugins/import/timing_import.rb

@@ -27,7 +27,7 @@ module Doing
       section = options[:section] || wwid.config['current_section']
       options[:no_overlap] ||= false
       options[:autotag] ||= wwid.auto_tag
-      wwid.add_section(section) unless wwid.content.key?(section)
+      wwid.content.add_section(section) unless wwid.content.section?(section)
 
       add_tags = options[:tag] ? options[:tag].split(/[ ,]+/).map { |t| t.sub(/^@?/, '') } : []
       prefix = options[:prefix] || '[Timing.app]'
@@ -73,11 +73,11 @@ module Doing
       filtered = skipped - new_items.count
       Doing.logger.debug('Skipped:' , %(#{filtered} items that didn't match filter criteria)) if filtered.positive?
 
-      new_items = wwid.dedup(new_items, options[:no_overlap])
+      new_items = wwid.dedup(new_items, no_overlap: options[:no_overlap])
       dups = filtered - new_items.count
       Doing.logger.debug('Skipped:' , %(#{dups} items with overlapping times)) if dups.positive?
 
-      wwid.content[section][:items].concat(new_items)
+      wwid.content.concat(new_items)
       Doing.logger.info('Imported:', %(#{new_items.count} items to #{section}))
     end
 

data/lib/doing/prompt.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module Doing
+  # Terminal Prompt methods
+  module Prompt
+    class << self
+      attr_writer :force_answer, :default_answer
+
+      include Color
+
+      def force_answer
+        @force_answer ||= nil
+      end
+
+      def default_answer
+        @default_answer ||= false
+      end
+
+      ##
+      ## Ask a yes or no question in the terminal
+      ##
+      ## @param      question          [String] The question
+      ##                               to ask
+      ## @param      default_response  (Bool)   default
+      ##                               response if no input
+      ##
+      ## @return     (Bool) yes or no
+      ##
+      def yn(question, default_response: false)
+        unless @force_answer.nil?
+          return @force_answer
+        end
+
+        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
+
+      def fzf
+        @fzf ||= install_fzf
+      end
+
+      def install_fzf
+        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, 'Compiling and installing fzf -- this will only happen once')
+        Doing.logger.log_now(:warn, 'fzf is copyright Junegunn Choi, MIT License <https://github.com/junegunn/fzf/blob/master/LICENSE>')
+
+        system("'#{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)
+          Doing.logger.log_now(:warn, 'Error installing, trying again as root')
+          system("sudo '#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null")
+        end
+        raise RuntimeError.new('Error installing fzf, please report at https://github.com/ttscoff/doing/issues') unless File.exist?(fzf_bin)
+
+        Doing.logger.info("fzf installed to #{fzf}")
+        Doing.logger.adjust_verbosity({ log_level: prev_level })
+        fzf_bin
+      end
+
+      ##
+      ## Generate a menu of options and allow user selection
+      ##
+      ## @return     [String] The selected option
+      ##
+      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
+        fzf_args << %(--prompt "#{prompt}")
+        fzf_args << '--multi' if multiple
+        header = "esc: cancel,#{multiple ? ' tab: multi-select, ctrl-a: select all,' : ''} return: confirm"
+        fzf_args << %(--header "#{header}")
+        options.sort! if sorted
+        res = `echo #{Shellwords.escape(options.join("\n"))}|#{fzf} #{fzf_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              [Hash] options
+      ## @param      include_section  [Boolean] include section
+      ##
+      ## @option opt [String] :header
+      ## @option opt [String] :prompt
+      ## @option opt [String] :query
+      ## @option opt [Boolean] :show_if_single
+      ## @option opt [Boolean] :menu
+      ## @option opt [Boolean] :sort
+      ## @option opt [Boolean] :multiple
+      ## @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('%13s', item.date.relative_date),
+            ' | ',
+            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)
+        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
+end

data/lib/doing/section.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Doing
+  # Section Object
+  class Section
+    attr_accessor :original, :title
+
+    def initialize(title, original: nil)
+      super()
+
+      @title = title
+
+      @original = if original.nil?
+                    "#{title}:"
+                  else
+                    original =~ /:(\s+@\S+(\(.*?\))?)*$/ ? original : "#{original}:"
+                  end
+    end
+
+    # Outputs section title
+    def to_s
+      @title
+    end
+
+    # @private
+    def inspect
+      %(#<Doing::Section @title="#{@title}" @original="#{@original}">)
+    end
+  end
+end