doing 1.0.93 → 2.0.6.pre

data/lib/doing/wwidfile.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Doing
+  class Items < Array
+    def from(path)
+      return [] unless path
+      path = File.expand_path(path)
+
+      if File.exist?(path) && File.file?(path) && File.stat(path).size.positive?
+        input = IO.read(File.expand_path(input))
+        input = input.force_encoding('utf-8') if input.respond_to? :force_encoding
+      end
+
+      section = 'Uncategorized'
+      lines = input.split(/[\n\r]/)
+      current = 0
+
+      lines.each do |line|
+        next if line =~ /^\s*$/
+
+        if line =~ /^(\S[\S ]+):\s*(@\S+\s*)*$/
+          section = Regexp.last_match(1)
+          @sections << { original: line, title: section }
+          current = 0
+        elsif line =~ /^\s*- (\d{4}-\d\d-\d\d \d\d:\d\d) \| (.*)/
+          date = Regexp.last_match(1).strip
+          title = Regexp.last_match(2).strip
+          item = Item.new(date, title, section)
+          @items.push(item)
+          current += 1
+        elsif current.zero?
+          # if content[section][:items].length - 1 == current
+          @other_content_top.push(line)
+        elsif line =~ /^\S/
+          @other_content_bottom.push(line)
+        else
+          prev_item = @items[current - 1]
+          prev_item.note = Note.new unless prev_item.note
+
+          prev_item.note.add(line)
+          # end
+        end
+      end
+      Hooks.trigger :post_read, self
+    end
+
+    def section_titles
+      @sections.map { |s| s[:title] }
+    end
+
+    ##
+    ## @brief      Adds a section.
+    ##
+    ## @param      title  (String) The new section title
+    ##
+    def add_section(title)
+      if section_titles.include?(title.cap_first)
+        Doing.logger.debug('Skipped': 'Section already exists')
+        return
+      end
+
+      @sections << { original: "#{title}:", title: title }
+      Doing.logger.info('Added section:', %("#{title.cap_first}"))
+    end
+
+    ##
+    ## @brief      Attempt to match a string with an existing section
+    ##
+    ## @param      frag     (String) The user-provided string
+    ## @param      guessed  (Boolean) already guessed and failed
+    ##
+    def guess_section(frag, guessed: false, suggest: false)
+      return 'All' if frag =~ /^all$/i
+      frag ||= wwid.config['current_section']
+
+      @sections.each { |sect| return sect[:title].cap_first if frag.downcase == sect[:title].downcase }
+
+      section = false
+      re = frag.split('').join('.*?')
+      sections.each do |sect|
+        next unless sect =~ /#{re}/i
+
+        Doing.logger.debug('Section match:', %(Assuming "#{sect}" from "#{frag}"))
+        section = sect
+        break
+      end
+
+      return section if suggest
+
+      unless section || guessed
+        alt = WWID.guess_view(frag, guessed: true, suggest: true)
+        if alt
+          meant_view = WWID.yn("Did you mean `doing view #{alt}`?", default_response: 'n')
+          raise Errors::InvalidSection, "Run again with `doing view #{alt}`" if meant_view
+        end
+
+        res = WWID.yn("Section #{frag} not found, create it", default_response: 'n')
+
+        if res
+          add_section(frag.cap_first)
+          WWID.write(@doing_file)
+          return frag.cap_first
+        end
+
+        raise Errors::InvalidSection, "Unknown section: #{frag}"
+      end
+      section ? section.cap_first : guessed
+    end
+
+    def section_items(section)
+      section = guess_section(section)
+      return @items if section =~ /all/i
+
+      @items.filter { |i| i.section == section }
+    end
+  end
+end

data/lib/doing.rb

@@ -1,4 +1,6 @@
-require 'doing/version.rb'
+# frozen_string_literal: true
+
+require 'doing/version'
 require 'time'
 require 'date'
 require 'yaml'
@@ -8,7 +10,45 @@ require 'tempfile'
 require 'chronic'
 require 'haml'
 require 'json'
-require 'doing/helpers'
-require 'doing/markdown_export'
+require 'logger'
+require 'safe_yaml/load'
+require 'doing/hash'
+require 'doing/colors'
+require 'doing/string'
+require 'doing/time'
+require 'doing/array'
+require 'doing/symbol'
+require 'doing/util'
+require 'doing/configuration'
+require 'doing/item'
+require 'doing/note'
+require 'doing/wwidfile'
 require 'doing/wwid'
+require 'doing/log_adapter'
+require 'doing/errors'
+require 'doing/hooks'
+require 'doing/plugin_manager'
+require 'doing/pager'
 # require 'doing/markdown_document_listener'
+
+# Main doing module
+module Doing
+  class << self
+    #
+    # @brief      Fetch the logger
+    #
+    # @return     the LogAdapter instance.
+    #
+    def logger
+      @logger ||= LogAdapter.new((ENV['DOING_LOG_LEVEL'] || :info).to_sym)
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def config_with(file, options = {})
+      @config = Configuration.new(file, options: options)
+    end
+  end
+end

data/lib/examples/commands/autotag.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Example command that calls an existing command (tag) with
+# preset options
+desc 'Autotag last entry or filtered entries'
+command :autotag do |c|
+  # Preserve some switches and flags. Values will be passed
+  # to tag command.
+  c.desc 'Section'
+  c.arg_name 'SECTION_NAME'
+  c.flag %i[s section], default_value: 'All'
+
+  c.desc 'How many recent entries to autotag (0 for all)'
+  c.arg_name 'COUNT'
+  c.flag %i[c count], default_value: 1, must_match: /^\d+$/, type: Integer
+
+  c.desc 'Don\'t ask permission to autotag all entries when count is 0'
+  c.switch %i[force], negatable: false, default_value: false
+
+  c.desc 'Autotag last entry (or entries) not marked @done'
+  c.switch %i[u unfinished], negatable: false, default_value: false
+
+  c.desc 'Autotag the last X entries containing TAG.
+  Separate multiple tags with comma (--tag=tag1,tag2), combine with --bool'
+  c.arg_name 'TAG'
+  c.flag [:tag]
+
+  c.desc 'Autotag entries matching search filter,
+  surround with slashes for regex (e.g. "/query.*/"),
+  start with single quote for exact match ("\'query")'
+  c.arg_name 'QUERY'
+  c.flag [:search]
+
+  c.desc 'Boolean (AND|OR|NOT) with which to combine multiple tag filters'
+  c.arg_name 'BOOLEAN'
+  c.flag [:bool], must_match: REGEX_BOOL, default_value: 'AND'
+
+  c.desc 'Select item(s) to tag from a menu of matching entries'
+  c.switch %i[i interactive], negatable: false, default_value: false
+
+  c.action do |global, options, _args|
+    # Force some switches and flags. We're using the tag
+    # command with settings that would invoke autotagging.
+
+    # Force enable autotag
+    options[:a] = true
+    options[:autotag] = true
+
+    # No need for date values
+    options[:d] = false
+    options[:date] = false
+
+    # Don't remove any tags
+    options[:rename] = nil
+    options[:regex] = false
+    options[:r] = false
+    options[:remove] = false
+
+    cmd = commands[:tag]
+    action = cmd.send(:get_action, nil)
+    action.call(global, options, [])
+  end
+end

data/lib/examples/commands/wiki.rb

