schedsolver2 0.0.1

data/.gitignore

@@ -0,0 +1,23 @@
+!.gitignore
+.*
+*.log
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+test_script.rb
+test_logger.rb
+
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schedsolver2.gemspec
+gemspec

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Julian Irwin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Schedsolver2
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'schedsolver2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schedsolver2
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/features/schedsolver_T1_initializes.feature

@@ -0,0 +1,11 @@
+#This is a trivial feature, existed to get me warmed up
+@completed
+Feature: T1 - Programmer Inits Schedsolver 
+  I want to open schedsolver
+  So that I can generate a schedule
+  @completed
+  Scenario: Initialize a School Instance
+    Given I haven't yet initialized schedsolver
+		When  I have Teachers, SchoolInfo and Constraints
+    And I initialize a School instance
+		Then The instance should have the inputs and empty population

data/features/schedsolver_T2_seed.feature

@@ -0,0 +1,16 @@
+@not_implemented
+Feature: T2 - Seed
+	As a user of algorithm api
+	I want to create an initial population by calling Schedsolver#seed_population
+	So that the genetic algorithm has something to run on 
+	Scenario: Generate Empty Seeds
+    Given I have an initialized School
+		When I add some schedules
+		Then the schools schedules list should get some empty schedules
+	Scenario: Fill Seeds
+    Given I have an initialized School
+    And it has some empty schedules
+		When I call School#fill_seeds
+		Then The population should be filled with seed schedules
+
+

data/features/schedsolver_T3_constraint_checker.feature

@@ -0,0 +1,29 @@
+@not-implemented
+Feature: T3 - Constraint Checker
+  I am an Algorithm *bleep bloop bleep*
+  I want to check if the schedule I just generated conforms to constraints
+  So that my creator will be satisfied *bloop*
+  Scenario: HC - Part Time Hours
+    Given I have an initialized School
+    And It has "2" schedule
+    And a part time art teacher constraint (M and 8-11 Tu)
+    When homeroom teacher gets scheduled for art on Tuesday in the first schedule
+    And homeroom teacher isn't scheduled for art on Tuesday or Monday in the second schedule
+    Then the constraint asserter will fail for the first schedule
+    And the constraint asserter will pass for the second schedule
+  Scenario: HC - Exact EC’s Per Week
+    Given I have an initialized School
+    And It has "3" schedules
+    And each homeroom must have "4" EC's per week  
+    When the first schedule has 3 EC's, the second has 4 and the last has 5
+    Then only the middle schedule will pass the constraint asserter
+  Scenario: HC - Max EC’s Per Day
+    Given I have an initialized School 
+    And It has "2" schedules
+    And a homeroom (:One) can have a max of two EC's per day
+    When one schedule has 3 EC's on monday and the other has 2
+    Then the first will fail and the second will succeed
+  Scenario: Multiple Constraints applied to one schedule 
+    Given I have an initialized School
+    And It has "2" schedules
+  Scenario: SC - Spacing Requirements

data/features/schedsolver_T3v2_constraints.feature

@@ -0,0 +1,8 @@
+Feature: Constraints
+  @wip
+  @heuristic
+  Scenario: Adding a part time hours constraint
+    Given I have an initialized School
+    And there is a teacher who only works on MWF
+    When the schedule is generated
+    Then the teacher will not be schedules on those days

data/features/schedsolver_T4_print_attributes.feature

@@ -0,0 +1,19 @@
+Feature: T4. Print School Attributes
+  I am a software developer
+  I want to print out schedules as an ASCII table
+  So that I can get feedback while developing/tweaking the Scheduling Algorithm
+  @completed
+  Scenario: Print schedules
+    Given I have an initialized School
+    When I call #print "schedules"
+    Then All of the schedules in population will be printed to my screen
+  @completed
+  Scenario: Print constraints
+    Given I have an initialized School
+    When I call #print "constraints"
+    Then the constraints will be displayed in a readable fashion
+  @completed
+  Scenario: Print school info
+    Given I have an initialized School
+    When I call #print "school_info"
+    Then the info will be displayed in a readable fashion

