• Data publicării: 23.12.2022, 00:10
• Data ultimei modificări: 23.12.2022, 00:10
• Deadline HARD: 16.01.2023, 23:59
• Responsabili: Mihail Ungureanu, Sorina Anamaria Buf, Narcis-Florin Căroi, Mihnea-Andrei Bloțiu, Mihai Soare, Eduard Marin
• Repository schelet: Github
• Actualizări:

• dezvoltarea unor abilități de bază de organizare și design orientat obiect;
• proiectarea unui design mentenabil, extensibil și reutilizabil, respectând astfel principalele obiective ale limbajelor OOP;
• înțelegerea scopului și contextului de utilizare ale design pattern-urilor studiate în cadrul laboratorului (și nu numai) în vederea alegerii și implementării pattern-ului potrivit pentru rezolvarea unei probleme reale;
• adăugarea de noi funcționalități, având la bază un codebase deja existent;
• respectarea unui stil de programare și de documentare a codului, în unitate cu practicile de codare folosite în prima etapă a aplicației.

Înainte de a merge mai departe cu funcționalitățile introduse de această etapă, dorim să facem o scurtă recapitulare asupra primului stagiu al proiectului și să clarificăm astfel anumite aspecte, pentru a nu întâmpina dificultăți în etapa curentă.

În cadrul primei etape, ați avut de implementat structura platformei noastre de streaming video, care a constat în definirea paginilor care pot fi accesate de un utilizator și flow-ul de accesare al acestora.

Am introdus schema precedentă pentru a avea o imagine și mai clară asupra paginilor existente pe site-ul nostru, modul în care acestea pot fi accesate (în urma acțiunilor de tipul change page) precum și acțiunile care pot fi realizate în cadrul fiecărei pagini. (acțiunile on page).

Se păstrează același format de input explicat în cadrul etapei anterioare, deci puteți vedea exemplele din cadrul paginii dedicate etapei 1.

În cazul acțiunilor de tipul on page, a existat o neconcordanță între formatul exemplificat pe ocw și cel din teste (ne cerem scuze pentru asta). Clarificăm și aici, că pentru o acțiune de tipul on page formatul de input NU va conține un field page, care să specifice pagina pe care se realizează acțiunea. Este de datoria voastră să vă salvați intern pagina pe care vă aflați și ce acțiuni aveți voie să executați în cadrul acesteia.

Formatul de output se păstrează și puteți vedea explicațiile integrale asupra conținutului acestuia pe pagina dedicată etapei precedente. În această secțiune vrem însă să revizuim ce tip de acțiuni generează scrierea de conținut la output.

Nu toate schimbările de pagină generează scrierea la output. Cele care generează sunt:

• change page către pagina Movies

→ output-ul va reflecta filmele accesibile utilizatorului ajuns pe pagina Movies, în cadrul câmpului currentMoviesList

• change page către pagina See details

→ output-ul va reflecta filmul accesat prin pagina See details, în cadrul câmpului currentMoviesList (o listă care va conține doar filmul a cărei pagini a fost accesată)

Nu toate acțiunile realizabile pe o pagină generează scrierea la output. Cele care generează sunt următoarele:

• login

→ output-ul va reflecta utilizatorul nou conectat, în cadrul câmpului currentUser

• register

→ output-ul va reflecta utilizatorul nou înregistrat și conectat, în cadrul câmpului currentUser

• search

→ output-ul va reflecta lista curentă a filmelor de pe pagina Movies, în urma filtrării executate de acțiunea search (ne amintim că acțiunea search este o comandă de filtrare în care condiția este ca titlul filmelor să înceapă obligatoriu cu string-ul oferit în câmpul de input startsWith), în cadrul câmpului currentMoviesList

• filter

→ output-ul va reflecta lista curentă a filmelor de pe pagina Movies, în urma filtrării executate de acțiunea filter (pe baza filtrelor primite la input), în cadrul câmpului currentMoviesList

• purchase

