Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-12-05T04:31:45Z

Nthanik:

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-12-05T04:27:23Z

Nthanik:

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-12-05T04:26:48Z

Nthanik:

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-12-05T04:26:10Z

Nthanik:

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-12-05T04:25:31Z

Nthanik:

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-12-05T04:22:42Z

Nthanik:

E1682. Improve score calculation

== Introduction ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Purpose ===
The purpose of the project is to improve the functionality of score calculation. The scores in expertiza were calculated by taking the sum of weighted scores to calculate the total every time it is called. This takes considerable amount of time as there is a calculation involved each time. The methodology behind score calculation in expertiza can be significantly improved. The design behind calculating and storing scores can be tweaked to offer significant performance improvements. To achieve this, it is ideal to store overall holistic stores in addition to individual criterion scores.

=== Problem Statement ===
The current drawback of the expertiza system lies in how the scores are stored: Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. As a result of this mechanism, the process slows down. This means that if we need to know what score user A gives to user B based on 100, we have to rely on the code to calculate it (since in answers table we only have the score that A gives B on each criterion).

To overcome this bottleneck, two additional mechanisms can be included for handling the holistic scores.

== Overall Description ==
Expertiza currently calculates scores dynamically when a page is called by taking the weighted scores of each question into consideration. This calculation is a time consuming process with a considerable overhead that significantly affects the performance. To solve the issue we propose a solution to store the holistic scores in a database, retrieving it every time it is required. This reduces the calculation that is required every time the score is called. When the user wants to check the scores of a completed assignment, a method localDB_calc is called and expertiza retrieves the scores of the student from the database rather than calculating the total from weighted scores. But, when the scores of an ongoing assignment is required, a method on_the_fly_calc is called that calculates the current score of the user. To determine which method will be invoked(on_the_fly_calc and localDB_calc), the current system time will be compared with last_review_deadline
* If system time is greater than last_review_deadline, indicating that the deadline has passed, the method localDbcal will retrieve the holistic score from the database
* If system time is lesser than last_review_deadline, indicating that the deadline has not passed, the method on_the_fly_cal will calculate the holistic score and display it.

== *FLOW CHART ==

== Tasks Identified ==
The two suggested mechanisms for handling the storage and calculation of holistic scores for peer-reviews, as specified in the requirements document are :
* on_the_fly_calc
* localDB_calc

=== on_the_fly_calc ===
When the assignment is still ongoing , this method is called and it calculates holistic scores over a set of data (in this case, a set of record in answers table, namely the responses from user A to user B on each criterion) and store it in localdbscores. This stored score is retrieved and printed when the user A clicks on the "Your scores" link.

In the current implementation, when a user A wants to view the score given by user B, user A's score(i.e. out of 100) will be calculated everytime using the scores given by user B for each criterion (i.e.. score out of 5).

Handles the calculation of reputations for each reviewer in the case of an ongoing assignment.

=== localDB_calc ===
Once the deadline for an assignment is completed, the method localDB_calc calculates the holistic score over a single db query (in this case, a query would be: “get the score that user A gives user B on assignment 999 on round 2”). The query can also ask to print the average of all the scores in round 1 and round2, this average will be retrieved from localdbscores and printed.

This method handles the calculation of reputations for each reviewer in the case of a finished assignment. (all the reputations are calculated and stored since they are finalized).

=== Database ===
To store the holistic scores when an assignment is completed, a database localdbscores needs to be created. The value from this db is retrieved and displayed when the scores of a completed assignment needs to be viewed. The database Design is shown below.

== Database Design ==
A table localdbscores will be created as:

class CreateLocalDB<ActiveRecord::Migration

def self.up

create_table :localdb_scores do |t|

t.column :id, :integer

t.column :score, :integer

t.column :round, :integer

t.column :type, :string

t.column :reference_id, :integer

end

with id, score, round, type, reference_id as its attributes as shown in the table below

"localdbscores" will have the following scores
{| class="wikitable"
|
|t.integer "id", limit: 24
|id
|Primary Key, Auto generated
|-
|
|t.string "Type", limit: 255
|Type
|Type of score: either final or intermediate
|-
|
|t.integer "Score", limit: 24
|Score
|Total score calculated based on each response to each criterion
|-
|
|t.integer "Round", limit:24
|Round
|The completed round number
|-
|
|t.integer "Reference_id" , limit:45
|Reference_id
|Acts as the foreign Key
|}

== Implementation ==

=== Assignment.rb ===
A new function get_last_review_date is added which takes assignid as a parameter and returns the last review deadline of the assignment. The deadline obtained from AssignmentDueDate for the corresponding assignid is stored in last_review_deadline and is returned.

=== Parent Class:ScoreCal ===
ScoreCal stores the score calculated by its sub classes: on_the_fly_cal and LocalDbcal to the database. In the database, a new table localdbscore is created with the schema as explained in section 2.2. Depending upon the deadline_type, object of either on_the_fly_cal or LocalDbcal is created and the appropriate functions within the classes are called.

=== Sub class 1: on_the_fly_cal ===
This is a subclass of class Scorecal contains a method calc_score whose functionality is to compute the holistic score. An object of on_the_fly_cal is called when the current time has not yet surpassed the time stored in last_review_deadline variable which contains the review duedate indicating that the assignment is still ongoing and has not been completed. The individual scores are retrieved from the database ScoreView and is stored in QuestionnaireData from which the holistic score of a student is calculated .

When the user accesses the scores for a review, the current implementation does not store a holistic score but rather calculates the holistic score from the score for every individual criterion. To calculate the total holistic score for a specific round, the individual scores are weighted and added.

This functionality is achieved by on_the_fly_calc.

A snapshot of the system before implementing the changes is shown below.

=== Sub class 2: LocalDbcal ===
This is a subclass of Scorecal and contains a function calc_score in class localDbcal. An object of LocalDbcal is called when the current time has surpassed the time stored in last_review_deadline variable which contains the review due date indicating that the assignment has been completed. This subclass retrieves the score from the database localDbscores for a corresponding student. If the score is not found in the database localDbscores, the function calc_score of on_the_fly_cal class is called to calculate the total from the weighted scores of each question. This calculated score is then inserted into the database.

This score is now returned to the view from where it was called.

=== _review_table.html.erb ===
The current implementation of this was to calculate the score and display it which as we know is a time consuming process. It has been changed to check if the current time has crossed the last_review_deadline obtained in assignments.rb and call the corresponding class as required.

If the current date has surpassed the last_review_deadline, it is an indication that the due date has passed and the class localDbcal is called to retrieve a value from the database as mentioned above. On the other hand, on_the_fly_cal is called when the current date has not surpassed the last_review_deadline, indicating that the assignment is ongoing and the holistic score is calculated and passed to the view.

== Design Pattern ==
The ScoreCal superclass has 2 subclasses: OnTheFlyCal and LocalDbCal. ScoreCal acts as an interface to obtain the scores, either from OnTheFlyCal or LocalDbCal depending on the last_review_deadline obtained from the get_last_review_date() in the assignment model. This pattern is similar to strategy pattern where the client is the _review_tble.html.erb, interface is the superclass and the subclasses are called accordingly.
[[File:UseCaseDiagram2.png]]

== Implementation ==

=== Parent Class:ScoreCalc ===
ScoreCalc stores the score calculated by its sub classes: on_the_fly_calc and LocalDBcalc to the database. In the database, a new table local_db_scoresn is created with the schema as explained in section 2.2. Depending upon the deadline_type, object of either on_the_fly_calc or LocalDBcalc is created and the appropriate functions within the classes are called.

==== Database design ====
A table local_db_scores will be created as:

create_table "local_db_scores",force::cascade do|t|

"local_db_scores" will have the following scores
{| class="wikitable"
|
|t.integer "id", limit: 24
|id
|Primary Key, Auto generated
|-
|
|t.string "Type", limit: 255
|Type
|Type of score: either final or intermediate
|-
|
|t.integer "Score", limit: 24
|Score
|Total score calculated based on each response to each criterion
|-
|
|t.integer "Round", limit:24
|Round
|The completed round number
|-
|
|t.integer "Reference_id" , limit:45
|Reference_id
|Acts as the foreign Key
|}

=== Sub class 1: on_the_fly_calc ===
An object of on_the_fly_calc is called when the deadline_type is not "review of review" which means that the assignment is ongoing and has not been completed and stores the scores till the current stage that will change once the assignment passes the deadline

The function compute_total_scores(scores) is used to calculate the total score based on each response to each criterion. The function is as below:

def compute_total_scores(scores)

total=0

self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.

When the user accesses the scores for a review, the current implementation does not store a holistic score but rather calculates the holistic score from the score for every individual criterion. To calculate the total holistic score for a specific round, the individual scores are weighted and added.

This functionality is achieved by on_the_fly_calc.

The current system calculates the holistic score every single time from the individual criterion. A snapshot of the system before implementing the changes is shown below.

[[File:rsz_flycur.png]]

The proposed implementation involves computing the holistic score once and storing it in the local_db_scores database for a particular user and for a specified round. The stored value is accessed and obtained instead of computing the holistic score every single time.

[[File:rsz_flyadb.png]]

=== Sub class 2: LocalDB_calc ===
An object of LocalDB_calc is called when the deadline_type is "review of review" which means that the assignment is completed and stores the final score in the database local_db_scores after computing it rather than computing it every time the score is required.

Function compute_total_scores(scores) is added to the class which calculates the total score based on each response to each criterion. The function(polymorphism) is as below:

def compute_total_scores(scores)

total=0

self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.

The snapshots prior to and post implementation are shown below :

[[File:rsz_loccur.png]]

The proposed implementation retrieves the round wise scores from the local_db_scores database and displays the average score once the deadline has passed rather than computing the average of the weighted scores for every access of the page as shown below.

[[File:rsz_locadb.png]]

The Dataflow diagram (DFD) for the proposed system is shown below.

[[File:Flowchart12.png|center|frame|flowchart]]

== Testing ==
The testing for model: on_the_fly_calc is carried out by questionnaire_spec.rb in the spec folder. The minimum and maximum score that an user gives for each criterion is checked.

Two more test cases to check whether the average score of each review falls within a given range:(0,100) will be added.

For LocalDB_calc, the average calculated across round 1 and round 2 will be checked to fall within 0 to 100. These test cases will be added to questionnaire_spec.rb.

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-12-05T04:20:14Z

Nthanik:

E1682. Improve score calculation

== Introduction ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Purpose ===
The purpose of the project is to improve the functionality of score calculation. The scores in expertiza were calculated by taking the sum of weighted scores to calculate the total every time it is called. This takes considerable amount of time as there is a calculation involved each time. The methodology behind score calculation in expertiza can be significantly improved. The design behind calculating and storing scores can be tweaked to offer significant performance improvements. To achieve this, it is ideal to store overall holistic stores in addition to individual criterion scores.

=== Problem Statement ===
The current drawback of the expertiza system lies in how the scores are stored: Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. As a result of this mechanism, the process slows down. This means that if we need to know what score user A gives to user B based on 100, we have to rely on the code to calculate it (since in answers table we only have the score that A gives B on each criterion).

To overcome this bottleneck, two additional mechanisms can be included for handling the holistic scores.

== Overall Description ==
Expertiza currently calculates scores dynamically when a page is called by taking the weighted scores of each question into consideration. This calculation is a time consuming process with a considerable overhead that significantly affects the performance. To solve the issue we propose a solution to store the holistic scores in a database, retrieving it every time it is required. This reduces the calculation that is required every time the score is called. When the user wants to check the scores of a completed assignment, a method localDB_calc is called and expertiza retrieves the scores of the student from the database rather than calculating the total from weighted scores. But, when the scores of an ongoing assignment is required, a method on_the_fly_calc is called that calculates the current score of the user. To determine which method will be invoked(on_the_fly_calc and localDB_calc), the current system time will be compared with last_review_deadline
* If system time is greater than last_review_deadline, indicating that the deadline has passed, the method localDbcal will retrieve the holistic score from the database
* If system time is lesser than last_review_deadline, indicating that the deadline has not passed, the method on_the_fly_cal will calculate the holistic score and display it.

== *FLOW CHART ==

== Tasks Identified ==
The two suggested mechanisms for handling the storage and calculation of holistic scores for peer-reviews, as specified in the requirements document are :
* on_the_fly_calc
* localDB_calc

=== on_the_fly_calc ===
When the assignment is still ongoing , this method is called and it calculates holistic scores over a set of data (in this case, a set of record in answers table, namely the responses from user A to user B on each criterion) and store it in localdbscores. This stored score is retrieved and printed when the user A clicks on the "Your scores" link.

In the current implementation, when a user A wants to view the score given by user B, user A's score(i.e. out of 100) will be calculated everytime using the scores given by user B for each criterion (i.e.. score out of 5).

Handles the calculation of reputations for each reviewer in the case of an ongoing assignment.

=== localDB_calc ===
Once the deadline for an assignment is completed, the method localDB_calc calculates the holistic score over a single db query (in this case, a query would be: “get the score that user A gives user B on assignment 999 on round 2”). The query can also ask to print the average of all the scores in round 1 and round2, this average will be retrieved from localdbscores and printed.

This method handles the calculation of reputations for each reviewer in the case of a finished assignment. (all the reputations are calculated and stored since they are finalized).

=== Database ===
To store the holistic scores when an assignment is completed, a database localdbscores needs to be created. The value from this db is retrieved and displayed when the scores of a completed assignment needs to be viewed. The database Design is shown below.

== Database Design ==
A table localdbscores will be created as:

class CreateLocalDB<ActiveRecord::Migration

def self.up

create_table :localdb_scores do |t|

t.column :id, :integer

t.column :score, :integer

t.column :round, :integer

t.column :type, :string

t.column :reference_id, :integer

end

with id, score, round, type, reference_id as its attributes as shown in the table below

"localdbscores" will have the following scores
{| class="wikitable"
|
|t.integer "id", limit: 24
|id
|Primary Key, Auto generated
|-
|
|t.string "Type", limit: 255
|Type
|Type of score: either final or intermediate
|-
|
|t.integer "Score", limit: 24
|Score
|Total score calculated based on each response to each criterion
|-
|
|t.integer "Round", limit:24
|Round
|The completed round number
|-
|
|t.integer "Reference_id" , limit:45
|Reference_id
|Acts as the foreign Key
|}

== Implementation ==

=== Assignment.rb ===
A new function get_last_review_date is added which takes assignid as a parameter and returns the last review deadline of the assignment. The deadline obtained from AssignmentDueDate for the corresponding assignid is stored in last_review_deadline and is returned.

=== Parent Class:ScoreCal ===
ScoreCal stores the score calculated by its sub classes: on_the_fly_cal and LocalDbcal to the database. In the database, a new table localdbscore is created with the schema as explained in section 2.2. Depending upon the deadline_type, object of either on_the_fly_cal or LocalDbcal is created and the appropriate functions within the classes are called.

=== Sub class 1: on_the_fly_cal ===
This is a subclass of class Scorecal contains a method calc_score whose functionality is to compute the holistic score. An object of on_the_fly_cal is called when the current time has not yet surpassed the time stored in last_review_deadline variable which contains the review duedate indicating that the assignment is still ongoing and has not been completed. The individual scores are retrieved from the database ScoreView and is stored in QuestionnaireData from which the holistic score of a student is calculated .

When the user accesses the scores for a review, the current implementation does not store a holistic score but rather calculates the holistic score from the score for every individual criterion. To calculate the total holistic score for a specific round, the individual scores are weighted and added.

This functionality is achieved by on_the_fly_calc.

A snapshot of the system before implementing the changes is shown below.

=== Sub class 2: LocalDbcal ===
This is a subclass of Scorecal and contains a function calc_score in class localDbcal. An object of LocalDbcal is called when the current time has surpassed the time stored in last_review_deadline variable which contains the review due date indicating that the assignment has been completed. This subclass retrieves the score from the database localDbscores for a corresponding student. If the score is not found in the database localDbscores, the function calc_score of on_the_fly_cal class is called to calculate the total from the weighted scores of each question. This calculated score is then inserted into the database.

This score is now returned to the view from where it was called.

=== _review_table.html.erb ===
The current implementation of this was to calculate the score and display it which as we know is a time consuming process. It has been changed to check if the current time has crossed the last_review_deadline obtained in assignments.rb and call the corresponding class as required.

If the current date has surpassed the last_review_deadline, it is an indication that the due date has passed and the class localDbcal is called to retrieve a value from the database as mentioned above. On the other hand, on_the_fly_cal is called when the current date has not surpassed the last_review_deadline, indicating that the assignment is ongoing and the holistic score is calculated and passed to the view.

== Introduction ==

=== Purpose ===
The methodology behind score calculation in expertiza can be significantly improved. The design behind calculating and storing scores can be tweaked to offer significant performance improvements. To achieve this, it is ideal to store overall holistic stores in addition to individual criterion scores.

=== Problem Statement ===
The current drawback of the expertiza system lies in how the scores are stored: Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. As a result of this mechanism, the process slows down. This means that if we need to know what score user A gives to user B based on 100, we have to rely on the code to calculate it (since in answers table we only have the score that A gives B on each criterion).

To overcome this bottleneck, two additional mechanisms can be included for handling the holistic scores.

== Proposed changes ==
The two suggested mechanisms for handling the storage and calculation of holistic scores for peer-reviews, as specified in the requirements document are :
* on_the_fly_calc
* localDB_calc

=== on_the_fly_calc ===
Calculate holistic scores over a set of data (in this case, a set of record in answers table, namely the responses from user A to user B on each criterion) and store it in local_db_scores. This stored score is retrieved and printed when the user A clicks on the "Your scores" link.

In the current implementation, when a user A wants to view the score given by user B, user A's score(i.e. out of 100) will be calculated everytime using the scores given by user B for each criterion (i.e.. score out of 5).

Handles the calculation of reputations for each reviewer in the case of an ongoing assignment.

=== localDB_calc ===
Calculate the holistic score over a single db query (in this case, a query would be: “get the score that user A gives user B on assignment 999 on round 2”). The query can also ask to print the average of all the scores in round 1 and round2, this average will be retrieved from local_db_scores and printed.

Handles the calculation of reputations for each reviewer in the case of a finished assignment. (all the reputations are calculated and stored since they are finalized).

== Design Pattern ==
The ScoreCal superclass has 2 subclasses: OnTheFlyCal and LocalDbCal. ScoreCal acts as an interface to obtain the scores, either from OnTheFlyCal or LocalDbCal depending on the last_review_deadline obtained from the get_last_review_date() in the assignment model. This pattern is similar to strategy pattern where the client is the _review_tble.html.erb, interface is the superclass and the subclasses are called accordingly.
[[File:UseCaseDiagram2.png]]

== Implementation ==

=== Parent Class:ScoreCalc ===
ScoreCalc stores the score calculated by its sub classes: on_the_fly_calc and LocalDBcalc to the database. In the database, a new table local_db_scoresn is created with the schema as explained in section 2.2. Depending upon the deadline_type, object of either on_the_fly_calc or LocalDBcalc is created and the appropriate functions within the classes are called.

==== Database design ====
A table local_db_scores will be created as:

create_table "local_db_scores",force::cascade do|t|

"local_db_scores" will have the following scores
{| class="wikitable"
|
|t.integer "id", limit: 24
|id
|Primary Key, Auto generated
|-
|
|t.string "Type", limit: 255
|Type
|Type of score: either final or intermediate
|-
|
|t.integer "Score", limit: 24
|Score
|Total score calculated based on each response to each criterion
|-
|
|t.integer "Round", limit:24
|Round
|The completed round number
|-
|
|t.integer "Reference_id" , limit:45
|Reference_id
|Acts as the foreign Key
|}

=== Sub class 1: on_the_fly_calc ===
An object of on_the_fly_calc is called when the deadline_type is not "review of review" which means that the assignment is ongoing and has not been completed and stores the scores till the current stage that will change once the assignment passes the deadline

The function compute_total_scores(scores) is used to calculate the total score based on each response to each criterion. The function is as below:

def compute_total_scores(scores)

total=0

self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.

When the user accesses the scores for a review, the current implementation does not store a holistic score but rather calculates the holistic score from the score for every individual criterion. To calculate the total holistic score for a specific round, the individual scores are weighted and added.

This functionality is achieved by on_the_fly_calc.

