doing 2.1.19 → 2.1.24

data/lib/doing/changelog/changes.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Doing
+  # A collection of Changes
+  class Changes
+    attr_reader :changes
+
+    def initialize(lookup: nil, search: nil)
+      changelog = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'CHANGELOG.md'))
+      raise 'Error locating changelog' unless File.exist?(changelog)
+
+      @content = IO.read(changelog)
+      parse_changes(lookup, search)
+    end
+
+    def latest
+      @changes[0].to_s.force_encoding('utf-8')
+    end
+
+    def to_s
+      @changes.map(&:to_s).join("\n\n").force_encoding('utf-8')
+    end
+
+    private
+
+    def parse_changes(lookup, search)
+      change_rx = /(?<=\n|\A)### (\d+\.\d+\.\d+(?:\w+)?)(.*?)(?=\n### |\Z)/m
+      @changes = @content.scan(change_rx).each_with_object([]) do |m, a|
+        next if m[0].nil? || m[1].nil?
+
+        a << Change.new(m[0], m[1].strip)
+      end
+
+      lookup(lookup) unless lookup.nil?
+      search(search) unless search.nil?
+    end
+
+    def lookup(lookup_version)
+      range = []
+
+      if lookup_version =~ /([\d.]+) *-+ *([\d.]+)/
+        m = Regexp.last_match
+        lookup("> #{m[1]}")
+        lookup("< #{m[2]}")
+      elsif lookup_version.scan(/[<>]/).count > 1
+        params = lookup_version.scan(/[<>] [\d.]+/)
+        params.each { |query| lookup(query) }
+      else
+        comp = case lookup_version
+               when /(<|prior|before|older)/
+                 :older
+               when />|since|after|newer/
+                 :newer
+               else
+                 :equal
+               end
+        version = Version.new(lookup_version)
+
+        @changes.select! do |change|
+          change.version.compare(version, comp)
+        end
+      end
+    end
+
+    def search(query)
+      @changes.map do |c|
+        c.entries = c.search_entries(query)
+      end
+
+      @changes.delete_if { |c| c.nil? || c.entries.nil? }
+    end
+  end
+end

data/lib/doing/changelog/entry.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Doing
+  # An individual changelog item
+  class Entry
+    attr_reader :type, :string
+
+    def initialize(string, type)
+      @string = string
+      @type = type
+    end
+
+    def clean(string)
+      string.gsub(/\|/, '\|')
+    end
+
+    def to_s
+      "- #{clean(@string)}"
+    end
+  end
+end

data/lib/doing/changelog/version.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Doing
+  # Semantic versioning
+  class Version
+    attr_reader :maj, :min, :patch
+
+    def initialize(string)
+      @maj, @min, @patch = version_to_a(string)
+    end
+
+    def version_to_a(string)
+      raise 'Version not a string' unless string.is_a?(String)
+
+      v = string.match(/(?<maj>\d+)(?:\.(?<min>[\d*?]+))?(?:\.(?<patch>[\d*?]+))?/)
+
+      raise 'Error parsing semantic version string' if v.nil?
+
+      maj = v['maj'].to_i
+      min = case v['min']
+            when /[*?]/
+              v['min'].sub(/(\d+)?[^\d]/, '\1\d+')
+            when /^[0-9]+$/
+              v['min'].to_i
+            end
+      pat = case v['patch']
+            when /[*?]/
+              v['patch'].sub(/(\d+)?[^\d]/, '\1\d+')
+            when /^[0-9]+$/
+              v['patch'].to_i
+            end
+      [maj, min, pat]
+    end
+
+    def wild?(val)
+      val.is_a?(String)
+    end
+
+
+    def compare(other, comp)
+      case comp
+      when :older
+        if @maj <= other.maj
+          if @maj < other.maj
+            true
+          elsif @maj == other.maj && (other.min.nil? || @min < other.min)
+            true
+          elsif @maj == other.maj && @min == other.min
+            other.patch.nil? ? false : @patch < other.patch
+          else
+            false
+          end
+        else
+          false
+        end
+      when :newer
+        if @maj >= other.maj
+          if @maj > other.maj
+            true
+          elsif @maj == other.maj && (other.min.nil? || @min > other.min)
+            true
+          elsif @maj == other.maj && @min == other.min
+            other.patch.nil? || @patch >= other.patch
+          else
+            false
+          end
+        else
+          false
+        end
+      when :equal
+        if @maj == other.maj
+          if other.min.nil?
+            true
+          elsif wild?(other.min)
+            @min.to_s =~ /^#{other.min}/ ? true : false
+          else
+            if @min == other.min
+              if other.patch.nil?
+                true
+              elsif wild?(other.patch)
+                @patch.to_s =~ /^#{other.patch}/ ? true : false
+              else
+                @patch == other.patch
+              end
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+
+    def to_s
+      "#{@maj}.#{@min || 0}.#{@patch || 0}"
+    end
+  end
+end

