mhc 1.1.1 → 1.2.0

data/lib/mhc/formatter/base.rb

@@ -0,0 +1,125 @@
+module Mhc
+  class Formatter
+    # prepare
+    # format_header
+    #   format_day_header
+    #     format_item_header
+    #     format_item
+    #     format_item_hooter
+    #   format_day_hooter
+    # format_footer
+    # teardown
+    class Base
+      def initialize(date_range:, options:nil)
+        @date_range = date_range
+        @options = options
+        @occurrences, @events, @items = [], [], {}
+        @event_hash = {}
+      end
+
+      def <<(occurrence)
+        event = occurrence.event
+        @occurrences << occurrence
+        @events << event unless @event_hash[event]
+        @event_hash[event] = true
+
+        @items[occurrence.date] ||= []
+        @items[occurrence.date] << occurrence
+      end
+
+      def to_s
+        context = {:items => @items}.merge(@options)
+        prepare(context)
+        string = format_header(context) + format_body(context) + format_footer(context)
+        teardown(context)
+        return string
+      end
+
+      ################################################################
+      private
+
+      def prepare(context);  end
+      def teardown(context); end
+
+      def pad_empty_dates
+        @date_range.each do |date|
+          @items[date] ||= []
+        end
+      end
+
+      def expand_multiple_days_occurrences
+        @occurrences.each do |oc|
+          next if oc.oneday?
+          ((oc.first + 1) .. oc.last).each do |date|
+            @items[date] ||= []
+            @items[date] << oc
+          end
+        end
+      end
+
+      def format_header(context); ""; end
+      def format_footer(context); ""; end
+      def format_day_header(context, date, is_holiday); ""; end
+      def format_day_footer(context, date); ""; end
+
+      def format_body(context)
+        context[:number] = 0
+        @items.keys.sort.map{|date| format_day(context, date, @items[date]) }.join
+      end
+
+      def format_day(context, date, items)
+        string = format_day_header(context, date, items.any?{|e| e.holiday?})
+
+        items = sort_items_in_day(items)
+        items.each_with_index do |occurrence, count|
+          context[:number] += 1
+          context[:number_in_day] = count + 1
+          string += format_item(context, date, occurrence)
+        end
+
+        return string + format_day_footer(context, date)
+      end
+
+      def format_item(context, date, item)
+        raise "Implement in subclasses."
+      end
+
+      def format_item_header(context, date, item)
+        raise "Implement in subclasses."
+      end
+
+      ################################################################
+      ## helpers
+      def append(item, separator = " ")
+        return "" if item.to_s.empty?
+        return separator + item.to_s
+      end
+
+      def prepend(item, separator = " ")
+        return "" if item.to_s.empty?
+        return item.to_s + separator
+      end
+
+      def enclose(item, bracket = "[]")
+        return "" if item.to_s.empty?
+        return bracket[0] + item.to_s + bracket[1]
+      end
+
+      # sort occurrences in a day
+      # make sure all-day occurrences are prior to others
+      def sort_items_in_day(items)
+        items.sort do |a,b|
+          sign_a = a.allday? ? 0 : 1
+          sign_b = b.allday? ? 0 : 1
+
+          if sign_a != sign_b
+            sign_a - sign_b
+          else
+            a <=> b
+          end
+        end
+      end
+
+    end # class Base
+  end # module Formatter
+end # module Mhc

data/lib/mhc/formatter/emacs.rb

