reservation 0.0.1 → 0.0.2

data/.loco

@@ -0,0 +1,3 @@
+# -*- mode: ruby -*-
+
+Loco::Counter::EXCLUDE << /^spec\/dummy/

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 YOURNAME
+Copyright 2013 Conan Dalton
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,56 @@
+# Reservation
+
+A gem for managing reservations. Provides the notion of "Event", which is basically an interval in time, and a
+"Reservation", which is a many-to-many association model between Event and your objects.
+
+There is no privileged event "owner", all associations are considered equivalent.
+
+This gem uses ActiveRecord to store events and reservations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'reservation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reservation
+
+## Usage
+
+Objects associated with an event are called "subjects"; each event has many subjects, via an association
+model called Reservation::Reservation. The simplest way to create a bunch of events is to use Event#create_weekly.
+This will create a set of events, with the given subjects, within the given constraints, repeating weekly.
+
+    subjects = [ { "role" => "owner", "subject" => matt, "status" => "confirmed" },
+                 { "role" => "helpr", "subject" => bill, "status" => "tentative" },
+                 { "role" => "place", "subject" => here, "status" => "tentative" }
+               ]
+
+    pattern = [ { "day" => "wed", "start" => "0930", "finish" => "1030"},
+                { "day" => "wed", "start" => "18",   "finish" => "20"  },
+                { "day" => "tue", "start" => "7",    "finish" => "830" } ]
+
+    Reservation::Event.create_weekly "the_title", "2013-09-03", "2013-10-13", subjects, pattern
+
+You can use Reservation::Event#build_weekly instead in order to instantiate the object graph without
+persisting it.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## license
+
+MIT License

data/lib/reservation.rb

@@ -1,6 +1,7 @@
-module Reservation
-end
 
+require "reservation/schedule"
+require "reservation/scopes"
+require "reservation/event_filter"
 require "reservation/event"
 require "reservation/reservation"
 

data/lib/reservation/event.rb

@@ -1,4 +1,9 @@
+require "reservation/time_offset"
+
 class Reservation::Event < ActiveRecord::Base
+  extend Reservation::TimeOffset
+  extend Reservation::EventFilter
+
   has_many :reservations, :class_name => "Reservation::Reservation"
   attr_accessible :finish, :start, :title
 
@@ -6,10 +11,61 @@ class Reservation::Event < ActiveRecord::Base
   scope :upto,  lambda { |time| where("reservation_events.start  < ?", time) }
   scope :reserved_for, lambda { |who|
     klass = who.class.base_class.name
-    joins("join reservation_reservations rrx on reservation_events.id = rrx.event_id").where("rrx.subject_type = ? and rrx.subject_id = ?", klass, who.id)
+    join_name = "rrx_#{Time.now.to_i}#{rand(1000)}"
+    joins("join reservation_reservations #{join_name} on reservation_events.id = #{join_name}.event_id").where("#{join_name}.subject_type = ? and #{join_name}.subject_id = ?", klass, who.id)
   }
 
   def overlap? range_start, range_end
     (range_end > start) && (range_start < finish)
   end
+
+  def matches? weekday_spec
+    return true if weekday_spec.nil?
+    return false if self.start.day != self.finish.day
+    spec = weekday_spec[DAY_MAP[self.start.wday]]
+    my_start = { :hour => self.start.hour, :min => self.start.min }
+    my_finish = { :hour => self.finish.hour, :min => self.finish.min }
+    spec.include? [my_start, my_finish]
+  end
+
+  def self.build_weekly title, from, upto, subjects, pattern
+    schedule = Reservation::Schedule::Weekly.new pattern
+    from = Date.parse from
+    max = Date.parse upto
+    events = schedule.generate from, max
+    events.each { |e|
+      e.title = title
+        subjects.each { |subject_data|
+          role    = subject_data["role"]
+          status  = subject_data["status"]
+          subject = subject_data["subject"]
+          e.reservations.build :role => role, :reservation_status => status, :subject => subject
+        }
+      yield e if block_given?
+    }
+    events
+  end
+
+  def self.create_weekly title, from, upto, subjects, pattern
+    build_weekly(title, from, upto, subjects, pattern) { |e| e.save! }
+  end
+
+  def self.remove_subject subject, filter_options
+    filter_events(filter_options).each { |event|
+      event.reservations.each { |r|
+        if r.subject == subject
+          r.destroy
+        end
+      }
+    }
+  end
+
+  def self.add_subject subject_data, filter_options
+    filter_events(filter_options).each { |event|
+      role    = subject_data["role"]
+      status  = subject_data["status"]
+      subject = subject_data["subject"]
+      event.reservations.create! :role => role, :reservation_status => status, :subject => subject
+    }
+  end
 end

