icalendar 1.4.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fac2f5451b7ca770f2ac6c7a821cde7019b243b0
-  data.tar.gz: 2e67f1b9d5f1e0194fc3a988674e18095947dc64
+  metadata.gz: 7f4b5d7252174baceb4b7e37a64286aaa38523ff
+  data.tar.gz: bfa01a3b7d32a7216f82a63f3b216ddfc2bc8745
 SHA512:
-  metadata.gz: f5d251b5bc4f461d7870a47b97f0b31ab7333e2cd7db214903b15275a9994f152f19330fe4a4a926c6c26a90d885c856f4ab9cebee55f6a3c1cdc488a044e6f0
-  data.tar.gz: 85137efbd0de1f1233f043dace763619e1332ba49a38a709da4a3c30243a7b10b9cc452bf47d5e13c78a214b95137aa200e7769b888c15998f6686c80deeac58
+  metadata.gz: a79833843dcf6a77bc4d4135e25b1bdaa436db93c4195ef76a40e3e8f00fc01dbf28c24871bac057bf362eea201b066b655a2fe16215da5a32576221d3393658
+  data.tar.gz: a2a2d04e8784be3f057cc9f23adcf45ec365282d035cb8655701fe6d08c531381dc7c0fceb8fb42948f8226042d20b1f7cee56a51e3d0ac46dcf1500cd387cfa

data/History.txt

@@ -1,3 +1,6 @@
+=== 1.5.0 2013-12-06
+ * Support for custom x- properties - Jake Craige
+
 === 1.4.5 2013-11-14
  * Fix Geo accessor methods - bouzuya
  * Add ical_multiline_property :related_to for Alarm

data/README.md

@@ -189,7 +189,7 @@ TIMEZONES
 Unicode
 ---
 
-Add `$KCODE = 'u'` to make icalender work correctly with Utf8 texts
+Add `$KCODE = 'u'` to make icalendar work correctly with Utf8 texts
 
 Parsing iCalendars
 ---

data/lib/icalendar/base.rb

@@ -11,7 +11,7 @@ require 'logger'
 
 module Icalendar #:nodoc:
 
-  VERSION = '1.4.5'
+  VERSION = '1.5.0'
 
   # A simple error class to differentiate iCalendar library exceptions
   # from ruby language exceptions or others.

data/lib/icalendar/component.rb

@@ -37,6 +37,8 @@ module Icalendar
   # Freebusy time information, or an Alarm.
   class Component < Icalendar::Base
 
+    CAL_EXTENSION_REGEX = /\Ax_[a-z_]+=?\Z/
+
     meta_include HashAttrs
 
     attr_reader :name
@@ -416,32 +418,30 @@ module Icalendar
       end
     end
 
-    def method_missing(method, *args)
-      @@logger.debug("Inside method_missing...")
-      method_name = method.to_s.downcase
-
-      super unless method_name =~ /x_.*/
+    public
 
-      # x-properties are accessed with underscore but stored with a dash so
-      # they output correctly and we don't have to special case the
-      # output code, which would require checking every property.
-      if args.size > 0 # Its a setter
-        # Pull off the possible equals
-        @properties[method_name[/x_[^=]*/].gsub('x_', 'x-')] = args.first
-      else # Or its a getter
-        return @properties[method_name.gsub('x_', 'x-')]
-      end
-    end
+    def method_missing(method_name, *args, &block)
+      # Allow proprietary calendar extensions to be set
+      #
+      # Example:
+      #   cal.x_wr_calname = "iCalendar Calendar"
+      if method_name =~ CAL_EXTENSION_REGEX
 
-    public
+        # Make sure to remove '=' from the end of the method_name so we can
+        # define it
+        name = method_name.to_s.chomp '='
 
-    def respond_to?(method_name, include_all=false)
-      if method_name.to_s.downcase =~ /x_.*/
-        true
+        self.class.class_eval do
+          ical_multiline_property name, name, name
+        end
+        send method_name, *args
       else
         super
       end
     end
 
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s =~ CAL_EXTENSION_REGEX || super
+    end
   end # class Component
 end

data/test/component/test_event.rb

@@ -23,23 +23,32 @@ class TestEvent < Test::Unit::TestCase
   def test_new
     assert(@event)
   end
-  
+
   # Properties that can only occur once per event
   def test_single_properties
     @event.ip_class = "PRIVATE"
-    
+
     @cal.add_event(@event)
-    
+
     cals = Icalendar::Parser.new(@cal.to_ical).parse
     cal2 = cals.first
     event2 = cal2.events.first
-    
+
     assert_equal("PRIVATE", event2.ip_class)
   end
+
+  def test_proprietary_attributes
+    @cal.add_event @event
+    @event.x_custom_property = 'My Custom Property'
+
+    result = Icalendar::Parser.new(@cal.to_ical).parse.first.events.first
+
+    assert_equal ['My Custom Property'], result.x_custom_property
+  end
 end
 
 class TestEventWithSpecifiedTimezone < Test::Unit::TestCase
-  
+
   def setup
     src = <<EOS
 BEGIN:VCALENDAR
@@ -60,28 +69,28 @@ EOS
     @calendar = Icalendar.parse(src).first
     @event = @calendar.events.first
   end
-  
+
   def test_event_is_parsed
     assert_not_nil(@event)
   end
-  
+
   def test_dtstart_should_understand_icalendar_tzid
     assert_respond_to(@event.dtstart, :icalendar_tzid)
   end
-  
+
   def test_dtstart_tzid_should_be_correct
     # puts "#{@event.dtstart.icalendar_tzid} #{@event.dtstart}"
     assert_equal("America/Chicago",@event.dtstart.icalendar_tzid)
   end
-  
+
   def test_dtend_tzid_should_be_correct
     assert_equal("America/Chicago",@event.dtend.icalendar_tzid)
   end
-  
+
 end
 
 class TestEventWithZuluTimezone < Test::Unit::TestCase
-  
+
   def setup
     src = <<EOS
 BEGIN:VCALENDAR
@@ -102,24 +111,24 @@ EOS
     @calendar = Icalendar.parse(src).first
     @event = @calendar.events.first
   end
-  
+
   def test_event_is_parsed
     assert_not_nil(@event)
   end
-  
+
   def test_dtstart_tzid_should_be_correct
     # puts "#{@event.dtstart.icalendar_tzid} #{@event.dtstart}"
     assert_equal("UTC",@event.dtstart.icalendar_tzid)
   end
-  
+
   def test_dtend_tzid_should_be_correct
     assert_equal("UTC",@event.dtend.icalendar_tzid)
   end
-  
+
 end
 
 class TestEventWithFloatingTimezone < Test::Unit::TestCase
-  
+
   def setup
     src = <<EOS
 BEGIN:VCALENDAR
@@ -140,24 +149,24 @@ EOS
     @calendar = Icalendar.parse(src).first
     @event = @calendar.events.first
   end
-  
+
   def test_event_is_parsed
     assert_not_nil(@event)
   end
-  
+
   def test_dtstart_tzid_should_be_nil
     # puts "#{@event.dtstart.icalendar_tzid.inspect} #{@event.dtstart}"
     assert_nil(@event.dtstart.icalendar_tzid)
   end
-  
+
   def test_dtend_tzid_should_be_nil
     assert_nil(@event.dtend.icalendar_tzid)
   end
-  
+
 end
 
 class TestAllDayEventWithoutTime < Test::Unit::TestCase
-  
+
   def setup
     src = <<EOS
 BEGIN:VCALENDAR
@@ -181,22 +190,22 @@ EOS
     @calendar = Icalendar.parse(src).first
     @event = @calendar.events.first
   end
-  
+
   def test_event_is_parsed
     assert_not_nil(@event)
   end
-  
+
   def test_dtstart_set_correctly
     assert_equal("20090110", @event.dtstart.to_ical)
   end
-  
+
 end
 
-class TestRecurringEventWithCount < Test::Unit::TestCase 
+class TestRecurringEventWithCount < Test::Unit::TestCase
   # DTSTART;TZID=US-Eastern:19970902T090000
   # RRULE:FREQ=DAILY;COUNT=10
   # ==> (1997 9:00 AM EDT)September 2-11
-  
+
   def setup
     src = <<EOS
 BEGIN:VCALENDAR
@@ -218,24 +227,24 @@ EOS
     @calendar = Icalendar.parse(src).first
     @event = @calendar.events.first
   end
