Class: Doing::WWID

Inherits:
Object
  • Object
show all
Includes:
Color
Defined in:
lib/doing/wwid.rb

Overview

Main "What Was I Doing" methods

Constant Summary

Constants included from Color

Color::ATTRIBUTES, Color::ATTRIBUTE_NAMES, Color::COLORED_REGEXP

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Color

attributes, coloring?, #support?, #uncolor

Constructor Details

#initialize ⇒ WWID

Initializes the object.



25
26
27
28
29
30
 
# File 'lib/doing/wwid.rb', line 25

def initialize
  @timers = {}
  @recorded_items = []
  @content = Items.new
  @auto_tag = true
end

Instance Attribute Details

#additional_configs ⇒ Object (readonly)

Returns the value of attribute additional_configs.



15
16
17
 
# File 'lib/doing/wwid.rb', line 15

def additional_configs
  @additional_configs
end

#auto_tag ⇒ Object

Returns the value of attribute auto_tag.



17
18
19
 
# File 'lib/doing/wwid.rb', line 17

def auto_tag
  @auto_tag
end

#config ⇒ Object

Returns the value of attribute config.



17
18
19
 
# File 'lib/doing/wwid.rb', line 17

def config
  @config
end

#config_file ⇒ Object

Returns the value of attribute config_file.



17
18
19
 
# File 'lib/doing/wwid.rb', line 17

def config_file
  @config_file
end

#content ⇒ Object (readonly)

Returns the value of attribute content.



15
16
17
 
# File 'lib/doing/wwid.rb', line 15

def content
  @content
end

#current_section ⇒ Object (readonly)

Returns the value of attribute current_section.



15
16
17
 
# File 'lib/doing/wwid.rb', line 15

def current_section
  @current_section
end

#default_option ⇒ Object

Returns the value of attribute default_option.



17
18
19
 
# File 'lib/doing/wwid.rb', line 17

def default_option
  @default_option
end

#doing_file ⇒ Object (readonly)

Returns the value of attribute doing_file.



15
16
17
 
# File 'lib/doing/wwid.rb', line 15

def doing_file
  @doing_file
end

Instance Method Details

#act_on(items, opt) ⇒ Object

Perform actions on a set of entries. If no valid action is included in the opt hash and the terminal is a TTY, a menu will be presented

Parameters:

  • items (Array) —

    Array of Items to affect

  • opt (Hash) —

    Options and actions to perform

Options Hash (opt):

  • :editor (Boolean)
  • :delete (Boolean)
  • :tag (String)
  • :flag (Boolean)
  • :finish (Boolean)
  • :cancel (Boolean)
  • :archive (Boolean)
  • :output (String)
  • :save_to (String)
  • :again (Boolean)
  • :resume (Boolean) 


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
 
# File 'lib/doing/wwid.rb', line 924

def act_on(items, opt)
  opt ||= {}
  actions = %i[editor delete tag flag finish cancel archive output save_to again resume]
  has_action = false
  single = items.count == 1

  actions.each do |a|
    if opt[a]
      has_action = true
      break
    end
  end

  unless has_action
    actions = [
      'add tag',
      'remove tag',
      'autotag',
      'cancel',
      'delete',
      'finish',
      'flag',
      'archive',
      'move',
      'edit',
      'output formatted'
    ]

    actions.concat(['resume/repeat', 'begin/reset']) if items.count == 1

    choice = Prompt.choose_from(actions,
                                prompt: 'What do you want to do with the selected items? > ',
                                multiple: true,
                                sorted: false,
                                fzf_args: ["--height=#{actions.count + 3}", '--tac', '--no-sort', '--info=hidden'])
    return unless choice

    to_do = choice.strip.split(/\n/)
    to_do.each do |action|
      case action
      when /resume/
        opt[:resume] = true
      when /reset/
        opt[:reset] = true
      when /autotag/
        opt[:autotag] = true
      when /(add|remove) tag/
        type = action =~ /^add/ ? 'add' : 'remove'
        raise InvalidArgument, "'add tag' and 'remove tag' can not be used together" if opt[:tag]

        tags = type == 'add' ? all_tags(@content) : all_tags(items)

        puts "#{yellow}Separate multiple tags with spaces, hit tab to complete known tags#{type == 'add' ? ', include values with tag(value)' : ''}"
        puts "#{boldgreen}Available tags: #{boldwhite}#{tags.sort.map(&:add_at).join(', ')}" if type == 'remove'
        tag = Prompt.read_line(prompt: "Tags to #{type}", completions: tags)

        # print "#{yellow("Tag to #{type}: ")}#{reset}"
        # tag = $stdin.gets
        next if tag =~ /^ *$/

        opt[:tag] = tag.strip.sub(/^@/, '')
        opt[:remove] = true if type == 'remove'
      when /output formatted/
        plugins = Plugins.available_plugins(type: :export).sort
        output_format = Prompt.choose_from(plugins,
                                           prompt: 'Which output format? > ',
                                           fzf_args: [
                                             "--height=#{plugins.count + 3}",
                                             '--tac',
                                             '--no-sort',
                                             '--info=hidden'
                                           ])
        next if output_format =~ /^ *$/

        raise UserCancelled unless output_format

        opt[:output] = output_format.strip
        res = opt[:force] ? false : Prompt.yn('Save to file?', default_response: 'n')
        if res
          # print "#{yellow('File path/name: ')}#{reset}"
          # filename = $stdin.gets.strip
          filename = Prompt.read_line(prompt: 'File path/name')
          next if filename.empty?

          opt[:save_to] = filename
        end
      when /archive/
        opt[:archive] = true
      when /delete/
        opt[:delete] = true
      when /edit/
        opt[:editor] = true
      when /finish/
        opt[:finish] = true
      when /cancel/
        opt[:cancel] = true
      when /move/
        section = choose_section.strip
        opt[:move] = section.strip unless section =~ /^ *$/
      when /flag/
        opt[:flag] = true
      end
    end
  end

  if opt[:resume] || opt[:reset]
    raise InvalidArgument, 'resume and restart can only be used on a single entry' if items.count > 1

    item = items[0]
    if opt[:resume] && !opt[:reset]
      repeat_item(item, { editor: opt[:editor] }) # hooked
    elsif opt[:reset]
      res = Prompt.enter_text('Start date (blank for current time)', default_response: '')
      if res =~ /^ *$/
        date = Time.now
      else
        date = res.chronify(guess: :begin)
      end

      res = if item.tags?('done', :and) && !opt[:resume]
              opt[:force] ? true : Prompt.yn('Remove @done tag?', default_response: 'y')
            else
              opt[:resume]
            end
      new_entry = reset_item(item, date: date, resume: res)
      @content.update_item(item, new_entry)
      Hooks.trigger :post_entry_updated, self, new_entry
    end
    write(@doing_file)

    return
  end

  if opt[:delete]
    delete_items(items, force: opt[:force]) # hooked
    return
  end

  if opt[:flag]
    tag = @config['marker_tag'] || 'flagged'
    items.map! do |i|
      i.tag(tag, date: false, remove: opt[:remove], single: single)
      Hooks.trigger :post_entry_updated, self, i
    end
  end

  if opt[:finish] || opt[:cancel]
    tag = 'done'
    items.map! do |i|
      if i.should_finish?
        should_date = !opt[:cancel] && i.should_time?
        i.tag(tag, date: should_date, remove: opt[:remove], single: single)
        Hooks.trigger :post_entry_updated, self, i
      end
    end
  end

  if opt[:autotag]
    items.map! do |i|
      new_title = autotag(i.title)
      if new_title == i.title
        logger.count(:skipped, level: :debug, message: '%count unchaged %items')
        # logger.debug('Autotag:', 'No changes')
      else
        logger.count(:added_tags)
        logger.write(items.count == 1 ? :info : :debug, 'Tagged:', new_title)
        i.title = new_title
        Hooks.trigger :post_entry_updated, self, i
      end
    end
  end

  if opt[:tag]
    tag = opt[:tag]
    items.map! do |i|
      i.tag(tag, date: false, remove: opt[:remove], single: single)
      i.expand_date_tags(@config['date_tags'])
      Hooks.trigger :post_entry_updated, self, i
    end
  end

  if opt[:archive] || opt[:move]
    section = opt[:archive] ? 'Archive' : guess_section(opt[:move])
    items.map! do |i|
      i.move_to(section, label: true)
      Hooks.trigger :post_entry_updated, self, i
    end
  end

  write(@doing_file)

  if opt[:editor]
    edit_items(items) # hooked

    write(@doing_file)
  end

  return unless opt[:output]

  items.each { |i| i.title = "#{i.title} @section(#{i.section})" }

  export_items = Items.new
  export_items.concat(items)
  export_items.add_section(Section.new('Export'), log: false)
  options = { section: 'All' }

  if opt[:output] =~ /doing/
    options[:output] = 'template'
    options[:template] = '- %date | %title%note'
  else
    options[:output] = opt[:output]
    options[:template] = opt[:template] || nil
  end

  output = list_section(options, items: export_items) # hooked

  if opt[:save_to]
    file = File.expand_path(opt[:save_to])
    if File.exist?(file)
      # Create a backup copy for the undo command
      FileUtils.cp(file, "#{file}~")
    end

    File.open(file, 'w+') do |f|
      f.puts output
    end

    logger.warn('File written:', file)
  else
    Doing::Pager.page output
  end
