rhs-schedule 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5f4b56aac9c5af3965c8a84dac2647175e3bdeb
-  data.tar.gz: cb30b9a7ad916b9b2c747f5631f4dc705dcd358a
+  metadata.gz: 45d9d22b1f06bf65d5f7f19cbb0f865696c07088
+  data.tar.gz: 83e50e970284e01b6812b0b35e0600fa0a0dcefa
 SHA512:
-  metadata.gz: 76999fe34edc375a0a64ab1b406a78c7e29a1c921e217e75e6ae224b4c81f78406f900392cf431b06d392337823ed406aa70c3918811d817ee1fb8f7f149db1f
-  data.tar.gz: 0362805402a3df7e53b294d395e55ca4152c0fbe515b0d7f23898f26f3ff1b6e39e5adf03cc57aea6aa9ceab224c323856c7a926f3a1f917595b2ef3b9342f02
+  metadata.gz: e4935fae5a8bb3fa729b7b5e49be49b18958aef622af9192a401ed0b055e10b44d6bcf5ceafde6e4eb97718a76b60a796cdfd96db41021c9b3132fc371337578
+  data.tar.gz: 26dc3d276c130f0a6b552ce4233389478a66d1324c1edeb09a630090071acb2b6b96fe7e150f770c71a04e90f01cc2f6e7d8389248f3b2f3133c318b797339c0

data/lib/rhs-schedule.rb

@@ -3,8 +3,10 @@ require 'json'
 
 require_relative 'rhs-schedule/scheduleday'
 require_relative 'rhs-schedule/period'
+require_relative 'rhs-schedule/exports'
+require_relative 'rhs-schedule/errors'
 
-VERSION = '0.2.0'.freeze
+VERSION = '0.3.0'.freeze
 
 # 05/25/16 08:50 AM
 DATE_FORMAT = '%m/%d/%y'.freeze
@@ -13,8 +15,14 @@ DATETIME_FORMAT = "#{DATE_FORMAT} #{TIME_FORMAT}".freeze
 EXCEPTIONS = ['0', '1', '2', '3', 'WEBEIM Scheduled', 'SIS Scheduled'].freeze
 
 class ScheduleSystem
+  include Exports
+
   attr_reader :schedule_days
 
+  # Creates a new ScheduleSystem by parsing the schedule text file passed to it. 
+  # If it cannot read the file the program aborts.
+  #
+  # @param path [String] the path to the text file (not the folder!) 
   def initialize(path)
     puts "Initializing Schedule System v#{VERSION}"
     abort "Cannot find schedule text file at '#{path}'. Please download it from http://intranet.regis.org/downloads/outlook_calendar_import/outlook_schedule_download.cfm." unless File.file? path
@@ -23,8 +31,13 @@ class ScheduleSystem
     @classdays = []
     @schedule_days = {}
     parse
+    super(self) # Initialize the exports with the parsed schedule
   end
 
+  # Gets the schedule day of the date passed.
+  #
+  # @param date [Date, DateTime] the date
+  # @return [String] the schedule day
   def get_sd date
     if date.is_a? DateTime
       @schedule_days[date]
@@ -34,102 +47,131 @@ class ScheduleSystem
     end
   end
 
+  # Displays formatted info on the current day, including it's schedule day and classes in order.
   def today
     #false_date = Date.strptime('05/20/16', DATE_FORMAT)
     @classdays.find { |cd| cd.schedule_day == @schedule_days[Date.parse(Time.now.to_s)]}
     #@classdays.find { |cd| cd.schedule_day == @schedule_days[false_date] }
   end
 
-  def parse
-    sds = [] # Schedule day lines
-    ps = [] # Period lines
-
-    File.open(@path, 'r') do |f|
-      f.each_line do |line|
-        next if line.include? 'Start Date' or line.strip.empty?
-
-        # Split the line and remove all the unnecessary values
-        values = line.split("\t")
-
-        # Determine schedule day or period
-        if line.include? ' Day'
-          # Use only date and schedule day
-          vital = [values[0], values[4]]
-          sds << vital
-        elsif values.length == 10
-          # Use only date, start time, end time, class name, and location
-          vital = [values[0], values[1], values[3], values[4], values[5]]
-          ps << vital
-        end
-      end
+  # Outputs a JSON object of all class days and their schedule days into the given file.
+  #
+  # @param path [String] the file path
+  def to_json(path)
+    puts 'Exporting schedule days to JSON'
+    File.open(path,'w') do |f|
+      f.write(JSON.pretty_generate(@schedule.schedule_days))
     end
