icalendar 1.5.4 → 2.0.0.beta.1

data/spec/calendar_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe Icalendar::Calendar do
+
+  context 'values' do
+    let(:property) { 'my-value' }
+
+    %w(prodid version calscale ip_method).each do |prop|
+      it "##{prop} sets and gets" do
+        subject.send("#{prop}=", property)
+        subject.send(prop).should == property
+      end
+    end
+
+    it "sets and gets custom properties" do
+      subject.x_custom_prop = property
+      expect(subject.x_custom_prop).to eq [property]
+    end
+
+    it 'can set params on a property' do
+      subject.prodid.ical_params = {'hello' => 'world'}
+      subject.prodid.value.should == 'icalendar-ruby'
+      subject.prodid.ical_params.should == {'hello' => 'world'}
+    end
+
+    context "required values" do
+      it 'is not valid when prodid is not set' do
+        subject.prodid = nil
+        subject.should_not be_valid
+      end
+
+      it 'is not valid when version is not set' do
+        subject.version = nil
+        subject.should_not be_valid
+      end
+
+      it 'is valid when both prodid and version are set' do
+        subject.version = '2.0'
+        subject.prodid = 'my-product'
+        subject.should be_valid
+      end
+
+      it 'is valid by default' do
+        subject.should be_valid
+      end
+    end
+  end
+
+  context 'components' do
+    let(:ical_component) { double 'Component', name: 'event', 'parent=' => nil }
+
+    %w(event todo journal freebusy timezone).each do |component|
+      it "##{component} adds a new component" do
+        subject.send("#{component}").should be_a_kind_of Icalendar::Component
+      end
+
+      it "##{component} passes a component to a block to build parts" do
+        expect { |b| subject.send("#{component}", &b) }.to yield_with_args Icalendar::Component
+      end
+
+      it "##{component} can be passed in" do
+        expect { |b| subject.send("#{component}", ical_component, &b) }.to yield_with_args ical_component
+        subject.send("#{component}", ical_component).should == ical_component
+      end
+    end
+
+    it "adds event to events list" do
+      subject.event ical_component
+      subject.events.should == [ical_component]
+    end
+
+    describe '#add_event' do
+      it 'delegates to non add_ version' do
+        subject.should_receive(:event).with ical_component
+        subject.add_event ical_component
+      end
+    end
+
+    describe '#find_event' do
+      let(:ical_component) { double 'Component', uid: 'uid' }
+      let(:other_component) { double 'Component', uid: 'other' }
+      before(:each) do
+        subject.events << other_component
+        subject.events << ical_component
+      end
+
+      it 'finds by uid' do
+        subject.find_event('uid').should == ical_component
+      end
+    end
+
+    describe '#find_timezone' do
+      let(:ical_timezone) { double 'Timezone', tzid: 'Eastern' }
+      let(:other_timezone) { double 'Timezone', tzid: 'Pacific' }
+      before(:each) do
+        subject.timezones << other_timezone
+        subject.timezones << ical_timezone
+      end
+
+      it 'finds by tzid' do
+        subject.find_timezone('Eastern').should == ical_timezone
+      end
+    end
+
+    it "adds reference to parent" do
+      e = subject.event
+      e.parent.should == subject
+    end
+
+    it 'can be added with add_x_ for custom components' do
+      subject.add_x_custom_component.should be_a_kind_of Icalendar::Component
+      expect { |b| subject.add_x_custom_component(&b) }.to yield_with_args Icalendar::Component
+      subject.add_x_custom_component(ical_component).should == ical_component
+    end
+  end
+
+  describe '#to_ical' do
+    before(:each) do
+      Timecop.freeze DateTime.new(2013, 12, 26, 5, 0, 0, '+0000')
+      subject.event do |e|
+        e.summary = 'An event'
+        e.dtstart = "20140101T000000Z"
+        e.dtend = "20140101T050000Z"
+        e.geo = [-1.2, -2.1]
+      end
+      subject.freebusy do |f|
+        f.dtstart = "20140102T080000Z"
+        f.dtend = "20140102T100000Z"
+        f.comment = 'Busy'
+      end
+    end
+    after(:each) do
+      Timecop.return
+    end
+
+    it 'outputs properties and components' do
+      expected_no_uid = <<-EOICAL.gsub("\n", "\r\n")
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:icalendar-ruby
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+DTSTAMP:20131226T050000Z
+DTSTART:20140101T000000Z
+DTEND:20140101T050000Z
+GEO:-1.2;-2.1
+SUMMARY:An event
+END:VEVENT
+BEGIN:VFREEBUSY
+DTSTAMP:20131226T050000Z
+DTSTART:20140102T080000Z
+DTEND:20140102T100000Z
+COMMENT:Busy
+END:VFREEBUSY
+END:VCALENDAR
+      EOICAL
+      expect(subject.to_ical.gsub(/^UID:.*\r\n(?: .*\r\n)*/, '')).to eq expected_no_uid
+    end
+  end
+
+  describe '#publish' do
+    it 'sets ip_method to "PUBLISH"' do
+      subject.publish
+      expect(subject.ip_method).to eq 'PUBLISH'
+    end
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Icalendar::Event do
+
+  describe '#dtstart' do
+    context 'no parent' do
+      it 'is invalid if not set' do
+        subject.should_not be_valid
+      end
+
+      it 'is valid if set' do
+        subject.dtstart = DateTime.now
+        subject.should be_valid
+      end
+    end
+
+    context 'with parent' do
+      before(:each) { subject.parent = Icalendar::Calendar.new }
+
+      it 'is invalid without method set' do
+        subject.should_not be_valid
+      end
+
+      it 'is valid with parent method set' do
+        subject.parent.ip_method = 'UPDATE'
+        subject.should be_valid
+      end
+    end
+  end
+
+  context 'mutually exclusive values' do
+    before(:each) { subject.dtstart = DateTime.now }
+
+    it 'is invalid if both dtend and duration are set' do
+      subject.dtend = Date.today + 1;
+      subject.duration = 'PT15M'
+      subject.should_not be_valid
+    end
+
+    it 'is valid if dtend is set' do
+      subject.dtend = Date.today + 1;
+      subject.should be_valid
+    end
+
+    it 'is valid if duration is set' do
+      subject.duration = 'PT15M'
+      subject.should be_valid
+    end
+  end
+
+  context 'suggested single values' do
+    before(:each) do
+      subject.dtstart = DateTime.now
+      subject.append_rrule double('RRule')
+      subject.append_rrule double('RRule')
+    end
+
+    it 'is valid by default' do
+      subject.should be_valid
+    end
+
+    it 'is invalid with strict checking' do
+      expect(subject.valid?(true)).to be_false
+    end
+  end
+
+  context 'multi values' do
+    describe '#comment' do
+      it 'will return an array when set singly' do
+        subject.comment = 'a comment'
+        subject.comment.should == ['a comment']
+      end
+
+      it 'can be appended' do
+        subject.comment << 'a comment'
+        subject.comment << 'b comment'
+        subject.comment.should == ['a comment', 'b comment']
+      end
+
+      it 'can be added' do
+        subject.append_comment 'a comment'
+        subject.comment.should == ['a comment']
+      end
+    end
+  end
+
+  describe '#find_alarm' do
+    it 'should not respond_to find_alarm' do
+      expect(subject.respond_to?(:find_alarm)).to be_false
+    end
+  end
+
+  describe '#to_ical' do
+    before(:each) do
+      subject.dtstart = "20131227T013000Z"
+      subject.dtend = "20131227T033000Z"
+      subject.summary = 'My event, my ical, my test'
+      subject.geo = [41.230896,-74.411774]
+      subject.x_custom_property = 'customize'
+    end
+
+    it { expect(subject.to_ical).to include 'DTSTART:20131227T013000Z' }
+    it { expect(subject.to_ical).to include 'DTEND:20131227T033000Z' }
+    it { expect(subject.to_ical).to include 'SUMMARY:My event\, my ical\, my test' }
+    it { expect(subject.to_ical).to include 'X-CUSTOM-PROPERTY:customize' }
+    it { expect(subject.to_ical).to include 'GEO:41.230896;-74.411774' }
+  end
+end

