Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fire - Alice D #46

Open
wants to merge 67 commits into
base: master
Choose a base branch
from
Open

Conversation

codeandmorecode
Copy link

Media Ranker

Congratulations! You're submitting your assignment!

Comprehension Questions

Question Answer
What was a custom model method you wrote? What was it responsible for doing? My Work class custom method category_organized takes in a category (i.e. book or album or movie) and is applied onto the whole work class. It returns all the works whose category is the one indicated, in decreasing order of vote count.
Describe how you approached testing that model method. What edge cases did you come up with? I created a before block with books, albums, movies, and users; then specifically for this method, I tested if "it returns an empty list if there are no records for a category" (which is an edge case). I also tested if "it returns expected results when there is data (which is a nominal case). Then I tested if it "returns an empty list when we pass in a category that does not exist", (which is an edge case). Then I tested if it "returns a list of work for each of the three categories (this is a nominal case). Lastly, I tested if it "returns a list of work in descending order of number of votes", and did that for each of the categories for consistency (and those are nominal cases).
What are session and flash? What is the difference between them? Session can be used to keep track of some information for the length of time that we have the browser open or until we end the session (for example: we can use session to hold the username and display to user that they are logged in with a message "Successfully logged in as "). Flash on the other hand, only lasts the length of a request cycle plus one. Flash is mostly used to display messages to user, for example "Your work was successfully added."
What was one thing that you gained more clarity on through this assignment? I gained more clarity on how to use yml files and fixtures among many other things.
What is the Heroku URL of your deployed application? https://aliced-media-ranker.herokuapp.com/

Assignment Submission: Media Ranker

Congratulations! You're submitting your assignment. Please reflect on the assignment with these questions.

Reflection

Prompt Response
What was a custom model method you wrote? What was it responsible for doing? My Work class custom method category_organized takes in a category (i.e. book or album or movie) and is applied onto the whole work class. It returns all the works whose category is the one indicated, in decreasing order of vote count.
Describe how you approached testing that model method. What edge cases did you come up with? I created a before block with books, albums, movies, and users; then specifically for this method, I tested if "it returns an empty list if there are no records for a category" (which is an edge case). I also tested if "it returns expected results when there is data (which is a nominal case). Then I tested if it "returns an empty list when we pass in a category that does not exist", (which is an edge case). Then I tested if it "returns a list of work for each of the three categories (this is a nominal case). Lastly, I tested if it "returns a list of work in descending order of number of votes", and did that for each of the categories for consistency (and those are nominal cases).
What are session and flash? What is the difference between them? Session can be used to keep track of some information for the length of time that we have the browser open or until we end the session (for example: we can use session to hold the username and display to user that they are logged in with a message "Successfully logged in as "). Flash on the other hand, only lasts the length of a request cycle plus one. Flash is mostly used to display messages to user, for example "Your work was successfully added."
What was one thing that you gained more clarity on through this assignment? I gained more clarity on how to use yml files and fixtures among many other things.
What is the Heroku URL of your deployed application? https://aliced-media-ranker.herokuapp.com/

Copy link

@jmaddox19 jmaddox19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Media Ranker

Great work!

Please checkout the comments I added to the rubric and the comments I made inline in your code to see areas for improvement. Overall, you accomplished the mean learning goals and did a great job! There are just a few little areas for growth :)

You made a whole site with so much interactive functionality that supports signin from many users! This is a big deal! I hope you've been able to celebrate this!

Also great job with your very thorough testing!!

Functional Requirements: Manual Testing

Criteria yes/no
Before logging in --
1. On index page, there are at most 10 pieces of media on three lists, and a Media Spotlight ✔️
2. Can go into a work's show page ✔️
3. Verify unable to vote on a work, and get a flash message Results in a generic 404 page, which is not particularly user-friendly
4. Can edit this work successfully, and get a flash message ✔️
5. Can go to "View all media" page and see three lists of works, sorted by vote ✔️
6. Verify unable to create a new work when the form is empty, and details about the validation errors are visible to the user through a flash message ✔️
7. Can create a new work successfully. Note the URL for this work's show page ✔️
8. Can delete this work successfully ✔️
9. Going back to the URL of this deleted work's show page produces a 404 or some redirect behavior (and does not try to produce a broken view) ✔️
10. Verify that the "View all users" page lists no users ✔️
Log in --
11. Logging in with a valid name changes the UI to "Logged in as" and "Logout" buttons No "Logged in as" button
12. Your username is listed in "View all users" page ✔️
13. Verify that number of votes determines the Media Spotlight ✔️
14. Voting on several different pieces of media affects the "Votes" tables shown in the work's show page and the user's show page Navigating to User show page results in the following error: undefined method vote_count'`
15. Voting on the same work twice produces an error and flash message, and there is no extra vote ✔️
Log out --
16. Logging out showed a flash message and changed the UI ✔️
17. Logging in as a new user creates a new user ✔️
18. Logging in as an already existing user has a specific flash message ✔️

Major Learning Goals/Code Review

