rhs-schedule 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d78ca9524a73504524f2f92521fa48d1e90db7f9
-  data.tar.gz: 373349b5453a766fedff74cf46cfd97390c26231
+  metadata.gz: a959475b900db7b022ed04b8adc7c09d874447e1
+  data.tar.gz: a0c4ed47196e541f1762972e85e37947503b36ea
 SHA512:
-  metadata.gz: 5a0dcb14e0d91cff691032cc93b62600b26ced05271d9669db658a570949694fd6f1478c6349940bf9a195850adf6e8f1c1fdfd0bd2955ad22999ede2e8e511c
-  data.tar.gz: c927c5441c7e426bf98061aed9f9f276efc7a94b7ce7c8d747f498560e414e25d07cff162162237a983e1fa66239f8955d821515764fec7398ff5b4d5c297fae
+  metadata.gz: 07ce4d16728bed927fd79e0987bd2c71ea85bb62e8e37cf5f54494a39c6372447ad80685f6a6e64e5e1deb6bf4324871b0fedffdccf3b2dbe0154b888832d17b
+  data.tar.gz: 8e0ee15009598ccca9ec472a28f5875154d9d1ef758281d3f3e486c8478de62cfb1d823cec03749a64ed9f0cce2d0f6d51e8c1c6a9caf88d88373275f0f823d6

data/lib/rhs-schedule.rb

@@ -6,7 +6,7 @@ require_relative 'rhs-schedule/period'
 require_relative 'rhs-schedule/exports'
 require_relative 'rhs-schedule/errors'
 
-VERSION = '0.5.0'.freeze
+VERSION = '0.6.0'.freeze
 
 # 05/25/16 08:50 AM
 DATE_FORMAT = '%m/%d/%y'.freeze
@@ -49,6 +49,8 @@ class ScheduleSystem
   end
 
   # Displays formatted info on the current day, including it's schedule day and classes in order.
+  #
+  # @return [ScheduleDay] The ScheduleDay object.
   def today
     #false_date = Date.strptime('05/20/16', DATE_FORMAT)
     @class_days[@schedule_days[Date.parse(Time.now.to_s)]]

data/lib/rhs-schedule/errors.rb

@@ -0,0 +1,5 @@
+class InvalidScheduleError < StandardError
+    def initialize(msg='Invalid schedule text file!')
+        super
+    end
+end

data/lib/rhs-schedule/exports.rb

@@ -0,0 +1,99 @@
+module Exports
+    def initialize(schedule)
+        @schedule = schedule
+        puts 'Loaded exports'
+    end
+
+    # Outputs the current schedule in JSON format to the path specified.
+    def to_json(path, include_advisements=false, include_frees=false)
+        puts "Not yet implemented."
+    end
+
+    # Exports the current schedule in CSV format (according to Google Calendar) to the path specified.
+    # https://support.google.com/calendar/answer/37118?hl=en
+    #
+    # @param path [String] the path to export to (not directory!)
+    # @param include_advisements [Boolean] whether or not to include AM/PM advisements in the export
+    # @param include_frees [Boolean] whether or not to include free periods in the export
+    def to_csv(path, include_advisements=false, include_frees=false)
+        # https://support.google.com/calendar/answer/37118?hl=en
+        # The format of the file is as follows:
+        # Headers
+        # 1 line per period in the school year
+        # 1 line per schedule day in the school year
+
+        headers = ['Subject', 'Start Date', 'Start Time', 'End Date', 'End Time', 'Location', 'All Day Event']
+        
+        csv_file = File.open(path, 'w')
+        csv_file.puts(headers.join(","))
+
+        # 1 line per period in year
+        @schedule.schedule_days.each do |date, sd|
+            date_str = date.strftime(DATE_FORMAT)
+            periods = @schedule.class_days[sd].periods
+            periods = periods.select { |p| p.course_title != 'Unstructured Time' } unless include_frees
+            periods = periods.select { |p| p.course_title != 'Morning Advisement' and p.course_title != 'Afternoon Advisement' } unless include_advisements
+
+            periods.each do |p|
+                values = [p.course_title, date_str, p.start_time.strftime(TIME_FORMAT), date_str, p.end_time.strftime(TIME_FORMAT), p.location, 'False']
+                csv_file.puts(values.join(","))
+            end
+        end
+
+        @schedule.schedule_days.each do |date, sd|
+            # 05/26/17		05/26/17		A Day		1	0	3	SIS Scheduled
+            date_str = date.strftime(DATE_FORMAT)
+            values = ["#{sd} Day", date_str, '', date_str, '', '', 'True']
+            csv_file.puts(values.join(","))
+        end
+
+        csv_file.close
+
+        puts "CSV schedule file exported to '#{path}'"
+    end
+
+    # Exports the current schedule in CSV format (according to MS Outlook) to the path specified.
+    # The format is the exact same as the initally downloaded schedule file.
+    #
+    # @param path [String] the path to export to (not directory!)
+    # @param include_advisements [Boolean] whether or not to include AM/PM advisements in the export
+    # @param include_frees [Boolean] whether or not to include free periods in the export
+    def to_tsv(path, include_advisements=false, include_frees=false)
+        # The format of the file is as follows:
+        # Headers
+        # 1 line per period in the school year
+        # 1 line per schedule day in the school year
+
+        headers = ['Start Date', 'Start Time', 'End Date', 'End Time', 'Subject', 'Location', 'All day event', 'Reminder on/off', 'Show time as', 'Categories']
+        
+        tsv_file = File.open(path, 'w')
+        tsv_file.puts(headers.join("\t"))
+
+        # 1 line per period in year
+        @schedule.schedule_days.each do |date, sd|
+            date_str = date.strftime(DATE_FORMAT)
+            periods = @schedule.class_days[sd].periods
+            periods = periods.select { |p| p.course_title != 'Unstructured Time' } unless include_frees
+            periods = periods.select { |p| p.course_title != 'Morning Advisement' and p.course_title != 'Afternoon Advisement' } unless include_advisements
+
+            periods.each do |p|
+                # Example line format:
+                # 09/12/16	09:50 AM	09/12/16	10:50 AM	Fine Arts 11 Art Practicum (1A) Prezioso	416	0	0	2	SIS Scheduled
+                
+                values = [date_str, p.start_time.strftime(TIME_FORMAT), date_str, p.end_time.strftime(TIME_FORMAT), p.course_title, p.location, 0, 0, 2, 'SIS Scheduled']
+                tsv_file.puts(values.join("\t"))
+            end
+        end
+
+        @schedule.schedule_days.each do |date, sd|
+            # 05/26/17		05/26/17		A Day		1	0	3	SIS Scheduled
+            date_str = date.strftime(DATE_FORMAT)
+            values = [date_str, '', date_str, '', "#{sd} Day", '', 1, 0, 3, 'SIS Scheduled']
+            tsv_file.puts(values.join("\t"))
+        end
+
+        tsv_file.close
+
+        puts "TSV schedule file exported to '#{path}'"
+    end
+end

data/lib/rhs-schedule/period.rb

@@ -11,8 +11,9 @@ class Period
     @location = location
   end
 
+  # Returns a short summary of the period including subject, location, and duration with times
   def to_s
-    "#{@course_title} in #{@location} for #{duration} minutes"
+    "#{@course_title} in #{@location} for #{duration} minutes (#{start_time} to #{end_time})"
   end
 
   # Returns the duration of the period in minutes

data/lib/rhs-schedule/scheduleday.rb

@@ -9,6 +9,7 @@ class ScheduleDay
     @periods = periods
   end
 
+  # Returns short summary of schedule day, including letter, number of periods, and then a list of the periods.
   def to_s
     to_return = ["#{@schedule_day}-Day: #{@periods.length} periods"]
     @periods.each do |p|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhs-schedule
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Frank Matranga
@@ -17,6 +17,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rhs-schedule.rb
+- lib/rhs-schedule/errors.rb
+- lib/rhs-schedule/exports.rb
 - lib/rhs-schedule/period.rb
 - lib/rhs-schedule/scheduleday.rb
 homepage: