Backend Module 2 paired Rails project, weeks 2 and 3
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
README.md Clarifications based on project feedback and progress checkins. Oct 19, 2018

README.md

Book Club

Backend Module 2 paired Rails project, weeks 2 and 3

Background and Description

This purpose of this application is for users to browse and review books. The primary goal of this challenge is testing your ability to set up many-to-many relationships and accessing attributes through multiple models.

Learning Goals for this Project

  • creation of a basic Rails web application
  • implementing basic MVC structure to your project
  • save and retrieve data from a database
  • display content on a web page with some very basic styling
  • learning how to test your code effectively at a Controller and a Model level

Requirements

  • must use Rails 5.1.x
  • must use PostgreSQL
  • all controller and model code must be tested via feature tests and model tests, respectively
  • must use some amount of HTML and CSS layout

Not Allowed

  • ask instructors in your public channel before adding any gems to your project
  • do not use JavaScript to sort content on a page

User Stories

These user stories may be worked on in any order that makes sense to your team. The most optimal order may not be a top-to-bottom approach.

Book Index Page

As a Visitor,
When I visit a book index page,
I see all book titles in the database.
Each book entry on the page shows the author(s) and number of 
pages in the book, and the year it was published.
As a Visitor,
When I visit the book index page,
Next to each book title, I see its average book rating
And I also see the total number of reviews for the book.
As a Visitor,
When I visit the book index page,
I should see one link each to sort the books by the following criteria:
- sorted by average rating in ascending order
- sorted by average rating in descending order
- sorted by number of pages in ascending order
- sorted by number of pages in descending order
- sorted by number of reviews in ascending order
- sorted by number of reviews in descending order
As a Visitor,
When I visit the book index page,
I see an area showing statistics about all books:
- three of the highest-rated books (book title and rating score)
- three of the worst-rated books (book title and rating score)
- three users who have written the most reviews (user name and review count)

Book Show Page

As a Visitor,
When I visit a book's show page,
I see the book title, the author(s) and the number of pages
in the book.
I also see a list of reviews for that book.

Each review will have a title and user, a numeric rating
from 1 to 5, and text for the review itself, and all content
must be present for each review.
As a Visitor,
When I visit a book's show page,
I see an area on the page for statistics about reviews
containing information such as:
- the top three reviews for this book (title, rating and user only)
- the bottom three reviews for this book  (title, rating and user only)
- the overall average rating of all reviews for this book

Adding New Content

As a Visitor,
When I visit the book index page,
I see a link that allows me to add a new book.
When I click that link, I am taken to a new book path.
I can add a new book through a form, including the book's
title, author(s), and number of pages in the book.
When I submit the form, I am taken to that book's show page.

Book titles should be converted to Title Case before saving.
Book titles should be unique within the system.
For authors, a comma-separated list of names should be entered,
and each author will be added to the database.
Authors added to the database should have their names converted
to Title Case.
Author Names should be unique within the system.
As a Visitor,
When I visit a book's show page
I see a link to add a new review for this book.
When I click on this link, I am taken to a new review path.
On this new page, I see a form where I can enter:
- a review title
- my username as a string
- a numeric rating that can only be a number from 1 to 5
- some text for the review itself
When the form is submitted, I should return to that book's
show page and I should see my review text.

User names should be converted to Title Case before saving.
User names should be unique within the system.

Author Show Page

As a Visitor,
When I visit an author's show page
I see all book titles by that author
And each book should show its year of publication, number of 
  pages and any other authors excluding the author that this show 
  page is about.
As a Visitor,
When I visit an author's show page,
Next to each book written by that author, I should see one of
the highest rated reviews for the book (title, score, and user name).

User Show Page

As a Visitor,
When I click on a user's name for any book review
I am taken to a show page for that user.
I should see all reviews (title, rating and text) that this 
user has written.
I should also see links to sort reviews in the following ways:
- sort reviews newest first (descending chronological order)
- sort reviews oldest first (ascending chronological order)

Deleting Content

As a Visitor,
When I visit a user's show page,
I see a link next to each review to delete the review.
When I delete a review I am returned to the user's show page
Then I should no longer see that review.
As a Visitor,
When I visit a book's show page,
I see a link on the page to delete the book.
This link should return me to the book index page where I
no longer see this book listed.

(you may need to delete other content before you can delete the book)
As a Visitor,
When I visit an author's show page,
I see a link on the page to delete the author.
This link should return me to the book index page where I
no longer see this author listed.
If this author was the only author for any book, that book is also deleted.

(you may need to delete other content before you can delete the author or book)

Linking All The Things

As a Visitor,
With the exception of a book's show page,
Anywhere I see a book title on the site,
I can click on the book title to go to that book's show page.
As a Visitor,
With the exception of an author's show page,
Anywhere I see an author's name on the site,
I can click on the name to go to that author's show page.
As a Visitor,
With the exception of a user's show page,
Anywhere I see a user's name on the site for a book review,
I can click on the name to go to that user's show page.

Extensions

If you finish the user stories above before the deadline, you are expected to attempt extension work. Extensions should not be attempted until all other work is complete.

As a Visitor,
I should not be permitted to save a book review using a name
I've previously used to review a specific book.
As a Visitor,
When I visit a user's show page to see their reviews,
I see additional links to sort their reviews in the following ways:
- sort reviews by highest rating, then by descending date
- sort reivews by lowest rating, then by ascending date
As a Visitor,
When I visit the book index page,
In the Statistics area of the page,
I should also see three authors who have the highest-rated books
As a Developer
I will spend additional time on HTML layout and styling
to create a visually oustanding project

Rubric

Each paired team will have a rubric uploaded to https://github.com/turingschool/ruby-submissions

Feature Completeness

4 - All user stories are 100% complete and additional extension work was attempted.
3 - All user stories are 100% complete.
2 - At least 12 user stories are complete but not all stories are 100% finished.
1 - Fewer than 12 user stories are complete.

MVC Responsibilities

4 - Views only display data and do not make additional calls to the database; they may include branch logic. Controllers request all data from Models except .all or .find calls and only do .create and .delete methods for writing data. Models read/write all other data using branch logic or smaller methods.
3 - Views make some calls to the database for .each calls and branch logic. Controllers push almost all work to the Models for reading/writing. Models sufficiently process and retrieve data.
2 - Views contain logic that make significant additional calls to the database including Model class methods. Controllers do a signficant amount of processing of data that should exist at a model level. Models process data in a way that is ineffcient, or contains work that determins presentation logic (how data might get viewed).
1 - Views, Controllers, and Models do not have a clear sense of resonsibilities.

ActiveRecord

4 - Highly effective and efficient use of ActiveRecord beyond what we've taught in class or by this point in the Obstacle Course. Even calling .each methods will not cause additional database lookups from the database.
3 - ActiveRecord is used in a clear and effective way to read/write data using almost no Ruby to process data.
2 - Significant number of places where Ruby is used to process data that could use ActiveRecord instead.
1 - Little or no ActiveRecord methods are used to read/write data; Ruby code was written to process most data.

Testing

4 - Very clear test-driven development. Test files are extremely well organized and nested and utilize before(:each) blocks for sharing test setups. 100% test coverage for features, and 100% of all model methods is tested.
3 - 98% or better test coverage for features, and all model methods are 100% tested.
2 - Many portions of code are missing tests.
1 - Testing is extremely poor, or not done.

User Experience and Styling/Layout

4 - Extremely well styled and purposeful layout. Excellent color scheme and font usage. Easy to use and follow the application workflow. Utilizes additional tooling like SCSS.
3 - Added a purposeful styling pattern and HTML layout using /app/views/application.html.erb and /app/assets/stylesheets/application.css. User workflow is easy to use with links to reach all areas of the site.
2 - Styling is poor, or incomplete. Layout does not utilize good HTML patterns. User workflow has significant problems and URIs have to managed manually.
1 - Little or no styling or layout. User workflow is significantly problematic.