Criteria yes/no
1. Sees the full development cycle including deployment, and the app is deployed to Heroku ✔️ Yes! Awesome! This wasn't meant to be required but I'm so glad you were able to get it done!
2. Practices full-stack development and fulfilling story requirements: the styling, look, and feel of the app is similar to the original Media Ranker
3. Practices git with at least 25 small commits and meaningful commit messages ✔️ Yes! SO MANY commits and they have brief descriptive messages :D

Previous Rails learning, Building Complex Model Logic, DRYing up Rails Code

Criteria yes/no
4. Routes file uses resources for works ✔️
5. Routes file shows intention in limiting routes for voting, log-in functionality, and users There is opportunity for more intentionality in limiting the votes routes
6. The homepage view, all media view, and new works view use semantic HTML ✔️
7. The homepage view, all media view, and new works view use partials when appropriate ✔️ Yes! Great use of partials!
8. The model for media (likely named work.rb) has_many votes ✔️
9. The model for media has methods to describe business logic, specifically for top ten and top media, possibly also for getting works by some category ✔️
10. Some controller, likely the ApplicationController, has a controller filter for finding a logged in user ✔️
11. Some controller, likely the WorksController, has a controller filter for finding a work ✔️
12. The WorksController uses strong params ✔️
13. The WorksController's code style is clean, and focused on working with requests, responses, params, session, flash ✔️ Absolutely!

Testing Rails Apps

Criteria yes/no
14. There are valid fixtures files used for users, votes, and works ✔️
15. User model has tests with sections on validations (valid and invalid) and relationships (has votes) ✔️
16. Vote model has tests with sections on validations (valid and invalid) and relationships (belongs to a user, belongs to a vote) ✔️
17. Work model has tests with sections on validations (valid and invalid) and relationships (has votes) ✔️
18. Work model has tests with a section on all business logic methods in the model, including their edge cases ✔️

Overall Feedback

Overall Feedback Criteria yes/no
Green (Meets/Exceeds Standards) 14+ in Functional Requirements: Manual Testing && 14+ in Code Review ✔️
Yellow (Approaches Standards) 12+ in Functional Requirements: Manual Testing && 11+ in Code Review, or the instructor judges that this project needs special attention
Red (Not at Standard) 0-10 in Code Review or 0-11 in Functional Reqs, or assignment is breaking/doesn’t run with less than 5 minutes of debugging, or the instructor judges that this project needs special attention

Code Style Bonus Awards

Was the code particularly impressive in code style for any of these reasons (or more...?)

Quality Yes?
Perfect Indentation
Elegant/Clever
Descriptive/Readable
Concise
Logical/Organized

Comment on lines +14 to +15
flash.now[:error] = "User not found"
head :not_found

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
flash.now[:error] = "User not found"
head :not_found
flash[:error] = "You must be logged in to vote"
redirect_back fallback_location: root_path

I honestly wish we'd never taught the use of head because we've since learned much better ways to handle these sorts of situations that I'd recommend you use instead (namely, render or redirect_to). I don't know if you ever tried this out, but it results in a generic browser error page so the user never sees the flash message.
In this specific case, because you'd ideally like to return to whatever page the user was already on, there's a nice method called redirect_back that a lot of students did a little internet searching to find :)

<%= form_with model: @work do |f| %>

<p><%= f.label :category %></p>
<p><%= f.text_area :category %></p>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious why some of these are text_area types and some are text_fields types.
text_area types are intended when the user is expected to enter full sentences or paragraphs, which I don't think is true of any of these fields except perhaps description.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making them text_area when they are probably just a word or two just makes for a slightly more awkward appearance on the browser.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also for category specifically, given that it must be one of the categories already created, it'd be much nicer to have made this a dropdown.
Otherwise the user must memorize the exact names of the categories to create a product.

<th>Work Category</th>
<th>Work Title</th>

<p>Acutal number of votes by this user: <%= @user.vote_count %></p>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vote_count method doesn't exist on the user model so this results in an error.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>Acutal number of votes by this user: <%= @user.vote_count %></p>
<p>Acutal number of votes by this user: <%= @user.votes.size %></p>


root to: "homepages#index"

resources :votes

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only route that is actually used in VotesController is create so all the other routes shouldn't be included here.

Comment on lines +32 to +41
def index
@votes = Vote.all
end

def show
if @vote.nil?
head :not_found
return
end
end

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no views for these so they aren't actually accessible, which is totally ok! We don't necessarily need to support all 7 "restful routes" for every controller. In this case, the only one your app actually supports is create. So it would be cleaner if this code were removed, since it isn't being used.

Suggested change
def index
@votes = Vote.all
end
def show
if @vote.nil?
head :not_found
return
end
end

Comment on lines +52 to +57
<%= render partial: "spotlight", locals: {work: @spotlight} %>


<%= render partial: "table_top10", locals: {header: "Albums", works: @albums} %>
<%= render partial: "table_top10", locals: {header: "Books", works: @books} %>
<%= render partial: "table_top10", locals: {header: "Movies", works: @movies} %>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the user of partials here! So clean!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants