dgp-schedule_attributes 0.4.0

data/lib/schedule_attributes/time_helpers.rb

@@ -0,0 +1,36 @@
+module ScheduleAttributes
+  module TimeHelpers
+    def self.parse_in_zone(str)
+      if Time.respond_to?(:zone) && Time.zone
+        # Rails 4.1 removes Date.to_time_in_current_zone in favour of Date.in_time_zone
+        if str.respond_to?(:in_time_zone)
+          str.in_time_zone
+        else
+          str.is_a?(Date) ? str.to_time_in_current_zone : Time.zone.parse(str)
+        end
+      else
+        str.is_a?(Time) ? str : Time.parse(str)
+      end
+    end
+
+    def self.today
+      if Time.respond_to?(:zone) && Time.zone
+        # Rails 4.1 removes Date.to_time_in_current_zone in favour of Date.in_time_zone
+        current_date = Date.current
+        current_date.respond_to?(:in_time_zone) ? current_date.in_time_zone : current_date.to_time_in_current_zone
+      else
+        Date.today.to_time
+      end
+    end
+  end
+
+  module DateHelpers
+    def self.today
+      if Time.respond_to?(:zone) && Time.zone
+        Date.current
+      else
+        Date.today
+      end
+    end
+  end
+end

data/lib/schedule_attributes/version.rb

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

data/schedule_attributes.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "schedule_attributes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dgp-schedule_attributes"
+  s.version     = ScheduleAttributes::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["David Gil"]
+  s.email       = ["dgilperez@gmail.com"]
+  s.homepage    = "https://github.com/dgilperez/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.13'
+  s.add_dependency 'activesupport', '>= 3.2'
+  s.add_dependency 'tzinfo' # this should be an activesupport dependency!
+
+  # s.add_runtime_dependency 'railties', '>= 3.2'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.99'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'activerecord', '>= 3.2'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'appraisal'
+end

data/spec/active_record_integration_spec.rb

@@ -0,0 +1,57 @@
+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
+
+    it "should deal with all_occurrences with no infinite loops" do
+      model.schedule_attributes = {
+        repeat: 1, interval: 7, interval_unit: "day",
+        start_date: "11/03/2000", end_date: "11/04/2000",
+        all_day: true
+      }
+      schedule = model.schedule
+
+      # Calling schedule_attributes should not change Schedule::Rule.
+      model.schedule_attributes
+
+      model.schedule.should == schedule
+      model.schedule.all_occurrences.size.should == 5
+    end
+  end
+
+end

data/spec/schedule_attributes/configuration_spec.rb

@@ -0,0 +1,29 @@
+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
+  describe ".time_format" do
+    it "has a default" do
+      subject.time_format.should == '%H:%M'
+    end
+
+    it "is settable" do
+      subject.time_format = '%l:%M %P'
+      subject.time_format.should == '%l:%M %P'
+    end
+  end
+end

