vpim 0.17 → 0.323

data/lib/vpim/vevent.rb

@@ -10,69 +10,55 @@ require 'vpim/dirinfo'
 require 'vpim/field'
 require 'vpim/rfc2425'
 require 'vpim/vpim'
-
-=begin
-A vTodo that is done:
-
-BEGIN:VTODO
-COMPLETED:20040303T050000Z
-DTSTAMP:20040304T011707Z
-DTSTART;TZID=Canada/Eastern:20030524T115238
-SEQUENCE:2
-STATUS:COMPLETED
-SUMMARY:Wash Car
-UID:E7609713-8E13-11D7-8ACC-000393AD088C
-END:VTODO
-
-BEGIN:VTODO
-DTSTAMP:20030909T015533Z
-DTSTART;TZID=Canada/Eastern:20030808T000000
-SEQUENCE:1
-SUMMARY:Renew Passport
-UID:EC76B256-BBE9-11D7-8401-000393AD088C
-END:VTODO
-
-
-=end
+require 'vpim/property/base'
+require 'vpim/property/common'
+require 'vpim/property/priority'
+require 'vpim/property/location'
+require 'vpim/property/resources'
 
 module Vpim
   class Icalendar
-    class Vtodo
-      def initialize(fields) #:nodoc:
-        @fields = fields
+    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
 
-        # TODO - don't get properties here, put the accessor in a module,
-        # which can cache the results.
+      # Create a Vjournal component.
+      def self.create(fields=[])
+        di = DirectoryInfo.create([], 'VJOURNAL')
 
-        @summary       = @properties.text('SUMMARY').first
-        @description   = @properties.text('DESCRIPTION').first
-        @comment       = @properties.text('COMMENT').first
-        @location      = @properties.text('LOCATION').first
-        @status        = @properties.text('STATUS').first
-        @uid           = @properties.text('UID').first
-        @priority      = @properties.text('PRIORITY').first
+        Vpim::DirectoryInfo::Field.create_array(fields).each { |f| di.push_unique f }
 
-        # See "TODO - fields" in dirinfo.rb
-        @dtstamp       = @properties.field('dtstamp')
-        @dtstart       = @properties.field('dtstart')
-        @dtend         = @properties.field('dtend')
-        @duration      = @properties.field('duration')
-        @due           = @properties.field('due')
-        @rrule         = @properties['rrule']
+        new(di.to_a)
+      end
 
-        # Need to seperate status-handling out into a module...
-        @status_values = [ 'COMPLETED' ];
+    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
 
-      attr_reader :description, :summary, :comment, :location
-      attr_reader :properties, :fields # :nodoc:
+      def initialize(fields) #:nodoc:
+        outer, inner = Vpim.outer_inner(fields)
+
+        @properties = Vpim::DirectoryInfo.create(outer)
+
+        @elements = inner
+      end
 
       # Create a new Vtodo object.
       #
@@ -94,37 +80,6 @@ module Vpim
         new(di.to_a)
       end
 
-=begin
-I think that the initialization shouldn't be done in the #initialize, so, for example,
-  @status = @properties.text('STATUS').first
-should be in the method below.
-
-That way, I can construct a Vtodo by just including a module for each field that is allowed
-in a Vtodo, simply.
-=end
-      def status
-        if(!@status); return nil; end
-
-        s = @status.upcase
-
-        unless @status_values.include?(s)
-          raise Vpim::InvalidEncodingError, "Invalid status '#{@status}'"
-        end
-
-        s
-      end
-
-      # +priority+ is a number from 1 to 9, with 1 being the highest and 0
-      # meaning "no priority", equivalent to not specifying the PRIORITY field.
-      # Other values are reserved by RFC2446.
-      def priority
-        p = @priority ? @priority.to_i : 0
-
-        if( p < 0 || p > 9 )
-          raise Vpim::InvalidEncodingError, 'Invalid priority #{@priority} - it must be 0-9!'
-        end
-        p
-      end
     end
   end
 end
@@ -132,35 +87,20 @@ end
 module Vpim
   class Icalendar
     class Vevent
