0b1

[michaeloboyle]

Summary of Changes

Rails Helper Configuration

• Configured rails_helper.rb with DatabaseCleaner and Capybara settings.

Testing Enhancements

• Added feature tests for user sign-in, viewing top stories, and marking stories as interesting.
• Added model tests for fetching top stories and story details from Hacker News API.
• Used WebMock to stub external API calls in tests.

Story Model and Migration

• Created Story model with methods to fetch data from Hacker News API.
• Added validation to InterestingStory model to prevent duplicate entries.

Database Schema

• Updated schema with stories and interesting_stories tables.

Routes

• Defined routes for stories and interesting_stories resources.
• Added custom route for marking stories as interesting.

Controllers

• Created StoriesController with index and mark_interesting actions.
• Created InterestingStoriesController with index action.

Views

• Created views for displaying top stories and interesting stories.
• Implemented navigation bar in application.html.erb.
• Added flash message display in application.html.erb.

Prevent Duplicate Entries

• Added validation and unique index to interesting_stories table to prevent duplicate entries.

CSS and Style

• Added basic CSS styling for navigation bar and flash messages.

Areas of Potential Improvement

Additional Test Scenarios

• Implement tests involving multiple users to ensure proper handling of concurrent actions.
• Add tests for edge cases, such as users marking the same story as interesting simultaneously.

Additional Validations

• Implement validations to ensure data integrity, such as ensuring that story IDs are valid.
• Add user input validations for any forms to enhance security and user experience.

Performance Improvements

• Implement caching for API requests to reduce load times and dependency on external services.
• Optimize database queries to improve performance, especially for large datasets.

Potential Enhancements

• Implement a feature for users to comment on interesting stories.
• Add user roles and permissions to manage access control and functionality.
• Enhance the UI with more advanced CSS and JavaScript for better user experience.

System Architecture Diagram

graph TD
  A[User] -->|Signs in| B(Devise Authentication)
  A -->|Views top stories| C(StoriesController#index)
  A -->|Marks story as interesting| D(StoriesController#mark_interesting)
  C -->|Fetch top stories| E[Hacker News API]
  D -->|Fetch story details| E[Hacker News API]
  C -->|Display stories| F[View: stories/index]
  D -->|Save interesting story| G[InterestingStory Model]
  G -->|Display interesting stories| H[InterestingStoriesController#index]
  H -->|Show interesting stories| I[View: interesting_stories/index]
  I -->|Navigation| J[Navigation Bar]

Loading