schedsolver2 0.0.1

data/lib/schedsolver2/school.rb

@@ -0,0 +1,176 @@
+module Schedsolver2
+
+  class School
+    include Schedsolver2
+    attr_accessor :cs
+    attr_reader :scheds, :consts, :si, :ts
+
+    def initialize si, ts, cs
+      @si, @ts, @cs = si, ts, cs
+      @consts = generate_constants
+      @scheds = []
+      verify_initialize_args
+      parse_part_time_constraints
+    end
+
+    def print attr
+      case attr
+      when :schedules
+        @scheds.each {|s| log.info("\n" + s.to_s) }
+      when :school_info
+        log.info("SCHOOL INFO #{@si}")
+      when :consts
+        log.info("CONSTS #{@consts}")
+      when :teachers
+        log.info("TEACHERS #{@ts}")
+      when :constraints
+        log.info("CONSTRAINTS #{@cs}")
+      end
+    end
+
+    def parse_part_time_constraints
+      @cs[:part_time] ||= {}
+      @ts[:e].each do |et|
+      not_work_days = (days - et.work_days)
+        if not_work_days == [] then next end
+        s_d = Constraint.days_descriptor(not_work_days, times, [et.id])
+        #log.debug("School#parse_part_time constraints\nS_D = #{s_d}\n")
+        new_pt_c = Constraint.new(:type  => :part_time,
+                                  :et_ids => [et.id],
+                                  :s_ds  => [s_d],
+                                  :name => "et#{et.id} part time")
+        @cs[:part_time][et.id] = new_pt_c
+      end
+    end
+
+    def verify_initialize_args
+      check = ((@si[:end_time] - @si[:start_time]) == (@si[:num_blocks] * @si[:block_size]))
+      raise ArgumentError, "si: end-start != num*size" unless check == true
+
+      @ts[:e].each do |t|
+        raise ArgumentError, "ts:e: has non-teacher" unless t.class == Teacher
+      end
+
+      @ts[:h].each do |t|
+        raise ArgumentError, "ts:h: has non-teacher" unless t.class == Teacher
+      end
+      #add check for cs?
+    end
+
+    def generate_constants
+      h = Hash.new
+      h[:days] = [:mon, :tue, :wed, :thu, :fri]
+      h[:times] = generate_times
+      h[:et_ids] = @ts[:e].map {|t| t.id}
+      h[:ht_ids] = @ts[:h].map {|t| t.id}
+      return h
+    end
+
+    def generate_times
+      ts, t = [], @si[:start_time]
+      @si[:num_blocks].times do 
+        ts << t
+        t += @si[:block_size]
+      end
+      return ts
+    end
+
+    def days 
+      @consts[:days]
+    end
+
+    def times
+      @consts[:times]
+    end
+
+    def et_ids
+      @consts[:et_ids]
+    end
+
+    def ht_ids
+      @consts[:ht_ids]
+    end
+
+    def add type, *args
+      case type
+      when :schedules
+        raise ArgumentError unless (args.size == 1 and args[0] > 0)
+        args[0].times { @scheds << Schedule.new(@consts) }
+      when :hard_constraint
+        @cs[:h] << args[0]
+      end
+    end
+
+    def generate_schedule(index)
+      #log.debug("GENERATE SCHEDULE")
+      i = index
+      @ts[:h].shuffle.each do |ht|
+        ht_id = ht.id
+        #log.debug("Assigning for ht #{ht_id}")
+        count = nil
+        count = ClassCounter.new(@consts[:et_ids])
+
+        @ts[:e].shuffle.each do |et|
+          et_id = et.id
+          w_remaining = @cs[:ecs_per_week] - count.by_et_id(et_id) 
+          #log.debug("\tLOOKING at et #{et_id} with #{w_remaining} remaining this week")
+          if w_remaining == 0
+            #log.debug("\tBREAK because remaining is 0 (top of days loop) ")
+            break
+          end
+
+          @consts[:times].shuffle.each do |time|
+            #log.debug("\tTIME: #{time}")
+            w_remaining = @cs[:ecs_per_week] - count.by_et_id(et_id) 
+
+            if w_remaining == 0 
+              #log.debug("\tBREAK because w_remaining is 0 (top of #{time} loop) ")
+              break
+            end
+             
+            @consts[:days].shuffle.each do |day|
+
+              d_remaining = @cs[:max_ecs_per_day] - count.by_day(day) 
+              w_remaining = @cs[:ecs_per_week] - count.by_et_id(et_id) 
+
+              if d_remaining == 0 
+                #log.debug("\tBREAK because d_remaining is 0 (top of #{day} loop) ")
+                next
+              elsif w_remaining == 0 
+                #log.debug("\tBREAK because w_remaining is 0 (top of #{day} loop) ")
+                break
+              elsif @scheds[i][day, time, et_id] != nil
+                #log.debug("\tNEXT because slot (#{day}, #{time}) is full")
+                next
+              elsif count[day, et_id] > 0
+                #log.debug("\tNEXT because this EC is already assigned to #{day}")
+                next
+              elsif not et.working?(day)
+                #log.debug("\tNEXT because et #{et_id} doesn't work on #{day}")
+                next
+              end
+
+              begin
+                @scheds[i][day, time, et_id] = ht_id
+              rescue InsanityError
+                #log.debug("\tNEXT because of insanity")
+                next
+              else
+                count[day, et_id] += 1
+                d_remaining = @cs[:max_ecs_per_day] - count.by_day(day) 
+                w_remaining = @cs[:ecs_per_week] - count.by_et_id(et_id) 
+                #log.debug("\tASSIGNED to (#{day},#{time}) with #{d_remaining} remaining today and #{w_remaining} for week")
+              end
+
+            end
+          end
+        end
+      end
+    end
+
+    def db
+      @scheds[0][:mon, 8, :Art] = 'TEST' 
+      @scheds[1][:wed, 12, :Music] = 'TEST' 
+    end
+  end
+end

