mhc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9eb513930c0f5d993e1755bed627593443df3e2
+  data.tar.gz: d4a6c467fe781e96c68c0ebad0a96f743e8d6a8b
+SHA512:
+  metadata.gz: 0027ebd2eaab008113d12e02062011bf403ce7f3611f8d41cd874ee0c16434ed3e9c576abb10199426f2d374c6ea8c397209ee35ec453b86c42713c56c7c39b1
+  data.tar.gz: 4b3ba18ed523c7105e9109f573b10f74bf1c4cfefbc99dea2e5d2dc4a09b03f6a17bd349097efae502b650323a6b64456dd3e0193fbc5f41516029519d1438e8

data/.gitignore

@@ -0,0 +1,27 @@
+*.elc
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+attic/
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+rdocs/
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle
+.ruby-version
+.ruby-gemset
+.rvmrc
+dist
+.cask

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/COPYRIGHT

@@ -0,0 +1,28 @@
+Copyright (C) 1999, 2000 Yoshinari Nomura. All rights reserved.
+Copyright (C) 2000-2015  MHC developing team. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the team nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE TEAM AND CONTRIBUTORS ``AS IS''
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
+THE TEAM OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mhc.gemspec
+gemspec
+gem "thor"
+gem "ri_cal", :git => 'https://github.com/yoshinari-nomura/ri_cal.git'
+gem "tzinfo"
+gem "tzinfo-data"

data/README.org

