New way to specify captions

Author: jburns20

SPEC.md

@@ -1,6 +1,12 @@
 # iHW Project Design Specifications
 
-*In order to make the iHW project more coordinated, unified, and better overall, I think that it’s a good idea for us to write up exactly how we are going about creating the two phone apps and web app. If we use this document to communicate our goals and ideas for the project, we can more effectively create a unified experience for the app across platforms. Please add or edit anything you want in any of the sections below, or even add new sections—this is our space to share ideas. Thanks!*
+*In order to make the iHW project more coordinated, unified, and better
+overall, I think that it’s a good idea for us to write up exactly how we
+are going about creating the two phone apps and web app. If we use this
+document to communicate our goals and ideas for the project, we can more
+effectively create a unified experience for the app across platforms.
+Please add or edit anything you want in any of the sections below, or
+even add new sections—this is our space to share ideas. Thanks!*
 
 ## Required Features - View
 
@@ -14,21 +20,28 @@
 
 ### Schedule View
 
--   Shows one day at a time, with the ability to swipe left and right to see different days.
+-   Shows one day at a time, with the ability to swipe left and right to
+    see different days.
 
 -   Shows date, day of week, and day number (if applicable).
 
 -   Shows a list of periods in the day.
 
--   For each period, shows course name (or "X"), start and end times, and period number (if applicable).
+-   For each period, shows course name (or "X"), start and end times,
+    and period number (if applicable).
 
--   For each period, lists the notes the user has added to the period and always has an empty box to add an additional note.
+-   For each period, lists the notes the user has added to the period
+    and always has an empty box to add an additional note.
 
--   Ability to show/hide a checkbox for any note or mark it as important (makes it bigger/bolder and moves it to the top) or unimportant (restores font and moves it to the bottom)
+-   Ability to show/hide a checkbox for any note or mark it as important
+    (makes it bigger/bolder and moves it to the top) or unimportant
+    (restores font and moves it to the bottom)
 
--   Shows a countdown timer next to the period title if the period will start soon.
+-   Shows a countdown timer next to the period title if the period will
+    start soon.
 
--   Has a button to jump to the current day and a button to choose a date to show.
+-   Has a button to jump to the current day and a button to choose a
+    date to show.
 
 ### Courses Editor
 
@@ -42,29 +55,37 @@
 
 -   Has text boxes for course name and period.
 
--   Validates the period text box as you type (doesn't let you type anything besides valid period numbers)
+-   Validates the period text box as you type (doesn't let you type
+    anything besides valid period numbers)
 
 -   Has a drop-down field to choose the term.
 
--   Has a grid of checkboxes with three rows (period before, this period, period after) to select class meetings.
+-   Has a grid of checkboxes with three rows (period before, this
+    period, period after) to select class meetings.
 
 -   Has buttons to delete this course or save it.
 
--   Rejects courses that do not have a name or at least one class meeting.
+-   Rejects courses that do not have a name or at least one class
+    meeting.
 
 ## Required Features - Model
 
 -   Loads curriculum JSON when user selects a campus during first-run
 
--   Reloads curriculum JSON on app launch every time there's an internet connection available
+-   Reloads curriculum JSON on app launch every time there's an internet
+    connection available
 
 -   Loads year JSON and cycle 0 on app launch
 
--   Loads cycle JSON files as needed (preloading at least one day before and after the currently selected day)
+-   Loads cycle JSON files as needed (preloading at least one day before
+    and after the currently selected day)
 
--   Loads the currently selected day, then preloads day(s) before and after it in the background
+-   Loads the currently selected day, then preloads day(s) before and
+    after it in the background
 
--   Saves notes when the user is done editing a note, when a note option is changed, and when the user leaves the day where the notes are written.
+-   Saves notes when the user is done editing a note, when a note option
+    is changed, and when the user leaves the day where the notes are
+    written.
 
 -   Saves courses whenever the user leaves the edit course view.
 
@@ -84,7 +105,8 @@
 
 ## Communications / JSON / Saving / etc.
 
--   Schedule JSON: contains all of the data (one year, one campus) that is not specific to any one particular user
+-   Schedule JSON: contains all of the data (one year, one campus) that
+    is not specific to any one particular user
 
     -   Format:
 
@@ -101,7 +123,8 @@
         “specialDays”: {...} //maps dates to day objects
     }
 
