duranged 0.0.1

data/lib/duranged/version.rb

@@ -0,0 +1,3 @@
+module Duranged
+  VERSION = '0.0.1'
+end

data/spec/duranged/base_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'shared/base_examples.rb')
+
+RSpec.describe Duranged::Base do
+  it_behaves_like "the base class", Duranged::Base
+end

data/spec/duranged/duration_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'shared/base_examples.rb')
+
+RSpec.describe Duranged::Duration do
+  it_behaves_like "the base class", Duranged::Duration
+
+  describe '#duration' do
+    subject { Duranged::Duration.new(30.seconds) }
+
+    it 'returns the duration value' do
+      expect(subject.duration).to eq(subject.value)
+    end
+  end
+end

data/spec/duranged/interval_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'shared/base_examples.rb')
+
+RSpec.describe Duranged::Interval do
+  it_behaves_like "the base class", Duranged::Interval
+
+  describe '#interval' do
+    subject { Duranged::Interval.new(30.seconds) }
+
+    it 'returns the interval value' do
+      expect(subject.interval).to eq(subject.value)
+    end
+  end
+end

data/spec/duranged/occurrence_spec.rb

@@ -0,0 +1,245 @@
+require 'spec_helper'
+
+RSpec.describe Duranged::Occurrence do
+  subject { Duranged::Occurrence.new(5, 36.hours) }
+
+  describe 'dump' do
+    it 'dumps the occurrence as a JSON hash' do
+      expect(Duranged::Occurrence.dump(subject)).to eq subject.to_json
+    end
+  end
+
+  describe 'load' do
+    context 'without a range' do
+      it 'creates a new occurrence from a JSON hash' do
+        expect(Duranged::Occurrence.load(subject.to_json)).to be_an_instance_of Duranged::Occurrence
+        expect(Duranged::Occurrence.load(subject.to_json).as_json).to eq subject.as_json
+      end
+    end
+
+    context 'with a range' do
+      subject { Duranged::Occurrence.new(5, 36.hours, 10.minutes, Time.now, Time.now + 3.days) }
+
+      it 'creates a new occurrence from a JSON hash' do
+        expect(Duranged::Occurrence.load(subject.to_json)).to be_an_instance_of Duranged::Occurrence
+        expect(Duranged::Occurrence.load(subject.to_json).as_json).to eq subject.as_json
+      end
+    end
+  end
+
+  describe '#initialize' do
+    context 'with occurrences' do
+      it 'sets occurrences' do
+        expect(subject.occurrences).to eq 5
+      end
+    end
+
+    context 'without occurrences' do
+      subject { Duranged::Occurrence.new }
+
+      it 'sets occurrences to 1' do
+        expect(subject.occurrences).to eq 1
+      end
+    end
+
+    context 'with interval' do
+      it 'sets interval' do
+        expect(subject.interval).to eq 36.hours
+      end
+    end
+
+    context 'without interval' do
+      subject { Duranged::Occurrence.new }
+
+      it 'sets interval to 0' do
+        expect(subject.interval).to eq nil
+      end
+    end
+
+    context 'with duration' do
+      subject { Duranged::Occurrence.new(5, 36.hours, 20.minutes) }
+
+      it 'sets duration' do
+        expect(subject.duration).to eq 20.minutes
+      end
+    end
+
+    context 'without duration' do
+      subject { Duranged::Occurrence.new }
+
+      it 'sets duration to 0' do
+        expect(subject.duration).to eq nil
+      end
+    end
+  end
+
+  describe '#occurrences_string' do
+    context 'with zero occurrences' do
+      subject { Duranged::Occurrence.new(0, 1.minute) }
+
+      it "returns 'never'" do
+        expect(subject.occurrences_string).to eq 'never'
+      end
+    end
+
+    context 'with a single occurrence' do
+      subject { Duranged::Occurrence.new(1, 1.minute) }
+
+      it "returns 'once'" do
+        expect(subject.occurrences_string).to eq 'once'
+      end
+    end
+
+    context 'with two occurrences' do
+      subject { Duranged::Occurrence.new(2, 1.minute) }
+
+      it "returns 'twice'" do
+        expect(subject.occurrences_string).to eq 'twice'
+      end
+    end
+
+    context 'with multiple occurrences' do
+      subject { Duranged::Occurrence.new([3,4,5].sample, 1.minute) }
+
+      it "returns 'X times'" do
+        expect(subject.occurrences_string).to eq "#{subject.occurrences} times"
+      end
+    end
+  end
+
+  describe '#as_json' do
+    context 'without a range' do
+      it 'returns an occurrences hash' do
+        expect(subject.as_json).to eq({occurrences: subject.occurrences, interval: subject.interval.as_json})
+      end
+    end
+
+    context 'with a range' do
+      subject { Duranged::Occurrence.new(5, 36.hours, 10.minutes, Time.now, Time.now + 3.days) }
+
+      it 'returns an occurrences hash' do
+        expect(subject.as_json).to eq({occurrences: subject.occurrences, duration: subject.duration.as_json, interval: subject.interval.as_json, range: subject.range.as_json})
+      end
+    end
+  end
+
+  describe '#to_s' do
+    subject { Duranged::Occurrence.new(3, 1.day, 10.minutes) }
+
+    it "returns a string matching 'OCCURRENCES for DURATION every INTERVAL'" do
+      expect(subject.to_s).to eq "#{subject.occurrences_string} for #{subject.duration.to_s} every #{subject.interval.to_s}"
+    end
+
+    context 'when occurrences is 0' do
+      subject { Duranged::Occurrence.new(0, 30.seconds) }
+
+      it 'returns the occurrences_string' do
+        expect(subject.to_s).to eq subject.occurrences_string
+      end
+
+      it "returns 'never'" do
+        expect(subject.to_s).to eq 'never'
+      end
+    end
+
+    context 'when interval is 0' do
+      subject { Duranged::Occurrence.new(3, 0, 30.seconds) }
+
+      it "returns a string matching 'OCCURRENCES for DURATION'" do
+        expect(subject.to_s).to eq "#{subject.occurrences_string} for #{subject.duration.to_s}"
+      end
+
+      context 'when duration is 0' do
+        subject { Duranged::Occurrence.new(3) }
+
+        it 'returns the occurrences string' do
+          expect(subject.to_s).to eq subject.occurrences_string
+        end
+      end
+    end
+
+    context 'when duration is 0' do
+      subject { Duranged::Occurrence.new(3, 1.day) }
+
+      it "returns a string matching 'OCCURRENCES every INTERVAL'" do
+        expect(subject.to_s).to eq "#{subject.occurrences_string} every #{subject.interval.to_s}"
+      end
+
+      context 'when interval is 0' do
+        subject { Duranged::Occurrence.new(3) }
+
+        it 'returns the occurrences string' do
+          expect(subject.to_s).to eq subject.occurrences_string
+        end
+      end
+    end
+  end
+
+  describe '#strfocc' do
+    context 'using the :occurence token' do
+      it 'returns the formatted string' do
+        expect(subject.strfocc(':occurrence')).to eq subject.occurrences.to_s
+      end
+    end
+
+    context 'using the :occurences token' do
+      it 'returns the formatted string' do
+        expect(subject.strfocc(':occurrences')).to eq subject.occurrences.to_s
+      end
+    end
+
+    context 'using the :duration token' do
+      subject { Duranged::Occurrence.new(5, 10.minutes, 30.seconds) }
+
+      it 'requires nested formatters' do
+        expect(subject.strfocc(':duration')).to eq ':duration'
+      end
+
+      it 'returns the formatted string' do
+        expect(subject.strfocc(':duration(%d:%h:%m:%s)')).to eq subject.duration.strfdur('%d:%h:%m:%s')
+      end
+    end
+
+    context 'using the :interval token' do
+      it 'requires nested formatters' do
+        expect(subject.strfocc(':interval')).to eq ':interval'
+      end
+
+      it 'returns the formatted string' do
+        expect(subject.strfocc(':interval(%d:%h:%m:%s)')).to eq subject.interval.strfdur('%d:%h:%m:%s')
+      end
+    end
+
+    context 'using the :range token' do
+      subject { Duranged::Occurrence.new(5, 10.minutes, 30.seconds, Time.now, Time.now + 1.hour) }
+
+      context 'without nested formatters' do
+        it 'returns the default formatted range string' do
+          expect(subject.strfocc(':range')).to eq subject.range.to_s
+        end
+      end
+
+      context 'with nested formatters' do
+        it 'returns the formatted string' do
+          expect(subject.strfocc(':range(:start_at(%l:%M%P) :end_at(%l:%M%P) :duration(%D%H%M%S))')).to eq "#{subject.range.start_at('%l:%M%P')} #{subject.range.end_at('%l:%M%P')} #{subject.range.strfdur('%D%H%M%S')}"
+        end
+      end
+    end
+
+    context "using complex format string ':occurrences times for :duration(%-s) seconds every :interval(%-m) minutes between :range(:start_at(%l:%M%P) and :end_at(%l:%M%P) (:duration(%-m minutes)))'" do
+      subject { Duranged::Occurrence.new(3, 5.minutes, 30.seconds, DateTime.parse('2015-01-01T06:00:00-07:00'), DateTime.parse('2015-01-01T06:20:00-07:00')) }
+
+      it "returns '3 times for 30 seconds every 5 minutes between 6:00am and 6:20am'" do
+        expect(subject.strfocc(':occurrences times for :duration(%-s) seconds every :interval(%-m) minutes between :range(:start_at(%l:%M%P) and :end_at(%l:%M%P) (:duration(%-m minutes)))')).to eq '3 times for 30 seconds every 5 minutes between 6:00am and 6:20am (20 minutes)'
+      end
+    end
+
+    context "using complex format string 'between :range(:start_at(%l:%M%P) and :end_at(%l:%M%P) (:duration(%-m minutes))), do something :occurrences times for :duration(%-s) seconds every :interval(%-m) minutes'" do
+      subject { Duranged::Occurrence.new(3, 5.minutes, 30.seconds, DateTime.parse('2015-01-01T06:00:00-07:00'), DateTime.parse('2015-01-01T06:20:00-07:00')) }
+
+      it "returns 'between 6:00am and 6:20am (20 minutes), do something 3 times for 30 seconds every 5 minutes'" do
+        expect(subject.strfocc('between :range(:start_at(%l:%M%P) and :end_at(%l:%M%P) (:duration(%-m minutes))), do something :occurrences times for :duration(%-s) seconds every :interval(%-m) minutes')).to eq 'between 6:00am and 6:20am (20 minutes), do something 3 times for 30 seconds every 5 minutes'
+      end
+    end
+  end
+end