data/lib/reservation/event_filter.rb

@@ -0,0 +1,47 @@
+module Reservation
+  module EventFilter
+    def parse_time_for_upto txt
+      d = Date.parse(txt) rescue nil
+      t = Time.parse(txt) rescue nil
+      raise "can't read date/time #{txt.inspect}" if d.nil? && t.nil?
+      if d && (d.to_time == t)
+        return (d + 1.day).to_time
+      end
+      t
+    end
+
+    def filter_events options
+      from = options["from"]
+      upto = options["upto"]
+      context = options["context"]
+      schedule = options["schedule"]
+
+      events = ::Reservation.events
+
+      if from
+        from = from.is_a?(String) ? Date.parse(from) : from.to_date
+        events = events.since(from)
+      end
+
+      if upto
+        upto = upto.is_a?(String) ? parse_time_for_upto(upto) : upto.to_time if upto
+        events = events.upto(upto) if upto
+      end
+
+      if context
+        context = [context] unless context.is_a? Array
+        context = context.uniq
+        events = context.inject(events) { |ee, ctx|
+          ee.reserved_for(ctx)
+        }
+      end
+
+      if schedule
+        schedule = ::Reservation::Schedule::Weekly.new schedule
+        events = schedule.filter events
+      end
+
+      events
+    end
+  end
+end

data/lib/reservation/reservation.rb

@@ -1,5 +1,7 @@
-class Reservation::Reservation < ActiveRecord::Base
-  belongs_to :event, :class_name => "Reservation::Event"
-  belongs_to :subject, :polymorphic => true
-  attr_accessible :reservation_status, :role, :subject_id, :subject_type, :event_id, :event, :subject
+module Reservation
+  class Reservation < ActiveRecord::Base
+    belongs_to :event, :class_name => "Reservation::Event"
+    belongs_to :subject, :polymorphic => true
+    attr_accessible :reservation_status, :role, :subject_id, :subject_type, :event_id, :event, :subject
+  end
 end

data/lib/reservation/schedule.rb