data/lib/doing/changelog.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'changelog/version'
+require_relative 'changelog/entry'
+require_relative 'changelog/change'
+require_relative 'changelog/changes'

data/lib/doing/completion/fish_completion.rb

@@ -31,28 +31,89 @@ module Doing
             and return 0
           end
 
+          function __fish_doing_cache_timer_expired
+            set -l timer __fish_doing_cache_timer_$argv[1]
+            if not set -q $timer
+              set -g $timer (date '+%s')
+            end
+
+            if test (math (date '+%s') - $$timer) -gt $argv[2]
+              set -g $timer (date '+%s')
+              return 1
+            end
+
+            return 0
+          end
+
+          function __fish_doing_subcommands
+            if not set -q __fish_doing_subcommands_cache
+              or __fish_doing_cache_timer_expired subcommands 86400
+              set -g -a __fish_doing_subcommands_cache (doing help -c)
+            end
+            printf '%s\n' $__fish_doing_subcommands_cache
+          end
+
           function __fish_doing_complete_sections
-            doing sections -c
+            if not set -q __fish_doing_sections_cache
+              or __fish_doing_cache_timer_expired sections 3600
+              set -g -a __fish_doing_sections_cache (doing sections -c)
+            end
+            printf '%s\n' $__fish_doing_sections_cache
+            __fish_doing_complete_show_tag
           end
 
           function __fish_doing_complete_views
-            doing views -c
+            if not set -q __fish_doing_views_cache
+              or __fish_doing_cache_timer_expired views 3600
+              set -g -a __fish_doing_views_cache (doing views -c)
+            end
+            printf '%s\n' $__fish_doing_views_cache
           end
 
-          function __fish_doing_subcommands
-            doing help -c
+          function __fish_doing_export_plugin
+            if not set -q __fish_doing_export_plugin_cache
+              or __fish_doing_cache_timer_expired export_plugins 3600
+              set -g -a __fish_doing_export_plugin_cache (doing plugins --type export -c)
+            end
+            printf '%s\n' $__fish_doing_export_plugin_cache
+          end
+
+          function __fish_doing_import_plugin
+            if not set -q __fish_doing_import_plugin_cache
+              or __fish_doing_cache_timer_expired import_plugins 3600
+              set -g -a __fish_doing_import_plugin_cache (doing plugins --type import -c)
+            end
+            printf '%s\n' $__fish_doing_import_plugin_cache
+          end
+
+          function __fish_doing_complete_template
+            if not set -q __fish_doing_template_cache
+              or __fish_doing_cache_timer_expired template 3600
+              set -g -a __fish_doing_template_cache (doing template -c)
+            end
+            printf '%s\n' $__fish_doing_template_cache
           end
 
-          function __fish_doing_export_plugins
-            doing plugins --type export -c
+          function __fish_doing_complete_tag
+            if not set -q __fish_doing_tag_cache
+              or __fish_doing_cache_timer_expired tags 60
+              set -g -a __fish_doing_tag_cache (doing tags)
+            end
+            printf '%s\n' $__fish_doing_tag_cache
           end
 
-          function __fish_doing_import_plugins
-            doing plugins --type import -c
+          function __fish_doing_complete_show_tag
+            if not set -q __fish_doing_tag_cache
+              or __fish_doing_cache_timer_expired tags 60
+              set -g -a __fish_doing_tag_cache (doing tags)
+            end
+            printf '@%s\n' $__fish_doing_tag_cache
           end
 
-          function __fish_doing_complete_templates
-            doing template -c
+          function __fish_doing_complete_args
+            for cmd in (doing commands_accepting -c $argv[1])
+              complete -x -c doing -l $argv[1] -n "__fish_doing_using_command $cmd" -a "(__fish_doing_complete_$argv[1])"
+            end
           end
 
           complete -c doing -f
@@ -62,8 +123,17 @@ module Doing
           complete -f -c doing -n '__fish_doing_using_command view' -a '(__fish_doing_complete_views)'
           complete -f -c doing -n '__fish_doing_using_command template' -a '(__fish_doing_complete_templates)'
           complete -f -c doing -s t -l type -x -n '__fish_doing_using_command import' -a '(__fish_doing_import_plugins)'