@@ -0,0 +1,81 @@
+desc 'Output a tag wiki'
+command :wiki do |c|
+  c.desc 'Section to rotate'
+  c.arg_name 'SECTION_NAME'
+  c.flag %i[s section], default_value: 'All'
+
+  c.desc 'Tag filter, combine multiple tags with a comma, use with --bool'
+  c.arg_name 'TAG'
+  c.flag [:tag]
+
+  c.desc 'Tag boolean (AND,OR,NOT)'
+  c.arg_name 'BOOLEAN'
+  c.flag %i[b bool], must_match: REGEX_BOOL, default_value: 'OR'
+
+  c.desc 'Include entries older than date'
+  c.arg_name 'DATE_STRING'
+  c.flag [:before]
+
+  c.desc 'Include entries newer than date'
+  c.arg_name 'DATE_STRING'
+  c.flag [:after]
+
+  c.desc 'Search filter, surround with slashes for regex (/query/), start with single quote for exact match ("\'query")'
+  c.arg_name 'QUERY'
+  c.flag [:search]
+
+  c.desc %(
+    Date range to include, or a single day to filter date on.
+    Date range argument should be quoted. Date specifications can be natural language.
+    To specify a range, use "to" or "through": `doing show --from "monday to friday"`
+  )
+  c.arg_name 'DATE_OR_RANGE'
+  c.flag %i[f from]
+
+  c.desc 'Only show items with recorded time intervals'
+  c.switch [:only_timed], default_value: false, negatable: false
+
+  c.action do |global, options, args|
+    wwid = global[:wwid]
+    tags = wwid.tag_groups([], opt: options)
+
+    wiki = Doing::Plugins.plugins.dig(:export, 'wiki', :class)
+
+    tags.each do |tag, items|
+      export_options = { page_title: tag, is_single: false, options: options }
+
+      raise RuntimeError, 'Missing plugin "wiki"' unless wiki
+
+      out = wiki.render(wwid, items, variables: export_options)
+
+      if out
+        FileUtils.mkdir_p('doing_wiki')
+        File.open(File.join('doing_wiki', tag + '.html'), 'w') do |f|
+          f.puts out
+        end
+      end
+    end
+
+    template = if wwid.config['export_templates']['wiki_index'] && File.exist?(File.expand_path(wwid.config['export_templates']['wiki_index']))
+                 IO.read(File.expand_path(wwid.config['export_templates']['wiki_index']))
+               else
+                 wiki.template('wiki_index')
+               end
+    style = if wwid.config['export_templates']['wiki_css'] && File.exist?(File.expand_path(wwid.config['export_templates']['wiki_css']))
+              IO.read(File.expand_path(wwid.config['export_templates']['wiki_css']))
+            else
+              wiki.template('wiki_css')
+            end
+    tags_out = tags.map { |t| {url: "#{t}.html"} }
+    engine = Haml::Engine.new(template)
+    index_out = engine.render(Object.new,
+                       { :@tags => tags.each_with_object([]) { |(tag, items), arr| arr << { name: tag, count: items.count } }, :@page_title => "Tags wiki", :@style => style })
+
+    if index_out
+      File.open(File.join('doing_wiki', 'index.html'), 'w') do |f|
+        f.puts index_out
+      end
+      Doing.logger.warn("Wiki written to doing_wiki directory")
+    end
+  end
+end

data/lib/examples/plugins/hooks.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Doing
+  # Hooks.register :post_config do |wwid|
+  #   wwid.config['twizzle'] = 'Fo shizzle'
+  #   wwid.write_config(File.expand_path('~/Desktop/wwidconfig.yml'))
+  # end
+
+  # Hooks.register :post_read, priority: 10 do |wwid|
+  #   Doing.logger.warn('Hook 1:', 'triggered priority 10')
+  #   Doing.logger.warn('Hook 2:', wwid.config['twizzle'])
+  # end
+
+  # Hooks.register :post_read, priority: 100 do |wwid|
+  #   Doing.logger.warn('Hook 2:', 'triggered priority 100')
+  # end
+
+  Hooks.register :post_write do |filename|
+    res = `/bin/bash /Users/ttscoff/scripts/after_doing.sh`.strip
+    Doing.logger.debug('Hooks:', res) unless res =~ /^\.\.\.$/
+  end
+end

