Refactoring: Refactorings/Change Reference to Value

From Notes
Jump to navigation Jump to search

A reference object can become small, immutable, and awkward to manage.


Mechanics

  1. Check that the candidate object is immutable or can become immutable (Try using Remove Setting Method). If not, abandon this refactoring.
  2. Create an == method and an eql? method (eql? can delegate to ==)
  3. Create a hash method
  4. Test
  5. Consider removing factory method and making a public constructor.

Example

Before

class Currency
  attr_reader :code

  def initialize(code)
    @code = code
  end

  def self.get(code)
    # return currency from registry
  end
end

# usage
usd = Currency.get("USD")

Currency.new("USD") == Currency.new("USD") # returns false

After

class Currency
  attr_reader :code

  def initialize(code)
    @code = code
  end

  def self.get(code)
    # return currency from registry
  end

  def eql?(other)
    self == (other)
  end

  def ==(other)
    other.equal?(self) || (other.instance_of?(self.class) && other.code == code)
  end

  def hash
    code.hash
  end
end

# usage
Currency.send(:new, "USD") == Currency.new("USD") # returns true
Refactorings
Composing Methods

Extract MethodInline MethodInline TempReplace Temp with QueryReplace Temp with ChainIntroduce Explaining VariableSplit Temporary VariableRemove Assignments to ParametersReplace Method with Method ObjectSubstitute AlgorithmReplace Loop with Collection Closure MethodExtract Surrounding MethodIntroduce Class AnnotationIntroduce Named ParameterRemove Named ParameterRemove Unused Default ParameterDynamic Method DefinitionReplace Dynamic Receptor with Dynamic Method DefinitionIsolate Dynamic ReceptorMove Eval from Runtime to Parse Time

Moving Features Between Objects

Move MethodMove FieldExtract ClassInline ClassHide DelegateRemove Middle Man

Organizing Data

Self Encapsulate FieldReplace Data Value with ObjectChange Value to ReferenceChange Reference to ValueReplace Array with ObjectReplace Hash with ObjectChange Unidirectional Association to BidirectionalChange Bidirectional Association to UnidirectionalReplace Magic Number with Symbolic ContentEncapsulate CollectionReplace Record with Data ClassReplace Type Code with PolymorphismReplace Type Code with Module ExtensionReplace Type Code with State-StrategyReplace Subclass with FieldsLazily Initialized AtributeEagerly Initialized Attribute

Simplifying Conditional Expressions

Decompose ConditionalRecompose ConditionalConsolidate Conditional ExpressionConsolidate Duplicate Conditional FragmentsRemove Control FlagReplace Nested Conditional with Guard ClausesReplace Conditional with PolymorphismIntroduce Null ObjectIntroduce Assertion

Making Method Calls Simpler

Rename MethodAdd ParameterRemove ParameterSeparate Query from ModifierParameterize MethodReplace Parameter with Explicit MethodsPreserve Whole ObjectReplace Parameter with MethodIntroduce Parameter ObjectRemove Setting MethodHide MethodReplace Constructor with Factory MethodReplace Error Code with ExceptionReplace Exception with TestIntroduce GatewayIntroduce Expression Builder

Dealing with Generalization

Pull Up MethodPush Down MethodExtract ModuleInline ModuleExtract SubclassIntroduce InheritanceCollapse HierarchyForm Template MethodReplace Inheritance with DelegationReplace Delegation with HierarchyReplace Abstract Superclass with Module

Big Refactorings

Tease Apart InheritanceConvert Procedural Design to ObjectsSeparate Domain from PresentationExtract Hierarchy