data/spec/duranged/range_spec.rb

@@ -0,0 +1,324 @@
+require 'spec_helper'
+
+RSpec.shared_examples "a format token" do |token, format, meth|
+  it 'requires nested formatters' do
+    expect(subject.strfrange("#{token}")).to eq "#{token}"
+  end
+
+  it "returns the formatted #{token}" do
+    expect(subject.strfrange("#{token}(#{format})")).to eq subject.send(meth, format)
+  end
+end
+
+RSpec.describe Duranged::Range do
+  now = Time.now
+  subject { Duranged::Range.new(now, 60.minutes) }
+
+  describe 'dump' do
+    it 'dumps the time range as a JSON hash' do
+      expect(Duranged::Range.dump(subject)).to eq subject.to_json
+    end
+  end
+
+  describe 'load' do
+    it 'creates a new time range from a JSON hash' do
+      expect(Duranged::Range.load(subject.to_json)).to be_an_instance_of Duranged::Range
+      expect(Duranged::Range.load(subject.to_json).as_json).to eq subject.as_json
+    end
+  end
+
+  describe '#initialize' do
+    context 'with a start_at and end_at' do
+      subject { Duranged::Range.new(now, (now + 60.minutes)) }
+
+      it 'sets start_at' do
+        expect(subject.start_at).to eq now
+      end
+
+      it 'sets end_at' do
+        expect(subject.end_at).to eq(now + 60.minutes)
+      end
+    end
+
+    context 'with a start_at and duration' do
+      subject { Duranged::Range.new(now, 60.minutes) }
+
+      it 'sets start_at' do
+        expect(subject.start_at).to eq now
+      end
+
+      context 'when the duration is an ActiveSupport::Duration' do
+        subject { Duranged::Range.new(now, 60.minutes) }
+
+        it 'sets end_at to start_at + duration' do
+          expect(subject.end_at).to eq(now + 60.minutes)
+        end
+      end
+
+      context 'when the duration is an integer' do
+        subject { Duranged::Range.new(now, 3600) }
+
+        it 'sets end_at to start_at + duration' do
+          expect(subject.end_at).to eq(now + 60.minutes)
+        end
+      end
+
+      context 'when the duration is a hash' do
+        subject { Duranged::Range.new(now, {minutes: 60}) }
+
+        it 'sets end_at to start_at + duration' do
+          expect(subject.end_at).to eq(now + 60.minutes)
+        end
+      end
+
+      context 'when the duration is a string' do
+        subject { Duranged::Range.new(now, "1 day, 2 hours and 30 minutes") }
+
+        it 'sets end_at to start_at + duration' do
+          expect(subject.end_at).to eq(now + (26.hours + 30.minutes))
+        end
+      end
+    end
+
+    context 'with just a duration' do
+      subject { Duranged::Range.new(60.minutes) }
+
+      it 'sets start_at to now' do
+        expect(subject.start_at).to be_between((Time.now - 1.seconds), Time.now)
+      end
+
+      context 'when the duration is an ActiveSupport::Duration' do
+        subject { Duranged::Range.new(60.minutes) }
+
+        it 'sets end_at to start_at + duration' do
+          expect(subject.end_at).to eq(subject.start_at + 60.minutes)
+        end
+      end
+
+      context 'when the duration is an integer' do
+        subject { Duranged::Range.new(3600) }
+
+        it 'sets end_at to start_at + duration' do
+          expect(subject.end_at).to eq(subject.start_at + 60.minutes)
+        end
+      end
+
+      context 'when the duration is a hash' do
+        subject { Duranged::Range.new({minutes: 60}) }
+
+        it 'sets end_at to start_at + duration' do
+          expect(subject.end_at).to eq(subject.start_at + 60.minutes)
+        end
+      end
+    end
+
+    context 'with just an end_at' do
+      subject { Duranged::Range.new(now + 60.minutes) }
+
+      it 'sets start_at to now' do
+        expect(subject.start_at).to be_between((Time.now - 1.seconds), Time.now)
+      end
+
+      it 'sets end_at' do
+        expect(subject.end_at).to eq(now + 60.minutes)
+      end
+    end
+  end
+
+  describe '#start_at' do
+    subject { Duranged::Range.new(now, 60.minutes) }
+
+    context 'without a format argument' do
+      it 'returns the start_at DateTime object' do
+        expect(subject.start_at).to eq now
+        expect(subject.start_at).to be_an_instance_of DateTime
+      end
+    end
+
+    context 'with a format argument' do
+      it 'returns a formatted string' do
+        expect(subject.start_at('%A, %b %e, %Y %l:%M%P')).to eq now.strftime('%A, %b %e, %Y %l:%M%P')
+      end
+    end
+  end
+
+  describe '#end_at' do
+    subject { Duranged::Range.new(now, 60.minutes) }
+
+    context 'without a format argument' do
+      it 'returns the end_at DateTime object' do
+        expect(subject.end_at).to eq(now + 60.minutes)
+        expect(subject.end_at).to be_an_instance_of DateTime
+      end
+    end
+
+    context 'with a format argument' do
+      it 'returns a formatted string' do
+        expect(subject.end_at('%A, %b %e, %Y %l:%M%P')).to eq((now + 60.minutes).strftime('%A, %b %e, %Y %l:%M%P'))
+      end
+    end
+  end
+
+  describe '#+' do
+    context 'when passed an integer' do
+      it 'returns an instance of the same class' do
+        expect(subject + 20).to be_an_instance_of subject.class
+      end
+
+      it 'adds the integer to the value' do
+        expect((subject + 20).value).to eq (subject.value + 20)
+      end
+
+      it 'recalculates the end_at' do
+        end_at = subject.end_at.to_i
+        expect((subject + 20).end_at.to_i).to eq (end_at + 20)
+      end
+    end
+
+    context 'when passed a duration' do
+      it 'returns an instance of the same class' do
+        expect(subject + Duranged::Duration.new(20)).to be_an_instance_of subject.class
+      end
+
+      it 'adds the duration to the value' do
+        expect((subject + Duranged::Duration.new(20)).value).to eq (subject.value + 20)
+      end
+
+      it 'recalculates the end_at' do
+        end_at = subject.end_at.to_i
+        expect((subject + Duranged::Duration.new(20)).end_at.to_i).to eq (end_at + 20)
+      end
+    end
+
+    context 'when passed an interval' do
+      it 'returns an instance of the same class' do
+        expect(subject + Duranged::Interval.new(20)).to be_an_instance_of subject.class
+      end
+
+      it 'adds the interval to the value' do
+        expect((subject + Duranged::Interval.new(20)).value).to eq (subject.value + 20)
+      end
+
+      it 'recalculates the end_at' do
+        end_at = subject.end_at.to_i
+        expect((subject + Duranged::Interval.new(20)).end_at.to_i).to eq (end_at + 20)
+      end
+    end
+  end
+
+  describe '#-' do
+    context 'when passed an integer' do
+      it 'returns an instance of the same class' do
+        expect(subject - 20).to be_an_instance_of subject.class
+      end
+
+      it 'adds the integer to the value' do
+        expect((subject - 20).value).to eq (subject.value - 20)
+      end
+
+      it 'recalculates the end_at' do
+        end_at = subject.end_at.to_i
+        expect((subject - 20).end_at.to_i).to eq (end_at - 20)
+      end
+    end
+
+    context 'when passed a duration' do
+      it 'returns an instance of the same class' do
+        expect(subject - Duranged::Duration.new(20)).to be_an_instance_of subject.class
+      end
+
+      it 'adds the duration to the value' do
+        expect((subject - Duranged::Duration.new(20)).value).to eq (subject.value - 20)
+      end
+
+      it 'recalculates the end_at' do
+        end_at = subject.end_at.to_i
+        expect((subject - Duranged::Duration.new(20)).end_at.to_i).to eq (end_at - 20)
+      end
+    end
+
+    context 'when passed an interval' do
+      it 'returns an instance of the same class' do
+        expect(subject - Duranged::Interval.new(20)).to be_an_instance_of subject.class
+      end
+
+      it 'adds the interval to the value' do
+        expect((subject - Duranged::Interval.new(20)).value).to eq (subject.value - 20)
+      end
+
+      it 'recalculates the end_at' do
+        end_at = subject.end_at.to_i
+        expect((subject - Duranged::Interval.new(20)).end_at.to_i).to eq (end_at - 20)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    it 'returns a hash with start_at and end_at' do
+      expect(subject.to_h).to eq({start_at: subject.start_at.as_json, end_at: subject.end_at.as_json})
+    end
+  end
+
+  describe '#as_json' do
+    it 'returns a hash with start_at and end_at' do
+      expect(subject.as_json).to eq({start_at: subject.start_at.as_json, end_at: subject.end_at.as_json})
+    end
+  end
+
+  describe '#to_duration' do
+    it 'returns a duration object' do
+      expect(subject.to_duration).to be_an_instance_of Duranged::Duration
+    end
+
+    it 'returns a duration object that represents the duration value' do
+      expect(subject.to_duration.duration).to eq subject.duration
+    end
+  end
+
+  describe '#to_s' do
+    subject { Duranged::Range.new((now.beginning_of_day), 60.minutes) }
+    let(:format) { '%-l:%M%P' }
+
+    it 'uses the default format' do
+      expect(subject.to_s).to eq "#{subject.start_at('%b. %-d %Y ' + format)} to #{subject.end_at(format)}"
+    end
+
+    context 'when start and end fall on the same day' do
+      subject { Duranged::Range.new((now.beginning_of_day + 30.minutes), (now.beginning_of_day + 5.hours)) }
+
+      it 'returns the start and end times' do
+        expect(subject.to_s).to eq "#{subject.start_at('%b. %-d %Y ' + format)} to #{subject.end_at(format)}"
+      end
+    end
+
+    context 'when start and end fall on different days' do
+      subject { Duranged::Range.new((now.utc.end_of_day - 20.minutes), 30.minutes) }
+      let(:format) { '%b. %-d %Y %-l:%M%P' }
+
+      it 'returns the start date/time and duration' do
+        expect(subject.to_s).to eq "#{subject.start_at(format)} (#{subject.to_duration.to_s})"
+      end
+    end
+  end
+
+  describe '#strfrange' do
+    context 'when using the :start_at token' do
+      it_behaves_like "a format token", ':start_at', '%b. %-d %Y %-l:%M%P', :start_at
+    end
+
+    context 'when using the :end_at token' do
+      it_behaves_like "a format token", ':end_at', '%b. %-d %Y %-l:%M%P', :end_at
+    end
+
+    context 'when using the :duration token' do
+      it_behaves_like "a format token", ':duration', '%D:%H:%M:%S', :strfdur
+    end
+
+    context "using complex format string ':start_at(%b. %-d %Y) :start_at(%l:%M%P) - :end_at(%l:%M%P) (:duration(%-h hours, %-m minutes))'" do
+      subject { Duranged::Range.new(DateTime.parse('2015-01-01T00:00:00-07:00'), DateTime.parse('2015-01-01T06:30:00-07:00')) }
+      it "returns 'Jan. 1 2015 12:00am - 6:30am (6 hours, 30 minutes)'" do
+        expect(subject.strfrange(':start_at(%b. %-d %Y) :start_at(%l:%M%P) - :end_at(%l:%M%P) (:duration(%-h hours, %-m minutes))')).to eq 'Jan. 1 2015 12:00am - 6:30am (6 hours, 30 minutes)'
+      end
+    end
+  end
+end