https://github.com/tpierrain/birthdaygreetings

https://github.com/tpierrain/birthdaygreetings

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/tpierrain/birthdaygreetings
• Owner: tpierrain
• Created: 2015-02-23T16:03:58.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-02-24T00:41:35.000Z (over 9 years ago)
• Last Synced: 2023-04-03T14:07:11.702Z (over 1 year ago)
• Language: C#
• Size: 121 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        


# The birthday greetings kata

Origin: http://matteo.vaccari.name/blog/archives/154

## Purpose

To learn about the hexagonal architecture, which is a good way to structure an application, and how to shield your domain model from external apis and systems.

## Prerequisites

This is not a basic exercise. I suppose you are already familiar with TDD and refactoring.

## Ingredients

This kata can be done in two ways; if you want to try the refactoring way, then import in Eclipse the base code (update: the up-to-date version of the exercise code is on Github). If you want to try the TDD way, start with a blank Java project.

## Problem:

Write a program that loads a set of employee records from a flat file

Sends a greetings email to all employees whose birthday is today

The flat file is a sequence of records, separated by newlines; this are the first few lines:

	last_name, first_name, date_of_birth, email

	Doe, John, 1982/10/08, [email protected]

	Ann, Mary, 1975/09/11, [email protected]

The greetings email contains the following text:

	Subject: Happy birthday!

	Happy birthday, dear John!

with the first name of the employee substituted for “John”

The program should be invoked by a main program like this one:

	public static void main(String[] args) {

	    ...

	    BirthdayService birthdayService = new BirthdayService(employeeRepository, emailService);

	    birthdayService.sendGreetings(today());

	}

Note that the collaborators of the birthdayService objects are injected in it. Ideally domain code should never use the new operator. The new operator is called from outside the domain code, to set up an aggregate of objects that collaborate together.

## Goals

The goal of this exercise is to come up with a solution that is

+ Testable; we should be able to test the internal application logic with no need to ever send a real email.

+ Flexible: we anticipate that the data source in the future could change from a flat file to a relational database, or perhaps a web service. We also anticipate that the email service could soon be replaced with a service that sends greetings through Facebook or some other social network.

Well-designed: separate clearly the business logic from the infrastructure.

## An optional complication

If you want to develop further the domain logic, you can take into account the special rule for people born on a 29th of February: they should be sent greetings on the 28th of February, except in leap years, when they will get their greetings on the 29th.