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 Method • Inline Method • Inline Temp • Replace Temp with Query • Replace Temp with Chain • Introduce Explaining Variable • Split Temporary Variable • Remove Assignments to Parameters • Replace Method with Method Object • Substitute Algorithm • Replace Loop with Collection Closure Method • Extract Surrounding Method • Introduce Class Annotation • Introduce Named Parameter • Remove Named Parameter • Remove Unused Default Parameter • Dynamic Method Definition • Replace Dynamic Receptor with Dynamic Method Definition • Isolate Dynamic Receptor • Move Eval from Runtime to Parse Time

Moving Features Between Objects

Move Method • Move Field • Extract Class • Inline Class • Hide Delegate • Remove Middle Man

Organizing Data

Self Encapsulate Field • Replace Data Value with Object • Change Value to Reference • Change Reference to Value • Replace Array with Object • Replace Hash with Object • Change Unidirectional Association to Bidirectional • Change Bidirectional Association to Unidirectional • Replace Magic Number with Symbolic Content • Encapsulate Collection • Replace Record with Data Class • Replace Type Code with Polymorphism • Replace Type Code with Module Extension • Replace Type Code with State-Strategy • Replace Subclass with Fields • Lazily Initialized Atribute • Eagerly Initialized Attribute

Simplifying Conditional Expressions

Decompose Conditional • Recompose Conditional • Consolidate Conditional Expression • Consolidate Duplicate Conditional Fragments • Remove Control Flag • Replace Nested Conditional with Guard Clauses • Replace Conditional with Polymorphism • Introduce Null Object • Introduce Assertion

Making Method Calls Simpler

Rename Method • Add Parameter • Remove Parameter • Separate Query from Modifier • Parameterize Method • Replace Parameter with Explicit Methods • Preserve Whole Object • Replace Parameter with Method • Introduce Parameter Object • Remove Setting Method • Hide Method • Replace Constructor with Factory Method • Replace Error Code with Exception • Replace Exception with Test • Introduce Gateway • Introduce Expression Builder

Dealing with Generalization

Pull Up Method • Push Down Method • Extract Module • Inline Module • Extract Subclass • Introduce Inheritance • Collapse Hierarchy • Form Template Method • Replace Inheritance with Delegation • Replace Delegation with Hierarchy • Replace Abstract Superclass with Module

Big Refactorings

Tease Apart Inheritance • Convert Procedural Design to Objects • Separate Domain from Presentation • Extract Hierarchy