schedulicon 0.0.1

data/lib/schedulicon.rb

@@ -0,0 +1,17 @@
+module Schedulicon
+  require 'schedulicon/version'
+  require 'schedulicon/day_of_week'
+  require 'schedulicon/day_in_month'
+  require 'schedulicon/schedule'
+  require 'schedulicon/attributes'
+
+  # Days of the week
+  MONDAY = 1
+  TUESDAY = 2
+  WEDNESDAY = 3
+  THURSDAY = 4
+  FRIDAY = 5
+  SATURDAY = 6
+  SUNDAY = 7
+
+end

data/lib/schedulicon/attributes.rb

@@ -0,0 +1,41 @@
+# Public: mixin for generating methods required by html forms
+#
+module Schedulicon
+  module Attributes
+
+    def self.included(klass)
+      klass.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+
+      def schedule_attribute(*names)
+        names.each do |name|
+          define_method(name) { instance_variable_get("@#{name}") || instance_variable_set("@#{name}", Schedule.new) }
+          define_method("#{name}=") do |value| instance_variable_set("@#{name}", value) end
+
+          define_method("#{name}_frequency") { send(name).frequency }
+          define_method("#{name}_frequency=") do |value| send(name).frequency = value.to_sym unless value.blank? end
+
+          define_method("#{name}_day_of_week") { send(name).day_of_week.to_i }
+          define_method("#{name}_day_of_week=") do |value| send(name).day_of_week = value end
+
+          define_method("#{name}_continues") { send(name).end_on ? :until : :forever }
+          define_method("#{name}_continues=") do |value| send(name).send("end_on=", nil) if value.to_sym != :until end
+
+          define_method("#{name}_until") { send(name).end_on }
+          define_method("#{name}_until=") do |value|
+            return unless value
+            if value.is_a? String
+              return if value.empty?
+              value = Time.parse(value)
+            end
+            send(name).end_on = value
+          end
+         end
+      end
+    end
+  end
+end

data/lib/schedulicon/day_in_month.rb

@@ -0,0 +1,56 @@
+# Public: Represents a day in month expression
+#
+# examples
+#
+# DayInMonth.new(Schedulicon::THURSDAY, 2)  # second Thursday
+# DayInMonth.new(Schedulicon::SATURDAY, -1)  # last Saturday
+#
+module Schedulicon
+  class DayInMonth
+
+    attr_reader :day, :frequency
+
+    def initialize(day, frequency)
+      @day, @frequency = day, frequency
+    end
+
+    def ordinal
+      {
+        :every => 0,
+        :first => 1,
+        :second => 2,
+        :third => 3,
+        :fourth => 4,
+        :last => -1
+      }[frequency]
+    end
+    # Public: generate array of dates for the range
+    #
+    # starts_at     - DateTime range starts at
+    # end_on        - DateTime rande ends on
+    #
+    # Returns Array of DateTime
+    def dates(start_at, end_on)
+      start_at.to_datetime.step(end_on).select { |d| week_matches(d) && d.cwday == day }
+    end
+
+    # Private: calculates whether date is in the ordinal week for the expression
+    #
+    def week_matches(date)
+      ordinal > 0 ?  week_in_month(date) == ordinal : week_from_end(date) == ordinal.abs
+    end
+
+    # Private: calculates the month week number for a date
+    #
+    def week_in_month(date)
+      ((date.day - 1) / 7) + 1
+    end
+
+    # Private: calculates the month week number from end of month for a date
+    #
+    def week_from_end(date)
+      last_day = DateTime.new(date.next_month.year, date.next_month.month, 1) - 1
+      ((last_day.day - date.day) / 7) + 1
+    end
+  end
+end

data/lib/schedulicon/day_of_week.rb

@@ -0,0 +1,26 @@
+# Public: Represents a day of week expression
+#
+# examples
+#
+# DayOfWeek.new(Schedulicon::THURSDAY)  # every Thursday
+#
+module Schedulicon
+  class DayOfWeek
+
+    attr_reader :day
+
+    def initialize(day)
+      @day = day
+    end
+
+    # Public: generate array of dates for the range
+    #
+    # starts_at     - DateTime range starts at
+    # end_on        - DateTime rande ends on
+    #
+    # Returns Array of DateTime
+    def dates(start_at, end_on)
+      start_at.to_datetime.step(end_on).select { |d| d.cwday == @day }
+    end
+  end
+end

data/lib/schedulicon/schedule.rb