@@ -0,0 +1,191 @@
+module Reservation
+  DAY_MAP = { "sun" => 0, "mon" => 1, "tue" => 2, "wed" => 3, "thu" => 4, "fri" => 5, "sat" => 6 }
+  MAP_DAY = %w{ sun mon tue wed thu fri sat }
+
+  module Schedule
+    #
+    # a utility class to match the hour and minute elements of a Time instance, without considering any other values
+    #
+    class HourMinute
+      attr_accessor :hour, :minute
+      def initialize hour, minute
+        @hour, @minute = hour, minute
+      end
+
+      def matches_time? time
+        time.hour == self.hour && time.min == self.minute
+      end
+
+      #
+      # hhmm is a string containg an hour-and-minute value
+      #
+      # #parse will remove all nondigit characters, pad the result to 4 digits,
+      # and interpret the first two as an hour value, the last two as a minute value
+      #
+      # padding takes place as follows :
+      #  * one digit becomes 0d00 (assumes "7" means "0700")
+      #  * two digits become dd00 (assumes "11" means "1100")
+      #  * three digits become 0ddd (assumes "830" means "0830")
+      #
+      def self.parse hhmm
+        orig = hhmm
+        hhmm = hhmm.gsub /[^\d]/, ""
+        hhmm = "0#{hhmm}00" if hhmm.length == 1
+        hhmm = "#{hhmm}00" if hhmm.length == 2
+        hhmm = "0#{hhmm}" if hhmm.length == 3
+        raise "Can't parse #{orig.inspect}" unless hhmm.match(/^\d\d\d\d$/)
+
+        hh = hhmm[0,2].to_i
+        mm = hhmm[2,4].to_i
+
+        new hh, mm
+      end
+
+      def change date
+        date.to_time.change :hour => hour, :min => minute
+      end
+
+      def to_s
+        "#{hour.to_s.rjust 2, "0"}#{minute.to_s.rjust 2, "0"}"
+      end
+    end
+
+    #
+    # a utility class to match the start and end times of an Event instance, without considering the event date
+    #
+    class Interval
+      attr_accessor :start, :finish
+
+      def initialize start, finish
+        @start, @finish = start, finish
+      end
+
+      # true if the start time and finish time of the given event matches start and finish times of this Interval
+      def matches? event
+        start.matches_time?(event.start) && finish.matches_time?(event.finish)
+      end
+
+      # build a new Event with this Interval's start and finish times, on the given date
+      def generate date
+        Event.new :start => start.change(date), :finish => finish.change(date)
+      end
+
+      def self.from start, finish
+        new HourMinute.parse(start), HourMinute.parse(finish)
+      end
+
+      def to_s
+        "#{start}-#{finish}"
+      end
+    end
+
+    #
+    # a utility class to represent a set of intervals on a single day
+    #
+    class Daily
+      attr_accessor :wday, :intervals
+
+      def initialize wday
+        @wday = wday
+        @intervals = []
+      end
+
+      def add interval
+        intervals << interval
+      end
+
+      def matches? event
+        return false if event.start.wday != self.wday
+        intervals.each { |interval|
+          return true if interval.matches? event
+        }
+        false
+      end
+
+      def generate date, list
+        return list if date.wday != wday
+        intervals.inject(list) { |list, interval|
+          list << interval.generate(date)
+          list
+        }
+      end
+
+      def to_s
+        "#{MAP_DAY[wday]} => #{intervals}"
+      end
+    end
+
+    #
+    # Weekly defines a set of intervals that recur weekly
+    #
+    # This class maintains an array of intervals for each weekday
+    #
+    # This class will never match multi-day events, as it assumes each event starts and ends within the same day
+    #
+    class Weekly
+
+      # wdays is a 7-element array of Daily instances
+      #
+      # the zeroth element corresponds to Sunday, because Time#wday behaves that way.
+      #
+      attr_accessor :wdays
+
+      # pattern is an array of the form
+      #
+      #  [ { "day" => "wed", "start" => "0930", "finish" => "10:30"},
+      #    { "day" => "wed", "start" => "18",   "finish" => "20"   },
+      #    { "day" => "tue", "start" => "7",    "finish" => "8h30" }  ]
+      #
+      # see HourMinute#parse for how "start" and "finish" values are read
+      #
+      def initialize pattern
+        self.wdays = (0..6).map { |i| Daily.new(i) }
+
+        pattern.each { |interval_spec|
+          wday   = DAY_MAP[interval_spec["day"]]
+          raise "unrecognised day #{spec["day"].inspect} in #{pattern.inspect}" if wday.nil?
+
+          start  = HourMinute.parse interval_spec["start"]
+          finish = HourMinute.parse interval_spec["finish"]
+          wdays[wday].add Interval.new(start, finish)
+        }
+      end
+
+      # true if there exists a Daily corresponding to this event's weekday, with
+      # an Interval corresponding to this event's start and finish times;
+      # false otherwise
+      #
+      def matches? event
+        return false if event.start.day != event.finish.day
+        wdays[event.start.wday].matches? event
+      end
+
+      #
+      # generate a set of Events according to this Weekly schedule, starting
+      # on #from at the earliest, ending on #upto at the latest.
+      #
+      # Note: #upto is *inclusive*, this will generate events on #upto,
+      # if the schedule allows
+      #
+      def generate from, upto
+        events = []
+        from.upto(upto).map { |date|
+          wdays.each { |day| day.generate date, events }
+        }
+        events
+      end
+
+      #
+      # return a new list including only those events in the given list
+      # that match this weekly schedule
+      #
+      def filter events
+        events.select { |e| matches? e }
+      end
+
+      def to_s
+        wdays.map(&:to_s).join "\n"
+      end
+    end
+  end
+end

data/lib/reservation/scopes.rb

@@ -0,0 +1,11 @@
+module Reservation
+  # replace this if you need to globally override the starting scope for events
+  def self.events
+    ::Reservation::Event.scoped
+  end
+
+  # replace this if you need to globally override the starting scope for reservations
+  def self.reservations
+    ::Reservation::Reservation.scoped
+  end
+end

data/lib/reservation/time_offset.rb

@@ -0,0 +1,17 @@
+module Reservation
+  module TimeOffset
+    def parse_time_offset hhmm
+      orig = hhmm
+      hhmm = hhmm.gsub /[^\d]/, ""
+      hhmm = "0#{hhmm}00" if hhmm.length == 1
+      hhmm = "#{hhmm}00" if hhmm.length == 2
+      hhmm = "0#{hhmm}" if hhmm.length == 3
+      raise "Can't parse #{orig.inspect}" unless hhmm.match(/^\d\d\d\d$/)
+
+      hh = hhmm[0,2].to_i
+      mm = hhmm[2,4].to_i
+
+      { :hour => hh, :min => mm }
+    end
+  end
+end

data/lib/reservation/version.rb

