icalendar 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 961c1bb54f8d041206166d436da335415ffa8373
-  data.tar.gz: 559c04b6e5456b74649baf53db4c60d2dd2f2485
+  metadata.gz: 1247afeb6249a4562ed23fdf9a01345f10513d8e
+  data.tar.gz: edb231f0a00055c53bafec1e92a4006b741d14fb
 SHA512:
-  metadata.gz: e0e4f2ee01e35b88c0d8916f7a17bd441338b6eda24aba19ab4e78c6cbf25b4bf2614fa94e82c1e085b9cf4bd006a863d690e17234c05aad0a670bc883f97534
-  data.tar.gz: db81643632c9054fcc1595d344949cd36848b7c3c5dea2fccced3322069320dde48c7ece037f6087025df04719b86b62fe369a1f34fbfb7a1c59107b2bbeac9a
+  metadata.gz: 3c93f4624d028b364b42ed6054df4b7bffe2296bdd392985aff5d929be4fff0ebea3ff15ae93799277935497385d28f0f210ff7928309dac9488b42d1c25bc0c
+  data.tar.gz: 59a6178deb2fc347b0487306aff201d64360ed52aae18fe3e905082988f827f7c6f509fdde39d15461cfb38a1b34b506c6caaa821fe3ede4af0eda7259121570

data/History.txt

@@ -1,3 +1,10 @@
+=== 2.2.0 2014-09-23
+ * Default to non-strict parsing
+ * Enable sorting events by dtstart - Mark Rickert
+ * Better tolerate malformed lines in parser - Gary Shutler
+ * Deduplicate timezone code - Jan Vlnas
+ * Eliminate warnings - rochefort
+
 === 2.1.2 2014-09-10
  * Fix timezone abbreviation generation - Jan Vlnas
  * Fix timezone repeat rules for end of month

data/README.md

@@ -233,13 +233,13 @@ Parsing iCalendars
     puts "start date-time timezone: #{event.dtstart.ical_params['tzid']}"
     puts "summary: #{event.summary}"
 
-You can also create a `Parser` instance directly, this can be used to disable
-the strict parsing:
+You can also create a `Parser` instance directly, this can be used to enable
+strict parsing:
 
-    # Some calendars contain non-standard parameters (e.g. Apple iCloud
-    # calendars). You can pass in a `strict` value when creating a new parser.
-    unstrict_parser = Icalendar::Parser.new(cal_file, false)
-    cal = unstrict_parser.parse
+    # Sometimes you want to strongly verify only rfc-approved properties are
+    # used
+    strict_parser = Icalendar::Parser.new(cal_file, true)
+    cal = strict_parser.parse
 
 Finders
 ---

data/icalendar.gemspec

@@ -18,6 +18,9 @@ variety of calendaring applications.
   s.post_install_message = <<-EOM
 HEADS UP! iCalendar 2.0 is not backwards-compatible with 1.x. Please see the README for the new syntax
 
+HEADS UP! icalendar 2.2.0 switches to non-strict parsing as default. Please see the README if you
+rely on strict parsing for information on how to enable it.
+
 ActiveSupport is required for TimeWithZone support, but not required for general use.
   EOM
 

data/lib/icalendar/parser.rb

@@ -4,7 +4,7 @@ module Icalendar
 
     attr_reader :source, :strict
 
-    def initialize(source, strict = true)
+    def initialize(source, strict = false)
       if source.respond_to? :gets
         @source = source
       elsif source.respond_to? :to_s
@@ -119,9 +119,18 @@ module Icalendar
     PARAM = "(#{NAME})=(#{PVALUE}(?:,#{PVALUE})*)"
     VALUE = '.*'
     LINE = "(?<name>#{NAME})(?<params>(?:;#{PARAM})*):(?<value>#{VALUE})"
+    BAD_LINE = "(?<name>#{NAME})(?<params>(?:;#{PARAM})*)"
 
     def parse_fields(input)
-      parts = %r{#{LINE}}.match(input) or fail "Invalid iCalendar input line: #{input}"
+      if parts = %r{#{LINE}}.match(input)
+        value = parts[:value]
+      else
+        parts = %r{#{BAD_LINE}}.match(input) unless strict?
+        parts or fail "Invalid iCalendar input line: #{input}"
+        # Non-strict and bad line so use a value of empty string
+        value = ''
+      end
+
       params = {}
       parts[:params].scan %r{#{PARAM}} do |match|
         param_name = match[0].downcase
@@ -134,7 +143,7 @@ module Icalendar
       {
         name: parts[:name].downcase.gsub('-', '_'),
         params: params,
-        value: parts[:value]
+        value: value
       }
     end
   end

data/lib/icalendar/tzinfo.rb

@@ -128,38 +128,29 @@ module TZInfo
   end
 
   class TimezonePeriod
+
+    # For DST, use the start_transition,
+    # for standard TZ, use the following period (starting from the end_transition).
     def daylight
-      Icalendar::Timezone::Daylight.new.tap do |day|
-        if dst?
-          day.tzname = abbreviation.to_s
-          day.tzoffsetfrom = start_transition.offset_from
-          day.tzoffsetto = start_transition.offset_to
-          day.dtstart = start_transition.dtstart
-          day.rrule = start_transition.rrule unless end_transition.nil?
-        else
-          day.tzname = end_transition.offset_abbreviation
-          day.tzoffsetfrom = end_transition.offset_from
-          day.tzoffsetto = end_transition.offset_to
-          day.dtstart = end_transition.dtstart
-          day.rrule = end_transition.rrule
+      transition = dst? ? start_transition : end_transition
+      day = Icalendar::Timezone::Daylight.new
+      build_timezone(day, transition) do |tz|
+        # rrule should not be set for the current [==DST/daylight] period
+        # if there is no recurrence rule for the end transition
+        if !dst? || !end_transition.nil?
+          tz.rrule = transition.rrule
         end
       end
     end
 
+    # For standard TZ, use the start_transition,
+    # for DST, use the following period, (starting from the end_transition)
     def standard
-      Icalendar::Timezone::Standard.new.tap do |std|
-        if dst?
-          std.tzname = end_transition.offset_abbreviation
-          std.tzoffsetfrom = end_transition.offset_from
-          std.tzoffsetto = end_transition.offset_to
-          std.dtstart = end_transition.dtstart
-          std.rrule = end_transition.rrule
-        else
-          std.tzname = abbreviation.to_s
-          std.tzoffsetfrom = start_transition.offset_from
-          std.tzoffsetto = start_transition.offset_to
-          std.dtstart = start_transition.dtstart
-          std.rrule = start_transition.rrule unless end_transition.nil?
+      transition = dst? ? end_transition : start_transition
+      std = Icalendar::Timezone::Standard.new
+      build_timezone(std, transition) do |tz|
+        if dst? || !end_transition.nil?
+          tz.rrule = transition.rrule
         end
       end
     end
@@ -172,5 +163,16 @@ module TZInfo
         std.dtstart = DateTime.new(1970).strftime '%Y%m%dT%H%M%S'
       end
     end
+
+    private
+    def build_timezone(timezone, transition)
+      timezone.tap do |tz|
+        tz.tzname = transition.offset_abbreviation
+        tz.tzoffsetfrom = transition.offset_from
+        tz.tzoffsetto = transition.offset_to
+        tz.dtstart = transition.dtstart
+        yield tz
+      end
+    end
   end
 end

data/lib/icalendar/values/date.rb

@@ -20,7 +20,15 @@ module Icalendar
         value.strftime FORMAT
       end
 
+      def <=>(other)
+        if other.is_a?(Icalendar::Values::Date) || other.is_a?(Icalendar::Values::DateTime)
+          value_ical <=> other.value_ical
+        else
+          nil
+        end
+      end
+
     end
 
   end
-end
+end

data/lib/icalendar/values/date_time.rb

@@ -28,7 +28,15 @@ module Icalendar
         end
       end
 
+      def <=>(other)
+        if other.is_a?(Icalendar::Values::Date) || other.is_a?(Icalendar::Values::DateTime)
+          value_ical <=> other.value_ical
+        else
+          nil
+        end
+      end
+
     end
 
   end
-end
+end

data/lib/icalendar/values/text.rb

@@ -1,12 +1,10 @@
 module Icalendar
   module Values
-
     class Text < Value
-
       def initialize(value, params = {})
-        value = value.gsub '\n', "\n"
-        value.gsub! '\,', ','
-        value.gsub! '\;', ';'
+        value = value.gsub('\n', "\n")
+        value.gsub!('\,', ',')
+        value.gsub!('\;', ';')
         value.gsub!('\\\\') { '\\' }
         super value, params
       end
@@ -14,13 +12,11 @@ module Icalendar
       def value_ical
         value.dup.tap do |v|
           v.gsub!('\\') { '\\\\' }
-          v.gsub! ';', '\;'
-          v.gsub! ',', '\,'
-          v.gsub! /\r?\n/, '\n'
+          v.gsub!(';', '\;')
+          v.gsub!(',', '\,')
+          v.gsub!(/\r?\n/, '\n')
         end
       end
-
     end
-
   end
-end
+end

data/lib/icalendar/values/utc_offset.rb

@@ -2,9 +2,7 @@ require 'ostruct'
 
 module Icalendar
   module Values
-
     class UtcOffset < Value
-
       def initialize(value, params = {})
         if value.is_a? Icalendar::Values::UtcOffset
           value = value.value
@@ -30,7 +28,7 @@ module Icalendar
       end
 
       def parse_fields(value)
-        value.gsub! /\s+/, ''
+        value.gsub!(/\s+/, '')
         md = /\A(?<behind>[+-])(?<hours>\d{2})(?<minutes>\d{2})(?<seconds>\d{2})?\z/.match value
         {
           behind: (md[:behind] == '-'),

data/lib/icalendar/version.rb

@@ -1,5 +1,5 @@
 module Icalendar
 
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'
 
 end

data/spec/fixtures/single_event_bad_line.ics

@@ -0,0 +1,22 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:bsprodidfortestabc123
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+DTSTAMP:20050118T211523Z
+UID:bsuidfortestabc123
+DTSTART;TZID=US-Mountain:20050120T170000
+DTEND;TZID=US-Mountain:20050120T184500
+CLASS:PRIVATE
+GEO:37.386013;-122.0829322
+ORGANIZER:mailto:joebob@random.net
+PRIORITY:2
+SUMMARY:This is a really long summary to test the method of unfolding lines
+ \, so I'm just going to make it a whole bunch of lines.
+ATTACH:http://bush.sucks.org/impeach/him.rhtml
+ATTACH:http://corporations-dominate.existence.net/why.rhtml
+RDATE;TZID=US-Mountain:20050121T170000,20050122T170000
+X-TEST-COMPONENT;QTEST="Hello, World":Shouldn't double double quotes
+X-NO-VALUE
+END:VEVENT
+END:VCALENDAR

data/spec/fixtures/two_date_time_events.ics

@@ -0,0 +1,64 @@
+BEGIN:VCALENDAR
+METHOD:PUBLISH
+VERSION:2.0
+X-WR-CALNAME:TMP
+PRODID:-//Apple Inc.//Mac OS X 10.9.4//EN
+X-APPLE-CALENDAR-COLOR:#0E61B9
+X-WR-TIMEZONE:America/New_York
+CALSCALE:GREGORIAN
+BEGIN:VTIMEZONE
+TZID:America/New_York
+BEGIN:DAYLIGHT
+TZOFFSETFROM:-0500
+RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SU
+DTSTART:20070311T020000
+TZNAME:EDT
+TZOFFSETTO:-0400
+END:DAYLIGHT
+BEGIN:STANDARD
+TZOFFSETFROM:-0400
+RRULE:FREQ=YEARLY;BYMONTH=11;BYDAY=1SU
+DTSTART:20071104T020000
+TZNAME:EST
+TZOFFSETTO:-0500
+END:STANDARD
+END:VTIMEZONE
+BEGIN:VEVENT
+STATUS:CONFIRMED
+CREATED:20140731T162556Z
+UID:7C4A5440-ABA5-4B32-A69D-AFD243B39FE1
+DTEND;TZID=America/New_York:20140714T100000
+TRANSP:OPAQUE
+SUMMARY:9am
+LAST-MODIFIED:20140731T162556Z
+DTSTAMP:20140731T164042Z
+DTSTART;TZID=America/New_York:20140714T090000
+LOCATION:
+SEQUENCE:13
+BEGIN:VALARM
+X-WR-ALARMUID:6F54CD66-F2A9-491D-8892-7E3209F6A2E4
+UID:6F54CD66-F2A9-491D-8892-7E3209F6A2E4
+TRIGGER;VALUE=DATE-TIME:19760401T005545Z
+ACTION:NONE
+END:VALARM
+END:VEVENT
+BEGIN:VEVENT
+STATUS:CONFIRMED
+CREATED:20140731T162556Z
+UID:A50FA12F-BCA9-4822-A61D-E86EB7440A16
+DTEND;VALUE=DATE:20140715
+TRANSP:TRANSPARENT
+SUMMARY:All Day
+LAST-MODIFIED:20140731T162556Z
+DTSTAMP:20140731T164829Z
+DTSTART;VALUE=DATE:20140714
+LOCATION:
+SEQUENCE:18
+BEGIN:VALARM
+X-WR-ALARMUID:295F2CF7-1C48-4E76-A8FC-718A1EBEDB76
+UID:295F2CF7-1C48-4E76-A8FC-718A1EBEDB76
+TRIGGER;VALUE=DATE-TIME:19760401T005545Z
+ACTION:NONE
+END:VALARM
+END:VEVENT
+END:VCALENDAR

data/spec/fixtures/two_day_events.ics

@@ -0,0 +1,35 @@
+BEGIN:VCALENDAR
+METHOD:PUBLISH
+VERSION:2.0
+X-WR-CALNAME:TMP
+PRODID:-//Apple Inc.//Mac OS X 10.9.4//EN
+X-APPLE-CALENDAR-COLOR:#0E61B9
+X-WR-TIMEZONE:America/New_York
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+STATUS:CONFIRMED
+CREATED:20140731T162556Z
+UID:A50FA12F-BCA9-4822-A61D-E86EB7440A16
+DTEND;VALUE=DATE:20140715
+TRANSP:TRANSPARENT
+SUMMARY:Monday
+LAST-MODIFIED:20140731T162556Z
+DTSTAMP:20140731T162628Z
+DTSTART;VALUE=DATE:20140714
+LOCATION:
+SEQUENCE:3
+END:VEVENT
+BEGIN:VEVENT
+STATUS:CONFIRMED
+CREATED:20140731T162556Z
+UID:7C4A5440-ABA5-4B32-A69D-AFD243B39FE1
+DTEND;VALUE=DATE:20140714
+TRANSP:TRANSPARENT
+SUMMARY:Sunday
+LAST-MODIFIED:20140731T162556Z
+DTSTAMP:20140731T162611Z
+DTSTART;VALUE=DATE:20140713
+LOCATION:
+SEQUENCE:5
+END:VEVENT
+END:VCALENDAR

data/spec/fixtures/two_time_events.ics

@@ -0,0 +1,64 @@
+BEGIN:VCALENDAR
+METHOD:PUBLISH
+VERSION:2.0
+X-WR-CALNAME:TMP
+PRODID:-//Apple Inc.//Mac OS X 10.9.4//EN
+X-APPLE-CALENDAR-COLOR:#0E61B9
+X-WR-TIMEZONE:America/New_York
+CALSCALE:GREGORIAN
+BEGIN:VTIMEZONE
+TZID:America/New_York
+BEGIN:DAYLIGHT
+TZOFFSETFROM:-0500
+RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SU
+DTSTART:20070311T020000
+TZNAME:EDT
+TZOFFSETTO:-0400
+END:DAYLIGHT
+BEGIN:STANDARD
+TZOFFSETFROM:-0400
+RRULE:FREQ=YEARLY;BYMONTH=11;BYDAY=1SU
+DTSTART:20071104T020000
+TZNAME:EST
+TZOFFSETTO:-0500
+END:STANDARD
+END:VTIMEZONE
+BEGIN:VEVENT
+STATUS:CONFIRMED
+CREATED:20140731T162556Z
+UID:7C4A5440-ABA5-4B32-A69D-AFD243B39FE1
+DTEND;TZID=America/New_York:20140714T100000
+TRANSP:OPAQUE
+SUMMARY:9am
+LAST-MODIFIED:20140731T162556Z
+DTSTAMP:20140731T164042Z
+DTSTART;TZID=America/New_York:20140714T090000
+LOCATION:
+SEQUENCE:13
+BEGIN:VALARM
+X-WR-ALARMUID:6F54CD66-F2A9-491D-8892-7E3209F6A2E4
+UID:6F54CD66-F2A9-491D-8892-7E3209F6A2E4
+TRIGGER;VALUE=DATE-TIME:19760401T005545Z
+ACTION:NONE
+END:VALARM
+END:VEVENT
+BEGIN:VEVENT
+STATUS:CONFIRMED
+CREATED:20140731T162556Z
+UID:A50FA12F-BCA9-4822-A61D-E86EB7440A16
+DTEND;TZID=America/New_York:20140714T095900
+TRANSP:OPAQUE
+SUMMARY:9:01-9:59
+LAST-MODIFIED:20140731T162556Z
+DTSTAMP:20140731T164405Z
+DTSTART;TZID=America/New_York:20140714T090100
+LOCATION:
+SEQUENCE:16
+BEGIN:VALARM
+X-WR-ALARMUID:295F2CF7-1C48-4E76-A8FC-718A1EBEDB76
+UID:295F2CF7-1C48-4E76-A8FC-718A1EBEDB76
+TRIGGER;VALUE=DATE-TIME:19760401T005545Z
+ACTION:NONE
+END:VALARM
+END:VEVENT
+END:VCALENDAR

data/spec/parser_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe Icalendar::Parser do
-
-  let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'single_event.ics') }
   subject { described_class.new source, false }
 
   describe '#parse' do
+    let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'single_event.ics') }
+
     it 'returns an array of calendars' do
       expect(subject.parse).to be_instance_of Array
       expect(subject.parse.count).to eq 1
@@ -23,4 +23,23 @@ describe Icalendar::Parser do
     end
   end
 
-end
+  describe '#parse with bad line' do
+    let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'single_event_bad_line.ics') }
+
+    it 'returns an array of calendars' do
+      expect(subject.parse).to be_instance_of Array
+      expect(subject.parse.count).to eq 1
+      expect(subject.parse[0]).to be_instance_of Icalendar::Calendar
+    end
+
+    it 'properly splits multi-valued lines' do
+      event = subject.parse.first.events.first
+      expect(event.geo).to eq [37.386013,-122.0829322]
+    end
+
+    it 'saves params' do
+      event = subject.parse.first.events.first
+      expect(event.dtstart.ical_params).to eq('tzid' => ['US-Mountain'])
+    end
+  end
+end

data/spec/roundtrip_spec.rb

@@ -38,6 +38,52 @@ describe Icalendar do
     end
   end
 
+  describe 'sorting daily events' do
+    let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'two_day_events.ics') }
+    subject { Icalendar.parse(source, true).events }
+
+    it 'sorts day events' do
+      events = subject.sort_by(&:dtstart)
+
+      expect(events.first.dtstart).to eq ::Date.new(2014, 7, 13)
+      expect(events.last.dtstart).to eq ::Date.new(2014, 7, 14)
+    end
+  end
+
+  describe 'sorting time events' do
+    let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'two_time_events.ics') }
+    subject { Icalendar.parse(source, true).events }
+
+    it 'sorts time events by start time' do
+      events = subject.sort_by(&:dtstart)
+
+      expect(events.first.dtstart).to eq ::DateTime.new(2014, 7, 14, 9, 0, 0, '-4')
+
+      expect(events.last.dtstart).to eq ::DateTime.new(2014, 7, 14, 9, 1, 0, '-4')
+      expect(events.last.dtend).to eq ::DateTime.new(2014, 7, 14, 9, 59, 0, '-4')
+    end
+
+    it 'sorts time events by end time' do
+      events = subject.sort_by(&:dtend)
+
+      expect(events.first.dtstart).to eq ::DateTime.new(2014, 7, 14, 9, 1, 0, '-4')
+      expect(events.first.dtend).to eq ::DateTime.new(2014, 7, 14, 9, 59, 0, '-4')
+      expect(events.last.dtstart).to eq ::DateTime.new(2014, 7, 14, 9, 0, 0, '-4')
+    end
+  end
+
+  describe 'sorting date / time events' do
+    let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'two_date_time_events.ics') }
+    subject { Icalendar.parse(source, true).events }
+
+    it 'sorts time events' do
+      events = subject.sort_by(&:dtstart)
+
+      expect(events.first.dtstart).to eq ::Date.new(2014, 7, 14)
+      expect(events.last.dtstart).to eq ::DateTime.new(2014, 7, 14, 9, 0, 0, '-4')
+    end
+  end
+
   describe 'non-standard values' do
     if defined? File::NULL
       before(:all) { Icalendar.logger = Icalendar::Logger.new File::NULL }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icalendar
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -179,7 +179,11 @@ files:
 - spec/fixtures/nondefault_values.ics
 - spec/fixtures/nonstandard.ics
 - spec/fixtures/single_event.ics
+- spec/fixtures/single_event_bad_line.ics
 - spec/fixtures/timezone.ics
+- spec/fixtures/two_date_time_events.ics
+- spec/fixtures/two_day_events.ics
+- spec/fixtures/two_time_events.ics
 - spec/freebusy_spec.rb
 - spec/journal_spec.rb
 - spec/parser_spec.rb
@@ -200,6 +204,9 @@ metadata: {}
 post_install_message: |
   HEADS UP! iCalendar 2.0 is not backwards-compatible with 1.x. Please see the README for the new syntax
 
+  HEADS UP! icalendar 2.2.0 switches to non-strict parsing as default. Please see the README if you
+  rely on strict parsing for information on how to enable it.
+
   ActiveSupport is required for TimeWithZone support, but not required for general use.
 rdoc_options: []
 require_paths:
@@ -227,7 +234,11 @@ test_files:
 - spec/fixtures/nondefault_values.ics
 - spec/fixtures/nonstandard.ics
 - spec/fixtures/single_event.ics
+- spec/fixtures/single_event_bad_line.ics
 - spec/fixtures/timezone.ics
+- spec/fixtures/two_date_time_events.ics
+- spec/fixtures/two_day_events.ics
+- spec/fixtures/two_time_events.ics
 - spec/freebusy_spec.rb
 - spec/journal_spec.rb
 - spec/parser_spec.rb