@@ -0,0 +1,209 @@
+#+TITLE: MHC -- Message Harmonized Calendaring system.
+#+AUTHOR: Yoshinari Nomura
+#+EMAIL:
+#+DATE: 2015-03-16
+#+OPTIONS: H:3 num:2 toc:nil
+#+OPTIONS: ^:nil @:t \n:nil ::t |:t f:t TeX:t
+#+OPTIONS: skip:nil
+#+OPTIONS: author:t
+#+OPTIONS: email:nil
+#+OPTIONS: creator:nil
+#+OPTIONS: timestamp:nil
+#+OPTIONS: timestamps:nil
+#+OPTIONS: d:nil
+#+OPTIONS: tags:t
+#+TEXT:
+#+DESCRIPTION:
+#+KEYWORDS:
+#+LANGUAGE: ja
+#+LATEX_CLASS: jsarticle
+#+LATEX_CLASS_OPTIONS: [a4j]
+# #+LATEX_HEADER: \usepackage{plain-article}
+# #+LATEX_HEADER: \renewcommand\maketitle{}
+# #+LATEX_HEADER: \pagestyle{empty}
+# #+LaTeX: \thispagestyle{empty}
+
+* DESCRIPTION
+  MHC is designed to help those who receive most appointments via email.
+  Using MHC, you can easily import schedule articles from emails.
+
+  You can get the latest version from:
+  + https://github.com/yoshinari-nomura/mhc
+  + http://www.quickhack.net/mhc
+
+  MHC has following features:
+
+  + Easy import your schedule from existing buffers.
+    For example, using with Mew/Gnus/Wanderlust (MUAs on Emacs),
+    you can easily compose your schedule items from
+    appoint-emails. MHC will guess the title,
+    date, time and description by scanning the email.
+  + Simple data structure allows you to manipulate stored data in many ways.
+  + Appointments can be made to repeat in flexible ways.
+  + powerful but simple expression of appointments.
+
+  MHC stores schedule articles in the same form of MH; you can manipulate
+  these messages not only by above tools but also by many other MUAs,
+  editors, UNIX commandline tools or your own scripts.
+
+* SYSTEM REQUIREMENTS
+  + Ruby 2.1 or newer
+  + Emacs 24 or newer
+
+* Information for Developers
+** INSTALL for developers:
+   1) Install rbenv + ruby-build
+      (see https://github.com/sstephenson/rbenv#basic-github-checkout for details)
+      #+BEGIN_SRC shell-script
+        $ git clone https://github.com/sstephenson/rbenv.git ~/.rbenv
+        $ git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
+        # Edit your shell dot files to add some path and environment variables.
+      #+END_SRC
+
+   2) Install Latest Ruby and bundler
+      #+BEGIN_SRC shell-script
+        # Install ruby 2.1.2
+        $ rbenv install 2.1.2
+
+        # Installation check
+        $ rbenv global 2.1.2
+        $ ruby -v # -> You will see: ruby 2.1.2...
+
+        # Install bundler for your new Ruby
+        $ gem install bundler
+
+        # If you want to use Ruby in your sytem, say /usr/bin/ruby
+        $ rbenv global system
+        $ ruby -v
+      #+END_SRC
+
+   3) Clone MHC from github
+      #+BEGIN_SRC shell-script
+        $ git clone git@github.com:yoshinari-nomura/mhc.git ~/src/mhc
+      #+END_SRC
+
+   4) Set default ruby version in MHC project
+      #+BEGIN_SRC shell-script
+        $ cd ~/src/mhc
+        $ echo '2.1.2' > .ruby-version
+        $ ruby -v # -> You will see: ruby 2.1.2...
+      #+END_SRC
+
+   5) Install requied gem packages in sandbox ~/src/mhc/vendor/bundle
+      #+BEGIN_SRC shell-script
+        $ cd ~/src/mhc
+        $ bundle install --path vendor/bundle
+      #+END_SRC
+
+   6) Initialize config file and spool directory
+      #+BEGIN_SRC shell-script
+        $ bin/mhc init ~/mhc
+
+        Guessing current local timezone ...
+                  ok  guess timezone ... Asia/Tokyo
+        Making directries under ~/mhc ...
+              create  ~/mhc/draft
+              create  ~/mhc/inbox
+              create  ~/mhc/presets
+              create  ~/mhc/spool
+              create  ~/mhc/trash
+              create  ~/mhc/status/cache
+              create  ~/mhc/status/log
+              create  ~/mhc/status/sync_channels
+        Copying config file(s) into ~/.config/mhc/config.yml ...
+                  ok  copy ~/.config/mhc/config.yml
+        Done.
+
+        # Read comments in config.yml carefully
+        $ vi ~/.config/mhc/config.yml
+
+        # Add Japanese Holidays if needed.
+        $ cp samples/japanese-holidays.mhcc ~/mhc/presets/
+
+        # Add ~/src/mhc/bin directory to your $PATH for dogfooding
+        $ export PATH=$HOME/src/mhc/bin:$PATH
+      #+END_SRC
+
+   7) Byte-compile Emacs client
+      #+BEGIN_SRC shell-script
+        $ cd emacs
+        $ make
+      #+END_SRC
+
+   8) Add setup in your =.emacs.d/init.el=
+      #+BEGIN_SRC emacs-lisp
+        (setq load-path
+              (cons "~/src/mhc/emacs" load-path))
+        (autoload 'mhc-mua-setup "mhc-mua")
+        (mhc-mua-setup)
+
+        ;; M-x mhc-goto-this-month
+      #+END_SRC
+
+   9) Check if TODAY is good.
+      #+BEGIN_SRC shell-script
+        $ mhc scan today
+      #+END_SRC
+
+   You may add ~/src/mhc/bin directory to your $PATH for dogfooding
+
+** DIRECTORY STRUCTURE
+*** Configuration Directory
+    Default configuration directory is =~/.config/mhc=.
+    If environment variable =MHC_CONFIG_HOME= or =XDG_CONFIG_HOME= is set,
+    it is taken as =$MHC_CONFIG_HOME/mhc= or =$XDG_CONFIG_HOME/mhc=.
+
+    Configuration directory =~/.config/mhc= has these stuffs:
+    + config.yml :: Configuration file (mandatory).
+    + plugins :: Your home-made Ruby functions.
+    See [[file:samples][samples]] for details.
+
+*** Spool Directory
+    Location of the spool directory should be set
+    by =TOPDIR:= element in =config.yml=.
+
+    For example, if you have =TOPDIR: ~/MHC= entry
+    in your =config.yml=, you will have these directory structure
+    under =~/MHC=:
+
+    + spool/*.mhc :: MHC event database. All events are flatly located
+                     in this directory in the form of ={x-sc-message-id}.mhc=
+    + draft/*.mhc :: Draft files of events.
+                     Opening a file in directory by Emacs,
+                     and Typing =C-cC-c= will move the file into =spool= directory.
+                     (Not implemented yet. Should be empty for now.)
+    + inbox/*.mhc :: Mainly same as =spool=. You will have a chance to
+                     review these events in this directory afterwards.
+                     (Not implemented yet. Should be empty for now.)
+    + presets/*.mhcc :: Database for fixed anniversary events
+                        such as birthdays or national holidays.
+    + trash/*.mhc :: Removed events from =spool= directory.
+    + status/ ::
+      + cache/* :: Cache files for speed-up.
+                   You can remove these files without any damage to MHC Database.
+      + log/* :: log files for debug.
+                 You can remove these files without any damage to MHC DB.
+
+      + sync_channels/* :: Sync records of MHC DB.
+           If you remove any files under this directory,
+           MHC Sync will be DAMAGED.
+* How to convert from the old MHC spool
+  [[https://gist.github.com/yoshinari-nomura/bb9a197e0e01ad81c883][update-uuid.sh]] would help you.
+
+  New format is:
+  + =X-SC-Record-Id= is now in UUID style.
+  + Each filename is in the form of ={UUID}.mhc=, not =[0-9]+=.
+  + UUID in =X-SC-Record-Id= is same as its file's base name.
+  + All articles are flatly placed in TOP/spool/ directory.
+
+  #+BEGIN_SRC shell-script
+    $ ./update-uuid.sh ~/Mail/schedule ~/mhc
+
+    Converting... logfile will be in /Users/nom/mhc/update-uuid.sh34485.log
+  #+END_SRC
+
+  For Japanese people, character-code conversion might be needed.
+  #+BEGIN_SRC shell-script
+    $ cd ~/mhc/spool
+    $ find . -name '*.mhc' | xargs -n 10 nkf --overwrite
+  #+END_SRC

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = 'rdocs'
+  rd.rdoc_files = FileList["lib/**/*.rb"]
+  rd.options << '-charset=UTF-8'
+end