@@ -1,3 +1,3 @@
 module Reservation
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/dummy/db/migrate/20130711174025_create_contacts.rb

@@ -2,6 +2,7 @@ class CreateContacts < ActiveRecord::Migration
   def change
     create_table :contacts do |t|
       t.string :name
+      t.string :type
 
       t.timestamps
     end

data/spec/dummy/db/schema.rb

@@ -15,6 +15,7 @@ ActiveRecord::Schema.define(:version => 20130711174025) do
 
   create_table "contacts", :force => true do |t|
     t.string   "name"
+    t.string   "type"
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   end

data/spec/models/event_spec.rb

@@ -1,6 +1,18 @@
 require 'spec_helper'
 
 describe Reservation::Event do
+  before { Time.zone = "Europe/Paris" }
+  let(:matt) { Person.create! :name => "matt" }
+  let(:here) { Place.create! :name => "here" }
+  let(:bill) { Person.create! :name => "bill" }
+
+  def the_reservations subject=nil
+      if subject
+        Reservation::Reservation.where(:subject_type => subject.class.base_class.name, :subject_id => subject.id)
+      else
+        Reservation::Reservation.all
+      end.map { |r| "#{r.event.title} #{r.subject.name} #{r.event.start.prettyd} #{r.event.finish.prettyd} #{r.reservation_status}"}.join("\n")
+  end
 
   it "should be a Reservation::Event" do
     Reservation::Event.new.should be_an_instance_of Reservation::Event
@@ -188,5 +200,134 @@ describe Reservation::Event do
       ee[1].reservations.map(&:subject).map(&:name).should == %w{ APPL Cafe }
       ee[2].reservations.map(&:subject).map(&:name).should == %w{ APPL Ulysses }
     end