@@ -0,0 +1,47 @@
+module Mhc
+  class Formatter
+    class Emacs < SymbolicExpression
+      private
+
+      def prepare(context)
+        expand_multiple_days_occurrences
+      end
+
+      def format_header(context);  "(";   end
+      def format_footer(context);  ")\n"; end
+
+      def format_day_header(context, date, is_holiday)
+        # (DAYS_FROM_EPOC . [year month day wday holiday-p (
+        format("(%d . [%d %d %d %d #{is_holiday ? 't' : 'nil'} (",
+               date.absolute_from_epoch, date.year, date.month, date.day, date.wday)
+      end
+
+      def format_item(context, date, item)
+        subject = item.subject.to_s
+        subject = "(no subject)" if subject == ""
+
+        # [ RECORD CONDITION SUBJECT LOCATION (TIMEB . TIMEE) ALARM
+        # CATEGORIES PRIORITY REGION RECURRENCE-TAG]
+        format("[(%s . [%s nil nil]) nil %s %s (%s . %s) %s (%s) nil nil %s]",
+               elisp_string(item.path.to_s),
+               elisp_string(item.uid.to_s),
+               elisp_string(subject),
+               elisp_string(item.location),
+               (item.time_range.first ? (item.time_range.first.to_i / 60) : "nil"),
+               (item.time_range.last  ? (item.time_range.last.to_i  / 60) : "nil"),
+               elisp_string(item.alarm.to_s),
+               item.categories.map{|c| elisp_string(c.to_s.downcase)}.join(" "),
+               elisp_string(item.recurrence_tag))
+      end
+
+      def format_day_footer(context, date)
+        ")]) "
+      end
+
+      def elisp_string(string)
+        '"' + string.to_s.toutf8.gsub(/[\"\\]/, '\\\\\&').gsub("\n", "\\n") + '"'
+      end
+
+    end # class Emacs
+  end # class Formatter
+end # module Mhc

data/lib/mhc/formatter/howm.rb

@@ -0,0 +1,35 @@
+module Mhc
+  class Formatter
+    class Howm < Base
+      private
+
+      def format_header(context)
+        format("= mhc %s--%s\n", *context[:items].keys.minmax)
+      end
+
+      def format_item(context, date, item)
+        string = format("[%04d-%02d-%02d %5s]%1s %s\n",
+                        date.year, date.month, date.mday,
+                        item.time_range.first.to_s,
+                        mark_todo(item.categories.to_mhc_string),
+                        item.subject)
+        if item.description.to_s != ""
+          string += item.description.to_s.gsub(/^/, " ") + "\n"
+        end
+        return string
+      end
+
+      def mark_todo(category)
+        case category
+        when /done/i
+          "."
+        when /todo/i
+          "+"
+        else
+          "@"
+        end
+      end
+
+    end # class Howm
+  end # class Formatter
+end # module Mhc

data/lib/mhc/formatter/icalendar.rb

@@ -0,0 +1,17 @@
+module Mhc
+  class Formatter
+    class Icalendar < Base
+      private
+
+      def format_body(context)
+        ical = RiCal.Calendar
+        ical.prodid = Mhc::PRODID
+        @events.each do |event|
+          ical.events << event.to_icalendar
+        end
+        return ical.to_s
+      end
+
+    end # class Icalendar
+  end # class Formatter
+end # module Mhc

data/lib/mhc/formatter/json.rb

@@ -0,0 +1,27 @@
+module Mhc
+  class Formatter
+    class Json < Base
+      require "json"
+
+      def format_body(context)
+        events = []
+        @occurrences.each do |oc|
+          class_name = []
+          class_name += oc.categories.map{|c| "mhc-category-#{c.to_s.downcase}"}
+          class_name << (oc.allday? ? "mhc-allday" : "mhc-time-range")
+
+          events << {
+            id:    oc.record_id,
+            allDay: oc.allday?,
+            title: oc.subject,
+            start: oc.dtstart.iso8601,
+            end:   oc.dtend.iso8601,
+            className: class_name
+          }
+        end
+        return events.to_json
+      end
+
+    end # class Json
+  end # class Formatter
+end # module Mhc

data/lib/mhc/formatter/mail.rb

@@ -0,0 +1,20 @@
+module Mhc
+  class Formatter
+    class Mail < Text
+      private
+
+      def format_header(context)
+        mail_address = context[:mailto].to_s
+        subject = format("MHC schedule report (%s--%s)", *context[:items].keys.minmax)
+        header =  "To: #{mail_address}\n"
+        header += "From: #{append(mail_address, "secretary-of-")}\n"
+        header += "Subject: #{subject}\n"
+        header += "Content-Type: Text/Plain; charset=utf-8\n"
+        header += "Content-Transfer-Encoding: 8bit\n"
+        header += "\n"
+        header += format("* mhc %s--%s\n", *context[:items].keys.minmax)
+      end
+
+    end # class Mail
+  end # class Formatter
+end # module Mhc

data/lib/mhc/formatter/org_table.rb

@@ -0,0 +1,24 @@
+module Mhc
+  class Formatter
+    class OrgTable < Base
+      private
+
+      def format_header(context)
+        format("* mhc %s--%s\n", *context[:items].keys.minmax)
+      end
+
+      def format_item(context, date, item)
+        # | No | Mission | Recurrence | Subject | Path | Date |
+        format("  | %4d | %s | %s | %s | %s | [%04d-%02d-%02d%s] |\n",
+               context[:number],
+               item.mission_tag.to_s.toutf8,
+               item.recurrence_tag.to_s.toutf8,
+               item.subject.to_s.toutf8,
+               item.path.to_s,
+               date.year, date.month, date.mday,
+               append(item.time_range.to_s))
+      end
+
+    end # class OrgTable
+  end # class Formatter
+end # module Mhc

data/lib/mhc/formatter/symbolic_expression.rb

@@ -0,0 +1,42 @@
+module Mhc
+  class Formatter
+    class SymbolicExpression < Base
+      private
+
+      def format_header(context);  "(";   end
+      def format_footer(context);  "(periods #{@periods}))\n"; end
+
+      def format_day_header(context, date, is_holiday)
+        date.strftime("((%2m %2d %Y) . (")
+      end
+
+      def format_item(context, date, item)
+        unless item.oneday?
+          format_multiple_days_item(context, date, item)
+          return ""
+        end
+        format_item_line(item)
+      end
+
+      def format_multiple_days_item(context, date, item)
+        @periods ||= ""
+        @periods +=  item.first.strftime("((%2m %2d %Y) ") +
+                    item.last.strftime(" (%2m %2d %Y) ") +
+          format_item_line(item) + ') '
+      end
+
+      def format_day_footer(context, date); ")) "; end
+
+      def format_item_line(item)
+        '"' +
+          format("%s%s%s",
+                 prepend(item.time_range.first.to_s).toutf8,
+                 item.subject.to_s.toutf8,
+                 append(enclose(item.location)).toutf8).gsub(/[\"\\]/, '\\\\\&') +
+          '" '
+
+      end
+
+    end # class SymbolicExpression
+  end # class Formatter
+end # module Mhc

data/lib/mhc/formatter/text.rb

@@ -0,0 +1,29 @@
+module Mhc
+  class Formatter
+    class Text < Base
+      def prepare(context)
+        expand_multiple_days_occurrences
+      end
+
+      def format_item(context, date, item)
+        subject = item.subject.to_s
+        subject = "(no subject)" if subject == ""
+        format("%s%-11s %s%s\n",
+               format_item_header(context, date, item),
+               item.time_range.to_mhc_string.toutf8,
+               subject.toutf8,
+               append(enclose(item.location)).toutf8
+               )
+      end
+
+      def format_item_header(context, date, item)
+        if context[:number_in_day] == 1
+          date.strftime("%Y/%m/%d %a ")
+        else
+          " " * 15
+        end
+      end
+
+    end # class Text
+  end # module Formatter
+end # module Mhc

data/lib/mhc/occurrence.rb

@@ -16,7 +16,6 @@ module Mhc
     :record_id,
     :uid,
     :subject,
-    :time_range,
     :recurrence_tag,
     :mission_tag,
     :allday?,
@@ -37,14 +36,32 @@ module Mhc
     end
 
     def date
-      @start_date
+      if @start_date.respond_to?(:hour)
+        Mhc::PropertyValue::Date.new(@start_date.year, @start_date.month, @start_date.day)
+      else
+        @start_date
+      end
+    end
+
+    # FIXME: TimeRange class should be implemented
+    def time_range
+      range = Mhc::PropertyValue::Range.new(Mhc::PropertyValue::Time)
+      if dtstart.respond_to?(:hour)
+        range.parse("#{dtstart.hour}:#{dtstart.min}-#{dtend.hour}:#{dtend.min}")
+      else
+        return range # allday
+      end
     end
 
     def dtstart
       if allday?
         @start_date
       else
-        time_range.first.to_datetime(@start_date)
+        if @start_date.respond_to?(:hour)
+          @start_date
+        else
+          @event.time_range.first.to_datetime(@start_date)
+        end
       end
     end
 
@@ -52,7 +69,11 @@ module Mhc
       if allday?
         @end_date + 1
       else
-        time_range.last.to_datetime(@end_date)
+        if @end_date.respond_to?(:hour)
+          @end_date
+        else
+          @event.time_range.last.to_datetime(@end_date)
+        end
       end
     end
 
@@ -77,7 +98,8 @@ module Mhc
         return "#{dtstart.to_mhc_string}" if oneday?
         return "#{@start_date.to_mhc_string}-#{@end_date.to_mhc_string}"
       else
-        return dtstart.strftime("%Y%m%d %H:%m-") + ((@start_date == @end_date) ? dtend.strftime("%H:%m") : dtend.strftime("%Y%m%dT%H:%m"))
+        time = dtstart.strftime("%Y%m%d %H:%m-") + ((@start_date.to_date == @end_date.to_date) ? dtend.strftime("%H:%m") : dtend.strftime("%Y%m%dT%H:%m"))
+        return time + " " + subject.to_mhc_string
       end
     end
 

data/lib/mhc/occurrence_enumerator.rb

@@ -71,7 +71,7 @@ module Mhc
           first_date = date_or_range
           last_date  = date_or_range
         end
-        if last_date < @date_range.first or @date_range.last < first_date
+        if last_date.to_date < @date_range.first or @date_range.last < first_date.to_date
           next
         end
         next if @exceptions.include?(first_date)