data/features/schedsolver_T5_crud_attributes.feature

@@ -0,0 +1,26 @@
+@not_implemented
+Feature: T5. CRUD School Attributes
+  I am a User
+  I want to change an attribute of my School
+  So that I can easily keep my schedule parameters up to date.
+#  Scenario: Add Teacher Given I have an initialized School
+#    Given I have an initialized School
+#    When I call Add Mrs. Two to ETs
+#    Then the teacher will be in School.teachers[:enrichment]
+#  Scenario: Delete Teacher 
+#    Given I have an initialized School
+#    When I call Delete Mr. Four
+#    Then the teacher will not be in School.teachers[:homeroom]
+#  Scenario: Add Constraint - ET Hours
+#    Given I have an initialized School
+#    And a Teacher, Mr. MWTh, in that school that can only work M, W, Th
+#    When I add a HC dictating Mr. MWTh’s hours
+#    Then MR. MWTh will only be scheduled on M, W, Th
+#  Scenario: Delete Constraint 
+#    Given I have an initialized School
+#    When I call Delete Constraint about Mr. MWTh
+#    Then the constraint will not show up when constraints are searched
+  Scenario: Add teacher
+    Given I have an initialized School
+    When I call "add" "e_teacher" "MrsTwo"
+    Then the "teachers" "e_teacher" list "should" contain "MrsTwo"

data/features/schedsolver_T6_generate_schedules.feature

@@ -0,0 +1,14 @@
+@not_implemented
+Feature: T6. Run Schedule Generator
+  I am a User
+  I want to generate a schedule for my elementary school
+  So that I don’t have to do it by hand!
+  @big_example
+  Scenario: Small example generation of schedule 
+    Given I have a school with ET 0 and HT 1
+    And ET 0 works only Tuesday, Thursday
+    And HT 1 must have 4 ECs/wk, 2/dy
+    When I generate a schedule
+    Then HT will have two ECs on both Tuesday and Thursday
+    
+

data/features/schedsolver_T7_log_output.feature

@@ -0,0 +1,9 @@
+@not_implemented
+Feature: T7. Developer Logs Output
+I am a Developer
+I want to debug and monitor Schedsolver
+So that I can fix bugs and make faster more organized progress
+Scenario: Automatic Log Outpus
+  Given I have an initialized School
+  When I run the algorithm
+  Then I should get informative log output (FIXME more details)

data/features/schedsolver_T8_big_example.feature

@@ -0,0 +1,10 @@
+Feature:
+  I am the rails app
+  I want to find a valid schedule
+  So that I can satisfy the users request
+  @big_example
+  Scenario:
+  Given I have a big example school with several constraints
+  When two schedules, first valid, second invalid are added
+  Then the first will fail and the second will succeed
+

data/features/schedsolver_heuristic.feature

@@ -0,0 +1,10 @@
+Feature: Heuristic approach
+  @completed
+  Scenario:
+    Given I have an initialized School
+    And the school's 0th ET works MWF
+    And each HT must have 3 ECs/wk
+    And each HT may have at most 2 ECs/dy
+    When the schedule is generated
+    Then there wil be one EC on each of MWF for ET 0
+    And there will be three total ET 1 entries

data/features/step_definitions/T1_steps.rb

@@ -0,0 +1,19 @@
+Given /^I haven't yet initialized schedsolver$/ do 
+end
+
+When /^I have Teachers, SchoolInfo and Constraints$/ do
+  @si.should_not == nil
+  @cs.should_not == nil
+  @ts.should_not == nil
+end
+
+When /^I initialize a School instance$/ do
+  @school = Schedsolver2::School.new @si, @ts, @cs
+end
+
+Then /^The instance should have the inputs and empty population$/ do
+  @school.scheds.should == []
+  @school.consts.should_not == nil
+end
+ 
+

data/features/step_definitions/T3_steps.rb