+
+    it "should find events for Ulysses and AAPL" do
+      ee = Reservation::Event.reserved_for(@book).reserved_for(@appl).order(:id)
+      ee.should == [@r6]
+    end
+  end
+
+  describe :create_weekly do
+    it "should build a simple event for a single subject" do
+      subjects = [{ "role" => "owner", "subject" => matt, "status" => "confirmed" } ]
+      pattern = [ { "day" => "mon", "start" => "0930", "finish" => "1030"} ]
+      Reservation::Event.create_weekly "floss teeth", "2013-09-03", "2013-10-13", subjects, pattern
+      the_reservations.should == "floss teeth matt Mon,20130909T0930 Mon,20130909T1030 confirmed
+floss teeth matt Mon,20130916T0930 Mon,20130916T1030 confirmed
+floss teeth matt Mon,20130923T0930 Mon,20130923T1030 confirmed
+floss teeth matt Mon,20130930T0930 Mon,20130930T1030 confirmed
+floss teeth matt Mon,20131007T0930 Mon,20131007T1030 confirmed"
+    end
+
+    it "should build multiple events for multiple subjects" do
+      subjects = [{ "role" => "owner", "subject" => matt, "status" => "confirmed" }, { "role" => "place", "subject" => here, "status" => "tentative" }]
+      pattern = [ { "day" => "wed", "start" => "0930", "finish" => "1030"}, { "day" => "wed", "start" => "18", "finish" => "20"}, { "day" => "tue", "start" => "7", "finish" => "830"} ]
+      Reservation::Event.create_weekly "the_title", "2013-09-03", "2013-09-30", subjects, pattern
+      the_reservations.should == "the_title matt Tue,20130903T0700 Tue,20130903T0830 confirmed
+the_title here Tue,20130903T0700 Tue,20130903T0830 tentative
+the_title matt Wed,20130904T0930 Wed,20130904T1030 confirmed
+the_title here Wed,20130904T0930 Wed,20130904T1030 tentative
+the_title matt Wed,20130904T1800 Wed,20130904T2000 confirmed
+the_title here Wed,20130904T1800 Wed,20130904T2000 tentative
+the_title matt Tue,20130910T0700 Tue,20130910T0830 confirmed
+the_title here Tue,20130910T0700 Tue,20130910T0830 tentative
+the_title matt Wed,20130911T0930 Wed,20130911T1030 confirmed
+the_title here Wed,20130911T0930 Wed,20130911T1030 tentative
+the_title matt Wed,20130911T1800 Wed,20130911T2000 confirmed
+the_title here Wed,20130911T1800 Wed,20130911T2000 tentative
+the_title matt Tue,20130917T0700 Tue,20130917T0830 confirmed
+the_title here Tue,20130917T0700 Tue,20130917T0830 tentative
+the_title matt Wed,20130918T0930 Wed,20130918T1030 confirmed
+the_title here Wed,20130918T0930 Wed,20130918T1030 tentative
+the_title matt Wed,20130918T1800 Wed,20130918T2000 confirmed
+the_title here Wed,20130918T1800 Wed,20130918T2000 tentative
+the_title matt Tue,20130924T0700 Tue,20130924T0830 confirmed
+the_title here Tue,20130924T0700 Tue,20130924T0830 tentative
+the_title matt Wed,20130925T0930 Wed,20130925T1030 confirmed
+the_title here Wed,20130925T0930 Wed,20130925T1030 tentative
+the_title matt Wed,20130925T1800 Wed,20130925T2000 confirmed
+the_title here Wed,20130925T1800 Wed,20130925T2000 tentative"
+    end
+  end
+
+  describe :add_subject do
+    it "should add a subject within time constraints" do
+      subjects = [{ "role" => "owner", "subject" => matt, "status" => "confirmed" } ]
+      pattern = [ { "day" => "mon", "start" => "0930", "finish" => "1030"} ]
+      Reservation::Event.create_weekly "my_title", "2013-09-03", "2013-10-13", subjects, pattern
+      Reservation::Event.add_subject({ "role" => "student", "status" => "tentative", "subject" => bill}, { "from" => "2013-09-01", "upto" => "2013-09-24", "context" => matt })
+      the_reservations.should == "my_title matt Mon,20130909T0930 Mon,20130909T1030 confirmed
+my_title matt Mon,20130916T0930 Mon,20130916T1030 confirmed
+my_title matt Mon,20130923T0930 Mon,20130923T1030 confirmed
+my_title matt Mon,20130930T0930 Mon,20130930T1030 confirmed
+my_title matt Mon,20131007T0930 Mon,20131007T1030 confirmed
+my_title bill Mon,20130909T0930 Mon,20130909T1030 tentative
+my_title bill Mon,20130916T0930 Mon,20130916T1030 tentative
+my_title bill Mon,20130923T0930 Mon,20130923T1030 tentative"
+    end
+
+    it "should add a subject within schedule contraints" do
+      subjects = [ { "role" => "owner", "subject" => matt, "status" => "confirmed" },
+                   { "role" => "place", "subject" => here, "status" => "tentative" } ]
+
+      pattern = [ { "day" => "wed", "start" => "0930", "finish" => "1030" },
+                  { "day" => "wed", "start" => "18",   "finish" => "20"   },
+                  { "day" => "tue", "start" => "7",    "finish" => "830"  } ]
+
+      Reservation::Event.create_weekly "the_title", "2013-09-03", "2013-10-13", subjects, pattern
+
+      add_schedule = [ { "day" => "wed", "start" => "18", "finish" => "20"} ]
+      Reservation::Event.add_subject({ "role" => "student", "status" => "tentative", "subject" => bill}, { "from" => "2013-09-17", "upto" => "2013-10-02", "schedule" => add_schedule })
+      the_reservations(bill).should == "the_title bill Wed,20130918T1800 Wed,20130918T2000 tentative
+the_title bill Wed,20130925T1800 Wed,20130925T2000 tentative
+the_title bill Wed,20131002T1800 Wed,20131002T2000 tentative"
+    end
+  end
+
+  describe :remove_subject do
+    it "should remove a subject within time constraints" do
+      subjects = [{ "role" => "owner", "subject" => matt, "status" => "confirmed" }, { "role" => "owner", "subject" => bill, "status" => "confirmed" } ]
+      pattern = [ { "day" => "mon", "start" => "0930", "finish" => "1030"} ]
+      Reservation::Event.create_weekly "my_title", "2013-09-03", "2013-10-13", subjects, pattern
+      Reservation::Event.remove_subject(bill, { "from" => "2013-09-15", "upto" => "2013-09-24", "context" => matt })
+      the_reservations.should == "my_title matt Mon,20130909T0930 Mon,20130909T1030 confirmed
+my_title bill Mon,20130909T0930 Mon,20130909T1030 confirmed
+my_title matt Mon,20130916T0930 Mon,20130916T1030 confirmed
+my_title matt Mon,20130923T0930 Mon,20130923T1030 confirmed
+my_title matt Mon,20130930T0930 Mon,20130930T1030 confirmed
+my_title bill Mon,20130930T0930 Mon,20130930T1030 confirmed
+my_title matt Mon,20131007T0930 Mon,20131007T1030 confirmed
+my_title bill Mon,20131007T0930 Mon,20131007T1030 confirmed"
+    end
+
+    it "should remove a subject within schedule contraints" do
+      subjects = [ { "role" => "owner", "subject" => matt, "status" => "confirmed" },
+                   { "role" => "helpr", "subject" => bill, "status" => "tentative" },
+                   { "role" => "place", "subject" => here, "status" => "tentative" }
+                 ]
+
+      pattern = [ { "day" => "wed", "start" => "0930", "finish" => "1030"},
+                  { "day" => "wed", "start" => "18",   "finish" => "20"  },
+                  { "day" => "tue", "start" => "7",    "finish" => "830" } ]
+
+      Reservation::Event.create_weekly "the_title", "2013-09-03", "2013-10-13", subjects, pattern
+
+      remove_schedule = [ { "day" => "wed", "start" => "18", "finish" => "20"}, { "day" => "wed", "start" => "930", "finish" => "1030"} ]
+      Reservation::Event.remove_subject(bill, { "from" => "2013-09-17", "upto" => "2013-10-02", "schedule" => remove_schedule })
+
+      the_reservations(bill).should == "
+the_title bill Tue,20130903T0700 Tue,20130903T0830 tentative
+the_title bill Wed,20130904T0930 Wed,20130904T1030 tentative
+the_title bill Wed,20130904T1800 Wed,20130904T2000 tentative
+the_title bill Tue,20130910T0700 Tue,20130910T0830 tentative
+the_title bill Wed,20130911T0930 Wed,20130911T1030 tentative
+the_title bill Wed,20130911T1800 Wed,20130911T2000 tentative
+the_title bill Tue,20130917T0700 Tue,20130917T0830 tentative
+the_title bill Tue,20130924T0700 Tue,20130924T0830 tentative
+the_title bill Tue,20131001T0700 Tue,20131001T0830 tentative
+the_title bill Tue,20131008T0700 Tue,20131008T0830 tentative
+the_title bill Wed,20131009T0930 Wed,20131009T1030 tentative
+the_title bill Wed,20131009T1800 Wed,20131009T2000 tentative".strip
+    end
   end
 end