-      def initialize(fields) #:nodoc:
-        @fields = fields
+      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
 
-        # TODO - don't get properties here, put the accessor in a module,
-        # which can cache the results.
-
-        @summary       = @properties.text('SUMMARY').first
-        @description   = @properties.text('DESCRIPTION').first
-        @comment       = @properties.text('COMMENT').first
-        @location      = @properties.text('LOCATION').first
-        @status        = @properties.text('STATUS').first
-        @uid           = @properties.text('UID').first
-
         # See "TODO - fields" in dirinfo.rb
-        @dtstamp       = @properties.field('dtstamp')
-        @dtstart       = @properties.field('dtstart')
-        @dtend         = @properties.field('dtend')
-        @duration      = @properties.field('duration')
-        @rrule         = @properties['rrule']
-
-        # Need to seperate status-handling out into a module...
-        @status_values = [ 'TENTATIVE', 'CONFIRMED', 'CANCELLED' ];
-
       end
 
       # Create a new Vevent object. All events must have a DTSTART field,
@@ -195,13 +135,6 @@ module Vpim
           )
       end
 
-      attr_reader :description, :summary, :comment, :location
-      attr_reader :properties, :fields # :nodoc:
-
-      #--
-      # The methods below should be shared, somehow, by all calendar components, not just Events.
-      #++
-
       # Accept an event invitation. The +invitee+ is the Address that wishes
       # to accept the event invitation as confirmed.
       def accept(invitee)
@@ -225,68 +158,24 @@ module Vpim
         Vevent.new(fields)
       end
 
-      # Status values are not rejected during decoding. However, if the
-      # status is requested, and it's value is not one of the defined
-      # allowable values, an exception is raised.
-      def status
-        if(!@status); return nil; end
-
-        s = @status.upcase
-
-        unless @status_values.include?(s)
-          raise Vpim::InvalidEncodingError, "Invalid status '#{@status}'"
-        end
-
-        s
-      end
-
-      # TODO - def status? ...
-
-      # TODO - def status= ...
-
-      # The unique identifier of this calendar component, a string. It cannot be
-      # nil, if it is not found in the component, the calendar is malformed, and
-      # this method will raise an exception.
-      def uid
-        if(!@uid)
-          raise Vpim::InvalidEncodingError, 'Invalid component - no UID field was found!'
-        end
-
-        @uid
-      end
-
-      # The time stamp for this calendar component. Describe what this is....
-      # This field is required!
-      def dtstamp
-        if(!@dtstamp)
-          raise Vpim::InvalidEncodingError, 'Invalid component - no DTSTAMP field was found!'
-        end
-
-        @dtstamp.to_time.first
-      end
-
-      # The start time for this calendar component. Describe what this is....
-      # This field is required!
-      def dtstart
-        if(!@dtstart)
-          raise Vpim::InvalidEncodingError, 'Invalid component - no DTSTART field was found!'
-        end
-
-        @dtstart.to_time.first
-      end
-
 =begin
       # Set the start time for the event to +start+, a Time object.
       # TODO - def dtstart=(start) ... start should be allowed to be Time/Date/DateTime
 =end
 
+      def transparency
+        proptoken 'TRANSP', ["OPAQUE", "TRANSPARENT"], "OPAQUE"
+      end
+
       # The duration in seconds of a Event, Todo, or Vfreebusy component, or
       # for Alarms, the delay period prior to repeating the alarm. The
       # duration is calculated from the DTEND and DTBEGIN fields if the
       # DURATION field is not present. Durations of zero seconds are possible.
       def duration
-        if(!@duration)
-          return nil unless @dtend
+        dur = @properties.field 'DURATION'
+        dte = @properties.field 'DTEND'
+        if !dur
+          return nil unless dte
 
           b = dtstart
           e = dtend
@@ -294,7 +183,7 @@ module Vpim
           return (e - b).to_i
         end
 
-        Icalendar.decode_duration(@duration.value_raw)
+        Icalendar.decode_duration(dur.value_raw)
       end
 
       # The end time for this calendar component. For an Event, if there is no
@@ -302,8 +191,9 @@ module Vpim
       # However, the end time will be calculated from the event duration, if
       # present.
       def dtend
