mhc 1.2.4 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4522630272ecdc9d44c9b994b2b31f8e36278abb0004708ec0e39d63e5d16792
-  data.tar.gz: cbcd079db569d336eec4eb87f21e5598cd3735b04f0fef6ffbbc8b7fdb583067
+  metadata.gz: f1770cced4e43154f7af7e9f9827811c082ba36215fc1a5f0553306a2b7ffec1
+  data.tar.gz: 68f9c66861b05ee65769ac9cc2bd3d011311a3407d39fcf1d07370fc57565c11
 SHA512:
-  metadata.gz: 1f052c78047e59e8638248ef56928f2ee3e85ae544b959d294c6900afb06868cb305a4a23b1ae85a35d963b870dbb0ec950c4c1d5cd9ea25d9ffe07334be5cd8
-  data.tar.gz: 874b007618cfd8be8a49ba0fab497ba38f6a36edfedbedf0ec72bb983c6c5ceff67a52c2b6138a62ced23fb0586e5f644eca018e2d9b963a8d79666100b94b9a
+  metadata.gz: f24b75dc4012c86e17578dcdcb3aa25cb689e2a448d75c520e37bed7951db33b5d6303598a7e3e923390a37f85a42150e8ecdc4edc5c4064997e0c19273f1f57
+  data.tar.gz: 7f56ec202242dfda4bb52b4fb9cb8820b5f45b2f433468c60671d3c44fae2c7724fb2b803cd787e5d58a76eb7b80c4c5809e7af618a3bb9aca6863975314a8b7

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/RedundantReturn:
+  Enabled: false
+Style/CommentedKeyword:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/RedundantSelf:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false

data/README.org

@@ -127,6 +127,7 @@
        | =M= | Open pointed article to edit                   |
        | =D= | Delete pointed article                         |
        | =C= | Copy article temporally as a reusable template |
+       | =R= | Copy article like =C= using completing-read    |
        | =Y= | Same as =E= but use the template stored by =C= |
 
     3) Draft Buffer
@@ -149,6 +150,7 @@
      X-SC-Time: 18:00-21:00
      X-SC-Category: Private Party
      X-SC-Cond:
+     X-SC-Recurrence-Tag: HomeParty
      X-SC-Duration:
      X-SC-Record-Id: C34D89F5-27FA-4243-AC6C-168D8D243D9A
      X-SC-Sequence: 0
@@ -241,6 +243,40 @@
       of 2015-07-15 (Wed) and inclusion of 2015-08-01 (Sat).
     #+END_EXAMPLE
 
+** Headers for Grouping
+*** X-SC-Category
+    =X-SC-Category:= is a space separated list of category
+    It is useful for selective display both in CLI:
+    : mhc scan today --category=Private
+    and Emacs UI:
+    : M-x mhc-set-default-category
+    : Default Category: Private && !Party
+
+    Also useful sync with Google Calendar. See [[https://github.com/yoshinari-nomura/mhc/blob/master/samples/DOT.mhc-config.yml][mhc-config.yml]] for
+    details.
+
+*** X-SC-Recurrence-Tag
+    =X-SC-Recurrence-Tag:= is a tag for bundling multiple event articles as one recurring group.
+
+    MHC allows flexible description of repeating events using
+    =X-SC-Cond:=, =X-SC-Duration:=, or =X-SC-Day:=. However, we know
+    this is not sufficient.
+
+    For example, in my experience, some monthly meetings do not have
+    distinct recurring patterns such like "Third Wednesday of each
+    month." Instead, the next date is fixed by coordination during the meeting.
+
+    In such cases, it is difficult to mark these events as a series of related events.
+    That's why we need =X-SC-Recurrence-Tag:=
+
+    Using =X-SC-Recurrence-Tag:=, MHC suggests what event should be arranged.
+    : mhc stuck_recurrences
+    will tell you to make the next appointment.
+
+    For example, if you have "X-SC-Recurrence-Tag: Dentist" in your
+    articles of past dentist events, mhc will point out that you
+    forgot to make your next dentist appointment.
+
 * INFORMATION FOR DEVELOPERS
 ** INSTALL for developers:
    1) Install rbenv + ruby-build
@@ -326,6 +362,7 @@
         (setq load-path
               (cons "~/src/mhc/emacs" load-path))
         (autoload 'mhc "mhc" "Message Harmonized Calendar system." t)
+        (autoload 'mhc-import "mhc" "Import a schedule." t)
 
         ;; M-x mhc
       #+END_SRC

data/Rakefile

@@ -20,7 +20,7 @@ task :build => :check_version
 task :check_version do
   for file in %w(mhc.el mhc-vars.el Cask)
     path = File.expand_path("../emacs/#{file}", __FILE__)
-    raise "File not found #{path}" unless File.exists?(path)
+    raise "File not found #{path}" unless File.exist?(path)
 
     content = File.open(path).read
     unless (/^;; Version: (\d+\.\d+\.\d+)$/ =~ content ||

data/bin/mhc

@@ -17,7 +17,7 @@ end
 
 gemfile = File.expand_path("../../Gemfile", __FILE__)
 
-if File.exists?(gemfile + ".lock")
+if File.exist?(gemfile + ".lock")
   ENV["BUNDLE_GEMFILE"] = gemfile
   require "bundler/setup"
 end
@@ -72,9 +72,10 @@ class MhcCLI < Thor
   register_option :repository, :desc => "Set MHC top directory", :banner => "DIRECTORY"
   register_option :calendar,   :desc => "Set source CALENDAR"
   register_option :category,   :desc => "Pick items only in CATEGORY"
-  register_option :format,     :desc => "Set printing format", :enum => %w(text mail orgtable emacs icalendar calfw howm json)
+  register_option :format,     :desc => "Set printing format", :enum => %w(text mail orgtable emacs icalendar calfw howm json html)
   register_option :search,     :desc => "Search items by complex expression"
   register_option :dry_run,    :desc => "Perform a trial run with no changes made", :type => :boolean
+  register_option :verbose,    :desc => "Show verbose message", :type => :boolean
 
   ################################################################
   # command name mappings
@@ -113,7 +114,9 @@ class MhcCLI < Thor
     Mhc::Command::Cache.new(builder.datastore)
   end
 
+  ################################################################
   # Command: todo
+  ################################################################
   desc "todo", "List Todo entries in MHC calendar"
 
   named_option :repository
@@ -131,7 +134,8 @@ class MhcCLI < Thor
         search_range = nil
       end
       next if task.in_category?("done") && !options[:show_all]
-      todos << task.occurrences(range: search_range).first
+      task_first = task.occurrences(range: search_range).first
+      todos << task_first if task_first
     end
     todos.each.sort{|a, b| a.dtstart <=> b.dtstart}.each do |t|
       deadline = t.dtstart
@@ -168,6 +172,38 @@ class MhcCLI < Thor
     Mhc::Command::Completions.new(help, global_options, command, config)
   end
 
+  ################################################################
+  # Command: compose
+  ################################################################
+  desc "compose", "Create new draft and open it in your editor"
+
+  long_desc <<-LONGDESC
+    Create a new draft and open it in your editor.
+    To select your favorite editor,
+    set environment variable MHC_EDITOR or EDITOR.
+  LONGDESC
+
+  def compose
+    require 'securerandom'
+    ev = Mhc::Event.new
+    ev.record_id = SecureRandom.uuid.upcase
+    path = builder.datastore.create(ev, true)
+    puts "Create draft #{path}"
+    editor = ENV["MHC_EDITOR"] || ENV["EDITOR"] || "vi"
+    system(editor, path)
+
+    while add(path) != 0
+      if ask("Retry?") =~ /^[Yy]/
+        system(editor, path)
+      else
+        puts "Abort..."
+        exit(1)
+      end
+    end
+    puts "Successfully registered."
+    exit(0)
+  end
+
   ################################################################
   # Command: config
   ################################################################
@@ -179,6 +215,40 @@ class MhcCLI < Thor
     puts Mhc::Converter::Emacs.new.to_emacs(config.get_value(name))
   end
 
+  ################################################################
+  # Command: add
+  ################################################################
+  desc "add FILE", "Add event FILE to repository"
+
+  named_option :repository
+
+  def add(file)
+    full_path = File.expand_path(file)
+
+    unless File.exist?(full_path)
+      puts Mhc::Converter::Emacs.new.to_emacs("No such file #{file}.")
+      return 1
+    end
+
+    event_string = File.open(full_path).read
+    errors = Mhc::Event.validate(event_string)
+
+    if errors.empty?
+      ev = Mhc::Event.parse(event_string)
+      calendar.add(ev)
+      return 0
+    else
+      string = ""
+      errors.each do |err, key|
+        string += "#{err.to_s.capitalize}"
+        string += " in X-SC-#{key.capitalize}" if key
+        string += ".\n"
+      end
+      puts string
+      return 1
+    end
+  end
+
   ################################################################
   # Command: init
   ################################################################
@@ -188,6 +258,55 @@ class MhcCLI < Thor
     Mhc::Command::Init.new(top_dir, options[:config] || DEFAULT_CONFIG_PATH, ENV["MHC_TZID"])
   end
 
+  ################################################################
+  # Command: stuck_recurrences
+  ################################################################
+  desc "stuck_recurrences", "List stuck recurrences in MHC calendar"
+
+  named_option :repository
+  named_option :verbose
+  named_option :format
+
+  # * stuck_recurrences
+  #
+  #  For all "living recurrences", if no next event has been set in
+  #  the "future", show the information on the last time.
+  #
+  #   + "living recurrences" ::
+  #     + There is a last-time evnet within a year and a half.
+  #   + "future" :: ten years from now.
+  #
+  def stuck_recurrences(format = options[:format])
+    today = Mhc::PropertyValue::Date.today
+
+    # Seek -1.5y to +10y
+    search_range = (today - ((365 *  5).to_i)) ..
+                   (today + ((365 * 10).to_i))
+
+    recurrences = {}
+
+    # Get all recurrences in search_range
+    calendar.occurrences(search_range).each do |oc|
+      rtag = oc.recurrence_tag.to_s
+      next if rtag.empty?
+      recurrences[rtag] ||= []
+      recurrences[rtag] << oc
+    end
+
+    formatter = Mhc::Formatter.build(formatter: format || :text, date_range: search_range)
+
+    recurrences.each do |rtag, recurrence|
+      if options[:verbose]
+        rec_put_debug(recurrence)
+      else
+        formatter << recurrence.last if rec_stuck?(recurrence)
+      end
+    end
+    str = formatter.to_s
+    return str if format == :json || options[:verbose]
+    puts str
+  end # stuck_recurrences
+
   ################################################################
   # Command: scan
   ################################################################
@@ -222,6 +341,9 @@ class MhcCLI < Thor
   named_option :calendar, :category, :format, :repository, :search
 
   def scan(range)
+    if options[:format].to_s == 'html'
+      $stuck_recurrences_json = stuck_recurrences(:json)
+    end
     begin
       Mhc::Command::Scan.new(calendar, range, **symbolize_keys(options))
     rescue Mhc::PropertyValue::ParseError, Mhc::Formatter::NameError, Mhc::Query::ParseError => e
@@ -326,6 +448,80 @@ class MhcCLI < Thor
 
   private
 
+  def rec_put_debug(recurrence)
+    ol = recurrence.last
+
+    today = Mhc::PropertyValue::Date.today
+    last_occurrence = recurrence.last
+    last_occurrence_date = last_occurrence.dtstart.to_date
+    # Ignore living recurrences
+    return false if last_occurrence_date > today
+
+    status = if rec_stuck?(recurrence) then " TODO" else "" end
+    print "*#{status} #{ol.recurrence_tag}#{status} "
+
+    print format("%s %s",
+                 ol.dtstart.strftime("%Y-%m-%d %a"),
+                 ol.subject)
+
+    print format(" (length: %d, max: %d, min: %d, avr: %d)\n",
+                 recurrence.length,
+                 *rec_stat(recurrence))
+
+    pr = recurrence.first
+    recurrence.each do |oc|
+      puts format("  %s %s (%d)",
+                  oc.dtstart.strftime("%Y-%m-%d %a"),
+                  oc.subject,
+                  (oc.dtstart.to_date - pr.dtstart.to_date).to_i
+                 )
+      pr = oc
+    end
+  end
+
+  # Judge if a recurrence is stuck or not. recurrence is a set of occurrences.
+  def rec_stuck?(recurrence, today = Mhc::PropertyValue::Date.today)
+    last_occurrence = recurrence.last
+    last_occurrence_date = last_occurrence.dtstart.to_date
+    max_interval, _min_interval, avr_interval = rec_stat(recurrence)
+
+    # Not stuck if scheduled in the future dates
+    return false if last_occurrence_date > today
+
+    # Stuck if last event occurred within 90 days, but average
+    # interval is less than 60 days.
+    if (today - last_occurrence_date).to_i < 90 && avr_interval < 60
+      return true
+    end
+
+    # Not stuck if the number of days between the last event and today
+    # does not reach 80% of the maximum interval.
+    return false if (today - last_occurrence_date).to_i < max_interval * 4 / 5
+
+    # Not stuck if the number of days between the last event and today
+    # is more than 30 days or 1.5 years beyond the maximum interval.
+    # It would be no more recurring.
+    return false if (today - last_occurrence_date).to_i > [max_interval + 30, 365*1.5].min
+
+    # Otherwise, stuck
+    return true
+  end
+
+  # Return statistics on recurrences: max/min/average interval.
+  def rec_stat(recurrence)
+    # Calcurate all intervals of the recurrence
+    intervals = recurrence.each_cons(2).map{|ocs|
+      (ocs[1].dtstart.to_date - ocs[0].dtstart.to_date).to_i
+    }.reject{|interval| interval < 1}
+
+    # Assume annual event if the recurrence is one-shot.
+    intervals = [365] if intervals.empty?
+
+    return [intervals.max,
+            intervals.min,
+            intervals.reduce(0, :+) / intervals.length]
+  end
+
   def exit_on_error(&block)
     begin
       yield if block_given?

data/emacs/Cask

@@ -5,7 +5,7 @@
 (source org)
 (source melpa)
 
-(package "mhc" "1.2.4" "Message Harmonized Calendaring system") ;; MHC_VERSION
+(package "mhc" "1.2.6" "Message Harmonized Calendaring system") ;; MHC_VERSION
 
 (files "mhc.el" "mhc-*.el")
 

data/emacs/mhc-db.el

@@ -34,6 +34,12 @@ If optional SEARCH is non-nil returned value is clipped by search string."
            (if category  (format " --category=%s" category) "")
            (if search  (format " --search='%s'" search) ""))))
 
+(defun mhc-db-stuck-recurrences ()
+  "List stuck recurrences in MHC calendar."
+  (mhc-db-flatten
+   (mhc-process-send-command
+    (format "stuck_recurrences --format=emacs"))))
+
 (defun mhc-db-scan-flat (begin-date end-date &optional nosort category search)
   "Scan MHC database from BEGIN-DATE to END-DATE.
 Unlike `mhc-db-scan`, returned value is not grouped by date.
@@ -42,19 +48,48 @@ For example:
 If optional NOSORT is non-nil, returned value is not sort.
 If optional CATEGORY is non-nil, returned value is clipped by category.
 If optional SEARCH is non-nil returned value is clipped by search string."
-  (let ((dayinfo-list (mhc-db-scan begin-date end-date nosort category search)))
-    (apply 'append
-           (mapcar (lambda (dayinfo)
-                     (let ((date (mhc-day-date dayinfo))
-                           (schedules (mhc-day-schedules dayinfo)))
-                       (mapcar (lambda (sch) (cons date sch)) schedules)))
-                   dayinfo-list))))
+  (mhc-db-flatten (mhc-db-scan begin-date end-date nosort category search)))
+
+(defun mhc-db-flatten (dayinfo-list)
+  "Flatten DAYINFO-LIST scanned from `mhc-db-scan`.
+Unlike `mhc-db-scan`, returned value is not grouped by date."
+  (apply 'append
+         (mapcar (lambda (dayinfo)
+                   (let ((date (mhc-day-date dayinfo))
+                         (schedules (mhc-day-schedules dayinfo)))
+                     (mapcar (lambda (sch) (cons date sch)) schedules)))
+                 dayinfo-list)))
 
 (defun mhc-db-search (&rest query)
   (let ((b (mhc-date-new 1970 1 1))
         (e (mhc-date-yy+ (mhc-date-now) 10)))
     (mhc-db-scan b e nil nil (mhc-db/query-to-search-string query))))
 