@@ -0,0 +1,78 @@
+# Public: Describes a schedule in a portable fashion
+#
+require 'time'
+require 'date'
+
+module Schedulicon
+  class Schedule
+    FREQUENCIES = [:every, :first, :second, :third, :fourth, :last]
+
+    attr_accessor :frequency, :day_of_week, :start_at, :end_on
+
+    def initialize(attrs={})
+      @frequency = attrs[:frequency] || :every
+      @day_of_week = attrs[:day_of_week] || Schedulicon::MONDAY
+      @start_at = attrs[:start_at]
+      @end_on = attrs[:end_on]
+    end
+
+    # Public: Hash of attributes that can be used to deserialise item from
+    #
+    def to_hash
+      hash = {
+        'frequency' => frequency,
+        'start_at' => start_at.xmlschema,
+        'day_of_week' => day_of_week
+      }
+      hash['end_on'] = end_on.xmlschema if end_on
+      hash
+    end
+
+    # Public: load schedule from the hash
+    #
+    def self.load(attrs)
+      schedule = Schedule.new
+      schedule.start_at = Time.xmlschema(attrs['start_at']).localtime
+      schedule.end_on = Time.xmlschema(attrs['end_on']).localtime if attrs['end_on']
+      schedule.day_of_week = attrs['day_of_week'].to_i
+      schedule.frequency = attrs['frequency'].to_sym
+      schedule
+    end
+
+    # Public: generates the expression required to generate the schedule dates
+    #
+    def expression
+      case frequency
+      when :every
+        DayOfWeek.new(day_of_week)
+      else
+        DayInMonth.new(day_of_week, frequency)
+      end
+    end
+
+    # Public: generate a list of dates for the schedule
+    #
+    def dates(from=nil, to=nil)
+      from ||= start_at
+      to ||= ((end_on && end_on.to_date) || from.to_date >> 12)
+      expression.dates(from, to).collect {|date| date.to_time }
+    end
+
+    # Public: override equality operator to compare values
+    #
+    def ==(other)
+      return false unless other
+      return false unless other.respond_to?(:frequency) && other.frequency == frequency
+      return false unless other.respond_to?(:day_of_week) && other.day_of_week == day_of_week
+      return false unless time_attribute_equal(other, :start_at)
+      return false unless time_attribute_equal(other, :end_on)
+      true
+    end
+
+    def time_attribute_equal(other, name)
+      return false unless other.respond_to? name
+      return other.send(name).utc == self.send(name).utc if other.send(name) && self.send(name)
+      true
+    end
+  end
+end

data/lib/schedulicon/version.rb

@@ -0,0 +1,3 @@
+module Schedulicon
+  VERSION = "0.0.1".freeze
+end

data/spec/schedulicon/attributes_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+class DummyModel
+  include Attributes
+  schedule_attribute :event_schedule
+end
+
+describe Attributes do
+  before(:each) do
+    @model = DummyModel.new
+  end
+
+  describe ".schedule_attribute" do
+    context "when root attribute not set" do
+      it "returns a Schedule" do
+        @model.event_schedule.should be_an_instance_of(Schedule)
+      end
+      it "frequency should be every" do
+        @model.event_schedule_frequency.should eq(:every)
+      end
+      it "day_of_week should be monday" do
+        @model.event_schedule_day_of_week.should eq(Schedulicon::MONDAY)
+      end
+      it "continues should be forever" do
+        @model.event_schedule_continues.should eq(:forever)
+      end
+      it "until should be nil" do
+        @model.event_schedule_until.should be_nil
+      end
+    end
+    context "#until" do
+      context "when set with valid date string" do
+
+        subject { @model.event_schedule_until = "12/07/2012" }
+
+        it "sets the until to a valid time" do
+          subject
+          @model.event_schedule_until.should eq(Time.new(2012, 7, 12))
+        end
+      end
+      context "when set with empty date string" do
+
+        subject { @model.event_schedule_until = "" }
+
+        it "sets the until to a valid time" do
+          subject
+          @model.event_schedule_until.should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/schedulicon/day_in_month_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe DayInMonth do
+  describe "#dates" do
+    before(:each) do
+      @start_at = DateTime.new(2012, 6, 1, 19, 0)
+      @end_on = DateTime.new(2012, 9, 1, 19, 0)
+    end
+
+    subject { DayInMonth.new(@day, @frequency).dates(@start_at, @end_on) }
+
+    context "when 3rd Thursday" do
+      before(:each) do
+        @day = Schedulicon::THURSDAY
+        @frequency = :third
+      end
+
+      it "first should be 21 June" do
+        subject[0].should eq(DateTime.new(2012, 6, 21, 19, 0))
+      end
+      it "second should be 19 July" do
+        subject[1].should eq(DateTime.new(2012, 7, 19, 19, 0))
+      end
+      it "third should be 16 August" do
+        subject[2].should eq(DateTime.new(2012, 8, 16, 19, 0))
+      end
+      it "should return 3 items" do
+        subject.count.should eq(3)
+      end
+    end
+
+    context "when last Tuesday" do
+      before(:each) do
+        @day = Schedulicon::TUESDAY
+        @frequency = :last
+      end
+      it "first should be 26 June" do
+        subject[0].should eq(DateTime.new(2012, 6, 26, 19, 0))
+      end
+      it "second should be 31 July" do
+        subject[1].should eq(DateTime.new(2012, 7, 31, 19, 0))
+      end
+      it "third should be 28 August" do
+        subject[2].should eq(DateTime.new(2012, 8, 28, 19, 0))
+      end
+      it "should return 3 items" do
+        subject.count.should eq(3)
+      end
+    end
+  end
+
+  describe "#week_from_end" do
+
+    subject { DayInMonth.new(Schedulicon::THURSDAY, :last).week_from_end(@date) }
+
+    context "when in last week" do
+      before(:each) do
+        @date = DateTime.new(2012, 6, 28)
+      end
+      it "is 1" do
+        subject.should eq(1)
+      end
+    end
+    context "when in penultimate week" do
+      before(:each) do
+        @date = DateTime.new(2012, 6, 22)
+      end
+      it "is 2" do
+        subject.should eq(2)
+      end
+    end
+
+  end
+end

