schedule_attributes 0.3.0

data/lib/schedule_attributes/version.rb

@@ -0,0 +1,3 @@
+module ScheduleAttributes
+  VERSION = "0.3.0"
+end

data/schedule_attributes.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "schedule_attributes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "schedule_attributes"
+  s.version     = ScheduleAttributes::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew Vit", "Mike Nicholaides"]
+  s.email       = ["andrew@avit.ca", "mike@ablegray.com"]
+  s.homepage    = "https://github.com/avit/schedule_attributes"
+  s.summary     = %q{Handle form inputs for IceCube schedules}
+  s.description = %q{Converts to/from date & time inputs for managing scheduled models.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'ice_cube', '>= 0.10.0'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'tzinfo' # this should be an activesupport dependency!
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'sqlite3'
+end

data/spec/active_record_integration_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'support/scheduled_active_record_model'
+
+
+describe CustomScheduledActiveRecordModel do
+
+  it "should have a default schedule" do
+    subject.my_schedule.should == hourly
+  end
+
+  def hourly
+    IceCube::Schedule.new(Date.today.to_time).tap { |s|
+      s.add_recurrence_rule IceCube::Rule.hourly
+    }
+  end
+
+end
+
+describe DefaultScheduledActiveRecordModel do
+  alias :model :subject
+
+  it "should have a default schedule" do
+    subject.schedule.should be_a IceCube::Schedule
+  end
+
+
+  describe "schedule_attributes" do
+    it "round-trips a schedule from the database" do
+      model.schedule_attributes = {
+        "repeat"=>"1", "date"=>"",
+        "start_date"=>"2013-02-26", "start_time"=>"",
+        "end_date"=>"2016-07-07",   "end_time"=>"",
+        "ordinal_day"=>"1",         "interval"=>"3",
+        "ordinal_week"=>"1",        "interval_unit"=>"day",
+        "sunday"=>"0",   "monday"=>"0", "tuesday"=>"0", "wednesday"=>"0",
+        "thursday"=>"0", "friday"=>"0", "saturday"=>"0"
+      }
+      expected = IceCube::Schedule.new(Time.local(2013, 2, 26)) do |s|
+        s.rrule IceCube::Rule.daily(3).until(Time.local(2016, 7, 7))
+      end
+      model.schedule.should == expected
+    end
+  end
+
+end

data/spec/schedule_attributes/configuration_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'schedule_attributes/configuration'
+
+describe "ScheduleAttributes" do
+  describe ".configure" do
+    it "yields a configuration instance" do
+      ScheduleAttributes.configure do |config|
+        config.should be_a ScheduleAttributes::Configuration
+      end
+    end
+
+    it "returns a configuration instance" do
+      ScheduleAttributes.configure.should be_a ScheduleAttributes::Configuration
+    end
+  end
+end
+
+describe ScheduleAttributes::Configuration do
+  its(:time_format) { should == '%H:%M' }
+
+  it "#time_format is settable" do
+    subject.time_format = '%l:%M %P'
+    subject.time_format.should == '%l:%M %P'
+  end
+end

data/spec/schedule_attributes/input_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+require 'schedule_attributes/input'
+
+describe ScheduleAttributes::Input do
+  let(:input) { described_class.new(example.metadata[:args]) }
+
+  describe "#repeat?" do
+    subject(:repeat) { input.repeat? }
+
+    context args: {} do
+      it { should be true }
+    end
+
+    [0, '0', 'false', 'f', 'F', 'no', 'none'].each do |cond|
+      context args: {repeat: cond} do
+        it { should be false }
+      end
+    end
+
+    [1, '1', 'true', 't', 'T', 'yes', 'whatever'].each do |cond|
+      context args: {repeat: cond} do
+        it { should be true }
+      end
+    end
+  end
+
+  describe "#start_time" do
+    subject(:start_time) { input.start_time }
+
+    context args: {} do
+      it { should be nil }
+    end
+
+    context args: {date: '2000-12-31'} do
+      it { should == Time.new(2000,12,31,0,0,0) }
+    end
+
+    context args: {start_date: '2000-12-31'} do
+      it { should == Time.new(2000,12,31,0,0,0) }
+    end
+
+    context args: {date: '2000-06-06', start_date: '2000-12-31'} do
+      it { should == Time.new(2000,12,31,0,0,0) }
+    end
+
+    context args: {repeat: '0', date: '2000-06-06', start_date: '2000-12-31'} do
+      it "uses date instead of start_date when not repeating" do
+        should == Time.new(2000,6,6,0,0,0)
+      end
+    end
+
+    context args: {start_date: '2000-12-31', start_time: '14:30'} do
+      it "combines start_date and start_time" do
+        should == Time.new(2000,12,31,14,30,0)
+      end
+    end
+
+    context args: {start_time: '14:00'} do
+      it { should == Date.today.to_time + 14.hours }
+    end
+  end
+
+  describe "#end_time" do
+    subject(:end_time) { input.end_time }
+
+    context args: {} do
+      it { should be nil }
+    end
+
+    context args: {end_time: '14:00'} do
+      it { should == Date.today.to_time + 14.hours }
+    end
+
+    context args: {start_date: '2000-12-31', end_time: '14:00'} do
+      it { should == Time.new(2000,12,31,14,0,0) }
+    end
+
+    context args: {start_date: '2000-06-06', end_date: '2000-12-31', end_time: '14:00'} do
+      it { should == Time.new(2000,6,6,14,0,0) }
+    end
+
+    context args: {date: '2000-12-31', end_time: '14:00'} do
+      it { should == Time.new(2000,12,31,14,0,0) }
+    end
+  end
+
+  describe "#duration" do
+    subject(:duration) { input.duration }
+
+    context args: {} do
+      it { should be nil }
+    end
+
+    context args: {start_time: '8:00'} do
+      it { should be nil }
+    end
+
+    context args: {start_time: '8:00', end_time: '14:00'} do
+      it { should == 6.hours }
+    end
+  end
+
+  describe "#dates" do
+    subject(:dates) { input.dates }
+
+    context args: {} do
+      it { should == [] }
+    end
+
+    context args: {repeat: '0'} do
+      it { should == [] }
+    end
+
+    context args: {start_date: '2000-06-06'} do
+      it { should == [] }
+    end
+
+    context args: {repeat: '0', date: '2000-06-06', start_date: '2000-02-03'} do
+      it { should == [Time.new(2000,6,6)] }
+    end
+
+    context args: {dates: ['2000-01-02','2000-02-03']} do
+      it { should == [Time.new(2000,1,2), Time.new(2000,2,3)] }
+    end
+
+    context args: {repeat: '0', date: '2000-06-06', start_date: '2000-06-06', start_time: '12:00'} do
+      it { should == [Time.new(2000,6,6,12,0)] }
+    end
+  end
+
+  describe "#ends?" do
+    subject(:ends) { input.ends? }
+
+    context args: {repeat: '1', end_date: ''} do
+      it { should be_false }
+    end
+  end
+
+  describe "#yearly_start_month_day?" do
+    subject(:yearly_start_month_day) { input.yearly_start_month_day? }
+
+    context args: {repeat: '1', yearly_start_month_day: '2'} do
+      it { should be_false }
+    end
+
+    context args: {repeat: '1', yearly_start_month: '12', yearly_start_month_day: '2'} do
+      it { should be_true }
+    end
+
+    context args: {repeat: '1', yearly_start_month: '12', yearly_start_month_day: '1'} do
+      it { should be_false }
+    end
+  end
+
+  describe "#yearly_end_month_day?" do
+    subject(:yearly_end_month_day) { input.yearly_end_month_day? }
+
+    context args: {repeat: '1', yearly_end_month_day: '27'} do
+      it { should be_false }
+    end
+
+    context args: {repeat: '1', yearly_end_month: '12', yearly_end_month_day: '27'} do
+      it { should be_true }
+    end
+
+    context args: {repeat: '1', yearly_end_month: '12', yearly_end_month_day: '31'} do
+      it { should be_false }
+    end
+
+    context args: {repeat: '1', yearly_end_month: '11', yearly_end_month_day: '30'} do
+      it { should be_false }
+    end
+  end
+end

data/spec/schedule_attributes/rule_parser/day_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+require 'ice_cube'
+require 'schedule_attributes/rule_parser'
+require 'schedule_attributes/input'
+
+describe ScheduleAttributes::RuleParser::Day do
+  let(:input)  { ScheduleAttributes::Input.new(example.metadata[:args]) }
+  let(:parser) { described_class.new(input) }
+  let(:t)      { Date.current.to_time }
+
+  describe "#rule" do
+    subject      { parser.rule }
+
+    context args: {} do
+      let(:every_day) { [t, t+1.day, t+2.days, t+3.days, t+4.days, t+5.days, t+6.days, t+7.days, t+8.days] }
+
+      it { should == IceCube::Rule.daily }
+      its_occurrences_until(8.days.from_now) { should == every_day }
+    end
+
+    context args: {interval: 2} do
+      let(:every_other_day) { [t, t+2.days, t+4.days, t+6.days, t+8.days] }
+
+      it { should == IceCube::Rule.daily(2) }
+      its_occurrences_until(8.days.from_now) { should == every_other_day }
+    end
+
+    context args: {end_date: '2014-01-30'} do
+      let(:t)           { Time.new(2014,01,30) }
+      let(:last_5_days) { [t-4.days, t-3.days, t-2.days, t-1.day, t] }
+
+      it { should == IceCube::Rule.daily.until(t) }
+      its_occurrences_until(Time.new(2014,02,01)) { subject[-5..-1].should == last_5_days }
+    end
+
+    context args: {yearly_start_month: 1, yearly_end_month: 12} do
+      it { should == IceCube::Rule.daily }
+    end
+
+    context args: {yearly_start_month: 6, yearly_end_month: 8} do
+      it { should == IceCube::Rule.daily.month_of_year(6,7,8) }
+    end
+
+    context args: {yearly_start_month: 11, yearly_end_month: 1} do
+      it { should == IceCube::Rule.daily.month_of_year(11,12,1) }
+    end
+
+    context args: {yearly_start_month: 12, yearly_end_month: 2} do
+      it { should == IceCube::Rule.daily.month_of_year(12,1,2) }
+    end
+
+    context args: {
+      yearly_start_month: 3, yearly_start_month_day: 14,
+      yearly_end_month:   3, yearly_end_month_day:   17
+    } do
+      it { should == IceCube::Rule.daily.month_of_year(3) }
+    end
+  end
+
+  describe "#exceptions" do
+    subject      { parser.exceptions }
+
+    context args: {
+      yearly_start_month: 3, yearly_start_month_day: 4,
+      yearly_end_month:   3, yearly_end_month_day:   26
+    } do
+      it "returns exceptions for the leading & trailing days" do
+        should == [
+          IceCube::Rule.daily.month_of_year(3).day_of_month(*1..3),
+          IceCube::Rule.daily.month_of_year(3).day_of_month(*27..31)
+        ]
+      end
+    end
+
+    context args: {yearly_start_month: 3, yearly_end_month: 3} do
+      it "has no trailing exceptions" do
+        should == []
+      end
+    end
+
+    context args: {yearly_start_month: 3, yearly_end_month: 4, yearly_end_month_day: 25} do
+      it "returns exceptions for the trailing days of the last month only" do
+        should == [IceCube::Rule.daily.month_of_year(4).day_of_month(*26..31)]
+      end
+    end
+
+    context args: {yearly_start_month: 3, yearly_start_month_day: 3, yearly_end_month: 4} do
+      it "returns exceptions for the leading days of the first month" do
+        should == [
+          IceCube::Rule.daily.month_of_year(3).day_of_month(*1..2)
+        ]
+      end
+    end
+
+    context args: {yearly_start_month: 3, yearly_end_month: 4, yearly_start_month_day: 31, yearly_end_month_day: 1} do
+      it "excepts the first 30 days of first month and last 30 days of last month" do
+        should == [
+          IceCube::Rule.daily.month_of_year(3).day_of_month(*1..30),
+          IceCube::Rule.daily.month_of_year(4).day_of_month(*2..31)
+        ]
+      end
+    end
+
+    context args: {yearly_start_month: 12, yearly_end_month: 1, yearly_start_month_day: 31, yearly_end_month_day: 1} do
+      it "excepts the first 30 days of first month and last 30 days of last month" do
+        should == [
+          IceCube::Rule.daily.month_of_year(12).day_of_month(*1..30),
+          IceCube::Rule.daily.month_of_year(1).day_of_month(*2..31)
+        ]
+      end
+    end
+  end
+end

data/spec/schedule_attributes/rule_parser/month_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'ice_cube'
+require 'schedule_attributes/rule_parser'
+require 'schedule_attributes/input'
+
+describe ScheduleAttributes::RuleParser::Month do
+
+  describe "#rule" do
+    let(:input)  { ScheduleAttributes::Input.new(example.metadata[:args]) }
+    let(:parser) { described_class.new(input) }
+    subject      { parser.rule }
+
+    let(:t) { Date.current }
+    let(:n) { (t-14 >> 1).change(day: 14) }
+
+    let(:monthly)    { [t, t >> 1, t >> 2, t >> 3].map(&:to_time) }
+    let(:bimonthly)  { [t, t >> 2, t >> 4, t >> 6].map(&:to_time) }
+    let(:every_14th) { [n, n >> 1, n >> 2, n >> 3].map(&:to_time) }
+
+    context args: {} do
+      it { should == IceCube::Rule.monthly }
+      its_occurrences_until(3.months.from_now) { should == monthly }
+    end
+
+    context args: {"start_date" => "2000-03-14", "interval" => "2"} do
+      it { should == IceCube::Rule.monthly(2) }
+      its_occurrences_until(6.months.from_now) { should == bimonthly }
+    end
+
+    context args: {"ordinal_unit" => "day", "ordinal_day" => "14"} do
+      it { should == IceCube::Rule.monthly.day_of_month(14) }
+      its_occurrences_until(4.months.from_now) { should == every_14th }
+    end
+
+    context args: {"ordinal_unit" => "week", "ordinal_week" => "2", "tuesday" => "1"} do
+      it { should == IceCube::Rule.monthly.day_of_week(:tuesday => [2]) }
+    end
+
+    context args: {"ordinal_unit" => "week", "ordinal_week" => "2"} do
+      it { should == IceCube::Rule.monthly.day_of_week(0=>(w=[2]), 1=>w, 2=>w, 3=>w, 4=>w, 5=>w, 6=>w) }
+    end
+
+    context args: {"start_date" => "2000-03-14", "end_date" => "2000-06-14"} do
+      it { should == IceCube::Rule.monthly.until(Time.new(2000,6,14)) }
+    end
+  end
+end

data/spec/schedule_attributes/rule_parser/week_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'ice_cube'
+require 'schedule_attributes/rule_parser'
+require 'schedule_attributes/input'
+
+describe ScheduleAttributes::RuleParser::Week do
+  let(:t)   { Date.current.to_time }
+  let(:sun) { (Date.current - Date.current.cwday.days).to_time + 1.week }
+  let(:mon) { sun + 1.day }
+  let(:sat) { sun - 1.day }
+
+  let(:weekly)        { [t, t+1.week, t+2.weeks, t+3.weeks, t+4.weeks, t+5.weeks] }
+  let(:every_2_weeks) { [t, t+2.week, t+4.weeks]}
+  let(:weekends)      { [sat, sun, sat+1.week, sun+1.week, sat+2.weeks, sun+2.weeks] }
+
+  describe "#rule" do
+    let(:input)  { ScheduleAttributes::Input.new(example.metadata[:args]) }
+    let(:parser) { described_class.new(input) }
+    subject      { parser.rule }
+
+    context args: {} do
+      it { should == IceCube::Rule.weekly }
+      its_occurrences_until(5.weeks.from_now) { should == weekly }
+    end
+
+    context args: {"interval" => "2"} do
+      it { should == IceCube::Rule.weekly(2) }
+      its_occurrences_until(5.weeks.from_now) { should == every_2_weeks }
+    end
+
+    context args: {"monday" => "0", "saturday" => "1", "sunday" => "1"} do
+      it { should == IceCube::Rule.weekly.day(0,6) }
+      its_occurrences_until(Date.today.beginning_of_week+3.weeks) { subject[-4..-1].should == weekends[-4..-1] }
+    end
+  end
+end