Application Source Code

https://github.com/tessssssssy/terminal-app

Purpose of the application

My application is an exercise planning and recording app. The application has multiple features. Users can schedule future workouts and log past workouts, recording workout type, distance, duration and date. They can also check off workouts as completed and view workout stats

What problem is this app trying to solve

This application aims to be a motivational tool to encourage people to get more exercise. It builds users accountability to an exercise plan by allowing them to plan future workouts and check them off as they are completed.

Target Audience

The app is intended for anyone who is interested in starting an exercise plan and want to record their workouts. The app is focused on exercises with the ability to record time and distance, including running, cycling, swimming, walking and hiking so would be particularly suited to people who are interested in those activities.

How the audience will use the application

Users will use the application to create their own exercise plan, log and check off completed workouts and to calculate and monitor their monthly activity totals.

Application Features

  1. Users can log completed workouts and record details icluding:
  • workout type: run, ride, swim or walk/hike
  • distance
  • duration
  • date completed

  1. Users can schedule future workouts in the same way they log past ones. Recording the planned workout type, distance, duration and the date they want to complete it.

  2. View a table of all workouts and their details. These are colour coded, with different colours for completed, incomplete past workouts and future planned workouts.

  3. Users can check off completed activities. This will change the colour of the activity in the view table. When a past activity is logged, it is checked completed automatically.

  4. Get workout stats. Users can view the total distance and duration for each workout type, and see their longest workouts by distance and duration. Users can choose to see totals and personal records for a specific months or view all.

User Interaction

  1. Users will type their name/username as a command line argument when they run the application

  2. The user will choose an option from a main menu:

  3. add activity

  4. show activities

  5. check completed activity

  6. get stats

  7. quit: quits the application

  8. The user will then be directed to one of the sub menus:

  9. add activity: asked to input activity type, distance, duration and date

  10. show activities: displays a table listing all the users activities

  11. check-completed-activities: asks the user for a date, then shows a list of activities on that date for the user to check off

  12. get stats: asks user to enter activity type and month, then shown a table of activity totals/personal records

  13. If the user ever enters an invalid input, the application will detect it and ask them to try again

User Interaction Diagram

User Interaction Diagram

Implementation Plan

Develop an implementation plan which:

  • outlines how each feature will be implemented and a checklist of tasks for each feature
  • prioritise the implementation of different features, or checklist items within a feature
  • provide a deadline, duration or other time indicator for each feature or checklist/checklist-item

Utilise a suitable project management platform to track this implementation plan

Your checklists for each feature should have at least 5 items.

Structure

The application will be written using a Model, View, Controller (MVC) type structure

  • The model will interact with and manipulate user data taken from user input and stored in a csv file. It will also send data to the display class to display to the user

  • The controller is responsible for taking user input and controlling the flow of the application. It sends user input to the model where it is processed and stored on a csv file

  • The display class will take user data from the model and display it in a visually appealing way to the user

  • An Activity class will be used to create a blueprint for activity objects

  • A csv file will be allocated to each user to store their activities

Features

  1. Main Menu
  2. create a menu method in controller class
  3. direct user to various sub menus/features
  4. use a loop to continue showing user menu options until they quit app
  5. install tty prompt gem to create more user friendly menu

  6. handle user input errors

  7. Add Activity

  8. Create an activity class with type, distance, duration, date parameters

  9. Create a method in controller that takes user input

  10. Create method in model that processes user input and creates activity object

  11. Append new activity to csv file

  12. Show Activities

  13. need a method to get activities from csv file and add to an array

  14. method in display class to display data in a presentable way

  15. use terminal-table gem to display the activities as a table

  16. sort data to show newest activities first

  17. Check off completed activities

  18. create a method to search for activities by date

  19. method to handle user input

  20. method to take selected activity and set completed

  21. change color of completed activity in display class

  22. auto set complete if a user logs a past activity

  23. Delete Activity

  24. method to search for activity to delete

  25. handle user input

  26. remove activity from activities array

  27. method to update the csv file

  28. redirect to main menu if no activities to delete

  29. Get Stats

  30. method to calculate total distance/time

  31. Display method to show totals

  32. method to find longest activities

  33. Display method to show longest activities

  34. method to handle user input - sub menu to enter activity type, month

Project Management

I will be utilizing trello for project management

trello

Testing

Manual Testing documentation

https://docs.google.com/spreadsheets/d/1gCTDmCn7aAHaRTZWpWSsw2kVUnW_tdpHwY4TgpYB4J0/edit?usp=sharing

Installation


gem install terminal-app

Gemfile


gem 'terminal-app', '~> 0.1.2'

Install Dependencies

bundle install

Running the application

ruby terminal-app <username>

Instructions

  1. Enter a username as a command line argument

  2. If it is a new user, a file will be created to store the users activities, otherwise, the username will be matched to their corresponding csv file with their stored data.

Command Line Interface

Main Menu

Main Menu

Show Activities

Show Activities

Check Completed sub-menu

Check Completed

Delete Activity sub-menu

Delete

Get Stats

Get Stats