Eric Liu's Software Development Blog

Colorized NAnt Console Output

2008-03-25T21:03:00.000-06:00

If you use NAnt for your build scripts, colored console output may be helpful in quickly spotting warnings or errors. I recently wrote a logger to do that:

Download the source for the version of NAnt you're using (I tested this against NAnt 0.85).
Apply this patch to the source tree. If you're on Windows, I believe you can use 'patch.exe' which comes with UnxUtils.
Build NAnt by following the instructions in 'README.txt'. This will produce a bunch of files, but the only one we're interested in is 'NAnt.Core.dll'.
In the directory where you store your NAnt binaries (eg. on my current project, it's in MyCurrentProject/tools/nant), replace 'NAnt.Core.dll' with the new one.
The last step is to add an option to your 'nant' call to specify the use of the new logger:
nant -logger:NAnt.Core.ConsoleColorLogger ...
On my current project, we have a 'build.bat' which invokes NAnt, so I just added the option there.

Once you have this in place, you should start seeing colors when a warning or error occurs. Feel free to use this sample build script to test it out (remember to invoke NAnt with -debug in order to see the debug-level messages!).

Customizing the colors

Simply specify additional properties when you invoke NAnt like this:

nant -logger:NAnt.Core.ConsoleColorLogger -D:ConsoleColorLogger.error=DarkRed -D:ConsoleColorLogger.warning=DarkMagenta ...

The levels you can customize are one of error/warning/info/verbose/debug. The colors you can use are 'default' (which means to use the foreground color you had before invoking NAnt) or one of these.

Hope that helps!

Why visitor pattern is worth the overhead

2006-08-16T03:12:00.000-06:00

I've observed that many developers tend to shy away from the visitor pattern. I suspect it's because even though they understand the pattern, the double-dispatch and the seemingly out-of-place accept methods seem like too much overhead. So, instead of using visitor, we end up with logic that switches on a simple enumeration or the type of an object. Compared to visitor, this kind of code is arguably simpler to understand.

I think that visitors are worth the overhead. What we gain is the ability to easily identify the effects of type changes.

Let's use this example: One part of our application captures user feedback. They have two options:

Choose a feedback from a standard list (eg. "Good" or "Bad")
Submit a short sentence describing their usage experience.

// C# pseudocode...

abstract class Feedback
{
    void Accept(IFeedbackVisitor visitor);
}

class StandardChoiceFeedback : Feedback
{
    int Code;
    string Description;
    void Accept(IFeedbackVisitor visitor) { visitor.Visit(this); }
}

class FreeFormFeedback : Feedback
{
    string Text;
    void Accept(IFeedbackVisitor visitor) { visitor.Visit(this); }
}

interface IFeedbackVisitor
{
    void Visit(StandardChoiceFeedback feedback);
    void Visit(FreeFormFeedback feedback);
}

Somewhere in the system, we display a grid of data, where each row corresponds to a user and one of the columns shows their feedback:

class FeedbackColumnRenderer : IFeedbackVisitor
{
    string RenderedText;

    void Visit(StandardChoiceFeedback feedback)
    {
        RenderedText = feedback.Description;
    }

    void Visit(FreeFormFeedback feedback)
    {
        RenderedText = feedback.Text;
    }
}

string RenderFeedbackColumn(Feedback feedback)
{
    FeedbackColumnRenderer renderer = new FeedbackColumnRenderer();
    feedback.Accept(renderer);
    return renderer.RenderedText;
}

So far, all we've shown is the overhead incurred by using visitor.

However, what happens when the requirements change? For example, our business analyst comes back in 3 weeks to inform us that on top of the two feedback options, there needs to be another option — the user can choose to leave their phone number so that a customer representative can give them a follow-up call to chat about their experience. We are asked to implement this change in the UI and the persistence layer.

Our core types change like this:

class FollowUpCallFeedback : Feedback
{
    PhoneNumber phoneNumber;
    void Accept(IFeedbackVisitor visitor) { visitor.Visit(this); }
}

interface IFeedbackVisitor
{
    void Visit(StandardChoiceFeedback feedback);
    void Visit(FreeFormFeedback feedback);
    void Visit(FollowUpCallFeedback feedback);
}

With just these changes, let's re-compile. What we find is that compilation isn't successful because all implementors of IFeedbackVisitor now have to implement the new Visit(FollowUpCallFeedback) method. On further examination of the compiler errors, we discover that not only are there feedback visitors in the UI and persistence layers, but there is also one used for an obscure report. We talk to our business analyst again, and find out that this report has been missed in talking about the change. Great! We then talk about what the report should look like when a phone number is involved.

I think this illustrates the power of the pattern. When something changes in our type hierarchy, we are actually forced to address all the places which will be affected up-front. If we had chosen to use a simple enumeration or type switching scheme instead and we are not extremely careful, we might not discover all the places that are affected by the requirements change until much later (for instance, when the testers [or worse, the users] visually inspect that particular report).

Why closure methods on collections matter

2006-07-29T00:48:00.000-06:00

I like the new closure methods (like ForEach and ConvertAll) on .NET 2.0 classes such as List<T> and Array, because from an OO standpoint, it really should be the responsibility of a collection to know how to traverse its own elements. However, I've always had a tough time justifying why you'd want to do...


employees.ForEach(delegate(Employee e) 
{
    Console.WriteLine(e);
});

... instead of...


foreach (Employee e in employees)
{
    Console.WriteLine(e);
}

In this case, it doesn't look like you gain anything.

Recently, I came across a situation which made me see the difference more clearly. Let's say you have a list of employees, and now, you want to remove all managers. Happily, we write...


foreach (Employee e in employees) 
{ 
    if (employee.Manager)
    {
        employees.Remove(e);
    }
}

This causes an exception because you can't modify a collection while you're iterating through it. OK, how about...


for (int i = 0; i < employees.Count; i++) 
{
    if (employees[i].Manager)
    {
        employees.RemoveAt(i);
    }
}

This doesn't throw an exception, but also doesn't work properly because we're modifying the count in the loop and our index will skip over elements. OK, so the solution is...


for (int i = employees.Count - 1; i >= 0; i--) 
{
    if (employees[i].Manager)
    {
        employees.RemoveAt(i);
    }
}

That's great! However, we now have to worry about remembering that a forward loop through a collection to conditionally remove elements semantically doesn't work. If you forget, no exception will be thrown, and only running unit tests or executing the program will reveal this.

On the other hand, we wouldn't have to remember this little gotcha if we simply relied on the RemoveAll method...


employees.RemoveAll(delegate(Employee e) { return e.Manager; });

In a way, this situation is similar to why we don't hesitate to use the Sort(IComparer) or Sort(Comparison<T>) methods, versus getting the elements and writing our own sorting algorithm. Do we have to care how the collection's sort works? Generally, no, since that's the responsibility of the collection.

FYI, check out the List<T>.RemoveAll method in .NET Reflector. It's not using a reverse for-loop.