The current system calculates the holistic score every single time from the individual criterion. A snapshot of the system before implementing the changes is shown below.

[[File:rsz_flycur.png]]

The proposed implementation involves computing the holistic score once and storing it in the local_db_scores database for a particular user and for a specified round. The stored value is accessed and obtained instead of computing the holistic score every single time.

[[File:rsz_flyadb.png]]

=== Sub class 2: LocalDB_calc ===
An object of LocalDB_calc is called when the deadline_type is "review of review" which means that the assignment is completed and stores the final score in the database local_db_scores after computing it rather than computing it every time the score is required.

Function compute_total_scores(scores) is added to the class which calculates the total score based on each response to each criterion. The function(polymorphism) is as below:

def compute_total_scores(scores)

total=0

self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.

The snapshots prior to and post implementation are shown below :

[[File:rsz_loccur.png]]

The proposed implementation retrieves the round wise scores from the local_db_scores database and displays the average score once the deadline has passed rather than computing the average of the weighted scores for every access of the page as shown below.

[[File:rsz_locadb.png]]

The Dataflow diagram (DFD) for the proposed system is shown below.

[[File:Flowchart12.png|center|frame|flowchart]]

== Testing ==
The testing for model: on_the_fly_calc is carried out by questionnaire_spec.rb in the spec folder. The minimum and maximum score that an user gives for each criterion is checked.

Two more test cases to check whether the average score of each review falls within a given range:(0,100) will be added.

For LocalDB_calc, the average calculated across round 1 and round 2 will be checked to fall within 0 to 100. These test cases will be added to questionnaire_spec.rb.

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-11-15T01:06:32Z

Nthanik:

E1682. Improve score calculation

== Introduction ==

=== Purpose ===
The methodology behind score calculation in expertiza can be significantly improved. The design behind calculating and storing scores can be tweaked to offer significant performance improvements. To achieve this, it is ideal to store overall holistic stores in addition to individual criterion scores.

=== Problem Statement ===
The current drawback of the expertiza system lies in how the scores are stored: Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. As a result of this mechanism, the process slows down. This means that if we need to know what score user A gives to user B based on 100, we have to rely on the code to calculate it (since in answers table we only have the score that A gives B on each criterion).

To overcome this bottleneck, two additional mechanisms can be included for handling the holistic scores.

== Proposed changes ==
The two suggested mechanisms for handling the storage and calculation of holistic scores for peer-reviews, as specified in the requirements document are :
* on_the_fly_calc
* localDB_calc

=== on_the_fly_calc ===
Calculate holistic scores over a set of data (in this case, a set of record in answers table, namely the responses from user A to user B on each criterion) and store it in local_db_scores. This stored score is retrieved and printed when the user A clicks on the "Your scores" link.

In the current implementation, when a user A wants to view the score given by user B, user A's score(i.e. out of 100) will be calculated everytime using the scores given by user B for each criterion (i.e.. score out of 5).

Handles the calculation of reputations for each reviewer in the case of an ongoing assignment.

=== localDB_calc ===
Calculate the holistic score over a single db query (in this case, a query would be: “get the score that user A gives user B on assignment 999 on round 2”). The query can also ask to print the average of all the scores in round 1 and round2, this average will be retrieved from local_db_scores and printed.

Handles the calculation of reputations for each reviewer in the case of a finished assignment. (all the reputations are calculated and stored since they are finalized).

=== Observer Pattern ===
Observer pattern will be used where the dependent:local_db_score will be updated when the deadline_type is changed. If the dead_line_type is anything other than "review of review", the weighted scores for each review will be calculated and scored in local_db_scores. If the deadline_type is "review of review", then the average of the weighted score for each round across users will be calculated and stored in local_db_score.

== Implementation ==

=== Parent Class:ScoreCalc ===
ScoreCalc stores the score calculated by its sub classes: on_the_fly_calc and LocalDBcalc to the database. In the database, a new table local_db_scoresn is created with the schema as explained in section 2.2. Depending upon the deadline_type, object of either on_the_fly_calc or LocalDBcalc is created and the appropriate functions within the classes are called.

==== Database design ====
A table local_db_scores will be created as:

create_table "local_db_scores",force::cascade do|t|

"local_db_scores" will have the following scores
{| class="wikitable"
|
|t.integer "id", limit: 24
|id
|Primary Key, Auto generated
|-
|
|t.string "Type", limit: 255
|Type
|Type of score: either final or intermediate
|-
|
|t.integer "Score", limit: 24
|Score
|Total score calculated based on each response to each criterion
|-
|
|t.integer "Round", limit:24
|Round
|The completed round number
|-
|
|t.integer "Reference_id" , limit:45
|Reference_id
|Acts as the foreign Key
|}

=== Sub class 1: on_the_fly_calc ===
An object of on_the_fly_calc is called when the deadline_type is not "review of review" which means that the assignment is ongoing and has not been completed and stores the scores till the current stage that will change once the assignment passes the deadline

The function compute_total_scores(scores) is used to calculate the total score based on each response to each criterion. The function is as below:

def compute_total_scores(scores)

total=0

self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.

When the user accesses the scores for a review, the current implementation does not store a holistic score but rather calculates the holistic score from the score for every individual criterion. To calculate the total holistic score for a specific round, the individual scores are weighted and added.

This functionality is achieved by on_the_fly_calc.

The current system calculates the holistic score every single time from the individual criterion. A snapshot of the system before implementing the changes is shown below.

The proposed implementation involves computing the holistic score once and storing it in the local_db_scores database for a particular user and for a specified round. The stored value is accessed and obtained instead of computing the holistic score every single time.
[[File:FlyADB.png|thumb|Proposed Implementation ]]
[[File:FlyCur.png|thumb|Current implementation]]

=== Sub class 2: LocalDB_calc ===
An object of LocalDB_calc is called when the deadline_type is "review of review" which means that the assignment is completed and stores the final score in the database local_db_scores after computing it rather than computing it every time the score is required.

Function compute_total_scores(scores) is added to the class which calculates the total score based on each response to each criterion. The function(polymorphism) is as below:

def compute_total_scores(scores)

total=0

self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.

The proposed implementation retrieves the round wise scores from the local_db_scores database and displays the average score once the deadline has passed rather than computing the average of the weighted scores for every access of the page.

The snapshots prior to and post implementation are shown below :
[[File:LocCur.png|thumb|Current System]]
[[File:LocADB.png|thumb|System after implementing changes]]
[[File:Flowchart12.png|center|frame|flowchart]]

== Testing ==
The testing for model: on_the_fly_calc is carried out by questionnaire_spec.rb in the spec folder. The minimum and maximum score that an user gives for each criterion is checked.

Two more test cases to check whether the average score of each review falls within a given range:(0,100) will be added.

For LocalDB_calc, the average calculated across round 1 and round 2 will be checked to fall within 0 to 100. These test cases will be added to questionnaire_spec.rb.

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-11-09T20:06:26Z

Nthanik:

E1682. Improve score calculation
=== LocalDBCalc: ===
Calculate the holistic score over a single db query (in this case, a query would be: “get the score that user A gives user B on assignment 999 on round 2”)

Handles the calculation of reputations for each reviewer in the case of a finished assignment. (all the reputations are calculated and stored since they are finalized)

== Implementation ==

=== Parent Class:ScoreCalc ===
ScoreCalc stores the score calculated by its sub classes: on_the_fly_calc and LocalDBcalc to the database. In the database, a new table local_db_scoresn is created with the schema as explained in section 2.2. Depending upon the deadline_type, object of either on_the_fly_calc or LocalDBcalc is created and the appropriate functions within the classes are called.

==== Database design ====
A table local_db_scores will be created as:

create_table "local_db_scores",force::cascade do|t|

"local_db_scores" will have the following scores
{| class="wikitable"
|
|t.integer "id", limit: 24
|id
|Primary Key, Auto generated
|-
|
|t.string "Type", limit: 255
|Type
|Type of score: either final or intermediate
|-
|
|t.integer "Score", limit: 24
|Score
|Total score calculated based on each response to each criterion
|-
|
|t.integer "Round", limit:24
|Round
|The completed round number
|-
|
|t.integer "Reference_id" , limit:45
|Reference_id
|Acts as the foreign Key
|}

=== Sub class 1: on_the_fly_calc ===
An object of on_the_fly_calc is called when the deadline_type is not "review of review" which means that the assignment is ongoing and has not been completed and stores the scores till the current stage that will change once the assignment passes the deadline

The function compute_total_scores(scores) is used to calculate the total score based on each response to each criterion. The function is as below:

def compute_total_scores(scores)

:total=0

:self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

:total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.

=== Sub class 2: LocalDB_calc ===
An object of LocalDB_calc is called when the deadline_type is "review of review" which means that the assignment is completed and stores the final score in the database local_db_scores after computing it rather than computing it every time the score is required.

Function compute_total_scores(scores) is added to the class which calculates the total score based on each response to each criterion. The function(polymorphism) is as below:

def compute_total_scores(scores)

:total=0

:self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

:total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.
[[File:Flowchart12.png]]

File:Flowchart12.png

2016-11-09T19:49:18Z

Nthanik:

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-11-09T19:48:59Z

Nthanik:

E1682. Improve score calculation

=== Sub class 1: on_the_fly_calc ===
An object of on_the_fly_calc is called when the deadline_type is not "review of review" which means that the assignment is ongoing and has not been completed and stores the scores till the current stage that will change once the assignment passes the deadline

The function compute_total_scores(scores) is used to calculate the total score based on each response to each criterion. The function is as below:

def compute_total_scores(scores)

total=0

self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.

=== Sub class 2: LocalDB_calc ===
An object of LocalDB_calc is called when the deadline_type is "review of review" which means that the assignment is completed and stores the final score in the database local_db_scores after computing it rather than computing it every time the score is required.

Function compute_total_scores(scores) is added to the class which calculates the total score based on each response to each criterion. The function(polymorphism) is as below:

def compute_total_scores(scores)

total=0

self.questionnaires.each{|questionnaire| total+=questionnaire.get_weighted_score(self,scores)}

total

end

The value in variable "total" needs to be stored in local_db_scores under "Score" and will be retrieved by using another function retrieve_total_score to display the total score instead of calculating it every time a user wants to view the scores.
[[File:Flowchart12.png]]

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-11-09T19:48:09Z

