Merge pull request #2 from KevFan/rebase

Rebase

Author: KevFan

README.md

@@ -1,3 +1,44 @@
-# web_assignment2_gym_app
+# Web Assignment 2 - Play Framework Gym Applet
+
+### Purpose Of Project:
+The project uses the play framework to develop a gym applet to allows member's of a gym to register and login to access their list of assessments if any, to add assessments and to generate some simple analytics such as BMI.
+
+A trainer can also log in, view a list of members he manages, update comment for assessments and delete members.
+
+### How to start project:
+The project is build using play framework 1.4.4. The project has not been tested in any other play framework versions.
+
+### User Instructions:
+To start the project, download/clone the repository and run the play run command at the project directory.
+
+Alternative, if the project is deployed, you can visit <link>   
+
+Note: Website is intended for use on a desktop - some functionality such as change in opacity on hover or pop up text on hover may not work as intended when viewed on a mobile system
+
+### Feature List:
++ Session information
++ Assessments - sorted by date
++ Member - registration
++ Member - add assessments
++ Member - delete assessments
++ Member - update account details
++ Trainer - update assessment comment
++ Trainer - delete member
+
+### Notes: 
++ Trainer can delete member assessments but this logs the trainer out afterwards due to view redirection in the delete assessments method
++ Trainer can only view members that he/she manages, therefore newly registered member's that are not assigned to a trainer cannot be viewed
++ There is no sign up available for a Trainer
+
+### List of Software + Technologies Used
++ Play Framework 1.4.4
++ Heroku (if deployed)
+
+
+### Authors:
+Kevin Fan
+
+
+### Version/Date:
+16th May 2017
 
-Test commit

app/Bootstrap.java

@@ -1,17 +1,17 @@
-import java.util.List;
-
-        import play.*;
-        import play.jobs.*;
-        import play.test.*;
-
-        import models.*;
+import play.jobs.*;
+import play.test.*;
+import models.*;
 
 /**
+ * Class that loads the data yml file to the play database
  * Created by kevin on 04/04/2017.
  */
 
 @OnApplicationStart
 public class Bootstrap extends Job {
+    /**
+     * Method that loads the data.yml file when there are no members in the database
+     */
     public void doJob() {
         if(Member.count() == 0) {
             Fixtures.loadModels("data.yml");

app/controllers/About.java

@@ -3,10 +3,15 @@
 import play.*;
 import play.mvc.*;
 
-public class About extends Controller
-{
-  public static void index() {
-    Logger.info("Rendering about");
-    render ("about.html");
-  }
+/**
+ * Controller class to render the abouts page
+ */
+public class About extends Controller {
+    /**
+     * Method to log and render the about.html page
+     */
+    public static void index() {
+        Logger.info("Rendering about");
+        render("about.html");
+    }
 }

app/controllers/Accounts.java

@@ -5,24 +5,51 @@
 import play.mvc.Controller;
 
 /**
+ * Controller class to control the accounts of Member and Trainers
  * Created by kevin on 08/04/2017.
  */
 public class Accounts extends Controller {
+    /**
+     * Method that render's the signup.html view
+     */
     public static void signup() {
         render("signup.html");
     }
 
+    /**
+     * Method that render's the login.html view
+     */
     public static void login() {
         render("login.html");
     }
 
+    /**
+     * Method that registers a new member to the gym applet.
+     * @param name Name of the Member
+     * @param gender Gender of the Member
+     * @param email Email of the Member
+     * @param password Password of the Member
+     * @param address Address of the Member
+     * @param height Height of the Member
+     * @param startingWeight Starting Weight of the Member
+     */
     public static void register(String name, String gender, String email, String password, String address, double height, double startingWeight) {
-        Logger.info("Registering new user " + email);
-        Member member = new Member(name, gender, email, password, address, height, startingWeight);
-        member.save();
-        redirect("/");
+        if (Member.findByEmail(email) != null || Trainer.findByEmail(email) != null) {
+            Logger.info("User email already used");
+            redirect("/");
+        } else {
+            Logger.info("Registering new user " + email);
+            Member member = new Member(name, gender, email, password, address, height, startingWeight);
+            member.save();
+            redirect("/");
+        }
     }
 
+    /**
+     * Method that authenticate the passed in email and password to an existing member/trainer's account
+     * @param email Email of the member/trainer
+     * @param password Password of the account
+     */
     public static void authenticate(String email, String password) {
         Logger.info("Attempting to authenticate with " + email + ":" + password);
         Trainer trainer = Trainer.findByEmail(email);
@@ -42,11 +69,18 @@ public static void authenticate(String email, String password) {
         }
     }
 
+    /**
+     * Method to end the session
+     */
     public static void logout() {
         session.clear();
         redirect("/");
     }
 
+    /**
+     * Method to return the Member of the current session
+     * @return Member of the current session if logged in successfully
+     */
     public static Member getLoggedInMember() {
         Member member = null;
         if (session.contains("logged_in_Memberid")) {
@@ -58,6 +92,10 @@ public static Member getLoggedInMember() {
         return member;
     }
 
+    /**
+     * Method to return the Trainer of the current session
+     * @return Trainer of the current session if logged in successfully
+     */
     public static Trainer getLoggedInTrainer() {
         Trainer trainer = null;
         if (session.contains("logged_in_Tainerid")) {

app/controllers/Admin.java

@@ -8,11 +8,15 @@
 import play.mvc.Controller;
 
 /**
+ * Controller that renders the trainer account session view
  * Created by kevin on 04/04/2017.
  */
 public class Admin extends Controller {
+    /**
+     * Method that renders the the trainer view of the list of member's he manages
+     */
     public static void index() {
-        Logger.info("Rendering Admin");
+        Logger.info("Rendering Trainer view");
 
         Trainer trainer = Accounts.getLoggedInTrainer();
         List<Member> memberList = trainer.memberList;

app/controllers/Dashboard.java

@@ -8,7 +8,13 @@
 import java.util.Collections;
 import java.util.List;
 
+/**
+ * Class that serves as the Controller for the main dashboard for a Member
+ */
 public class Dashboard extends Controller {
+    /**
+     * Renders the dashboard for the current member, and their assessments sorted in reverse order
+     */
     public static void index() {
         Logger.info("Rendering Dashboard");
         Member member = Accounts.getLoggedInMember();
@@ -17,6 +23,15 @@ public static void index() {
         render("dashboard.html", member, assessmentlist);
     }
 
+    /**
+     * Adds a new assessment for the member
+     * @param weight Weight measurement of the assessment
+     * @param chest Chest measurement of the assessment
+     * @param thigh Thigh measurement of the assessment
+     * @param upperArm Upper Arm measurement of the assessment
+     * @param waist Waist measurement of the assessment
+     * @param hips Hips measurement of the assessment
+     */
     public static void addAssessment(double weight, double chest, double thigh, double upperArm, double waist, double hips) {
         Member member = Accounts.getLoggedInMember();
         Assessment assessment = new Assessment(weight, chest, thigh, upperArm, waist, hips);
@@ -26,6 +41,11 @@ public static void addAssessment(double weight, double chest, double thigh, doub
         redirect("/dashboard");
     }
 
+    /**
+     * Deletes an assessment from the current member's list of assessments
+     * @param id Member id
+     * @param assessmentid Assessment id
+     */
     public static void deleteAssessment(Long id, Long assessmentid) {
         Member member = Member.findById(id);
         Assessment assessment = Assessment.findById(assessmentid);
@@ -35,114 +55,4 @@ public static void deleteAssessment(Long id, Long assessmentid) {
         Logger.info("Deleting Assessment");
         redirect("/dashboard");
     }
-
-    /**
-     * This method calculates the BMI value for the member.
-     * <p>
-     * The formula used for BMI is weight divided by the square of the height.
-     *
-     * @return the BMI value for the member.  The number returned is truncated to two decimal places.
-     **/
-    public static double calculateBMI() {
-        Member member = Accounts.getLoggedInMember();
-        if (member.height <= 0)
-            return 0;
-        else if (member.assessmentlist.size() != 0) {
-            return toTwoDecimalPlaces(member.assessmentlist.get(0).weight / ((member.height * member.height)));
-        } else {
-            return toTwoDecimalPlaces(member.startingWeight / (member.height * member.height));
-        }
-    }
-
-    /*
-     * This is a private helper method.  It ensures that all double data returned from this class
-     * is restricted to two decimal places.  Note:  this method does not round
-     */
-    private static double toTwoDecimalPlaces(double num) {
-        return (int) (num * 100) / 100.0;
-    }
-
-
-    /**
-     * This method determines the BMI category that the member belongs to.
-     * <p>
-     * <pre>
-     *
-     * The category is determined by the magnitude of the members BMI according to the following:
-     *
-     *     BMI less than    15   (exclusive)                      is "VERY SEVERELY UNDERWEIGHT"
-     *     BMI between      15   (inclusive) and 16   (exclusive) is "SEVERELY UNDERWEIGHT"
-     *     BMI between      16   (inclusive) and 18.5 (exclusive) is "UNDERWEIGHT"
-     *     BMI between      18.5 (inclusive) and 25   (exclusive) is "NORMAL"
-     *     BMI between      25   (inclusive) and 30   (exclusive) is "OVERWEIGHT"
-     *     BMI between      30   (inclusive) and 35   (exclusive) is "MODERATELY OBESE"
-     *     BMI between      35   (inclusive) and 40   (exclusive) is "SEVERELY OBESE"
-     *     BMI greater than 40   (inclusive)                      is "VERY SEVERELY OBESE"
-     *
-     * </pre>
-     *
-     * @return <pre>
-     * The format of the String is similar to this (note the double quotes around the category):
-     *     "NORMAL".
-     * </pre>
-     */
-    public static String determineBMICategory() {
-        double bmi = calculateBMI();
-
-        if (bmi < 15) return "VERY SEVERELY UNDERWEIGHT";
-        else if (bmi < 16) return "SEVERELY UNDERWEIGHT";
-        else if (bmi < 18.5) return "UNDERWEIGHT";
-        else if (bmi < 25) return "NORMAL";
-        else if (bmi < 30) return "OVERWEIGHT";
-        else if (bmi < 35) return "MODERATELY OBESE";
-        else if (bmi < 40) return "SEVERELY OBESE";
-        else return "VERY SEVERELY OBESE";
-    }
-
-    /**
-     * This method returns a boolean to indicate if the member has an ideal
-     * body weight based on the Devine formula.
-     * <p>
-     * <pre>
-     * For males, an ideal body weight is:   50 kg + 2.3 kg for each inch over 5 feet.
-     * For females, an ideal body weight is: 45.5 kg + 2.3 kg for each inch over 5 feet.
-     *
-     * Note:  if no gender is specified, return the result of the female calculation.
-     *
-     * </pre>
-     *
-     * @return Returns true if the result of the devine formula is within 2 kgs (inclusive) of the
-     * starting weight; false if it is outside this range.
-     */
-    public static boolean isIdealBodyWeight() {
-        Member member = Accounts.getLoggedInMember();
-        double fiveFeet = 60.0;
-        double idealBodyWeight;
-
-        double inches = member.height * 39.37;
-
-        if (inches <= fiveFeet) {
-            if (member.gender.equals("M")) {
-                idealBodyWeight = 50;
-            } else {
-                idealBodyWeight = 45.5;
-            }
-        } else {
-            if (member.gender.equals("M")) {
-                idealBodyWeight = 50 + ((inches - fiveFeet) * 2.3);
-            } else {
-                idealBodyWeight = 45.5 + ((inches - fiveFeet) * 2.3);
-            }
-        }
-
-        if (member.assessmentlist.isEmpty()) {
-            return ((idealBodyWeight <= (member.startingWeight + 2.0))
-                    && (idealBodyWeight >= (member.startingWeight - 2.0))
-            );
-        } else {
-            return ((idealBodyWeight <= (member.assessmentlist.get(0).weight + 2.0))
-                    && (idealBodyWeight >= (member.assessmentlist.get(0).weight - 2.0))
-            );
-        }
-    }
 }