data/spec/schedulicon/day_of_week_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe DayOfWeek do
+  describe "#dates" do
+    before(:each) do
+      @start_at = DateTime.new(2012, 6, 1, 19, 0)
+      @end_on = DateTime.new(2012, 7, 1, 19, 0)
+    end
+    
+    context "when Monday" do
+      before(:each) do
+        @day = Schedulicon::MONDAY
+      end
+      
+      subject { DayOfWeek.new(@day).dates(@start_at, @end_on) }
+      
+      it "first should be 4 June" do
+        subject[0].should eq(DateTime.new(2012, 6, 4, 19, 0))
+      end
+      it "second should be 11 June" do
+        subject[1].should eq(DateTime.new(2012, 6, 11, 19, 0))
+      end
+      it "third should be 18 June" do
+        subject[2].should eq(DateTime.new(2012, 6, 18, 19, 0))
+      end
+      it "fourth should be 25 June" do
+        subject[3].should eq(DateTime.new(2012, 6, 25, 19, 0))
+      end
+      it "should return 4 items" do
+        subject.count.should eq(4)
+      end
+    end
+  end
+    
+end

data/spec/schedulicon/schedule_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe Schedule do
+  describe ".load" do
+    before(:each) do
+      @frequency = :first
+      @day_of_week = Schedulicon::WEDNESDAY
+      @start_at = random_time
+    end
+
+    subject { Schedule.load({'frequency' => @frequency.to_s, 'day_of_week' => @day_of_week.to_s, 'start_at' => @start_at.xmlschema }) }
+
+    it "sets the start time" do
+      subject.start_at.to_s.should eq(@start_at.to_s)
+    end
+    it "sets the day_of_week" do
+      subject.day_of_week.should eq(@day_of_week)
+    end
+    it "sets the day on the expression" do
+      subject.frequency.should eq(@frequency)
+    end
+  end
+
+  describe "#to_hash" do
+    before(:each) do
+      @schedule = Schedule.new
+      @schedule.frequency = :first
+      @schedule.day_of_week = Schedulicon::WEDNESDAY
+      @schedule.start_at = random_time
+      @schedule.end_on = random_time
+    end
+
+    subject { @schedule.to_hash }
+
+    it "sets the start time" do
+      subject['start_at'].should eq(@schedule.start_at.xmlschema)
+    end
+    it "sets the start time" do
+      subject['end_on'].should eq(@schedule.end_on.xmlschema)
+    end
+    it "sets the day_of_week" do
+      subject['day_of_week'].should eq(@schedule.day_of_week)
+    end
+    it "sets the day on the expression" do
+      subject['frequency'].should eq(@schedule.frequency)
+    end
+  end
+
+  describe "#expression" do
+    before(:each) do
+      @schedule = Schedule.new
+    end
+
+    subject { @schedule.expression }
+
+    context "when every Friday" do
+      before(:each) do
+        @schedule.day_of_week = Schedulicon::FRIDAY
+        @schedule.frequency = :every
+      end
+      it "should be a DayOfWeek" do
+        subject.should be_an_instance_of(DayOfWeek)
+      end
+      it "should have Friday as the day" do
+        subject.day.should eq(Schedulicon::FRIDAY)
+      end
+    end
+
+    context "when 3rd Tuesday of the month" do
+      before(:each) do
+        @schedule.day_of_week = Schedulicon::TUESDAY
+        @schedule.frequency = :third
+      end
+      it "should be a DayInMonth" do
+        subject.should be_an_instance_of(DayInMonth)
+      end
+      it "should have Tuesday as the day" do
+        subject.day.should eq(Schedulicon::TUESDAY)
+      end
+      it "should have 3 as the ordinal" do
+        subject.ordinal.should eq(3)
+      end
+    end
+
+    context "when last Sunday of the month" do
+      before(:each) do
+        @schedule.day_of_week = Schedulicon::SUNDAY
+        @schedule.frequency = :last
+      end
+      it "should be a DayInMonth" do
+        subject.should be_an_instance_of(DayInMonth)
+      end
+      it "should have Tuesday as the day" do
+        subject.day.should eq(Schedulicon::SUNDAY)
+      end
+      it "should have 3 as the ordinal" do
+        subject.ordinal.should eq(-1)
+      end
+    end
+  end
+
+  describe "#dates" do
+    before(:each) do
+      @schedule = Schedule.new
+      @schedule.start_at = @start_at = random_time
+      @schedule.end_on = @end_on = random_time
+      @expression = mock('Expression', :dates => [])
+      @schedule.stub(:expression) { @expression }
+      @from = random_time
+      @to = random_time
+    end
+
+    subject { @schedule.dates(@from, @to) }
+
+    it "calls the expression#dates with args" do
+      @expression.should_receive(:dates).with(@from, @to)
+      subject
+    end
+    context "when no argumens passed" do
+      before(:each) do
+        @from = nil
+        @to = nil
+      end
+      it "calls the expression#dates with args" do
+        @expression.should_receive(:dates).with(@start_at, @end_on.to_date)
+        subject
+      end
+      context "when end_on is nil" do
+        before(:each) do
+          @schedule.end_on = nil
+        end
+        it "calls end as 12 months from start" do
+          @expression.should_receive(:dates).with(@start_at, @start_at.to_date >> 12)
+          subject
+        end
+      end
+    end
+  end
+
+  describe "#==" do
+    before(:each) do
+      @start_at = random_time
+      @schedule = Schedule.new(:frequency => :second, :day_of_week => Schedulicon::SATURDAY, :start_at => @start_at)
+    end
+
+    subject { @schedule == @other }
+
+    context "when other is nil" do
+      before(:each) do
+        @other = nil
+      end
+      it "is false" do
+        subject.should eq(false)
+      end
+    end
+    context "when other is equal" do
+      before(:each) do
+        @other = Schedule.new(:frequency => :second, :day_of_week => Schedulicon::SATURDAY, :start_at => @start_at)
+      end
+      it "is true" do
+        subject.should eq(true)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'time'
+require 'date'
+require 'rake'
+require 'rspec'
+require "#{Rake.application.original_dir}/lib/schedulicon"
+
+include Schedulicon
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+end
+
+def random_string
+  (0...24).map{ ('a'..'z').to_a[rand(26)] }.join
+end
+
+def random_integer
+  rand(9999)
+end
+
+def random_time
+  Time.now - random_integer
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: schedulicon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Bird
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-11 00:00:00.000000000 Z
+dependencies: []
+description: Gem for recurring events
+email: adam.bird@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/schedulicon/attributes.rb
+- lib/schedulicon/day_in_month.rb
+- lib/schedulicon/day_of_week.rb
+- lib/schedulicon/schedule.rb
+- lib/schedulicon/version.rb
+- lib/schedulicon.rb
+- spec/schedulicon/attributes_spec.rb
+- spec/schedulicon/day_in_month_spec.rb
+- spec/schedulicon/day_of_week_spec.rb
+- spec/schedulicon/schedule_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/adambird/schedulicon
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem for recurring events
+test_files:
+- spec/schedulicon/attributes_spec.rb
+- spec/schedulicon/day_in_month_spec.rb
+- spec/schedulicon/day_of_week_spec.rb
+- spec/schedulicon/schedule_spec.rb
+- spec/spec_helper.rb