CSC/ECE 517 Spring 2014/ch1a 1e rm - Revision history

Rjlloyd: /* Metrics */

2014-02-19T05:42:54Z

Metrics

← Older revision		Revision as of 05:42, 19 February 2014
Line 171:		Line 171:
	Moving methods and parameters around to where they have the best accessibility also has its uses. Classes also tend to be promoted or demoted to super and sub classes after their ultimate functional purpose is determined.		Moving methods and parameters around to where they have the best accessibility also has its uses. Classes also tend to be promoted or demoted to super and sub classes after their ultimate functional purpose is determined.

	==~~Metrics~~==		==Metric Tools==
	It can be hard to decide whether or not to refactor, especially when it’s for something that appears to be working fine with just a surface level smell. Program analysis tools are used to derive various types of code metrics, which allow coders to identify problem areas and future pitfalls of their code base. These tools look at the code in several different ways, including the number of times a source file has been edited to help determine if it is a possible target of [feature envy], duplicate code structure to identify replicated lines, and block depths to suggest possible complexity issues.		It can be hard to decide whether or not to refactor, especially when it’s for something that appears to be working fine with just a surface level smell. Program analysis tools are used to derive various types of code metrics, which allow coders to identify problem areas and future pitfalls of their code base. These tools look at the code in several different ways, including the number of times a source file has been edited to help determine if it is a possible target of [feature envy], duplicate code structure to identify replicated lines, and block depths to suggest possible complexity issues.

Rjlloyd: /* More Techniques */

2014-02-19T05:42:08Z

More Techniques

← Older revision		Revision as of 05:42, 19 February 2014
Line 170:		Line 170:

	Moving methods and parameters around to where they have the best accessibility also has its uses. Classes also tend to be promoted or demoted to super and sub classes after their ultimate functional purpose is determined.		Moving methods and parameters around to where they have the best accessibility also has its uses. Classes also tend to be promoted or demoted to super and sub classes after their ultimate functional purpose is determined.

	~~===More Techniques===~~
	~~There many more techniques than those that are listed above. Each has its specific purpose, though one must take care to make sure that it is a necessary refactoring.~~

	==Metrics==		==Metrics==

Rjlloyd: /* Best Practices */

2014-02-19T05:37:05Z

Best Practices

← Older revision		Revision as of 05:37, 19 February 2014
Line 190:		Line 190:

	For cyclomatic complexity (the number of possible paths), Saikuro is commonly employed and made to be easy to implement. For code complexity, Flog is the typical choice by the open source community of users.<ref>http://www.sitepoint.com/code-metrics-and-you/</ref>		For cyclomatic complexity (the number of possible paths), Saikuro is commonly employed and made to be easy to implement. For code complexity, Flog is the typical choice by the open source community of users.<ref>http://www.sitepoint.com/code-metrics-and-you/</ref>

	~~===Best Practices===~~
	~~Because~~

	==Getting Started with Refactoring==		==Getting Started with Refactoring==

Rjlloyd: /* Metrics */

2014-02-19T05:32:08Z

Metrics

@@ Line 176: / Line 176: @@
 ==Metrics==
 It can be hard to decide whether or not to refactor, especially when it’s for something that appears to be working fine with just a surface level smell. Program analysis tools are used to derive various types of code metrics, which allow coders to identify problem areas and future pitfalls of their code base. These tools look at the code in several different ways, including the number of times a source file has been edited to help determine if it is a possible target of [feature envy], duplicate code structure to identify replicated lines, and block depths to suggest possible complexity issues.
 ===Open Source Ruby Metric Tools===
@@ Line 183: / Line 190: @@
 For cyclomatic complexity (the number of possible paths),  Saikuro is commonly employed and made to be easy to implement. For code complexity, Flog is the typical choice by the open source community of users.<ref>http://www.sitepoint.com/code-metrics-and-you/</ref>
 ===Best Practices===

Rjlloyd: /* Metrics */

2014-02-19T05:31:47Z

Metrics

