CSC/ECE 517 Fall 2009/wiki1a 8 nd: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
 
(98 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Problem Statement=
='''Problem Statement'''=


The list of refactorings has become quite long.  But people don't remember long lists very well.  To promote learning the different patterns, they should be categorized in some way, or perhaps, along various dimensions. As a reference we have taken the list of refactorings available [http://www.refactoring.com/catalog/index.html here] and categorized them along as many different dimensions as makes sense.
The list of refactorings has become quite long & people don't remember long lists very well.  To promote learning the different patterns, they should be categorized in some way, or perhaps, along various dimensions.Here is an attempt to categorize the various available refactoring methods into different categories along as many different dimensions as makes sense. As a reference we have taken the list of refactorings methods available at http://www.refactoring.com/catalog/index.html.


='''Categorization of Refactoring Methods'''=
=='''Categorization Framework Used'''==
When an application is developed using an object oriented programming language the code architecture is designed in the following way. First the functionality of the application is divided into major chunks and assigned to sets of packages which form the first level of hierarchy for the program.


Here are the categories & sub-categories using which the refactorings available [http://www.refactoring.com/catalog/index.html here] have been categorized.
The second level of hierarchy is the compilation unit which has access to all public types declared in its package and also automatically imports them. Types consist of classes and interfaces.  


=Categorization of Refactoring Methods=
The functionality implemented in a package is further broken down and implemented using classes at the third level of hierarchy. Classes are made out of items, which are basically methods and fields. Fields declare data which are associated with the class.Interfaces encode the similarities among classes.  
==Categorization Framework Used==
When an application is developed using an object oriented programming language the code architecture is designed in the following way. First the functionality of the application is divided into major chunks & assigned to sets of packages which form the first level of hierarchy for the program.  


The second level of hierarchy are the compilation units which has access to all types declared in its package and also automatically import all of the public types(in other packages/files) declared in the package. Types consist of classes & interfaces.  
The fourth level of hierarchy consists of objects which act as data structures and store data associated with the class. This helps to store multiple values of the same type of data.  


The functionality implemented in a package is further broken down & implemented using classes at the third level of hierarchy. Classes are made out of items, which are basically methods & fields. Fields declare data which are associated with the class.  Interfaces encode the similarities among classes.  
At the lowest level i.e the fifth is the data, which is a part of the object. At this level, the code which is a part of the method processes this data.  


In order to store multiple values of the same type of data, the fourth level of hierarchy i.e. a # of objects are  created which act as data structures and store data associated with the class.
This hierarchy is followed during any application development using an object oriented language and when an analyst is asked to refactor code, he/she also parses through this same hierarchy to understand the code functionality and to find spots where the code can be refactored.  


At the lowest level is the data which is a part of the object & also at this level is the code which processes this data, which is a part of the method. The creation of objects of a class, storage of data into the object fields & calling of methods for processing of the object data is controlled from the main function.
Most of the refactoring methods belong to level 3, level 4 and level 5, hence these categories have again been divided into sub-categories, to reduce generalization & make the categorization more specific. Here is an attempt to make categorization of the refactoring methods based on the said hierarchy. Also there are a few categories which aren't derived from the above hierarchy. Here are the categories and sub-categories using which the refactoring methods available at http://www.refactoring.com/catalog/index.html have been categorized.
 
This hierarchy is followed during any application development using an object oriented language & when an analyst is asked to refactor code, he/she also parses through this same hierarchy to understand the code functionality & to find spots where the code can be refactored. Most of the refactoring methods belong to level 3, level 4 and level 5, hence these categories have again been divided into sub-categories, to reduce generalization & make the categorization more specific. Here is an attempt to make categorization of the refactoring methods based on the said hierarchy.  
 
Also there are a two categories whose inspiration isn't the above hierarchy.


=='''Categories'''==
=='''Categories'''==
===Refactoring the Package===
===Refactoring the Package===
*Extract Package
A refactoring method will fall under this category if the changes made affect the package structure or add to the functionality to the package. The refactoring method generally may involve breaking a package to smaller packages to divide the functionality or moving classes to a more relevant package.
*Move Class
*Extract Package
*Move Class


===Refactoring the Class===
===Refactoring the Class===


*'''Changing Class Association'''          
*'''Changing Class Association'''
**Change Unidirectional Association to Bidirectional
A refactoring method falls in this category if it tries to change the association between two classes so that features of a class may be added or removed.
**Change Unidirectional Association to Bidirectional
*Change Unidirectional Association to Bidirectional
*Change Bidirectional  Association to Unidirectional
*Extract Interface
 
*'''Change of Class Structure''' A refactoring method falls in this category when it tries to change the hierarchy that the classes share amongst them.
**Splitting of Class
*Duplicate Observed Data
*Extract Class
*Extract SubClass
*Extract SuperClass
*Separate Data Access Code
*Localize Disparate Logic
**Merging of  Class
*Collapse Hierarchy
*Replace Subclass with Fields
*Inline Class


*'''Change of Class Structure'''
*'''Inter-Class Movement of Items'''
**Collapse Hierarchy
A refactoring method falls in this category when it tries to move functionality/detail between classes. This may involve movement of constructors, fields or methods between classes.
**Duplicate Observed Data
*Pull up Constructor Body
**Extract Class
*Pull up Field
**Extract SubClass
*Pull up Method
**Extract SuperClass
*Push Down Field
**Inline Class
*Push Down Method
**Replace Subclass with Fields
*Move Field
**Separate Data Access Code
*Move Method
*'''Moving Additional Functionality to Client Class'''
A refactoring method falls in this category when functionality needs to be added to a server class which cannot be altered. The refactoring method achieves it by adding sever class extensions to the client method.
*Introduce Local Extension 
*Introduce Foreign Method


*'''Addition to a Class'''
*'''Replacement of Class Instantiation with Constructors'''
**Pull up Constructor Body
A refactoring method falls in this category when it tries to convert loading of some of the classes from dynamic to static or vice-versa.
**Pull up Field
 
**Pull up Method
*Convert Static to Dynamic Construction
**Push Down Field
*Convert Dynamic to Static Construction
**Push Down Method


===Refactoring the Method===
===Refactoring the Method===


*'''Meaningful and Detailed Method Calls'''
*'''Meaningful and Detailed Method Calls'''
**Add Parameter
A refactoring method will fall under this category if it modifies a method call to pass more data to the method or tries to make the method call more understandable.
**Rename Method
*Add Parameter
**Preserve Whole Object
*Preserve Whole Object
*Rename Method


*'''Change of Structure of the Method Code'''
*'''Change of Structure of the Method Code'''
**Extract Method
A refactoring method will fall under this category if it deliberately changes the internal flow of the code without affecting the output. These methods need not result in the optimization of the code or simplification.
**Inline Method
*Consolidate Conditional Expression
**Consolidate Conditional Expression
*Encapsulation Collection
**Encapsulation Collection
*Extract Method
**Form Template Method
*Inline Method
**Replace Nested Conditional with Guard Clauses
*Form Template Method
**Replace Parameter with Method
*Replace Nested Conditional with Guard Clauses
*Replace Parameter with Method


*'''Change Method Call Hierarchy'''
*'''Change Method Call Hierarchy/Sequence'''
**Remove Middle man
A refactoring method will fall in this category when it tries to change the method call flow in any way.
**Replace Delegation with Inheritance
*Remove Middle man
**Replace Inheritance with Delegation
*Replace Delegation with Inheritance
*Replace Inheritance with Delegation


*'''Improve Method Readability'''
*'''Improve Method Readability'''
**Introduce Explaining Variable
A refactoring method will fall under this category when it increases the readability of the code for a new person reading the code or for debugging purpose if ever needed.
**Replace Magic No with Symbolic Constant  
*Introduce Explaining Variable
**Split Temporary Variable
*Replace Magic No with Symbolic Constant
*Replace Recursion with Iteration
*Split Temporary Variable


*'''Method Code Refactoring based on Method Arguments'''
*'''Method Code Refactoring based on Method Arguments'''
**Replace Conditional with Polymorphism
A refactoring method will fall under this category when it makes the behavior of the executed method code, change depending on the argument passed, or when it frees the method code of this feature.
**Replace Conditional with Visitor
*Parameterize Method
**Replace Parameter with Explicit Methods
*Replace Conditional with Polymorphism
*Replace Conditional with Visitor
*Replace Parameter with Explicit Methods


===Refactoring the Object===
===Refactoring the Object===


*'''Replacements with Objects'''
*'''Replacements with Objects'''
**Introduce Null Object
A refactory method will fall under this category when the code is changed such that its execution is more centered around the object. And different parameters like array, data values are replaced by objects.
**Replace Array with Object
*Introduce Null Object
**Introduce Parameter Object
*Introduce Parameter Object
**Replace Data Value with Object
*Replace Array with Object
**Replace Method with Method Object
*Replace Data Value with Object
*Replace Method with Method Object
*Replace Record with Data Class


*'''Object Initialization'''
*'''Object Initialization'''
**Replace Constructor with Factory Method
A refactory method will fall under this category when it tries to alter the constructor used for the initialization of the object.
*Replace Constructor with Factory Method
*Remove Setting Method


*'''Accessing the Object/Data'''
*'''Accessing the Object/Data'''
**Change Reference to Value
A refactory method will fall under this category if the method changes the way an object or data is accessed.
**Change Value to Reference
*Change Reference to Value
**Refactor Architecture by Tiers
*Change Value to Reference
**Self Encapsulate Field
*Refactor Architecture by Tiers
*Self Encapsulate Field


===Refactoring the Code===
===Refactoring the Code===


*'''Code Optimization'''
*'''Code Optimization'''
**Replace Temp with Query
A refactoring method will fall under this category when the method brings about change in the code such a way that its execution is optimized.
**Consolidate Duplicate Conditional Fragments
*Consolidate Duplicate Conditional Fragments
**Decompose Conditional
*Eliminate Inter-Entity Bean Communication
**Inline Temp
*Inline Temp
**Introduce Assertion
*Remove Control Flag
**Replace Iteration with Recursion
*Replace Iteration with Recursion
**Remove Control Flag
*Replace Temp with Query
*Use a Connection Pool
 
*'''Code Reliability Improvement'''
A refactoring method will fall under this category if it helps to make the code less prone to errors and adhere more to its intended functionality.
*Introduce Assertion
*Introduce A Controller
*Introduce Synchronizer Token
*Reduce Scope of Variable
*Remove Assignments to Parameters
 
*'''Code Simplification'''
A refactoring method will fall under this category when it causes simplification of the code making it more readable and understandable, it may or may not optimize the execution.
*Encapsulate Downcast
*Remove Double Negative
*Replace Assignment with Initialization
*Reverse Conditional
*Separate Query from Modifier
*Split Loop
*Substitute Algorithm
*Decompose Conditional


*'''Redundant Code Elimination'''
*'''Redundant Code Elimination'''
**Parametrize Method
A refactoring method will fall under this category if it helps to eliminate the unnecessary code
**Remove Parameter
and makes the code cleaner.
 
*Parametrize Method
*'''Method Code Simplification'''
*Remove Parameter
**Remove Double Negative
**Replace Assignment with Initialization
**Encapsulate Downcast
**Reduce Scope of Variable
**Reverse Conditional
**Separate Query from Modifier
**Split Loop
**Substitute Algorithm


*'''Removal of "Type Code"'''
*'''Removal of "Type Code"'''
**Replace Type Code with Class
A refactory method will fall under the category Removal of  "Type Code" if the method helps to remove the type code.
**Replace Type Code with State/Strategy
*Replace Type Code with Class
**Replace Type Code with Subclasses
*Replace Type Code with State/Strategy
*Replace Type Code with Subclasses


===Refactoring for Privacy===
===Refactoring for Privacy===
*Hide Delegate
A refactoring method will fall under this category if it helps in data protection and privacy.
*Hide Method
*Encapsulate Field
*Encapsulate Field
*Hide Delegate
*Hide Presentation Tier-Specific Details from the Business tier
*Hide Method
*Introduce Business Delegate
*Hide Presentation Tier-Specific Details from the Business tier
*Wrap Entities with Session
*Introduce Business Delegate
*Wrap Entities with Session


===Dealing with Exceptions===
===Dealing with Exceptions===
*Remove Error Code with Exception
A refactoring method will fall under this category if it optimizes the way the code handles an exception situation.
*Replace Exception with Test
*Remove Error Code with Exception
*Replace Exception with Test


=References=
=References=
http://www.refactoring.com<br>
Refactoring: Improving the Design of Existing Code by Martin Fowler.

Latest revision as of 14:39, 11 September 2009

Problem Statement

The list of refactorings has become quite long & people don't remember long lists very well. To promote learning the different patterns, they should be categorized in some way, or perhaps, along various dimensions.Here is an attempt to categorize the various available refactoring methods into different categories along as many different dimensions as makes sense. As a reference we have taken the list of refactorings methods available at http://www.refactoring.com/catalog/index.html.

Categorization of Refactoring Methods

Categorization Framework Used

When an application is developed using an object oriented programming language the code architecture is designed in the following way. First the functionality of the application is divided into major chunks and assigned to sets of packages which form the first level of hierarchy for the program.

The second level of hierarchy is the compilation unit which has access to all public types declared in its package and also automatically imports them. Types consist of classes and interfaces.

The functionality implemented in a package is further broken down and implemented using classes at the third level of hierarchy. Classes are made out of items, which are basically methods and fields. Fields declare data which are associated with the class.Interfaces encode the similarities among classes.

The fourth level of hierarchy consists of objects which act as data structures and store data associated with the class. This helps to store multiple values of the same type of data.

At the lowest level i.e the fifth is the data, which is a part of the object. At this level, the code which is a part of the method processes this data.

This hierarchy is followed during any application development using an object oriented language and when an analyst is asked to refactor code, he/she also parses through this same hierarchy to understand the code functionality and to find spots where the code can be refactored.

Most of the refactoring methods belong to level 3, level 4 and level 5, hence these categories have again been divided into sub-categories, to reduce generalization & make the categorization more specific. Here is an attempt to make categorization of the refactoring methods based on the said hierarchy. Also there are a few categories which aren't derived from the above hierarchy. Here are the categories and sub-categories using which the refactoring methods available at http://www.refactoring.com/catalog/index.html have been categorized.

Categories

Refactoring the Package

A refactoring method will fall under this category if the changes made affect the package structure or add to the functionality to the package. The refactoring method generally may involve breaking a package to smaller packages to divide the functionality or moving classes to a more relevant package. 

*Extract Package
*Move Class

Refactoring the Class

  • Changing Class Association

A refactoring method falls in this category if it tries to change the association between two classes so that features of a class may be added or removed. 

*Change Unidirectional Association to Bidirectional
*Change Bidirectional  Association to Unidirectional
*Extract Interface
  • Change of Class Structure A refactoring method falls in this category when it tries to change the hierarchy that the classes share amongst them.
    • Splitting of Class
*Duplicate Observed Data
*Extract Class
*Extract SubClass
*Extract SuperClass
*Separate Data Access Code
*Localize Disparate Logic
    • Merging of Class
*Collapse Hierarchy
*Replace Subclass with Fields
*Inline Class
  • Inter-Class Movement of Items

A refactoring method falls in this category when it tries to move functionality/detail between classes. This may involve movement of constructors, fields or methods between classes. 

*Pull up Constructor Body
*Pull up Field
*Pull up Method
*Push Down Field 
*Push Down Method
*Move Field
*Move Method
  • Moving Additional Functionality to Client Class

A refactoring method falls in this category when functionality needs to be added to a server class which cannot be altered. The refactoring method achieves it by adding sever class extensions to the client method. 

*Introduce Local Extension  
*Introduce Foreign Method
  • Replacement of Class Instantiation with Constructors

A refactoring method falls in this category when it tries to convert loading of some of the classes from dynamic to static or vice-versa. 

*Convert Static to Dynamic Construction
*Convert Dynamic to Static Construction

Refactoring the Method

  • Meaningful and Detailed Method Calls

A refactoring method will fall under this category if it modifies a method call to pass more data to the method or tries to make the method call more understandable. 

*Add Parameter
*Preserve Whole Object
*Rename Method
  • Change of Structure of the Method Code

A refactoring method will fall under this category if it deliberately changes the internal flow of the code without affecting the output. These methods need not result in the optimization of the code or simplification. 

*Consolidate Conditional Expression
*Encapsulation Collection
*Extract Method
*Inline Method
*Form Template Method
*Replace Nested Conditional with Guard Clauses
*Replace Parameter with Method
  • Change Method Call Hierarchy/Sequence

A refactoring method will fall in this category when it tries to change the method call flow in any way. 

*Remove Middle man
*Replace Delegation with Inheritance
*Replace Inheritance with Delegation
  • Improve Method Readability

A refactoring method will fall under this category when it increases the readability of the code for a new person reading the code or for debugging purpose if ever needed. 

*Introduce Explaining Variable
*Replace Magic No with Symbolic Constant
*Replace Recursion with Iteration 
*Split Temporary Variable
  • Method Code Refactoring based on Method Arguments

A refactoring method will fall under this category when it makes the behavior of the executed method code, change depending on the argument passed, or when it frees the method code of this feature. 

*Parameterize Method
*Replace Conditional with Polymorphism
*Replace Conditional with Visitor
*Replace Parameter with Explicit Methods

Refactoring the Object

  • Replacements with Objects

A refactory method will fall under this category when the code is changed such that its execution is more centered around the object. And different parameters like array, data values are replaced by objects. 

*Introduce Null Object
*Introduce Parameter Object
*Replace Array with Object
*Replace Data Value with Object
*Replace Method with Method Object
*Replace Record with Data Class
  • Object Initialization

A refactory method will fall under this category when it tries to alter the constructor used for the initialization of the object. 

*Replace Constructor with Factory Method
*Remove Setting Method
  • Accessing the Object/Data

A refactory method will fall under this category if the method changes the way an object or data is accessed. 

*Change Reference to Value
*Change Value to Reference
*Refactor Architecture by Tiers
*Self Encapsulate Field

Refactoring the Code

  • Code Optimization

A refactoring method will fall under this category when the method brings about change in the code such a way that its execution is optimized. 

*Consolidate Duplicate Conditional Fragments
*Eliminate Inter-Entity Bean Communication
*Inline Temp
*Remove Control Flag
*Replace Iteration with Recursion
*Replace Temp with Query
*Use a Connection Pool
  • Code Reliability Improvement

A refactoring method will fall under this category if it helps to make the code less prone to errors and adhere more to its intended functionality. 

*Introduce Assertion
*Introduce A Controller
*Introduce Synchronizer Token
*Reduce Scope of Variable
*Remove Assignments to Parameters
  • Code Simplification

A refactoring method will fall under this category when it causes simplification of the code making it more readable and understandable, it may or may not optimize the execution. 

*Encapsulate Downcast
*Remove Double Negative
*Replace Assignment with Initialization
*Reverse Conditional
*Separate Query from Modifier
*Split Loop
*Substitute Algorithm
*Decompose Conditional
  • Redundant Code Elimination

A refactoring method will fall under this category if it helps to eliminate the unnecessary code and makes the code cleaner. 

*Parametrize Method
*Remove Parameter
  • Removal of "Type Code"

A refactory method will fall under the category Removal of "Type Code" if the method helps to remove the type code. 

*Replace Type Code with Class
*Replace Type Code with State/Strategy
*Replace Type Code with Subclasses

Refactoring for Privacy

A refactoring method will fall under this category if it helps in data protection and privacy. 

*Encapsulate Field
*Hide Delegate
*Hide Method
*Hide Presentation Tier-Specific Details from the Business tier
*Introduce Business Delegate
*Wrap Entities with Session

Dealing with Exceptions

A refactoring method will fall under this category if it optimizes the way the code handles an exception situation. 

*Remove Error Code with Exception
*Replace Exception with Test

References

http://www.refactoring.com
Refactoring: Improving the Design of Existing Code by Martin Fowler.

Retrieved from "https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2009/wiki1a_8_nd&oldid=19044"