data/lib/schedsolver2/teacher.rb

@@ -0,0 +1,49 @@
+module Schedsolver2
+  class Teacher
+    attr_accessor :name, :id, :work_days
+
+    @@ids ||= []
+    def Teacher::ids
+      @@ids
+    end
+
+    def Teacher::reset_ids
+      @@ids = []
+    end
+    
+    def initialize name, id=nil
+      @name = name.to_s
+      @work_days = [:mon, :tue, :wed, :thu, :fri]
+      unless id == nil then
+        raise ArgumentError, "Dupicate id" unless Teacher.uniq_id?(id)
+        @id = id
+      else
+        @id = Teacher.generate_id
+      end
+      @@ids << @id
+    end
+
+    def to_s
+      @name.to_s + "(#{self.id})"
+    end
+
+    def self.generate_id
+      id = 0
+      until Teacher.uniq_id?(id); id += 1; end
+      return id
+    end
+
+    def self.uniq_id? id
+      if @@ids.include?(id) 
+        return false 
+      else 
+        return true 
+      end
+    end
+
+    def working? day
+      @work_days.include? day 
+    end
+      
+  end
+end

data/schedsolver2.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schedsolver2/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "schedsolver2"
+  gem.version       = Schedsolver2::VERSION
+  gem.authors       = ["Julian Irwin"]
+  gem.email         = ["julian.irwin@gmail.com"]
+  gem.description   = %q{Create schedules for elementary schools}
+  gem.summary       = ""
+  gem.homepage      = ""
+
+  gem.add_dependency('pp')
+  gem.add_dependency('text-table')
+  gem.add_dependency('logger')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/schedsolver2.rb'}"
+puts "Loading schedsolver2 gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/ClassCounter_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Schedsolver2
+
+  describe ClassCounter do
+    include_context "main"  
+    
+    before(:each) do
+      @count = ClassCounter.new [0 ,1, 2]
+    end
+
+    describe "#by_et_id" do
+      it "counts all ets of a certain type" do
+        @count[:mon, 0] = 1
+        @count[:fri, 0] = 2
+        @count[:mon, 1] = 4
+        @count[:wed, 1] = 8 
+        @count.by_et_id(0).should == 3
+        @count.by_et_id(1).should == 12
+        @count.by_et_id(2).should == 0
+      end
+    end
+
+    describe "#by_day" do
+      it "counts all days of a certain type" do
+        @count[:mon, 0] = 1
+        @count[:fri, 0] = 2
+        @count[:mon, 1] = 4
+        @count[:wed, 1] = 8 
+        @count.by_day(:mon).should == 5
+        @count.by_day(:tue).should == 0
+        @count.by_day(:wed).should == 8
+      end
+    end
+  end
+  
+
+end