Nthanik:

CSC/ECE 517 Fall 2016 E1682: Improve score calculation

2016-11-09T19:47:42Z

Nthanik: Created page with "E1682. Improve score calculation === Sub class 1: on_the_fly_calc === An object of on_the_fly_calc is called when the deadline_type is not "review of review" which means that th..."

CSC/ECE 517 Fall 2016

2016-11-09T19:44:42Z

Nthanik: /* Final Project Design Document */

[http://www.example.com link title]==Calibration Assignment Submissions==
*[[Calibration Assignment Submission (Firebrick JS)]]
*[[Calibration Assignment Submission (Active Job)]]
==Writing Assignments 2==
*[[CSC/ECE 517 Fall 2016/E1666. Test team functionality]]
*[[CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller]]
*[[CSC/ECE 517 Fall 2016/E1631. Refactoring Bidding Interface]]
*[[CSC/ECE 517 Fall 2016/E1674.Refactor leaderboard.rb and write unit tests]]
*[[CSC/ECE 517 Fall 2016/E1671. Unit Tests for participants.rb Hierarchy]]
*[[CSC/ECE 517 Fall 2016/E1668.Test e-mailing functionality]]
*[[CSC/ECE 517 Fall 2016/E1658. Refractor lottery_controller.rb and write integration tests]]
*[[CSC/ECE 517 Fall 2016/E1660. Review requirements and thresholds]]
*[[CSC/ECE 517 Fall 2016/E1650. Sort instructor views alphabetically by default]]
*[[CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller]]
*[[CSC/ECE 517 Fall 2016/E1645. Refactoring Tree Display Controller]]
*[[CSC/ECE 517 Fall 2016/E1659. Refactor on_the_fly_calc.rb]]
*[[CSC/ECE 517 Fall 2016/E1657. Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2016/E1653. Fix and improve rubric criteria]]
*[[CSC/ECE 517 Fall 2016/E1642. Refactor review_response_map.rb]]
*[[CSC/ECE 517 Fall 2016/E1633. Refactor different question types from quiz feature]]
*[[CSC/ECE_517_Fall_2016/E1664:_Feature_Test_Assignment_Creation]]
*[[CSC/ECE 517 Fall 2016/E1666. Test team functionality]]
*[[CSC/ECE_517_Fall_2016/E1654. Improve_date-picker_and_deadlines]]
*[[CSC/ECE_517_Fall_2016/E1652 Fix teammate advertisements and requests to join a team ]]
*[[CSC/ECE_517_Fall_2016/E1662. UI issues/fixes]]
*[[CSC/ECE_517_Fall_2016/E1673. Refactor question_type.rb]]
*[[CSC/ECE_517_Fall_2016/E1675. Timestamp for student file & hyperlink submissions]]
*[[CSC/ECE_517_Fall_2016/E1640. Refactor response.rb and response_helper.rb]]
*[[CSC/ECE 517 Fall 2016/E1634. Refactor and write unit test of due_date.rb and deadline_helper.rb]]
*[[CSC/ECE_517_Fall_2016/M1654._Improve_network_security_features]]
*[[CSC/ECE_517_Fall_2016/E1670._Unit_tests_for_answers.rb]]
*[[CSC/ECE_517_Fall_2016/E1641. Refactor review_mapping_controller.rb]]
*[[CSC/ECE_517_Fall_2016/M1652_Implement_ImageMap_Support_Servo]]
*[[CSC/ECE_517_Fall_2016/E1648/Add_past_due_assignment]]
*[[CSC/ECE 517 Fall 2016/E1656. Improve imports]]
*[[CSC/ECE_517_Fall_2016/M1653_Implement_HTML_form_validation]]
==Final Project Design Document==
*[[CSC/ECE 517 Fall 2016 E1696 Improve Self-Review]]
*[[CSC/ECE 517 Fall 2016 E1676 Role-based reviewing]]
*[[CSC/ECE 517 Fall 2016/E1680. Improve survey functionality]]
*[[CSC/ECE 517 Fall 2016/E1693. Drag-and-drop interface for creating rubrics]]
*[[CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing]]
*[[CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions]]
*[[CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement]]
*[[CSC/ECE 517 Fall 2016 E1707: Top trading cycles to exclude previous teammates]]
*[[CSC/ECE 517 Fall 2016 E1678: Review configuration options]]
*[[CSC/ECE 517 Fall 2016 E1682: Improve score calculation]]

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-29T00:03:30Z

Nthanik: Blanked the page

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-29T00:01:47Z

Nthanik: Undo revision 102936 by Nthanik (talk)

Introduction
Expertiza
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

Code Climate
Code Climate[1] is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

Tasks Identified
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:

Due_date.rb
Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
Useless assignment to variable - `sorted_deadlines`.
Prefer `each` over `for`.
Use `find_by` instead of `where.first`.
Correct the use of Time function
Deadline_helper.rb
Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
Trailing whitespace detected.
Extra empty line detected at module body end.
Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.
Current Implementation
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

Changed Implementation
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are

Due_date.rb (path: /app/models)
Deadline_helper.rb (path: /app/helpers)
Testing files

Due_date_spec.rb (path: /spec/models)
Deadline_helper_spec.rb (path: /spec/helpers)
Due_date.rb
Converted for..in loop to object.each in order to follow better Ruby syntax.
Unnecessary assignment to sorted_deadlines removed.
Nested ternary operators have been changed to if..else in order to make it more readable.

Due_date.rb
Changed where(...).first to find_by(...) which is the newer recommended syntax.
Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
Removed trailing whitespaces.

Deadline_helper.rb
Time functions were changed to functions with zones
Extra line removed

Deadline_helper
RSpec testing
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

due_date_spec.rb
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.

If the factory is successfully able to build the due_date objects.
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
If the function "set_flag" successfully sets the due_date flag.
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
If the function "self.copy" is able to copy due dates from one assignment to another.
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
If the function "self.deadline_sort" is able to sort the due dates in ascending order.
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
To test this file run the following command:

rspec spec/models/due_date_spec.rb
The output of this RSpec file is present in below screenshot:

Code coverage details of the above RSpec files is present in below screenshot:

Code coverage details of the above RSpec files is present in below screenshot:

deadline_helper_spec.rb
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:

Check if the factory is valid:
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
Fail if the due date is invalid:
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
If new due_date object is created:
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
due_at should be same for 0 offset:
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
due_at is calculated correctly if offset is positive:
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
due_at is calculated correctly if offset is negative:
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
The offset is being converted to integer properly:
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
To test this file run the following command:

rspec spec/models/deadline_helper_spec.rb
The output of this RSpec file is present in below screenshot:

Code coverage details of the above RSpec files is present in below screenshot:

References
"Log in to your Code Climate dashboard with GitHub or your email.". codeclimate.com. Retrieved 2016-10-28.

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-29T00:01:35Z

Nthanik: Undo revision 102952 by Nthanik (talk)

'''Introduction
'''Expertiza
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

Code Climate
Code Climate[1] is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

Tasks Identified
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:

Due_date.rb
Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
Useless assignment to variable - `sorted_deadlines`.
Prefer `each` over `for`.
Use `find_by` instead of `where.first`.
Correct the use of Time function
Deadline_helper.rb
Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
Trailing whitespace detected.
Extra empty line detected at module body end.
Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.
Current Implementation
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

Changed Implementation
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are

Due_date.rb (path: /app/models)
Deadline_helper.rb (path: /app/helpers)
Testing files

Due_date_spec.rb (path: /spec/models)
Deadline_helper_spec.rb (path: /spec/helpers)
Due_date.rb
Converted for..in loop to object.each in order to follow better Ruby syntax.
Unnecessary assignment to sorted_deadlines removed.
Nested ternary operators have been changed to if..else in order to make it more readable.

Due_date.rb
Changed where(...).first to find_by(...) which is the newer recommended syntax.
Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
Removed trailing whitespaces.

Deadline_helper.rb
Time functions were changed to functions with zones
Extra line removed

Deadline_helper
RSpec testing
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

due_date_spec.rb
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.

If the factory is successfully able to build the due_date objects.
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
If the function "set_flag" successfully sets the due_date flag.
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
If the function "self.copy" is able to copy due dates from one assignment to another.
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
If the function "self.deadline_sort" is able to sort the due dates in ascending order.
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
To test this file run the following command:

rspec spec/models/due_date_spec.rb
The output of this RSpec file is present in below screenshot:

Code coverage details of the above RSpec files is present in below screenshot:

Code coverage details of the above RSpec files is present in below screenshot:

deadline_helper_spec.rb
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:

Check if the factory is valid:
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
Fail if the due date is invalid:
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
If new due_date object is created:
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
due_at should be same for 0 offset:
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
due_at is calculated correctly if offset is positive:
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
due_at is calculated correctly if offset is negative:
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
The offset is being converted to integer properly:
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
To test this file run the following command:

rspec spec/models/deadline_helper_spec.rb
The output of this RSpec file is present in below screenshot:

Code coverage details of the above RSpec files is present in below screenshot:

References
"Log in to your Code Climate dashboard with GitHub or your email.". codeclimate.com. Retrieved 2016-10-28.

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-29T00:01:22Z

Nthanik: Undo revision 103200 by Nthanik (talk)

== '''Introduction''' ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Code Climate ===
Code Climate<ref>{{Cite web|url=https://codeclimate.com/dashboard|title=Log in to your Code Climate dashboard with GitHub or your email.|website=codeclimate.com|access-date=2016-10-28}}</ref> is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

== '''Tasks Identified''' ==
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:
* Due_date.rb
** Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
** Useless assignment to variable - `sorted_deadlines`.
** Prefer `each` over `for`.
** Use `find_by` instead of `where.first`.
** Correct the use of Time function
* Deadline_helper.rb
** Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
** Trailing whitespace detected.
** Extra empty line detected at module body end.

* Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.

== '''Current Implementation''' ==
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

== '''Changed Implementation''' ==
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are
* Due_date.rb (path: /app/models)

* Deadline_helper.rb (path: /app/helpers)
Testing files
* Due_date_spec.rb (path: /spec/models)
* Deadline_helper_spec.rb (path: /spec/helpers)
=== Due_date.rb ===
* Converted for..in loop to object.each in order to follow better Ruby syntax.
* Unnecessary assignment to sorted_deadlines removed.
* Nested ternary operators have been changed to if..else in order to make it more readable.
**[[File:Duedaterb.png|thumb|Due_date.rb|center|500x500px]]
* Changed where(...).first to find_by(...) which is the newer recommended syntax.
* Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
* Removed trailing whitespaces.[[File:DueDaterb2.png|center|thumb|565x565px]]

=== Deadline_helper.rb ===
* Time functions were changed to functions with zones
* Extra line removed
[[File:Deadlinehelper.png|center|thumb|631x631px|Deadline_helper]]

== '''RSpec testing''' ==
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

=== due_date_spec.rb ===
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.
* If the factory is successfully able to build the due_date objects.<syntaxhighlight lang="ruby">
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
</syntaxhighlight>
* If the function "set_flag" successfully sets the due_date flag.<syntaxhighlight lang="ruby">
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
</syntaxhighlight>
* If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).<syntaxhighlight lang="ruby">
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
</syntaxhighlight>
* If the function "self.copy" is able to copy due dates from one assignment to another.<syntaxhighlight lang="ruby">
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
</syntaxhighlight>
* If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.<syntaxhighlight lang="ruby">
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
</syntaxhighlight>
* If the function "self.deadline_sort" is able to sort the due dates in ascending order.<syntaxhighlight lang="ruby">
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
</syntaxhighlight>
* If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.<syntaxhighlight lang="ruby">
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
</syntaxhighlight>
* If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.<syntaxhighlight lang="ruby">
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
</syntaxhighlight>
* If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.<syntaxhighlight lang="ruby">
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/due_date_spec.rb
</syntaxhighlight>
The output of this RSpec file is present in below screenshot:
[[File:Duedaterspec.png|center|thumb|558x558px]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Duedatecoverage.png|center|thumb|736x736px]]

Code coverage details of the above RSpec files is present in below screenshot:

=== deadline_helper_spec.rb ===
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:
* Check if the factory is valid:
<syntaxhighlight lang="ruby">
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
</syntaxhighlight>
* Fail if the due date is invalid:
<syntaxhighlight lang="ruby">
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
</syntaxhighlight>
* If new due_date object is created:<syntaxhighlight lang="ruby">
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
</syntaxhighlight>
* due_at should be same for 0 offset:<syntaxhighlight lang="ruby">
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is positive:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is negative:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
</syntaxhighlight>
* The offset is being converted to integer properly:<syntaxhighlight lang="ruby">
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/deadline_helper_spec.rb
</syntaxhighlight>The output of this RSpec file is present in below screenshot:
[[File:Deadlinerspec.png|center|thumb|705x705px]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Deadlinecoverage.png|center|thumb|823x823px]]