← Older revision		Revision as of 05:31, 19 February 2014
Line 180:		Line 180:
	There are a variety of open source code metric tools that can be employed specifically for Ruby programs. [https://www.ruby-toolbox.com/categories/code_metrics The Ruby Toolbox] contains the most popular of these tools along with ratings.		There are a variety of open source code metric tools that can be employed specifically for Ruby programs. [https://www.ruby-toolbox.com/categories/code_metrics The Ruby Toolbox] contains the most popular of these tools along with ratings.

	[http://rubydoc.info/gems/simplecov/frames Simple Cov] is at the top of this list. It was developed specifically to be of use to anyone using any framework. It integrates itself with the project’s own test cases to check the code coverage of them in addition to cucumber features.		[http://rubydoc.info/gems/simplecov/frames Simple Cov] is at the top of this list for code coverage. It was developed specifically to be of use to anyone using any framework. It integrates itself with the project’s own test cases to check the code coverage of them in addition to cucumber features.

			For cyclomatic complexity (the number of possible paths), Saikuro is commonly employed and made to be easy to implement. For code complexity, Flog is the typical choice by the open source community of users.<ref>http://www.sitepoint.com/code-metrics-and-you/</ref>

	===Code Climate===		===Code Climate===
Line 187:		Line 189:
	#Duplication Metric - This looks at the syntax trees of the code in order to identify identical and similar code structures. Because the syntax trees are being analyzed, code formatting and different method and class names do not affect the score. <ref>https://codeclimate.com/docs#quality-metrics</ref>		#Duplication Metric - This looks at the syntax trees of the code in order to identify identical and similar code structures. Because the syntax trees are being analyzed, code formatting and different method and class names do not affect the score. <ref>https://codeclimate.com/docs#quality-metrics</ref>
	#Churn Method - This integrates with the Git repository to look at the change history of the project’s files. Files with excessively high change histories have a tendency to have a high complexity rating as well, as they can be the result of feature envy, where extra functions are added into a file instead of being added to a new file with its own functionality.		#Churn Method - This integrates with the Git repository to look at the change history of the project’s files. Files with excessively high change histories have a tendency to have a high complexity rating as well, as they can be the result of feature envy, where extra functions are added into a file instead of being added to a new file with its own functionality.


			===Best Practices===
			Because

	==Getting Started with Refactoring==		==Getting Started with Refactoring==

Makhavne: /* Background */

2014-02-19T05:16:17Z

Background

← Older revision		Revision as of 05:16, 19 February 2014
Line 10:		Line 10:

	Refactoring has its difficulties, whether or not it is done using an [http://en.wikipedia.org/wiki/Integrated_development_environment IDE] or whether it is done by hand. There are lots of errors that can be made during refactoring, so it is pertinent to determine when it is necessary to refactor. Code metrics are one method used to determine how badly a file needs refactoring.		Refactoring has its difficulties, whether or not it is done using an [http://en.wikipedia.org/wiki/Integrated_development_environment IDE] or whether it is done by hand. There are lots of errors that can be made during refactoring, so it is pertinent to determine when it is necessary to refactor. Code metrics are one method used to determine how badly a file needs refactoring.

			Two main types of refactoring are <ref>http://web.cecs.pdx.edu/~black/publications/IEEESoftwareRefact.pdf</ref>:
			# Floss refactoring: refactoring performed regularly to keep code clean; gives healthy benefits in the long run
			# Root canal refactoring: infrequent and protracted periods of refactoring; makes it painful and expensive (similar to dental analogy); mainly performed to clean unhealthy code

	==Refactoring Techniques==		==Refactoring Techniques==

Rjlloyd: /* Code Climate */

2014-02-19T05:13:09Z

Code Climate

← Older revision		Revision as of 05:13, 19 February 2014
Line 182:		Line 182:
	#Complexity Metric - This is based off of the Assignment, Branches, and Conditions ([http://c2.com/cgi/wiki?AbcMetric ABC]) metric, where the number of assignments, branches, and conditions are counted and analyzed. However, because Code Climate is constructed for Ruby programs, it also takes into account certain types of Ruby constructs that may increase the metric score, but are actually beneficial to the project.		#Complexity Metric - This is based off of the Assignment, Branches, and Conditions ([http://c2.com/cgi/wiki?AbcMetric ABC]) metric, where the number of assignments, branches, and conditions are counted and analyzed. However, because Code Climate is constructed for Ruby programs, it also takes into account certain types of Ruby constructs that may increase the metric score, but are actually beneficial to the project.
	#Duplication Metric - This looks at the syntax trees of the code in order to identify identical and similar code structures. Because the syntax trees are being analyzed, code formatting and different method and class names do not affect the score. <ref>https://codeclimate.com/docs#quality-metrics</ref>		#Duplication Metric - This looks at the syntax trees of the code in order to identify identical and similar code structures. Because the syntax trees are being analyzed, code formatting and different method and class names do not affect the score. <ref>https://codeclimate.com/docs#quality-metrics</ref>
	#Churn Method - This integrates with the Git repository to look at the change history of the project’s files. Files with excessively high change histories have a tendency to have a high complexity rating as well, as they can be the result of feature envy, where extra functions are added into a file instead of being added to a new file with ~~it’s~~ own functionality.		#Churn Method - This integrates with the Git repository to look at the change history of the project’s files. Files with excessively high change histories have a tendency to have a high complexity rating as well, as they can be the result of feature envy, where extra functions are added into a file instead of being added to a new file with its own functionality.

	==Getting Started with Refactoring==		==Getting Started with Refactoring==

Rjlloyd: /* Background */

2014-02-19T05:12:39Z

Background

← Older revision		Revision as of 05:12, 19 February 2014
Line 5:		Line 5:
	==Background==		==Background==

	The idea behind [http://en.wikipedia.org/wiki/Code_refactoring code refactoring] is to take a code base and improve ~~it's~~ readability, [http://en.wikipedia.org/wiki/Extensibility extensibility], and [http://en.wikipedia.org/wiki/Reusability reusability]. The practice is focused on having a better quality and more standardized code base, and not on fixing bugs or changing functionality.		The idea behind [http://en.wikipedia.org/wiki/Code_refactoring code refactoring] is to take a code base and improve its readability, [http://en.wikipedia.org/wiki/Extensibility extensibility], and [http://en.wikipedia.org/wiki/Reusability reusability]. The practice is focused on having a better quality and more standardized code base, and not on fixing bugs or changing functionality.

	In their Refactoring book<ref name="Refactoring book">http://books.google.com/books?id=1MsETFPD3I0C</ref>, Martin Fowler and Kent Beck define refactoring as 'A change made to the internal structure of software to make it easier to understand and cheaper to modify without changing its observable behavior… It is a disciplined way to clean up code that minimizes the chances of introducing bugs'.		In their Refactoring book<ref name="Refactoring book">http://books.google.com/books?id=1MsETFPD3I0C</ref>, Martin Fowler and Kent Beck define refactoring as 'A change made to the internal structure of software to make it easier to understand and cheaper to modify without changing its observable behavior… It is a disciplined way to clean up code that minimizes the chances of introducing bugs'.

	Refactoring has its difficulties, whether or not it is done using an [http://en.wikipedia.org/wiki/Integrated_development_environment IDE] or whether it is done by hand. There are lots of ~~pitfalls and~~ errors that can be made during refactoring, so it is pertinent to determine ~~how important a refactor~~ is to ~~the code~~. Code metrics are one method used to determine how badly a file needs refactoring.		Refactoring has its difficulties, whether or not it is done using an [http://en.wikipedia.org/wiki/Integrated_development_environment IDE] or whether it is done by hand. There are lots of errors that can be made during refactoring, so it is pertinent to determine when it is necessary to refactor. Code metrics are one method used to determine how badly a file needs refactoring.

	==Refactoring Techniques==		==Refactoring Techniques==

Rjlloyd: /* Further Reading */

2014-02-19T05:11:22Z

Rjlloyd: /* Refactoring Techniques */

2014-02-19T05:10:52Z

Refactoring Techniques

Show changes

← Older revision		Revision as of 05:11, 19 February 2014
Line 220:		Line 220:
	==Further Reading==		==Further Reading==
	*[http://en.wikipedia.org/wiki/Code_smell Ways to identify problems in code]		*[http://en.wikipedia.org/wiki/Code_smell Ways to identify problems in code]

			*[http://ghendry.net/refactor.html A description of smells with their techniques exists]

			*[http://www.refactoring.com/catalog/index.html A list of techniques with examples in Ruby are listed]

	*[http://blog.codeclimate.com/blog/2012/11/14/why-ruby-class-methods-resist-refactoring/ Resistance With Refactoring Ruby Class Methods]		*[http://blog.codeclimate.com/blog/2012/11/14/why-ruby-class-methods-resist-refactoring/ Resistance With Refactoring Ruby Class Methods]