@@ -0,0 +1,97 @@
+#################Part Time Hours###################
+
+Given /^a part time art teacher constraint \(M and 8-11 Tu\)$/ do
+  # All day monday and tuesday
+  not_working_days = {}
+  [:mon, :tue].each do |day|
+    not_working_days[day] ||= {}
+    (8...14).each do |time|
+      not_working_days[day][time] = [0]
+    end
+  end
+  # Pass as long as :Art isn't scheduled on mon or tue.
+  test = Proc.new do |slot, value|
+    if value == nil then false else true end
+  end   
+  #  
+  counter = Proc.new do |count|
+    if count > 0 then false else true end
+  end
+
+  hc = Schedsolver2::Constraint.new([not_working_days], test, counter)
+
+  @school.add :hard_constraint, hc 
+end
+
+When /^homeroom teacher gets scheduled for art on Tuesday in the first schedule$/ do 
+  @school.scheds[0][:tue, 8, 0] = 2
+end
+
+When /^homeroom teacher isn't scheduled for art on Tuesday or Monday in the second schedule$/ do 
+  @school.scheds[1][:wed, 8, 0] = 2
+end
+
+Then /^the constraint asserter will fail for the first schedule$/ do 
+  Schedsolver2::Constraint.hard_assert(@school.scheds[0], @school.cs[:h][0]).should == false
+end
+
+Then /^the constraint asserter will pass for the second schedule$/ do 
+  Schedsolver2::Constraint.hard_assert(@school.scheds[1], @school.cs[:h][0]).should == true
+end
+
+################# Exact EC's Per Week ###############
+
+Given /^each homeroom must have "(.*?)" EC's per week$/ do |arg1|      
+  s_d = @all_days_slot_descriptor
+  test = Proc.new { |slot, value| if value == nil then false else true end}
+  assess = Proc.new { |count| if count == 4 then true else false end}
+  c = Schedsolver2::Constraint.new [s_d], test, assess
+  @school.add :hard_constraint, c
+end
+
+When /^the first schedule has (\d+) EC's, the second has (\d+) and the last has (\d+)$/ do |arg1, arg2, arg3|
+  start = @si[:start_time]
+  [arg1, arg2, arg3].each_with_index do |arg, n_sch|
+    (0..arg.to_i-1).each do |n| 
+      @school.scheds[n_sch][:mon, start + n, 0] = 2
+    end 
+  end
+  @school.print :schedules
+end
+
+Then /^only the middle schedule will pass the constraint asserter$/ do 
+  Schedsolver2::Constraint.hard_assert(@school.scheds[0], @school.cs[:h][0]).should == false
+  Schedsolver2::Constraint.hard_assert(@school.scheds[1], @school.cs[:h][0]).should == true
+  Schedsolver2::Constraint.hard_assert(@school.scheds[2], @school.cs[:h][0]).should == false
+end
+
+################# Exact EC's Per Week ###############
+
+Given /^a homeroom \(:One\) can have a max of two EC's per day$/ do 
+  s_ds = []
+  @school.days.each do |day|
+    s_ds << Schedsolver2::Constraint.day_descriptor(day, @school.times, @school.et_ids)
+  end
+  test = Proc.new {|slot, value| if value == 2 then true else false end }
+  assess = Proc.new {|count| if count <= 2 then true else false end}
+  c = Schedsolver2::Constraint.new s_ds, test, assess
+  @school.add :hard_constraint, c
+end
+
+When /^one schedule has (\d+) EC's on monday and the other has (\d+)$/ do |a1, a2|
+  @school.scheds[0][:mon, 8, 0]    = 2
+  @school.scheds[0][:mon, 9, 0]    = 2
+  @school.scheds[0][:mon, 14, 1] = 2
+  @school.scheds[1][:mon, 8, 0]    = 2
+  @school.scheds[1][:mon, 14, 1] = 2
+end
+
+Then /^the first will fail and the second will succeed$/ do 
+  Schedsolver2.log.info("et_ids: #{@school.et_ids}")
+  Schedsolver2::Constraint.hard_assert(@school.scheds[0], @school.cs[:h][0]).should == false
+  Schedsolver2::Constraint.hard_assert(@school.scheds[1], @school.cs[:h][0]).should == true
+end
+
+################# Sanity Checks #######################
+
+

data/features/step_definitions/T3v2_steps.rb