data/{test/fixtures/folding.ics → spec/fixtures/nondefault_values.ics}

@@ -12,9 +12,9 @@ DESCRIPTION:FULL DETAILS:\nhttp://test.com/events/570\n\nCary Brothers walk
  lyrical beauty rare in a young songwriter\,&quot\; and &quot\;this soulful 
  blend of everything that feels good.&quot\; Rising up around him is music\;
   transcending genres\, genders and generations.
-DTEND:20061215T180000
+DTEND;VALUE=DATE:20061215
 DTSTAMP:20061215T114034
-DTSTART:20061215T160000
+DTSTART;VALUE=DATE:20061215
 SEQUENCE:1001
 SUMMARY:DigiWorld 2006
 UID:foobar

data/{test → spec}/fixtures/single_event.ics

@@ -1,24 +1,21 @@
 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
-SUMMARY:This is a really long summary
-  to test the method of unfolding lines\,
-  so I'm just going to ma
- ke it
-  a whol
- e
-  bunch of lines.
-CLASS:PRIVATE
-PRIORITY:2
-GEO:37.386013;-122.0829322
-DTSTART;TZID=US-Mountain:20050120T170000
-DTEND:20050120T184500
-DTSTAMP:20050118T211523Z
-NAME:SomeName
+RDATE;TZID=US-Mountain:20050121T170000,20050122T170000
+X-TEST-COMPONENT;QTEST="Hello, World":Shouldn't double double quotes
 END:VEVENT
 END:VCALENDAR