data/spec/models/schedule/daily_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Reservation::Schedule::Daily do
+  before { Time.zone = "Europe/Paris" }
+  let(:event_start)  { time("2013-07-12T07:00:00") }
+  let(:event_finish) { time("2013-07-12T09:30:00") }
+  let(:event)        { Reservation::Event.new :start => event_start, :finish => event_finish }
+
+  def interval start, finish
+    start  = Reservation::Schedule::HourMinute.parse start
+    finish = Reservation::Schedule::HourMinute.parse finish
+    Reservation::Schedule::Interval.new(start, finish)
+  end
+
+  it "should match when there exists a matching interval on the same day as the given event" do
+    daily = Reservation::Schedule::Daily.new(5)
+    daily.add interval("7h", "9:30")
+    daily.add interval("18", "2230")
+
+    daily.matches?(event).should be_true
+  end
+
+  it "should not match when the day is different" do
+    daily = Reservation::Schedule::Daily.new(3)
+    daily.add interval("7h", "9:30")
+    daily.add interval("18", "2230")
+
+    daily.matches?(event).should be_false
+  end
+
+  it "should not match when there is no corresponding interval" do
+    daily = Reservation::Schedule::Daily.new(5)
+    daily.add interval("7h", "9:45")
+    daily.add interval("18", "2230")
+
+    daily.matches?(event).should be_false
+  end
+
+  it "should generate events corresponding to its intervals on the given matching date" do
+    daily = Reservation::Schedule::Daily.new(5)
+    daily.add interval("7h", "9:45")
+    daily.add interval("18", "2230")
+
+    events = []
+    daily.generate date("2013-07-12"), events
+    events.map { |e| "#{e.start.prettyd} #{e.finish.pretty}"}.join("\n").
+      should == "Fri,20130712T0700 20130712T0945
+Fri,20130712T1800 20130712T2230"
+  end
+
+  it "should generate no events when the date does not match its weekday" do
+    daily = Reservation::Schedule::Daily.new(2)
+    daily.add interval("7h", "9:45")
+    daily.add interval("18", "2230")
+
+    events = []
+    daily.generate date("2013-07-12"), events
+    events.should == []
+  end
+end