+          complete -f -c doing -n '__fish_doing_using_command help' -a '(__fish_doing_subcommands)'
+
+          # complete -xc doing -n '__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from (doing help -c)' -a "(doing help -c)"
+
+          function __fish_doing_complete_args
+            for cmd in (doing commands_accepting -c $argv[1])
+              complete -x -c doing -l $argv[1] -n "__fish_doing_using_command $cmd" -a "(__fish_doing_complete_$argv[1])"
+            end
+          end
 
-          complete -xc doing -n '__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from (doing help -c)' -a "(doing help -c)"
+          __fish_doing_complete_args tag
         EOFUNCTIONS
       end
 
@@ -161,7 +231,7 @@ module Doing
         end
 
         unless need_export.empty?
-          out << "complete -f -c doing -s o -l output -x -n '__fish_doing_using_command #{need_export.join(' ')}' -a '(__fish_doing_export_plugins)'"
+          out << "complete -f -c doing -s o -l output -x -n '__fish_doing_using_command #{need_export.join(' ')}' -a '(__fish_doing_export_plugin)'"
         end
 
         unless need_bool.empty?

data/lib/doing/configuration.rb

@@ -30,6 +30,7 @@ module Doing
         'command_path' => File.join(Util.user_home, '.config', 'doing', 'commands')
       },
       'doing_file' => '~/.local/share/doing/what_was_i_doing.md',
+      'doing_file_sort' => 'desc',
       'backup_dir' => '~/.local/share/doing/doing_backup',
       'history_size' => 15,
       'current_section' => 'Currently',
@@ -159,7 +160,7 @@ module Doing
     def choose_config(create: false)
       return @config_file if @force_answer
 
-      if @additional_configs.count.positive? || create
+      if @additional_configs&.count&.positive? || create
         choices = [@config_file].concat(@additional_configs)
         choices.push('Create a new .doingrc in the current directory') if create && !File.exist?('.doingrc')
         res = Doing::Prompt.choose_from(choices.uniq.sort.reverse,
@@ -189,7 +190,7 @@ module Doing
     ##                      matched, first match wins)
     ## @return     [Array] ordered array of resolved keys
     ##
-    def resolve_key_path(keypath, create: false)
+    def resolve_key_path(keypath, create: false, distance: 2)
       cfg = @settings
       real_path = []
       unless keypath =~ /^[.*]?$/
@@ -197,16 +198,24 @@ module Doing
         while paths.length.positive? && !cfg.nil?
           path = paths.shift
           new_cfg = nil
-          cfg.each do |key, val|
-            next unless key =~ path.to_rx(distance: 4)
 
-            real_path << key
-            new_cfg = val
-            break
+          if cfg.is_a?(Hash)
+            matches = cfg.select { |key, val| key =~ path.to_rx(distance: distance) }
+            if matches.count.positive?
+              shortest = matches.keys.group_by(&:length).min.last[0]
+              real_path << shortest
+              new_cfg = matches[shortest]
+            end
+          else
+            new_cfg = cfg
           end
 
           if new_cfg.nil?
-            return nil unless create
+            if distance < 5 && !create
+              return resolve_key_path(keypath, create: false, distance: distance + 1)
+            else
+              return nil unless create
+            end
 
             resolved = real_path.count.positive? ? "Resolved #{real_path.join('->')}, but " : ''
             Doing.logger.log_now(:warn, "#{resolved}#{path} is unknown")

data/lib/doing/hash.rb

@@ -6,14 +6,32 @@ module Doing
     ##
     ## Freeze all values in a hash
     ##
-    ## @return     { description_of_the_return_value }
+    ## @return     Hash with all values frozen
     ##
     def deep_freeze
-      map { |k, v| v.is_a?(Hash) ? v.deep_freeze : v.freeze }.freeze
+      chilled = {}
+      each do |k, v|
+        chilled[k] = v.is_a?(Hash) ? v.deep_freeze : v.freeze
+      end
+
+      chilled.freeze
     end
 
     def deep_freeze!
-      replace deep_freeze
+      replace deep_thaw.deep_freeze
+    end
+
+    def deep_thaw
+      chilled = {}
+      each do |k, v|
+        chilled[k] = v.is_a?(Hash) ? v.deep_thaw : v.dup
+      end
+
+      chilled.dup
+    end
+
+    def deep_thaw!
+      replace deep_thaw
     end
 
     # Turn all keys into string
@@ -30,15 +48,16 @@ module Doing
 
     # Set a nested hash value using an array
     #
-    # @example `{}.deep_set(['one', 'two'], 'value')`
-    # @example `=> { 'one' => { 'two' => 'value' } }
+    # @example
+    #   {}.deep_set(['one', 'two'], 'value')
+    #   # => { 'one' => { 'two' => 'value' } }
     #
     # @param      path   [Array] key path
     # @param      value  The value
     #
     def deep_set(path, value)
       if path.count == 1
-        if value
+        unless value.nil? || value =~ /^ *$/
           self[path[0]] = value
         else
           delete(path[0])

data/lib/doing/help_monkey_patch.rb

@@ -0,0 +1,31 @@
+# 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)
+        Doing::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]
+          Doing::Pager.page HelpModules::GlobalHelpFormat.new(@app,@sorter,@text_wrapping_class).format
+        else
+          name = arguments.shift
+          command = command_finder.find_command(name)
+          unless command.nil?
+            Doing::Pager.page HelpModules::CommandHelpFormat.new(
+              command,
+              @app,
+              @sorter,
+              @synopsis_formatter_class,
+              @text_wrapping_class).format
+          end
+        end
+      end
+    end
+  end
+end