data/lib/examples/plugins/say_export.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+# title: Export plugin example
+# description: Speak the most recent entry (macOS)
+# author: Brett Terpstra
+# url: https://brettterpstra.com
+
+# Example
+#
+# doing show -o sayit
+#
+# ## Configuration
+#
+# Change what the plugin says by generating a template with
+# `doing template --type say`, saving it to a file, and
+# putting the path to that file in `export_templates->say` in
+# .doingrc.
+#
+# export_templates:
+#   say: /path/to/template.txt
+#
+# Use a different voice by adding a `say_voice` key to your
+# .doingrc. Use `say -v ?` to see available voices.
+#
+# say_voice: Zarvox
+
+module Doing
+  ##
+  ## @brief      Plugin class
+  ##
+  class SayExport
+    include Doing::Util
+
+    #-------------------------------------------------------
+    ## Plugin Settings. A plugin must have a self.settings
+    ## method that returns a hash with plugin settings.
+    ##
+    ## trigger:   (required) Regular expression to match
+    ## FORMAT when used with `--output FORMAT`. Registered
+    ## name of plugin must be able to match the trigger, but
+    ## alternatives can be included
+    ##
+    ## templates: (optional) Array of templates this plugin
+    ## can export (plugin must have :template method)
+    ##
+    ##   Each template is a hash containing:
+    ##               - name: display name for template
+    ##               - trigger: regular expression for
+    ##                 `template --type FORMAT`
+    ##
+    ##   If a template is included, a config key will
+    ##   automatically be added for the user to override
+    ##   The config key will be available at:
+    ##
+    ##       wwid.config['export_templates'][PLUGIN_NAME]
+    ##
+    ## config:    (optional) A Hash which will be
+    ## added to the main configuration in the plugins section.
+    ## Options defined here are included when config file is
+    ## created or updated with `config --update`. Use this to
+    ## add new configuration keys, not to override existing
+    ## ones.
+    ##
+    ##   The configuration keys will be available at:
+    ##
+    ##      wwid.config['plugins'][PLUGIN_NAME][KEY]
+    ##
+    ## @brief      Method to return plugin settings (required)
+    ##
+    ## @return     Hash of settings for this plugin
+    ##
+    def self.settings
+      {
+        trigger: 'say(?:it)?',
+        templates: [
+          { name: 'say', trigger: 'say(?:it)?' }
+        ],
+        config: {
+          'say_voice' => 'Fiona'
+        }
+      }
+    end
+
+
+    #-------------------------------------------------------
+    ## Output a template. Only required if template(s) are
+    ## included in settings. The method should return a
+    ## string (not output it to the STDOUT).
+    ##
+    ## @brief      Method to return template (optional)
+    ##
+    ## @param      trigger  The trigger passed to the
+    ##                      template function. When this
+    ##                      method defines multiple
+    ##                      templates, the trigger can be
+    ##                      used to determine which one is
+    ##                      output.
+    ##
+    ## @return     (String) template contents
+    ##
+    def self.template(trigger)
+      return unless trigger =~ /^say(it)?$/
+      'On %date, you were %title, recorded in section %section%took'
+    end
+
+
+    ##
+    ## @brief      Render data received from an output
+    ##             command
+    ##
+    ## @param      wwid       The wwid object with config
+    ##                        and public methods
+    ## @param      items      An array of items to be output
+    ##                        { <Date>date, <String>title,
+    ##                        <String>section, <Array>note }
+    ## @param      variables  Additional variables including
+    ##                        flags passed to command
+    ##                        (variables[:options])
+    ##
+    ## @return     (String) Rendered output
+    ##
+    def self.render(wwid, items, variables: {})
+      return if items.nil? || items.empty?
+
+      # the :options key includes the flags passed to the
+      # command that called the plugin use `puts
+      # variables.inspect` to see properties and methods
+      # when run
+      opt = variables[:options]
+
+      # This plugin just grabs the last item in the `items`
+      # list (which could be the oldest or newest, depending
+      # on the sort order of the command that called the
+      # plugin). Most of the time you'll want to use :each
+      # or :map to generate output.
+      i = items[-1]
+
+      # Format the item. Items are a hash with 3 keys: date,
+      # title, and section (parent section) Start time is in
+      # item.date. The wwid object has some methods for
+      # calculation and formatting, including
+      # wwid.item.end_date to convert the @done
+      # timestamp to an end date.
+      if opt[:times]
+        interval = i.interval
+
+        if interval
+          took = '. You finished on '
+          finished_at = i.end_date
+          took += finished_at.strftime('%A %B %e at %I:%M%p')
+
+          d, h, m = wwid.format_time(interval)
+          took += ' and it took'
+          took += " #{d.to_i} days" if d.to_i.positive?
+          took += " #{h.to_i} hours" if h.to_i.positive?
+          took += " #{m.to_i} minutes" if m.to_i.positive?
+        end
+      end
+
+      date = i.date.strftime('%A %B %e at %I:%M%p')
+      title = i.title.gsub(/ @done\(.*?\)/, '').gsub(/@/, 'hashtag ')
+      tpl = template('say')
+
+      if wwid.config['export_templates'].key?('say')
+        cfg_tpl = wwid.config['export_templates']['say']
+        tpl = cfg_tpl unless cfg_tpl.nil? || cfg_tpl.empty?
+      end
+      output = tpl.dup
+      output.gsub!(/%date/, date)
+      output.gsub!(/%title/, title)
+      output.gsub!(/%section/, i.section)
+      output.gsub!(/%took/, took || '')
+
+      # Debugging output
+      # warn "Saying: #{output}"
+
+      # To provide results on the command line after the
+      # command runs, add to the wwid.results array. Results
+      # are provided on STDERR unless doing is run with
+      # `--stdout`
+      Doing.logger.info('Spoke the last entry. Did you hear it?')
+
+      # This export runs a command for fun, most plugins won't
+      voice = wwid.config['plugins']['say']['say_voice'] || 'Alex'
+      `say -v "#{voice}" "#{output}"`
+
+      # Return the result (don't output to terminal with puts or print)
+      output
+    end
+
+    # Register the plugin with doing.
+    # Doing::Plugins.register 'NAME', TYPE, Class
+    #
+    # Name should be lowercase, no spaces
+    #
+    # TYPE is :import or :export
+    #
+    # Class is the plugin class (e.g. Doing::SayExport), or
+    # self if called within the class
+    Doing::Plugins.register 'say', :export, self
+  end
+end