→ output-ul va reflecta filmul curent pe care ne aflăm, în cadrul câmpului currentMoviesList (o listă care va conține doar filmul a cărei pagini a fost accesată) și cumpărarea acestuia, fiind apendat la lista purchasedMovies din obiectul utilizatorului curent, currentUser

• watch

→ output-ul va reflecta filmul curent pe care ne aflăm, în cadrul câmpului currentMoviesList (o listă care va conține doar filmul a cărei pagini a fost accesată) și vizionarea acestuia, fiind apendat la lista watchedMovies din obiectul utilizatorului curent, currentUser

• like

→ output-ul va reflecta filmul curent pe care ne aflăm, în cadrul câmpului currentMoviesList (o listă care va conține doar filmul a cărei pagini a fost accesată) și aprecierea acestuia, fiind apendat la lista likedMovies din obiectul utilizatorului curent, currentUser

• rate

→ output-ul va reflecta filmul curent pe care ne aflăm, în cadrul câmpului currentMoviesList (o listă care va conține doar filmul a cărei pagini a fost accesată) și oferirea de rating acestuia, fiind apendat la lista ratedMovies din obiectul utilizatorului curent, currentUser

Acum că avem toate detaliile platformei noastre clarificate (hopefully), putem sa ne apucăm de implementarea noilor funcționalități de care depinde etapa curentă de îmbunătățire a aplicației.

Noile acțiuni pe care le vom introduce în această etapă vor presupune o mică modificare realizată asupra formatului de output, mai exact, introducerea unui nou câmp în cadrul obiectului currentUser.

{
  "error" : null,
  "currentMoviesList" : [ ],
  "currentUser" : {
    "credentials" : {
      "name" : "Eduard",
      "password" : "secret",
      "accountType" : "standard",
      "country" : "Romania",
      "balance" : "50"
    },
    "tokensCount" : 0,
    "numFreePremiumMovies" : 15,
    "purchasedMovies" : [ ],
    "watchedMovies" : [ ],
    "likedMovies" : [ ],
    "ratedMovies" : [ ],
    "notifications": []
  }
}

După cum puteți observa în exemplul anterior, singura modificare care apare este adăugarea unui array notifications, în cadrul obiectului currentUser. Restul field-urilor rămân neschimbate și își păstrează însemnătatea și rolul din prima etapă a proiectului.

Popularea câmpului notifications va fi explicată în cadrul fiecărei acțiuni ce necesită modificarea acestuia. În principiu, fiecare user va trebui să stocheze o coadă de notificări ce va fi populată de-a lungul execuției, în urma anumitor acțiuni efectuate.

I’ve seen it all… asta a fost principala plângere din partea utilizatorilor site-ului vostru, care, într-o seară de procrastinare a temei la SO, au vizualizat toate filmele din baza voastră de date și au făcut switch rapid pe NETFLIX, că deadline-ul la temă e oricum departe.

Ca să-i aduceți înapoi pe site, deschideți The Pirate Bay și uploadați pe POO TV toate filmele Marvel pe care le găsiți. Ba mai mult, ca să nu supraîncărcați baza de date, vreți să aveți și posibilitatea ca ocazional să ștergeți filmele mai puțin populare.

Nu în ultimul rând, ca să vă țineți consumatorii mulțumiți, le oferiți acestora posibilitatea de abonare gratuită la anumite movie topics și implicit de a primi notificări în momentul update-urilor efectuate asupra bazei de filme.

În această etapă, vom adăuga un nou tip de acțiune, subscribe, prin care utilizatorul curent conectat va avea posibilitatea de a se abona la un anumit gen de filme.

{
      "type": "on page",
      "feature": "subscribe",
      "subscribedGenre": "Action"
}

Inputul acestei comenzi va conține numele acțiunii, “subscribe”, și genul la care se abonează utilizatorul. Un utilizator se poate abona la un singur gen de filme printr-o acțiune de subscribe.

Dacă nu există erori, nu se va afișa nimic la output după efectuarea acestui tip de comandă, fiind de datoria voastră să vă salvați intern categoriile cinematografice la care se abonează utilizatorii.

