Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T01:16:58Z

Sbhawsi:

==E1501: Refactoring Assignments.rb==
This page is about an open source project based on Expertiza OSS. This project aims to refactor assignment.rb which is the largest class in Expertiza. It also aims to refactor other snippets which does not follow the Ruby style guidelines.

===Refactoring===
<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

=== Introduction to Expertiza ===

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly. The pull request can be viewed [https://github.com/yatish27/expertiza/commit/ddbd575e6695e8c6b4b6fff8c8aaf814a3981773 here].

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small and well readable code. The code was refactored to be more readable. Many changes were done to the structure of the code to make it more Ruby like. Changes such as removing the return statements, writing .each instead of "for loop", adding a "?" to name of methods if they return boolean values, indentations and naming conventions were improved. Few of the examples are shown below in raw form as well as Github screenshots:

[[File:Refac.JPG|center]]

This refactoring example makes the snippet small and easy to read. It also introduces more Ruby style terms like select and processes like piping instructions.
'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem <ref>[https://github.com/evrone/quiet_assets Quite_assets]</ref> "quite_assets" was added to avoid unnecessary log creation of the asset request. It mutes the asset pipeline log messages. This gem is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order. We changed them to the right order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously. Also, please have a look at the pull request for all the refactor details. You can pull the code with refactored file [https://github.com/yatish27/expertiza here].

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:46:25Z

Sbhawsi:

==E1501: Refactoring Assignments.rb==
This page is about an open source project based on Expertiza OSS. This project aims to refactor assignment.rb which is the largest class in Expertiza. It also aims to refactor other snippets which does not follow the Ruby style guidelines.

===Refactoring===
<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

=== Introduction to Expertiza ===

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly. The pull request can be viewed [https://github.com/yatish27/expertiza/commit/ddbd575e6695e8c6b4b6fff8c8aaf814a3981773 here].

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small and well readable code. The code was refactored to be more readable. Many changes were done to the structure of the code to make it more Ruby like. Changes such as removing the return statements, writing .each instead of "for loop", adding a "?" to name of methods if they return boolean values, indentations and naming conventions were improved. Few of the examples are shown below in raw form as well as Github screenshots:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem <ref>[https://github.com/evrone/quiet_assets Quite_assets]</ref> "quite_assets" was added to avoid unnecessary log creation of the asset request. It mutes the asset pipeline log messages. This gem is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order. We changed them to the right order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously. Also, please have a look at the pull request for all the refactor details. You can pull the code with refactored file [https://github.com/yatish27/expertiza here].

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:42:14Z

Sbhawsi:

==E1501: Refactoring Assignments.rb==
===Refactoring===
<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

=== Introduction to Expertiza ===

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly. The pull request can be viewed [https://github.com/yatish27/expertiza/commit/ddbd575e6695e8c6b4b6fff8c8aaf814a3981773 here].

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small and well readable code. The code was refactored to be more readable. Many changes were done to the structure of the code to make it more Ruby like. Changes such as removing the return statements, writing .each instead of "for loop", adding a "?" to name of methods if they return boolean values, indentations and naming conventions were improved. Few of the examples are shown below in raw form as well as Github screenshots:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem <ref>[https://github.com/evrone/quiet_assets Quite_assets]</ref> "quite_assets" was added to avoid unnecessary log creation of the asset request. It mutes the asset pipeline log messages. This gem is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order. We changed them to the right order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously. Also, please have a look at the pull request for all the refactor details. You can pull the code with refactored file [https://github.com/yatish27/expertiza here].

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:41:42Z

Sbhawsi:

==E1501: Refactoring Assignments.rb==
===Refactoring===
<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

=== Introduction to Expertiza === 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly. The pull request can be viewed [https://github.com/yatish27/expertiza/commit/ddbd575e6695e8c6b4b6fff8c8aaf814a3981773 here].

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small and well readable code. The code was refactored to be more readable. Many changes were done to the structure of the code to make it more Ruby like. Changes such as removing the return statements, writing .each instead of "for loop", adding a "?" to name of methods if they return boolean values, indentations and naming conventions were improved. Few of the examples are shown below in raw form as well as Github screenshots:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem <ref>[https://github.com/evrone/quiet_assets Quite_assets]</ref> "quite_assets" was added to avoid unnecessary log creation of the asset request. It mutes the asset pipeline log messages. This gem is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order. We changed them to the right order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously. Also, please have a look at the pull request for all the refactor details. You can pull the code with refactored file [https://github.com/yatish27/expertiza here].

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:40:32Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly. The pull request can be viewed [https://github.com/yatish27/expertiza/commit/ddbd575e6695e8c6b4b6fff8c8aaf814a3981773 here].

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small and well readable code. The code was refactored to be more readable. Many changes were done to the structure of the code to make it more Ruby like. Changes such as removing the return statements, writing .each instead of "for loop", adding a "?" to name of methods if they return boolean values, indentations and naming conventions were improved. Few of the examples are shown below in raw form as well as Github screenshots:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem <ref>[https://github.com/evrone/quiet_assets Quite_assets]</ref> "quite_assets" was added to avoid unnecessary log creation of the asset request. It mutes the asset pipeline log messages. This gem is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order. We changed them to the right order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously. Also, please have a look at the pull request for all the refactor details. You can pull the code with refactored file [https://github.com/yatish27/expertiza here].

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:36:06Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly. The pull request can be viewed [https://github.com/yatish27/expertiza/commit/ddbd575e6695e8c6b4b6fff8c8aaf814a3981773 here].

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small and well readable code. The code was refactored to be more readable. Many changes were done to the structure of the code to make it more Ruby like. Changes such as removing the return statements, writing .each instead of "for loop", adding a "?" to name of methods if they return boolean values, indentations and naming conventions were improved. Few of the examples are shown below in raw form as well as Github screenshots:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem <ref>[https://github.com/evrone/quiet_assets Quite_assets]</ref> "quite_assets" was added to avoid unnecessary log creation of the asset request. It mutes the asset pipeline log messages. This gem is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order. We changed them to the right order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously. Also, please have a look at the pull request for all the refactor details. You can pull the code with refactored file [https://github.com/yatish27/expertiza here]..

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:32:22Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly. The pull request can be viewed [https://github.com/yatish27/expertiza/commit/ddbd575e6695e8c6b4b6fff8c8aaf814a3981773 here].

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small and well readable code. The code was refactored to be more readable. Many changes were done to the structure of the code to make it more Ruby like. Changes such as removing the return statements, writing .each instead of "for loop", adding a "?" to name of methods if they return boolean values, indentations and naming conventions were improved. Few of the examples are shown below in raw form as well as Github screenshots:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem <ref>[https://github.com/evrone/quiet_assets Quite_assets]</ref> "quite_assets" was added to avoid unnecessary log creation of the asset request. It mutes the asset pipeline log messages. This gem is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:28:03Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly. The pull request can be viewed [https://github.com/yatish27/expertiza/commit/ddbd575e6695e8c6b4b6fff8c8aaf814a3981773 here] here.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Many changes were done to the structure of the code to make it more Ruby like. Changes such as removing the return statements, writing .each instead of "for loop", adding a "?" to names of methods if they return boolean values, indentations and naming conventions were improved. Few of the examples are shown below in raw form as well as Github screenshots:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:22:55Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
<ref>[http://guides.rubyonrails.org/active_record_basics.html ActiveRecord]</ref>ActiveRecord concern is a pattern introduced in Rails 4.1 to separate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a <ref>[http://rubylearning.com/satishtalim/modules_mixins.html Module/Mixins]</ref> module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of "for loop" and naming conventions were improved. Few of the examples are given below:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:15:25Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of "for loop" and naming conventions were improved. Few of the examples are given below:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no MYSQL specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw SQL also helps in keeping the code clean.
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
<ref>[https://github.com/bbatsov/rubocop Rubocop]</ref>`Rubocop` was used to check the ruby style guide violations. Most of the Ruby style guide violations in assignment.rb class were fixed.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;
*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: Few of the controller tests were not in the correct order.

=Steps to verify changes=
* Feature change was not in the scope of the project. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:08:25Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/510 Expertiza Pull request]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-24T00:02:56Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:

[[File:Refac.JPG|center]]

<pre>
'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T23:47:03Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

[[File:Refac1.JPG|center]]


== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

File:Refac1.JPG

2015-03-23T23:46:26Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T23:44:05Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:

[[File:Refac.JPG|center]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T23:40:50Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:

[[File:Refac.JPG]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T23:40:26Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:

[[File:Refac.JPG]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T23:39:57Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:

[[File:Refac.JPG]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T23:39:05Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:
[[File:Refac.JPG]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T23:37:29Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate module scorable.rb===
AvtiveRecord Concern is pattern introduced in Rails 4.1 to seperate the heavy loading done by models. It is recommended that models should be fat and should contain the business logic. This is leads to models getting too coupled. ActiveRecord Concerns solves this problem. Methods which can be logically put together are added in a module/mixin. This mixin is then included in the main model. The mixin can be reused by any other model if required. This makes the code align with Rails philosophy of DRY. In this case all methods related to 'scores' were collaborated together and put inside the mixin scorable.
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

== Instance 2 : Ruby idiomatic==

===Make assignment.rb more Ruby like===
There were many instances where the coding was not like ruby like. The ruby community believes in small, well readable code. The code was refactored to be more readable. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Few of the examples are given below:
[[File:refac.jpg]]

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 3 : Addition of ActiveRecord like Query==
ActiveRecord provides a layer on top database. Hence if no Mysql specific query is used in the code it very simple to change the database without changing the code. Using Ruby hash for query rather than raw sql also helps in keeping the code clean
The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 4: Ruby style guide ==
We used `rubocop` to check the ruby style guide violations. We fixed most of the Ruby style guide violations in that class.

== Instance 5 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.; The older version was not compatible with ruby 2.2.0

*One more gem "quite_assets" was added to avoid unnecessary log creation of the asset request. This is very helpful during development.;

* Clean up tests: few of the controller tests were not in the correct order.

=Steps to verify changes=
* We have not made any changes in the features of Expertiza. The changes are checking bad code smells and fixing them. The way to verify the changes is to make sure that it works as it was previously.

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

File:Refac.JPG

2015-03-23T23:35:46Z

Sbhawsi: Refactoring of assignment.rb in expertiza OSS.

Refactoring of assignment.rb in expertiza OSS.

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:17:42Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing <ref>[http://bundler.io/gemfile.html Gemfile]</ref>Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;

*One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.;

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:15:59Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>Expertiza is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;

*One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.;

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:15:46Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref> is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;

*One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.;

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:14:44Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;

*One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.;

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]
<references/>

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:13:38Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

*Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.;

*One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.;

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:12:54Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
*get_scores;
*get_max_score_possible;
*compute_reviews_hash;
*get_average_score;

All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:11:08Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound which can be grouped into smaller, more manageable classes.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:09:28Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is the largest class in Expertiza, comprising 1105 lines of code which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound.

'''What needs to be done:'''

*The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores;
*Moreover, the querying module is database dependent which should be made database independent;
*There are many function names and code lines which does not follow the ruby guidelines. They should be changed to more ruby like coding style; 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:04:57Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are difficult to read;
* Programs that does not follow the language specific guidelines;
* Programs that has high coupling;

''' Introduction to Expertiza ''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned and modified from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews.

Assignment.rb is a file which contains the assignment model and the related functionalities. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound.

'''What needs to be done:'''
 The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores. Moreover, the querying module was database dependent which was made database independent. There are many function names and code lines which does not follow the ruby guidelines. They were changed to more ruby like coding style. 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:02:20Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are hard to read are hard to modify;
* Programs that have duplicate logic are hard to modify;
* Programs that require additional behavior that requires you to change running code are hard to modify;
* Programs with complex conditional logic are hard to modify. 

''' Introduction to Expertiza ''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound.

'''What needs to be done:'''
 The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores. Moreover, the querying module was database dependent which was made database independent. There are many function names and code lines which does not follow the ruby guidelines. They were changed to more ruby like coding style. 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:02:01Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are hard to read are hard to modify;
* Programs that have duplicate logic are hard to modify;
* Programs that require additional behavior that requires you to change running code are hard to modify;
* Programs with complex conditional logic are hard to modify. 

'' Introduction to Expertiza '' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound.

'''What needs to be done:'''
 The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores. Moreover, the querying module was database dependent which was made database independent. There are many function names and code lines which does not follow the ruby guidelines. They were changed to more ruby like coding style. 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:01:41Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are hard to read are hard to modify;
* Programs that have duplicate logic are hard to modify;
* Programs that require additional behavior that requires you to change running code are hard to modify;
* Programs with complex conditional logic are hard to modify. 

== Introduction to Expertiza == 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound.

'''What needs to be done:'''
 The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores. Moreover, the querying module was database dependent which was made database independent. There are many function names and code lines which does not follow the ruby guidelines. They were changed to more ruby like coding style. 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T19:01:15Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref>Refactoring is a technique to alter the internal structure of the code without affecting the external behaviour.
It is used for:

* Programs that are hard to read are hard to modify;
* Programs that have duplicate logic are hard to modify;
* Programs that require additional behavior that requires you to change running code are hard to modify;
* Programs with complex conditional logic are hard to modify. 

==Introduction to Expertiza== 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound.

'''What needs to be done:'''
 The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores. Moreover, the querying module was database dependent which was made database independent. There are many function names and code lines which does not follow the ruby guidelines. They were changed to more ruby like coding style. 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:59:08Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

<ref>[http://refactoring.com/ Refactoring]</ref> is a technique to alter the internal structure of the code without affecting the external behaviour.
Refactoring adds to the value of any program that has at least one of the following shortcomings<ref>[http://jexp.de/papers/refactoring/refactoring/node9.html#SECTION00330000000000000000 Benefits of Code Refactoring Michael Hunger. Oct. 25, 2000]</ref>:

* Programs that are hard to read are hard to modify;
* Programs that have duplicate logic are hard to modify;
* Programs that require additional behavior that requires you to change running code are hard to modify;
* Programs with complex conditional logic are hard to modify. 

==Introduction to Expertiza== 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound.

'''What needs to be done:'''
 The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores. Moreover, the querying module was database dependent which was made database independent. There are many function names and code lines which does not follow the ruby guidelines. They were changed to more ruby like coding style. 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:57:19Z

Sbhawsi:

=E1501: Refactoring Assignments.rb=

Refactoring is a disciplined technique for restructuring an existing body of code, altering its internal structure without changing its external behavior<ref>[http://refactoring.com/ Refactoring]</ref>.
Refactoring adds to the value of any program that has at least one of the following shortcomings<ref>[http://jexp.de/papers/refactoring/refactoring/node9.html#SECTION00330000000000000000 Benefits of Code Refactoring Michael Hunger. Oct. 25, 2000]</ref>:

* Programs that are hard to read are hard to modify;
* Programs that have duplicate logic are hard to modify;
* Programs that require additional behavior that requires you to change running code are hard to modify;
* Programs with complex conditional logic are hard to modify. 

'''Introduction to Expertiza''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains methods which calculates the student scores. The assignment and scoring modules are very tightly bound.

'''What needs to be done:'''
 The assignment model needs refactoring as it contains some modules which are responsible for generating assignment scores. Moreover, the querying module was database dependent which was made database independent. There are many function names and code lines which does not follow the ruby guidelines. They were changed to more ruby like coding style. 

= Re-factored Instances =

== Instance 1 : Refactoring the Assignment.rb ==

===Creation of separate model scorable.rb===
There are many methods which are not directly related to assignments. These methods are responsible for generating the scores and related functions. These methods are:
1.get_scores
2.get_max_score_possible
3.compute_reviews_hash
4.get_average_score
All these methods are taken out of assignment.rb and pushed into a new file "scorable.rb". This made score generation a separate module and the dependency of scores on assignments have been reduced significantly.

===Make assignment.rb more Ruby like===
There were many instances where the coding style was not according to ruby guidelines. The code was refactored to be more ruby like. Changes such as removing the return statements, writing .each instead of for loop and improving naming conventions were implemented. Some of the changes are described below:

'''Before Change'''
<pre>
quiz_response_mappings.each do |qmapping|
if qmapping.response
quiz_responses << qmapping.response
end
end
</pre>

'''After Change'''
<pre>
quiz_responses = quiz_response_mappings.select{ |qmapping| qmapping.response }.map(&:response)
</pre>

'''Before Change'''
<pre>
total = 0
self.questionnaires.each { |questionnaire| total += questionnaire.get_weighted_score(self, scores) }
total
</pre>

'''After Change'''
<pre>
self.questionnaires.inject(0) { |total, questionnaire| total + questionnaire.get_weighted_score(self, scores) }
</pre>

== Instance 2 : Addition of ActiveRecord like Query==

The queries where changed to function more like active record query. This made the queries database independent and more user friendly.

'''Before Change'''
<pre>
DueDate.where( ['assignment_id = ? and deadline_type_id >= ?', self.id, 7]).due_at
</pre>

'''After Change'''
<pre>
DueDate.where(assignment_id: self.id, deadline_type_id: 7).due_at
</pre>

== Instance 3 : Changing Gemfile==

Version of gem "EventMachine" was updated as earlier version was incompatible with ruby version 2.2.0. The version was changed from 1.0.3 to 1.0.7.

One more gem "quite_assets" was added to avoid unnecessary log creation of background functions.

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:52:21Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:48:41Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:45:22Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:35:44Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:34:46Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:33:31Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:21:24Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:18:54Z

Sbhawsi:

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T18:02:03Z

Sbhawsi:

'''E1501: Refactoring Assignments.rb'''

This page provides information about a project which aims to refactor Assignment.rb file present in Expertiza OSS.

'''Introduction to Expertiza''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains the functions responsible for grading.

'''What needs to be done:'''
 The assignment model needed a refactoring as it contains some modules which were responsible for generating assignment scores. Moreover, the querying module was database dependent which was made database independent. There were many function names and code lines which were not following the ruby guidelines. They were changed to more ruby like coding style. 

=Changes Made=

==SignupSheet Controller==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| create
| Fixed redirection after topic creation to Topics tab
| On successful creation of a topic, the action was merely redirecting to the assignments/edit view
|-
| update
| Fixed redirection after topic updation to Topics tab
| Once a topic was successfully edited, the view rendered was just a list of topics
|-
| edit
| Initialized @assignment_id variable
| The variable is used in the edit view
|-
| rowspan="3" valign="middle" |
destroy
| Renamed the 'delete' method to 'destroy'
| This was done for better Rails 4 routing compatibility
|-
| Initialized the assignment_id parameter
| This is used further on and is not passed from the link URL
|-
| Fixed redirection after topic deletion to Topics tab
| Once a topic was successfully deleted, the view rendered was just a list of topics
|}

==Views==

{| class="wikitable"
|-
! style="width:18%;"|View Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| rowspan="5" valign="middle" |
sign_up_sheet/_add_signup_topcis
| Fixed title
| The page title displayed for an instructor was "Sign-up sheet for ... "
|-
| Commented out View/Manage bookmark links
| These links were broken, and according to existing code were not meant for the instructor view.
|-
| Added variable initialization for @sign_up_topics
| The variable was referenced further on in the view, which was causing an 'nil value' error
|-
| Fixed flash message rendering for new topic creation
| The flash message was rendering incorrectly with HTML tags visible on the web page
|-
| Added full path names to partial names
| The shared partials were also being used by views in the Assignments controller, so full paths were needed
|-
| sign_up_sheet/_add_topics
| Added separation between the Import Topics and Manage Bookmarks links
| The two links were clumped together and it was difficult to distinguish between them
|-
| sign_up_sheet/_actions
| Replaced rendering of the reserve_topic partial with the _all_actions partial
| The reserve_topic partial is no longer being used and is replaced by the newly created _all_actions partial
|-
| sign_up_sheet/_all_actions
| Created this new partial
| We created the _all_actions partial to conditionally render the "Actions" table field for both instructors and students. This now also includes working links through which instructors or administrators can edit or delete topics.
|-
| sign_up_sheet/_table_line
| Gave edit/delete rights to Super Admin
| The Super-Administrator user wasn't included in the list of users with these permissions
|-
| sign_up_sheet/edit
| Modified title and included @assignment_id variable to be passed as a parameter variable to the update action
| The view was initially trying to access the params[:assignment_id] variable which was not getting initialized
|-
| assignments/edit
| Changed the partial rendered to /sign_up_sheet/add_signup_topcis.html
| The assignments/edit/add_signup_topics partial (with duplicated code) was otherwise being rendered
|}

= Re-factored Code Cases =

== Case 1 : Refactoring the AssignmentsController and SignupSheetController ==

===Removing duplicate _add_signup_topics partials===
The AssignmentsController displayed topics to the instructor while he was editing an assignment. It used _add_signup_topics.html.erb partial to render topics under the topics tab. The SignupSheetController displayed topics to a student who wanted to view signup topics under an assignment. It was found that it had its own copy namely _add_signup_topcis.html.erb to display topics to the student. We wanted to have these two controllers use the same views to render the same thing which was list of topics under an assignment. We made the AssignmentsController reuse the _add_signup_topcis.html.erb partial under the SignupSheetController.

view:assignments/edit.html.erb 
This view contains all the tabs to display like general,rubrics,review_strategy, topics which are related to the selected assignment. tabs-5 is the topics tab which we are interested in.
<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render 'assignments/edit/add_signup_topics' %>
</div>
</pre>

===After Changes===
We have redundant code in two methods so we merged add_signup_topics_staggered and add_signup_topics into add_signup_topics. The action calls single method for both type of assignments and renders views based on condition of staggered or non-staggered assignment.

<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render '/sign_up_sheet/add_signup_topcis.html' %>
</div>
</pre>

=== Refactoring view code into relevant views ===
There were no edit/delete links to edit/delete a topic in the instructor view. These had to be conditionally added based on the role of the currently logged in user. This was to prevent students from editing/deleting topics and to keep instructors from signing up for a topic. This was implemented as follows.

===Adding Edit/Delete functionality to topics tab===

The current expertiza project had two views to display the Actions column in the topics table. These were _reserve_topics.html.erb and _actions.html. The first one was displaying the signup button for the student and the latter was displaying the bookmarks and rendering the _reserve_topics.html.erb after the bookmarks. On top of this we had to add the edit/delete links for the instructor. A refactor was called for. We decided to create a _all_actions.html.erb partial which had the responsibility to display the relevant actions depending upon the role of the currently logged in user. This helped us remove the separate partial to render actions pertaining to a student, namely _reserve_topics.html.erb . Also the _actions.html.erb only took care of displaying the bookmark links rather than dealing with both bookmarks and actions.

partial_view:_all_actions,html.erb
<pre>
<% if ['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator'].include? current_user_role?.name %>
<td align="center">
<%= link_to image_tag('edit_icon.png', :border => 0, :title => 'Edit Topic', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'edit', :id => topic.id %>
<%= link_to image_tag('delete_icon.png', :border => 0, :title => 'Delete Topic', :align => 'middle'), sign_up_sheet_path(topic.id), method: :delete, data: {confirm: 'Are you sure?'} %>
<%elsif @show_actions %>
...
#Render signup button for student here. The @show_actions will be true if this partial is navigated from the SignupSheetController which is accessible only to students.
</pre>

== Case 2 : Cleaning up unused code ==
The Refactors mentioned above enable us to delete unused partials namely:

*assignments controller partials :
**_add_signup_topics.html.erb
**_reserve_topic.html.erb

*signup_sheet_controller partials :
**_reserve_topic.html.erb
 

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://152.46.18.5:3000/ VCL link] - This might not be available after Nov. 2014
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://docs.google.com/document/d/1FZCL9KWSdVNsX9BowuZ3gxbCOJoiWX-GVLctSZei3No The OSS project requirements doc (Fall 2014 - Expertiza)]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T05:42:57Z

Sbhawsi:

'''E1501: Refactoring Assignments.rb'''

This page provides information about a project which aims to refactor Assignment.rb file present in Expertiza OSS.

'''Introduction to Expertiza''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the score module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains the functions responsible for grading.

'''What needs to be done:'''
The Topics tab in the Assignments --> Edit view is not usable right now by an instructor when he/she is editing an assignment. The functionality that displays topics also needs to be usable by the student view, since students also have to view the list of topics (when they sign up for a topic). Instructor and student functionality is a little different: instructors can add topics and change the number of slots, but they can’t sign up for topics. The Topics tab needs to be fixed, edit/delete topic functionality is to be added for instructors and common/duplicate code needs to be refactored.

The functionality to display the topics under an assignment is duplicated between the AssignmentController views and the SignupSheetController views. Both the instructor and the student can view the topics by selecting an assignment and we were required to remove this duplication in the views. Consequently, most of our work dealt with modifying the SignupSheetController and its corresponding views.

=Changes Made=

==SignupSheet Controller==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| create
| Fixed redirection after topic creation to Topics tab
| On successful creation of a topic, the action was merely redirecting to the assignments/edit view
|-
| update
| Fixed redirection after topic updation to Topics tab
| Once a topic was successfully edited, the view rendered was just a list of topics
|-
| edit
| Initialized @assignment_id variable
| The variable is used in the edit view
|-
| rowspan="3" valign="middle" |
destroy
| Renamed the 'delete' method to 'destroy'
| This was done for better Rails 4 routing compatibility
|-
| Initialized the assignment_id parameter
| This is used further on and is not passed from the link URL
|-
| Fixed redirection after topic deletion to Topics tab
| Once a topic was successfully deleted, the view rendered was just a list of topics
|}

==Views==

{| class="wikitable"
|-
! style="width:18%;"|View Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| rowspan="5" valign="middle" |
sign_up_sheet/_add_signup_topcis
| Fixed title
| The page title displayed for an instructor was "Sign-up sheet for ... "
|-
| Commented out View/Manage bookmark links
| These links were broken, and according to existing code were not meant for the instructor view.
|-
| Added variable initialization for @sign_up_topics
| The variable was referenced further on in the view, which was causing an 'nil value' error
|-
| Fixed flash message rendering for new topic creation
| The flash message was rendering incorrectly with HTML tags visible on the web page
|-
| Added full path names to partial names
| The shared partials were also being used by views in the Assignments controller, so full paths were needed
|-
| sign_up_sheet/_add_topics
| Added separation between the Import Topics and Manage Bookmarks links
| The two links were clumped together and it was difficult to distinguish between them
|-
| sign_up_sheet/_actions
| Replaced rendering of the reserve_topic partial with the _all_actions partial
| The reserve_topic partial is no longer being used and is replaced by the newly created _all_actions partial
|-
| sign_up_sheet/_all_actions
| Created this new partial
| We created the _all_actions partial to conditionally render the "Actions" table field for both instructors and students. This now also includes working links through which instructors or administrators can edit or delete topics.
|-
| sign_up_sheet/_table_line
| Gave edit/delete rights to Super Admin
| The Super-Administrator user wasn't included in the list of users with these permissions
|-
| sign_up_sheet/edit
| Modified title and included @assignment_id variable to be passed as a parameter variable to the update action
| The view was initially trying to access the params[:assignment_id] variable which was not getting initialized
|-
| assignments/edit
| Changed the partial rendered to /sign_up_sheet/add_signup_topcis.html
| The assignments/edit/add_signup_topics partial (with duplicated code) was otherwise being rendered
|}

= Re-factored Code Cases =

== Case 1 : Refactoring the AssignmentsController and SignupSheetController ==

===Removing duplicate _add_signup_topics partials===
The AssignmentsController displayed topics to the instructor while he was editing an assignment. It used _add_signup_topics.html.erb partial to render topics under the topics tab. The SignupSheetController displayed topics to a student who wanted to view signup topics under an assignment. It was found that it had its own copy namely _add_signup_topcis.html.erb to display topics to the student. We wanted to have these two controllers use the same views to render the same thing which was list of topics under an assignment. We made the AssignmentsController reuse the _add_signup_topcis.html.erb partial under the SignupSheetController.

view:assignments/edit.html.erb 
This view contains all the tabs to display like general,rubrics,review_strategy, topics which are related to the selected assignment. tabs-5 is the topics tab which we are interested in.
<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render 'assignments/edit/add_signup_topics' %>
</div>
</pre>

===After Changes===
We have redundant code in two methods so we merged add_signup_topics_staggered and add_signup_topics into add_signup_topics. The action calls single method for both type of assignments and renders views based on condition of staggered or non-staggered assignment.

<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render '/sign_up_sheet/add_signup_topcis.html' %>
</div>
</pre>

=== Refactoring view code into relevant views ===
There were no edit/delete links to edit/delete a topic in the instructor view. These had to be conditionally added based on the role of the currently logged in user. This was to prevent students from editing/deleting topics and to keep instructors from signing up for a topic. This was implemented as follows.

===Adding Edit/Delete functionality to topics tab===

The current expertiza project had two views to display the Actions column in the topics table. These were _reserve_topics.html.erb and _actions.html. The first one was displaying the signup button for the student and the latter was displaying the bookmarks and rendering the _reserve_topics.html.erb after the bookmarks. On top of this we had to add the edit/delete links for the instructor. A refactor was called for. We decided to create a _all_actions.html.erb partial which had the responsibility to display the relevant actions depending upon the role of the currently logged in user. This helped us remove the separate partial to render actions pertaining to a student, namely _reserve_topics.html.erb . Also the _actions.html.erb only took care of displaying the bookmark links rather than dealing with both bookmarks and actions.

partial_view:_all_actions,html.erb
<pre>
<% if ['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator'].include? current_user_role?.name %>
<td align="center">
<%= link_to image_tag('edit_icon.png', :border => 0, :title => 'Edit Topic', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'edit', :id => topic.id %>
<%= link_to image_tag('delete_icon.png', :border => 0, :title => 'Delete Topic', :align => 'middle'), sign_up_sheet_path(topic.id), method: :delete, data: {confirm: 'Are you sure?'} %>
<%elsif @show_actions %>
...
#Render signup button for student here. The @show_actions will be true if this partial is navigated from the SignupSheetController which is accessible only to students.
</pre>

== Case 2 : Cleaning up unused code ==
The Refactors mentioned above enable us to delete unused partials namely:

*assignments controller partials :
**_add_signup_topics.html.erb
**_reserve_topic.html.erb

*signup_sheet_controller partials :
**_reserve_topic.html.erb
 

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://152.46.18.5:3000/ VCL link] - This might not be available after Nov. 2014
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://docs.google.com/document/d/1FZCL9KWSdVNsX9BowuZ3gxbCOJoiWX-GVLctSZei3No The OSS project requirements doc (Fall 2014 - Expertiza)]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T05:42:26Z

Sbhawsi:

'''E1501: Refactoring Assignments.rb'''

This page provides information about a project which aims to refactor Assignment.rb file present in Expertiza OSS.

'''Introduction to Expertiza''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the grading module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb
scorable.rb
Gemfile
schema.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains the functions responsible for grading.

'''What needs to be done:'''
The Topics tab in the Assignments --> Edit view is not usable right now by an instructor when he/she is editing an assignment. The functionality that displays topics also needs to be usable by the student view, since students also have to view the list of topics (when they sign up for a topic). Instructor and student functionality is a little different: instructors can add topics and change the number of slots, but they can’t sign up for topics. The Topics tab needs to be fixed, edit/delete topic functionality is to be added for instructors and common/duplicate code needs to be refactored.

The functionality to display the topics under an assignment is duplicated between the AssignmentController views and the SignupSheetController views. Both the instructor and the student can view the topics by selecting an assignment and we were required to remove this duplication in the views. Consequently, most of our work dealt with modifying the SignupSheetController and its corresponding views.

=Changes Made=

==SignupSheet Controller==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| create
| Fixed redirection after topic creation to Topics tab
| On successful creation of a topic, the action was merely redirecting to the assignments/edit view
|-
| update
| Fixed redirection after topic updation to Topics tab
| Once a topic was successfully edited, the view rendered was just a list of topics
|-
| edit
| Initialized @assignment_id variable
| The variable is used in the edit view
|-
| rowspan="3" valign="middle" |
destroy
| Renamed the 'delete' method to 'destroy'
| This was done for better Rails 4 routing compatibility
|-
| Initialized the assignment_id parameter
| This is used further on and is not passed from the link URL
|-
| Fixed redirection after topic deletion to Topics tab
| Once a topic was successfully deleted, the view rendered was just a list of topics
|}

==Views==

{| class="wikitable"
|-
! style="width:18%;"|View Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| rowspan="5" valign="middle" |
sign_up_sheet/_add_signup_topcis
| Fixed title
| The page title displayed for an instructor was "Sign-up sheet for ... "
|-
| Commented out View/Manage bookmark links
| These links were broken, and according to existing code were not meant for the instructor view.
|-
| Added variable initialization for @sign_up_topics
| The variable was referenced further on in the view, which was causing an 'nil value' error
|-
| Fixed flash message rendering for new topic creation
| The flash message was rendering incorrectly with HTML tags visible on the web page
|-
| Added full path names to partial names
| The shared partials were also being used by views in the Assignments controller, so full paths were needed
|-
| sign_up_sheet/_add_topics
| Added separation between the Import Topics and Manage Bookmarks links
| The two links were clumped together and it was difficult to distinguish between them
|-
| sign_up_sheet/_actions
| Replaced rendering of the reserve_topic partial with the _all_actions partial
| The reserve_topic partial is no longer being used and is replaced by the newly created _all_actions partial
|-
| sign_up_sheet/_all_actions
| Created this new partial
| We created the _all_actions partial to conditionally render the "Actions" table field for both instructors and students. This now also includes working links through which instructors or administrators can edit or delete topics.
|-
| sign_up_sheet/_table_line
| Gave edit/delete rights to Super Admin
| The Super-Administrator user wasn't included in the list of users with these permissions
|-
| sign_up_sheet/edit
| Modified title and included @assignment_id variable to be passed as a parameter variable to the update action
| The view was initially trying to access the params[:assignment_id] variable which was not getting initialized
|-
| assignments/edit
| Changed the partial rendered to /sign_up_sheet/add_signup_topcis.html
| The assignments/edit/add_signup_topics partial (with duplicated code) was otherwise being rendered
|}

= Re-factored Code Cases =

== Case 1 : Refactoring the AssignmentsController and SignupSheetController ==

===Removing duplicate _add_signup_topics partials===
The AssignmentsController displayed topics to the instructor while he was editing an assignment. It used _add_signup_topics.html.erb partial to render topics under the topics tab. The SignupSheetController displayed topics to a student who wanted to view signup topics under an assignment. It was found that it had its own copy namely _add_signup_topcis.html.erb to display topics to the student. We wanted to have these two controllers use the same views to render the same thing which was list of topics under an assignment. We made the AssignmentsController reuse the _add_signup_topcis.html.erb partial under the SignupSheetController.

view:assignments/edit.html.erb 
This view contains all the tabs to display like general,rubrics,review_strategy, topics which are related to the selected assignment. tabs-5 is the topics tab which we are interested in.
<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render 'assignments/edit/add_signup_topics' %>
</div>
</pre>

===After Changes===
We have redundant code in two methods so we merged add_signup_topics_staggered and add_signup_topics into add_signup_topics. The action calls single method for both type of assignments and renders views based on condition of staggered or non-staggered assignment.

<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render '/sign_up_sheet/add_signup_topcis.html' %>
</div>
</pre>

=== Refactoring view code into relevant views ===
There were no edit/delete links to edit/delete a topic in the instructor view. These had to be conditionally added based on the role of the currently logged in user. This was to prevent students from editing/deleting topics and to keep instructors from signing up for a topic. This was implemented as follows.

===Adding Edit/Delete functionality to topics tab===

The current expertiza project had two views to display the Actions column in the topics table. These were _reserve_topics.html.erb and _actions.html. The first one was displaying the signup button for the student and the latter was displaying the bookmarks and rendering the _reserve_topics.html.erb after the bookmarks. On top of this we had to add the edit/delete links for the instructor. A refactor was called for. We decided to create a _all_actions.html.erb partial which had the responsibility to display the relevant actions depending upon the role of the currently logged in user. This helped us remove the separate partial to render actions pertaining to a student, namely _reserve_topics.html.erb . Also the _actions.html.erb only took care of displaying the bookmark links rather than dealing with both bookmarks and actions.

partial_view:_all_actions,html.erb
<pre>
<% if ['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator'].include? current_user_role?.name %>
<td align="center">
<%= link_to image_tag('edit_icon.png', :border => 0, :title => 'Edit Topic', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'edit', :id => topic.id %>
<%= link_to image_tag('delete_icon.png', :border => 0, :title => 'Delete Topic', :align => 'middle'), sign_up_sheet_path(topic.id), method: :delete, data: {confirm: 'Are you sure?'} %>
<%elsif @show_actions %>
...
#Render signup button for student here. The @show_actions will be true if this partial is navigated from the SignupSheetController which is accessible only to students.
</pre>

== Case 2 : Cleaning up unused code ==
The Refactors mentioned above enable us to delete unused partials namely:

*assignments controller partials :
**_add_signup_topics.html.erb
**_reserve_topic.html.erb

*signup_sheet_controller partials :
**_reserve_topic.html.erb
 

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://152.46.18.5:3000/ VCL link] - This might not be available after Nov. 2014
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://docs.google.com/document/d/1FZCL9KWSdVNsX9BowuZ3gxbCOJoiWX-GVLctSZei3No The OSS project requirements doc (Fall 2014 - Expertiza)]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T05:14:56Z

Sbhawsi:

'''E1501: Refactoring Assignments.rb'''

This page provides information about a project which aims to refactor Assignment.rb file present in Expertiza OSS.

'''Introduction to Expertiza''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the grading module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains the functions responsible for grading.

'''What needs to be done:'''
The Topics tab in the Assignments --> Edit view is not usable right now by an instructor when he/she is editing an assignment. The functionality that displays topics also needs to be usable by the student view, since students also have to view the list of topics (when they sign up for a topic). Instructor and student functionality is a little different: instructors can add topics and change the number of slots, but they can’t sign up for topics. The Topics tab needs to be fixed, edit/delete topic functionality is to be added for instructors and common/duplicate code needs to be refactored.

The functionality to display the topics under an assignment is duplicated between the AssignmentController views and the SignupSheetController views. Both the instructor and the student can view the topics by selecting an assignment and we were required to remove this duplication in the views. Consequently, most of our work dealt with modifying the SignupSheetController and its corresponding views.

=Changes Made=

==SignupSheet Controller==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| create
| Fixed redirection after topic creation to Topics tab
| On successful creation of a topic, the action was merely redirecting to the assignments/edit view
|-
| update
| Fixed redirection after topic updation to Topics tab
| Once a topic was successfully edited, the view rendered was just a list of topics
|-
| edit
| Initialized @assignment_id variable
| The variable is used in the edit view
|-
| rowspan="3" valign="middle" |
destroy
| Renamed the 'delete' method to 'destroy'
| This was done for better Rails 4 routing compatibility
|-
| Initialized the assignment_id parameter
| This is used further on and is not passed from the link URL
|-
| Fixed redirection after topic deletion to Topics tab
| Once a topic was successfully deleted, the view rendered was just a list of topics
|}

==Views==

{| class="wikitable"
|-
! style="width:18%;"|View Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| rowspan="5" valign="middle" |
sign_up_sheet/_add_signup_topcis
| Fixed title
| The page title displayed for an instructor was "Sign-up sheet for ... "
|-
| Commented out View/Manage bookmark links
| These links were broken, and according to existing code were not meant for the instructor view.
|-
| Added variable initialization for @sign_up_topics
| The variable was referenced further on in the view, which was causing an 'nil value' error
|-
| Fixed flash message rendering for new topic creation
| The flash message was rendering incorrectly with HTML tags visible on the web page
|-
| Added full path names to partial names
| The shared partials were also being used by views in the Assignments controller, so full paths were needed
|-
| sign_up_sheet/_add_topics
| Added separation between the Import Topics and Manage Bookmarks links
| The two links were clumped together and it was difficult to distinguish between them
|-
| sign_up_sheet/_actions
| Replaced rendering of the reserve_topic partial with the _all_actions partial
| The reserve_topic partial is no longer being used and is replaced by the newly created _all_actions partial
|-
| sign_up_sheet/_all_actions
| Created this new partial
| We created the _all_actions partial to conditionally render the "Actions" table field for both instructors and students. This now also includes working links through which instructors or administrators can edit or delete topics.
|-
| sign_up_sheet/_table_line
| Gave edit/delete rights to Super Admin
| The Super-Administrator user wasn't included in the list of users with these permissions
|-
| sign_up_sheet/edit
| Modified title and included @assignment_id variable to be passed as a parameter variable to the update action
| The view was initially trying to access the params[:assignment_id] variable which was not getting initialized
|-
| assignments/edit
| Changed the partial rendered to /sign_up_sheet/add_signup_topcis.html
| The assignments/edit/add_signup_topics partial (with duplicated code) was otherwise being rendered
|}

= Re-factored Code Cases =

== Case 1 : Refactoring the AssignmentsController and SignupSheetController ==

===Removing duplicate _add_signup_topics partials===
The AssignmentsController displayed topics to the instructor while he was editing an assignment. It used _add_signup_topics.html.erb partial to render topics under the topics tab. The SignupSheetController displayed topics to a student who wanted to view signup topics under an assignment. It was found that it had its own copy namely _add_signup_topcis.html.erb to display topics to the student. We wanted to have these two controllers use the same views to render the same thing which was list of topics under an assignment. We made the AssignmentsController reuse the _add_signup_topcis.html.erb partial under the SignupSheetController.

view:assignments/edit.html.erb 
This view contains all the tabs to display like general,rubrics,review_strategy, topics which are related to the selected assignment. tabs-5 is the topics tab which we are interested in.
<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render 'assignments/edit/add_signup_topics' %>
</div>
</pre>

===After Changes===
We have redundant code in two methods so we merged add_signup_topics_staggered and add_signup_topics into add_signup_topics. The action calls single method for both type of assignments and renders views based on condition of staggered or non-staggered assignment.

<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render '/sign_up_sheet/add_signup_topcis.html' %>
</div>
</pre>

=== Refactoring view code into relevant views ===
There were no edit/delete links to edit/delete a topic in the instructor view. These had to be conditionally added based on the role of the currently logged in user. This was to prevent students from editing/deleting topics and to keep instructors from signing up for a topic. This was implemented as follows.

===Adding Edit/Delete functionality to topics tab===

The current expertiza project had two views to display the Actions column in the topics table. These were _reserve_topics.html.erb and _actions.html. The first one was displaying the signup button for the student and the latter was displaying the bookmarks and rendering the _reserve_topics.html.erb after the bookmarks. On top of this we had to add the edit/delete links for the instructor. A refactor was called for. We decided to create a _all_actions.html.erb partial which had the responsibility to display the relevant actions depending upon the role of the currently logged in user. This helped us remove the separate partial to render actions pertaining to a student, namely _reserve_topics.html.erb . Also the _actions.html.erb only took care of displaying the bookmark links rather than dealing with both bookmarks and actions.

partial_view:_all_actions,html.erb
<pre>
<% if ['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator'].include? current_user_role?.name %>
<td align="center">
<%= link_to image_tag('edit_icon.png', :border => 0, :title => 'Edit Topic', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'edit', :id => topic.id %>
<%= link_to image_tag('delete_icon.png', :border => 0, :title => 'Delete Topic', :align => 'middle'), sign_up_sheet_path(topic.id), method: :delete, data: {confirm: 'Are you sure?'} %>
<%elsif @show_actions %>
...
#Render signup button for student here. The @show_actions will be true if this partial is navigated from the SignupSheetController which is accessible only to students.
</pre>

== Case 2 : Cleaning up unused code ==
The Refactors mentioned above enable us to delete unused partials namely:

*assignments controller partials :
**_add_signup_topics.html.erb
**_reserve_topic.html.erb

*signup_sheet_controller partials :
**_reserve_topic.html.erb
 

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://152.46.18.5:3000/ VCL link] - This might not be available after Nov. 2014
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://docs.google.com/document/d/1FZCL9KWSdVNsX9BowuZ3gxbCOJoiWX-GVLctSZei3No The OSS project requirements doc (Fall 2014 - Expertiza)]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T05:14:17Z

Sbhawsi:

'''E1501: Refactoring Assignments.rb'''

This page provides information about a project which aims to refactor Assignment.rb file present in Expertiza OSS.

'''Introduction to Expertiza''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model and the related functionality. It also contains the grading module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb

'''What they do'''
Assignment.rb along with the controller file is responsible for creating and editing the assignments. The file also contains the functions responsible for grading.

'''What needs to be done:'''
The Topics tab in the Assignments --> Edit view is not usable right now by an instructor when he/she is editing an assignment. The functionality that displays topics also needs to be usable by the student view, since students also have to view the list of topics (when they sign up for a topic). Instructor and student functionality is a little different: instructors can add topics and change the number of slots, but they can’t sign up for topics. The Topics tab needs to be fixed, edit/delete topic functionality is to be added for instructors and common/duplicate code needs to be refactored.

The functionality to display the topics under an assignment is duplicated between the AssignmentController views and the SignupSheetController views. Both the instructor and the student can view the topics by selecting an assignment and we were required to remove this duplication in the views. Consequently, most of our work dealt with modifying the SignupSheetController and its corresponding views.

=Changes Made=

==SignupSheet Controller==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| create
| Fixed redirection after topic creation to Topics tab
| On successful creation of a topic, the action was merely redirecting to the assignments/edit view
|-
| update
| Fixed redirection after topic updation to Topics tab
| Once a topic was successfully edited, the view rendered was just a list of topics
|-
| edit
| Initialized @assignment_id variable
| The variable is used in the edit view
|-
| rowspan="3" valign="middle" |
destroy
| Renamed the 'delete' method to 'destroy'
| This was done for better Rails 4 routing compatibility
|-
| Initialized the assignment_id parameter
| This is used further on and is not passed from the link URL
|-
| Fixed redirection after topic deletion to Topics tab
| Once a topic was successfully deleted, the view rendered was just a list of topics
|}

==Views==

{| class="wikitable"
|-
! style="width:18%;"|View Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| rowspan="5" valign="middle" |
sign_up_sheet/_add_signup_topcis
| Fixed title
| The page title displayed for an instructor was "Sign-up sheet for ... "
|-
| Commented out View/Manage bookmark links
| These links were broken, and according to existing code were not meant for the instructor view.
|-
| Added variable initialization for @sign_up_topics
| The variable was referenced further on in the view, which was causing an 'nil value' error
|-
| Fixed flash message rendering for new topic creation
| The flash message was rendering incorrectly with HTML tags visible on the web page
|-
| Added full path names to partial names
| The shared partials were also being used by views in the Assignments controller, so full paths were needed
|-
| sign_up_sheet/_add_topics
| Added separation between the Import Topics and Manage Bookmarks links
| The two links were clumped together and it was difficult to distinguish between them
|-
| sign_up_sheet/_actions
| Replaced rendering of the reserve_topic partial with the _all_actions partial
| The reserve_topic partial is no longer being used and is replaced by the newly created _all_actions partial
|-
| sign_up_sheet/_all_actions
| Created this new partial
| We created the _all_actions partial to conditionally render the "Actions" table field for both instructors and students. This now also includes working links through which instructors or administrators can edit or delete topics.
|-
| sign_up_sheet/_table_line
| Gave edit/delete rights to Super Admin
| The Super-Administrator user wasn't included in the list of users with these permissions
|-
| sign_up_sheet/edit
| Modified title and included @assignment_id variable to be passed as a parameter variable to the update action
| The view was initially trying to access the params[:assignment_id] variable which was not getting initialized
|-
| assignments/edit
| Changed the partial rendered to /sign_up_sheet/add_signup_topcis.html
| The assignments/edit/add_signup_topics partial (with duplicated code) was otherwise being rendered
|}

= Re-factored Code Cases =

== Case 1 : Refactoring the AssignmentsController and SignupSheetController ==

===Removing duplicate _add_signup_topics partials===
The AssignmentsController displayed topics to the instructor while he was editing an assignment. It used _add_signup_topics.html.erb partial to render topics under the topics tab. The SignupSheetController displayed topics to a student who wanted to view signup topics under an assignment. It was found that it had its own copy namely _add_signup_topcis.html.erb to display topics to the student. We wanted to have these two controllers use the same views to render the same thing which was list of topics under an assignment. We made the AssignmentsController reuse the _add_signup_topcis.html.erb partial under the SignupSheetController.

view:assignments/edit.html.erb 
This view contains all the tabs to display like general,rubrics,review_strategy, topics which are related to the selected assignment. tabs-5 is the topics tab which we are interested in.
<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render 'assignments/edit/add_signup_topics' %>
</div>
</pre>

===After Changes===
We have redundant code in two methods so we merged add_signup_topics_staggered and add_signup_topics into add_signup_topics. The action calls single method for both type of assignments and renders views based on condition of staggered or non-staggered assignment.

<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render '/sign_up_sheet/add_signup_topcis.html' %>
</div>
</pre>

=== Refactoring view code into relevant views ===
There were no edit/delete links to edit/delete a topic in the instructor view. These had to be conditionally added based on the role of the currently logged in user. This was to prevent students from editing/deleting topics and to keep instructors from signing up for a topic. This was implemented as follows.

===Adding Edit/Delete functionality to topics tab===

The current expertiza project had two views to display the Actions column in the topics table. These were _reserve_topics.html.erb and _actions.html. The first one was displaying the signup button for the student and the latter was displaying the bookmarks and rendering the _reserve_topics.html.erb after the bookmarks. On top of this we had to add the edit/delete links for the instructor. A refactor was called for. We decided to create a _all_actions.html.erb partial which had the responsibility to display the relevant actions depending upon the role of the currently logged in user. This helped us remove the separate partial to render actions pertaining to a student, namely _reserve_topics.html.erb . Also the _actions.html.erb only took care of displaying the bookmark links rather than dealing with both bookmarks and actions.

partial_view:_all_actions,html.erb
<pre>
<% if ['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator'].include? current_user_role?.name %>
<td align="center">
<%= link_to image_tag('edit_icon.png', :border => 0, :title => 'Edit Topic', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'edit', :id => topic.id %>
<%= link_to image_tag('delete_icon.png', :border => 0, :title => 'Delete Topic', :align => 'middle'), sign_up_sheet_path(topic.id), method: :delete, data: {confirm: 'Are you sure?'} %>
<%elsif @show_actions %>
...
#Render signup button for student here. The @show_actions will be true if this partial is navigated from the SignupSheetController which is accessible only to students.
</pre>

== Case 2 : Cleaning up unused code ==
The Refactors mentioned above enable us to delete unused partials namely:

*assignments controller partials :
**_add_signup_topics.html.erb
**_reserve_topic.html.erb

*signup_sheet_controller partials :
**_reserve_topic.html.erb
 

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://152.46.18.5:3000/ VCL link] - This might not be available after Nov. 2014
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://docs.google.com/document/d/1FZCL9KWSdVNsX9BowuZ3gxbCOJoiWX-GVLctSZei3No The OSS project requirements doc (Fall 2014 - Expertiza)]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]

CSC/ECE 517 Spring 2015/oss E1501 YWS

2015-03-23T05:11:33Z

Sbhawsi: Created page with "'''E1501: Refactoring Assignments.rb''' This page provides information about a project which aims to refactor Assignment.rb file present in Expertiza OSS. '''Introduction to Ex..."

'''E1501: Refactoring Assignments.rb'''

This page provides information about a project which aims to refactor Assignment.rb file present in Expertiza OSS.

'''Introduction to Expertiza''' 

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using the [http://rubyonrails.org/ Ruby on Rails] platform. It provides features like team assignments, peer review, submission of projects, grading etc. The code can be cloned from [https://github.com/expertiza/expertiza GitHub]. This application provides an efficient way to manage assignments, grades and reviews, which makes the process easier and faster when the class strength is large.

Assignment.rb is a file which contains the assignment model which is used to create and edit assignments and the related functionality. It also contains the grading module which is refactored to make the file more clean and easy to read.

__TOC__

= Problem Statement =
'''Classes involved:'''
assignment.rb

'''What needs to be done:'''
The Topics tab in the Assignments --> Edit view is not usable right now by an instructor when he/she is editing an assignment. The functionality that displays topics also needs to be usable by the student view, since students also have to view the list of topics (when they sign up for a topic). Instructor and student functionality is a little different: instructors can add topics and change the number of slots, but they can’t sign up for topics. The Topics tab needs to be fixed, edit/delete topic functionality is to be added for instructors and common/duplicate code needs to be refactored.

The functionality to display the topics under an assignment is duplicated between the AssignmentController views and the SignupSheetController views. Both the instructor and the student can view the topics by selecting an assignment and we were required to remove this duplication in the views. Consequently, most of our work dealt with modifying the SignupSheetController and its corresponding views.

=Changes Made=

==SignupSheet Controller==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| create
| Fixed redirection after topic creation to Topics tab
| On successful creation of a topic, the action was merely redirecting to the assignments/edit view
|-
| update
| Fixed redirection after topic updation to Topics tab
| Once a topic was successfully edited, the view rendered was just a list of topics
|-
| edit
| Initialized @assignment_id variable
| The variable is used in the edit view
|-
| rowspan="3" valign="middle" |
destroy
| Renamed the 'delete' method to 'destroy'
| This was done for better Rails 4 routing compatibility
|-
| Initialized the assignment_id parameter
| This is used further on and is not passed from the link URL
|-
| Fixed redirection after topic deletion to Topics tab
| Once a topic was successfully deleted, the view rendered was just a list of topics
|}

==Views==

{| class="wikitable"
|-
! style="width:18%;"|View Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| rowspan="5" valign="middle" |
sign_up_sheet/_add_signup_topcis
| Fixed title
| The page title displayed for an instructor was "Sign-up sheet for ... "
|-
| Commented out View/Manage bookmark links
| These links were broken, and according to existing code were not meant for the instructor view.
|-
| Added variable initialization for @sign_up_topics
| The variable was referenced further on in the view, which was causing an 'nil value' error
|-
| Fixed flash message rendering for new topic creation
| The flash message was rendering incorrectly with HTML tags visible on the web page
|-
| Added full path names to partial names
| The shared partials were also being used by views in the Assignments controller, so full paths were needed
|-
| sign_up_sheet/_add_topics
| Added separation between the Import Topics and Manage Bookmarks links
| The two links were clumped together and it was difficult to distinguish between them
|-
| sign_up_sheet/_actions
| Replaced rendering of the reserve_topic partial with the _all_actions partial
| The reserve_topic partial is no longer being used and is replaced by the newly created _all_actions partial
|-
| sign_up_sheet/_all_actions
| Created this new partial
| We created the _all_actions partial to conditionally render the "Actions" table field for both instructors and students. This now also includes working links through which instructors or administrators can edit or delete topics.
|-
| sign_up_sheet/_table_line
| Gave edit/delete rights to Super Admin
| The Super-Administrator user wasn't included in the list of users with these permissions
|-
| sign_up_sheet/edit
| Modified title and included @assignment_id variable to be passed as a parameter variable to the update action
| The view was initially trying to access the params[:assignment_id] variable which was not getting initialized
|-
| assignments/edit
| Changed the partial rendered to /sign_up_sheet/add_signup_topcis.html
| The assignments/edit/add_signup_topics partial (with duplicated code) was otherwise being rendered
|}

= Re-factored Code Cases =

== Case 1 : Refactoring the AssignmentsController and SignupSheetController ==

===Removing duplicate _add_signup_topics partials===
The AssignmentsController displayed topics to the instructor while he was editing an assignment. It used _add_signup_topics.html.erb partial to render topics under the topics tab. The SignupSheetController displayed topics to a student who wanted to view signup topics under an assignment. It was found that it had its own copy namely _add_signup_topcis.html.erb to display topics to the student. We wanted to have these two controllers use the same views to render the same thing which was list of topics under an assignment. We made the AssignmentsController reuse the _add_signup_topcis.html.erb partial under the SignupSheetController.

view:assignments/edit.html.erb 
This view contains all the tabs to display like general,rubrics,review_strategy, topics which are related to the selected assignment. tabs-5 is the topics tab which we are interested in.
<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render 'assignments/edit/add_signup_topics' %>
</div>
</pre>

===After Changes===
We have redundant code in two methods so we merged add_signup_topics_staggered and add_signup_topics into add_signup_topics. The action calls single method for both type of assignments and renders views based on condition of staggered or non-staggered assignment.

<pre>
<div id="tabs-3">
<%= render 'assignments/edit/review_strategy' %>
</div>
<div id="tabs-4">
<%= render 'assignments/edit/due_dates' %>
</div>
<div id="tabs-5">
<%= render '/sign_up_sheet/add_signup_topcis.html' %>
</div>
</pre>

=== Refactoring view code into relevant views ===
There were no edit/delete links to edit/delete a topic in the instructor view. These had to be conditionally added based on the role of the currently logged in user. This was to prevent students from editing/deleting topics and to keep instructors from signing up for a topic. This was implemented as follows.

===Adding Edit/Delete functionality to topics tab===

The current expertiza project had two views to display the Actions column in the topics table. These were _reserve_topics.html.erb and _actions.html. The first one was displaying the signup button for the student and the latter was displaying the bookmarks and rendering the _reserve_topics.html.erb after the bookmarks. On top of this we had to add the edit/delete links for the instructor. A refactor was called for. We decided to create a _all_actions.html.erb partial which had the responsibility to display the relevant actions depending upon the role of the currently logged in user. This helped us remove the separate partial to render actions pertaining to a student, namely _reserve_topics.html.erb . Also the _actions.html.erb only took care of displaying the bookmark links rather than dealing with both bookmarks and actions.

partial_view:_all_actions,html.erb
<pre>
<% if ['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator'].include? current_user_role?.name %>
<td align="center">
<%= link_to image_tag('edit_icon.png', :border => 0, :title => 'Edit Topic', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'edit', :id => topic.id %>
<%= link_to image_tag('delete_icon.png', :border => 0, :title => 'Delete Topic', :align => 'middle'), sign_up_sheet_path(topic.id), method: :delete, data: {confirm: 'Are you sure?'} %>
<%elsif @show_actions %>
...
#Render signup button for student here. The @show_actions will be true if this partial is navigated from the SignupSheetController which is accessible only to students.
</pre>

== Case 2 : Cleaning up unused code ==
The Refactors mentioned above enable us to delete unused partials namely:

*assignments controller partials :
**_add_signup_topics.html.erb
**_reserve_topic.html.erb

*signup_sheet_controller partials :
**_reserve_topic.html.erb
 

=Steps to verify changes=

=See Also=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/itsmylifesoham/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://152.46.18.5:3000/ VCL link] - This might not be available after Nov. 2014
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://docs.google.com/document/d/1FZCL9KWSdVNsX9BowuZ3gxbCOJoiWX-GVLctSZei3No The OSS project requirements doc (Fall 2014 - Expertiza)]

= References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] 
[http://en.wikipedia.org/wiki/Code_smell Code smell]