Add rating field to Book

docs/DeveloperGuide.adoc

@@ -978,18 +978,18 @@ Use case ends.
 
 1. User obtains a list of books by listing (<<Use case: UC1 - View my reading list, *UC1*>>)
  or searching (<<Use case: UC2 - Search for books,*UC2*>>).
-2. User requests to give a rating to a specific book in the list.
+2. User requests to give a rate to a specific book in the list.
 3. Bibliotek shows a success message.
 +
 Use case ends.
 
 *Extensions*
 
 [none]
-* 2a. The given rating is out of range.
+* 2a. The given rate is out of range.
 +
 [none]
-** 2a1. Bibliotek says that the rating is invalid and asks user to try again.
+** 2a1. Bibliotek says that the rate is invalid and asks user to try again.
 +
 Use case resumes at step 2
 

src/main/java/seedu/address/logic/parser/CliSyntax.java

@@ -11,5 +11,6 @@ public class CliSyntax {
     public static final Prefix PREFIX_DESCRIPTION = new Prefix("d/");
     public static final Prefix PREFIX_ISBN = new Prefix("i/");
     public static final Prefix PREFIX_TITLE = new Prefix("t/");
+    public static final Prefix PREFIX_RATING = new Prefix("r/");
 
 }

src/main/java/seedu/address/logic/parser/ParserUtil.java

@@ -13,6 +13,7 @@
 import seedu.address.model.book.Author;
 import seedu.address.model.book.Category;
 import seedu.address.model.book.Description;
+import seedu.address.model.book.Rating;
 import seedu.address.model.book.Title;
 
 /**
@@ -125,4 +126,23 @@ public static Optional<Description> parseDescription(Optional<String> descriptio
         return description.isPresent() ? Optional.of(parseDescription(description.get())) : Optional.empty();
     }
 
+    /**
+     * Parses a {@code String rate} into a {@code Rating}.
+     * Leading and trailing whitespaces will be trimmed.
+     */
+    public static Rating parseRating(int rating) {
+        requireNonNull(rating);
+        return new Rating(rating);
+    }
+
+    /**
+     * Parses a {@code Optional<String> rate} into an {@code Optional<Rating>}
+     * if {@code rating} is present.
+     * See header comment of this class regarding the use of {@code Optional} parameters.
+     */
+    public static Optional<Rating> parseRating(Optional<Integer> rating) {
+        requireNonNull(rating);
+        return rating.isPresent() ? Optional.of(parseRating(rating.get())) : Optional.empty();
+    }
+
 }

src/main/java/seedu/address/model/book/Book.java

@@ -18,6 +18,7 @@ public class Book {
     private final Title title;
     private final UniqueList<Category> categories;
     private final Description description;
+    private final Rating rating;
     private final Gid gid;
     private final Isbn isbn;
     private final PublicationDate publicationDate;
@@ -35,6 +36,21 @@ public Book(Gid gid, Isbn isbn, Set<Author> authors, Title title, Set<Category>
         this.title = title;
         this.categories = new UniqueList<>(categories);
         this.description = description;
+        this.rating = new Rating(-1);
+        this.publicationDate = publicationDate;
+        this.publisher = publisher;
+    }
+
+    public Book(Gid gid, Isbn isbn, Set<Author> authors, Title title, Set<Category> categories,
+                Description description, Rating rating, Publisher publisher, PublicationDate publicationDate) {
+        requireAllNonNull(gid, isbn, authors, title, categories, description, publisher, publicationDate);
+        this.gid = gid;
+        this.isbn = isbn;
+        this.authors = new UniqueList<>(authors);
+        this.title = title;
+        this.categories = new UniqueList<>(categories);
+        this.description = description;
+        this.rating = rating;
         this.publicationDate = publicationDate;
         this.publisher = publisher;
     }
@@ -63,6 +79,10 @@ public Description getDescription() {
         return description;
     }
 
+    public Rating getRating() {
+        return rating;
+    }
+
     public Gid getGid() {
         return gid;
     }

src/main/java/seedu/address/model/book/Rating.java

@@ -0,0 +1,41 @@
+package seedu.address.model.book;
+
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Represents a book's rate.
+ * Guarantees: immutable.
+ */
+public class Rating {
+
+    public final Integer rating;
+
+    /**
+     * Constructs a {@code Description}.
+     *
+     * @param rating A book rating.
+     */
+    public Rating(Integer rating) {
+        requireNonNull(rating);
+        this.rating = rating;
+    }
+
+
+    @Override
+    public String toString() {
+        return rating.toString();
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof Rating // instanceof handles nulls
+                && this.rating.equals(((Rating) other).rating)); // state check
+    }
+
+    @Override
+    public int hashCode() {
+        return rating.hashCode();
+    }
+
+}

