implemented exclusion dates, pl readme

Author: srflp

README.md

@@ -3,41 +3,40 @@ An online tool that makes adding your schedule to Google Calendar faster and eas
 
 You can test it [here](https://srflp.github.io/planeo/).
 
-Simply fill out the form, submit it and enjoy the schedule in Google Calendar 📅.
+Simply fill out the form, submit it and enjoy the schedule in your Google Calendar 📅.
+
+Currently the form is adjusted to suit the needs of students attending the Faculty of Computing and Telecommunications of the Poznan University of Technology.
 
 _Read this in other languages: [Polski](README.pl.md)_
 
 
 ## About the project
 
-The main goal of this project is to help students in integrating their schedule with Google Calendar.
-
-### Why?
+The main goal of this project is to help students in transferring their schedule into Google Calendar.
 
-Such personalized tool as planeo makes the process much more intuitive, because it perfectly suits the needs.
+### Why not adding the schedule manually?
 
-Adding the timetable manually is highly time-consuming. If you've never tried it, I'm sure, the easiest option is planeo.
+planeo makes the process much more intuitive, because it's tailored to do just one thing - adding a schedule.
 
-Google Calendar is an incredible multi-purpose tool, but it is event-oriented. It's easy to add single events or simple recurring events, but when it comes to complex recurring events, for example such occurring in a timespan beetween two dates, it's doable but not enjoyable.
+Adding the timetable to Google Calendar manually is highly time-consuming.
 
 ### What does it exactly do?
 
-After you fill out the form and submit it, the data you typed in is preprocessed.
-
-// TODO
+After you fill out the form and submit it, the data you typed in is preprocessed and submitted to Google Calendar API in special form.
 
 ## Technical details
-The entire project was written in plain JavaScript, without the use of any JS frameworks.
+The entire project was written in plain JavaScript, without the use of any massive JS frameworks.
 
 ### Dependencies
 #### Development side
-- [babel](https://github.com/babel/babel) - it transpiles modern JS to JS that is able to run in the most browsers
-- [webpack](https://github.com/webpack/webpack) - combined with babel it bundles the source code into single bundle.js file
+- [babel](https://github.com/babel/babel) - it transpiles ES6 JS to ES5 that is able to run in the most browsers
+- [webpack](https://github.com/webpack/webpack) - launches babel and bundles the source code into single bundle.js file
 
 #### Production side
 - [Bootstrap](https://github.com/twbs/bootstrap) - UI (CSS only)
 - [flatpickr](https://github.com/flatpickr/flatpickr) - datepickers
-- [loadjs](https://github.com/muicss/loadjs) - for loading Google API directly from JavaScript
+- [loadjs](https://github.com/muicss/loadjs) - for loading Google API Client Library directly with JavaScript
+- [dayjs](https://github.com/iamkun/dayjs) - lightweight library to manage complex date manipulation
 
 ## Installation
 If you want to run it on your own computer/server:

README.pl.md

@@ -1,5 +1,64 @@
 # planeo
 
-// TODO
+Narzędzie, które pozwala dodać Twój plan zajęć do Kalendarza Google szybciej i prościej, niż gdyby robić to ręcznie.
 
-_Read this in other languages: [English](README.md)_
+Możesz przetestować je [tutaj](https://srflp.github.io/planeo/).
+
+Formularz jest dostosowany obecnie do planów zajęć Wydziału Intformatyki i Telekomunikacji Politechniki Poznańskiej.
+
+_Read this in other languages: [English](README.md)_
+
+## O projekcie
+
+Głównym celem tego projektu jest ułatwienie studentom dodawania swoich planów do Kalendarza Google.
+
+### Dlaczego nie dodawać planu ręcznie?
+
+planeo znacząco upraszcza proces dodawania planu do Kalendarza, robienie tego ręcznie jest bardzo czasochłonne.
+
+### Co ten program tak właściwie robi?
+
+Po wypełnieniu formularza i wysłaniu go, planeo przetwarza wpisane dane i przekazuje je do API Kalendarza Google.
+To tak w bardzo dużym uproszczeniu. W rzeczywistości, proces po kliknięciu „Dodaj” wygląda tak:
+- dodawane są całodniowe wydarzenia znakujące początki i końce semestru
+- w poniedziałek każdego tygodnia semestru dodawane jest całodniowe wydarzenie oznaczające, czy dany tydzień jest tygodniem parzystym, czy nieparzystym (na podstawie informacji z formularza, czy pierwszy tydzień jest parzysty/nieparzysty)
+- wyszukiwana jest pierwsza data wystąpienia danego zajęcia w semestrze (uwzględniając parzystości tygodni i występujące święta, podczas których zajęć nie ma), a następnie dodawane jest cykliczne wydarzenie (ang. recurrent event) z tą datą jako datą początku, oraz datą końca semestru jako datę końca cyklicznego wydarzenia. Cykliczne wydarzenia mają częstotliwość określoną na 1 tydzień (przy ustawieniu "wszystkie tygodnie") lub 2 tygodnie (przy wybraniu opcji "parzyste"/"nieparzyste"). Do informacji o cykliczności wydarzenia dołączane są wyjątki, czyli wszystkie daty w których zajęcia się nie odbędą (święta).
+- jako całodniowe wydarzenia dodawane są dni wolne od zajęć dydaktycznych (święta) 
+
+## Detale techniczne
+Cały projekt został napisany w czystym JavaScripcie, bez użycia żadnych dużych JSowych frameworków.
+
+### Zależności
+#### Development side
+- [babel](https://github.com/babel/babel) - transpiluje JSa w standardzie ES6 do standardu ES5 który jest obsługiwany przez zdecydowaną większość przeglądarek
+- [webpack](https://github.com/webpack/webpack) - uruchamia babela i bundluje kod w pojedynczy plik bundle.js
+
+#### Production side
+- [Bootstrap](https://github.com/twbs/bootstrap) - interfejs użytkownika (sam CSS)
+- [flatpickr](https://github.com/flatpickr/flatpickr) - kalendarzyki do wyboru daty
+- [loadjs](https://github.com/muicss/loadjs) - do wczytywania Google API Client Library bezpośrednio z poziomu JavaScriptu
+- [dayjs](https://github.com/iamkun/dayjs) - lekka biblioteka do wygodnego operowania na datach
+
+## Instalacja
+Jeśli chcesz uruchomić ten projekt na swoim komputerze:
+1. sklonuj repozytorium
+2. uruchom `npm install` będąc w katalogu projekty
+3. wejdź do folderu `dist` i uruchom z jego poziomu serwer HTTP, np.
+    ```
+    $ python3 -m http.server 8000
+    ```
+4. uruchom webpacka:
+    ```
+    npx webpack
+    ```
+    Automatycznie będzie on nadzorował zmiany w projekcie i auktualizował plik bundle.js z każdą zmianą.
+    
+### Inne
+Dodatkowo możesz nadać lokalnemu adresowi strony adres publiczny używając ngroka (aby np. przetestować apkę na telefonie):
+```
+./ngrok http localhost:8000
+```
+Aktualizacja brancha gh-pages:
+```
+git subtree push --prefix dist origin gh-pages
+```

dist/bundle.js

@@ -1,26 +1,31 @@
 import dayjs from "dayjs"
 import customParseFormat from 'dayjs/plugin/customParseFormat';
+import isSameOrBefore from 'dayjs/plugin/isSameOrBefore';
 dayjs.extend(customParseFormat);
+dayjs.extend(isSameOrBefore);
 
 export default class CalendarEvent {
     constructor(event) {
         this.summary = event.name;
-        this.startDate = event.startDate.format('YYYY-MM-DD'); // expects Date object
-        this.endDate = event.endDate.format('YYYY-MM-DD');
         this.allDay = event.allDay; // boolean
-        if (!this.allDay) {
+        this.startDate = event.startDate.format('YYYY-MM-DD'); // expects Date object
+        if (this.allDay) {
+            this.endDate = event.endDate.add(1, 'day').format('YYYY-MM-DD'); // correction of Google Calendar bug
+        } else {
+            this.endDate = event.endDate.format('YYYY-MM-DD');
             this.startDateTime = dayjs(this.startDate + ' ' + event.startHour, 'YYYY-MM-DD HH:mm').toISOString();
             this.endDateTime = dayjs(this.endDate + ' ' + event.endHour, 'YYYY-MM-DD HH:mm').toISOString();
         }
         if (event.recurrence) {
             this.recurrence = [
                 [
                     'RRULE:FREQ=WEEKLY',
-                    'UNTIL=' + event.recurrence.endDate.format('YYYYMMDDTHHmmss[Z]'),
+                    'UNTIL=' + event.recurrence.endDate.add(1, 'day').format('YYYYMMDDTHHmmss[Z]'),
                     'INTERVAL=' + event.recurrence.interval,
                     'WKST=MO', // the week start date
                     'BYDAY=' + event.recurrence.days.map(this.weekdayToRruleShortcut).join(','),
                 ].join(';'),
+                ...this.generateExDates(event.recurrence.exDates, event.startHour),
             ];
         }
 
@@ -65,4 +70,20 @@ export default class CalendarEvent {
             'niedziela': 'SU',
         }[weekday];
     }
+
+    generateExDates(dates, startHour) {
+        const exRules = [];
+        if (dates) {
+            dates.forEach((date => {
+                if (date.length === 1) {
+                    date[1] = date[0];
+                }
+                while(date[0].isSameOrBefore(date[1])) {
+                    exRules.push(`EXDATE;TZID=Europe/Warsaw:${date[0].format(`YYYYMMDDT${startHour.split(':').join('')}00`)}`);
+                    date[0] = date[0].add(1, 'day');
+                }
+            }));
+        }
+        return exRules;
+    }
 }

src/googleCalendar/CalendarEvent.js

@@ -33,12 +33,9 @@ export default async function addAndFillInCalendar(data, statusBox) {
         statusBox.setOperationStatus("Trwa dodawanie zajęć...");
         await addLessons(calendarId, data, semesterStartDate, semesterEndDate);
 
-        // TODO addHolidays
         statusBox.setOperationStatus("Trwa dodawanie dni wolnych...");
         await addHolidays(calendarId, data.holidays);
 
-        // TODO removeLessonsOnHolidays
-
         statusBox.setOperationStatus(`Kalendarz „${data.calendarName}” został dodany`, false);
     } catch (error) {
         console.error(error);
@@ -117,6 +114,7 @@ async function addLessons(calendarId, data, semesterStartDate, semesterEndDate)
                 endDate: semesterEndDate,
                 days: [lesson.weekday],
                 interval: interval,
+                exDates: getParsedHolidayDates(data.holidays),
             }
         });
 

src/googleCalendar/main.js

@@ -28,10 +28,4 @@ export const weekdays = ['poniedziałek', 'wtorek', 'środa', 'czwartek', 'piąt
 
 export function weekdaySort(a, b) {
     return weekdays.indexOf(a.weekday) - weekdays.indexOf(b.weekday);
-}
-
-// export function addDays(date, days) {
-//     const result = new Date(date);
-//     result.setDate(result.getDate() + days);
-//     return result;
-// }
+}