data/spec/fixtures/timezone.ics

@@ -0,0 +1,35 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:icalendar-ruby
+CALSCALE:GREGORIAN
+BEGIN:VTIMEZONE
+TZID:America/New_York
+BEGIN:DAYLIGHT
+DTSTART:20070311T020000
+TZOFFSETFROM:-0500
+TZOFFSETTO:-0400
+RRULE:FREQ=YEARLY;BYDAY=2SU;BYMONTH=3
+TZNAME:EDT
+END:DAYLIGHT
+BEGIN:STANDARD
+DTSTART:20071104T020000
+TZOFFSETFROM:-0400
+TZOFFSETTO:-0500
+RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=11
+TZNAME:EST
+END:STANDARD
+END:VTIMEZONE
+BEGIN:VEVENT
+DTSTAMP:20120320T014112Z
+UID:9B9CB907-F25F-4D27-B6F3-6DE3A3397BC2
+DTSTART;TZID=America/New_York:20120323T190000
+DTEND;TZID=America/New_York:20120323T230000
+CREATED:20120312T191609Z
+LAST-MODIFIED:20120320T014105Z
+LOCATION:Baltimore
+SEQUENCE:0
+STATUS:CONFIRMED
+SUMMARY:Eastern Event
+TRANSP:OPAQUE
+END:VEVENT
+END:VCALENDAR

data/spec/freebusy_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Icalendar::Freebusy do
+
+  # currently no behavior in Journal not tested other places
+
+end

data/spec/journal_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Icalendar::Journal do
+
+  # currently no behavior in Journal not tested other places
+
+end

data/spec/parser_spec.rb

@@ -0,0 +1,26 @@
+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
+    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

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Icalendar do
+
+  describe 'single event round trip' do
+    let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'single_event.ics') }
+
+    it 'will generate the same file as is parsed' do
+      Icalendar.parse(source, true).to_ical.should == source
+    end
+  end
+
+  describe 'timezone round trip' do
+    let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'timezone.ics') }
+    it 'will generate the same file as it parsed' do
+      Icalendar.parse(source, true).to_ical.should == source
+    end
+  end
+
+  describe 'non-default values' do
+    let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', 'nondefault_values.ics') }
+    subject { Icalendar.parse(source, true).events.first }
+
+    it 'will set dtstart to Date' do
+      expect(subject.dtstart.value).to eq ::Date.new(2006, 12, 15)
+    end
+
+    it 'will set dtend to Date' do
+      expect(subject.dtend.value).to eq ::Date.new(2006, 12, 15)
+    end
+
+    it 'will output value param on dtstart' do
+      expect(subject.dtstart.to_ical(subject.class.default_property_types['dtstart'])).to match /^;VALUE=DATE:20061215$/
+    end
+
+    it 'will output value param on dtend' do
+      expect(subject.dtend.to_ical(subject.class.default_property_types['dtend'])).to match /^;VALUE=DATE:20061215$/
+    end
+  end
+end