+(defun mhc-db-past-occurrences (&optional days)
+  (let ((now (mhc-date-now)))
+    (nreverse
+     (mhc-db-scan-flat (mhc-date- now (or days 732)) now))))
+
+(defun mhc-db-make-completion-list (occurrences)
+  (delq nil
+        (mapcar
+         (lambda (occurrence)
+           (let ((sch (cdr occurrence)))
+             (if  (not (string= (mhc-record-name (mhc-schedule-record sch)) ""))
+                 (cons (mhc-db-real-to-display occurrence) occurrence))))
+         occurrences)))
+
+(defun mhc-db-real-to-display (occurrence)
+  (let* ((date (car occurrence))
+         (sch (cdr occurrence))
+         (location (mhc-schedule-location sch)))
+    (concat
+     (mhc-date-format date "%04d/%02d/%02d" yy mm dd)
+     (format " %11s " (mhc-schedule-time-as-string sch))
+     (mhc-schedule-subject sch)
+     (if (and location (not (string= location "")))
+         (format " [%s]" location)))))
+
 (defun mhc-db/quote-string (string)
   (format "\"%s\"" string))
 

data/emacs/mhc-summary.el

@@ -294,9 +294,10 @@ If optional argument FOR-DRAFT is non-nil, Hilight message as draft message."
       (set-visited-file-name nil)
       ;; (rename-buffer (file-name-nondirectory file) 'unique)
       ;; (run-hooks 'mhc-calendar-view-file-hook)
+      (let ((buffer-read-only nil))
+        (mhc-message-mode))
       (set-buffer-modified-p nil)
       (setq buffer-read-only t)
-      (mhc-message-mode)
       (mhc-message-set-file-name file)
       )))
 
