rhs-schedule 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a959475b900db7b022ed04b8adc7c09d874447e1
-  data.tar.gz: a0c4ed47196e541f1762972e85e37947503b36ea
+  metadata.gz: 172e5a7deee9a6fbcc7a87c64a5af9d14b2fa4f0
+  data.tar.gz: 0f33998edeed880f68b33d48d91f04f4bd38dc5d
 SHA512:
-  metadata.gz: 07ce4d16728bed927fd79e0987bd2c71ea85bb62e8e37cf5f54494a39c6372447ad80685f6a6e64e5e1deb6bf4324871b0fedffdccf3b2dbe0154b888832d17b
-  data.tar.gz: 8e0ee15009598ccca9ec472a28f5875154d9d1ef758281d3f3e486c8478de62cfb1d823cec03749a64ed9f0cce2d0f6d51e8c1c6a9caf88d88373275f0f823d6
+  metadata.gz: 0a0d21f8253a8608904f8fa215296d16360673e45cb7608cd6ad98b4b7c4e517e47a362f6fbf0e605a8f5bbc05c664b22c5f7f24bb95f4c135c4a5c4b0bb6b77
+  data.tar.gz: 55de0b13178b3b7df12acf93b038af95cb4f3ae8269317c2d36a6be9b07c62830da9e5337f5098650b6246a27933c758e6b6a67add0137e3cc619066910de9ba

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Frank Matranga
+
+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,15 @@
+# rhs-schedule
+A RubyGem that can parse the Regis Intranet schedule download so that it can be used in programs (such as displaying it correctly).
+
+## How to Use
+```ruby
+require 'rhs-schedule'
+
+# Initialize the schedule system by passing a path to the schedule text download from the Intranet
+# (found at http://intranet.regis.org/downloads/outlook_calendar_import/outlook_schedule_download.cfm)
+schedule = ScheduleSystem.new 'path/to/schedule.txt'
+
+# Check out the wiki to see how to use it!
+puts schedule.today
+```
+**Documentation is available at [http://www.rubydoc.info/github/Apexal/rhs-schedule/master/](http://www.rubydoc.info/github/Apexal/rhs-schedule/master/)**

data/lib/rhs-schedule.rb

@@ -6,22 +6,33 @@ require_relative 'rhs-schedule/period'
 require_relative 'rhs-schedule/exports'
 require_relative 'rhs-schedule/errors'
 
-VERSION = '0.6.0'.freeze
+VERSION = '0.7.0'.freeze
 
-# 05/25/16 08:50 AM
+# e.g. 05/25/16
 DATE_FORMAT = '%m/%d/%y'.freeze
+
+# e.g. '08:50 AM' 
 TIME_FORMAT = '%I:%M %p'.freeze
+
+# e.g. '05/25/16 08:50 AM'
 DATETIME_FORMAT = "#{DATE_FORMAT} #{TIME_FORMAT}".freeze
+
+# The list of values found in a valid schedule download that should be ignored
 EXCEPTIONS = ['0', '1', '2', '3', 'WEBEIM Scheduled', 'SIS Scheduled'].freeze
 
 class ScheduleSystem
   include Exports
 
+  # Returns an hash mapping all school days' dates to their schedule day letter
+  # @return [Hash] the date to string hash
   attr_reader :schedule_days
+
+  # Return a hash mapping schedule day letters to their corresponding ScheduleDay objects
+  # @return [Hash] the string to ScheduleDay hash
   attr_reader :class_days
 
   # Creates a new ScheduleSystem by parsing the schedule text file passed to it. 
-  # If it cannot read the file the program aborts.
+  # If it cannot read the file or it detects that the format of the file is invalid the program aborts.
   #
   # @param path [String] the path to the text file (not the folder!) 
   def initialize(path)
@@ -81,7 +92,6 @@ class ScheduleSystem
       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
-
     end
 
     # Reads the schedule text file and parses each line to decide periods and schedule days.
@@ -120,7 +130,7 @@ class ScheduleSystem
       handled = [] # Holds what schedules have been made
       @schedule_days.each do |date, sd|
         next if handled.include? sd
-        lines = ps.find_all { |values| values[0].gsub(/\n/, "") == date.strftime(DATE_FORMAT) }
+        lines = ps.find_all { |values| values[0] == date.strftime(DATE_FORMAT) }
 
         next if lines.empty?
         create_class_day sd, lines

data/lib/rhs-schedule/exports.rb

@@ -1,10 +1,9 @@
 module Exports
     def initialize(schedule)
         @schedule = schedule
-        puts 'Loaded exports'
     end
 
-    # Outputs the current schedule in JSON format to the path specified.
+    # Outputs the current schedule in JSON format to the path specified. (NOT YET IMPLEMENTED)
     def to_json(path, include_advisements=false, include_frees=false)
         puts "Not yet implemented."
     end

data/lib/rhs-schedule/period.rb

@@ -1,7 +1,21 @@
 class Period
+  # The time (only) of day that the period starts at.
+  # ex. '10:30 AM' or '02:40 PM'
+  # @return [String] the time
   attr_reader :start_time
+
+  # The time (only) of day that the period ends at.
+  # ex. '10:30 AM' or '02:40 PM'
+  # @return [String] the time
   attr_reader :end_time
+
+  # The title of the course or event of the period.
+  # @return [String] the title
   attr_reader :course_title
+
+  # The location of the period without any preceding text.
+  # e.g. '312' not 'Room 312'
+  # @return [String] the location
   attr_reader :location
 
   def initialize(course, start_time, end_time, location)
@@ -16,7 +30,7 @@ class Period
     "#{@course_title} in #{@location} for #{duration} minutes (#{start_time} to #{end_time})"
   end
 
-  # Returns the duration of the period in minutes
+  # Returns the duration of the period in minutes of the period
   # @return [Integer] duration in minutes
   def duration
     ((@end_time - @start_time) * 24 * 60).to_i

data/lib/rhs-schedule/scheduleday.rb

@@ -1,4 +1,6 @@
 class ScheduleDay
+  # Returns the letter of the schedule day for the ScheduleDay object.
+  # @return [String] the letter
   attr_reader :schedule_day
 
   attr_writer :periods
@@ -13,7 +15,7 @@ class ScheduleDay
   def to_s
     to_return = ["#{@schedule_day}-Day: #{@periods.length} periods"]
     @periods.each do |p|
-      to_return << " -#{p.to_s}"
+      to_return << " -#{p.to_s}\n"
     end
     to_return << "\n"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhs-schedule
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Frank Matranga
@@ -16,6 +16,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/rhs-schedule.rb
 - lib/rhs-schedule/errors.rb
 - lib/rhs-schedule/exports.rb