Skip to main content

Smalltalk Conversion mapped to C#

Lately the team has been making some rather drastic changes and re-designs to our codebase in an attempt to minimise friction to change. In other words, we've identified areas that are painful or tedious to work in and have hopefully rectified them by re-writing the code. The proof of this should be felt as we begin adding new features, the newly improved code is certainly faster and more optimised.

Regardless, one area that remains troublesome in my opinion is object mapping (or the correct term of conversion) code. While I've not personally been involved with this reworking of the codebase, I have recently just finished reading Kent Beck's - Smalltalk Best Practice Patterns. Many of the developers I follow on Twitter have been blogging about this book and I figured it was time to give it a go. After all it gets massive praise whether or not you use Smalltalk. While reading this book a few key points regarding object conversion are discussed and I found them incredibly relevant.

So should you read the book? I would say yes. I don't program in Smalltalk. I don't plan on programming Smalltalk. Nor had I read a line of Smalltalk before. But you should still read this book. The first half is incredibly relevant to any OO programming language. Granted I found the second half is less useful, but the gems I've picked up in the first half more than make up for this. In fact, pages 28 to 30 are so good I figured it would be worth sharing.

I've been convinced for a while that creating separate objects to convert objects is unnecessary, and in fact adds to the amount of code you need to write and maintain, thus increasing resistance for change. So if we remove this unecesary, intermediate object, how do we create a new object from another object? The answer is conversion. This answer strangely comes from a book all about Smalltalk. The answer also strangely comes from a book over ten years old. Pages 28 - 30 cover the topic of conversion. The following is quoted heavily from the book, but I recommend reading the pages in full.


Question - How do you convert information from one object's format to another's?
Answer - Convert from one object to another rather than overwhelm any one object's protocol.

What this is getting at is we could using C# extension methods do the following to the String class.

This would be abusing the String class. If we want a postcode from a string, we should have the Postcode object create us a Postcode from a string, not the other way around. There could be hundreds of conversions from strings to a new object, but we would violate the string class if we did this. In turn, Kent goes on to say "Conversions that return similar responsibilities should use a Convert Method. To convert to an object with different protocol use a Converter Constructor Method".

Converter Method

Question - How do you represent simple conversion of an object to another object with the same protocol but different format?
Answer - Provide a method in the object to be converted that converts to the new object. Name the method by pre-appending "as" to the class of the object returned.

In C# this would be:

In C# the convention is to use To rather than As for converter methods. For example we could do quotes.ToArray() on a List of Quotes. We still have the same protocol, a collection of quotes, we are just storing them in a different format. The rule for adding such methods is that there should only be one sensible way to perform this conversion, and the source and destination share the same protocol.

Converter Constructor Method

Question - How do you represent the conversion of an object to another with different protocol?
Answer - Make a constructor method that takes the object to be converted as an argument

In our codebase we have a RegistrationDate object. We have a constructor that takes a string representation of the date (from the outside world) and constructs a RegistrationDate . This very same principle can be applied to other, more complex objects. For example consider an active record style approach below. Here QuoteRecord represents our database object, with Quote representing a domain object. The following would be the converter constructor method. In other words, we create (or convert) our quote from the quote record. No separate mapper. No intermediate object. Less resistance for change.

The benefit here is that we have minimised friction. If the requirements for this code changes we will need up to update at worst, the record and the domain object. Had we used a separate object to perform the mapping we would end up with a third place to maintain if we decided to add a new property to our QuoteRecord.

I'll admit to having only used this technique for a week or so, though so far it has worked a treat and I expect it to continue working considering these techniques have stood the test of time.


Popular posts from this blog

Three Steps to Code Quality via TDD

Common complaints and problems that I've both encountered and hear other developers raise when it comes to the practice of Test Driven Development are: Impossible to refactor without all the tests breakingMinor changes require hours of changes to test codeTest setup is huge, slow to write and difficult to understandThe use of test doubles (mocks, stubs and fakes is confusing)Over the next three posts I will demonstrate three easy steps that can resolve the problems above. In turn this will allow developers to gain one of the benefits that TDD promises - the ability to refactor your code mercifully in order to improve code quality.StepsStop Making Everything PublicLimit the Amount of Dependencies you Use A Unit is Not Always a Method or ClassCode quality is a tricky subject and highly subjective, however if you follow the three guidelines above you should have the ability to radically change implementation details and therefore improve code quality when needed.

DRY vs DAMP in Tests

In the previous post I mentioned that duplication in tests is not always bad. Sometimes duplication becomes a problem. Tests can become large or virtually identically excluding a few lines. Changes to these tests can take a while and increase the maintenance overhead. At this point, DRY violations need to be resolved.SolutionsTest HelpersA common solution is to extract common functionality into setup methods or other helper utilities. While this will remove and reduce duplication this can make tests a bit harder to read as the test is now split amongst unrelated components. There is a limit to how useful such extractions can help as each test may need to do something slightly differently.DAMP - Descriptive and Meaningful PhrasesDescriptive and Meaningful Phrases is the alter ego of DRY. DAMP tests often use the builder pattern to construct the System Under Test. This allows calls to be chained in a fluent API style, similar to the Page Object Pattern. Internally the implementation wil…

Coding In the Real World

As a student when confronted with a problem, I would end up coding it and thinking - how do the professionals do this?For some reason I had the impression that once I entered the industry I would find enlightenment. Discovering the one true way to write high quality, professional code.It turns out that code in industry is not too far removed from the code I was writing back when I knew very little.Code in the real world can be:messy or cleanhard or easy to understandsimple or complexeasy or hard to changeor any combination of the aboveVery rarely will you be confronted with a problem that is difficult. Most challenges typically are formed around individuals and processes, rather than day to day coding. Years later I finally have the answer. Code in the real world is not that much different to code we were all writing when we first started out.If I could offer myself some advice back in those early days it would be to follow KISS, YAGNI and DRY religiously. The rest will fall into plac…

Feature Toggles

I'm a fan of regular releasing. My background and experience leads me to release as regularly as possible. There are numerous benefits to regular releases; limited risk, slicker release processes and the ability to change as requirements evolve.The problem with this concept is how can you release when features are not functionally complete?SolutionIf there is still work in progress, one solution to allow frequent releases is to use feature toggles. Feature toggles are simple conditional statements that are either enabled or disabled based on some condition.This simple example shows a feature toggle for an "Edit User" feature. If the boolean condition is false, then we only show the "New User" feature and the "Admin" feature. This boolean value will be provided by various means, usually a configuration file. This means at certain points we can change this value in order to demonstrate the "Edit User" functionality. Our demo environment could …

Reused Abstraction Principle

This is the second part of my series on abstractions.Part 1 - AbstractionsPart 3 - Dependency Elimination PrincipleThe Reused Abstraction Principle is a simple in concept in practice, but oddly rarely followed in typical enterprise development. I myself have been incredibly guilty of this in the past.Most code bases have a 1:1 mapping of interfaces to implementations. Usually this is the sign of TDD or automated testing being applied badly. The majority of these interfaces are wrong. 1:1 mappings between interfaces and implementations is a code smell.Such situations are usually the result of extracting an interface from an implementation, rather than having the client drive behaviour.These interfaces are also often bad abstractions, known as "leaky abstractions". As I've discussed previously, these abstractions tend to offer nothing more than simple indirection.ExampleApply the "rule of three". If there is only ever one implementation, then you don't need …