data/lib/doing/hooks.rb

@@ -23,7 +23,11 @@ module Doing
 
     # register hook(s) to be called later, public API
     def self.register(event, priority: DEFAULT_PRIORITY, &block)
-      register_one(event, priority_value(priority), &block)
+      if event.is_a?(Array)
+        event.each { |ev| register_one(ev, priority_value(priority), &block) }
+      else
+        register_one(event, priority_value(priority), &block)
+      end
     end
 
     # Ensure the priority is a Fixnum

data/lib/doing/item.rb

@@ -125,11 +125,11 @@ module Doing
       return true if same_time?(item_b)
 
       start_a = date
-      interval = interval
-      end_a = interval ? start_a + interval.to_i : start_a
+      a_interval = interval
+      end_a = a_interval ? start_a + a_interval.to_i : start_a
       start_b = item_b.date
-      interval = item_b.interval
-      end_b = interval ? start_b + interval.to_i : start_b
+      b_interval = item_b.interval
+      end_b = b_interval ? start_b + b_interval.to_i : start_b
       (start_a >= start_b && start_a <= end_b) || (end_a >= start_b && end_a <= end_b) || (start_a < start_b && end_a > end_b)
     end
 
@@ -216,8 +216,8 @@ module Doing
     ##
     def tags?(tags, bool = :and, negate: false)
       if bool == :pattern
-        tags = tags.join(' ') if tags.is_a?(Array)
-        matches = tag_pattern?(tags.gsub(/ *, */, ' '))
+        tags = tags.to_tags.tags_to_array.join(' ')
+        matches = tag_pattern?(tags)
 
         return negate ? !matches : matches
       end
@@ -283,7 +283,7 @@ module Doing
         new_title = @title.gsub(rx) { |m| yellow(m) }
         new_note.add(@note.to_s.gsub(rx) { |m| yellow(m) })
       else
-        query = to_phrase_query(search.strip)
+        query = search.strip.to_phrase_query
 
         if query[:must].nil? && query[:must_not].nil?
           query[:must] = query[:should]
@@ -319,7 +319,7 @@ module Doing
       if search.is_rx? || matching == :fuzzy
         matches = @title + @note.to_s =~ search.to_rx(distance: distance, case_type: case_type)
       else
-        query = to_phrase_query(search.strip)
+        query = search.strip.to_phrase_query
 
         if query[:must].nil? && query[:must_not].nil?
           query[:must] = query[:should]
@@ -612,29 +612,14 @@ module Doing
       end
     end
 
-    def to_query(query)
-      parser = BooleanTermParser::QueryParser.new
-      transformer = BooleanTermParser::QueryTransformer.new
-      parse_tree = parser.parse(query)
-      transformer.apply(parse_tree).to_elasticsearch
-    end
-
-    def to_phrase_query(query)
-      parser = PhraseParser::QueryParser.new
-      transformer = PhraseParser::QueryTransformer.new
-      parse_tree = parser.parse(query)
-      transformer.apply(parse_tree).to_elasticsearch
-    end
-
     def tag_pattern?(tags)
-      query = to_query(tags)
+      query = tags.to_query
 
       no_tags?(query[:must_not]) && all_tags?(query[:must]) && any_tags?(query[:should])
     end
 
     def split_tags(tags)
