vpim 0.323 → 0.357

data/lib/vpim/version.rb

@@ -7,7 +7,9 @@
 =end
 
 module Vpim
-  VERSION = "0.323"
+  PRODID = '-//Ensemble Independent//vPim 0.357//EN'
+
+  VERSION = '0.357'
 
   # Return the API version as a string.
   def Vpim.version

data/lib/vpim/vevent.rb

@@ -15,74 +15,7 @@ require 'vpim/property/common'
 require 'vpim/property/priority'
 require 'vpim/property/location'
 require 'vpim/property/resources'
-
-module Vpim
-  class Icalendar
-    class Vjournal
-      include Vpim::Icalendar::Property::Base
-      include Vpim::Icalendar::Property::Common
-
-      def initialize(fields) #:nodoc:
-        outer, inner = Vpim.outer_inner(fields)
-
-        @properties = Vpim::DirectoryInfo.create(outer)
-
-        @elements = inner
-      end
-
-      # Create a Vjournal component.
-      def self.create(fields=[])
-        di = DirectoryInfo.create([], 'VJOURNAL')
-
-        Vpim::DirectoryInfo::Field.create_array(fields).each { |f| di.push_unique f }
-
-        new(di.to_a)
-      end
-
-    end
-  end
-end
-
-module Vpim
-  class Icalendar
-    class Vtodo
-      include Vpim::Icalendar::Property::Base
-      include Vpim::Icalendar::Property::Common
-      include Vpim::Icalendar::Property::Priority
-      include Vpim::Icalendar::Property::Location
-      include Vpim::Icalendar::Property::Resources
-
-      def initialize(fields) #:nodoc:
-        outer, inner = Vpim.outer_inner(fields)
-
-        @properties = Vpim::DirectoryInfo.create(outer)
-
-        @elements = inner
-      end
-
-      # Create a new Vtodo object.
-      #
-      # If specified, +fields+ must be either an array of Field objects to
-      # add, or a Hash of String names to values that will be used to build
-      # Field objects. The latter is a convenient short-cut allowing the Field
-      # objects to be created for you when called like:
-      #
-      #   Vtodo.create('SUMMARY' => "buy mangos")
-      #
-      # TODO - maybe todos are usually created in a particular way? I can
-      # make it easier. Ideally, I would like to make it hard to encode an invalid
-      # Event.
-      def Vtodo.create(fields=[])
-        di = DirectoryInfo.create([], 'VTODO')
-
-        Vpim::DirectoryInfo::Field.create_array(fields).each { |f| di.push_unique f }
-
-        new(di.to_a)
-      end
-
-    end
-  end
-end
+require 'vpim/property/recurrence'
 
 module Vpim
   class Icalendar
@@ -92,6 +25,7 @@ module Vpim
       include Vpim::Icalendar::Property::Priority
       include Vpim::Icalendar::Property::Location
       include Vpim::Icalendar::Property::Resources
+      include Vpim::Icalendar::Property::Recurrence
 
       def initialize(fields) #:nodoc:
         outer, inner = Vpim.outer_inner(fields)
@@ -201,28 +135,6 @@ module Vpim
         end
       end
 
-      # The recurrence rule, if any, for this event. Recurrence starts at the
-      # DTSTART time.
-      def rrule
-        propvalue 'RRULE'
-      end
-
-      # The times this event occurs, as a Vpim::Rrule.
-      #
-      # Note: the event may occur only once.
-      #
-      # Note: occurences are currently calculated only from DTSTART and RRULE,
-      # no allowance for EXDATE or other fields is made.
-      def occurences
-        Vpim::Rrule.new(dtstart, rrule)
-      end
-
-      # Check if this event overlaps with the time period later than or equal to +t0+, but
-      # earlier than +t1+.
-      def occurs_in?(t0, t1)
-        occurences.each_until(t1).detect { |t| tend = t + (duration || 0); tend > t0 }
-      end
-
     end
   end
 end

data/lib/vpim/vjournal.rb