== '''References''' ==

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-29T00:01:12Z

Nthanik: Undo revision 103202 by Nthanik (talk)

== '''Introduction''' ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Code Climate ===
Code Climate<ref>{{Cite web|url=https://codeclimate.com/dashboard|title=Log in to your Code Climate dashboard with GitHub or your email.|website=codeclimate.com|access-date=2016-10-28}}</ref> is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

== '''Tasks Identified''' ==
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:
* Due_date.rb
** Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
** Useless assignment to variable - `sorted_deadlines`.
** Prefer `each` over `for`.
** Use `find_by` instead of `where.first`.
** Correct the use of Time function
* Deadline_helper.rb
** Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
** Trailing whitespace detected.
** Extra empty line detected at module body end.

* Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.

== '''Current Implementation''' ==
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

== '''Changed Implementation''' ==
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are
* Due_date.rb (path: /app/models)

* Deadline_helper.rb (path: /app/helpers)
Testing files
* Due_date_spec.rb (path: /spec/models)
* Deadline_helper_spec.rb (path: /spec/helpers)
=== Due_date.rb ===
* Converted for..in loop to object.each in order to follow better Ruby syntax.
* Unnecessary assignment to sorted_deadlines removed.
* Nested ternary operators have been changed to if..else in order to make it more readable.
[[File:Duedaterb.png]]
* Changed where(...).first to find_by(...) which is the newer recommended syntax.
* Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
* Removed trailing whitespaces.
[[File:DueDaterb2.png]]

=== Deadline_helper.rb ===
* Time functions were changed to functions with zones
* Extra line removed
[[File:Deadlinehelper.png]]

== '''RSpec testing''' ==
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

=== due_date_spec.rb ===
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.
* If the factory is successfully able to build the due_date objects.<syntaxhighlight lang="ruby">
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
</syntaxhighlight>
* If the function "set_flag" successfully sets the due_date flag.<syntaxhighlight lang="ruby">
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
</syntaxhighlight>
* If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).<syntaxhighlight lang="ruby">
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
</syntaxhighlight>
* If the function "self.copy" is able to copy due dates from one assignment to another.<syntaxhighlight lang="ruby">
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
</syntaxhighlight>
* If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.<syntaxhighlight lang="ruby">
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
</syntaxhighlight>
* If the function "self.deadline_sort" is able to sort the due dates in ascending order.<syntaxhighlight lang="ruby">
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
</syntaxhighlight>
* If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.<syntaxhighlight lang="ruby">
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
</syntaxhighlight>
* If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.<syntaxhighlight lang="ruby">
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
</syntaxhighlight>
* If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.<syntaxhighlight lang="ruby">
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/due_date_spec.rb
</syntaxhighlight>
The output of this RSpec file is present in below screenshot:
[[File:Duedaterspec.png|center|thumb|558x558px]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Duedatecoverage.png|center|thumb|736x736px]]

Code coverage details of the above RSpec files is present in below screenshot:

=== deadline_helper_spec.rb ===
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:
* Check if the factory is valid:
<syntaxhighlight lang="ruby">
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
</syntaxhighlight>
* Fail if the due date is invalid:
<syntaxhighlight lang="ruby">
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
</syntaxhighlight>
* If new due_date object is created:<syntaxhighlight lang="ruby">
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
</syntaxhighlight>
* due_at should be same for 0 offset:<syntaxhighlight lang="ruby">
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is positive:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is negative:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
</syntaxhighlight>
* The offset is being converted to integer properly:<syntaxhighlight lang="ruby">
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/deadline_helper_spec.rb
</syntaxhighlight>The output of this RSpec file is present in below screenshot:
[[File:Deadlinerspec.png|center|thumb|705x705px]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Deadlinecoverage.png|center|thumb|823x823px]]

== '''References''' ==

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-29T00:01:04Z

Nthanik: Undo revision 103232 by Nthanik (talk)