end

#add_item(title, section = nil, opt) ⇒ Object

Adds an entry

Parameters:

  • title (String) —

    The entry title

  • section (String) (defaults to: nil) —

    The section to add to

  • opt (Hash) —

    Additional Options

Options Hash (opt):

  • :date (Date) —

    item start date

  • :note (Array) —

    item note (will be converted if value is String)

  • :back (Date) —

    backdate

  • :timed (Boolean) —

    new item is timed entry, marks previous entry as @done



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/doing/wwid.rb', line 342

def add_item(title, section = nil, opt)
  opt ||= {}
  section ||= @config['current_section']
  @content.add_section(section, log: false)
  opt[:back] ||= opt[:date] ? opt[:date] : Time.now
  opt[:date] ||= Time.now
  note = Note.new
  opt[:timed] ||= false

  note.add(opt[:note]) if opt[:note]

  title = [title.strip.cap_first]
  title = title.join(' ')

  if @auto_tag
    title = autotag(title)
    title.add_tags!(@config['default_tags']) unless @config['default_tags'].empty?
  end

  title.compress!
  entry = Item.new(opt[:back], title.strip, section)
  entry.note = note

  items = @content.dup
  if opt[:timed]
    items.reverse!
    items.each_with_index do |i, x|
      next if i.title =~ / @done/

      finish_date = verify_duration(i.date, opt[:back], title: i.title)
      items[x].tag('done', value: finish_date.strftime('%F %R'))
      break
    end
  end

  Hooks.trigger :pre_entry_add, self, entry

  @content.push(entry)
  # logger.count(:added, level: :debug)
  logger.info('New entry:', %(added "#{entry.date.relative_date}: #{entry.title}" to #{section}))

  Hooks.trigger :post_entry_added, self, entry.dup
end

#add_with_editor(**options) ⇒ Object

Raises:

  • (MissingEditor) 


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/doing/wwid.rb', line 308

def add_with_editor(**options)
  raise MissingEditor, 'No EDITOR variable defined in environment' if Util.default_editor.nil?

  input = options[:date].strftime('%F %R | ')
  input += options[:title]
  input += "\n#{options[:note]}" if options[:note]
  input = fork_editor(input).strip

  d, title, note = format_input(input)
  raise EmptyInput, 'No content' if title.empty?

  if options[:ask]
    ask_note = Doing::Prompt.read_lines(prompt: 'Add a note')
    note.add(ask_note) unless ask_note.empty?
  end

  date = d.nil? ? options[:date] : d
  finish = options[:finish_last] || false
  add_item(title.cap_first, options[:section], { note: note, back: date, timed: finish })
  write(@doing_file)
end

#all_tags(items, opt: {}, counts: false) ⇒ Object 



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/doing/wwid.rb', line 566

def all_tags(items, opt: {}, counts: false)
  if counts
    all_tags = {}
    items.each do |item|
      item.tags.each do |tag|
        if all_tags.key?(tag.downcase)
          all_tags[tag.downcase] += 1
        else
          all_tags[tag.downcase] = 1
        end
      end
    end

    all_tags.sort_by { |tag, count| count }
  else
    all_tags = []
    items.each { |item| all_tags.concat(item.tags.map(&:downcase)).uniq! }
    all_tags.sort
  end
end

#archive(section = , options) ⇒ Object

Move entries from a section to Archive or other specified section

Parameters:

  • section (String) (defaults to: ) —

    The source section

  • options (Hash) —

    Options



1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
 
# File 'lib/doing/wwid.rb', line 1686

def archive(section = @config['current_section'], options)
  options ||= {}
  count       = options[:keep] || 0
  destination = options[:destination] || 'Archive'
  tags        = options[:tags] || []
  bool        = options[:bool] || :and

  section = choose_section if section.nil? || section =~ /choose/i
  archive_all = section =~ /^all$/i # && !(tags.nil? || tags.empty?)
  section = guess_section(section) unless archive_all

  @content.add_section(destination, log: true)
  # add_section(Section.new('Archive')) if destination =~ /^archive$/i && [email protected]?('Archive')

  destination = guess_section(destination)

  if @content.section?(destination) && (@content.section?(section) || archive_all)
    do_archive(section, destination, { count: count, tags: tags, bool: bool, search: options[:search], label: options[:label], before: options[:before] })
    write(doing_file)
  else
    raise InvalidArgument, 'Either source or destination does not exist'
  end
end

#autotag(string) ⇒ Object

Uses 'autotag' configuration to turn keywords into tags for time tracking. Does not repeat tags in a title, and only converts the first instance of an untagged keyword

Parameters:

  • string (String) —

    The text to tag



1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
 
# File 'lib/doing/wwid.rb', line 1921

def autotag(string)
  return unless string
  return string unless @auto_tag

  original = string.dup
  text = string.dup

  current_tags = text.scan(/@\w+/).map { |t| t.sub(/^@/, '') }
  tagged = {
    whitelisted: [],
    synonyms: [],
    transformed: [],
    replaced: []
  }

  @config['autotag']['whitelist'].each do |tag|
    next if text =~ /@#{tag}\b/i

    text.sub!(/(?<= |\A)(#{tag.strip})(?= |\Z)/i) do |m|
      m.downcase! unless tag =~ /[A-Z]/
      tagged[:whitelisted].push(m)
      "@#{m}"
    end
  end

  @config['autotag']['synonyms'].each do |tag, v|
    v.each do |word|
      word = word.wildcard_to_rx
      next unless text =~ /\b#{word}\b/i

      unless current_tags.include?(tag) || tagged[:whitelisted].include?(tag)
        tagged[:synonyms].push(tag)
        tagged[:synonyms] = tagged[:synonyms].uniq
      end
    end
  end

  if @config['autotag'].key? 'transform'
    @config['autotag']['transform'].each do |tag|
      next unless tag =~ /\S+:\S+/

      if tag =~ /::/
        rx, r = tag.split(/::/)
      else
        rx, r = tag.split(/:/)
      end

      flag_rx = %r{/([r]+)$}
      if r =~ flag_rx
        flags = r.match(flag_rx)[1].split(//)
        r.sub!(flag_rx, '')
      end
      r.gsub!(/\$/, '\\')
      rx.sub!(/^@?/, '@')
      regex = Regexp.new("(?<= |\\A)#{rx}(?= |\\Z)")

      text.sub!(regex) do
        m = Regexp.last_match
        new_tag = r

        m.to_a.slice(1, m.length - 1).each_with_index do |v, idx|
          new_tag.gsub!("\\#{idx + 1}", v)
        end
        # Replace original tag if /r
        if flags&.include?('r')
          tagged[:replaced].concat(new_tag.split(/ /).map { |t| t.sub(/^@/, '') })
          new_tag.split(/ /).map { |t| t.sub(/^@?/, '@') }.join(' ')
        else
          tagged[:transformed].concat(new_tag.split(/ /).map { |t| t.sub(/^@/, '') })
          tagged[:transformed] = tagged[:transformed].uniq
          m[0]
        end
      end
    end
  end

  logger.debug('Autotag:', "whitelisted tags: #{tagged[:whitelisted].log_tags}") unless tagged[:whitelisted].empty?
  logger.debug('Autotag:', "synonyms: #{tagged[:synonyms].log_tags}") unless tagged[:synonyms].empty?
  logger.debug('Autotag:', "transforms: #{tagged[:transformed].log_tags}") unless tagged[:transformed].empty?
  logger.debug('Autotag:', "transform replaced: #{tagged[:replaced].log_tags}") unless tagged[:replaced].empty?

  tail_tags = tagged[:synonyms].concat(tagged[:transformed])
  tail_tags.sort!
  tail_tags.uniq!

  text.add_tags!(tail_tags) unless tail_tags.empty?

  if text == original
    logger.debug('Autotag:', "no change to \"#{text.strip}\"")
  else
    new_tags = tagged[:whitelisted].concat(tail_tags).concat(tagged[:replaced])
    logger.debug('Autotag:', "added #{new_tags.log_tags} to \"#{text.strip}\"")
    logger.count(:autotag, level: :info, count: 1, message: 'autotag updated %count %items')
  end

  text.dedup_tags
end

#choose_section(include_all: false) ⇒ String

Generate a menu of sections and allow user selection

Returns:

  • (String) —

    The selected section name



1533
1534
1535
1536
1537
1538
 
# File 'lib/doing/wwid.rb', line 1533

def choose_section(include_all: false)
  options = @content.section_titles.sort
  options.unshift('All') if include_all
  choice = Prompt.choose_from(options, prompt: 'Choose a section > ', fzf_args: ['--height=60%'])
  choice ? choice.strip : choice
end

#choose_section_tag ⇒ String

Generate a menu of sections and tags and allow user selection

Returns:

  • (String) —

    The selected section or tag name



1558
1559
1560
1561
1562
1563
 
# File 'lib/doing/wwid.rb', line 1558

def choose_section_tag
  options = @content.section_titles.sort
  options.concat(@content.all_tags.sort.map { |t| "@#{t}" })
  choice = Prompt.choose_from(options, prompt: 'Choose a section or tag > ', fzf_args: ['--height=60%'])
  choice ? choice.strip : choice
end

#choose_tag(section = 'All', items: nil, include_all: false) ⇒ String

Generate a menu of tags and allow user selection

Returns:

  • (String) —

    The selected tag name



1545
1546
1547
1548
1549
1550
1551
 
# File 'lib/doing/wwid.rb', line 1545

def choose_tag(section = 'All', items: nil, include_all: false)
  items ||= @content.in_section(section)
  tags = all_tags(items, counts: true).map { |t, c| "@#{t} (#{c})" }
  tags.unshift('No tag filter') if include_all
  choice = Prompt.choose_from(tags, sorted: false, multiple: true, prompt: 'Choose tag(s) > ', fzf_args: ['--height=60%'])
  choice ? choice.split(/\n/).map { |t| t.strip.sub(/ \(.*?\)$/, '')}.join(' ') : choice
end

#choose_view ⇒ String

Generate a menu of views and allow user selection

Returns:

  • (String) —

    The selected view name



1579
1580
1581
1582
 
# File 'lib/doing/wwid.rb', line 1579

def choose_view
  choice = Prompt.choose_from(views.sort, prompt: 'Choose a view > ', fzf_args: ['--height=60%'])
  choice ? choice.strip : choice
end

#configure(filename = nil) ⇒ Object

Load configuration files and updated the @config attribute with a Doing::Configuration object

Parameters:

  • filename (String) (defaults to: nil) —

    (optional) path to alternative config file



2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
 
# File 'lib/doing/wwid.rb', line 2185

def configure(filename = nil)
  if filename
    Doing.config_with(filename, { ignore_local: true })
  elsif ENV['DOING_CONFIG']
    Doing.config_with(ENV['DOING_CONFIG'], { ignore_local: true })
  end

  Doing.logger.benchmark(:configure, :start)
  config = Doing.config
  Doing.logger.benchmark(:configure, :finish)

  config.settings['backup_dir'] = ENV['DOING_BACKUP_DIR'] if ENV['DOING_BACKUP_DIR']
  @config = config.settings
end

#create(filename = nil) ⇒ Object

Create a new doing file



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/doing/wwid.rb', line 113

def create(filename = nil)
  filename = @doing_file if filename.nil?
  return if File.exist?(filename) && File.stat(filename).size.positive?

  FileUtils.mkdir_p(File.dirname(filename)) unless File.directory?(File.dirname(filename))

  File.open(filename, 'w+') do |f|
    f.puts "#{@config['current_section']}:"
  end
end

#dedup(items, no_overlap: false) ⇒ Object

Remove items from an array that already exist in

Parameters:

  • items (Array) —

    The items to deduplicate

  • no_overlap (Boolean) (defaults to: false) —

    Remove items with overlapping time spans



395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/doing/wwid.rb', line 395

def dedup(items, no_overlap: false)
  items.delete_if do |item|
    duped = false
    @content.each do |comp|
      duped = no_overlap ? item.overlapping_time?(comp) : item.same_time?(comp)
      break if duped
    end
    logger.count(:skipped, level: :debug, message: '%count overlapping %items') if duped
    # logger.log_now(:debug, 'Skipped:', "overlapping entry: #{item.title}") if duped
    duped
  end
end

#delete_items(items, force: false) ⇒ Object 



804
805
806
807
808
809
810
811
812
813
 
# File 'lib/doing/wwid.rb', line 804

def delete_items(items, force: false)
  items.slice(0, 5).each { |i| puts i.to_pretty } unless force
  puts softpurple("+ #{items.size - 5} additional #{'item'.to_p(items.size - 5)}") if items.size > 5 && !force

  res = force ? true : Prompt.yn("Delete #{items.size} #{'item'.to_p(items.size)}?", default_response: 'y')
  return unless res

  items.each { |i| Hooks.trigger :post_entry_removed, self, @content.delete_item(i, single: items.count == 1) }
  write(@doing_file)
end

#edit_items(items) ⇒ Object 



815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/doing/wwid.rb', line 815

def edit_items(items)
  items.sort_by! { |i| i.date }
  editable_items = []

  items.each do |i|
    editable = "#{i.date.strftime('%F %R')} | #{i.title}"
    old_note = i.note ? i.note.strip_lines.join("\n") : nil
    editable += "\n#{old_note}" unless old_note.nil?
    editable_items << editable
  end
  divider = "-----------"
  notice =<<~EONOTICE
  # - You may delete entries, but leave all divider lines (---) in place.
  # - Start and @done dates replaced with a time string (yesterday 3pm) will
  #   be parsed automatically. Do not delete the pipe (|) between start date
  #   and entry title.
  EONOTICE
  input =  "#{editable_items.map(&:strip).join("\n#{divider}\n")}\n\n#{notice}"

  new_items = fork_editor(input).split(/^#{divider}/).map(&:strip)

  new_items.each_with_index do |new_item, i|
    input_lines = new_item.split(/[\n\r]+/).delete_if(&:ignore?)
    first_line = input_lines[0]&.strip

    if first_line.nil? || first_line =~ /^#{divider.strip}$/ || first_line.strip.empty?
      deleted = @content.delete_item(items[i], single: new_items.count == 1)
      Hooks.trigger :post_entry_removed, self, deleted
      Doing.logger.info('Deleted:', deleted.title)
    else
      date, title, note = format_input(new_item)

      note.map!(&:strip)
      note.delete_if(&:ignore?)
      item = items[i]
      old_item = item.dup
      item.date = date || items[i].date
      item.title = title
      item.note = note
      if (item.equal?(old_item))
        Doing.logger.count(:skipped, level: :debug)
      else
        Doing.logger.count(:updated)
        Hooks.trigger :post_entry_updated, self, item
      end
    end
  end
end

#edit_last(section: 'All', options: {}) ⇒ Object

Edit the last entry

Parameters:

  • section (String) (defaults to: 'All') —

    The section, default "All"



1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'lib/doing/wwid.rb', line 1354

def edit_last(section: 'All', options: {})
  options[:section] = guess_section(section)

  item = last_entry(options)

  if item.nil?
    logger.debug('Skipped:', 'No entries found')
    return
  end

  content = ["#{item.date.strftime('%F %R')} | #{item.title.dup}"]
  content << item.note.strip_lines.join("\n") unless item.note.empty?
  new_item = fork_editor(content.join("\n"))
  date, title, note = format_input(new_item)
  date ||= item.date

  if title.nil? || title.empty?
    logger.debug('Skipped:', 'No content provided')
  elsif title == item.title && note.equal?(item.note) && date.equal?(item.date)
    logger.debug('Skipped:', 'No change in content')
  else
    item.date = date unless date.nil?
    item.title = title
    item.note.add(note, replace: true)
    logger.info('Edited:', item.title)
    Hooks.trigger :post_entry_updated, self, item.dup

    write(@doing_file)
  end
end

#filter_items(items = Items.new, opt: {}) ⇒ Object

Filter items based on search criteria

Parameters:

  • items (Array) (defaults to: Items.new) —

    The items to filter (if empty, filters all items)

  • opt (Hash) (defaults to: {}) —

    The filter parameters

Options Hash (opt:):

  • :section (String) — default: 'all'
  • :unfinished (Boolean) — default: false
  • :tag (Array or String) — default: [] —

    Array or comma-separated string

  • :tag_bool (Symbol) — default: :and —

    :and, :or, :not

  • :search (String) — default: '' —

    string, optional regex with /string/

  • :date_filter (Array) — default: nil —

    [[Time]start, [Time]end]

  • :only_timed (Boolean) — default: false
  • :before (String) — default: nil —

    Date/Time string, unparsed

  • :after (String) — default: nil —

    Date/Time string, unparsed

  • :today (Boolean) — default: false —

    limit to entries from today

  • :yesterday (Boolean) — default: false —

    limit to entries from yesterday

  • :count (Number) — default: 0 —

    max entries to return

  • :age (String) — default: new —

    'old' or 'new'

  • :val (Array) — default: nil —

    Array of tag value queries



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/doing/wwid.rb', line 649

def filter_items(items = Items.new, opt: {})
  time_rx = /^(\d{1,2}+(:\d{1,2}+)?( *(am|pm))?|midnight|noon)$/

  if items.nil? || items.empty?
    section = opt[:section] ? guess_section(opt[:section]) : 'All'
    items = section =~ /^all$/i ? @content.dup : @content.in_section(section)
  end

  opt[:time_filter] = [nil, nil]
  if opt[:from] && !opt[:date_filter]
    if opt[:from][0].is_a?(String) && opt[:from][0] =~ time_rx
      opt[:time_filter] = opt[:from]
    elsif opt[:from][0].is_a?(Time)
      opt[:date_filter] = opt[:from]
    end
  end

  if opt[:before].is_a?(String) && opt[:before] =~ time_rx
    opt[:time_filter][1] = opt[:before]
    opt[:before] = nil
  end

  if opt[:after].is_a?(String) && opt[:after] =~ time_rx
    opt[:time_filter][0] = opt[:after]
    opt[:after] = nil
  end

  items.sort_by! { |item| [item.date, item.title.downcase] }.reverse

  filtered_items = items.select do |item|
    keep = true
    if opt[:unfinished]
      finished = item.tags?('done', :and)
      finished = opt[:not] ? !finished : finished
      keep = false if finished
    end

    if keep && opt[:val]&.count&.positive?
      bool = opt[:bool].normalize_bool if opt[:bool]
      bool ||= :and
      bool = :and if bool == :pattern

      val_match = opt[:val].nil? || opt[:val].empty? ? true : item.tag_values?(opt[:val], bool)
      keep = false unless val_match
      keep = opt[:not] ? !keep : keep
    end

    if keep && opt[:tag]
      opt[:tag_bool] = opt[:bool].normalize_bool if opt[:bool]
      opt[:tag_bool] ||= :and
      tag_match = opt[:tag].nil? || opt[:tag].empty? ? true : item.tags?(opt[:tag], opt[:tag_bool])
      keep = false unless tag_match
      keep = opt[:not] ? !keep : keep
    end

    if keep && opt[:search]
      search_match = if opt[:search].nil? || opt[:search].empty?
                       true
                     else
                       item.search(opt[:search], case_type: opt[:case].normalize_case)
                     end

      keep = false unless search_match
      keep = opt[:not] ? !keep : keep
    end

    if keep && opt[:date_filter]&.length == 2
      start_date = opt[:date_filter][0]
      end_date = opt[:date_filter][1]

      in_date_range = if end_date
                        item.date >= start_date && item.date <= end_date
                      else
                        item.date.strftime('%F') == start_date.strftime('%F')
                      end
      keep = false unless in_date_range
      keep = opt[:not] ? !keep : keep
    end

    if keep && opt[:time_filter][0] || opt[:time_filter][1]
      start_string = if opt[:time_filter][0].nil?
                       "#{item.date.strftime('%Y-%m-%d')} 12am"
                     else
                       "#{item.date.strftime('%Y-%m-%d')} #{opt[:time_filter][0]}"
                     end
      start_time = start_string.chronify(guess: :begin)

      end_string = if opt[:time_filter][1].nil?
                     "#{item.date.to_datetime.next_day.strftime('%Y-%m-%d')} 12am"
                   else
                     "#{item.date.strftime('%Y-%m-%d')} #{opt[:time_filter][1]}"
                   end
      end_time = end_string.chronify(guess: :end)

      in_time_range = item.date >= start_time && item.date <= end_time
      keep = false unless in_time_range
      keep = opt[:not] ? !keep : keep
    end

    keep = false if keep && opt[:only_timed] && !item.interval

    if keep && opt[:tag_filter]
      keep = item.tags?(opt[:tag_filter]['tags'], opt[:tag_filter]['bool'])
      keep = opt[:not] ? !keep : keep
    end

    if keep && opt[:before]
      before = opt[:before]
      if before =~ time_rx
        cutoff = "#{item.date.strftime('%Y-%m-%d')} #{before}".chronify(guess: :begin)
      elsif before.is_a?(String)
        cutoff = before.chronify(guess: :begin)
      else
        cutoff = before
      end
      keep = cutoff && item.date <= cutoff
      keep = opt[:not] ? !keep : keep
    end

    if keep && opt[:after]
      after = opt[:after]
      if after =~ time_rx
        cutoff = "#{item.date.strftime('%Y-%m-%d')} #{after}".chronify(guess: :end)
      elsif after.is_a?(String)
        cutoff = after.chronify(guess: :end)
      else
        cutoff = after
      end
      keep = cutoff && item.date >= cutoff
      keep = opt[:not] ? !keep : keep
    end

    if keep && opt[:today]
      keep = item.date >= Date.today.to_time && item.date < Date.today.next_day.to_time
      keep = opt[:not] ? !keep : keep
    elsif keep && opt[:yesterday]
      keep = item.date >= Date.today.prev_day.to_time && item.date < Date.today.to_time
      keep = opt[:not] ? !keep : keep
    end

    keep
  end
  count = opt[:count].to_i&.positive? ? opt[:count].to_i : filtered_items.count

  output = Items.new

  if opt[:age] && opt[:age].normalize_age == :oldest
    output.concat(filtered_items.slice(0, count).reverse)
  else
    output.concat(filtered_items.reverse.slice(0, count))
  end

  output
end

#fork_editor(input = '', message: :default) ⇒ Object

Create a process for an editor and wait for the file handle to return

Parameters:

  • input (String) (defaults to: '') —

    Text input for editor

Raises:

  • (MissingEditor) 


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/doing/wwid.rb', line 129

def fork_editor(input = '', message: :default)
  # raise NonInteractive, 'Non-interactive terminal' unless $stdout.isatty || ENV['DOING_EDITOR_TEST']

  raise MissingEditor, 'No EDITOR variable defined in environment' if Util.default_editor.nil?

  tmpfile = Tempfile.new(['doing', '.md'])

  File.open(tmpfile.path, 'w+') do |f|
    f.puts input
    unless message.nil?
      f.puts message == :default ? "# The first line is the entry title, any lines after that are added as a note" : message
    end
  end

  pid = Process.fork { system("#{Util.editor_with_args} #{tmpfile.path}") }

  trap('INT') do
    begin
      Process.kill(9, pid)
    rescue StandardError
      Errno::ESRCH
    end
    tmpfile.unlink
    tmpfile.close!
    exit 0
  end

  Process.wait(pid)

  begin
    if $?.exitstatus == 0
      input = IO.read(tmpfile.path)
    else
      exit_now! 'Cancelled'
    end
  ensure
    tmpfile.close
    tmpfile.unlink
  end

  input.split(/\n/).delete_if(&:ignore?).join("\n")
end

#format_input(input) ⇒ Array

Takes a multi-line string and formats it as an entry

Parameters:

  • input (String) —

    The string to parse

Returns:

  • (Array) —

    [[String]title, [Note]note]

Raises:

  • (EmptyInput) 


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/doing/wwid.rb', line 179

def format_input(input)
  raise EmptyInput, 'No content in entry' if input.nil? || input.strip.empty?

  input_lines = input.split(/[\n\r]+/).delete_if(&:ignore?)
  title = input_lines[0]&.strip
  raise EmptyInput, 'No content in first line' if title.nil? || title.strip.empty?

  date = nil
  iso_rx = /\d{4}-\d\d-\d\d \d\d:\d\d/
  date_rx = /^(?:\s*- )?(?<date>.*?) \| (?=\S)/

  raise EmptyInput, 'No content' if title.sub(/^.*?\| */, '').strip.empty?

  title.expand_date_tags(@config['date_tags'])

  if title =~ date_rx
    m = title.match(date_rx)
    d = m['date']
    date = if d =~ iso_rx
             Time.parse(d)
           else
             d.chronify(guess: :begin)
           end
    title.sub!(date_rx, '').strip!
  end

  note = Note.new
  note.add(input_lines[1..-1]) if input_lines.length > 1
  # If title line ends in a parenthetical, use that as the note
  if note.empty? && title =~ /\s+\(.*?\)$/
    title.sub!(/\s+\((?<note>.*?)\)$/) do
      m = Regexp.last_match
      note.add(m['note'])
      ''
    end
  end

  note.strip_lines!
  note.compress

  [date, title, note]
end

#fuzzy_filter_items(items, opt: {}) ⇒ Object 



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/doing/wwid.rb', line 599

def fuzzy_filter_items(items, opt: {})
  scannable = items.map.with_index { |item, idx| "#{item.title} #{item.note.join(' ')}".gsub(/[|*?!]/, '') + "|#{idx}"  }.join("\n")

  fzf_args = [
    '--multi',
    %(--filter="#{opt[:search].sub(/^'?/, "'")}"),
    '--no-sort',
    '-d "\|"',
    '--nth=1'
  ]
  if opt[:case]
    fzf_args << case opt[:case].normalize_case
                when :sensitive
                  '+i'
                when :ignore
                  '-i'
                end
  end
  # fzf_args << '-e' if opt[:exact]
  # puts fzf_args.join(' ')
  res = `echo #{Shellwords.escape(scannable)}|#{Prompt.fzf} #{fzf_args.join(' ')}`
  selected = Items.new
  res.split(/\n/).each do |item|
    idx = item.match(/\|(\d+)$/)[1].to_i
    selected.push(items[idx])
  end
  selected
end

#get_diff(filename = nil) ⇒ Object

Raises:

  • (DoingRuntimeError) 


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/doing/wwid.rb', line 2200

def get_diff(filename = nil)
  configure if @config.nil?

  filename ||= @config['doing_file']
  init_doing_file(filename)
  current_content = @content.dup
  backup_file = Util::Backup.last_backup(filename, count: 1)
  raise DoingRuntimeError, 'No undo history to diff' if backup_file.nil?

  backup = WWID.new
  backup.config = @config
  backup.init_doing_file(backup_file)
  current_content.diff(backup.content)
end

#get_interval(item, formatted: true, record: true) ⇒ Object

Gets the interval between entry's start date and @done date

Parameters:

  • item (Item) —

    The entry

  • formatted (Boolean) (defaults to: true) —

    Return human readable time (default seconds)

  • record (Boolean) (defaults to: true) —

    Add the interval to the total for each tag

Returns:

  • Interval in seconds, or [d, h, m] array if formatted is true. False if no end date or interval is 0



2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
 
# File 'lib/doing/wwid.rb', line 2166

def get_interval(item, formatted: true, record: true)
  if item.interval
    seconds = item.interval
    record_tag_times(item, seconds) if record
    return seconds.positive? ? seconds : false unless formatted

    return seconds.positive? ? seconds.time_string(format: :clock) : false
  end

  false
end

#get_view(title) ⇒ Object

Gets a view from configuration

Parameters:

  • title (String) —

    The title of the view to retrieve



1589
1590
1591
1592
1593
 
# File 'lib/doing/wwid.rb', line 1589

def get_view(title)
  return @config['views'][title] if @config['views'].has_key?(title)

  false
end

#guess_section(frag, guessed: false, suggest: false) ⇒ Object

Attempt to match a string with an existing section

Parameters:

  • frag (String) —

    The user-provided string

  • guessed (Boolean) (defaults to: false) —

    already guessed and failed



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/doing/wwid.rb', line 237

def guess_section(frag, guessed: false, suggest: false)
  return 'All' if frag =~ /^all$/i
  frag ||= @config['current_section']

  return frag.cap_first if @content.section?(frag)

  section = nil
  re = frag.to_rx(distance: 2, case_type: :ignore)
  sections.each do |sect|
    next unless sect =~ /#{re}/i

    logger.debug('Match:', %(Assuming "#{sect}" from "#{frag}"))
    section = sect
    break
  end

  return section if suggest

  unless section || guessed
    alt = guess_view(frag, guessed: true, suggest: true)
    if alt
      meant_view = Prompt.yn("#{boldwhite("Did you mean")} `#{yellow("doing view #{alt}")}#{boldwhite}`?", default_response: 'n')

      raise WrongCommand.new("run again with #{"doing view #{alt}".boldwhite}", topic: 'Try again:') if meant_view

    end

    res = Prompt.yn("#{boldwhite}Section #{frag.yellow}#{boldwhite} not found, create it", default_response: 'n')

    if res
      @content.add_section(frag.cap_first, log: true)
      write(@doing_file)
      return frag.cap_first
    end

    raise InvalidSection.new("unknown section #{frag.bold.white}", topic: 'Missing:')
  end
  section ? section.cap_first : guessed
end

#guess_view(frag, guessed: false, suggest: false) ⇒ Object

Attempt to match a string with an existing view

Parameters:

  • frag (String) —

    The user-provided string

  • guessed (Boolean) (defaults to: false) —

    already guessed



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/doing/wwid.rb', line 283

def guess_view(frag, guessed: false, suggest: false)
  views.each { |view| return view if frag.downcase == view.downcase }
  view = false
  re = frag.to_rx(distance: 2, case_type: :ignore)
  views.each do |v|
    next unless v =~ /#{re}/i

    logger.debug('Match:', %(Assuming "#{v}" from "#{frag}"))
    view = v
    break
  end
  unless view || guessed
    alt = guess_section(frag, guessed: true, suggest: true)

    raise InvalidView.new(%(unknown view #{frag.bold.white}), topic: 'Missing:') unless alt

    meant_view = Prompt.yn("Did you mean `doing show #{alt}`?", default_response: 'n')

    raise WrongCommand.new("run again with #{"doing show #{alt}".yellow}", topic: 'Try again:') if meant_view

    raise InvalidView.new(%(unknown view #{alt.bold.white}), topic: 'Missing:')
  end
  view
end

#import(paths, opt) ⇒ Object

Imports external entries

Parameters:

  • paths (String) —

    Path to JSON report file

  • opt (Hash) —

    Additional Options



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/doing/wwid.rb', line 414

def import(paths, opt)
  opt ||= {}
  Plugins.plugins[:import].each do |_, options|
    next unless opt[:type] =~ /^(#{options[:trigger].normalize_trigger})$/i

    if paths.count.positive?
      paths.each do |path|
        options[:class].import(self, path, options: opt)
      end
    else
      options[:class].import(self, nil, options: opt)
    end
    break
  end
end

#init_doing_file(path = nil) ⇒ Object

Initializes the doing file.

Parameters:

  • path (String) (defaults to: nil) —

    Override path to a doing file, optional



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/doing/wwid.rb', line 50

def init_doing_file(path = nil)
  @doing_file =  File.expand_path(@config['doing_file'])

  if path.nil?
    create(@doing_file) unless File.exist?(@doing_file)
    input = IO.read(@doing_file)
    input = input.force_encoding('utf-8') if input.respond_to? :force_encoding
    logger.debug('Read:', "read file #{@doing_file}")
  elsif File.exist?(File.expand_path(path)) && File.file?(File.expand_path(path)) && File.stat(File.expand_path(path)).size.positive?
    @doing_file = File.expand_path(path)
    input = IO.read(File.expand_path(path))
    input = input.force_encoding('utf-8') if input.respond_to? :force_encoding
    logger.debug('Read:', "read file #{File.expand_path(path)}")
  elsif path.length < 256
    @doing_file = File.expand_path(path)
    create(path)
    input = IO.read(File.expand_path(path))
    input = input.force_encoding('utf-8') if input.respond_to? :force_encoding
    logger.debug('Read:', "read file #{File.expand_path(path)}")
  end

  @other_content_top = []
  @other_content_bottom = []

  section = nil
  lines = input.split(/[\n\r]/)

  lines.each do |line|
    next if line =~ /^\s*$/

    if line =~ /^(\S[\S ]+):\s*(@\S+\s*)*$/
      section = Regexp.last_match(1)
      @content.add_section(Section.new(section, original: line), log: false)
    elsif line =~ /^\s*- (\d{4}-\d\d-\d\d \d\d:\d\d) \| (.*)/
      if section.nil?
        section = 'Uncategorized'
        @content.add_section(Section.new(section, original: 'Uncategorized:'), log: false)
      end

      date = Regexp.last_match(1).strip
      title = Regexp.last_match(2).strip
      item = Item.new(date, title, section)
      @content.push(item)
    elsif @content.count.zero?
      # if content[section].items.length - 1 == current
      @other_content_top.push(line)
    elsif line =~ /^\S/
      @other_content_bottom.push(line)
    else
      prev_item = @content.last
      prev_item.note = Note.new unless prev_item.note

      prev_item.note.add(line)
      # end
    end
  end

  Hooks.trigger :post_read, self
end

#interactive(opt) ⇒ Object

Display an interactive menu of entries

Options hash is shared with #filter_items and #act_on

Parameters:

  • opt (Hash) —

    Additional options

Raises:

  • (NoResults) 


871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/doing/wwid.rb', line 871

def interactive(opt)
  opt ||= {}
  opt[:section] = opt[:section] ? guess_section(opt[:section]) : 'All'

  search = nil

  if opt[:search]
    search = opt[:search]
    search.sub!(/^'?/, "'") if opt[:exact]
    opt[:search] = search
  end

  # opt[:query] = opt[:search] if opt[:search] && !opt[:query]
  opt[:query] = "!#{opt[:query]}" if opt[:query] && opt[:not]
  opt[:multiple] = true
  opt[:show_if_single] = true
  filter_options = %i[after before case date_filter from fuzzy not search section val].each_with_object({}) {
    |k, hsh| hsh[k] = opt[k]
  }
  items = filter_items(Items.new, opt: filter_options)

  menu_options = %i[search query exact multiple show_if_single menu sort case].each_with_object({}) {
    |k, hsh| hsh[k] = opt[k]
  }

  selection = Prompt.choose_from_items(items, include_section: opt[:section] =~ /^all$/i, **menu_options)

  raise NoResults, 'no items selected' if selection.nil? || selection.empty?

  act_on(selection, opt)
end

#last(times: true, section: nil, options: {}) ⇒ Object

Show the last entry

Parameters:

  • times (Bool) (defaults to: true) —

    Show times

  • section (String) (defaults to: nil) —

    Section to pull from, default Currently



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
 
# File 'lib/doing/wwid.rb', line 1873

def last(times: true, section: nil, options: {})
  section = section.nil? || section =~ /all/i ? 'All' : guess_section(section)
  cfg = @config['templates'][options[:config_template]].deep_merge(@config['templates']['default'], { extend_existing_arrays: true, sort_merged_arrays: true }).deep_merge({
    'wrap_width' => @config['wrap_width'] || 0,
    'date_format' => @config['default_date_format'],
    'order' => @config['order'] || 'asc',
    'tags_color' => @config['tags_color'],
    'duration' => @config['duration'],
    'interval_format' => @config['interval_format']
  }, { extend_existing_arrays: true, sort_merged_arrays: true })
  options[:duration] ||= cfg['duration'] || false
  options[:interval_format] ||= cfg['interval_format'] || 'text'

  opts = {
    case: options[:case],
    config_template: 'last',
    count: 1,
    delete: options[:delete],
    duration: options[:duration],
    format: cfg['date_format'],
    interval_format: options[:interval_format],
    not: options[:negate],
    section: section,
    template: options[:template] || cfg['template'],
    times: times,
    val: options[:val],
    wrap_width: cfg['wrap_width']
  }

  if options[:tag]
    opts[:tag_filter] = {
      'tags' => options[:tag],
      'bool' => options[:tag_bool]
    }
  end

  opts[:search] = options[:search] if options[:search]

  list_section(opts)
end

#last_entry(opt) ⇒ Object

Get the last entry

Parameters:

  • opt (Hash) —

    Additional Options



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/doing/wwid.rb', line 541

def last_entry(opt)
  opt ||= {}
  opt[:tag_bool] ||= :and
  opt[:section] ||= @config['current_section']

  items = filter_items(Items.new, opt: opt)

  logger.debug('Filtered:', "Parameters matched #{items.count} entries")

  if opt[:interactive]
    last_entry = Prompt.choose_from_items(items, include_section: opt[:section] =~ /^all$/i,
      menu: true,
      header: '',
      prompt: 'Select an entry > ',
      multiple: false,
      sort: false,
      show_if_single: true
     )
  else
    last_entry = items.max_by { |item| item.date }
  end

  last_entry
end

#last_note(section = 'All') ⇒ Object

Return the content of the last note for a given section

Parameters:

  • section (String) (defaults to: 'All') —

    The section to retrieve from, default All

Raises:

  • (NoEntryError) 


436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/doing/wwid.rb', line 436

def last_note(section = 'All')
  section = guess_section(section)

  last_item = last_entry({ section: section })

  raise NoEntryError, 'No entry found' unless last_item

  logger.log_now(:info, 'Edit note:', last_item.title)

  note = last_item.note&.to_s || ''
  "#{last_item.title}\n# EDIT BELOW THIS LINE ------------\n#{note}"
end

#list_date(dates, section, times = nil, output = nil, opt) ⇒ Object

Display entries within a date range

Parameters:

  • dates (Array) —

    [start, end]

  • section (String) —

    The section

  • times (Bool) (defaults to: nil) —

    Show times

  • output (String) (defaults to: nil) —

    Output format

  • opt (Hash) —

    Additional Options



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'lib/doing/wwid.rb', line 1768

def list_date(dates, section, times = nil, output = nil, opt)
  opt ||= {}
  opt[:totals] ||= false
  opt[:sort_tags] ||= false
  section = guess_section(section)
  # :date_filter expects an array with start and end date
  dates = dates.split_date_range if dates.instance_of?(String)

  list_section({
                 section: section,
                 count: 0,
                 order: 'asc',
                 date_filter: dates,
                 times: times,
                 output: output,
                 totals: opt[:totals],
                 duration: opt[:duration],
                 sort_tags: opt[:sort_tags],
                 template: opt[:template],
                 config_template: opt[:config_template]
               })
end

#list_section(opt, items: Items.new) ⇒ Object

Display contents of a section based on options

Parameters:

  • opt (Hash) —

    Additional Options



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
 
# File 'lib/doing/wwid.rb', line 1600

def list_section(opt, items: Items.new)
  opt[:config_template] ||= 'default'

  tpl_cfg = @config.dig('templates', opt[:config_template])

  cfg = if opt[:view_template]
          @config.dig('views', opt[:view_template]).deep_merge(tpl_cfg, { extend_existing_arrays: true, sort_merged_arrays: true })
        else
          tpl_cfg
        end

  cfg.deep_merge({
                   'wrap_width' => @config['wrap_width'] || 0,
                   'date_format' => @config['default_date_format'],
                   'order' => @config['order'] || 'asc',
                   'tags_color' => @config['tags_color'],
                   'duration' => @config['duration'],
                   'interval_format' => @config['interval_format']
                 }, { extend_existing_arrays: true, sort_merged_arrays: true })

  opt[:duration] ||= cfg['duration'] || false
  opt[:interval_format] ||= cfg['interval_format'] || 'text'
  opt[:count] ||= 0
  opt[:age] ||= :newest
  opt[:age] = opt[:age].normalize_age
  opt[:format] ||= cfg['date_format']
  opt[:order] ||= cfg['order'] || 'asc'
  opt[:tag_order] ||= 'asc'
  opt[:tags_color] = cfg['tags_color'] || false if opt[:tags_color].nil?
  opt[:template] ||= cfg['template']

  # opt[:highlight] ||= true
  title = ''
  is_single = true
  if opt[:section].nil?
    opt[:section] = choose_section
    title = opt[:section]
  elsif opt[:section].instance_of?(String)
    title = if opt[:section] =~ /^all$/i
              if opt[:page_title]
                opt[:page_title]
              elsif opt[:tag_filter] && opt[:tag_filter]['bool'].normalize_bool != :not
                opt[:tag_filter]['tags'].map { |tag| "@#{tag}" }.join(' + ')
              else
                'doing'
              end
            else
              guess_section(opt[:section])
            end
  end

  items = filter_items(items, opt: opt)

  items.reverse! unless opt[:order] =~ /^d/i

  if opt[:delete]
    delete_items(items, force: opt[:force])
    return
  elsif opt[:editor]
    edit_items(items)
    return
  elsif opt[:interactive]
    opt[:menu] = !opt[:force]
    opt[:query] = '' # opt[:search]
    opt[:multiple] = true
    selected = Prompt.choose_from_items(items.reverse, include_section: opt[:section] =~ /^all$/i, **opt)

    raise NoResults, 'no items selected' if selected.nil? || selected.empty?

    act_on(selected, opt)
    return
  end

  opt[:output] ||= 'template'
  opt[:wrap_width] ||= @config['templates']['default']['wrap_width'] || 0

  output(items, title, is_single, opt)
end

#logger ⇒ Object

Logger

Responds to :debug, :info, :warn, and :error

Each method takes a topic, and a message or block

Example: debug('Hooks', 'Hook 1 triggered')



41
42
43
 
# File 'lib/doing/wwid.rb', line 41

def logger
  @logger ||= Doing.logger
end

#next_item(item, options = {}) ⇒ Item

Get next item in the index

Parameters:

  • item (Item) —

    target item

  • options (Hash) (defaults to: {}) —

    additional options

Returns:

  • (Item) —

    the next chronological item in the index

See Also:



1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/doing/wwid.rb', line 1340

def next_item(item, options = {})
  options ||= {}
  items = filter_items(Items.new, opt: options)

  idx = items.index(item)

  idx.positive? ? items[idx - 1] : nil
end

#recent(count = 10, section = nil, opt) ⇒ Object

Show recent entries

Parameters:

  • count (Integer) (defaults to: 10) —

    The number to show

  • section (String) (defaults to: nil) —

    The section to show from, default Currently

  • opt (Hash) —

    Additional Options



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/doing/wwid.rb', line 1836

def recent(count = 10, section = nil, opt)
  opt ||= {}
  times = opt[:t] || true
  opt[:totals] ||= false
  opt[:sort_tags] ||= false

  cfg = @config['templates'][opt[:config_template]].deep_merge(@config['templates']['default'], { extend_existing_arrays: true, sort_merged_arrays: true }).deep_merge({
    'wrap_width' => @config['wrap_width'] || 0,
    'date_format' => @config['default_date_format'],
    'order' => @config['order'] || 'asc',
    'tags_color' => @config['tags_color'],
    'duration' => @config['duration'],
    'interval_format' => @config['interval_format']
  }, { extend_existing_arrays: true, sort_merged_arrays: true })
  opt[:duration] ||= cfg['duration'] || false
  opt[:interval_format] ||= cfg['interval_format'] || 'text'

  section ||= @config['current_section']
  section = guess_section(section)

  opt[:section] = section
  opt[:wrap_width] = cfg['wrap_width']
  opt[:count] = count
  opt[:format] = cfg['date_format']
  opt[:template] = opt[:template] || cfg['template']
  opt[:order] = 'asc'
  opt[:times] = times

  list_section(opt)
end

#repeat_item(item, opt) ⇒ Object

Duplicate an item and add it as a new item

Parameters:

  • item (Item) —

    the item to duplicate

  • opt (Hash) —

    additional options

Options Hash (opt):

  • :editor (Boolean) —

    open new item in editor

  • :date (String) —

    set start date

  • :in (String) —

    add new item to section :in

  • :note (Note) —

    add note to new item

Returns:

  • nothing



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/doing/wwid.rb', line 475

def repeat_item(item, opt)
  opt ||= {}
  if item.should_finish?
    if item.should_time?
      finish_date = verify_duration(item.date, Time.now, title: item.title)
      item.title.tag!('done', value: finish_date.strftime('%F %R'))
    else
      item.title.tag!('done')
    end
    Hooks.trigger :post_entry_updated, self, item
  end

  # Remove @done tag
  title = item.title.sub(/\s*@done(\(.*?\))?/, '').chomp
  section = opt[:in].nil? ? item.section : guess_section(opt[:in])
  @auto_tag = false

  note = opt[:note] || Note.new

  if opt[:editor]
    start = opt[:date] ? opt[:date] : Time.now
    to_edit = "#{start.strftime('%F %R')} | #{title}"
    to_edit += "\n#{note.strip_lines.join("\n")}" unless note.empty?
    new_item = fork_editor(to_edit)
    date, title, note = format_input(new_item)

    opt[:date] = date unless date.nil?

    if title.nil? || title.empty?
      logger.warn('Skipped:', 'No content provided')
      return
    end
  end

  # @content.update_item(original, item)
  add_item(title, section, { note: note, back: opt[:date], timed: false })
end

#repeat_last(opt) ⇒ Object

Restart the last entry

Parameters:

  • opt (Hash) —

    Additional Options



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/doing/wwid.rb', line 518

def repeat_last(opt)
  opt ||= {}
  opt[:section] ||= 'all'
  opt[:section] = guess_section(opt[:section])
  opt[:note] ||= []
  opt[:tag] ||= []
  opt[:tag_bool] ||= :and

  last = last_entry(opt)
  if last.nil?
    logger.warn('Skipped:', 'No previous entry found')
    return
  end

  repeat_item(last, opt)
  write(@doing_file)
end

#reset_item(item, date: nil, resume: false) ⇒ Object

Reset start date to current time, optionally remove done tag (resume)

Parameters:

  • item (Item) —

    the item to reset/resume

  • resume (Boolean) (defaults to: false) —

    removing @done tag if true



455
456
457
458
459
460
461
 
# File 'lib/doing/wwid.rb', line 455

def reset_item(item, date: nil, resume: false)
  date ||= Time.now
  item.date = date
  item.tag('done', remove: true) if resume
  logger.info('Reset:', %(Reset #{resume ? 'and resumed ' : ''} "#{item.title}" in #{item.section}))
  item
end

#rotate(opt) ⇒ Object

Rename doing file with date and start fresh one



1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
 
# File 'lib/doing/wwid.rb', line 1470

def rotate(opt)
  opt ||= {}
  keep = opt[:keep] || 0
  tags = []
  tags.concat(opt[:tag].split(/ *, */).map { |t| t.sub(/^@/, '').strip }) if opt[:tag]
  bool  = opt[:bool] || :and
  sect = opt[:section] !~ /^all$/i ? guess_section(opt[:section]) : 'all'

  section = guess_section(sect)

  section_items = @content.in_section(section)
  max = section_items.count - keep.to_i

  counter = 0
  new_content = Items.new

  section_items.each do |item|
    break if counter >= max
    if opt[:before]
      time_string = opt[:before]
      cutoff = time_string.chronify(guess: :begin)
    end

    unless ((!tags.empty? && !item.tags?(tags, bool)) || (opt[:search] && !item.search(opt[:search].to_s)) || (opt[:before] && item.date >= cutoff))
      new_item = @content.delete(item)
      Hooks.trigger :post_entry_removed, self, item.dup
      raise DoingRuntimeError, "Error deleting item: #{item}" if new_item.nil?

      new_content.add_section(new_item.section, log: false)
      new_content.push(new_item)
      counter += 1
    end
  end

  if counter.positive?
    logger.count(:rotated,
                 level: :info,
                 count: counter,
                 message: "Rotated %count %items")
  else
    logger.info('Skipped:', 'No items were rotated')
  end

  write(@doing_file)

  file = @doing_file.sub(/(\.\w+)$/, "_#{Time.now.strftime('%Y-%m-%d')}\\1")
  if File.exist?(file)
    init_doing_file(file)
    @content.concat(new_content).uniq!
    logger.warn('File update:', "added entries to existing file: #{file}")
  else
    @content = new_content
    logger.warn('File update:', "created new file: #{file}")
  end

  write(file, backup: false)
end

#sections ⇒ Array

List sections

Returns:

  • (Array) —

    section titles



227
228
229
 
# File 'lib/doing/wwid.rb', line 227

def sections
  @content.section_titles
end

#stop_start(target_tag, opt) ⇒ Object

Accepts one tag and the raw text of a new item if the passed tag is on any item, it's replaced with @done. if new_item is not nil, it's tagged with the passed tag and inserted. This is for use where only one instance of a given tag should exist (@meanwhile)

Parameters:

  • target_tag (String) —

    Tag to replace

  • opt (Hash) —

    Additional Options

Options Hash (opt):

  • :section (String) —

    target section

  • :archive (Boolean) —

    archive old item

  • :back (Date) —

    backdate new item

  • :new_item (String) —

    content to use for new item

  • :note (Array) —

    note content for new item



1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
 
# File 'lib/doing/wwid.rb', line 1400

def stop_start(target_tag, opt)
  opt ||= {}
  tag = target_tag.dup
  opt[:section] ||= @config['current_section']
  opt[:archive] ||= false
  opt[:back] ||= Time.now
  opt[:new_item] ||= false
  opt[:note] ||= false

  opt[:section] = guess_section(opt[:section])

  tag.sub!(/^@/, '')

  found_items = 0

  @content.each_with_index do |item, i|
    next unless item.section == opt[:section] || opt[:section] =~ /all/i

    next unless item.title =~ /@#{tag}/

    item.title.add_tags!([tag, 'done'], remove: true)
    item.tag('done', value: opt[:back].strftime('%F %R'))

    found_items += 1

    if opt[:archive] && opt[:section] != 'Archive'
      item.title = item.title.sub(/(?:@from\(.*?\))?(.*)$/, "\\1 @from(#{item.section})")
      item.move_to('Archive', label: false, log: false)
      logger.count(:completed_archived)
      logger.info('Completed/archived:', item.title)
    else
      logger.count(:completed)
      logger.info('Completed:', item.title)
    end
    Hooks.trigger :post_entry_updated, self, item
  end


  logger.debug('Skipped:', "No active @#{tag} tasks found.") if found_items.zero?

  if opt[:new_item]
    date, title, note = format_input(opt[:new_item])
    opt[:back] = date unless date.nil?
    note.add(opt[:note]) if opt[:note]
    title.tag!(tag)
    add_item(title.cap_first, opt[:section], { note: note, back: opt[:back] })
  end

  write(@doing_file)
end

#tag_groups(items, opt: {}) ⇒ Object 



587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/doing/wwid.rb', line 587

def tag_groups(items, opt: {})
  all_items = filter_items(items, opt: opt)
  tags = all_tags(all_items, opt: {})
  tag_groups = {}
  tags.each do |tag|
    tag_groups[tag] ||= []
    tag_groups[tag] = filter_items(all_items, opt: { tag: tag, tag_bool: :or })
  end

  tag_groups
end

#tag_last(opt) ⇒ Object

Tag the last entry or X entries

Parameters:

  • opt (Hash) —

    Additional Options (see

    filter_items for filtering

    options)

Raises:

  • (NoResults)

See Also:



1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
 
# File 'lib/doing/wwid.rb', line 1188

def tag_last(opt) # hooked
  opt ||= {}
  opt[:count] ||= 1
  opt[:archive] ||= false
  opt[:tags] ||= ['done']
  opt[:sequential] ||= false
  opt[:date] ||= false
  opt[:remove] ||= false
  opt[:autotag] ||= false
  opt[:back] ||= false
  opt[:unfinished] ||= false
  opt[:section] = opt[:section] ? guess_section(opt[:section]) : 'All'

  items = filter_items(Items.new, opt: opt)

  if opt[:interactive]
    items = Prompt.choose_from_items(items, include_section: opt[:section] =~ /^all$/i, menu: true,
                                header: '',
                                prompt: 'Select entries to tag > ',
                                multiple: true,
                                sort: true,
                                show_if_single: true)

    raise NoResults, 'no items selected' if items.empty?

  end

  raise NoResults, 'no items matched your search' if items.empty?

  if opt[:tags].empty? && !opt[:autotag]
    completions = opt[:remove] ? all_tags(items) : all_tags(@content)
    if opt[:remove]
      puts "#{yellow}Available tags: #{boldwhite}#{completions.map(&:add_at).join(', ')}"
    else
      puts "#{yellow}Use tab to complete known tags"
    end
    opt[:tags] = Doing::Prompt.read_line(prompt: "Enter tag(s) to #{opt[:remove] ? 'remove' : 'add'}",
                                         completions: completions,
                                         default_response: '').to_tags
    raise UserCancelled, 'No tags provided' if opt[:tags].empty?
  end

  items.each do |item|
    added = []
    removed = []

    if opt[:autotag]
      new_title = autotag(item.title) if @auto_tag
      if new_title == item.title
        logger.count(:skipped, level: :debug, message: '%count unchaged %items')
        # logger.debug('Autotag:', 'No changes')
      else
        logger.count(:added_tags)
        logger.write(items.count == 1 ? :info : :debug, 'Tagged:', new_title)
        item.title = new_title
      end
    else
      if opt[:sequential]
        next_entry = next_item(item)

        done_date = if next_entry.nil?
                      Time.now
                    else
                      next_entry.date - 60
                    end
      else
        done_date = item.calculate_end_date(opt)
      end

      opt[:tags].each do |tag|
        if tag == 'done' && !item.should_finish?

          Doing.logger.debug('Skipped:', "Item in never_finish: #{item.title}")
          logger.count(:skipped, level: :debug)
          next
        end


        tag = tag.strip

        if tag =~ /^done$/ && opt[:date] && item.should_time?
          max_elapsed = @config.dig('interaction', 'confirm_longer_than') || 0
          max_elapsed = max_elapsed.chronify_qty if max_elapsed.is_a?(String)
          elapsed = done_date - item.date

          if max_elapsed.positive? && (elapsed > max_elapsed) && !opt[:took]
            puts boldwhite(item.title)
            human = elapsed.time_string(format: :natural)
            res = Prompt.yn(yellow("Did this actually take #{human}"), default_response: true)
            unless res
              new_elapsed = Prompt.enter_text('How long did it take?').chronify_qty
              raise InvalidTimeExpression, 'Unrecognized time span entry' unless new_elapsed > 0

              opt[:took] = new_elapsed
              done_date = item.calculate_end_date(opt) if opt[:took]
            end
          end
        end

        if opt[:remove] || opt[:rename] || opt[:value]
          rename_to = nil
          if opt[:value]
            rename_to = tag
          elsif opt[:rename]
            rename_to = tag
            tag = opt[:rename]
          end
          old_title = item.title.dup
          force = opt[:value].nil? ? false : true
          item.title.tag!(tag, remove: opt[:remove], rename_to: rename_to, regex: opt[:regex], value: opt[:value], force: force)
          if old_title != item.title
            removed << tag
            added << rename_to if rename_to
          else
            logger.count(:skipped, level: :debug)
          end
        else
          old_title = item.title.dup
          should_date = opt[:date] && item.should_time?
          item.title.tag!('done', remove: true) if tag =~ /done/ && !should_date
          item.title.tag!(tag, value: should_date ? done_date.strftime('%F %R') : nil)
          added << tag if old_title != item.title
        end
      end
    end

    logger.log_change(tags_added: added, tags_removed: removed, item: item, single: items.count == 1)

    item.note.add(opt[:note]) if opt[:note]

    if opt[:archive] && opt[:section] != 'Archive' && (opt[:count]).positive?
      item.move_to('Archive', label: true)
    elsif opt[:archive] && opt[:count].zero?
      logger.warn('Skipped:', 'Archiving is skipped when operating on all entries')
    end

    item.expand_date_tags(@config['date_tags'])
    Hooks.trigger :post_entry_updated, self, item
  end

  write(@doing_file)
end

#tag_times(format: :text, sort_by_name: false, sort_order: 'asc') ⇒ Object

Get total elapsed time for all tags in selection

Parameters:

  • format (String) (defaults to: :text) —

    return format (html, json, or text)

  • sort_by_name (Boolean) (defaults to: false) —

    Sort by name if true, otherwise by time

  • sort_order (String) (defaults to: 'asc') —

    The sort order (asc or desc)



2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/doing/wwid.rb', line 2028

def tag_times(format: :text, sort_by_name: false, sort_order: 'asc')
  return '' if @timers.empty?

  max = @timers.keys.sort_by { |k| k.length }.reverse[0].length + 1

  total = @timers.delete('All')

  tags_data = @timers.delete_if { |_k, v| v == 0 }
  sorted_tags_data = if sort_by_name
                       tags_data.sort_by { |k, _v| k }
                     else
                       tags_data.sort_by { |_k, v| v }
                     end

  sorted_tags_data.reverse! if sort_order =~ /^asc/i
  case format
  when :html

    output = <<EOS
      <table>
      <caption id="tagtotals">Tag Totals</caption>
      <colgroup>
      <col style="text-align:left;"/>
      <col style="text-align:left;"/>
      </colgroup>
      <thead>
      <tr>
        <th style="text-align:left;">project</th>
        <th style="text-align:left;">time</th>
      </tr>
      </thead>
      <tbody>
EOS
    sorted_tags_data.reverse.each do |k, v|
      if v > 0
        output += "<tr><td style='text-align:left;'>#{k}</td><td style='text-align:left;'>#{v.time_string(format: :clock)}</td></tr>\n"
      end
    end
    tail = <<EOS
    <tr>
      <td style="text-align:left;" colspan="2"></td>
    </tr>
    </tbody>
    <tfoot>
    <tr>
      <td style="text-align:left;"><strong>Total</strong></td>
      <td style="text-align:left;">#{total.time_string(format: :clock)}</td>
    </tr>
    </tfoot>
    </table>
EOS
    output + tail
  when :markdown
    pad = sorted_tags_data.map {|k, v| k }.group_by(&:size).max.last[0].length
    pad = 7 if pad < 7
    output = <<~EOS
  | #{' ' * (pad - 7) }project | time     |
  | #{'-' * (pad - 1)}: | :------- |
    EOS
    sorted_tags_data.reverse.each do |k, v|
      if v > 0
        output += "| #{' ' * (pad - k.length)}#{k} | #{v.time_string(format: :clock)} |\n"
      end
    end
    tail = "[Tag Totals]"
    output + tail
  when :json
    output = []
    sorted_tags_data.reverse.each do |k, v|
      output << {
        'tag' => k,
        'seconds' => v,
        'formatted' => v.time_string(format: :clock)
      }
    end
    output
  when :human
    output = []
    sorted_tags_data.reverse.each do |k, v|
      spacer = ''
      (max - k.length).times do
        spacer += ' '
      end
      output.push("┃ #{spacer}#{k}:#{v.time_string(format: :hm)} ┃")
    end

    header = '┏━━ Tag Totals '
    (max - 2).times { header += '━' }
    header += '┓'
    footer = '┗'
    (max + 12).times { footer += '━' }
    footer += '┛'
    divider = '┣'
    (max + 12).times { divider += '━' }
    divider += '┫'
    output = output.empty? ? '' : "\n#{header}\n#{output.join("\n")}"
    output += "\n#{divider}"
    spacer = ''
    (max - 6).times do
      spacer += ' '
    end
    total_time = total.time_string(format: :hm)
    total = "┃ #{spacer}total: "
    total += total_time
    total += ' ┃'
    output += "\n#{total}"
    output += "\n#{footer}"
    output
  else
    output = []
    sorted_tags_data.reverse.each do |k, v|
      spacer = ''
      (max - k.length).times do
        spacer += ' '
      end
      output.push("#{k}:#{spacer}#{v.time_string(format: :clock)}")
    end

    output = output.empty? ? '' : "\n--- Tag Totals ---\n#{output.join("\n")}"
    output += "\n\nTotal tracked: #{total.time_string(format: :clock)}\n"
    output
  end
end

#today(times = true, output = nil, opt) ⇒ Object

Show all entries from the current day

Parameters:

  • times (Boolean) (defaults to: true) —

    show times

  • output (String) (defaults to: nil) —

    output format

  • opt (Hash) —

    Options



1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/doing/wwid.rb', line 1717

def today(times = true, output = nil, opt)
  opt ||= {}
  opt[:totals] ||= false
  opt[:sort_tags] ||= false

  cfg = @config['templates'][opt[:config_template]].deep_merge(@config['templates']['default'], { extend_existing_arrays: true, sort_merged_arrays: true }).deep_merge({
    'wrap_width' => @config['wrap_width'] || 0,
    'date_format' => @config['default_date_format'],
    'order' => @config['order'] || 'asc',
    'tags_color' => @config['tags_color'],
    'duration' => @config['duration'],
    'interval_format' => @config['interval_format']
  }, { extend_existing_arrays: true, sort_merged_arrays: true })

  template = opt[:template] || cfg['template']

  opt[:duration] ||= cfg['duration'] || false
  opt[:interval_format] ||= cfg['interval_format'] || 'text'

  options = {
    after: opt[:after],
    before: opt[:before],
    count: 0,
    duration: opt[:duration],
    from: opt[:from],
    format: cfg['date_format'],
    interval_format: opt[:interval_format],
    order: cfg['order'] || 'asc',
    output: output,
    section: opt[:section],
    sort_tags: opt[:sort_tags],
    template: template,
    times: times,
    today: true,
    totals: opt[:totals],
    wrap_width: cfg['wrap_width'],
    tags_color: cfg['tags_color'],
    config_template: opt[:config_template]
  }
  list_section(options)
end

#verify_duration(date, finish_date, title: nil) ⇒ Object 



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/doing/wwid.rb', line 1157

def verify_duration(date, finish_date, title: nil)
  max_elapsed = @config.dig('interaction', 'confirm_longer_than') || 0
  max_elapsed = max_elapsed.chronify_qty if max_elapsed.is_a?(String)
  date = date.chronify(guess: :end, context: :today) if finish_date.is_a?(String)

  elapsed = finish_date - date

  if max_elapsed.positive? && (elapsed > max_elapsed)
    puts boldwhite(title) if title
    human = elapsed.time_string(format: :natural)
    res = Prompt.yn(yellow("Did this entry actually take #{human}"), default_response: true)
    unless res
      new_elapsed = Prompt.enter_text('How long did it take?').chronify_qty
      raise InvalidTimeExpression, 'Unrecognized time span entry' unless new_elapsed.positive?

      finish_date = date + new_elapsed if new_elapsed
    end
  end

  finish_date
end

#views ⇒ Array

List available views

Returns:



1570
1571
1572
 
# File 'lib/doing/wwid.rb', line 1570

def views
  @config.has_key?('views') ? @config['views'].keys : []
end

#write(file = nil, backup: true) ⇒ Object

Write content to file or STDOUT

Parameters:

  • file (String) (defaults to: nil) —

    The filepath to write to



1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
 
# File 'lib/doing/wwid.rb', line 1456

def write(file = nil, backup: true)
  Hooks.trigger :pre_write, self, file
  output = combined_content
  if file.nil?
    $stdout.puts output
  else
    Util.write_to_file(file, output, backup: backup)
    run_after if @config.key?('run_after')
  end
end

#yesterday(section, times = nil, output = nil, opt) ⇒ Object

Show entries from the previous day

Parameters:

  • section (String) —

    The section

  • times (Bool) (defaults to: nil) —

    Show times

  • output (String) (defaults to: nil) —

    Output format

  • opt (Hash) —

    Additional Options



1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/doing/wwid.rb', line 1799

def yesterday(section, times = nil, output = nil, opt)
  opt ||= {}
  opt[:totals] ||= false
  opt[:sort_tags] ||= false
  section = guess_section(section)
  y = (Time.now - (60 * 60 * 24)).strftime('%Y-%m-%d')
  opt[:after] = "#{y} #{opt[:after]}" if opt[:after]
  opt[:before] = "#{y} #{opt[:before]}" if opt[:before]

  options = {
    after: opt[:after],
    before: opt[:before],
    count: 0,
    duration: opt[:duration],
    from: opt[:from],
    order: opt[:order],
    output: output,
    section: section,
    sort_tags: opt[:sort_tags],
    tag_order: opt[:tag_order],
    times: times,
    totals: opt[:totals],
    yesterday: true,
    config_template: opt[:config_template] || 'today',
    template: opt[:template]
  }

  list_section(options)
end