@@ -633,6 +634,7 @@ If BANNER is set, it is printed on the horizontal line."
   (define-key mhc-summary-mode-map "E" 'mhc-edit)
   (define-key mhc-summary-mode-map "M" 'mhc-modify)
   (define-key mhc-summary-mode-map "C" 'mhc-reuse-copy)
+  (define-key mhc-summary-mode-map "R" 'mhc-reuse-past-event)
   (define-key mhc-summary-mode-map "Y" 'mhc-reuse-create)
 
   (define-key mhc-summary-mode-map "n" 'mhc-summary-display-next)

data/emacs/mhc-vars.el

@@ -18,7 +18,7 @@
 
 
 ;;; Constants:
-(defconst mhc-version "mhc 1.2.4") ;; MHC_VERSION
+(defconst mhc-version "mhc 1.2.6") ;; MHC_VERSION
 
 
 ;;; Configration Variables:

data/emacs/mhc.el

@@ -3,7 +3,7 @@
 ;; Description: Message Harmonized Calendaring system.
 ;; Author:  Yoshinari Nomura <nom@quickhack.net>
 ;; Created: 1994-07-04
-;; Version: 1.2.4
+;; Version: 1.2.6
 ;; Keywords: calendar
 ;; URL: http://www.quickhack.net/mhc
 ;; Package-Requires: ((calfw "20150703"))
@@ -19,7 +19,8 @@
 ;;
 ;;  (setq load-path
 ;;        (cons "~/src/mhc/emacs" load-path))
-;;  (autoload 'mhc "mhc")
+;;  (autoload 'mhc "mhc" nil t)
+;;  (autoload 'mhc-import "mhc" nil t)
 ;;
 ;; and M-x mhc
 
@@ -325,10 +326,11 @@
         ret))))
 
 (defun mhc-expr-compile (string)
-  (byte-compile
-   `(lambda (schedule)
-      ,(mhc-expr-parse string)
-      )))
+  (let ((lexical-binding nil))
+    (byte-compile
+     `(lambda (schedule)
+	,(mhc-expr-parse string)
+	))))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;
@@ -796,6 +798,7 @@ Returns t if the importation was succeeded."
   :group 'mhc
   :type 'boolean)
 
+;;;###autoload
 (defun mhc-import (&optional get-original)
   "Import a schedule from the current article.
 The default action of this command is to import a schedule from the
@@ -912,6 +915,27 @@ the default action of this command is changed to the latter."
           (message "%s is copied." (mhc-record-subject-as-string record)))
       (message "No file here."))))
 
+(defun mhc-reuse-past-event ()
+  "Select past schedule and copy to template."
+  (interactive)
+  (let* ((completion-ignore-case t)
+         (read-file-name-completion-ignore-case t)
+         (read-buffer-completion-ignore-case t)
+         (case-fold-search t)
+         (collection
+          (mhc-db-make-completion-list
+           (mhc-db-past-occurrences)))
+         (completion-table
+          (lambda (string pred action)
+            (if (eq action 'metadata)
+                '(metadata (display-sort-function . identity)
+                           (cycle-sort-function . identity))
+              (complete-with-action action collection string pred))))
+         (key (completing-read "Select occurrence: " completion-table nil t))
+         (sch (cdr (cdr (assoc key collection)))))
+    (mhc-reuse-copy
+     (mhc-record-name (mhc-schedule-record sch)))))
+
 (defun mhc-modify ()
   "Modify the current schedule."
   (interactive)

data/lib/mhc/calendar.rb

@@ -23,6 +23,22 @@ module Mhc
       @datastore.entries(category: "todo")
     end
 
+    def recurrences(rec, &scope_block)
+      @datastore.entries(recurrence: rec)
+    end
+
+    def recurrence_tags
+      hash = {}
+      @datastore.entries.each do |ev|
+        tag = ev.recurrence_tag.to_s
+        next if tag == ""
+        next if hash[tag]
+
+        yield tag
+        hash[tag] = ev
+      end
+    end
+
     def occurrences(date_range, &scope_block)
       ocs = []
       @datastore.entries(range: date_range).each do |event|
@@ -34,6 +50,10 @@ module Mhc
       return ocs.sort
     end
 
+    def add(event)
+      @datastore.update(event)
+    end
+
     ################################################################
     ## for sync manager
 

data/lib/mhc/command/init.rb

@@ -62,7 +62,7 @@ module Mhc
         require "erb"
         template = ERB.new(File.open(template_path).read, nil, "-")
 
-        if File.exists?(dest_path)
+        if File.exist?(dest_path)
           say_status "exist", "Ignore #{dest_path}", :yellow
           return
         end
@@ -98,7 +98,7 @@ module Mhc
         require "digest/md5"
 
         # Debian
-        if File.exists?("/etc/timezone")
+        if File.exist?("/etc/timezone")
           return File.open("/etc/timezone").read.chomp
         end
 
@@ -109,13 +109,13 @@ module Mhc
         end
 
         # Red Had / CentOS
-        if File.exists?("/etc/sysconfig/clock") &&
+        if File.exist?("/etc/sysconfig/clock") &&
             /ZONE=["']?([^"']+)/ =~ File.open("/etc/sysconfig/clock").read.chomp
           return $1
         end
 
         # generic including FreeBSD
-        if File.exists?("/etc/localtime")
+        if File.exist?("/etc/localtime")
           localtime = Digest::MD5.file("/etc/localtime")
           candidates = Dir.chdir("/usr/share/zoneinfo") do
             Dir.glob("**/*").select do |fn|

data/lib/mhc/config.rb

@@ -52,7 +52,11 @@ module Mhc
       end
 
       def self.create_from_yaml_string(yaml_string, filename = nil)
-        hash = YAML.load(yaml_string, filename) || {}
+        hash = if YAML.respond_to?(:unsafe_load)
+                 YAML.unsafe_load(yaml_string, filename: filename)
+               else
+                 YAML.load(yaml_string, filename)
+               end || {}
         return new(hash)
       end
 
@@ -207,7 +211,7 @@ module Mhc
     end # class Top
 
     def self.create_from_file(file_name)
-      unless File.exists?(File.expand_path(file_name))
+      unless File.exist?(File.expand_path(file_name))
         raise Mhc::ConfigurationError, "config file '#{file_name}' not found"
       end
       begin