Project Plan

[danwells]

Planning Steps for the Project

(Should follow the project requirements.)

• All team members are welcome to contribute their ideas and edit others.

[danwells]

Named person should concentrate on that part of the plan but everyone should contribute in all areas. Jay - concentrate on tasks model Kait - concentrate on groups model Todd - concentrate on events model Dan - concentrate on users model

Planning areas (from requirements):

• [ ] Describe Model requirements (classes/database tables)
• [ ] Describe View requirements (windows to be used in application)
• [ ] Describe Controller requirements (control features)
  • [ ] Routes
  • [ ] Paths/Names
  • [ ] Controller actions/methods
• [ ] Security issues
  • [ ] User name/password
  • [ ] Authentication/validation

[danwells]

Snapshot of our Planning Board

Not sure if it will be helpful for planning, but there it is.

[danwells]

Project Description

A web application that provides user services for creating, customizing, and storing "to do" checklists for various events.

• Events describe single overarching activities ranging from long duration (e.g., a vacation or business trip) to short duration (e.g., grocery shopping, afternoon at the beach).
• Event checklist items can populated by selecting from one or more categories containing checklist tasks/items that are relevant to that category's topic (e.g., tasks for travel planning, going swimming, sightseeing, house maintenance, etc.)
• Categories may also be created, customized, and stored by a user.
• Individual checklist items (tasks) may be created ad-hoc and inserted into an event checklist
• Users should sign-up for an account in order to store their event checklists for modifications and re-use at a later time

[danwells]

View Requirements

• Layout containing view (application.html.erb)
  • Container view with common application titles/links/menu items
  • Specific views displayed in the "yield area"
  • Something like this:

Root view

• sign in
• log in

• logo

  

Dashboard

• Split window
  • Top portion would have a "Welcome #{user name}" message with additional user information as needed
  • Left side contains lists of events and/or categories
  • Right side contains list of task items populated from selected event categories or custom tasks entered ad-hoc
• Embed partial views/forms from the other model views

User views

• app/views/users/show.html.erb
  • EDIT ACCOUNT PAGE
  • displays user account info and possibly a summary of their stored events
  • link to edit user page
  • link to delete user (sends to destroy user route)
• app/views/users/new.html.erb (displays form for user account sign up)
• app/views/users/edit.html.erb (displays form for user account editing)

Sign up views

Login views

• app/views/logins/new.html.erb (displays form for user log in)

• Group views
  • app/views/groups/...
  • new.html.erb (?)
  • edit.html.erb (?)

[danwells]

Controller Requirements

• DashboardController:
  • List/Index view of combined User/Event/Category/Task information
• UserController RESTful routes needed (6 of 7):
  • Show user - Present view to show user's account information and possibly summary of stored events
  • New user - Present view with form for new user account
  • Create user - Creates new entry in users table
  • Edit user - Present view with form for editing user account info
  • Update user - Updates user information in users table
  • Destroy user - Removes user account information from users table
• LoginsController RESTful routes needed (3 of 7):
  • New login - Present view with login form
  • Create login
  • Find and authenticate user
  • Set session[:user_id] variable or raise a "Login failed" error
  • Destroy login - Set session[:user_id] variable to nil
• EventController RESTful routes needed (7 of 7):
  • Index event
  • Show event
  • New event
  • Create event
  • Edit event
  • Update event
  • Destroy event
• GroupController RESTful routes needed (7 of 7):
  • Index groups
  • Show group
  • New group
  • Create group
  • Edit group
  • Update group
  • Destroy group
• TaskController RESTful routes needed (7 of 7):
  • Index tasks
  • Show task
  • New task
  • Create task
  • Edit task
  • Update task
  • Destroy task

[danwells]

Security Issues

• User password stored in users table as password_digest hash
• Email will be validated for uniqueness and will be used for password matching
• Emulate Sumeet's code-along security methods in the ApplicationController:
  • ApplicationController#authorize method to check if user is already logged into the session. If not, send to new_login route to allow the user to log in.
  • ApplicationController#current_user private helper method to return User object if session[:user_id] variable has been set or nil if not

[danwells]

TO DO

• Generate milestones
• Research and generate more detail in page designs
• Determine user notification mechanism (email, twilio, ...)

[kaitlynhova]

Model Requirements

User class - users table

id	fname	lname	email	phone	password_digest
integer	string	string	string	string

• has_secure_password
• attr_accessible :fname, :lname, :email, :phone, :password, :password_confirmation
• has_many :events
• validates :email, :uniqueness => true
• Minimum information fields (first name, last name, email)
• Security related fields (password digest)
• Session variable: session[:user_id]
• Optional/Future fields (page theme preferences, checklist display styles, ...)

Event class - events table

id	name	due	user_id
integer	string	date	integer

• has_many :categories
• belongs_to :user
• Minimum information fields (name:string, user_id:integer, due_date:date)

Group class - groups table

id	name	event_id
integer	string	integer

• has_many :tasks
• belongs_to :event
• Minimum information fields (name:string, event_id:integer)

Task class - tasks table

id	description	done	category_id
integer	string	boolean	integer

• belongs_to :category
• Minimum information fields (description:string, done:boolean, category_id:integer)