YAGNI: delete speculative options
Delete the settings nobody uses, so each new column is a two-line change.
Watch the narrated video
Every step
Problem
Steps 1–4Refactor
Steps 5–10Payoff
Step 11Recap
Steps 12–13The code: before and after
Before
/* appsettings.json
{
"Export": {
"Format": "csv",
"Delimiter": ",",
"Header": true
}
}
*/
record ExportOptions(string Format, string Delimiter, bool Header);
class OrderExport
{
private readonly string format;
private readonly string delimiter;
private readonly bool header;
public OrderExport(ExportOptions options)
{
format = options.Format;
delimiter = options.Delimiter;
header = options.Header;
}
public string Export(List<Order> orders)
{
var output = new StringBuilder();
if (header && format == "csv")
{
output.Append("id" + delimiter + "total\n");
}
foreach (var o in orders)
{
string row = format switch
{
"csv" => o.Id + delimiter + o.Total,
"json" => "{\"id\":\"" + o.Id
+ "\",\"total\":" + o.Total + "}",
"xml" => "<order id=\"" + o.Id
+ "\" total=\"" + o.Total + "\"/>",
_ => throw new ArgumentException(format)
};
output.Append(row).Append('\n');
}
return output.ToString();
}
}
class NightlyJob(
ExportOptions options, IOrderRepo orders, IWarehouse warehouse)
{
public void Run()
{
string csv = new OrderExport(options).Export(orders.Today());
warehouse.UploadCsv(csv);
}
}After
/* appsettings.json
{
}
*/
class OrderExport
{
public string Export(List<Order> orders)
{
var output = new StringBuilder();
output.Append("id,total,postalCode\n");
foreach (var o in orders)
{
string row = o.Id + "," + o.Total + "," + o.PostalCode;
output.Append(row).Append('\n');
}
return output.ToString();
}
}
class NightlyJob(IOrderRepo orders, IWarehouse warehouse)
{
public void Run()
{
string csv = new OrderExport().Export(orders.Today());
warehouse.UploadCsv(csv);
}
}Transcript, step by step
Problem
Step 1: An export with three settings Before
Every night, this job exports today's orders and uploads them to the warehouse. Order Export reads three settings from the config file at the top, a format, a delimiter and a header flag. It writes a header line, then one row per order in whichever format the config names. It can write CSV, JSON or XML, so it looks ready for whatever the business asks for next.
Step 2: One column, four edits Code smell
The warehouse now wants the postal code as a third column. So the header gets a new name, and every arm of the format switch gets a new value. A speculative option is a setting built for a need nobody has yet, and this class reads three of them. You can see what they cost here in the header, here in the CSV arm, here in JSON, and here in XML.
Step 3: Two formats nobody reads Code smell
Yet the config file only ever says CSV, and the only caller uploads CSV to the warehouse. So the JSON and XML arms never run, and nobody would notice if one of them broke. One new column costs four edits, and two of them land in formats nothing reads. A missing quote in the XML line would compile fine and sit there until someone finally turns XML on. And every option multiplies the paths a reader has to check before trusting a change.
Step 4: Back it out, then delete Plan
Let's back that change out. YAGNI, you aren't gonna need it, says you build a feature when someone needs it, and these two formats have nobody. Kent Beck put it as make the change easy, then make the easy change. So we delete the options nobody uses, one small step at a time, and the file the warehouse gets stays the same after each one.
Refactor
Step 5: Delete the XML arm Remove Dead Code
No config value picks XML and no caller reads it, so the XML arm goes first. The switch keeps CSV, JSON and the discard arm, and the file the warehouse gets is the same as before.
Step 6: Delete the JSON arm Remove Dead Code
JSON goes for the same reason, so the switch is down to the CSV arm and a discard arm. That discard arm only throws for a format the config file never sets.
Step 7: Format can only be csv Remove Field
With one arm left, format can only ever be CSV, so it stops being a field. The switch collapses into the CSV row, and the header test only checks the header flag. Format leaves the config file too, because nothing reads it anymore.
Step 8: The delimiter is always a comma Remove Field
The delimiter was a comma in the config and nowhere else, so we write the comma in place. The field goes, along with its constructor line, its record parameter and its line in the config file.
Step 9: The header is always on Remove Field
Header is always true, so the path that skips the header line has never run. We delete the if, and then the field, because nothing reads it anymore. The config file is down to an Export section with nothing in it.
Step 10: Nothing left to configure Remove Parameter
The constructor took the options and read nothing from them, so it goes, and the Export Options record goes with it. The nightly job builds Order Export with no arguments now, and it drops its options parameter. And the config file at the top is empty.
Payoff
Step 11: The postal code, in two edits Payoff
Now the postal code goes back in. It takes one new name in the header and one new value in the row, so that's two edits. The JSON and XML arms that took two of the four edits are gone, and there's one row line where there were three arms. YAGNI fit here because the config always said CSV and the only caller uploads CSV, so those options cost an edit on every change and gave nothing back. The loop, the return and the nightly job didn't change.
Recap
Step 12: Where we started, where we ended Before / after
On the left, three fields copied a format, a delimiter and a header flag out of the config. The format switch had three arms, and only the CSV one ever ran. On the right, there's one short method, and the config file is empty. It already writes the postal code, and it's still shorter than the switch was.
Step 13: When to reach for it Takeaways
Delete an option when the config only ever sets one value and no caller reaches the other branches. Keep it when a second user is real and dated, like a signed contract with a JSON partner, or when ops set the value per environment, because deleting it means writing it again against a deadline. You'll spot it by config values that never change, switch arms no caller reaches, and defaults that nobody overrides.