-  
+
   def test_event_is_parsed
     assert_not_nil(@event)
   end
-  
+
   def test_recurrence_rules_should_return_a_recurrence_rule_array
     assert_equal 1, @event.recurrence_rules.length
     assert_kind_of(Icalendar::RRule, @event.recurrence_rules.first)
   end
-  
+
   def test_occurrences_after_with_start_before_start_at_should_return_count_occurrences
     assert_equal 10, @event.occurrences_starting(Time.utc(1997, 9, 2, 8, 30, 0, 0)).length
   end
-                  
+
 #  def test_occurrences_after_with_start_before_start_at_should_return_an_event_with_the_dtstart_as_the_first_event
 #    assert_equal @event.dtstart.to_s, @event.occurrences_starting(Time.utc(1997, 9, 2, 8, 30, 0, 0)).first.dtstart.to_s
 #  end
-#  
+#
 #  def test_occurrences_after_with_start_before_start_at_should_return_events_with_the_correct_dtstart_values
 #    expected = (0..9).map {|delta| (@event.dtstart + delta).to_s}
 #    assert_equal expected, @event.occurrences_starting(Time.utc(1997, 9, 2, 8, 30, 0, 0)).map {|occurence| occurence.dtstart.to_s}

data/test/test_calendar.rb

@@ -6,7 +6,7 @@ class TestCalendar < Test::Unit::TestCase
   include Icalendar
    # Generate a calendar using the raw api, and then spit it out
    # as a string.  Parse the string and make sure everything matches up.
-   def test_raw_generation    
+   def test_raw_generation
       # Create a fresh calendar
       cal = Calendar.new
 
@@ -14,7 +14,7 @@ class TestCalendar < Test::Unit::TestCase
       cal.version = "3.2"
       cal.prodid = "test-prodid"
 
-      # Now generate the string and then parse it so we can verify 
+      # Now generate the string and then parse it so we can verify
       # that everything was set, generated and parsed correctly.
       calString = cal.to_ical
 
@@ -46,29 +46,29 @@ class TestCalendar < Test::Unit::TestCase
    def test_create_multiple_event_calendar
        # Create a fresh calendar
        cal = Calendar.new
-       [1,2,3].each do |t| 
+       [1,2,3].each do |t|
            cal.event do
                self.dtend = "1997090#{t}T190000Z"
                self.summary = "This is summary #{t}"
            end
        end
-       [1,2,3].each do |t| 
+       [1,2,3].each do |t|
            cal.todo do
                self.summary = "test #{t} todo"
            end
        end
        cal.to_ical
    end
-   
+
    def test_find
      cal = Calendar.new
 
      # add some events so we actually have to search
-     10.times do 
+     10.times do
        cal.event
-       cal.todo 
+       cal.todo
        cal.journal
-       cal.freebusy 
+       cal.freebusy
      end
      event = cal.events[5]
      assert_equal(event, cal.find_event(event.uid))
@@ -78,8 +78,27 @@ class TestCalendar < Test::Unit::TestCase
 
      journal = cal.journals[5]
      assert_equal(journal, cal.find_journal(journal.uid))
-     
+
      freebusy = cal.freebusys[5]
      assert_equal(freebusy, cal.find_freebusy(freebusy.uid))
    end
+
+   def test_set_and_get_proprietary_attributes
+     cal = Calendar.new
+
+     cal.x_wr_name = 'Icalendar Calendar'
+
+     calString = cal.to_ical
+
+     cals = Parser.new(calString).parse
+
+     cal2 = cals.first
+     assert_equal(["Icalendar Calendar"], cal2.x_wr_name)
+   end
+
+   def test_respond_to_proprietary_attributes
+     cal = Calendar.new
+
+     assert_respond_to(cal, 'x_wr_name=')
+   end
 end

data/test/test_component.rb

@@ -64,7 +64,7 @@ class TestComponent < Test::Unit::TestCase
 
   def test_x_property
     @event.x_foobar = "my-custom-property"
-    assert_equal("my-custom-property", @event.x_foobar)
+    assert_equal(["my-custom-property"], @event.x_foobar)
   end
 
   def test_method_missing_no_x

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icalendar
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.5.0
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A ruby implementation of the iCalendar specification (RFC-2445).