icalendar 1.5.4 → 2.0.0.beta.1

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'timecop'
+require 'icalendar'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/timezone_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Icalendar::Timezone do
+
+  describe "valid?" do
+    subject { described_class.new.tap { |t| t.tzid = 'Eastern' } }
+
+    context 'with both standard and daylight components' do
+      before(:each) do
+        subject.daylight { |d| d.should_receive(:valid?).and_return true }
+        subject.standard { |s| s.should_receive(:valid?).and_return true }
+      end
+
+      it { should be_valid }
+    end
+
+    context 'with only standard' do
+      before(:each) { subject.standard { |s| s.stub(:valid?).and_return true } }
+      it { should be_valid }
+    end
+
+    context 'with only daylight' do
+      before(:each) { subject.daylight { |d| d.stub(:valid?).and_return true } }
+      it { should be_valid }
+    end
+
+    context 'with neither standard or daylight' do
+      it { should_not be_valid }
+    end
+  end
+end

data/spec/todo_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Icalendar::Todo do
+
+  describe '#dtstart' do
+    it 'is not normally required' do
+      subject.dtstart = nil
+      subject.should be_valid
+    end
+
+    context 'with duration set' do
+      before(:each) { subject.duration = 'PT15M' }
+
+      it 'is invalid if not set' do
+        subject.should_not be_valid
+      end
+
+      it 'is valid when set' do
+        subject.dtstart = Date.today
+        subject.should be_valid
+      end
+    end
+  end
+end

data/spec/tzinfo_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require_relative '../lib/icalendar/tzinfo'
+
+describe 'TZInfo::Timezone' do
+
+  let(:tz) { TZInfo::Timezone.get 'Europe/Copenhagen' }
+  let(:date) { DateTime.new 1970 }
+  subject { tz.ical_timezone date }
+
+  describe 'daylight offset' do
+    specify { expect(subject.daylights.first.tzoffsetto.value_ical).to eq "+0200" }
+    specify { expect(subject.daylights.first.tzoffsetfrom.value_ical).to eq "+0100" }
+  end
+
+  describe 'standard offset' do
+    specify { expect(subject.standards.first.tzoffsetto.value_ical).to eq "+0100" }
+    specify { expect(subject.standards.first.tzoffsetfrom.value_ical).to eq "+0200" }
+  end
+
+  describe 'no end transition' do
+    let(:tz) { TZInfo::Timezone.get 'America/Cayman' }
+    let(:date) { DateTime.now }
+
+    it 'only creates a standard component' do
+      expect(subject.to_ical).to eq <<-EXPECTED.gsub "\n", "\r\n"
+BEGIN:VTIMEZONE
+TZID:America/Cayman
+BEGIN:STANDARD
+DTSTART:19120201T000711
+TZOFFSETFROM:-0652
+TZOFFSETTO:-0500
+TZNAME:EST
+END:STANDARD
+END:VTIMEZONE
+      EXPECTED
+    end
+  end
+
+  describe 'no transition' do
+    let(:tz) { TZInfo::Timezone.get 'UTC' }
+    let(:date) { DateTime.now }
+
+    it 'creates a standard component with equal offsets' do
+      expect(subject.to_ical).to eq <<-EXPECTED.gsub "\n", "\r\n"
+BEGIN:VTIMEZONE
+TZID:UTC
+BEGIN:STANDARD
+DTSTART:19700101T000000
+TZOFFSETFROM:+0000
+TZOFFSETTO:+0000
+TZNAME:UTC
+END:STANDARD
+END:VTIMEZONE
+      EXPECTED
+    end
+  end
+
+  describe 'dst transition' do
+    subject { TZInfo::Timezone.get 'America/Los_Angeles' }
+    let(:now) { subject.now }
+    # freeze in DST transition in America/Los_Angeles
+    before(:each) { Timecop.freeze DateTime.new(2013, 11, 03, 1, 30, 0, '-08:00') }
+    after(:each) { Timecop.return }
+
+    specify { expect { subject.ical_timezone now, nil }.to raise_error TZInfo::AmbiguousTime }
+    specify { expect { subject.ical_timezone now, true }.not_to raise_error }
+    specify { expect { subject.ical_timezone now, false }.not_to raise_error }
+
+    context 'TZInfo::Timezone.default_dst = nil' do
+      before(:each) { TZInfo::Timezone.default_dst = nil }
+      specify { expect { subject.ical_timezone now }.to raise_error TZInfo::AmbiguousTime }
+    end
+
+    context 'TZInfo::Timezone.default_dst = true' do
+      before(:each) { TZInfo::Timezone.default_dst = true }
+      specify { expect { subject.ical_timezone now }.not_to raise_error }
+    end
+
+    context 'TZInfo::Timezone.default_dst = false' do
+      before(:each) { TZInfo::Timezone.default_dst = false }
+      specify { expect { subject.ical_timezone now }.not_to raise_error }
+    end
+  end
+
+end

