Object Mentor Blog: Another Refactoring Exercise: Design Patterns Recommended!-)

Another Refactoring Exercise: Design Patterns Recommended!-)

Brett Schuchert — Tue, 09 Jun 2009 20:57:00 -0500

Well the previous exercise was fun so here’s another one. The following code is taken from the same problem, an RPN calculator. Originally, the interface of the calculator was “wide”; there was a method for each operator. E.g., plus(), minus(), factorial(). In an effort to fix this, a new method, perform(String operatorName) was added and ultimately the interface was fixed gradually to remove those methods.

Changing he calculator API in this way is an example of applying the open/closed principle. However, the resulting code is just a touch ugly (I made it a little extra ugly just for the hack [sic] of it). This code as written does pass all of my unit tests.

Before the code, however, let me give you a little additional information:

I changed the calculator to use BigDecimal instead of int
Right now the calculator has three operators, +, – !
Eventually, there will be many operators (50 ish)
Right now there are only binary and unary operators, however there will be other kinds: ternary, quaternary, and others such as sum the stack and replace just the sum on the stack or calculate the prime factors of the top of the stack so take one value but push many values

So have a look at the following code and then either suggest changes or provide something better. There’s a lot that can be done to this code to make it clearer and make the system easier to extend.

The Perform Method

   public void perform(String operatorName) {
      BigDecimal op1 = stack.pop();

      if ("+".equals(operatorName)) {
         BigDecimal op2 = stack.pop();
         stack.push(op1.add(op2));
         currentMode = Mode.inserting;
      } else if ("-".equals(operatorName)) {
         BigDecimal op2 = stack.pop();
         stack.push(op2.subtract(op1));
         currentMode = Mode.inserting;
      } else if ("!".equals(operatorName)) {
         op1 = op1.round(MathContext.UNLIMITED);
         BigDecimal result = BigDecimal.ONE;
         while (op1.compareTo(BigDecimal.ONE) > 0) {
            result = result.multiply(op1);
            op1 = op1.subtract(BigDecimal.ONE);
         }
         stack.push(result);
      } else {
         throw new MathOperatorNotFoundException();
      }
   }

Unlike the last example, I’ll provide the entire class. Feel free to make changes to this class as well. However, for now focus on the perform(...) method.

One note, Philip Schwarz recommended a change to what I proposed to avoid the command/query separation violation. I applied his recommendation before posting this updated version.

The Whole Class

package com.scrippsnetworks.calculator;

import java.math.BigDecimal;
import java.math.MathContext;

public class RpnCalculator {
   private OperandStack stack = new OperandStack();
   private Mode currentMode = Mode.accumulating;

   enum Mode {
      accumulating, replacing, inserting
   };

   public RpnCalculator() {
   }

   public void take(BigDecimal value) {
      if (currentMode == Mode.accumulating)
         value = determineNewTop(stack.pop(), value);

      if (currentMode == Mode.replacing)
         stack.pop();

      stack.push(value);
      currentMode = Mode.accumulating;
   }

   private BigDecimal determineNewTop(BigDecimal currentTop, BigDecimal value) {
      BigDecimal newTopValue = currentTop;
      String digits = value.toString();
      while (digits.length() > 0) {
         newTopValue = newTopValue.multiply(BigDecimal.TEN);
         newTopValue = newTopValue.add(new BigDecimal(Integer.parseInt(digits
               .substring(0, 1))));
         digits = digits.substring(1);
      }

      return newTopValue;
   }

   public void enter() {
      stack.dup();
      currentMode = Mode.replacing;
   }

   public void perform(String operatorName) {
      BigDecimal op1 = stack.pop();

      if ("+".equals(operatorName)) {
         BigDecimal op2 = stack.pop();
         stack.push(op1.add(op2));
         currentMode = Mode.inserting;
      } else if ("-".equals(operatorName)) {
         BigDecimal op2 = stack.pop();
         stack.push(op2.subtract(op1));
         currentMode = Mode.inserting;
      } else if ("!".equals(operatorName)) {
         op1 = op1.round(MathContext.UNLIMITED);

         BigDecimal result = BigDecimal.ONE;
         while (op1.compareTo(BigDecimal.ONE) > 0) {
            result = result.multiply(op1);
            op1 = op1.subtract(BigDecimal.ONE);
         }
         stack.push(result);
      } else {
         throw new MathOperatorNotFoundException();
      }
   }

   public BigDecimal getX() {
      return stack.x();
   }

   public BigDecimal getY() {
      return stack.y();
   }

   public BigDecimal getZ() {
      return stack.z();
   }

   public BigDecimal getT() {
      return stack.t();
   }
}

"Another Refactoring Exercise: Design Patterns Recommended!-)" by Polo Ralph Lauren Pas Cher

Thu, 12 Jan 2012 21:11:53 -0600

Hi, Brilliant, just I have learnt, what I needed to know. thank you for writing such an excellent article.Please keep it up.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by christian louboutin

Thu, 03 Nov 2011 09:17:07 -0500

The professional design make you foot more comfortable. Even more tantalizing,this pattern make your legs look as long as you can,it will make you looked more attractive.Moveover,it has reasonable price.If you are a popular woman,do not miss it.

Technical details of Christian Louboutin Velours Scrunch Suede Boots Coffee:

Color: Coffee
Material: Suede
4(100mm) heel
Signature red sole x

Fashion, delicate, luxurious Christian louboutins shoes on sale, one of its series is Christian Louboutin Tall Boots, is urbanism collocation. This Christian louboutins shoes design makes people new and refreshing. Red soles shoes is personality, your charm will be wonderful performance.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by full colour leaflet

Mon, 24 Oct 2011 15:41:42 -0500

der is nwe mid nyt im cant concentration .you hav to done grt job

"Another Refactoring Exercise: Design Patterns Recommended!-)" by website design

Mon, 24 Oct 2011 15:38:53 -0500

im codein this but i hav a problem …..but i wont fixed error????

"Another Refactoring Exercise: Design Patterns Recommended!-)" by Tips For Bowling

Tue, 18 Oct 2011 12:18:29 -0500

I was assigned to do a job by the attorney general, and that was to find out whether crimes were committed.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by car colour service

Sat, 08 Oct 2011 01:41:00 -0500

some of days i searching in google some calculating method. it is great for me. thanks buddy

"Another Refactoring Exercise: Design Patterns Recommended!-)" by canada goose coat

Thu, 15 Sep 2011 21:09:19 -0500

When it comes to feather dress, what appears in your mind? Which kind brand of down jacket do you like prefer? Though there are many down jackets for you to choose from, on the word, which one you really enjoy? I want to say that canada goose coats is really your best choice. I believe you can’t agree with me any more. When you take the quality into consideration, you will find that it is superior to any other kind of coat. Besides, discount canada goose jackets is a world well-known brand, which has gained high reputation in the world, which has accepted by our customers and some organization. Because of its high quality, some of our loyal customers have promoted it to the people around them. In their opinion, it is good to informing others to know it. Recently, Canada Goose Trillium Parka is on hot sale. What I have to inform you is that all the products there are made by hand, so they are elaborative and elegant enough. It is really beautiful once you dress in. So, if you are a lovely girl or woman, go to the store to buy one for you. You will appreciate it that you have such a coat.In addition, they also have any other products like canada goose Gloves and canada goose jacket supplier.Hope your will like its!

"Another Refactoring Exercise: Design Patterns Recommended!-)" by Diablo3

Wed, 14 Sep 2011 13:18:56 -0500

hmm ,i’m not sure if this is what i’m looking for but anyway this is interresting and could be useful some day,thanks for taking time to write such cool stuff

"Another Refactoring Exercise: Design Patterns Recommended!-)" by bagsupplyer

Wed, 07 Sep 2011 05:49:46 -0500

Designer women Juicy backpacks free shipping for wholesale

"Another Refactoring Exercise: Design Patterns Recommended!-)" by blackhawk tactical gear

Thu, 09 Jun 2011 00:49:56 -0500

This method looks very useful for many applications

blackhawk tactical gear

"Another Refactoring Exercise: Design Patterns Recommended!-)" by mbt shoes sales

Wed, 18 May 2011 23:21:25 -0500

YES SERIOUSLY!!!!! SO MUCH SPARKLY TEXT!!!

"Another Refactoring Exercise: Design Patterns Recommended!-)" by mediation

Sat, 14 May 2011 22:19:51 -0500

Your way of thinking is one of a kind. i find this to be excellent. Great work.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by Santa Monica Homes For Sale

Sat, 14 May 2011 11:39:44 -0500

This method looks very useful for many applications

"Another Refactoring Exercise: Design Patterns Recommended!-)" by divorce settlement agreement

Sat, 14 May 2011 11:38:12 -0500

Your way of thinking is one of a kind. i find this to be excellent. Great work.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by EDDM Retail

Thu, 12 May 2011 15:13:20 -0500

Hm great i like this and it is nice discussion here keep going on…

"Another Refactoring Exercise: Design Patterns Recommended!-)" by For Sale In Hayward

Sun, 08 May 2011 13:24:11 -0500

Very serious calculation, such research is important to keep it continue to develop.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by okey oyunu oyna

Thu, 28 Apr 2011 14:41:10 -0500

nice code.

internette görüntülü olarak okey oyunu oyna, gerçek kisilerle tanis, turnuva heyecanini yasa.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by Willie Trevizo

Thu, 14 Apr 2011 08:14:38 -0500

Your way of thinking is one of a kind. i find this to be excellent. Great work. roofing

"Another Refactoring Exercise: Design Patterns Recommended!-)" by clothing manufacturer

Wed, 30 Mar 2011 04:19:22 -0500

the article is what I want! Thank you

"Another Refactoring Exercise: Design Patterns Recommended!-)" by centrifugal fan

Mon, 28 Feb 2011 23:46:56 -0600

Haile Electric Industrial Co. Ltd. is the leading manufacturer and exporter of cold room,axial fan,condensing unit,centrifugal fan,shaded pole motor and refrigeration products in China.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by iPhone SMS to Mac Backup

Mon, 28 Feb 2011 03:02:57 -0600

Would you like to banckup iphone SMS to mac, macBook, macbookPro as .txt files? Now a software iphone SMS to Mac Backup can help you to realize it.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by skirunride

Sat, 19 Feb 2011 07:36:45 -0600

Very serious calculation, such research is important to keep to continue to develop

"Another Refactoring Exercise: Design Patterns Recommended!-)" by Silicone Molding

Tue, 28 Dec 2010 21:47:19 -0600

Mold making is the core business of Intertech (Taiwan). With world level technology, Intertech enjoys a very good reputation for making Injection Mold and Plastic Moldsfor their worldwide customers.

"Another Refactoring Exercise: Design Patterns Recommended!-)" by http://www.whiteiphone4transformer.com

Thu, 23 Dec 2010 20:43:23 -0600

People love fashion will always love white iphone 4. Now you can get the advance chance to take the hottest iphone 4 conversion kit. Here we go!

"Another Refactoring Exercise: Design Patterns Recommended!-)" by chanel store

Sun, 14 Nov 2010 05:07:09 -0600

Very pleased that the article is what I want! Thank you