data/spec/models/schedule/hour_minute_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Reservation::Schedule::HourMinute do
+  before { Time.zone = "Europe/Paris" }
+  let(:rightnow) { time("2013-04-30T18:30:00") }
+
+  it "should match when hours and minutes match" do
+    hm = Reservation::Schedule::HourMinute.new 18, 30
+    hm.matches_time?(rightnow).should be_true
+  end
+
+  it "should not match when minutes differ" do
+    hm = Reservation::Schedule::HourMinute.new 18, 31
+    hm.matches_time?(rightnow).should be_false
+  end
+
+  it "should not match when hours differ" do
+    hm = Reservation::Schedule::HourMinute.new 17, 30
+    hm.matches_time?(rightnow).should be_false
+  end
+
+  it "should parse '7' as '0700'" do
+    hm = Reservation::Schedule::HourMinute.parse "7"
+    hm.hour.should == 7
+    hm.minute.should == 0
+  end
+
+  it "should parse '11' as '1100'" do
+    hm = Reservation::Schedule::HourMinute.parse "11"
+    hm.hour.should == 11
+    hm.minute.should == 0
+  end
+
+  it "should parse '815' as '0815'" do
+    hm = Reservation::Schedule::HourMinute.parse "815"
+    hm.hour.should == 8
+    hm.minute.should == 15
+  end
+
+  it "should change a date to a time with the given hour and minute" do
+    hm = Reservation::Schedule::HourMinute.parse "815"
+    time = hm.change date("2013-07-12")
+    time.pretty.should == "20130712T0815"
+  end
+end

data/spec/models/schedule/interval_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Reservation::Schedule::Interval do
+  before { Time.zone = "Europe/Paris" }
+
+  let(:start)  { time("2013-04-30T18:30:00") }
+  let(:finish) { time("2013-04-30T22:30:00") }
+  let(:event)  { Reservation::Event.new :start => start, :finish => finish }
+
+  it "should match when start and finish match" do
+    hm1 = Reservation::Schedule::HourMinute.new 18, 30
+    hm2 = Reservation::Schedule::HourMinute.new 22, 30
+    interval = Reservation::Schedule::Interval.new hm1, hm2
+    interval.matches?(event).should be_true
+  end
+
+  it "should not match when start differs" do
+    hm1 = Reservation::Schedule::HourMinute.new 14, 00
+    hm2 = Reservation::Schedule::HourMinute.new 22, 30
+    interval = Reservation::Schedule::Interval.new hm1, hm2
+    interval.matches?(event).should be_false
+  end
+
+  it "should not match when finish differs" do
+    hm1 = Reservation::Schedule::HourMinute.new 18, 30
+    hm2 = Reservation::Schedule::HourMinute.new 23, 00
+    interval = Reservation::Schedule::Interval.new hm1, hm2
+    interval.matches?(event).should be_false
+  end
+
+  it "should generate a new Event with its start and finish times on the given date" do
+    interval = make_interval "1830", "2300"
+    event = interval.generate date('2013-07-12')
+    event.start.pretty.should  == "20130712T1830"
+    event.finish.pretty.should == "20130712T2300"
+  end
+end

