Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number
 
PerlMonks  

comment on

( [id://3333] : superdoc . print w/replies, xml ) Need Help??
A Refactoring for Perl.

You need to subclass a class that contains factory methods,
and also the class that the factory methods return.

Change

sub factory { my $self = shift; ... my $newInstance = new Bar(...); ... return $newInstance; }
to
sub factory { my $self = shift; ... my newInstance = $self->factoryClass()->new(...); ... return newInstance; } sub factoryClass { "Bar" }

Motivation

Factory methods return instances of some class known to the factory method. Typically the class name is hard-coded. If the class that holds the factory method is subclassed, the factory method is inherited, but will continue to return instances of the same hard-coded class. This isn't always desirable. A set of cooperating base classes, one of which uses a factory method to create instances of the other, may both need to be subclassed. If a factory method uses a hard-coded class name, that factory method must be copied into a subclass and modified. If the factory method performs other work (e.g., bookkeeping to account for the newly created instance), this can result in redundant code in the class hierarchy.

The solution is to "soft code" the class name that the factory method will create new instances of, by creating a new method that returns the class name, and using the new method in place of the hard-coded class name. The factory method can then be inherited by subclasses, which merely need to override the method that returns the class name.

Mechanics

  • Identify a factory method that hard-codes a class name.
  • Create a new method that returns the class name.
  • In the factory class, replace the hard-coded class name with an invocation of the new method.
  • Test.

Discussion

I first ran into the need for this when attempting to subclass pieces of GIFGraph, and finding myself initially thwarted by hard-coded class names in its factory methods. (I had to refactor methods to create some factory methods, but that's a separate story.)

This refactoring is hardly original thinking. It's been done in the Smalltalk world for years. If you know of an existing writeup of this refactoring for Perl, please provide a reference.


In reply to Refactoring: Soft-code class name in factory method by dws

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.