doing 2.1.1pre → 2.1.5pre

data/lib/doing/note.rb

@@ -22,7 +22,7 @@ module Doing
     ## Add note contents, optionally replacing existing note
     ##
     ## @param      note     [Array] The note to add, can be
-    ##                      string or array (Note)
+    ##                      String, Array, or Note
     ## @param      replace  [Boolean] replace existing
     ##                      content
     ##
@@ -36,32 +36,7 @@ module Doing
     end
 
     ##
-    ## Append an array of strings to note
-    ##
-    ## @param      lines  [Array] Array of strings
-    ##
-    def append(lines)
-      concat(lines)
-      replace compress
-    end
-
-    ##
-    ## Append a string to the note content
-    ##
-    ## @param      input  [String] The input string,
-    ##                    newlines will be split
-    ##
-    def append_string(input)
-      concat(input.split(/\n/).map(&:strip))
-      replace compress
-    end
-
-    def compress!
-      replace compress
-    end
-
-    ##
-    ## Remove blank lines and comment lines (#)
+    ## Remove blank lines and comments (#)
     ##
     ## @return     [Array] compressed array
     ##
@@ -69,8 +44,8 @@ module Doing
       delete_if { |l| l =~ /^\s*$/ || l =~ /^#/ }
     end
 
-    def strip_lines!
-      replace strip_lines
+    def compress!
+      replace compress
     end
 
     ##
@@ -83,6 +58,10 @@ module Doing
       map(&:strip)
     end
 
+    def strip_lines!
+      replace strip_lines
+    end
+
     ##
     ## Note as multi-line string
     def to_s
@@ -101,11 +80,33 @@ module Doing
     ## @param      other  [Note] The other Note
     ##
     ## @return     [Boolean] true if equal
-    ##
     def equal?(other)
       return false unless other.is_a?(Note)
 
       to_s == other.to_s
     end
+
+    private
+
+    ##
+    ## Append an array of strings to note
+    ##
+    ## @param      lines  [Array] Array of strings
+    ##
+    def append(lines)
+      concat(lines)
+      replace compress
+    end
+
+    ##
+    ## Append a string to the note content
+    ##
+    ## @param      input  [String] The input string,
+    ##                    newlines will be split
+    ##
+    def append_string(input)
+      concat(input.split(/\n/).map(&:strip))
+      replace compress
+    end
   end
 end

data/lib/doing/phrase_parser.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'parslet'
+
+module PhraseParser
+  # This parser adds quoted phrases (using matched double quotes) in addition to
+  # terms. This is done creating multiple types of clauses instead of just one.
+  # A phrase clause generates an Elasticsearch match_phrase query.
+  class QueryParser < Parslet::Parser
+    rule(:term) { match('[^\s"]').repeat(1).as(:term) }
+    rule(:quote) { str('"') }
+    rule(:operator) { (str('+') | str('-')).as(:operator) }
+    rule(:phrase) do
+      (quote >> (term >> space.maybe).repeat >> quote).as(:phrase)
+    end
+    rule(:clause) { (operator.maybe >> (phrase | term)).as(:clause) }
+    rule(:space)  { match('\s').repeat(1) }
+    rule(:query) { (clause >> space.maybe).repeat.as(:query) }
+    root(:query)
+  end
+
+  class QueryTransformer < Parslet::Transform
+    rule(:clause => subtree(:clause)) do
+      if clause[:term]
+        TermClause.new(clause[:operator]&.to_s, clause[:term].to_s)
+      elsif clause[:phrase]
+        phrase = clause[:phrase].map { |p| p[:term].to_s }.join(' ')
+        PhraseClause.new(clause[:operator]&.to_s, phrase)
+      else
+        raise "Unexpected clause type: '#{clause}'"
+      end
+    end
+    rule(query: sequence(:clauses)) { Query.new(clauses) }
+  end
+
+  class Operator
+    def self.symbol(str)
+      case str
+      when '+'
+        :must
+      when '-'
+        :must_not
+      when nil
+        :should
+      else
+        raise "Unknown operator: #{str}"
+      end
+    end
+  end
+
+  class TermClause
+    attr_accessor :operator, :term
+
+    def initialize(operator, term)
+      self.operator = Operator.symbol(operator)
+      self.term = term
+    end
+  end
+
+  # Phrase
+  class PhraseClause
+    attr_accessor :operator, :phrase
+
+    def initialize(operator, phrase)
+      self.operator = Operator.symbol(operator)
+      self.phrase = phrase
+    end
+  end
+
+  ## Query object
+  class Query
+    attr_accessor :should_clauses, :must_not_clauses, :must_clauses
+
+    def initialize(clauses)
+      grouped = clauses.chunk(&:operator).to_h
+      self.should_clauses = grouped.fetch(:should, [])
+      self.must_not_clauses = grouped.fetch(:must_not, [])
+      self.must_clauses = grouped.fetch(:must, [])
+    end
+
+    def to_elasticsearch
+      query = {}
+
+      if should_clauses.any?
+        query[:should] = should_clauses.map do |clause|
+          clause_to_query(clause)
+        end
+      end
+
+      if must_clauses.any?
+        query[:must] = must_clauses.map do |clause|
+          clause_to_query(clause)
+        end
+      end
+
+      if must_not_clauses.any?
+        query[:must_not] = must_not_clauses.map do |clause|
+          clause_to_query(clause)
+        end
+      end
+
+      query
+    end
+
+    def clause_to_query(clause)
+      case clause
+      when TermClause
+        match(clause.term)
+      when PhraseClause
+        match_phrase(clause.phrase)
+      else
+        raise "Unknown clause type: #{clause}"
+      end
+    end
+
+    def match(term)
+      term
+    end
+
+    def match_phrase(phrase)
+      phrase
+    end
+  end
+end

data/lib/doing/plugin_manager.rb

@@ -28,26 +28,30 @@ module Doing
         plugins
       end
 
-      # Public: Setup the plugin search path
+      # Setup the plugin search path
+      #
+      # @param      add_dir  [String] optional additional
+      #                      path to include
+      #
+      # @return     [Array] Returns an Array of plugin search paths
       #
-      # Returns an Array of plugin search paths
       def plugins_path(add_dir = nil)
         paths = Array(File.join(File.dirname(__FILE__), 'plugins'))
         paths << File.join(add_dir) if add_dir
         paths.map { |d| File.expand_path(d) }
       end
 
-      ##
+
       # Register a plugin
       #
-      # param: +[String|Array]+ title  The name of the plugin (can be an array of names)
-      #
-      # param: +type+ The plugin type (:import, :export)
-      #
-      # param: +klass+ The class responding to :render or :import
+      # @param      title  [String|Array] The name of the
+      #                    plugin (can be an array of names)
+      # @param      type   [Symbol] The plugin type
+      #                    (:import, :export)
+      # @param      klass  [Class] The class responding to
+      #                    :render or :import
       #
-      #
-      # returns: Success boolean
+      # @return     [Boolean] Success boolean
       #
       def register(title, type, klass)
         type = validate_plugin(title, type, klass)
@@ -90,6 +94,15 @@ module Doing
         type
       end
 
+      ##
+      ## Converts a partial symbol to a valid plugin type,
+      ## e.g. :imp => :import
+      ##
+      ## @param      type     [Symbol] the symbol to test
+      ## @param      default  [Symbol] fallback value
+      ##
+      ## @return     [Symbol] :import or :export
+      ##
       def valid_type(type, default: nil)
         type ||= default
 
@@ -154,10 +167,13 @@ module Doing
       end
 
       ##
-      ## Return a regular expression of all
-      ##             plugin triggers for type
+      ## Return a regular expression of all plugin triggers
+      ## for type
+      ##
+      ## @param      type  [Symbol] The type :import or
+      ##                   :export
       ##
-      ## @param      type  The type :import or :export
+      ## @return     [Regexp] regular expression
       ##
       def plugin_regex(type: :export)
         type = valid_type(type)
@@ -168,6 +184,14 @@ module Doing
         Regexp.new("^(?:#{pattern.join('|')})$", true)
       end
 
+      ##
+      ## Return array of available template names
+      ##
+      ## @param      type  [Symbol] Plugin type (:import,
+      ##                   :export)
+      ##
+      ## @return     [Array<String>] template names
+      ##
       def plugin_templates(type: :export)
         type = valid_type(type)
         templates = []
@@ -181,6 +205,15 @@ module Doing
         templates
       end
 
+      ##
+      ## Return a regular expression of all template
+      ## triggers for type
+      ##
+      ## @param      type  [Symbol] The type :import or
+      ##                   :export
+      ##
+      ## @return     [Regexp] regular expression
+      ##
       def template_regex(type: :export)
         type = valid_type(type)
         pattern = []
@@ -193,6 +226,17 @@ module Doing
         Regexp.new("^(?:#{pattern.join('|')})$", true)
       end
 
+      ##
+      ## Find and return the appropriate template for a
+      ## trigger string. Outputs a string that can be
+      ## written out to the terminal for redirection
+      ##
+      ## @param      trigger  [String] The trigger to test
+      ## @param      type     [Symbol] the plugin type
+      ##                      (:import, :export)
+      ##
+      ## @return     [String] string content of template for trigger
+      ##
       def template_for_trigger(trigger, type: :export)
         type = valid_type(type)
         plugs = plugins[type].clone

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

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+# title: Day One Export
+# description: Export entries to Day One plist for auto import
+# author: Brett Terpstra
+# url: https://brettterpstra.com
+module Doing
+  class DayOneRenderer
+    attr_accessor :items, :page_title, :totals
+
+    def initialize(page_title, items, totals)
+      @page_title = page_title
+      @items = items
+      @totals = totals
+    end
+
+    def get_binding
+      binding()
+    end
+  end
+
+  class DayoneExport
+    include Doing::Util
+
+    def self.settings
+      {
+        trigger: 'day(?:one)?(?:-(?:days?|entries))?',
+        templates: [
+          { name: 'dayone', trigger: 'day(?:one)?$' },
+          { name: 'dayone_entry', trigger: 'day(?:one)-entr(?:y|ies)?$'}
+        ]
+      }
+    end
+
+    def self.template(trigger)
+      case trigger
+      when /day(?:one)-entr(?:y|ies)?$/
+        IO.read(File.join(File.dirname(__FILE__), '../../../templates/doing-dayone-entry.erb'))
+      else
+        IO.read(File.join(File.dirname(__FILE__), '../../../templates/doing-dayone.erb'))
+      end
+    end
+
+    def self.render(wwid, items, variables: {})
+
+      return if items.nil?
+
+      opt = variables[:options]
+      trigger = opt[:output]
+      digest = case trigger
+               when /-days?$/
+                 :day
+               when /-entries$/
+                 :entries
+               else
+                 :digest
+               end
+
+      all_items = []
+      days = {}
+      flagged = false
+      tags = []
+
+      items.each do |i|
+        day_flagged = false
+        date_key = i.date.strftime('%Y-%m-%d')
+
+        if String.method_defined? :force_encoding
+          title = i.title.force_encoding('utf-8').link_urls(format: :markdown)
+          note = i.note.map { |line| line.force_encoding('utf-8').strip.link_urls(format: :markdown) } if i.note
+        else
+          title = i.title.link_urls(format: :markdown)
+          note = i.note.map { |line| line.strip.link_urls(format: :markdown) } if i.note
+        end
+
+        title = "#{title} @project(#{i.section})" unless variables[:is_single]
+
+        tags.concat(i.tag_array).sort!.uniq!
+        flagged = day_flagged = true if i.tags?(wwid.config['marker_tag'])
+
+        interval = wwid.get_interval(i, record: true) if i.title =~ /@done\((\d{4}-\d\d-\d\d \d\d:\d\d.*?)\)/ && opt[:times]
+        interval ||= false
+        human_time = false
+        if interval
+          d, h, m = wwid.format_time(wwid.get_interval(i, formatted: false))
+          human_times = []
+          human_times << format('%<d>d day%<p>s', d: d, p: d == 1 ? '' : 's') if d > 0
+          human_times << format('%<h>d hour%<p>s', h: h, p: h == 1 ? '' : 's') if h > 0
+          human_times << format('%<m>d minute%<p>s', m: m, p: m == 1 ? '' : 's') if m > 0
+          human_time = human_times.join(', ')
+        end
+
+        done = i.tags?('done') ? ' ' : ' '
+
+        item = {
+          date_object: i.date,
+          date: i.date.strftime('%a %-I:%M%p'),
+          shortdate: i.date.relative_date,
+          done: done,
+          note: note,
+          section: i.section,
+          time: interval,
+          human_time: human_time,
+          title: title.strip,
+          starred: day_flagged,
+          tags: i.tag_array
+        }
+        all_items << item
+
+
+        if days.key?(date_key)
+          days[date_key][:starred] = true if day_flagged
+          days[date_key][:tags] = days[date_key][:tags].concat(i.tag_array).sort.uniq
+          days[date_key][:entries].push(item)
+        else
+          days[date_key] ||= { tags: [], entries: [], starred: false }
+          days[date_key][:starred] = true if day_flagged
+          days[date_key][:tags] = days[date_key][:tags].concat(i.tag_array).sort.uniq
+          days[date_key][:entries].push(item)
+        end
+      end
+
+
+      template = if wwid.config['export_templates']['dayone'] && File.exist?(File.expand_path(wwid.config['export_templates']['dayone']))
+                   IO.read(File.expand_path(wwid.config['export_templates']['dayone']))
+                 else
+                   self.template('dayone')
+                 end
+
+      totals = opt[:totals] ? wwid.tag_times(format: :markdown, sort_by_name: opt[:sort_tags], sort_order: opt[:tag_order]) : ''
+
+      case digest
+      when :day
+        days.each do |k, hsh|
+          title = "#{k}: #{variables[:page_title]}"
+          to_dayone(template: template,
+                    title: title,
+                    items: hsh[:entries],
+                    totals: '',
+                    date: Time.parse(k),
+                    tags: tags,
+                    starred: hsh[:starred])
+        end
+      when :entries
+        entry_template = if wwid.config['export_templates']['dayone_entry'] && File.exist?(File.expand_path(wwid.config['export_templates']['dayone_entry']))
+                           IO.read(File.expand_path(wwid.config['export_templates']['dayone_entry']))
+                         else
+                           self.template('dayone-entry')
+                         end
+        all_items.each do |item|
+          to_dayone(template: entry_template,
+                    title: '',
+                    items: [item],
+                    totals: '',
+                    date: item[:date_object],
+                    tags: item[:tags],
+                    starred: item[:starred])
+        end
+      else
+        to_dayone(template: template,
+                    title: variables[:page_title],
+                    items: all_items,
+                    totals: totals,
+                    date: Time.now,
+                    tags: tags,
+                    starred: flagged)
+      end
+
+      @out = ''
+    end
+
+    def self.to_dayone(template: self.template(nil), title: 'doing', items: [], totals: '', date: Time.now, tags: [], starred: false)
+      mdx = DayOneRenderer.new(title, items, totals)
+
+      engine = ERB.new(template)
+      content = engine.result(mdx.get_binding)
+
+      uuid = SecureRandom.uuid
+      # uuid = `uuidgen`.strip
+
+      plist = {
+        'Creation Date' => date,
+        'Creator' => { 'Software Agent' => 'Doing/2.0.0' },
+        'Entry Text' => content,
+        'Starred' => starred,
+        'Tags' => tags.sort.uniq.delete_if { |t| t =~ /(done|cancell?ed|from)/ },
+        'UUID' => uuid
+      }
+
+      container = File.expand_path('~/Library/Group Containers/')
+      dayone_dir = Dir.glob('*.dayoneapp2', base: container).first
+      import_dir = File.join(container, dayone_dir, 'Data', 'Auto Import', 'Default Journal.dayone', 'entries')
+      FileUtils.mkdir_p(import_dir) unless File.exist?(import_dir)
+      entry_file = File.join(import_dir, "#{uuid}.doentry")
+      Doing.logger.debug('Day One Export:', "Exporting to #{entry_file}")
+      File.open(entry_file, 'w') do |f|
+        f.puts plist.to_plist
+      end
+
+      Doing.logger.count(:exported, level: :info, count: items.count, message: '%count %items exported to Day One import folder')
+    end
+
+    Doing::Plugins.register 'dayone', :export, self
+    Doing::Plugins.register 'dayone-days', :export, self
+    Doing::Plugins.register 'dayone-entries', :export, self
+  end
+end