+  end
 
-    puts "Found #{ps.length} periods for #{sds.length} class days"
+  private
+    def check_valid_schedule lines
+      # Check for headers
+      first_line = lines.first.strip
+      raise InvalidScheduleError, 'Correct headers are missing.' if first_line != 'Start Date	Start Time	End Date	End Time	Subject	Location	All day event	Reminder on/off	Show time as	Categories' 
 
-    sds.each { |values| handle_schedule_day_line values }
-    handled = [] # Holds what schedules have been made
-    @schedule_days.each do |date, sd|
-      next if handled.include? sd
+      # Check length of file
+      raise InvalidScheduleError, 'File has less than 200 lines.' if lines.length < 200
+
+      # Check if there are period lines and schedule day lines
+      expected = lines.length * 10 # Expected data over all split by tabs
+      actual = 0
+      lines.each { |l| actual += l.split("\t").length }
+      raise InvalidScheduleError, 'Not all lines are valid.' unless expected == actual
+      #raise InvalidScheduleError, 'Missing schedule day lines' unless lines
 
-      lines = ps.find_all { |values| values[0] == date.strftime(DATE_FORMAT) }
-      next if lines.empty?
-      create_class_day sd, lines
-      handled << sd
     end
-  end
 
-  def handle_schedule_day_line values
-    date = Date.strptime(values[0], DATE_FORMAT)
-    sd = values[1][0] # A Day -> A
-    @schedule_days[date] = sd
-  end
+    # Reads the schedule text file and parses each line to decide periods and schedule days.
+    def parse
+      sds = [] # Schedule day lines
+      ps = [] # Period lines
+
+      File.open(@path, 'r') do |f|
+        lines = f.read.split("\r")
+
+        check_valid_schedule lines
+        
+        lines.each do |line|
+          next if line.include? 'Start Date' or line.strip.empty?
+
+          # Split the line and remove all the unnecessary values
+          values = line.split("\t")
+
+          # Determine schedule day or period
+          if line.include? ' Day'
+            # Use only date and schedule day
+            vital = [values[0], values[4]]
+            sds << vital
+          elsif values.length == 10
+            # Use only date, start time, end time, class name, and location
+            vital = [values[0], values[1], values[3], values[4], values[5]]
+            ps << vital
+          end
+        end
+      end
 
-  def create_class_day sd, lines
-    periods = []
-    lines.each do |values|
-      # [date, start time, end time, class name, location]
-      course_title = values[3]
-      start_time = DateTime.strptime(values[1], TIME_FORMAT)
-      end_time = DateTime.strptime(values[2], TIME_FORMAT)
-      location = values[4]
+      puts "Found #{ps.length} periods for #{sds.length} class days"
 
-      periods << Period.new(course_title, start_time, end_time, location)
-    end
+      sds.each { |values| handle_schedule_day_line values }
+      handled = [] # Holds what schedules have been made
+      @schedule_days.each do |date, sd|
+        next if handled.include? sd
 
-    day = ScheduleDay.new(sd, periods)
-    fill_periods day
-    @classdays << day
-  end
+        lines = ps.find_all { |values| values[0] == date.strftime(DATE_FORMAT) }
+        next if lines.empty?
+        create_class_day sd, lines
+        handled << sd
+      end
+    end
 
-  # Take a just created periods list and fill in the holes (lunch and frees)
-  def fill_periods(day)
-    old = day.periods
+    def handle_schedule_day_line values
+      date = Date.strptime(values[0], DATE_FORMAT)
+      sd = values[1][0] # A Day -> A
+      @schedule_days[date] = sd
+    end
 
-    # AM Advisement isn't in schedule text file
-    filled = [Period.new('Morning Advisement', DateTime.strptime('8:40 AM', TIME_FORMAT), DateTime.strptime('8:50 AM', TIME_FORMAT), 'Advisement')]
+    def create_class_day sd, lines
+      periods = []
+      lines.each do |values|
+        # [date, start time, end time, class name, location]
+        course_title = values[3]
+        start_time = DateTime.strptime(values[1], TIME_FORMAT)
+        end_time = DateTime.strptime(values[2], TIME_FORMAT)
+        location = values[4]
 
-    last_end = filled.first.end_time # Don't use old.first since the day could start with a free period
-    old.each do |p|
-      filled << Period.new('Unstructured Time', last_end, p.start_time, 'Anywhere') if p.start_time != last_end # I <3 Ruby
+        periods << Period.new(course_title, start_time, end_time, location)
+      end
 
-      filled << p
-      last_end = p.end_time
+      day = ScheduleDay.new(sd, periods)
+      fill_periods day
+      @classdays << day
     end
 
-    if filled.last.end_time.strftime('%I:%M %p') != '02:50 PM'
-      end_time = DateTime.strptime('2:50 PM', TIME_FORMAT)
-      filled << Period.new('Unstructured Time', filled.last.end_time, end_time, 'Anywhere')
-    end
+    # Take a just created periods list and fill in the holes (lunch and frees)
+    def fill_periods(day)
+      old = day.periods
 
-    # PM Advisement isn't in schedule text file
-    filled << Period.new('Afternoon Advisement', DateTime.strptime('2:50 PM', TIME_FORMAT), DateTime.strptime('3:00 PM', TIME_FORMAT), 'Advisement')
-    day.periods = filled
-  end
+      # AM Advisement isn't in schedule text file
+      filled = [Period.new('Morning Advisement', DateTime.strptime('8:40 AM', TIME_FORMAT), DateTime.strptime('8:50 AM', TIME_FORMAT), 'Advisement')]
 
-  def to_json(path)
-    puts 'Exporting schedule days to JSON'
-    File.open(path,'w') do |f|
-      f.write(JSON.pretty_generate(@schedule.schedule_days))
+      last_end = filled.first.end_time # Don't use old.first since the day could start with a free period
+      old.each do |p|
+        filled << Period.new('Unstructured Time', last_end, p.start_time, 'Anywhere') if p.start_time != last_end # I <3 Ruby
+
+        filled << p
+        last_end = p.end_time
+      end
+
+      if filled.last.end_time.strftime('%I:%M %p') != '02:50 PM'
+        end_time = DateTime.strptime('2:50 PM', TIME_FORMAT)
+        filled << Period.new('Unstructured Time', filled.last.end_time, end_time, 'Anywhere')
+      end
+
+      # PM Advisement isn't in schedule text file
+      filled << Period.new('Afternoon Advisement', DateTime.strptime('2:50 PM', TIME_FORMAT), DateTime.strptime('3:00 PM', TIME_FORMAT), 'Advisement')
+      day.periods = filled
     end
-  end
+
+    
 end

data/lib/rhs-schedule/period.rb

@@ -13,6 +13,8 @@ class Period
     "#{@course_title} in #{@location} for #{duration} minutes"
   end
 
+  # Returns the duration of the period in minutes
+  # @return [Integer] duration in minutes
   def duration
     ((@end_time - @start_time) * 24 * 60).to_i
   end

data/lib/rhs-schedule/scheduleday.rb

@@ -9,14 +9,6 @@ class ScheduleDay
     @periods = periods
   end
 
-  def add_period(period)
-    @periods << period
-  end
-
-  def sort_periods
-    @periods.sort! { |a, b| a.start_time <=> b.start_time }
-  end
-
   def to_s
     to_return = ["#{@schedule_day}-Day: #{@periods.length} periods"]
     @periods.each do |p|
@@ -26,4 +18,13 @@ class ScheduleDay
 
     to_return.join("\n")
   end
+
+  private
+    def add_period(period)
+      @periods << period
+    end
+
+    def sort_periods
+      @periods.sort! { |a, b| a.start_time <=> b.start_time }
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhs-schedule
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Frank Matranga