Acum, ne dorim să putem modifica baza noastră de filme, pentru a avea mereu un conținut up to date, care să nu ne plictisească utilizatorii.

Pentru a realiza acest lucru, vom adăuga încă un tip de acțiune, database, care, va putea fi efectuată indiferent de pagina pe care ne aflăm.

Acest tip de comanda va avea două posibile features: add și delete.

În momentul în care se execută o acțiune de tipul database add, un nou film va fi adăugat în baza de date. Puteți privi acțiunea ca fiind executată de un administrator extern al bazei de date, care nu va afecta pagina pe care sunteți.

De asemenea, prin intermediul acestei comenzi, utilizatorii care sunt abonați (prin intermediul acțiunii subscribe explicate anterior) la cel puțin unul dintre genurile filmului nou adăugat vor fi notificați de adăugare.

{
  "type": "database",
  "feature": "add",
  "addedMovie": {
    "name": "Matrix 2",
    "year": "1998",
    "duration": 131,
    "genres": [
      "Action",
      "Comedy",
      "Crime"
    ],
    "actors": [
      "Laurence Fishburne",
      "Halle Berry",
      "Keanu Reeves"
    ],
    "countriesBanned": [
      "Ireland"
    ]
  }
}

Inputul pentru acest tip de comandă va conține tipul acțiuni (field-ul type cu valoarea database) și tipul operației efectuate asupra bazei de date (field-ul feature cu valoarea add). Obiectul addedMovie va conține toate field-urile de descriere ale noului film adăugat.

În momentul în care se realizează o acțiune database add, TOȚI utilizatorii care sunt abonați la cel puțin unul dintre genurile filmului, și care nu se află într-una dintre țările banate ale movie-ului, vor fi notificați de adăugarea noului film, și implicit își vor apendui la o coadă de notificări acest eveniment.

"notifications" : [ {
    "movieName" : "Matrix 2",
    "message" : "ADD"
} ]

Notificarea de adăugare a unui film este caracterizată prin numele filmului (field-ul movieName), și tipul acțiunii, ADD, care s-a efectuat (field-ul message).

Dacă nu există erori, nu se va afișa nimic la output după efectuarea acestui tip de comandă, fiind de datoria voastră să actualizați baza de date și să notificați în mod corect utilizatorii (și implicit să adăugați la coada lor de notificări evenimentul).

Acțiunea database delete va reprezenta inversul comenzii database add (so shocking, I know) și va efectua ștergerea unui film din baza de date. La fel ca în cazul acțiunii precedente, puteți să o vedeți ca fiind executată de un administrator extern al bazei de date, care nu va afecta pagina pe care vă aflați.

Utilizatorii care au achiziționat filmul care urmează a fi șters vor fi notificați de ștergerea acestuia și vor primi înapoi resursele folosite pentru cumpărarea filmului.

{
  "type": "database",
  "feature": "delete",
  "deletedMovie": "Titanic"
}

Inputul pentru acest tip de comandă va conține tipul acțiunii (field-ul type cu valoarea database) și tipul operației efectuate asupra bazei de date (field-ul feature cu valoarea delete). Obiectul deletedMovie va conține numele filmului care trebuie șters.

În momentul în care se realizează o acțiune database delete, TOȚI utilizatorii care au cumpărat filmul respectiv vor fi notificați de ștergere și implicit își vor apendui la o coadă de notificări acest eveniment.

"notifications" : [ {
    "movieName" : "Titanic",
    "message" : "DELETE"
} ]

Notificarea de ștergere a unui film este caracterizată prin numele filmului (field-ul movieName), și tipul acțiunii, DELETE, care s-a efectuat (field-ul message).

Dacă nu există erori, nu se va afișa nimic la output după efectuarea acestui tip de comandă, fiind de datoria voastră să actualizați baza de date și să notificați în mod corect utilizatorii (și implicit să adăugați la coada lor de notificări evenimentul).