-        if(@dtend)
-          @dtend.to_time.first
+        dte = @properties.field 'DTEND'
+        if dte
+          dte.to_time.first
         elsif duration
             dtstart + duration
         else
@@ -314,7 +204,7 @@ module Vpim
       # The recurrence rule, if any, for this event. Recurrence starts at the
       # DTSTART time.
       def rrule
-        @rrule
+        propvalue 'RRULE'
       end
 
       # The times this event occurs, as a Vpim::Rrule.
@@ -324,7 +214,7 @@ module Vpim
       # 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)
+        Vpim::Rrule.new(dtstart, rrule)
       end
 
       # Check if this event overlaps with the time period later than or equal to +t0+, but
@@ -333,46 +223,6 @@ module Vpim
         occurences.each_until(t1).detect { |t| tend = t + (duration || 0); tend > t0 }
       end
 
-      # Return the event organizer, an object of Icalendar::Address (or nil if
-      # there is no ORGANIZER field).
-      #
-      # TODO - verify that it is illegal for there to be more than one
-      # ORGANIZER, if more than one is allowed, this needs to return an array.
-      def organizer
-        unless instance_variables.include? "@organizer"
-          @organizer = @properties.field('ORGANIZER')
-
-          if @organizer
-            @organizer = Icalendar::Address.new(@organizer)
-          end
-        end
-        @organizer.freeze
-      end
-
-      # Return an array of attendees, an empty array if there are none. The
-      # attendees are objects of Icalendar::Address. If +uri+ is specified
-      # only the return the attendees with this +uri+.
-      def attendees(uri = nil)
-        unless instance_variables.include? "@attendees"
-          @attendees = @properties.enum_by_name('ATTENDEE').map { |a| Icalendar::Address.new(a).freeze }
-          @attendees.freeze
-        end
-        if uri
-          @attendees.select { |a| a == uri } .freeze
-        else
-          @attendees
-        end
-      end
-
-      # Return true if the +uri+, usually a mailto: URI, is an attendee.
-      def attendee?(uri)
-        attendees.include? uri
-      end
-
-      # CONTACT - value is text, parameters are ALTREP and LANGUAGE.
-      #
-      # textual contact information, or an altrep referring to a URI pointing
-      # at a vCard or LDAP entry...
     end
   end
 end

data/lib/vpim/vpim.rb

@@ -12,7 +12,6 @@
 # Author::     Sam Roberts <sroberts@uniserve.com>
 # Copyright::  Copyright (C) 2006 Sam Roberts
 # License::    May be distributed under the same terms as Ruby
-# Version::    0.17
 # Homepage::   http://vpim.rubyforge.org
 #
 # vCard (RFC 2426) is a format for personal information, see Vpim::Vcard and
@@ -21,17 +20,17 @@
 # iCalendar (RFC 2445) is a format for calendar related information, see
 # Vpim::Icalendar.
 #
-# iCalendar was called vCalendar pre-IETF standaradization, and since both of
-# these "v-formats" are commonly used personal information management, the
+# 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 mature to the point of useability, but there is always more
-# that could be done. I have a very long todo list, so if you think something
-# is missing, or have API suggestions, please contact me. I can't promise
+# 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.
 #
@@ -77,21 +76,17 @@
 # - link:rrule.txt: utility for printing recurrence rules
 # - link:ics-dump.txt: utility for dumping contents of .ics files
 module Vpim
-  VERSION = "0.17"
-
-  # Return the API version as a string.
-  def Vpim.version
-    VERSION
-  end
 end
 
+require 'vpim/version'
+
 module Vpim
   # Exception used to indicate that data being decoded is invalid, the message
   # usually gives some clue as to exactly what is invalid.
   class InvalidEncodingError < StandardError; end
 end
 
-module Vpim::Methods
+module Vpim::Methods #:nodoc:
   module_function
 
   # Case-insensitive comparison of +str0+ to +str1+, returns true or false.
@@ -111,9 +106,9 @@ module Vpim::Methods
   def casecmp?(str0, str1)
     if str0 == nil
       if str1 == nil