== '''Introduction''' ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Code Climate ===
Code Climate<ref>{{Cite web|url=https://codeclimate.com/dashboard|title=Log in to your Code Climate dashboard with GitHub or your email.|website=codeclimate.com|access-date=2016-10-28}}</ref> is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

== '''Tasks Identified''' ==
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:
* Due_date.rb
** Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
** Useless assignment to variable - `sorted_deadlines`.
** Prefer `each` over `for`.
** Use `find_by` instead of `where.first`.
** Correct the use of Time function
* Deadline_helper.rb
** Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
** Trailing whitespace detected.
** Extra empty line detected at module body end.

* Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.

== '''Current Implementation''' ==
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

== '''Changed Implementation''' ==
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are
* Due_date.rb (path: /app/models)

* Deadline_helper.rb (path: /app/helpers)
Testing files
* Due_date_spec.rb (path: /spec/models)
* Deadline_helper_spec.rb (path: /spec/helpers)
=== Due_date.rb ===
* Converted for..in loop to object.each in order to follow better Ruby syntax.
* Unnecessary assignment to sorted_deadlines removed.
* Nested ternary operators have been changed to if..else in order to make it more readable.
[[File:Duedaterb.png]]
* Changed where(...).first to find_by(...) which is the newer recommended syntax.
* Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
* Removed trailing whitespaces.
[[File:DueDaterb2.png]]

=== Deadline_helper.rb ===
* Time functions were changed to functions with zones
* Extra line removed
[[File:Deadlinehelper.png]]

== '''RSpec testing''' ==
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

=== due_date_spec.rb ===
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.
* If the factory is successfully able to build the due_date objects.<syntaxhighlight lang="ruby">
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
</syntaxhighlight>
* If the function "set_flag" successfully sets the due_date flag.<syntaxhighlight lang="ruby">
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
</syntaxhighlight>
* If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).<syntaxhighlight lang="ruby">
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
</syntaxhighlight>
* If the function "self.copy" is able to copy due dates from one assignment to another.<syntaxhighlight lang="ruby">
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
</syntaxhighlight>
* If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.<syntaxhighlight lang="ruby">
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
</syntaxhighlight>
* If the function "self.deadline_sort" is able to sort the due dates in ascending order.<syntaxhighlight lang="ruby">
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
</syntaxhighlight>
* If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.<syntaxhighlight lang="ruby">
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
</syntaxhighlight>
* If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.<syntaxhighlight lang="ruby">
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
</syntaxhighlight>
* If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.<syntaxhighlight lang="ruby">
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/due_date_spec.rb
</syntaxhighlight>
The output of this RSpec file is present in below screenshot:
[[File:Duedaterspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Duedatecoverage.png]]

Code coverage details of the above RSpec files is present in below screenshot:

=== deadline_helper_spec.rb ===
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:
* Check if the factory is valid:
<syntaxhighlight lang="ruby">
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
</syntaxhighlight>
* Fail if the due date is invalid:
<syntaxhighlight lang="ruby">
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
</syntaxhighlight>
* If new due_date object is created:<syntaxhighlight lang="ruby">
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
</syntaxhighlight>
* due_at should be same for 0 offset:<syntaxhighlight lang="ruby">
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is positive:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is negative:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
</syntaxhighlight>
* The offset is being converted to integer properly:<syntaxhighlight lang="ruby">
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/deadline_helper_spec.rb
</syntaxhighlight>The output of this RSpec file is present in below screenshot:
[[File:Deadlinerspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Deadlinecoverage.png]]

== '''References''' ==

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-29T00:00:54Z

Nthanik: Undo revision 103255 by Nthanik (talk)

== '''Introduction''' ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Code Climate ===
Code Climate<ref>{{Cite web|url=https://codeclimate.com/dashboard|title=Log in to your Code Climate dashboard with GitHub or your email.|website=codeclimate.com|access-date=2016-10-28}}</ref> is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

== '''Tasks Identified''' ==
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:
* Due_date.rb
** Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
** Useless assignment to variable - `sorted_deadlines`.
** Prefer `each` over `for`.
** Use `find_by` instead of `where.first`.
** Correct the use of Time function
* Deadline_helper.rb
** Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
** Trailing whitespace detected.
** Extra empty line detected at module body end.

* Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.

== '''Current Implementation''' ==
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

== '''Changed Implementation''' ==
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are
* Due_date.rb (path: /app/models)

* Deadline_helper.rb (path: /app/helpers)
Testing files
* Due_date_spec.rb (path: /spec/models)
* Deadline_helper_spec.rb (path: /spec/helpers)
=== Due_date.rb ===
* Converted for..in loop to object.each in order to follow better Ruby syntax.
* Unnecessary assignment to sorted_deadlines removed.
* Nested ternary operators have been changed to if..else in order to make it more readable.
[[File:Duedaterb.png]]
* Changed where(...).first to find_by(...) which is the newer recommended syntax.
* Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
* Removed trailing whitespaces.
[[File:DueDaterb2.png]]

=== Deadline_helper.rb ===
* Time functions were changed to functions with zones
* Extra line removed
[[File:Deadlinehelper.png]]

== '''RSpec testing''' ==
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

=== due_date_spec.rb ===
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.
* If the factory is successfully able to build the due_date objects.<syntaxhighlight lang="ruby">
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
</syntaxhighlight>
* If the function "set_flag" successfully sets the due_date flag.<syntaxhighlight lang="ruby">
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
</syntaxhighlight>
* If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).<syntaxhighlight lang="ruby">
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
</syntaxhighlight>
* If the function "self.copy" is able to copy due dates from one assignment to another.<syntaxhighlight lang="ruby">
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
</syntaxhighlight>
* If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.<syntaxhighlight lang="ruby">
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
</syntaxhighlight>
* If the function "self.deadline_sort" is able to sort the due dates in ascending order.<syntaxhighlight lang="ruby">
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
</syntaxhighlight>
* If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.<syntaxhighlight lang="ruby">
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
</syntaxhighlight>
* If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.<syntaxhighlight lang="ruby">
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
</syntaxhighlight>
* If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.<syntaxhighlight lang="ruby">
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/due_date_spec.rb
</syntaxhighlight>
The output of this RSpec file is present in below screenshot:
[[File:Duedaterspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Duedatecoverage.png]]

Code coverage details of the above RSpec files is present in below screenshot:

=== deadline_helper_spec.rb ===
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:
* Check if the factory is valid:
<syntaxhighlight lang="ruby">
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
</syntaxhighlight>
* Fail if the due date is invalid:
<syntaxhighlight lang="ruby">
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
</syntaxhighlight>
* If new due_date object is created:<syntaxhighlight lang="ruby">
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
</syntaxhighlight>
* due_at should be same for 0 offset:<syntaxhighlight lang="ruby">
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is positive:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is negative:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
</syntaxhighlight>[[asd]]
* The offset is being converted to integer properly:<syntaxhighlight lang="ruby">
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/deadline_helper_spec.rb
</syntaxhighlight>The output of this RSpec file is present in below screenshot:
[[File:Deadlinerspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Deadlinecoverage.png]]

== '''References''' ==
"[http://www.expertiza.ncsu.edu]"
"[Ruby on Rails]". [http://www.rubyonrails.org]. Retrieved 2016-10-28.
"[Log in to your Code Climate dashboard with GitHub or your email].". [http://www.codeclimate.com]. Retrieved 2016-10-28.
"[RSpec: Behaviour Driven Development for Ruby]". [http://www.rspec.info]. Retrieved 2016-10-28.
"[Travis CI - Test and Deploy with Confidence]". [http://www.travis-ci.com link title]. Retrieved 2016-10-28
"[Working Effectively with Data Factories Using FactoryGirl]". [http://www.semaphoreci.com]. Retrieved 2016-10-28

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-29T00:00:04Z

Nthanik: Undo revision 103346 by Nthanik (talk)

== '''Introduction''' ==

=== Expertiza ===
Expertiza<ref>{{Cite web|url=http://www.expertiza.ncsu.edu|access-date=2016-10-28}}</ref> is an open source project for school assignment management for instructors and students based on the Ruby on Rails<ref>{{Cite web|url=http://www.rubyonrails.org|access-date=2016-10-28}}</ref> framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Code Climate ===
Code Climate<ref>{{Cite web|url=https://codeclimate.com/dashboard|title=Log in to your Code Climate dashboard with GitHub or your email.|website=codeclimate.com|access-date=2016-10-28}}</ref> is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

== '''Tasks Identified''' ==
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:
* Due_date.rb
** Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
** Useless assignment to variable - `sorted_deadlines`.
** Prefer `each` over `for`.
** Use `find_by` instead of `where.first`.
** Correct the use of Time function
* Deadline_helper.rb
** Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
** Trailing whitespace detected.
** Extra empty line detected at module body end.

* Create respective RSpec<ref>{{Cite web|url=http://www.rspec.info|access-date=2016-10-28}}</ref>files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.

== '''Current Implementation''' ==
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

== '''Changed Implementation''' ==
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are
* Due_date.rb (path: /app/models)

* Deadline_helper.rb (path: /app/helpers)
Testing files
* Due_date_spec.rb (path: /spec/models)
* Deadline_helper_spec.rb (path: /spec/helpers)
=== Due_date.rb ===
* Converted for..in loop to object.each in order to follow better Ruby syntax.
* Unnecessary assignment to sorted_deadlines removed.
* Nested ternary operators have been changed to if..else in order to make it more readable.
[[File:Duedaterb.png]]
* Changed where(...).first to find_by(...) which is the newer recommended syntax.
* Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
* Removed trailing whitespaces.
[[File:DueDaterb2.png]]

=== Deadline_helper.rb ===
* Time functions were changed to functions with zones
* Extra line removed
[[File:Deadlinehelper.png]]

== '''RSpec testing''' ==
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.For both of these two files, all Travis CI<ref>{{Cite web|url=http://http://www.travis-ci.com|access-date=2016-10-28}}</ref> test cases have passed.

These RSpec files have 100% code coverage visible at: /coverage/index.html

=== due_date_spec.rb ===
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.
* If the factory is successfully able to build the due_date objects.<syntaxhighlight lang="ruby">
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
</syntaxhighlight>
* If the function "set_flag" successfully sets the due_date flag.<syntaxhighlight lang="ruby">
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
</syntaxhighlight>
* If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).<syntaxhighlight lang="ruby">
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
</syntaxhighlight>
* If the function "self.copy" is able to copy due dates from one assignment to another.<syntaxhighlight lang="ruby">
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
</syntaxhighlight>
* If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.<syntaxhighlight lang="ruby">
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
</syntaxhighlight>
* If the function "self.deadline_sort" is able to sort the due dates in ascending order.<syntaxhighlight lang="ruby">
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
</syntaxhighlight>
* If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.<syntaxhighlight lang="ruby">
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
</syntaxhighlight>
* If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.<syntaxhighlight lang="ruby">
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
</syntaxhighlight>
* If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.<syntaxhighlight lang="ruby">
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/due_date_spec.rb
</syntaxhighlight>
The output of this RSpec file is present in below screenshot:
[[File:Duedaterspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Duedatecoverage.png]]

Code coverage details of the above RSpec files is present in below screenshot:

=== deadline_helper_spec.rb ===
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:
* Check if the factory<ref>{{Cite web|url=http://http://www.semaphoreci.com|access-date=2016-10-28}}</ref> is valid:
<syntaxhighlight lang="ruby">
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
</syntaxhighlight>
* Fail if the due date is invalid:
<syntaxhighlight lang="ruby">
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
</syntaxhighlight>
* If new due_date object is created:<syntaxhighlight lang="ruby">
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
</syntaxhighlight>
* due_at should be same for 0 offset:<syntaxhighlight lang="ruby">
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is positive:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is negative:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
</syntaxhighlight>[[asd]]
* The offset is being converted to integer properly:<syntaxhighlight lang="ruby">
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/deadline_helper_spec.rb
</syntaxhighlight>The output of this RSpec file is present in below screenshot:
[[File:Deadlinerspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Deadlinecoverage.png]]

== '''References''' ==
"[http://www.expertiza.ncsu.edu]"
"[Ruby on Rails]". [http://www.rubyonrails.org]. Retrieved 2016-10-28.
"[Log in to your Code Climate dashboard with GitHub or your email].". [http://www.codeclimate.com]. Retrieved 2016-10-28.
"[RSpec: Behaviour Driven Development for Ruby]". [http://www.rspec.info]. Retrieved 2016-10-28.
"[Travis CI - Test and Deploy with Confidence]". [http://www.travis-ci.com link title]. Retrieved 2016-10-28
"[Working Effectively with Data Factories Using FactoryGirl]". [http://www.semaphoreci.com]. Retrieved 2016-10-28

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T23:53:27Z

Nthanik: Blanked the page

File:DueDaterb2.png

2016-10-28T23:52:04Z

Nthanik: uploaded a new version of "File:DueDaterb2.png"

File:DueDaterb2.png

2016-10-28T23:50:18Z

Nthanik: uploaded a new version of "File:DueDaterb2.png"

CSC/ECE 517 Fall 2016/E1634. Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T23:26:52Z

Nthanik:

CSC/ECE 517 Fall 2016/E1634. Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T23:20:32Z

Nthanik:

User:Nthanik

2016-10-28T23:14:00Z

Nthanik: moved User:Nthanik to CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

#REDIRECT [[CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb]]

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T23:14:00Z

Nthanik: moved User:Nthanik to CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T23:08:28Z

Nthanik:

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T22:56:27Z

Nthanik:

== '''Introduction''' ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Code Climate ===
Code Climate<ref>{{Cite web|url=https://codeclimate.com/dashboard|title=Log in to your Code Climate dashboard with GitHub or your email.|website=codeclimate.com|access-date=2016-10-28}}</ref> is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

== '''Tasks Identified''' ==
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:
* Due_date.rb
** Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
** Useless assignment to variable - `sorted_deadlines`.
** Prefer `each` over `for`.
** Use `find_by` instead of `where.first`.
** Correct the use of Time function
* Deadline_helper.rb
** Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
** Trailing whitespace detected.
** Extra empty line detected at module body end.

* Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.

== '''Current Implementation''' ==
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

== '''Changed Implementation''' ==
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are
* Due_date.rb (path: /app/models)

* Deadline_helper.rb (path: /app/helpers)
Testing files
* Due_date_spec.rb (path: /spec/models)
* Deadline_helper_spec.rb (path: /spec/helpers)
=== Due_date.rb ===
* Converted for..in loop to object.each in order to follow better Ruby syntax.
* Unnecessary assignment to sorted_deadlines removed.
* Nested ternary operators have been changed to if..else in order to make it more readable.
[[File:Duedaterb.png]]
* Changed where(...).first to find_by(...) which is the newer recommended syntax.
* Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
* Removed trailing whitespaces.
[[File:DueDaterb2.png]]

=== Deadline_helper.rb ===
* Time functions were changed to functions with zones
* Extra line removed
[[File:Deadlinehelper.png]]

== '''RSpec testing''' ==
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

=== due_date_spec.rb ===
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.
* If the factory is successfully able to build the due_date objects.<syntaxhighlight lang="ruby">
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
</syntaxhighlight>
* If the function "set_flag" successfully sets the due_date flag.<syntaxhighlight lang="ruby">
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
</syntaxhighlight>
* If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).<syntaxhighlight lang="ruby">
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
</syntaxhighlight>
* If the function "self.copy" is able to copy due dates from one assignment to another.<syntaxhighlight lang="ruby">
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
</syntaxhighlight>
* If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.<syntaxhighlight lang="ruby">
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
</syntaxhighlight>
* If the function "self.deadline_sort" is able to sort the due dates in ascending order.<syntaxhighlight lang="ruby">
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
</syntaxhighlight>
* If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.<syntaxhighlight lang="ruby">
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
</syntaxhighlight>
* If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.<syntaxhighlight lang="ruby">
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
</syntaxhighlight>
* If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.<syntaxhighlight lang="ruby">
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/due_date_spec.rb
</syntaxhighlight>
The output of this RSpec file is present in below screenshot:
[[File:Duedaterspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Duedatecoverage.png]]

Code coverage details of the above RSpec files is present in below screenshot:

=== deadline_helper_spec.rb ===
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:
* Check if the factory is valid:
<syntaxhighlight lang="ruby">
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
</syntaxhighlight>
* Fail if the due date is invalid:
<syntaxhighlight lang="ruby">
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
</syntaxhighlight>
* If new due_date object is created:<syntaxhighlight lang="ruby">
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
</syntaxhighlight>
* due_at should be same for 0 offset:<syntaxhighlight lang="ruby">
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is positive:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is negative:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
</syntaxhighlight>[[asd]]
* The offset is being converted to integer properly:<syntaxhighlight lang="ruby">
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/deadline_helper_spec.rb
</syntaxhighlight>The output of this RSpec file is present in below screenshot:
[[File:Deadlinerspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Deadlinecoverage.png]]

== '''References''' ==
"[http://www.expertiza.ncsu.edu]"
"[Ruby on Rails]". [http://www.rubyonrails.org]. Retrieved 2016-10-28.
"[Log in to your Code Climate dashboard with GitHub or your email].". [http://www.codeclimate.com]. Retrieved 2016-10-28.
"[RSpec: Behaviour Driven Development for Ruby]". [http://www.rspec.info]. Retrieved 2016-10-28.
"[Travis CI - Test and Deploy with Confidence]". [http://www.travis-ci.com link title]. Retrieved 2016-10-28
"[Working Effectively with Data Factories Using FactoryGirl]". [http://www.semaphoreci.com]. Retrieved 2016-10-28

File:Duedaterspec.png

2016-10-28T22:38:09Z

Nthanik:

File:Duedatecoverage.png

2016-10-28T22:37:47Z

Nthanik:

File:Deadlinerspec.png

2016-10-28T22:37:24Z

Nthanik:

File:Deadlinecoverage.png

2016-10-28T22:35:47Z

Nthanik:

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T22:34:08Z

Nthanik:

== '''Introduction''' ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Code Climate ===
Code Climate<ref>{{Cite web|url=https://codeclimate.com/dashboard|title=Log in to your Code Climate dashboard with GitHub or your email.|website=codeclimate.com|access-date=2016-10-28}}</ref> is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

== '''Tasks Identified''' ==
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:
* Due_date.rb
** Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
** Useless assignment to variable - `sorted_deadlines`.
** Prefer `each` over `for`.
** Use `find_by` instead of `where.first`.
** Correct the use of Time function
* Deadline_helper.rb
** Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
** Trailing whitespace detected.
** Extra empty line detected at module body end.

* Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.

== '''Current Implementation''' ==
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

== '''Changed Implementation''' ==
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are
* Due_date.rb (path: /app/models)

* Deadline_helper.rb (path: /app/helpers)
Testing files
* Due_date_spec.rb (path: /spec/models)
* Deadline_helper_spec.rb (path: /spec/helpers)
=== Due_date.rb ===
* Converted for..in loop to object.each in order to follow better Ruby syntax.
* Unnecessary assignment to sorted_deadlines removed.
* Nested ternary operators have been changed to if..else in order to make it more readable.
[[File:Duedaterb.png]]
* Changed where(...).first to find_by(...) which is the newer recommended syntax.
* Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
* Removed trailing whitespaces.
[[File:DueDaterb2.png]]

=== Deadline_helper.rb ===
* Time functions were changed to functions with zones
* Extra line removed
[[File:Deadlinehelper.png]]

== '''RSpec testing''' ==
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

=== due_date_spec.rb ===
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.
* If the factory is successfully able to build the due_date objects.<syntaxhighlight lang="ruby">
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
</syntaxhighlight>
* If the function "set_flag" successfully sets the due_date flag.<syntaxhighlight lang="ruby">
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
</syntaxhighlight>
* If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).<syntaxhighlight lang="ruby">
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
</syntaxhighlight>
* If the function "self.copy" is able to copy due dates from one assignment to another.<syntaxhighlight lang="ruby">
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
</syntaxhighlight>
* If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.<syntaxhighlight lang="ruby">
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
</syntaxhighlight>
* If the function "self.deadline_sort" is able to sort the due dates in ascending order.<syntaxhighlight lang="ruby">
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
</syntaxhighlight>
* If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.<syntaxhighlight lang="ruby">
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
</syntaxhighlight>
* If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.<syntaxhighlight lang="ruby">
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
</syntaxhighlight>
* If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.<syntaxhighlight lang="ruby">
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/due_date_spec.rb
</syntaxhighlight>
The output of this RSpec file is present in below screenshot:
[[File:Duedaterspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Duedatecoverage.png]]

Code coverage details of the above RSpec files is present in below screenshot:

=== deadline_helper_spec.rb ===
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:
* Check if the factory is valid:
<syntaxhighlight lang="ruby">
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
</syntaxhighlight>
* Fail if the due date is invalid:
<syntaxhighlight lang="ruby">
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
</syntaxhighlight>
* If new due_date object is created:<syntaxhighlight lang="ruby">
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
</syntaxhighlight>
* due_at should be same for 0 offset:<syntaxhighlight lang="ruby">
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is positive:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is negative:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
</syntaxhighlight>
* The offset is being converted to integer properly:<syntaxhighlight lang="ruby">
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/deadline_helper_spec.rb
</syntaxhighlight>The output of this RSpec file is present in below screenshot:
[[File:Deadlinerspec.png]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Deadlinecoverage.png]]

== '''References''' ==

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T22:33:11Z

Nthanik:

== '''Introduction''' ==

=== Expertiza ===
Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customise new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and word documents. Expertiza provides a dashboard for all the assignments corresponding to a course and provides absolute control to the Instructors and Teaching Assistants. In addition to assignments, it encompasses peer reviews wherein participants are allowed to provide feedback anonymously about each other's work thereby providing scope for the better outcome. The due_date.rb file is responsible for informing the users about the deadline for submission of the each assignment. Due dates in Expertiza have their association with many other components like assignments, reviews etc.

=== Code Climate ===
Code Climate<ref>{{Cite web|url=https://codeclimate.com/dashboard|title=Log in to your Code Climate dashboard with GitHub or your email.|website=codeclimate.com|access-date=2016-10-28}}</ref> is a tool that runs static analysis on a GitHub project and outputs many details like test coverage, complexity, duplication, security, style, and more. There is a Google Chrome extension to integrate the Code Climate results generated directly into GitHub which is visible when browsing the repository on the browser. It allows us to see issues displayed directly inside GitHub's UI, to review which lines are covered in diffs and files, and add repositories and open tickets without changing your workflow.

== '''Tasks Identified''' ==
To install Code climate Chrome Extension that highlights the duplicated code.

To refactor the following two files:
* Due_date.rb
** Ternary operators must not be nested. Prefer `if` or `else` constructs instead.
** Useless assignment to variable - `sorted_deadlines`.
** Prefer `each` over `for`.
** Use `find_by` instead of `where.first`.
** Correct the use of Time function
* Deadline_helper.rb
** Do not use `Time.now` without zone. Use one of `Time.zone.now`, `Time.current`, `Time.now.in_time_zone`, `Time.now.utc`, `Time.now.getlocal`, `Time.now.iso8601`, `Time.now.jisx0301`, `Time.now.rfc3339`, `Time.now.to_i`, `Time.now.to_f` instead.
** Trailing whitespace detected.
** Extra empty line detected at module body end.

* Create respective RSpec files in /spec/models/ and /spec/helper folder and write unit tests for each method in due_date.rb and deadline_helper.rb.

== '''Current Implementation''' ==
DueDate is a Model class to manage the deadlines of an assignment. It has methods for setting due dates for an assignment, copying due dates from one assignment to a new assignment etc. DeadlineHelper provides helper functions that help DueDate perform certain tasks. The assignment focuses on refactoring some of the methods based on warnings received from Code Climate's static analysis and modifying the language to make it more Ruby-friendly. The assignment also involves writing unit test cases for due_date.rb and deadline_helper.rb in order to increase test coverage.

The goal of this project is to attempt to make this part of the application easier to read and write unit test cases that the application must pass.

== '''Changed Implementation''' ==
Changes implemented involves refactoring the code and making it more understandable by adding comments in the code.

The modified files are
* Due_date.rb (path: /app/models)

* Deadline_helper.rb (path: /app/helpers)
Testing files
* Due_date_spec.rb (path: /spec/models)
* Deadline_helper_spec.rb (path: /spec/helpers)
=== Due_date.rb ===
* Converted for..in loop to object.each in order to follow better Ruby syntax.
* Unnecessary assignment to sorted_deadlines removed.
* Nested ternary operators have been changed to if..else in order to make it more readable.
[[File:Duedaterb.png]]
* Changed where(...).first to find_by(...) which is the newer recommended syntax.
* Corrected the Time.now functions by adding the correct zones to them such as Time.zone.now.
* Removed trailing whitespaces.
[[File:DueDaterb2.png]]

=== Deadline_helper.rb ===
* Time functions were changed to functions with zones
* Extra line removed
[[File:Deadlinehelper.png]]

== '''RSpec testing''' ==
There were no existing tests for the functions in due_date.rb and deadline_helper.rb. We have added exhaustive set of RSpec tests to test all the code. We have added two new spec files 'due_date_spec.rb' and ‘deadline_helper_spec.rb’ which cover the testing scenarios for the functions in ‘due_date.rb’ and ‘deadline_helper.rb’.

These RSpec files have 100% code coverage visible at: /coverage/index.html

=== due_date_spec.rb ===
This file is located at spec/models and tests the functionalities of the due_date.rb file located in app/models. There are 18 test cases in total which are listed below.
* If the factory is successfully able to build the due_date objects.<syntaxhighlight lang="ruby">
it "due date factory created successfully" do
expect(@assignment_due_date).to be_valid
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "due dates created correctly" do
expect(@due_dates.length).to be == 10
end
</syntaxhighlight>
* If the function "set_flag" successfully sets the due_date flag.<syntaxhighlight lang="ruby">
it "due date flag is set" do
expect(@assignment_due_date.flag).to be false
@assignment_due_date.set_flag
expect(@assignment_due_date.flag).to be true
end
</syntaxhighlight>
* If the function "due_at_is_valid_datetime" returns nil (no errors) for a valid datetime in due_at (no invalid test cases can be added here because model does not allow invalid datetime to be set at all).<syntaxhighlight lang="ruby">
it "due at is valid datetime" do
expect(@assignment_due_date.due_at_is_valid_datetime).to be nil
end
</syntaxhighlight>
* If the function "self.copy" is able to copy due dates from one assignment to another.<syntaxhighlight lang="ruby">
it "copy due dates to new assignment" do
new_assignment_id = build(:assignment, id: 999).id
old_assignment_id = @assignment_due_date.assignment.id
DueDate.copy(old_assignment_id, new_assignment_id)
expect(DueDate.where(parent_id: new_assignment_id).count).to eql DueDate.where(parent_id: old_assignment_id).count
end
</syntaxhighlight>
* If the function "self.set_duedate" is able to create another due date by copying data from an existing due date object.<syntaxhighlight lang="ruby">
it "create new duedate record with values" do
DueDate.set_duedate({id: 999}, @assignment_due_date.deadline_type_id,
@assignment_due_date.parent_id, @assignment_due_date.round)
new_due_date = DueDate.find_by(id: 999)
expect(new_due_date).to be_valid
expect(new_due_date.deadline_type_id).to eql @assignment_due_date.deadline_type_id
expect(new_due_date.parent_id).to eql @assignment_due_date.parent_id
expect(new_due_date.round).to eql @assignment_due_date.round
end
</syntaxhighlight>
* If the function "self.deadline_sort" is able to sort the due dates in ascending order.<syntaxhighlight lang="ruby">
it "sort duedate records" do
sorted_due_dates = @due_dates
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql false

sorted_due_dates = DueDate.deadline_sort(@due_dates)
expect(sorted_due_dates.each_cons(2).all?{|m1, m2| (m1.due_at <=> m2.due_at) != 1}).to eql true
end
</syntaxhighlight>
* If the function "self.done_in_assignment_round" returns the correct number of rounds for specific inputs. This involves an invalid test case as well for 0 rounds.<syntaxhighlight lang="ruby">
describe "#done_in_assignment_round" do
it "return 0 when no response map" do
response = ReviewResponseMap.create
response.type = "ResponseMap"
response.save
expect(DueDate.done_in_assignment_round(1, response)).to eql 0
end

it "return round 1 for single round" do
response = ReviewResponseMap.create
expect(DueDate.done_in_assignment_round(@assignment_due_date.parent_id, response)).to eql 1
end
end
</syntaxhighlight>
* If the function "self.get_next_due_date" works as expected. This involves several invalid test cases as well.<syntaxhighlight lang="ruby">
describe "#get_next_due_date" do
it "no subsequent due date" do
expect(DueDate.get_next_due_date(@assignment_due_date.parent_id)).to be nil
end

it "nil value throws exception" do
expect { DueDate.get_next_due_date(nil) }.to raise_exception(ActiveRecord::RecordNotFound)
end

it "get next assignment due date" do
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000)
expect(DueDate.get_next_due_date(due_date.parent_id)).to be_valid
end

it "get next due date from topic for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right.id, review_allowed_id: @deadline_right.id,
review_of_review_allowed_id: @deadline_right.id, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be_valid
end

it "next due date does not exist for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be nil
end

it "next due date is before Time.now for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:topic_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now - 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id, due_date.parent_id)).to be nil
end

it "get next due date from assignment for staggered deadline" do
assignment_id = create(:assignment, staggered_deadline: true, name: "testassignment").id
due_date = create(:assignment_due_date, deadline_type: @deadline_type,
submission_allowed_id: @deadline_right, review_allowed_id: @deadline_right,
review_of_review_allowed_id: @deadline_right, due_at: Time.zone.now + 5000, parent_id: assignment_id)
expect(DueDate.get_next_due_date(assignment_id)).to be_valid
end
end
</syntaxhighlight>
* If the function "self.default_permission" returns the correct default permissions for particular deadline and permission types.<syntaxhighlight lang="ruby">
it "metareview review_of_review_allowed default permission OK" do
expect(DueDate.default_permission('metareview', 'review_of_review_allowed')).to be == DeadlineRight::OK
end
</syntaxhighlight><syntaxhighlight lang="ruby">
it "review submission_allowed default permission NO" do
expect(DueDate.default_permission('review', 'submission_allowed')).to be == DeadlineRight::NO
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/due_date_spec.rb
</syntaxhighlight>
The output of this RSpec file is present in below screenshot:
[[File:Duedaterspec.png|center|thumb|558x558px]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Duedatecoverage.png|center|thumb|736x736px]]

Code coverage details of the above RSpec files is present in below screenshot:

=== deadline_helper_spec.rb ===
This is a test file for testing the functionalities of Deadline_helper.rb file located at app/helpers. Different test cases present in this file are:
* Check if the factory is valid:
<syntaxhighlight lang="ruby">
it "has a valid factory" do
factory = FactoryGirl.build(:topic_due_date)
expect(factory).to be_valid
end
</syntaxhighlight>
* Fail if the due date is invalid:
<syntaxhighlight lang="ruby">
it "should fail because of invalid due_date" do
expect { DeadlineHelper.create_topic_deadline(nil, 0, 0)}.to raise_exception(NoMethodError)
end
</syntaxhighlight>
* If new due_date object is created:<syntaxhighlight lang="ruby">
it "new due_date object created" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 1)
expect(TopicDueDate.count).to be == 2
end
</syntaxhighlight>
* due_at should be same for 0 offset:<syntaxhighlight lang="ruby">
it "due_at should be same for 0 offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 0, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == @topic_due_date.due_at.to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is positive:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for positive offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
* due_at is calculated correctly if offset is negative:<syntaxhighlight lang="ruby">
it "due_at calculated correctly for negative offset" do
DeadlineHelper.create_topic_deadline(@topic_due_date, -5000, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) - 5000).to_s
end
</syntaxhighlight>
* The offset is being converted to integer properly:<syntaxhighlight lang="ruby">
it "offset converted to integer correctly" do
DeadlineHelper.create_topic_deadline(@topic_due_date, 5000.15, 10)
new_due_date = TopicDueDate.find_by(parent_id: 10)
expect(new_due_date).to be_valid
expect(new_due_date.due_at.to_s).to be == (Time.zone.parse(@topic_due_date.due_at.to_s) + 5000).to_s
end
</syntaxhighlight>
To test this file run the following command:<syntaxhighlight>
rspec spec/models/deadline_helper_spec.rb
</syntaxhighlight>The output of this RSpec file is present in below screenshot:
[[File:Deadlinerspec.png|center|thumb|705x705px]]

Code coverage details of the above RSpec files is present in below screenshot:
[[File:Deadlinecoverage.png|center|thumb|823x823px]]

== '''References''' ==

File:Deadlinehelper.png

2016-10-28T22:31:00Z

Nthanik:

File:DueDaterb2.png

2016-10-28T22:24:44Z

Nthanik: uploaded a new version of "File:DueDaterb2.png": due

File:DueDaterb2.png

2016-10-28T22:17:24Z

Nthanik:

File:Duedaterb.png

2016-10-28T22:11:14Z

Nthanik: uploaded a new version of "File:Duedaterb.png": Reverted to version as of 22:08, 28 October 2016

Due_date.rb

File:Duedaterb.png

2016-10-28T22:11:05Z

Nthanik: uploaded a new version of "File:Duedaterb.png"

Due_date.rb

File:Duedaterb.png

2016-10-28T22:09:31Z

Nthanik: uploaded a new version of "File:Duedaterb.png": Reverted to version as of 22:08, 28 October 2016

Due_date.rb

File:Duedaterb.png

2016-10-28T22:09:15Z

Nthanik: uploaded a new version of "File:Duedaterb.png": Due

Due_date.rb

File:Duedaterb.png

2016-10-28T22:08:41Z

Nthanik: Due_date.rb

Due_date.rb

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T20:40:09Z

Nthanik:

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T20:36:42Z

Nthanik:

CSC/ECE 517 Fall 2016/E1634.Refactor and write unit test of due date.rb and deadline helper.rb

2016-10-28T20:36:18Z

Nthanik: Created page with "Introduction Expertiza Expertiza is an open source project for school assignment management for instructors and students based on the Ruby on Rails framework. Expertiza allows th..."