@@ -0,0 +1,14 @@
+Given /^there is a teacher who only works on MWF$/ do   
+  @school.ts[:e][0].work_days = [:mon, :wed, :fri]
+  @school.parse_part_time_constraints
+end
+
+Then /^the teacher will not be schedules on those days$/ do  
+  id = @school.ts[:e][0].id 
+  @school.print :constraints
+  Schedsolver2::Constraint.hard_assert(
+    @school.scheds[0], 
+    @school.cs[:part_time][id]
+  ).should == true
+end
+

data/features/step_definitions/T4_steps.rb

@@ -0,0 +1,19 @@
+# Print Schedules
+#
+When /^I call \#print "(.*?)"$/ do |arg1|
+  @school.print arg1
+end
+
+Then /^All of the schedules in population will be printed to my screen$/ do
+  output = double()
+  @school.log = output
+  output.should_receive(:info)
+  @school.add :schedules, 1
+  @school.print :schedules
+end
+
+Then /^the info will be displayed in a readable fashion$/ do
+end
+
+Then /^the constraints will be displayed in a readable fashion$/ do
+end

data/features/step_definitions/T6_steps.rb

@@ -0,0 +1,62 @@
+Given /^I have a school with ET (\d+) and HT (\d+)$/ do |arg1, arg2|
+  @si = {:start_time => 8,
+         :end_time   => 15,
+         :num_blocks => 14,
+         :block_size => 0.5}
+  @ts = {:e => [Schedsolver2::Teacher.new(:Art, 0)],
+         :h => [Schedsolver2::Teacher.new(:One, 1)]}
+  @cs = {:h => [], :s => []} 
+  @school = Schedsolver2::School.new @si, @ts, @cs
+  @school.add :schedules, 1
+  @school.log.level = Logger::INFO
+end
+
+Given /^ET (\d+) works only Tuesday, Thursday$/ do |arg1| 
+  s_ds = [:mon, :wed, :fri].inject([]) do |ds, day|
+    ds << Schedsolver2::Constraint.day_descriptor(day, @school.times, [0])
+  end
+  @school.log.debug("s_ds: #{s_ds}")
+  test = Proc.new {|slot, value| if value != nil then true else false end}
+  assess = Proc.new {|count| if count > 0 then false else true end}
+  hc0 = Schedsolver2::Constraint.new s_ds, test, assess
+  @school.add :hard_constraint, hc0
+end
+
+Given /^HT (\d+) must have (\d+) ECs\/wk, (\d+)\/dy$/ do |arg1, arg2, arg3| 
+  s_ds0 = [Schedsolver2::Constraint.week_descriptor(@school.times, [0])]
+  s_ds1 = [:mon, :tue, :wed, :thu, :fri].inject([]) do |ds, day|
+    ds << Schedsolver2::Constraint.day_descriptor(day, @school.times, [0])
+  end
+
+  @school.log.debug "s_ds0: #{s_ds0}"
+  @school.log.debug "s_ds1: #{s_ds1}"
+
+  test = Proc.new {|slot, value| if value == 1 then true else false end}
+
+  assess0 = Proc.new {|count| if count == 4 then true else false end}
+  assess1 = Proc.new {|count| if count <= 2 then true else false end}
+
+  hc0 = Schedsolver2::Constraint.new s_ds0, test, assess0
+  hc1 = Schedsolver2::Constraint.new s_ds1, test, assess1
+
+  @school.add :hard_constraint, hc0
+  @school.add :hard_constraint, hc1
+end
+
+When /^I generate a schedule$/ do
+  @school.make_schedule(0)
+end
+
+Then /^HT will have two ECs on both Tuesday and Thursday$/ do 
+  Schedsolver2::Constraint.hard_assert(@school.scheds[0], @school.cs[:h][0]).should == true
+  Schedsolver2::Constraint.hard_assert(@school.scheds[0], @school.cs[:h][2]).should == true
+  Schedsolver2::Constraint.hard_assert(@school.scheds[0], @school.cs[:h][1]).should == true
+end
+  
+   
+
+
+
+
+
+