data/spec/values/date_time_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Icalendar::Values::DateTime do
+
+  subject { described_class.new value, params }
+  let(:value) { '20140209T194355Z' }
+  let(:params) { {} }
+
+  # not sure how to automatically test both sides of this.
+  # For now - relying on commenting out dev dependency in gemspec
+  # AND uninstalling gem manually
+  if defined? ActiveSupport
+
+    context 'with ActiveSupport' do
+      it 'parses a string to a ActiveSupport::TimeWithZone instance' do
+        expect(subject.value).to be_a_kind_of ActiveSupport::TimeWithZone
+        expect(subject.value_ical).to eq value
+      end
+
+      context 'local time' do
+        let(:value) { '20140209T160652' }
+        let(:params) { {'tzid' => 'America/Denver'} }
+
+        it 'parses the value as local time' do
+          expect(subject.value.hour).to eq 16
+          expect(subject.value.utc_offset).to eq -25200
+          expect(subject.value.utc.hour).to eq 23
+        end
+      end
+    end
+
+  else
+
+    context 'without ActiveSupport' do
+      it 'parses a string to a DateTime instance' do
+        expect(subject.value).to be_a_kind_of ::DateTime
+      end
+
+      context 'local time' do
+        let(:value) { '20140209T160652' }
+        let(:params) { {'tzid' => 'America/Denver'} }
+
+        it 'parses the value as local time' do
+          expect(subject.value.hour).to eq 16
+          # TODO better offset support without ActiveSupport
+          #expect(subject.offset).to eq Rational(-7, 24)
+        end
+      end
+    end
+
+  end
+
+
+  context 'common tests' do
+    it 'does not add any tzid parameter to output' do
+      expect(subject.to_ical described_class).to eq ":#{value}"
+    end
+
+    context 'local time' do
+      let(:value) { '20140209T160652' }
+      let(:params) { {'tzid' => 'America/Denver'} }
+
+      it 'keeps value and tzid as localtime on output' do
+        expect(subject.to_ical described_class).to eq ";TZID=America/Denver:#{value}"
+      end
+    end
+
+    context 'floating local time' do
+      let(:value) { '20140209T162845' }
+
+      it 'keeps the value as a DateTime' do
+        expect(subject.value).to be_a_kind_of ::DateTime
+      end
+
+      it 'does not append a Z on output' do
+        expect(subject.to_ical described_class).to eq ":#{value}"
+      end
+    end
+  end
+end

data/spec/values/duration_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Icalendar::Values::Duration do
+
+  subject { described_class.new value }
+
+  describe '#past?' do
+    context 'positive explicit' do
+      let(:value) { '+P15M' }
+      specify { expect(subject.past?).to be_false }
+    end
+
+    context 'positive implicit' do
+      let(:value) { 'P15M' }
+      specify { expect(subject.past?).to be_false }
+    end
+
+    context 'negative' do
+      let(:value) { '-P15M' }
+      specify { expect(subject.past?).to be_true }
+    end
+  end
+
+  describe '#days' do
+    context 'days given' do
+      let(:value) { 'P5DT3H' }
+      specify { expect(subject.days).to eq 5 }
+    end
+    context 'no days given' do
+      let(:value) { 'P5W' }
+      specify { expect(subject.days).to eq 0 }
+    end
+  end
+
+  describe '#weeks' do
+    let(:value) { 'P3W' }
+    specify { expect(subject.weeks).to eq 3 }
+  end
+
+  describe '#hours' do
+    let(:value) { 'PT6H' }
+    specify { expect(subject.hours).to eq 6 }
+  end
+
+  describe '#minutes' do
+    let(:value) { 'P2DT5H45M12S' }
+    specify { expect(subject.minutes).to eq 45 }
+  end
+
+  describe '#seconds' do
+    let(:value) { '-PT5M30S' }
+    specify { expect(subject.seconds).to eq 30 }
+  end
+
+  describe '#value_ical' do
+    let(:value) { 'P2DT4H' }
+    specify { expect(subject.value_ical).to eq value }
+  end
+
+  describe '#days=' do
+    let(:value) { 'P3D' }
+    it 'can set the number of days' do
+      subject.days = 4
+      expect(subject.value_ical).to eq 'P4D'
+    end
+  end
+end

data/spec/values/period_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe Icalendar::Values::Period do
+
+  subject { described_class.new value }
+
+  context 'date-time/date-time' do
+    let(:value) { '19830507T000600Z/20140128T201400Z' }
+
+    describe '#value_ical' do
+      specify { expect(subject.value_ical).to eq value }
+    end
+    describe '#period_start' do
+      specify { expect(subject.period_start).to eq DateTime.new(1983, 5, 7, 0, 6) }
+    end
+    describe '#duration' do
+      specify { expect(subject.duration).to be_nil }
+    end
+    describe '#explicit_end' do
+      specify { expect(subject.explicit_end).to eq DateTime.new(2014, 01, 28, 20, 14) }
+    end
+  end
+
+  context 'date-time/duration' do
+    let(:value) { '19830507T000600Z/P1604W' }
+    let(:expected_duration) { OpenStruct.new past: false, weeks: 1604, days: 0, hours: 0, minutes: 0, seconds: 0 }
+
+    describe '#value_ical' do
+      specify { expect(subject.value_ical).to eq value }
+
+      it 'allows updating duration' do
+        subject.duration = 'PT30M'
+        expect(subject.value_ical).to eq '19830507T000600Z/PT30M'
+      end
+    end
+    describe '#period_start' do
+      specify { expect(subject.period_start).to eq DateTime.new(1983, 5, 7, 0, 6) }
+    end
+    describe '#duration' do
+      specify { expect(subject.duration).to eq expected_duration }
+    end
+    describe '#explicit_end' do
+      specify { expect(subject.explicit_end).to eq nil }
+    end
+  end
+end