--   Year JSON (badly named): contains course information and other general information specific to the user
+-   Year JSON (badly named): contains course information and other
+    general information specific to the user
 
     -   Format:
 
@@ -117,22 +140,26 @@
 
     -   Week numbers are as follows:
 
-        -   The partial week between July 1 and the first Sunday after July 1 has week number 0.
+        -   The partial week between July 1 and the first Sunday after
+            July 1 has week number 0.
 
-        -   On and after the first Sunday after July 1, the week number is: (number of days since the first Sunday after July 1 / 7)+1.
+        -   On and after the first Sunday after July 1, the week number
+            is: (number of days since the first Sunday after July 1 /
+            7)+1.
 
     -   Format:
 
 <!-- -->
 
     {
         “number”: 1,
-        “notes”: {...} //maps "date.period" to arrays of notes
+        “notes”: {...} //maps “<date>.<period>" to arrays of notes
     }
 
 -   Date Format for JSON: `“M/D/YYYY”` e.g. `“9/16/2012”`
 
--   Time Format for JSON: `“H:M”`  e.g. `“8:0”` or `“14:30”` (use 24 hour time)
+-   Time Format for JSON: `“H:M”`  e.g. `“8:0”` or `“14:30”` (use 24
+    hour time)
 
 -   Course Format for JSON:
 
@@ -145,19 +172,23 @@
         “meetings”: [1,1,1,1,0]
     }
 
--   Note Format for JSON: (IMPORTANT: period is NOT the same as “periodNum” in the Period JSON! periodNum can be any number, but period is the index of the period within the day [-1 for additional notes at the bottom of every day])
+-   Note Format for JSON: (IMPORTANT: period is NOT the same as
+    “periodNum” in the Period JSON! “periodNum" can be any number, but
+    “period" is the INDEX of the period within the day [-1 for
+    additional notes at the bottom of every day])
 
 <!-- -->
 
     {
-        “text”: “Hello, World!”,
-        “isChecked”: false,
-        “isImportant”: false,
-        “isToDo”: false
+        "text": "Hello, World!",
+        "isChecked": false,
+        "isImportant": false,
+        "isToDo": false
         "period": 1
     }
 
--   Normal Day (with break) Format for JSON (day number 0 for no day number):
+-   Normal Day (with break) Format for JSON (day number 0 for no day
+    number):
 
 <!-- -->
 
@@ -171,10 +202,14 @@
         "periodsBeforeBreak": 2,
         "type": "normal",
         "date": "9/12/2012",
-        "hasBreak": true
+        "hasBreak": true,
+        "breakIsFree": true,
+        "caption": "A.P. English Exam today 8:00-10:30",
+        "captionLink": "http://www.google.com/"
     }
 
--   Normal Day (without break) Format for JSON (day number 0 for no day number):
+-   Normal Day (without break) Format for JSON (day number 0 for no day
+    number):
 
 <!-- -->
 
@@ -184,17 +219,22 @@
         "numPeriods": 8,
         "type": "normal",
         "date": "9/12/2012",
-        "hasBreak": false
+        "hasBreak": false,
+        "caption": "A.P. English Exam today 8:00-10:30",
+        "captionLink": "http://www.google.com/"
     }
 
--   Test Day (i.e. Custom Day) Format for JSON:
+-   Test Day (aka Custom Day) Format for JSON (“tests” refers to an
+    array of “period” objects):
 
 <!-- -->
 
     {
         "date": "10/6/2012",
         "tests": [...],
-        "type": "test"
+        "type": "test",
+        "caption": "A.P. English Exam today 8:00-10:30",
+        "captionLink": "http://www.google.com/"
     }
 
 -   Holiday Format for JSON:
@@ -204,10 +244,14 @@
     {
         "date": "10/22/2012",
         "name": "Mid-Semester Break",
-        "type": "holiday"
+        "type": "holiday",
+        "caption": "A.P. English Exam today 8:00-10:30",
+        "captionLink": "http://www.google.com/"
     }
 
--   Period format for JSON: (IMPORTANT: periodNum is NOT the same as “period” in the Note JSON! periodNum can be any number, but period is the index of the period within the day.)
+-   Period format for JSON: (IMPORTANT: periodNum is NOT the same as
+    “period” in the Note JSON! periodNum can be any number, but period
+    is the index of the period within the day.)
 
 <!-- -->
 
@@ -216,7 +260,8 @@
         "startTime": "8:0",  
         "name": "Period Name",  
         "date": "11/3/2012",  
