doing 2.1.21 → 2.1.25

data/lib/doing/changelog/change.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Doing
+  # A single version's entries
+  class Change
+    attr_reader :version, :content
+
+    attr_accessor :entries
+
+    def initialize(version, content)
+      @version = Version.new(version)
+      @content = content
+      parse_entries
+    end
+
+    def parse_entries
+      @entries = []
+      types = @content.scan(/(?<=\n|\A)#### (NEW|IMPROVED|FIXED)(.*?)(?=\n####|\Z)/m)
+      types.each do |type|
+        type[1].scan(/\s*- +(.*?)$/).each do |entry|
+          @entries << Entry.new(entry[0].strip, type[0])
+        end
+      end
+    end
+
+    def search_entries(search_string)
+      case_type = :ignore
+
+      matches = []
+
+      if search_string.is_rx?
+        matches = @entries.select { |e| e.string =~ search_string.to_rx(distance: 2, case_type: case_type) }
+      else
+        query = search_string.gsub(/(-)?--/, '\1]]').to_phrase_query
+
+        if query[:must].nil? && query[:must_not].nil?
+          query[:must] = query[:should]
+          query[:should] = []
+        end
+
+        @entries.each do |entry|
+          m = no_searches?(entry.string, query[:must_not])
+          m &&= all_searches?(entry.string, query[:must])
+          m &&= any_searches?(entry.string, query[:should])
+          matches << entry if m
+        end
+      end
+
+      @entries = matches.count.positive? ? matches : nil
+    end
+
+    def to_h
+      { version: @version, content: @content }
+    end
+
+    def to_s
+      out = ["### #{@version}"]
+      items = {
+        new: [],
+        improved: [],
+        fixed: [],
+        other: []
+      }
+      @entries.each do |e|
+        type = e.type.downcase.to_sym
+        if items.key?(type)
+          items[type] << e
+        else
+          items[:other] << e
+        end
+      end
+
+      items.each do |type, members|
+        if members.count.positive?
+          out << "#### #{type.to_s.capitalize}"
+          out << members.map(&:to_s).join("\n")
+        end
+      end
+
+      out.join("\n\n")
+    end
+
+    private
+
+    def all_searches?(text, searches)
+      return true if searches.nil? || searches.empty?
+
+      searches.each do |s|
+        rx = Regexp.new(s.wildcard_to_rx, true)
+        return false unless text =~ rx
+      end
+      true
+    end
+
+    def no_searches?(text, searches)
+      return true if searches.nil? || searches.empty?
+
+      searches.each do |s|
+        rx = Regexp.new(s.wildcard_to_rx, true)
+        return false if text =~ rx
+      end
+      true
+    end
+
+    def any_searches?(text, searches)
+      return true if searches.nil? || searches.empty?
+
+      searches.each do |s|
+        rx = Regexp.new(s.wildcard_to_rx, true)
+        return true if text =~ rx
+      end
+      false
+    end
+  end
+end

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

@@ -123,8 +123,9 @@ 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)"
+          # 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])

data/lib/doing/configuration.rb

@@ -45,8 +45,7 @@ module Doing
       'templates' => {
         'default' => {
           'date_format' => '%Y-%m-%d %H:%M',
-          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %dark%boldmagenta[%boldwhite%-10section%boldmagenta]%reset
-            %yellow%interval%boldred%duration%dark%white%80_14┃ note',
+          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %boldmagenta[%boldwhite%-10section%boldmagenta]%reset %yellow%interval%boldred%duration%white%80_14┃ note',
           'wrap_width' => 0,
           'order' => 'asc'
         },
@@ -63,8 +62,7 @@ module Doing
         },
         'recent' => {
           'date_format' => '%_I:%M%P',
-          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %dark%boldmagenta[%boldwhite%-10section%boldmagenta]%reset
-            %yellow%interval%boldred%duration%dark%white%80_14┃ note',
+          'template' => '%reset%cyan%shortdate %boldwhite%80║ title %boldmagenta[%boldwhite%-10section%boldmagenta]%reset  %yellow%interval%boldred%duration%white%80_14┃ note',
           'wrap_width' => 88,
           'count' => 10,
           'order' => 'asc'
@@ -160,7 +158,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,
@@ -190,7 +188,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 =~ /^[.*]?$/
@@ -198,16 +196,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")
@@ -306,7 +312,7 @@ module Doing
 
       @ignore_local = opt[:ignore_local] if opt[:ignore_local]
 
-      config = read_config.dup
+      config = read_config.clone
 
       plugin_config = Util.deep_merge_hashes(DEFAULTS['plugins'], config['plugins'] || {})
 
@@ -314,7 +320,7 @@ module Doing
 
       Plugins.plugins.each do |_type, plugins|
         plugins.each do |title, plugin|
-          plugin_config[title] = plugin[:config] if plugin[:config] && !plugin[:config].empty?
+          plugin_config[title] = plugin[:config] if plugin[:config].good?
           config['export_templates'][title] ||= nil if plugin[:templates] && !plugin[:templates].empty?
         end
       end

data/lib/doing/good.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Doing
+  # Object helpers
+  class ::Object
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      !nil? && !empty?
+    end
+  end
+
+  class ::String
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      !strip.empty?
+    end
+  end
+
+  class ::Array
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      !nil? && !empty?
+    end
+  end
+
+  class ::FalseClass
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      false
+    end
+  end
+
+  class ::TrueClass
+    ##
+    ## Tests if object is nil or empty
+    ##
+    ## @return     [Boolean] true if object is defined and
+    ##             has content
+    ##
+    def good?
+      true
+    end
+  end
+end

data/lib/doing/hash.rb

@@ -6,14 +6,36 @@ 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
+
+    def clone
+      Marshal.load(Marshal.dump(self))
     end
 
     # Turn all keys into string
@@ -30,8 +52,9 @@ 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

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

@@ -10,8 +10,8 @@ module Doing
       post_local_config: [],  # wwid
       post_read: [],          # wwid
       pre_entry_add: [],      # wwid, new_entry
-      post_entry_added: [],   # wwid, new_entry.dup
-      post_entry_updated: [], # wwid, entry
+      post_entry_added: [],   # wwid, new_entry
+      post_entry_updated: [], # wwid, entry, old_entry
       post_entry_removed: [], # wwid, entry.dup
       pre_export: [],         # wwid, format, entries
       pre_write: [],          # wwid, file
@@ -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
@@ -53,7 +57,7 @@ module Doing
 
     def self.trigger(event, *args)
       hooks = @registry[event]
-      return if hooks.nil? || hooks.empty?
+      return unless hooks.good?
 
       # sort and call hooks according to priority and load order
       hooks.sort_by { |h| @hook_priority[h] }.each do |hook|