data/spec/schedule_attributes/input_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+require 'schedule_attributes/input'
+
+describe ScheduleAttributes::Input do
+  let(:input) { described_class.new(RSpec.current_example.metadata[:args]) }
+
+  describe "#repeat?" do
+    subject(:repeat) { input.repeat? }
+
+    context 'no arguments', args: {} do
+      it { should be true }
+    end
+
+    [0, '0', 'false', 'f', 'F', 'no', 'none'].each do |cond|
+      context 'false', args: {repeat: cond} do
+        it { should be false }
+      end
+    end
+
+    [1, '1', 'true', 't', 'T', 'yes', 'whatever'].each do |cond|
+      context 'true', args: {repeat: cond} do
+        it { should be true }
+      end
+    end
+  end
+
+  describe "#start_time" do
+    subject(:start_time) { input.start_time }
+
+    context 'no arguments', args: {} do
+      it { should be nil }
+    end
+
+    context 'date argument', args: {date: '2000-12-31'} do
+      it { should == Time.new(2000,12,31,0,0,0) }
+    end
+
+    context 'start_date argument', args: {start_date: '2000-12-31'} do
+      it { should == Time.new(2000,12,31,0,0,0) }
+    end
+
+    context 'date and start_date arguments', args: {date: '2000-06-06', start_date: '2000-12-31'} do
+      it { should == Time.new(2000,12,31,0,0,0) }
+    end
+
+    context 'both dates and repeat arguments', 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 'start_date and start_time arguments', 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 'start_time argument', 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 'no arguments', args: {} do
+      it { should be nil }
+    end
+
+    context 'end_time argument', args: {end_time: '14:00'} do
+      it { should == Date.today.to_time + 14.hours }
+    end
+
+    context 'start_date and end_time arguments', args: {start_date: '2000-12-31', end_time: '14:00'} do
+      it { should == Time.new(2000,12,31,14,0,0) }
+    end
+
+    context 'start_date, end_date and end_time arguments', 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 'date and end_time arguments', args: {date: '2000-12-31', end_time: '14:00'} do
+      it { should == Time.new(2000,12,31,14,0,0) }
+    end
+
+    context 'start_date and _time and end_date and _time arguments', args: {start_date: '2000-06-06', end_date: '2000-12-31', start_time: '06:00', end_time: '14:00'} do
+      it { should == Time.new(2000,6,6,14,0,0) }
+    end
+
+    context 'start_date and _time and end_date and _time arguments, 24h format', args: {start_date: '2000-06-06', end_date: '2000-12-31', start_time: '20:00', end_time: '14:00'} do
+      it { should == Time.new(2000,6,7,14,0,0) }
+    end
+  end
+
+  describe "#duration" do
+    subject(:duration) { input.duration }
+
+    context 'no arguments', args: {} do
+      it { should be nil }
+    end
+
+    context 'start_time argument', args: {start_time: '8:00'} do
+      it { should be nil }
+    end
+
+    context 'start_time and end_time arguments', args: {start_time: '8:00', end_time: '14:00'} do
+      it { should == 6.hours }
+    end
+  end
+
+  describe "#dates" do
+    subject(:dates) { input.dates }
+
+    context 'no arguments', args: {} do
+      it { should == [] }
+    end
+
+    context 'repeat argument', args: {repeat: '0'} do
+      it { should == [] }
+    end
+
+    context 'start_date argument', args: {start_date: '2000-06-06'} do
+      it { should == [] }
+    end
+
+    context 'repeat, date and start_date arguments', args: {repeat: '0', date: '2000-06-06', start_date: '2000-02-03'} do
+      it { should == [Time.new(2000,6,6)] }
+    end
+
+    context 'dates array argument', args: {dates: ['2000-01-02','2000-02-03']} do
+      it { should == [Time.new(2000,1,2), Time.new(2000,2,3)] }
+    end
+
+    context 'repeat, date, start_date and start_time arguments', 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 'repeat and end_date arguments', args: {repeat: '1', end_date: ''} do
+      it { should be_falsey }
+    end
+  end
+
+  describe "#yearly_start_month_day?" do
+    subject(:yearly_start_month_day) { input.yearly_start_month_day? }
+
+    context 'repeat and yearly_start_month_day arguments', args: {repeat: '1', yearly_start_month_day: '2'} do
+      it { should be_falsey }
+    end
+
+    context 'repeat, yearly_start_month and yearly_start_month_day arguments', args: {repeat: '1', yearly_start_month: '12', yearly_start_month_day: '2'} do
+      it { should be_truthy }
+    end
+
+    context 'repeat, yearly_start_month and yearly_start_month_day arguments', args: {repeat: '1', yearly_start_month: '12', yearly_start_month_day: '1'} do
+      it { should be_falsey }
+    end
+  end
+
+  describe "#yearly_end_month_day?" do
+    subject(:yearly_end_month_day) { input.yearly_end_month_day? }
+
+    context 'repeat and yearly_end_month_day arguments', args: {repeat: '1', yearly_end_month_day: '27'} do
+      it { should be_falsey }
+    end
+
+    context 'repeat, yearly_end_month and yearly_end_month_day arguments', args: {repeat: '1', yearly_end_month: '12', yearly_end_month_day: '27'} do
+      it { should be_truthy }
+    end
+
+    context 'repeat, yearly_end_month and yearly_end_month_day arguments', args: {repeat: '1', yearly_end_month: '12', yearly_end_month_day: '31'} do
+      it { should be_falsey }
+    end
+
+    context 'repeat, yearly_end_month and yearly_end_month_day arguments', args: {repeat: '1', yearly_end_month: '11', yearly_end_month_day: '30'} do
+      it { should be_falsey }
+    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(RSpec.current_example.metadata[:args]) }
+  let(:parser) { described_class.new(input) }
+  let(:t)      { Date.current.to_time }
+
+  describe "#rule" do
+    subject      { parser.rule }
+
+    context 'no arguments', 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 'interval argument', 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 'end_date argument', 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 'yearly_start_month and yearly_end_month arguments, whole year', args: {yearly_start_month: 1, yearly_end_month: 12} do
+      it { should == IceCube::Rule.daily }
+    end
+
+    context 'yearly_start_month and yearly_end_month arguments, less than a year', args: {yearly_start_month: 6, yearly_end_month: 8} do
+      it { should == IceCube::Rule.daily.month_of_year(6,7,8) }
+    end
+
+    context 'yearly_start_month and yearly_end_month arguments, jump year', args: {yearly_start_month: 11, yearly_end_month: 1} do
+      it { should == IceCube::Rule.daily.month_of_year(11,12,1) }
+    end
+
+    context 'yearly_start_month and yearly_end_month arguments, jump year alt', args: {yearly_start_month: 12, yearly_end_month: 2} do
+      it { should == IceCube::Rule.daily.month_of_year(12,1,2) }
+    end
+
+    context 'yearly_start_month, yearly_start_month_day, yearly_end_month and yearly_end_month_day arguments', 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 'yearly_start_month, yearly_start_month_day, yearly_end_month and yearly_end_month_day arguments', 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 'yearly_start_month and yearly_end_month arguments', args: {yearly_start_month: 3, yearly_end_month: 3} do
+      it "has no trailing exceptions" do
+        should == []
+      end
+    end
+
+    context 'yearly_start_month, yearly_end_month and yearly_end_month_day arguments', 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 'yearly_start_month, yearly_start_month_day and yearly_end_month arguments', 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 'yearly_start_month, yearly_end_month, yearly_start_month_day and yearly_end_month_day arguments', 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 'yearly_start_month, yearly_end_month, yearly_start_month_day and yearly_end_month_day arguments', 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