data/bin/mhc

@@ -0,0 +1,312 @@
+#!/usr/bin/env ruby
+
+################################################################
+# rbenv support:
+# If this file is a symlink, and bound to a specific ruby
+# version via rbenv (indicated by RBENV_VERSION),
+# I want to resolve the symlink and re-exec
+# the original executable respecting the .ruby_version
+# which should indicate the right version.
+#
+if File.symlink?(__FILE__) and ENV["RBENV_VERSION"]
+  ENV["RBENV_VERSION"] = nil
+  shims_path = File.expand_path("shims", ENV["RBENV_ROOT"])
+  ENV["PATH"] = shims_path + ":" + ENV["PATH"]
+  exec(File.readlink(__FILE__), *ARGV)
+end
+
+ENV["BUNDLE_GEMFILE"] = File.expand_path("../../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler/setup"
+
+require "thor"
+require "mhc"
+
+Encoding.default_external="UTF-8"
+
+class MhcCLI < Thor
+  ################################################################
+  # constants
+
+  DEFAULT_CONFIG_HOME = File.join((ENV["XDG_CONFIG_HOME"] || "~/.config"), "mhc")
+  DEFAULT_CONFIG_FILE = "config.yml"
+  DEFAULT_CONFIG_PATH = File.join(DEFAULT_CONFIG_HOME, DEFAULT_CONFIG_FILE)
+
+  package_name 'MHC'
+
+  ################################################################
+  # class methods
+
+  class << self
+    attr_accessor :calendar
+    attr_accessor :popular_options
+  end
+
+  def self.register_option(name, options)
+    @popular_options ||= {}
+    @popular_options[name] = options
+  end
+
+  def self.named_option(*names)
+    names.each do |name|
+      method_option name, @popular_options[name]
+    end
+  end
+
+  ################################################################
+  # global options
+
+  class_option :debug,   :desc => "Set debug flag", :type => :boolean
+  class_option :profile, :desc => "Set profiler flag", :type => :boolean
+  class_option :config,  :desc => "Set config path (default: #{DEFAULT_CONFIG_PATH})", :banner => "FILE"
+
+  check_unknown_options! :except => :completions
+
+  ################################################################
+  # frequently used options
+
+  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)
+  register_option :search,     :desc => "Search items by complex expression"
+  register_option :dry_run,    :desc => "Perform a trial run with no changes made", :type => :boolean
+
+  ################################################################
+  # command name mappings
+
+  map ["--version", "-v"] => :version
+
+  map ["--help", "-h"] => :help
+  default_command :help
+
+  ################################################################
+  # Command: help
+  ################################################################
+
+  desc "help [COMMAND]", "Describe available commands or one specific command"
+  def help(command = nil)
+    super(command)
+  end
+
+  ################################################################
+  # Command: version
+  ################################################################
+  desc "version", "Show version"
+
+  def version
+    puts Mhc::VERSION
+  end
+
+  ################################################################
+  # Command: cache
+  ################################################################
+  desc "cache", "Dump cache file"
+
+  named_option :repository
+
+  def cache
+    Mhc::Command::Cache.new(calendar)
+  end
+
+  ################################################################
+  # Command: completions
+  ################################################################
+  desc "completions [COMMAND]", "List available commands or options for COMMAND", :hide => true
+
+  long_desc <<-LONGDESC
+    List available commands or options for COMMAND
+    This is supposed to be a zsh compsys helper"
+  LONGDESC
+
+  def completions(*command)
+    help = self.class.commands
+    global_options = self.class.class_options
+    Mhc::Command::Completions.new(help, global_options, command, config)
+  end
+
+  ################################################################
+  # Command: config
+  ################################################################
+  desc "configuration", "Show current configuration in various formats."
+
+  named_option :format
+
+  def configuration(name = nil)
+    puts Mhc::Converter::Emacs.new.to_emacs(config.get_value(name))
+  end
+
+  ################################################################
+  # Command: init
+  ################################################################
+  desc "init DIRECTORY", "Initialize MHC repository and configuration template"
+
+  def init(top_dir)
+    Mhc::Command::Init.new(top_dir, options[:config] || DEFAULT_CONFIG_PATH, ENV["MHC_TZID"])
+  end
+
+  ################################################################
+  # Command: scan
+  ################################################################
+  desc "scan RANGE", "Scan events in date RANGE"
+
+  long_desc <<-LONGDESC
+    scan events in date RANGE.
+
+    RANGE is one of:
+    \x5 + START-YYYYMMDD
+    \x5 + START[+LENGTH]
+
+    START is one of:
+    \x5 + today, tomorrow, sun ... sat, yyyymmdd
+    \x5 + thismonth, nextmonth, yyyymm
+
+    LENGTH is a number followed by a SUFFIX. SUFFIX is one of:
+    \x5 + d (days)
+    \x5 + w (weeks)
+    \x5 + m (months)
+
+    If LENGTH is omitted, it is treated as '1d' or '1m' depending on
+    which type of START is set.
+
+    Examples:
+    \x5 mhc scan 20140101-20141231
+    \x5 mhc scan 2140101+3d
+    \x5 mhc scan today --category 'Business'
+    \x5 mhc scan thismonth --search 'category:Business & !subject:"Trip"'
+  LONGDESC
+
+  named_option :calendar, :category, :format, :repository, :search
+
+  def scan(range)
+    begin
+      Mhc::Command::Scan.new(calendar, range, **symbolize_keys(options))
+    rescue Mhc::PropertyValue::ParseError, Mhc::FormatterNameError, Mhc::Query::ParseError => e
+      STDERR.print "Error: " + e.message + "\n"
+    end
+    return self
+  end
+
+  ################################################################
+  # Command: server
+  ################################################################
+  desc "server", "Invoked as server (backend of emacs)"
+
+  named_option :repository
+
+  def server
+    require "shellwords"
+    while line = STDIN.gets # STDIN.noecho(&:gets)
+      argv = line.chomp.shellsplit
+      self.class.start(argv)
+      STDOUT.flush
+    end
+  end
+
+  ################################################################
+  # Command: show
+  ################################################################
+  desc "show MESSAGE_ID", "Show article found by MESSAGE_ID"
+
+  named_option :calendar, :repository
+
+  def show(message_id)
+    event = exit_on_error do
+      calendar.find(uid: message_id)
+    end
+    print event.dump if event
+  end
+
+  ################################################################
+  # Command: sync
+  ################################################################
+  desc "sync SYNC_CHANNEL", "Synchronize DBs via SYNC_CHANNEL"
+
+  named_option :dry_run
+
+  def sync(channel_name)
+    driver = exit_on_error do
+      builder.sync_driver(channel_name)
+    end
+    driver.sync_all(options[:dry_run])
+    return self
+  end
+
+  ################################################################
+  # add some hooks to Thor
+
+  no_commands do
+    def invoke_command(command, *args)
+      setup_global_options unless command.name == "init"
+      result = super
+      teardown
+      result
+    end
+  end
+
+  ################################################################
+  # private
+
+  private
+
+  def exit_on_error(&block)
+    begin
+      yield if block_given?
+    rescue Mhc::ConfigurationError => e
+      STDERR.print "ERROR: #{e.message}.\n"
+      exit 1
+    end
+  end
+
+  attr_reader :builder, :config, :calendar
+
+  def setup_global_options
+    exit_on_error do
+      @config = Mhc::Config.create_from_file(options[:config] || DEFAULT_CONFIG_PATH)
+      @builder ||= Mhc::Builder.new(@config)
+      if @config.general.tzid
+        Mhc.default_tzid = @config.general.tzid
+      end
+
+      calname  = options[:calendar] || @config.calendars.first.name
+      @config.general.repository = options[:repository] if options[:repository]
+
+      self.class.calendar ||= builder.calendar(calname)
+      @calendar = self.class.calendar
+    end
+
+    load_plugins
+
+    if options[:profile]
+      require 'profiler'
+      Profiler__.start_profile
+    end
+    if options[:debug]
+      require "pp"
+      $MHC_DEBUG = true
+      $MHC_DEBUG_FOR_DEVELOPER = true if ENV["MHC_DEBUG_FOR_DEVELOPER"]
+    end
+  end
+
+  def load_plugins
+    config_path = options[:config] || DEFAULT_CONFIG_PATH
+    plugin_dir  = File.dirname(config_path)
+
+    Dir.glob(File.expand_path("plugins/*.rb", plugin_dir)) do |rb|
+      require rb
+    end
+  end
+
+  def teardown
+    if options[:profile]
+      Profiler__.print_profile($stdout)
+    end
+  end
+
+  def symbolize_keys(hash)
+    Hash[hash.map {|k,v| [k.to_sym, v]}]
+  end
+end
+
+command = MhcCLI.start(ARGV)