data/spec/constraint_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Schedsolver2
+
+  describe Constraint do
+    include_context "main"
+
+
+    describe "#hard_assert" do
+      it "takes a constraint and a schedule" do
+        @school.add :schedules, 1
+        @school.add :hard_constraint, @c_true
+        expect { 
+          Constraint.hard_assert @school.sched[0], @school.cs[:h][0]
+        }.to_not raise_error(ArgumentError)
+      end
+
+      it "throws an arg error upon getting bad input" do
+        expect { 
+          Constraint.hard_assert :not_schec, @c_true
+          }.to raise_error(ArgumentError)
+        @school.add :schedules, 1
+        expect { 
+          Constraint.hard_assert @school.scheds[0], :not_constraint
+        }.to raise_error(ArgumentError)
+      end
+
+      it "returns false for an impossible-to-meet constraint" do
+        @school.add :schedules, 1
+        Constraint.hard_assert(@school.scheds[0], @c_false).should == false
+      end        
+
+      it "returns true for an always-met constraint" do
+        @school.add :schedules, 1
+        Constraint.hard_assert(@school.scheds[0], @c_true).should == true
+      end        
+    end
+
+    describe "Constraint.make_slots_ary", :wip=>true do
+      it "returns nil for nil input" do
+        expect {
+          Constraint.make_slots_ary(nil)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "turns {:mon => {8 => [:Art]}} into [:mon, 8, :Art]" do
+        h = {:mon => {8 => [:Art]}}
+        a = [[:mon, 8, :Art]]
+        Constraint.make_slots_ary(h).should == a
+      end
+
+      it "works for a bigger hash too" do
+        h = {:mon => {8 => [:Art, :Music], 9 => [:Music]}, :wed => {13 => [:Art]}}
+        a = [[:mon, 8, :Art], [:mon, 8, :Music], [:mon, 9, :Music], [:wed, 13, :Art]]
+        Constraint.make_slots_ary(h).should == a
+      end
+    end
+
+    describe "Constraint.day_descriptor", :wip => true do
+      it "gives a slot_descriptor for a whole day" do
+        s_d = {:mon => {8  => [:One],
+                       9  => [:One],
+                       10 => [:One],
+                       11 => [:One],
+                       12 => [:One],
+                       13 => [:One],
+                       14 => [:One]}}
+        Constraint.day_descriptor(:mon, @school.times, [:One]).should == s_d
+      end
+    end
+
+    describe "Constraint.week_descriptor", :wip => true do
+      it "gives a slot_descriptor for a whole week" do
+        s_d = {:mon => {8 => [0]},
+               :tue => {8 => [0]},
+               :wed => {8 => [0]},
+               :thu => {8 => [0]},
+               :fri => {8 => [0]}}
+      Constraint.week_descriptor([8], [0]).should == s_d
+      end
+    end
+  end
+end

data/spec/schedsolver2_spec.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Schedsolver2" do
+end

data/spec/schedule_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Schedsolver2
+
+  describe Schedule do 
+    include_context "main"
+
+    describe "#[]=, #[]" do
+      before(:all) do
+        @et = @ts[:e][0]
+        @et2 = @ts[:e][1]
+        @ht = @ts[:h][0]
+        @ht2 = @ts[:h][1]
+        @school.add :schedules, 1
+        @sched_class = @school.scheds[0]
+      end
+
+      it "adds teachers to slots in the schedule" do
+        @sched_class[:mon, 8, @et.id] = @ht.id
+        @sched_class.sched[0][0][0].should == @ht.id
+
+        @sched_class[:wed, 12, @et.id] = @ht.id
+        @sched_class.sched[0][0][0].should == @ht.id
+      end
+
+      it "blows up when it is given bad arguments" do
+        expect{@sched_class[:not_a_day, 8, @et.id]}.to raise_error(ArgumentError)
+        expect{@sched_class[:mon, -1, @et.id]}.to raise_error(ArgumentError)
+        expect{@sched_class[:mon, 8, :Not_a_teacher]}.to raise_error(ArgumentError)
+
+        expect{@sched_class[:not_a_day, 8, @et.id]=nil}.to raise_error(ArgumentError)
+        expect{@sched_class[:mon, -1, @et.id]=nil}.to raise_error(ArgumentError)
+        expect{@sched_class[:mon, 8, :Not_a_teacher]=nil}.to raise_error(ArgumentError)
+      end
+
+      it "throws InsanityError if one HC gets simultaneous ECs" do
+        @sched_class[:mon, 8, @et.id] = @ht.id
+        expect{
+          @sched_class[:mon, 8, @et2.id] = @ht.id
+        }.to raise_error(InsanityError)
+      end
+
+      it "doesn't throw Insanity error if distinct HCs get simultaneous ECs" do
+        @sched_class[:mon, 8, @et.id] = @ht.id
+        expect{
+          @sched_class[:mon, 8, @et2.id] = @ht2.id
+        }.to_not raise_error(InsanityError)
+      end
+    end 
+  end
+
+end
+