data/spec/values/recur_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Icalendar::Values::Recur do
+
+  subject { described_class.new value }
+  let(:value) { 'FREQ=DAILY' }
+
+  describe 'parsing' do
+    context 'multiple bydays' do
+      let(:value) { 'FREQ=WEEKLY;COUNT=4;BYDAY=MO,WE,FR' }
+
+      specify { expect(subject.frequency).to eq 'WEEKLY' }
+      specify { expect(subject.count).to eq 4 }
+      specify { expect(subject.by_day).to eq %w(MO WE FR) }
+    end
+
+    context 'single byday' do
+      let(:value) { 'FREQ=YEARLY;BYDAY=2SU;BYMONTH=3' }
+
+      specify { expect(subject.frequency).to eq 'YEARLY' }
+      specify { expect(subject.by_day).to eq %w(2SU) }
+      specify { expect(subject.by_month).to eq [3] }
+    end
+  end
+
+  describe '#valid?' do
+    it 'requires frequency' do
+      expect(subject.valid?).to be_true
+      subject.frequency = nil
+      expect(subject.valid?).to be_false
+    end
+
+    it 'cannot have both until and count' do
+      subject.until = '20140201'
+      subject.count = 4
+      expect(subject.valid?).to be_false
+    end
+  end
+
+  describe '#value_ical' do
+    let(:value) { 'FREQ=DAILY;BYYEARDAY=1,34,56,240;BYDAY=SU,SA' }
+
+    it 'outputs in spec order' do
+      expect(subject.value_ical).to eq 'FREQ=DAILY;BYDAY=SU,SA;BYYEARDAY=1,34,56,240'
+    end
+  end
+end

data/spec/values/text_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Icalendar::Values::Text do
+
+  subject { described_class.new value }
+  let(:unescaped) { "This \\ that, semi; colons\r\nAnother line: \"why not?\"" }
+  let(:escaped) { 'This \\\\ that\, semi\; colons\nAnother line: "why not?"' }
+
+  describe '#value_ical' do
+    let(:value) { unescaped }
+    it 'escapes \ , ; NL' do
+      expect(subject.value_ical).to eq escaped
+    end
+  end
+
+  describe 'unescapes in initializer' do
+    context 'given escaped version' do
+      let(:unescaped_no_cr) { unescaped.gsub "\r", '' }
+      let(:value) { escaped }
+      it 'removes escaping' do
+        expect(subject.value).to eq unescaped_no_cr
+      end
+    end
+
+    context 'given unescaped version' do
+      let(:value) { unescaped }
+      it 'does not try to double unescape' do
+        expect(subject.value).to eq unescaped
+      end
+    end
+  end
+
+  describe 'escapes parameter text properly' do
+    subject { described_class.new escaped, {'param' => param_value} }
+    context 'single value, no special characters' do
+      let(:param_value) { 'HelloWorld' }
+      it 'does not wrap param in double quotes' do
+        expect(subject.params_ical).to eq %(;PARAM=HelloWorld)
+      end
+    end
+    context 'single value, special characters' do
+      let(:param_value) { 'Hello:World' }
+      it 'wraps param value in double quotes' do
+        expect(subject.params_ical).to eq %(;PARAM="Hello:World")
+      end
+    end
+    context 'single value, double quotes' do
+      let(:param_value) { 'Hello "World"' }
+      it 'replaces double quotes with single' do
+        expect(subject.params_ical).to eq %(;PARAM=Hello 'World')
+      end
+    end
+    context 'multiple values, no special characters' do
+      let(:param_value) { ['HelloWorld', 'GoodbyeMoon'] }
+      it 'joins with comma' do
+        expect(subject.params_ical).to eq %(;PARAM=HelloWorld,GoodbyeMoon)
+      end
+    end
+    context 'multiple values, with special characters' do
+      let(:param_value) { ['Hello, World', 'GoodbyeMoon'] }
+      it 'quotes values with special characters, joins with comma' do
+        expect(subject.params_ical).to eq %(;PARAM="Hello, World",GoodbyeMoon)
+      end
+    end
+    context 'multiple values, double quotes' do
+      let(:param_value) { ['Hello, "World"', 'GoodbyeMoon'] }
+      it 'replaces double quotes with single' do
+        expect(subject.params_ical).to eq %(;PARAM="Hello, 'World'",GoodbyeMoon)
+      end
+    end
+  end
+end