data/lib/examples/plugins/templates/wiki.css

@@ -0,0 +1,169 @@
+body {
+  background: #fff;
+  color: #333;
+  font-family: Helvetica,arial,freesans,clean,sans-serif;
+  font-size: 21px;
+  line-height: 1.5;
+  text-align: justify;
+}
+
+@media only screen and (max-width: 900px) {
+  body {
+    font-size: calc(12px + 1vw);
+  }
+
+  .date,
+  .note {
+    font-size: calc(8px + 1vw)!important;
+  }
+}
+
+h1 {
+  margin-bottom: 1em;
+  margin-left: .1em;
+  position: relative;
+  text-align: left;
+}
+
+ul {
+  list-style-position: outside;
+  position: relative;
+  text-align: left;
+  padding-left: 0;
+}
+
+article > ul > li {
+  display: grid;
+  grid-template-columns: 14ch auto;
+  line-height: 1.2;
+  list-style-type: none;
+  padding-left: 10px;
+  position: relative;
+  word-break: break-word;
+  transition: background .2s ease-in-out;
+}
+
+article > ul > li:hover {
+  background: rgba(150,150,150,.05);
+}
+
+.date {
+  color: #7d9ca2;
+  font-size: 17px;
+  padding: 15px 1ch 0 0;
+  text-align: right;
+  white-space: nowrap;
+  transition: color .2s ease-in-out;
+}
+
+.entry {
+  border-left: solid 1px #ccc;
+  line-height: 1.2;
+  padding: 10px 10px 10px 3ch;
+  text-indent: -2ch;
+}
+
+.tag {
+  color: #999;
+  transition: color 1s ease-in;
+}
+
+.note {
+  color: #aaa;
+  display: block;
+  font-size: 17px;
+  line-height: 1.1;
+  padding: 1em 0 0 2ch;
+  position: relative;
+  transition: color .2s ease-in-out;
+}
+
+li:hover .note {
+  color: #777;
+}
+
+li:hover .tag {
+  color: rgb(182, 120, 125);
+}
+
+li:hover .date {
+  color: rgb(100, 169, 165);
+}
+
+.note li {
+    margin-bottom: .5em;
+    list-style: none;
+    position: relative;
+}
+
+.note li:before {
+  color: #ddd;
+  content: '\25BA';
+  font-size: 12px;
+  font-weight: 300;
+  left: -3ch;
+  position: absolute;
+  top: .25em;
+}
+
+.time {
+  background: #f9fced;
+  border-bottom: dashed 1px #ccc;
+  color: #729953;
+  font-size: 15px;
+  margin-right: 4px;
+  padding: 0 5px;
+  position: relative;
+  text-align: right;
+}
+
+table td {
+  border-bottom: solid 1px #ddd;
+  height: 24px;
+}
+
+caption {
+  border-bottom: solid 1px #aaa;
+  margin: 10px 0;
+  text-align: left;
+}
+
+table {
+  margin: 50px 0 0 211px;
+  width: 400px;
+}
+
+th {
+  padding-bottom: 10px;
+}
+
+th, td {
+  padding-right: 20px;
+}
+
+table {
+  margin: 50px 0 2em 16ch;
+  max-width: 400px;
+}
+
+.section {
+  border-left: solid 1px rgb(182, 120, 125);
+  border-radius: 25px;
+  border-right: solid 1px rgb(182, 120, 125);
+  color: rgb(182, 120, 125);
+  font-size: .8em;
+  line-height: 1 !important;
+  padding: 0 4px;
+  transition: background .4s ease-in, color .4s ease-in;
+}
+
+li:hover .section {
+  color: #fff;
+  background: rgb(182, 120, 125);
+}
+
+a:link {
+  background-color: rgba(203, 255, 251, .15);
+  color: #64a9a5;
+  text-decoration: none;
+}