data/spec/models/schedule/weekly_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Reservation::Schedule::Weekly do
+  before { Time.zone = "Europe/Paris" }
+  let(:event_start)  { time("2013-07-12T07:00:00") } # this is a friday
+  let(:event_finish) { time("2013-07-12T09:30:00") }
+  let(:event)        { Reservation::Event.new :start => event_start, :finish => event_finish }
+
+  it "should not match in any case if the event spans more than one day" do
+    weekly = Reservation::Schedule::Weekly.new [ { "day" => "wed", "start" => "0930", "finish" => "10:30"},
+                                                 { "day" => "wed", "start" => "18",   "finish" => "20"   },
+                                                 { "day" => "fri", "start" => "7h",   "finish" => "9:30" },
+                                                 { "day" => "tue", "start" => "7",    "finish" => "8h30" }  ]
+
+    start  = time("2013-02-12T07:00:00") # this is a tuesday
+    finish = time("2013-03-12T09:30:00")
+    my_event = Reservation::Event.new :start => start, :finish => finish
+
+    weekly.matches?(my_event).should be_false
+  end
+
+  it "should match when there exists a matching interval on the same day as the given event" do
+    weekly = Reservation::Schedule::Weekly.new [ { "day" => "wed", "start" => "0930", "finish" => "10:30"},
+                                                 { "day" => "wed", "start" => "18",   "finish" => "20"   },
+                                                 { "day" => "fri", "start" => "7h",   "finish" => "9:30" },
+                                                 { "day" => "tue", "start" => "7",    "finish" => "8h30" }  ]
+
+    weekly.matches?(event).should be_true
+  end
+
+  it "should not match when there exists no matching interval on the same day as the given event" do
+    weekly = Reservation::Schedule::Weekly.new [ { "day" => "wed", "start" => "0930", "finish" => "10:30"},
+                                                 { "day" => "wed", "start" => "18",   "finish" => "20"   },
+                                                 { "day" => "fri", "start" => "7h",   "finish" => "8:30" },
+                                                 { "day" => "tue", "start" => "7",    "finish" => "8h30" }  ]
+
+    weekly.matches?(event).should be_false
+  end
+
+  it "should generate events corresponding to the weekly schedule" do
+    weekly = Reservation::Schedule::Weekly.new [ { "day" => "wed", "start" => "0930", "finish" => "10:30"},
+                                                 { "day" => "wed", "start" => "18",   "finish" => "20"   },
+                                                 { "day" => "fri", "start" => "10h",   "finish" => "11:45" },
+                                                 { "day" => "tue", "start" => "7",    "finish" => "8h30" }  ]
+
+    events = weekly.generate date("2013-07-08"), date("2013-07-23")
+    events.map { |e| "#{e.start.prettyd} #{e.finish.pretty}"}.join("\n").
+      should == "Tue,20130709T0700 20130709T0830
+Wed,20130710T0930 20130710T1030
+Wed,20130710T1800 20130710T2000
+Fri,20130712T1000 20130712T1145
+Tue,20130716T0700 20130716T0830
+Wed,20130717T0930 20130717T1030
+Wed,20130717T1800 20130717T2000
+Fri,20130719T1000 20130719T1145
+Tue,20130723T0700 20130723T0830"
+  end
+
+  it "should filter a set of events" do
+    weekly = Reservation::Schedule::Weekly.new [ { "day" => "wed", "start" => "0930", "finish" => "10:30"},
+                                                 { "day" => "wed", "start" => "18",   "finish" => "20"   },
+                                                 { "day" => "fri", "start" => "10h",   "finish" => "11:45" },
+                                                 { "day" => "tue", "start" => "7",    "finish" => "8h30" }  ]
+
+    events = weekly.generate date("2013-07-08"), date("2013-07-23")
+
+    filter = Reservation::Schedule::Weekly.new [ { "day" => "wed", "start" => "0930", "finish" => "10:30"} ]
+
+    events = filter.filter events
+    events.map { |e| "#{e.start.prettyd} #{e.finish.pretty}"}.join("\n").
+      should == "Wed,20130710T0930 20130710T1030
+Wed,20130717T0930 20130717T1030"
+  end
+end

data/spec/spec_helper.rb

@@ -27,6 +27,10 @@ module Helper
   def time t
     Time.parse t
   end
+
+  def make_interval start, finish
+    Reservation::Schedule::Interval.from start, finish
+  end
 end
 
 RSpec::Core::ExampleGroup.send :include, Helper
@@ -39,4 +43,13 @@ ActiveRecord::Base.silence do
   load(File.dirname(__FILE__) + '/dummy/db/schema.rb')
 end
 
+class Time
+  def pretty
+    self.strftime("%Y%m%dT%H%M")
+  end
+
+  def prettyd
+    self.strftime("%a,%Y%m%dT%H%M")
+  end
+end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reservation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -99,16 +99,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .loco
 - .rspec
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/generators/reservation/reservations_generator.rb
 - lib/generators/reservation/templates/migration.rb
 - lib/reservation.rb
 - lib/reservation/event.rb
+- lib/reservation/event_filter.rb
 - lib/reservation/reservation.rb
+- lib/reservation/schedule.rb
+- lib/reservation/scopes.rb
+- lib/reservation/time_offset.rb
 - lib/reservation/version.rb
 - lib/tasks/reservation_tasks.rake
 - reservation.gemspec
@@ -167,6 +172,10 @@ files:
 - spec/dummy/test/unit/reservation/time_slot_test.rb
 - spec/dummy/test/unit/thing_test.rb
 - spec/models/event_spec.rb
+- spec/models/schedule/daily_spec.rb
+- spec/models/schedule/hour_minute_spec.rb
+- spec/models/schedule/interval_spec.rb
+- spec/models/schedule/weekly_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/conanite/reservation
 licenses: []
@@ -248,4 +257,8 @@ test_files:
 - spec/dummy/test/unit/reservation/time_slot_test.rb
 - spec/dummy/test/unit/thing_test.rb
 - spec/models/event_spec.rb
+- spec/models/schedule/daily_spec.rb
+- spec/models/schedule/hour_minute_spec.rb
+- spec/models/schedule/interval_spec.rb
+- spec/models/schedule/weekly_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,3 +0,0 @@
-= Reservation
-
-This project rocks and uses MIT-LICENSE.