Ne propunem să adăugăm un nou element de UI pe fiecare pagină a site-ului nostru, butonul de back. Să navighezi pe un site fără posibilitatea de a te întoarce pe pagina anterioară poate fi destul de frustrant, nu-i așa? De aceea, am decis să includem acest feature și în cadrul aplicației noastre.

Această acțiune poate fi văzută ca inversul acțiunii de tip change page, dar în loc să navigați către următoarea pagină primită în input, vă întoarceți pe pagina pe care v-ați aflat înainte de efectuarea ultimei comenzi de tip change page.

{
  "type": "back"
}

În cazul acestei acțiuni nu există un exemplu propriu-zis de output, întrucât întoarcerea pe o anumită pagină va genera același output ca o acțiune de tipul change page către pagina respectivă.

Pentru a reaprinde vânzările abonamentelor, în această etapă le oferim utilizatorilor premium și mai multe beneficii, sub forma de recomandări personalizate.

La finalul șirului de acțiuni, utilizatorul premium conectat va primi o recomandare de film, pe baza genurilor filmelor cele mai apreciate de acesta.

Aceste recomandări nu vor funcția ca o nouă acțiune primită la input, ci, va fi de datoria voastră ca la finalul execuției tuturor acțiunilor din input, să afișați la output recomandarea de film pentru utilizatorul premium conectat.

Algoritm de generare recomandare:

• realizarea unui top al genurilor apreciate de către utilizator, prin sortarea în mod descrescător a acestora în funcție de numărul de like-uri;

• sortarea filmelor din baza de date descrescător în funcție de numărul total de like-uri;

• găsirea primului film din baza de date cu cel mai mare număr de like-uri care nu a mai fost văzut de către utilizator și care face parte din genul de film cel mai apreciat de acesta;

• dacă nu există un film nevizualizat din categoria celui mai apreciat gen, se va trece la următorul cel mai apreciat gen al utilizatorului și continuăm așa până când, fie am găsit un film care îndeplinește datele problemei, fie am epuizat genurile utilizatorului.

{
  "error" : null,
  "currentMoviesList" : null,
  "currentUser" : {
    "credentials" : {
      "name" : "Eduard",
      "password" : "secret",
      "accountType" : "premium",
      "country" : "Romania",
      "balance" : "150"
    },
    "tokensCount" : 40,
    "numFreePremiumMovies" : 14,
    "purchasedMovies" : [ {
      "name" : "Titanic",
      "year" : "2019",
      "duration" : 131,
      "genres" : [ "Action", "Thriller", "Crime" ],
      "actors" : [ "Laurence Fishburne", "Halle Berry", "Keanu Reeves" ],
      "countriesBanned" : [ "Russia" ],
      "numLikes" : 1,
      "rating" : 0.00,
      "numRatings" : 0
    } ],
    "watchedMovies" : [ {
      "name" : "Titanic",
      "year" : "2019",
      "duration" : 131,
      "genres" : [ "Action", "Thriller", "Crime" ],
      "actors" : [ "Laurence Fishburne", "Halle Berry", "Keanu Reeves" ],
      "countriesBanned" : [ "Russia" ],
      "numLikes" : 1,
      "rating" : 0.00,
      "numRatings" : 0
    } ],
    "likedMovies" : [ {
      "name" : "Titanic",
      "year" : "2019",
      "duration" : 131,
      "genres" : [ "Action", "Thriller", "Crime" ],
      "actors" : [ "Laurence Fishburne", "Halle Berry", "Keanu Reeves" ],
      "countriesBanned" : [ "Russia" ],
      "numLikes" : 1,
      "rating" : 0.00,
      "numRatings" : 0
    } ],
    "ratedMovies" : [ ],
    "notifications" : [ {
      "movieName" : "John Wick: Chapter 3 - Parabellum",
      "message" : "Recommendation"
    } ]
  }
}

{
  "error" : null,
  "currentMoviesList" : null,
  "currentUser" : {
    "credentials" : {
      "name" : "Mihail",
      "password" : "discret",
      "accountType" : "premium",
      "country" : "Russia",
      "balance" : "1337"
    },
    "tokensCount" : 0,
    "numFreePremiumMovies" : 15,
    "purchasedMovies" : [ ],
    "watchedMovies" : [ ],
    "likedMovies" : [ ],
    "ratedMovies" : [ ],
    "notifications" : [ {
      "movieName" : "No recommendation",
      "message" : "Recommendation"
    } ]
  } 
} 

• Separați conceptele de sine stătătoare în clase separate, nu le îmbinați - clasele ar trebui să aibă un sigur rol.
• Adaptați agregarea și moștenirea la situație, grupați pe cât posibil informația și acțiunile comune în clase generale.
• Nu vă apucați să scrieți direct; alocați timp modelării și abstractizării, pentru că altfel vă puteți trezi cu o temă muncitorească, cu mult cod din care să nu înțelegeți prea multe și pe care să-l extindeți greu.
• Vă recomandăm să porniți implementarea de la codul scris în prima etapă a proiectului, la care să adăugați noile funcționalități, dar se poate trimite și o implementare scrisă de la zero, care să nu păstreze codul primei părți, dar care să conțină funcționalitatea primei părți.
• Etapa a doua se poate trimite fără să fi trimis prima etapă a proiectului, însă va fi nevoie să se implementeze și funcționalitățile primei etape pentru a putea primi punctajul total pe teste; în acest caz se va primi punctaj doar pe a doua etapă.
• Verificați periodic această pagină, deoarece scheletul/cerința pot suferi modificări în urma unor erori din partea noastră.

Pentru testarea soluției, rulați funcția main a clasei Test. Aceasta va rula atât testele, cât și checkstyle-ul. Pentru rularea checkerului, aveți nevoie ca proiectul vostru să aibă încărcate bibliotecile pentru citirea fișierelor JSON. Mai multe detalii aici.

Punctajul constă din:

• 60p implementare - trecerea testelor
• 10p coding style (vezi checkstyle)
• 15p design și organizare (folosire design patterns)
• 10p README clar, concis, explicații axate pe design (flow, interacțiuni)
• 5p utilizare Git (minimum 3 commit-uri personale, relevante pentru flow-ul proiectului)

Depunctările pentru designul și organizarea codului se vor scădea din punctajul testelor. Dacă vor apărea depunctări specifice temei în momentul evaluării, nemenționate pe pagina cu depunctări generale, ele se vor încadra în limitele de maxim 15 pentru design, 10p pentru README. Dacă tema nu respectă cerințele, sau nu are design OOP, atunci pot apărea depunctări suplimentare.

Bonusuri: La evaluare, putem oferi bonusuri pentru design foarte bun, cod bine documentat, dar și pentru diverse elemente suplimentare alese de voi.

Unul din obiectivele temei este învățarea respectării code-style-ului limbajului pe care îl folosiți. Aceste convenții (de exemplu cum numiți fișierele, clasele, variabilele, cum indentați) sunt verificate pentru temă de către tool-ul checkstyle.

Pe pagina de Recomandări cod găsiți câteva exemple de coding style.

Dacă numărul de erori depistate de checkstyle depășește 30, atunci punctele pentru coding-style nu vor fi acordate. Dacă punctajul este negativ, acesta se trunchiază la 0.

Exemple:

• punctaj_total = 125 și nr_erori = 200 ⇒ nota_finala = 115
• punctaj_total = 125 și nr_erori = 29 ⇒ nota_finala = 125
• punctaj_total = 80 și nr_erori = 30 ⇒ nota_finala = 80
• punctaj_total = 80 și nr_erori = 31 ⇒ nota_finala = 70

Arhiva pe care o veţi urca pe VMChecker va trebui să conţină în directorul rădăcină:

• fișierul README
• folder-ul src cu pachetele și cu fișierele .java
• folder-ul .git

• Schelet de cod
• Indicații pentru teme
• Recomandări coding style & javadoc