-        "endTime": "14:30"  
+        "endTime": "14:30”,
+        “isFreePeriod”: false,
     }
 
 -   Constants:

iHW-iOS/iHW/iHW.xcodeproj/project.xcworkspace/xcuserdata/jonathanburns.xcuserdatad/UserInterfaceState.xcuserstate

@@ -36,6 +36,7 @@
 @property (strong, nonatomic) NSDictionary *normalDayTemplate;
 @property (strong, nonatomic) NSDictionary *normalMondayTemplate;
 @property (strong, nonatomic) NSDictionary *specialDayTemplates;
+@property (strong, nonatomic) NSDictionary *dayCaptions;
 @property (strong) NSMutableDictionary *loadedWeeks;
 @property (strong) NSMutableDictionary *loadedDays;
 @property (strong, nonatomic) NSMutableDictionary *dayNumbers;

iHW-iOS/iHW/iHW/IHWCurriculum.h

@@ -18,6 +18,7 @@
 #import "IHWNote.h"
 #import "IHWPeriod.h"
 
+static NSString *curriculumDirectory = @"http://beta.ihwapp.com/curriculum/";
 static IHWCurriculum *currentCurriculum;
 
 #pragma mark ****************PRIVATE INSTANCE VARS*****************
@@ -215,7 +216,7 @@ - (BOOL)downloadParseScheduleJSON {
     //NSLog(@">downloading schedule JSON");
     NSError *error = nil;
     NSURLResponse *response = nil;
-    NSString *urlStr = [NSString stringWithFormat:@"http://beta.ihwapp.com/curriculum/%d%@.hws", self.year, getCampusChar(self.campus)];
+    NSString *urlStr = [NSString stringWithFormat:@"%@%d%@.hws", curriculumDirectory, self.year, getCampusChar(self.campus)];
     NSURLRequest *request = [[NSURLRequest alloc] initWithURL:[NSURL URLWithString:urlStr] cachePolicy:NSURLRequestReloadIgnoringCacheData timeoutInterval:10];
     [(IHWAppDelegate *)[UIApplication sharedApplication].delegate performSelectorOnMainThread:@selector(showNetworkIcon) withObject:nil waitUntilDone:NO];
     NSData *scheduleJSON = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];
@@ -270,6 +271,14 @@ - (BOOL)parseScheduleJSON:(NSData *)scheduleJSON {
         [specialDays setObject:[specialDaysJSON objectForKey:dateStr] forKey:[[IHWDate alloc] initFromString:dateStr]];
     }
     self.specialDayTemplates = [NSDictionary dictionaryWithDictionary:specialDays];
+    
+    //Load day captions into curriculum
+    NSMutableDictionary *captions = [[NSMutableDictionary alloc] init];
+    NSDictionary *captionsJSON = [scheduleDict objectForKey:@"dayCaptions"];
+    for (NSString *dateStr in [captionsJSON allKeys]) {
+        [captions setObject:[captionsJSON objectForKey:dateStr] forKey:[[IHWDate alloc] initFromString:dateStr]];
+    }
+    self.dayCaptions = [NSDictionary dictionaryWithDictionary:captions];
     return YES;
 }
 
@@ -412,6 +421,15 @@ - (BOOL)loadDay:(IHWDate *)date {
     } else if ([type isEqualToString:@"holiday"]) {
         day = [[IHWHoliday alloc] initWithJSONDictionary:template];
     } else return NO;
+    
+    //Add caption if necessary
+    NSDictionary *captionDict = [self.dayCaptions objectForKey:date];
+    if (captionDict != nil && day.caption == nil) {
+        day.caption = [captionDict objectForKey:@"text"];
+        if ([captionDict objectForKey:@"link"] != nil) {
+            day.captionLink = [captionDict objectForKey:@"link"];
+        }
+    }
     //[self.loadedDays insertObject:day forKey:date sortedUsingComparator:[IHWDate comparator]];
     [self performSelectorOnMainThread:@selector(addLoadedDay:) withObject:day waitUntilDone:YES];
     return YES;
