doing 2.1.40 → 2.1.41

data/docs/doc/top-level-namespace.html

@@ -86,7 +86,7 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span>, <span class='object_link'><a href="FalseClass.html" title="FalseClass (class)">FalseClass</a></span>, <span class='object_link'><a href="Hash.html" title="Hash (class)">Hash</a></span>, <span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span>, <span class='object_link'><a href="String.html" title="String (class)">String</a></span>, <span class='object_link'><a href="Symbol.html" title="Symbol (class)">Symbol</a></span>, <span class='object_link'><a href="Time.html" title="Time (class)">Time</a></span>, <span class='object_link'><a href="TrueClass.html" title="TrueClass (class)">TrueClass</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span>, <span class='object_link'><a href="FalseClass.html" title="FalseClass (class)">FalseClass</a></span>, <span class='object_link'><a href="Hash.html" title="Hash (class)">Hash</a></span>, <span class='object_link'><a href="Numeric.html" title="Numeric (class)">Numeric</a></span>, <span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span>, <span class='object_link'><a href="String.html" title="String (class)">String</a></span>, <span class='object_link'><a href="Symbol.html" title="Symbol (class)">Symbol</a></span>, <span class='object_link'><a href="Time.html" title="Time (class)">Time</a></span>, <span class='object_link'><a href="TrueClass.html" title="TrueClass (class)">TrueClass</a></span>
     
   
 </p>
@@ -206,7 +206,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Mar 15 11:14:28 2022 by
+  Generated on Wed Mar 16 09:42:15 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.27 (ruby-3.0.1).
 </div>

data/doing.rdoc

@@ -5,7 +5,7 @@ record of what you've been doing, complete with tag-based time tracking. The
 command line tool allows you to add entries, annotate with tags and notes, and
 view your entries with myriad options, with a focus on a "natural" language syntax.
 
-v2.1.40
+v2.1.41
 
 === Global Options
 === --config_file arg
@@ -439,7 +439,7 @@ Look up a specific version. Specify versions as "MAJ.MIN.PATCH", MIN
            to a version. Wildcards (*?) accepted unless using < or >.
 
 [Default Value] None
-[Must Match] (?-mix:^(?:(?:(?:[<>=]+|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[0-9.*?]+ *)+|(?:[\d.]+ *(?:-|to)+ *[0-9.]+))$)
+[Must Match] (?-mix:^(?:(?:(?:[<>=]+|p(?:rior)|b(?:efore)|o(?:lder)|s(?:ince)|a(?:fter)|n(?:ewer))? *[0-9.*?]{1,10} *)+|(?:[\d.]+ *(?:-|to)+ *[0-9.]{1,10}))$)
 
 
 ===== -s|--search arg
@@ -2628,11 +2628,21 @@ Adds default_tags to a .doingrc file in the current directory. Any entry created
 subdirectories will be tagged with the default tags. You can modify these any time using the `config set` commnand or
 manually editing the .doingrc file.
 ===== Options
-===== -r|--remove
+===== --clear
 Remove all default_tags from the local .doingrc
 
 
 
+===== -e|--editor
+Use default editor to edit tag list
+
+
+
+===== -r|--remove
+Delete tag(s) from the current list
+
+
+
 ==== Command: <tt>tags  [MAX_COUNT]</tt>
 List all tags in the current Doing file
 

data/lib/completion/_doing.zsh

@@ -183,7 +183,7 @@ function _doing() {
                 args=( {'(--autotag)-a','(-a)--autotag'}"[Autotag entries based on autotag configuration in ~/]" "--bool[Boolean used to combine multiple tags]:BOOLEAN:" {'(--count)-c','(-c)--count'}"[How many recent entries to tag]:COUNT:" "--case[Case sensitivity for search string matching ((c)ase-sensitive]:TYPE:" {'(--date)-d','(-d)--date'}"[Include current date/time with tag]" "--force[Dont ask permission to tag all entries when count is 0t ask permission to tag all entries when count is 0]" {'(--interactive)-i','(-i)--interactive'}"[Select item(s) to tag from a menu of matching entries]" "--not[Tag items that *dont* match search/tag filterst* match search/tag filters]" {'(--remove)-r','(-r)--remove'}"[Remove given tag(s)]" "--regex[Interpret tag string as regular expression]" "--rename[Replace existing tag with tag argument]:ORIG_TAG:" {'(--section)-s','(-s)--section'}"[Section]:SECTION_NAME:" "--search[Filter entries using a search query]:QUERY:" "--tag[Filter entries by tag]:TAG:" {'(--unfinished)-u','(-u)--unfinished'}"[Tag last entry]" {'(--value)-v','(-v)--value'}"[Include a value]:VALUE:" "--val[Perform a tag value query]:QUERY:" {'(--exact)-x','(-x)--exact'}"[Force exact search string matching]" )
             ;;
             tag_dir) 
-                args=( {'(--remove)-r','(-r)--remove'}"[Remove all default_tags from the local]" )
+                args=( "--clear[Remove all default_tags from the local]" {'(--editor)-e','(-e)--editor'}"[Use default editor to edit tag list]" {'(--remove)-r','(-r)--remove'}"[Delete tag(s) from the current list]" )
             ;;
             tags) 
                 args=( "--bool[Boolean used to combine multiple tags]:BOOLEAN:" {'(--counts)-c','(-c)--counts'}"[Show count of occurrences]" "--case[Case sensitivity for search string matching ((c)ase-sensitive]:TYPE:" {'(--interactive)-i','(-i)--interactive'}"[Select items to scan from a menu of matching entries]" {'(--line)-l','(-l)--line'}"[Output in a single line with @ symbols]" "--not[Show items that *dont* match search/tag filterst* match search/tag filters]" {'(--order)-o','(-o)--order'}"[Sort order]:ORDER:" {'(--section)-s','(-s)--section'}"[Section]:SECTION_NAME:" "--search[Filter entries using a search query]:QUERY:" "--sort[Sort by name or count]:SORT_ORDER:" "--tag[Filter entries by tag]:TAG:" "--val[Perform a tag value query]:QUERY:" {'(--exact)-x','(-x)--exact'}"[Force exact search string matching]" )

data/lib/completion/doing.bash

@@ -321,9 +321,9 @@ _doing_tag() {
 _doing_tag_dir() {
   
   if [[ "$token" == --* ]]; then
-    COMPREPLY=( $( compgen -W '--remove' -- $token ) )
+    COMPREPLY=( $( compgen -W '--clear --editor --remove' -- $token ) )
   elif [[ "$token" == -* ]]; then
-    COMPREPLY=( $( compgen -W '-r --remove' -- $token ) )
+    COMPREPLY=( $( compgen -W '-e -r --clear --editor --remove' -- $token ) )
   
   fi
 }

data/lib/completion/doing.fish

@@ -505,7 +505,9 @@ complete -c doing -l unfinished -s u -f  -n '__fish_doing_using_command tag' -d
 complete -c doing -l value -s v -f -r -n '__fish_doing_using_command tag' -d Include\ a\ value
 complete -c doing -l val  -f -r -n '__fish_doing_using_command tag' -d Perform\ a\ tag\ value\ query
 complete -c doing -l exact -s x -f  -n '__fish_doing_using_command tag' -d Force\ exact\ search\ string\ matching
-complete -c doing -l remove -s r -f  -n '__fish_doing_using_command tag_dir' -d Remove\ all\ default_tags\ from\ the\ local
+complete -c doing -l clear  -f  -n '__fish_doing_using_command tag_dir' -d Remove\ all\ default_tags\ from\ the\ local
+complete -c doing -l editor -s e -f  -n '__fish_doing_using_command tag_dir' -d Use\ default\ editor\ to\ edit\ tag\ list
+complete -c doing -l remove -s r -f  -n '__fish_doing_using_command tag_dir' -d Delete\ tag\(s\)\ from\ the\ current\ list
 complete -c doing -l bool  -f -r -n '__fish_doing_using_command tags' -d Boolean\ used\ to\ combine\ multiple\ tags
 complete -c doing -l counts -s c -f  -n '__fish_doing_using_command tags' -d Show\ count\ of\ occurrences
 complete -c doing -l case  -f -r -n '__fish_doing_using_command tags' -d Case\ sensitivity\ for\ search\ string\ matching\ \[\(c\)ase-sensitive

data/lib/doing/array/array.rb

@@ -3,18 +3,22 @@
 require_relative 'tags'
 require_relative 'nested_hash'
 
-class ::Array
-  ##
-  ## Force UTF-8 encoding of strings in array
-  ##
-  ## @return     [Array] Encoded lines
-  ##
-  def utf8
-    c = self.class
-    if String.method_defined? :force_encoding
-      replace c.new(map(&:utf8))
-    else
-      self
+module Doing
+  class ::Array
+    include ArrayTags
+    include ArrayNestedHash
+    ##
+    ## Force UTF-8 encoding of strings in array
+    ##
+    ## @return     [Array] Encoded lines
+    ##
+    def utf8
+      c = self.class
+      if String.method_defined? :force_encoding
+        replace c.new(map(&:utf8))
+      else
+        self
+      end
     end
   end
 end

data/lib/doing/array/nested_hash.rb

@@ -2,7 +2,7 @@ module Doing
   ##
   ## Array helpers
   ##
-  class ::Array
+  module ArrayNestedHash
     ##
     ## Convert array to nested hash, setting last key to value
     ##

data/lib/doing/array/tags.rb

@@ -4,12 +4,14 @@ module Doing
   ##
   ## Array helpers
   ##
-  class ::Array
+  module ArrayTags
     ##
     ## Convert an array of @tags to plain strings
     ##
-    ## @return     [Array] array of strings
+    ## @return     [Array] array of strings without @ symbols
     ##
+    ## @example Convert an array of tags to strings
+    ##   ['@one', '@two', 'three'].to_tags => ['one', 'two', 'three']
     def tags_to_array
       map(&:remove_at).map(&:strip)
     end
@@ -18,9 +20,8 @@ module Doing
     #
     # @return     [Array] Array of @tags
     #
-    # @example
-    #   ['one', '@two', 'three'].to_tags
-    #   # => ['@one', '@two', '@three']
+    # @example Convert an array of strings with or without @ symbols
+    #   ['one', '@two', 'three'].to_tags => ['@one', '@two', '@three']
     def to_tags
       map(&:add_at)
     end

data/lib/doing/changelog/changelog.rb

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

data/lib/doing/chronify/array.rb

@@ -2,7 +2,7 @@
 
 module Doing
   # Chronify array helpers
-  class ::Array
+  module ChronifyArray
     # Convert [d, h, m] to [y, d, h, m]
     def to_years
       d, h, m = self
@@ -56,8 +56,6 @@ module Doing
     ##
     ## Format [d, h, m] as string
     ##
-    ## @accept     [Array] Array of [days, hours, minutes]
-    ##
     ## @param      format  [Symbol] The format, :dhm, :hm,
     ##                     :m, :clock, :natural
     ## @return     [String] formatted string

data/lib/doing/chronify/chronify.rb

@@ -3,3 +3,15 @@
 require_relative 'array'
 require_relative 'numeric'
 require_relative 'string'
+
+class ::String
+  include Doing::ChronifyString
+end
+
+class ::Array
+  include Doing::ChronifyArray
+end
+
+class ::Numeric
+  include Doing::ChronifyNumeric
+end

data/lib/doing/chronify/numeric.rb

@@ -4,11 +4,12 @@ module Doing
   ##
   ## Number helpers
   ##
-  class ::Numeric
+  module ChronifyNumeric
     ##
     ## Format human readable time from seconds
     ##
-    ## @param      seconds  [Integer] Seconds
+    ## @param      human  [Boolean] if True, don't convert
+    ##                    hours into days
     ##
     def format_time(human: false)
       return [0, 0, 0] if nil?

data/lib/doing/chronify/string.rb

@@ -2,7 +2,7 @@
 
 module Doing
   # Chronify methods for strings
-  class ::String
+  module ChronifyString
     ##
     ## Converts input string into a Time object when input
     ## takes on the following formats:

data/lib/doing/completion/completion_string.rb

@@ -0,0 +1,25 @@
+module Doing
+  module Completion
+    module StringUtils
+      def short_desc
+        split(/[,.]/)[0].sub(/ \(.*?\)?$/, '').strip
+      end
+
+      def ltrunc(max)
+        if length > max
+          sub(/^.*?(.{#{max - 3}})$/, '...\1')
+        else
+          self
+        end
+      end
+
+      def ltrunc!(max)
+        replace ltrunc(max)
+      end
+    end
+  end
+end
+
+class ::String
+  include Doing::Completion::StringUtils
+end

data/lib/doing/completion.rb

@@ -2,7 +2,7 @@
 
 require 'tty-progressbar'
 
-require_relative 'completion/string'
+require_relative 'completion/completion_string'
 require_relative 'completion/fish_completion'
 require_relative 'completion/zsh_completion'
 require_relative 'completion/bash_completion'

data/lib/doing/good.rb

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
 module Doing
+  # Numeric helpers
+  class ::Numeric
+    # Test of number is positive
+    def good?
+      positive?
+    end
+  end
+
   # Object helpers
   class ::Object
     ##

data/lib/doing/item/dates.rb

@@ -1,5 +1,5 @@
 module Doing
-  class Item
+  module ItemDates
     # def date=(new_date)
     #   @date = new_date.is_a?(Time) ? new_date : Time.parse(new_date)
     # end

data/lib/doing/{item.rb → item/item.rb}

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
-require_relative 'item/dates'
-require_relative 'item/tags'
-require_relative 'item/state'
-require_relative 'item/query'
+require_relative 'dates'
+require_relative 'tags'
+require_relative 'state'
+require_relative 'query'
 
 module Doing
   ##
   ## This class describes a single WWID item
   ##
   class Item
+    include ItemDates
+    include ItemQuery
+    include ItemState
+    include ItemTags
+
     attr_accessor :date, :title, :section, :note
 
     # attr_reader :id
@@ -56,7 +61,7 @@ module Doing
 
       return false unless @note.equal?(other.note)
 
-      return false if match_section && @section != other.section
+      return false if match_section && !@section.equal?(other.section)
 
       true
     end

data/lib/doing/item/query.rb

@@ -2,7 +2,7 @@
 
 module Doing
   # Tag and search filtering for a Doing entry
-  class Item
+  module ItemQuery
     ##
     ## Test if item contains tag(s)
     ##

data/lib/doing/item/state.rb

@@ -1,6 +1,6 @@
 module Doing
   # State queries for a Doing entry
-  class Item
+  module ItemState
     ##
     ## Test if item has a @done tag
     ##

data/lib/doing/item/tags.rb

@@ -2,7 +2,7 @@
 
 module Doing
   # A Doing entry
-  class Item
+  module ItemTags
     ##
     ## Add (or remove) tags from the title of the item
     ##

data/lib/doing/items/filter.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Doing
+  class Items < Array
+    # Get a new Items object containing only items in a
+    # specified section
+    #
+    # @param      section  [String] section title
+    #
+    # @return     [Items] Array of items
+    #
+    def in_section(section)
+      if section =~ /^all$/i
+        dup
+      else
+        items = Items.new.concat(select { |item| !item.nil? && item.section == section })
+        items.add_section(section, log: false)
+        items
+      end
+    end
+
+    ##
+    ## Search Items for a string (title and note)
+    ##
+    ## @param      query      [String] The query
+    ## @param      case_type  [Symbol] The case type
+    ##                        (:smart, :sensitive, :ignore)
+    ##
+    ## @return     [Items] array of items matching search
+    ##
+    def search(query, case_type: :smart)
+      WWID.new.fuzzy_filter_items(self, query, case_type: case_type)
+    end
+
+    ##
+    ## Search items by tags
+    ##
+    ## @param      tags  [Array,String] The tags by which to
+    ##                   filter
+    ## @param      bool  [Symbol] The bool with which to
+    ##                   combine multiple tags
+    ##
+    ## @return     [Items] array of items matching tag filter
+    ##
+    def tagged(tags, bool: :and)
+      WWID.new.filter_items(self, opt: { tag: tags, bool: bool })
+    end
+
+    ##
+    ## Filter Items by date. String arguments will be
+    ## chronified
+    ##
+    ## @param      start   [Time,String] Filter items after
+    ##                     this date
+    ## @param      finish  [Time,String] Filter items before
+    ##                     this date
+    ##
+    ## @return     [Items] array of items with dates between
+    ##             targets
+    ##
+    def between_dates(start, finish)
+      start = start.chronify(guess: :begin, future: false) if start.is_a?(String)
+      finish = finish.chronify(guess: :end) if finish.is_a?(String)
+      WWID.new.filter_items(self, opt: { date_filter: [start, finish] })
+    end
+  end
+end

data/lib/doing/items/items.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'filter'
+require_relative 'modify'
+require_relative 'sections'
+require_relative 'util'
+
+module Doing
+  # A collection of Item objects
+  class Items < Array
+    attr_accessor :sections
+
+    def initialize
+      super
+      @sections = []
+    end
+
+    ##
+    ## Test if self includes Item
+    ##
+    ## @param      item           [Item] The item to search for
+    ## @param      match_section  [Boolean] Section must match
+    ##
+    ## @return     [Boolean] True if Item exists
+    ##
+    def include?(item, match_section: true)
+      includes = false
+      each do |other_item|
+        if other_item.equal?(item, match_section: match_section)
+          includes = true
+          break
+        end
+      end
+
+      includes
+    end
+
+    # Output sections and items in Doing file format
+    def to_s
+      out = []
+      @sections.each do |section|
+        out.push(section.original)
+        items = in_section(section.title).sort_by { |i| [i.date, i.title] }
+        items.reverse! if Doing.setting('doing_file_sort').normalize_order == :desc
+        items.each { |item| out.push(item.to_s) }
+      end
+
+      out.join("\n")
+    end
+
+    # @private
+    def inspect
+      sections = @sections.map { |s| "<Section:#{s.title} #{in_section(s.title).count} items>" }.join(', ')
+      "#<Doing::Items #{count} items, #{@sections.count} sections: #{sections}>"
+    end
+  end
+end

data/lib/doing/items/modify.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Doing
+  class Items < Array
+    ##
+    ## Delete an item from the index
+    ##
+    ## @param      item  The item
+    ##
+    def delete_item(item, single: false)
+      deleted = delete(item)
+      Doing.logger.count(:deleted)
+      Doing.logger.info('Entry deleted:', deleted.title) if single
+      deleted
+    end
+
+    ##
+    ## Update an item in the index with a modified item
+    ##
+    ## @param      old_item  The old item
+    ## @param      new_item  The new item
+    ##
+    def update_item(old_item, new_item)
+      s_idx = index { |item| item.equal?(old_item) }
+
+      raise ItemNotFound, 'Unable to find item in index, did it mutate?' unless s_idx
+
+      return if fetch(s_idx).equal?(new_item)
+
+      self[s_idx] = new_item
+      Doing.logger.count(:updated)
+      Doing.logger.info('Entry updated:', self[s_idx].title.trunc(60))
+      new_item
+    end
+  end
+end

data/lib/doing/items/sections.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Doing
+  class Items < Array
+    # List sections, title only
+    #
+    # @return     [Array] section titles
+    #
+    def section_titles
+      @sections.map(&:title)
+    end
+
+    # Test if section already exists
+    #
+    # @param      section  [String] section title
+    #
+    # @return     [Boolean] true if section exists
+    #
+    def section?(section)
+      section = section.is_a?(Section) ? section.title.downcase : section.downcase
+      @sections.map { |i| i.title.downcase }.include?(section)
+    end
+
+    ##
+    ## Return the best section match for a search query
+    ##
+    ## @param      frag      The search query
+    ## @param      distance  The distance apart characters can be (fuzziness)
+    ##
+    ## @return     [Section] (first) matching section object
+    ##
+    def guess_section(frag, distance: 2)
+      section = nil
+      re = frag.to_rx(distance: distance, case_type: :ignore)
+      @sections.each do |sect|
+        next unless sect.title =~ /#{re}/i
+
+        Doing.logger.debug('Match:', %(Assuming "#{sect.title}" from "#{frag}"))
+        section = sect
+        break
+      end
+
+      section
+    end
+
+    # Add a new section to the sections array. Accepts
+    # either a Section object, or a title string that will
+    # be converted into a Section.
+    #
+    # @param      section  [Section] The section to add. A
+    #                      String value will be converted to
+    #                      Section automatically.
+    # @param      log      [Boolean] Add a log message
+    #                      notifying the user about the
+    #                      creation of the section.
+    #
+    # @return     nothing
+    #
+    def add_section(section, log: false)
+      section = section.is_a?(Section) ? section : Section.new(section.cap_first)
+
+      return if section?(section)
+
+      @sections.push(section)
+      Doing.logger.info('New section:', %("#{section}" added)) if log
+    end
+
+    def delete_section(section, log: false)
+      return unless section?(section)
+
+      raise DoingRuntimeError, 'Section not empty' if in_section(section).count.positive?
+
+      @sections.each do |sect|
+        next unless sect.title == section && in_section(sect).count.zero?
+
+        @sections.delete(sect)
+        Doing.logger.info('Removed section:', %("#{section}" removed)) if log
+      end
+
+      Doing.logger.error('Not found:', %("#{section}" not found))
+    end
+  end
+end