-      return true
+        return true
       else
-        return fasle
+        return false
       end
     end
 

data/lib/vpim.rb

@@ -0,0 +1,14 @@
+=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
+
+# I think a file like this may be required by ruby-gems.
+
+require 'vpim/icalendar'
+require 'vpim/vcard'
+require 'vpim/maker/vcard'
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: vpim
 version: !ruby/object:Gem::Version 
-  version: "0.17"
-date: 2006-03-08 00:00:00 -08:00
+  version: "0.323"
+date: 2006-03-20 00:00:00 -08:00
 summary: a library to manipulate vCards and iCalendars
 require_paths: 
 - lib
@@ -28,36 +28,26 @@ cert_chain:
 authors: 
 - Sam Roberts
 files: 
-- lib/vpim
-- lib/vpim/agent
+- lib/vpim.rb
 - lib/vpim/date.rb
-- lib/vpim/date.rb~
 - lib/vpim/dirinfo.rb
-- lib/vpim/dirinfo.rb~
 - lib/vpim/duration.rb
-- lib/vpim/duration.rb~
 - lib/vpim/enumerator.rb
-- lib/vpim/enumerator.rb~
 - lib/vpim/field.rb
-- lib/vpim/field.rb~
 - lib/vpim/icalendar.rb
-- lib/vpim/icalendar.rb~
-- lib/vpim/maker
 - lib/vpim/rfc2425.rb
-- lib/vpim/rfc2425.rb~
 - lib/vpim/rrule.rb
-- lib/vpim/rrule.rb~
 - lib/vpim/time.rb
-- lib/vpim/time.rb~
 - lib/vpim/vcard.rb
-- lib/vpim/vcard.rb~
+- lib/vpim/version.rb
 - lib/vpim/vevent.rb
-- lib/vpim/vevent.rb~
 - lib/vpim/vpim.rb
-- lib/vpim/vpim.rb~
-- lib/vpim/agent/plist.rb
 - lib/vpim/maker/vcard.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/resources.rb
 test_files: []
 
 rdoc_options: []

data/lib/vpim/agent/plist.rb

@@ -1,86 +0,0 @@
-# http://www2a.biglobe.ne.jp/~seki/ruby/src/plist.rb
-require 'rexml/document'
-require 'time'
-
-class Plist #:nodoc:
-   def self.file_to_plist(fname)
-     File.open(fname) do |fp|
-       doc = REXML::Document.new(fp)
-       return self.new.visit(REXML::XPath.match(doc, '/plist/')[0])
-     end
-   end
-
-   def initialize
-     setup_method_table
-   end
-
-   def visit(node)
-     visit_one(node.elements[1])
-   end
-
-   def visit_one(node)
-     choose_method(node.name).call(node)
-   end
-
-   def visit_null(node)
-     p node if $DEBUG
-     nil
-   end
-
-   def visit_dict(node)
-     dict = {}
-     es =  node.elements.to_a
-     while key = es.shift
-       next unless key.name == 'key'
-       dict[key.text] = visit_one(es.shift)
-     end
-     dict
-   end
-
-   def visit_array(node)
-     node.elements.collect do |x|
-       visit_one(x)
-     end
-   end
-
-   def visit_integer(node)
-     node.text.to_i
-   end
-
-   def visit_real(node)
-     node.text.to_f
-   end
-
-   def visit_string(node)
-     node.text.to_s
-   end
-
-   def visit_date(node)
-     Time.parse(node.text.to_s)
-   end
-
-   def visit_true(node)
-     true
-   end
-
-   def visit_false(node)
-     false
-   end
-
-   private
-   def choose_method(name)
-     @method.fetch(name, method(:visit_null))
-   end
-
-   def setup_method_table
-     @method = {}
-     @method['dict'] = method(:visit_dict)
-     @method['integer'] = method(:visit_integer)
-     @method['real'] = method(:visit_real)
-     @method['string'] = method(:visit_string)
-     @method['date'] = method(:visit_date)
-     @method['true'] = method(:visit_true)
-     @method['false'] = method(:visit_false)
-     @method['array'] = method(:visit_array)
-   end
-end