@@ -467,12 +485,17 @@ - (NSArray *)allCourseNames {
 
 - (BOOL)addCourse:(IHWCourse *)c {
     for (IHWCourse *check in self.courses) {
+        //Make sure no courses conflict with the new course
         if (!termsCompatible(check.term, c.term)) {
+            //There could be a problem if the terms overlap
             if (check.period == c.period) {
+                //There could be a problem if the periods are the same
                 for (int i=1; i<=self.campus; i++) {
+                    //There's a problem if the two courses meet on the same day
                     if ([c meetingOn:i] != MEETING_X_DAY && [check meetingOn:i] != MEETING_X_DAY) return NO;
                 }
             } else {
+                //Check for double periods
                 IHWCourse *later;
                 IHWCourse *earlier;
                 if (c.period > check.period) {
@@ -483,18 +506,21 @@ - (BOOL)addCourse:(IHWCourse *)c {
                     earlier = c;
                 }
                 if (ABS(c.period-check.period) == 1) {
+                    //Double periods could be a problem when the courses are in consecutive periods
                     for (int i=1; i<=self.campus; i++) {
                         if ([earlier meetingOn:i] == MEETING_DOUBLE_AFTER && [later meetingOn:i] != MEETING_X_DAY) return NO;
                         if ([later meetingOn:i] == MEETING_DOUBLE_BEFORE && [earlier meetingOn:i] != MEETING_X_DAY) return NO;
                     }
                 } else if (ABS(c.period-check.period) == 2) {
+                    //Double periods could also be a problem when the courses are two periods apart
                     for (int i=1; i<=self.campus; i++) {
                         if ([earlier meetingOn:i] == MEETING_DOUBLE_AFTER && [later meetingOn:i] == MEETING_DOUBLE_BEFORE) return NO;
                     }
                 }
             }
         }
     }
+    //No problems found
     [self.courses addObject:c];
     [self.loadedDays removeAllObjects];
     return YES;
@@ -510,6 +536,8 @@ - (void)removeAllCourses {
     [self.loadedDays removeAllObjects];
 }
 
+//Unnecessary methods
+
 /*
 - (BOOL)replaceCourseWithName:(NSString *)oldName withCourse:(IHWCourse *)c {
     IHWCourse *oldCourse = [self courseWithName:oldName];
@@ -546,8 +574,10 @@ - (IHWCourse *)courseMeetingOnDate:(IHWDate *)d period:(int)period {
     int dayNum = [[self.dayNumbers objectForKey:d] intValue];
     NSArray *terms = [self termsFromDate:d];
     if (dayNum == 0) {
+        //For "No X Periods" days, choose the course that meets the most
         IHWCourse *maxMeetings = nil;
         int max = 1;
+        //If the course only meets once per cycle, it doesn't meet on "No X Periods" days
         for (IHWCourse *c in self.courses) {
             BOOL termFound = NO;
             for (NSNumber *term in terms) if ([term intValue] == c.term) {

iHW-iOS/iHW/iHW/IHWCurriculum.m

@@ -157,6 +157,10 @@ - (void)loadTableViewCells {
 
 - (void)viewDidAppear:(BOOL)animated {
    //NSLog(@"viewDidAppear");
+    if (self.scrollToIndex != -1) {
+        [self.periodsTableView scrollToRowAtIndexPath:[NSIndexPath indexPathForRow:self.scrollToIndex inSection:0] atScrollPosition:UITableViewScrollPositionMiddle animated:YES];
+        self.scrollToIndex = -1;
+    }
 }
 
 - (void)keyboardWillShow:(NSNotification *)notification {
@@ -241,7 +245,7 @@ - (UITableViewCell *)createNewCellForIndex:(int)index {
 
     cell.frame = CGRectMake(0, 0, self.view.bounds.size.width, [view neededHeight]);
     view.dayViewController = self;
-    [view createCountdownViewIfNeeded];
+    if ([view createCountdownViewIfNeeded]) self.scrollToIndex = index;
     [cell.contentView addSubview:view];
     return cell;
 }

iHW-iOS/iHW/iHW/IHWDayViewController.m

@@ -18,6 +18,7 @@
 @property int periodsAfterBreak;
 @property int periodLength;
 @property int breakLength;
+@property BOOL breakIsFree;
 @property (strong, nonatomic) NSDictionary *periodLengths;
 @property (strong, nonatomic) NSString *breakName;
 
@@ -26,6 +27,7 @@
  periodsBeforeBreak:(int)pbb
          afterBreak:(int)pab
         breakLength:(int)blength
+        breakIsFree:(BOOL)breakIsFree
        periodLength:(int)plength;
 
 - (id)initWithDate:(IHWDate *)date