@@ -0,0 +1,46 @@
+=begin
+  Copyright (C) 2006 Sam Roberts
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+
+require 'vpim/dirinfo'
+require 'vpim/field'
+require 'vpim/rfc2425'
+require 'vpim/vpim'
+require 'vpim/property/base'
+require 'vpim/property/common'
+require 'vpim/property/recurrence'
+
+module Vpim
+  class Icalendar
+
+    class Vjournal
+      include Vpim::Icalendar::Property::Base
+      include Vpim::Icalendar::Property::Common
+      include Vpim::Icalendar::Property::Recurrence
+
+      def initialize(fields) #:nodoc:
+        outer, inner = Vpim.outer_inner(fields)
+
+        @properties = Vpim::DirectoryInfo.create(outer)
+
+        @elements = inner
+      end
+
+      # Create a Vjournal component.
+      def self.create(fields=[])
+        di = DirectoryInfo.create([], 'VJOURNAL')
+
+        Vpim::DirectoryInfo::Field.create_array(fields).each { |f| di.push_unique f }
+
+        new(di.to_a)
+      end
+
+    end
+
+  end
+end
+

data/lib/vpim/vpim.rb

@@ -6,84 +6,26 @@
   details.
 =end
 
-#:main:Vpim
-#:title:vpim - a library to manipulate vCards and iCalendars
-#
-# Author::     Sam Roberts <sroberts@uniserve.com>
-# Copyright::  Copyright (C) 2006 Sam Roberts
-# License::    May be distributed under the same terms as Ruby
-# Homepage::   http://vpim.rubyforge.org
-#
-# vCard (RFC 2426) is a format for personal information, see Vpim::Vcard and
-# Vpim::Maker::Vcard.
-#
-# iCalendar (RFC 2445) is a format for calendar related information, see
-# Vpim::Icalendar.
-#
-# iCalendar was called vCalendar pre-IETF standardization, and since both of
-# these "v-formats" are commonly used for personal information management, the
-# library is called "vpim".
-#
-# vCard and iCalendar support is built on top of an implementation of the MIME
-# Content-Type for Directory Information (RFC 2425). The basic RFC 2425 format
-# is implemented by  Vpim::DirectoryInfo and Vpim::DirectoryInfo::Field.
-#
-# The libary is quite useable, but there is always more that could be done.
-# Since I have a more on my todo list than I have time, if you think something
-# is missing or have API suggestions, please contact me. I can't promise
-# instantaneous turnaround, but I might be able to suggest another approach,
-# and features requested by users of vPim are high priority for me.
-#
-# = Project Information
-#
-# The latest release can be downloaded from the Ruby Forge project page:
-#
-# - http://rubyforge.org/projects/vpim
-#
-# For notifications about new releases, or asking questions about vPim, please
-# subscribe to "vpim-talk":
-#
-# - http://rubyforge.org/mailman/listinfo/vpim-talk
-#
-# = Examples
-# 
-# Sample utilities are provided as examples of using vPim in samples/.
-# 
-# vCard examples are:
-# - link:ex_mkvcard.txt: example of creating a vCard
-# - link:ex_cpvcard.txt: example of copying and them modifying a vCard
-# - link:ex_mkv21vcard.txt: example of creating version 2.1 vCard
-# - link:mutt-aliases-to-vcf.txt: convert a mutt aliases file to vCards
-# - link:ex_get_vcard_photo.txt: pull photo data from a vCard
-# - link:ab-query.txt: query the OS X Address Book to find vCards
-# - link:vcf-to-mutt.txt: query vCards for matches, output in formats useful
-#   with Mutt (see link:README.mutt for details)
-# - link:tabbed-file-to-vcf.txt: convert a tab-delimited file to vCards, a
-#   (small but) complete application contributed by Dane G. Avilla, thanks!
-# - link:vcf-to-ics.txt: example of how to create calendars of birthdays from vCards
-# - link:vcf-dump.txt: utility for dumping contents of .vcf files
-# 
-# iCalendar examples are:
-# - link:ics-to-rss.txt: prints todos as RSS, or starts a WEBrick servlet
-#   that publishes todos as a RSS feed. Thanks to Dave Thomas for this idea,
-#   from http://pragprog.com/pragdave/Tech/Blog/ToDos.rdoc.
-# - link:cmd-itip.txt: prints emailed iCalendar invitations in human-readable
-#   form, and see link:README.mutt for instruction on mutt integration. I get
-#   a lot of meeting invitations from Lotus Notes/Domino users at work, and
-#   this is pretty useful in figuring out where and when I am supposed to be.
-# - link:reminder.txt: prints upcoming events and todos, by default from
-#   Apple's iCal calendars
-# - link:rrule.txt: utility for printing recurrence rules
-# - link:ics-dump.txt: utility for dumping contents of .ics files
-module Vpim
-end
-
 require 'vpim/version'
 
+#:main:README
+#:title:vpim - a library to manipulate vCards and iCalendars
 module Vpim
   # Exception used to indicate that data being decoded is invalid, the message
-  # usually gives some clue as to exactly what is invalid.
+  # should describe what is invalid.
   class InvalidEncodingError < StandardError; end
+
+  # Exception used to indicate that data being decoded is unsupported, the message
+  # should describe what is unsupported.
+  #
+  # If its unsupported, its likely because I didn't anticipate it being useful
+  # to support this, and it likely it could be supported on request.
+  class UnsupportedError < StandardError; end
+  
+  # Exception used to indicate that encoding failed, probably because the
+  # object would not result in validly encoded data. The message should
+  # describe what is unsupported.
+  class Unencodeable < StandardError; end
 end
 
 module Vpim::Methods #:nodoc:

data/lib/vpim/vtodo.rb

@@ -0,0 +1,82 @@
+=begin
+  Copyright (C) 2006 Sam Roberts
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+
+require 'vpim/dirinfo'
+require 'vpim/field'
+require 'vpim/rfc2425'
+require 'vpim/vpim'
+require 'vpim/property/base'
+require 'vpim/property/common'
+require 'vpim/property/priority'
+require 'vpim/property/location'
+require 'vpim/property/resources'
+require 'vpim/property/recurrence'
+
+module Vpim
+  class Icalendar
+
+    class Vtodo
+      include Vpim::Icalendar::Property::Base
+      include Vpim::Icalendar::Property::Common
+      include Vpim::Icalendar::Property::Priority
+      include Vpim::Icalendar::Property::Location
+      include Vpim::Icalendar::Property::Resources
+      include Vpim::Icalendar::Property::Recurrence
+
+      def initialize(fields) #:nodoc:
+        outer, inner = Vpim.outer_inner(fields)
+
+        @properties = Vpim::DirectoryInfo.create(outer)
+
+        @elements = inner
+      end
+
+      # Create a new Vtodo object.
+      #
+      # If specified, +fields+ must be either an array of Field objects to
+      # add, or a Hash of String names to values that will be used to build
+      # Field objects. The latter is a convenient short-cut allowing the Field
+      # objects to be created for you when called like:
+      #
+      #   Vtodo.create('SUMMARY' => "buy mangos")
+      #
+      # TODO - maybe todos are usually created in a particular way? I can
+      # make it easier. Ideally, I would like to make it hard to encode an invalid
+      # Event.
+      def Vtodo.create(fields=[])
+        di = DirectoryInfo.create([], 'VTODO')
+
+        Vpim::DirectoryInfo::Field.create_array(fields).each { |f| di.push_unique f }
+
+        new(di.to_a)
+      end
+
+      # The date and time that a to-do is expected to be completed, a Time.
+      def due
+        proptime 'DUE'
+      end
+
+      # The date and time that a to-do was actually completed, a Time.
+      def completed
+        proptime 'COMPLETED'
+      end
+
+      # The percentage completetion of the to-do, between 0 and 100. 0 means it hasn't
+      # started, 100 that it has been completed.
+      #
+      # TODO - the handling of this property isn't tied to either COMPLETED: or
+      # STATUS:, but perhaps it should be?
+      def percent_complete
+        propinteger 'PERCENT-COMPLETE'
+      end
+
+    end
+
+  end
+end
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: vpim
 version: !ruby/object:Gem::Version 
-  version: "0.323"
-date: 2006-03-20 00:00:00 -08:00
+  version: "0.357"
+date: 2006-03-31 00:00:00 -08:00
 summary: a library to manipulate vCards and iCalendars
 require_paths: 
 - lib
@@ -29,6 +29,8 @@ authors:
 - Sam Roberts
 files: 
 - lib/vpim.rb
+- lib/vpim/address.rb
+- lib/vpim/attachment.rb
 - lib/vpim/date.rb
 - lib/vpim/dirinfo.rb
 - lib/vpim/duration.rb
@@ -41,12 +43,15 @@ files:
 - lib/vpim/vcard.rb
 - lib/vpim/version.rb
 - lib/vpim/vevent.rb
+- lib/vpim/vjournal.rb
 - lib/vpim/vpim.rb
+- lib/vpim/vtodo.rb
 - lib/vpim/maker/vcard.rb
 - lib/vpim/property/base.rb
 - lib/vpim/property/common.rb
 - lib/vpim/property/location.rb
 - lib/vpim/property/priority.rb
+- lib/vpim/property/recurrence.rb
 - lib/vpim/property/resources.rb
 test_files: []