src/main/java/seedu/address/network/api/google/BookDeserializer.java

@@ -36,7 +36,6 @@ public class BookDeserializer extends StdDeserializer<Book> {
     public Book deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException {
         JsonRoot root = jp.readValueAs(JsonRoot.class);
         JsonVolumeInfo volumeInfo = root.volumeInfo;
-
         Isbn isbn = getIsbnFromIndustryIdentifiers(volumeInfo.industryIdentifiers);
 
         if (isbn == null) {
@@ -46,7 +45,8 @@ public Book deserialize(JsonParser jp, DeserializationContext ctxt) throws IOExc
         return new Book(new Gid(root.id), isbn,
                 BookDataUtil.getAuthorSet(volumeInfo.authors), new Title(volumeInfo.title),
                 getCategorySet(volumeInfo.categories), getDescription(volumeInfo.description),
-                new Publisher(volumeInfo.publisher), new PublicationDate(volumeInfo.publishedDate));
+                new Publisher(volumeInfo.publisher),
+                new PublicationDate(volumeInfo.publishedDate));
     }
 
     private Isbn getIsbnFromIndustryIdentifiers(JsonIndustryIdentifiers[] iiArray) {

src/main/java/seedu/address/network/api/google/BookShelfDeserializer.java

@@ -48,7 +48,6 @@ public BookShelf deserialize(JsonParser jp, DeserializationContext ctxt) throws
     /** Converts a JsonVolume into a Book, and add it into the book shelf. */
     private void convertAndAddBook(BookShelf bookShelf, JsonVolume volume, Gid gid) {
         JsonVolumeInfo volumeInfo = volume.volumeInfo;
-
         Isbn isbn = getIsbnFromIndustryIdentifiers(volumeInfo.industryIdentifiers);
 
         if (isbn == null) {
@@ -60,6 +59,7 @@ private void convertAndAddBook(BookShelf bookShelf, JsonVolume volume, Gid gid)
                 BookDataUtil.getAuthorSet(volumeInfo.authors), new Title(volumeInfo.title),
                 BookDataUtil.getCategorySet(volumeInfo.categories), new Description(volumeInfo.description),
                 new Publisher(volumeInfo.publisher), new PublicationDate(volumeInfo.publishedDate));
+
         try {
             bookShelf.addBook(book);
         } catch (DuplicateBookException e) {

src/main/java/seedu/address/storage/XmlAdaptedBook.java

@@ -16,6 +16,7 @@
 import seedu.address.model.book.Isbn;
 import seedu.address.model.book.PublicationDate;
 import seedu.address.model.book.Publisher;
+import seedu.address.model.book.Rating;
 import seedu.address.model.book.Title;
 
 /**
@@ -34,6 +35,8 @@ public class XmlAdaptedBook {
     @XmlElement(required = true)
     private String description;
     @XmlElement(required = true)
+    private Integer rating;
+    @XmlElement(required = true)
     private String publisher;
     @XmlElement(required = true)
     private String publicationDate;
@@ -53,16 +56,36 @@ public XmlAdaptedBook() {}
      * Constructs an {@code XmlAdaptedBook} with the given book details.
      */
     public XmlAdaptedBook(String gid, String isbn, String title, String description,
+                           List<XmlAdaptedAuthor> authors, List<XmlAdaptedCategory> categories,
+                           String publisher, String publicationDate) {
+        this.title = title;
+        this.description = description;
+        this.rating = -1;
+        if (authors != null) {
+            this.authors = new ArrayList<>(authors);
+        }
+        if (categories != null) {
+            this.categories = new ArrayList<>(categories);
+        }
+        this.gid = gid;
+        this.isbn = isbn;
+        this.publicationDate = publicationDate;
+        this.publisher = publisher;
+    }
+
+    public XmlAdaptedBook(String gid, String isbn, String title, String description, Integer rate,
                           List<XmlAdaptedAuthor> authors, List<XmlAdaptedCategory> categories,
                           String publisher, String publicationDate) {
         this.title = title;
         this.description = description;
+        this.rating = -1;
         if (authors != null) {
             this.authors = new ArrayList<>(authors);
         }
         if (categories != null) {
             this.categories = new ArrayList<>(categories);
         }
+        this.rating = rate;
         this.gid = gid;
         this.isbn = isbn;
         this.publicationDate = publicationDate;
@@ -79,6 +102,7 @@ public XmlAdaptedBook(Book source) {
         isbn = source.getIsbn().isbn;
         title = source.getTitle().title;
         description = source.getDescription().description;
+        rating = source.getRating().rating;
         authors = new ArrayList<>();
         for (Author author : source.getAuthors()) {
             authors.add(new XmlAdaptedAuthor(author));
@@ -118,6 +142,12 @@ public Book toModelType() throws IllegalValueException {
         }
         final Description description = new Description(this.description);
 
+        if (this.rating == null) {
+            throw new IllegalValueException(String.format(MISSING_FIELD_MESSAGE_FORMAT,
+                    Rating.class.getSimpleName()));
+        }
+        final Rating rating = new Rating(this.rating);
+
         if (this.gid == null) {
             throw new IllegalValueException(String.format(MISSING_FIELD_MESSAGE_FORMAT,
                     Gid.class.getSimpleName()));
@@ -143,7 +173,7 @@ public Book toModelType() throws IllegalValueException {
         final PublicationDate publicationDate = new PublicationDate(this.publicationDate);
 
         return new Book(gid, isbn, new HashSet<>(bookAuthors), title,
-                new HashSet<>(bookCategories), description, publisher, publicationDate);
+                new HashSet<>(bookCategories), description, rating, publisher, publicationDate);
     }
 
     @Override
@@ -159,6 +189,7 @@ public boolean equals(Object other) {
         XmlAdaptedBook otherBook = (XmlAdaptedBook) other;
         return Objects.equals(title, otherBook.title)
                 && Objects.equals(description, otherBook.description)
+                && Objects.equals(rating, otherBook.rating)
                 && authors.equals(otherBook.authors)
                 && categories.equals(otherBook.categories)
                 && Objects.equals(gid, otherBook.gid)

src/test/data/XmlBookShelfStorageTest/invalidAndValidBookBookShelf.xml

@@ -4,6 +4,7 @@
     <books>
         <title>Artemis</title>
         <description>This is Artemis.</description>
+        <rating>Rate</rating>
         <authors>Andy Weir</authors>
         <categories>Fiction</categories>
         <gid>ry3GjwEACAAJ</gid>

src/test/data/XmlSerializableBookShelfTest/typicalBooksBookShelf.xml

@@ -3,6 +3,7 @@
     <books>
         <title>Artemis</title>
         <description>This is Artemis.</description>
+        <rating>-1</rating>
         <authors>Andy Weir</authors>
         <categories>Fiction</categories>
         <gid>ry3GjwEACAAJ</gid>
@@ -13,6 +14,7 @@
     <books>
         <title>Babylon's Ashes</title>
         <description>This is Babylon's Ashes.</description>
+        <rating>-1</rating>
         <authors>James S. A. Corey</authors>
         <categories>Fiction</categories>
         <gid>3jsYCwAAQBAJ</gid>
@@ -23,6 +25,7 @@
     <books>
         <title>The Collapsing Empire</title>
         <description>This is The Collapsing Empire.</description>
+        <rating>-1</rating>
         <authors>John Scalzi</authors>
         <categories>Fiction</categories>
         <gid>2SoaDAAAQBAJ</gid>
@@ -33,6 +36,7 @@
     <books>
         <title>Consider Phlebas</title>
         <description>This is Consider Phlebas.</description>
+        <rating>-1</rating>
         <authors>Iain M. Banks</authors>
         <categories>Fiction</categories>
         <categories>Science Fiction</categories>
@@ -44,6 +48,7 @@
     <books>
         <title>Waking Gods</title>
         <description>This is Waking Gods.</description>
+        <rating>-1</rating>
         <authors>Sylvain Neuvel</authors>
         <categories>Fiction</categories>
         <categories>Science Fiction</categories>

src/test/data/XmlUtilTest/missingBookField.xml

@@ -2,6 +2,7 @@
 <!-- Book with missing title field -->
 <book>
     <description>This is Artemis.</description>
+    <rating>-1</rating>
     <authors>Andy Weir</authors>
     <categories>Fiction</categories>
 </book>

src/test/data/XmlUtilTest/tempBookShelf.xml

@@ -3,6 +3,7 @@
     <books>
         <title>Artemis</title>
         <description>This is Artemis.</description>
+        <rating>-1</rating>
         <authors>Andy Weir</authors>
         <categories>Fiction</categories>
         <githubUsername></githubUsername>
@@ -13,7 +14,12 @@
     <books>
         <title>Babylon's Ashes</title>
         <description>This is Babylon's Ashes.</description>
+        <rating>-1</rating>
         <authors>James S. A. Corey</authors>
         <categories>Fiction</categories>
+        <githubUsername></githubUsername>
+        <street></street>
+        <postalCode></postalCode>
+        <city></city>
     </books>
 </bookshelf>

src/test/data/XmlUtilTest/validBook.xml

@@ -1,12 +1,13 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 
 <book>
+    <gid>ry3GjwEACAAJ</gid>
+    <isbn>9780525572664</isbn>
     <title>Artemis</title>
     <description>This is Artemis.</description>
+    <rating>-1</rating>
     <authors>Andy Weir</authors>
     <categories>Fiction</categories>
-    <gid>ry3GjwEACAAJ</gid>
-    <isbn>9780525572664</isbn>
-    <publisher></publisher>
+    <publisher> </publisher>
     <publicationDate>2017-11-14</publicationDate>
 </book>

src/test/data/XmlUtilTest/validBookShelf.xml

@@ -3,6 +3,7 @@
     <books>
         <title>Artemis</title>
         <description>This is Artemis.</description>
+        <rating>-1</rating>
         <authors>Andy Weir</authors>
         <categories>Fiction</categories>
         <gid>ry3GjwEACAAJ</gid>
@@ -13,6 +14,7 @@
     <books>
         <title>Babylon's Ashes</title>
         <description>This is Babylon's Ashes.</description>
+        <rating>-1</rating>
         <authors>James S. A. Corey</authors>
         <categories>Fiction</categories>
         <gid>3jsYCwAAQBAJ</gid>
@@ -23,6 +25,7 @@
     <books>
         <title>The Collapsing Empire</title>
         <description>This is The Collapsing Empire.</description>
+        <rating>-1</rating>
         <authors>John Scalzi</authors>
         <categories>Fiction</categories>
         <gid>2SoaDAAAQBAJ</gid>
@@ -33,6 +36,7 @@
     <books>
         <title>Waking Gods</title>
         <description>This is Waking Gods.</description>
+        <rating>-1</rating>
         <authors>Sylvain Neuvel</authors>
         <categories>Fiction</categories>
         <categories>Science Fiction</categories>