-      tags = tags.split(/ *, */) if tags.is_a? String
-      tags.map { |t| t.strip.add_at }
+      tags.to_tags.tags_to_array
     end
   end
 end

data/lib/doing/items.rb

@@ -131,7 +131,9 @@ module Doing
       out = []
       @sections.each do |section|
         out.push(section.original)
-        in_section(section.title).each { |item| out.push(item.to_s)}
+        items = in_section(section.title).sort_by { |i| i.date }
+        items.reverse! if Doing.config.settings['doing_file_sort'].normalize_order == 'desc'
+        items.each { |item| out.push(item.to_s)}
       end
 
       out.join("\n")

data/lib/doing/log_adapter.rb

@@ -356,7 +356,7 @@ module Doing
         next if data[:count].zero?
 
         count = data[:count]
-        tags = data[:tag] ? data[:tag].uniq.map { |t| "@#{t}".cyan }.join(', ') : 'tags'
+        tags = data[:tag] ? data[:tag].uniq.map { |t| t.add_at.cyan }.join(', ') : 'tags'
         topic, m = format_counter(key, data)
         message = m.dup
         message.sub!(/%count/, count.to_s)

data/lib/doing/pager.rb

@@ -54,8 +54,8 @@ module Doing
           read_io.close
           write_io.write(text)
           write_io.close
-        rescue SystemCallError => e
-          raise Errors::DoingStandardError, "Pager error, #{e}"
+        rescue SystemCallError # => e
+          # raise Errors::DoingStandardError, "Pager error, #{e}"
         end
 
         _, status = Process.waitpid2(pid)

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

@@ -75,7 +75,7 @@ module Doing
           note = i.note.map { |line| line.strip.link_urls(format: :markdown) } if i.note
         end
 
-        title = "#{title} @project(#{i.section})" unless variables[:is_single]
+        title = "#{title} @section(#{i.section})" unless variables[:is_single]
 
         tags.concat(i.tag_array).sort!.uniq!
         flagged = day_flagged = true if i.tags?(wwid.config['marker_tag'])

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

@@ -48,7 +48,7 @@ module Doing
           note = i.note.map { |line| line.strip.link_urls(format: :markdown) } if i.note
         end
 
-        title = "#{title} @project(#{i.section})" unless variables[:is_single]
+        title = "#{title} @section(#{i.section})" unless variables[:is_single]
 
         interval = wwid.get_interval(i, record: true) if i.title =~ /@done\((\d{4}-\d\d-\d\d \d\d:\d\d.*?)\)/ && opt[:times]
         interval ||= false

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

@@ -49,6 +49,8 @@ module Doing
           note = []
         end
 
+        placeholders['tags'] = item.tags
+
         placeholders['date'] = item.date.strftime(opt[:format])
 
         interval = wwid.get_interval(item, record: true, formatted: false) if opt[:times]
@@ -56,8 +58,10 @@ module Doing
           interval = case opt[:interval_format].to_sym
                      when :human
                        interval.time_string(format: :hm)
-                     else
+                     when :text
                        interval.time_string(format: :clock)
+                     else
+                       interval.time_string(format: opt[:interval_format].to_sym)
                      end
         end
 
@@ -69,8 +73,10 @@ module Doing
           duration = case opt[:interval_format].to_sym
                      when :human
                        duration.time_string(format: :hm)
-                     else
+                     when :text
                        duration.time_string(format: :clock)
+                     else
+                       duration.time_string(format: opt[:interval_format].to_sym)
                      end
         end
         duration ||= ''
@@ -119,7 +125,7 @@ module Doing
 
         output.gsub!(/\\%/, '%')
 
-        output.highlight_search!(opt[:search]) if opt[:search] && !opt[:not] && opt[:hilite]
+        output.highlight_search!(opt[:search]) if opt[:template] =~ /^temp/ && opt[:search] && !opt[:not] && opt[:hilite]
 
         out += "#{output}\n"
       end

data/lib/doing/prompt.rb

@@ -42,7 +42,7 @@ module Doing
         end
       end
 
-      def read_lines(prompt: 'Enter text', completions: [])
+      def read_lines(prompt: 'Enter text', completions: [], default_response: '')
         $stdin.reopen('/dev/tty')
         return default_response if @default_answer
 
@@ -72,8 +72,10 @@ module Doing
         res.join("\n").strip
       end
 
-      def request_lines(prompt: 'Enter text')
+      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')}"