Joutsen Framework

The Joutsen framework offers extensions and convenience functionality for the .NET Framework for often required tasks. It is a collection of classes and methods that are often used but either complicated to implement or unnecessarily reimplemented for every project.

The functionality offered by the Joutsen framework can also be used to ease the writing of unit tests. It offers extensions to commonly required functionality to write efficient test code.

The goal of the project is to further extend the .NET Framework to reduce the need of rewriting common code over and over for each project.

Installation

The build binaries can be directly referenced by other projects in order to make use of the functionality.

API Reference

The documentation of the stable version of the framework's APIs can be found here.

Building

In order to build the project .NET Framework 4.7 is required. After cloning the project update the submodules by running:

% git submodules update –init

With all the code available the NuGet packages can be updated and the solution can be build using MSBuild. A convenient way to handle all of this is the build.sh bash script in the scripts folder.

Test

The project includes unit and component tests which can be run with any nunit testrunner. All the requirements for the tests are bundled with the tests. The tests-run.sh bash script in the scripts folder can provide a fast way to run the tests.

Name

"Joutsen" is the Finnish word for swan which reflects on the author's name. It can also be seen as an acronym for "Just Outright UTilizable Simple Extensions for .NET" which would be more like a description but is not really used.