Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kbilsted/stateprinter
Automating unit testing and ToString() coding
https://github.com/kbilsted/stateprinter
golden-master tostring tostring-utilities unittest
Last synced: 1 day ago
JSON representation
Automating unit testing and ToString() coding
- Host: GitHub
- URL: https://github.com/kbilsted/stateprinter
- Owner: kbilsted
- License: apache-2.0
- Created: 2014-03-15T20:06:12.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T17:22:11.000Z (almost 3 years ago)
- Last Synced: 2024-11-06T02:52:56.456Z (1 day ago)
- Topics: golden-master, tostring, tostring-utilities, unittest
- Language: C#
- Homepage:
- Size: 1.5 MB
- Stars: 92
- Watchers: 11
- Forks: 31
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
#  StatePrinter
[](https://ci.appveyor.com/project/kbilsted/stateprinter/branch/master)
[](http://nuget.org/packages/stateprinter)
[](http://nuget.org/packages/stateprinter)
[](http://nuget.org/packages/stateprinter)
[](https://coveralls.io/r/kbilsted/StatePrinter?branch=master)
[](http://www.apache.org/licenses/LICENSE-2.0)
[]()
[]()
[](https://gitter.im/kbilsted/StatePrinter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
**THIS PROJECT IS BEING SUPERSEDED BY *ReassureTest*! GO TO https://github.com/kbilsted/ReassureTest.Net**
# What is Stateprinter
A simple framework for **automating** aspects of implementing `ToString()`-methods, unit testing, and debugging. Speed is achieved through **run-time code generation** and caching.
Why you should take StatePrinter for a spin
* *No more manual `ToString()`* - it is much easier to write robust and self-sufficient `ToString()` methods. Seamless integration into a code-base with manually implemented ToString-methods.
* *No more manual writing/updating Asserts* - both for new tests and when the code changes, all tests can automatically be corrected.
* *No more screens full of asserts*. Especially testing against object-graphs is a bliss.
* Very configurable and extensible.
* It is part of the back-end engine of other projects
* The very nice [ApprovalTests framework](http://approvaltests.sourceforge.net/).
## How do I get started
The documentation is split into
* [Automating ToString methods](https://github.com/kbilsted/StatePrinter/blob/master/doc/AutomatingToStrings.md)
and
* [Automating unit testing](https://github.com/kbilsted/StatePrinter/blob/master/doc/AutomatingUnitTesting.md)
* [The problems with traditional unit testing (that stateprinter solves)](https://github.com/kbilsted/StatePrinter/blob/master/doc/TheProblemsWithTraditionalUnitTesting.md)
and
* [Configuration and exension](https://github.com/kbilsted/StatePrinter/blob/master/doc/HowToConfigure.md)
## Where can I get it?
Install Stateprinter from the package manager console:
```
PM> Install-Package StatePrinter
```
And for pre-release versions
```
PM> Install-Package StatePrinter -Pre
```
## How can I get help?
For quick questions, [Stack Overflow](http://stackoverflow.com/questions/tagged/stateprinter?sort=newest) is your best bet. For harder questions, bugs, issues or feature requests, [create a GitHub Issue (and let's chat)](https://github.com/kbilsted/StatePrinter/issues/new).
## How can I help out
Everyone is encouraged to help improve this project. Here are a few ways you can help:
* Blog about your experinces with the tool. We highly need publicity. I'll gladly link from here to your blog.
* [Report bugs](https://github.com/kbilsted/StatePrinter/issues/new)
* [Fix issues](https://github.com/kbilsted/StatePrinter/issues/) and submit pull requests
* Write, clarify, or fix [the documentation](doc/)
* [Suggest](https://github.com/kbilsted/StatePrinter/issues/new) or add new features
*StatePrinter has been awarded a ReSharper group license, to share among all active contributers*.
## Versioning
Stateprinter is maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:
`..`
and constructed with the following guidelines:
* Breaking backward compatibility bumps the major
* New additions without breaking backward compatibility bumps the minor
* Bug fixes and misc changes increase the build number
For more information on SemVer, please visit http://semver.org/.
## History
Version History: http://github.com/kbilsted/StatePrinter/blob/master/CHANGELOG.md
This file describes the latest pushed changes. For documentation of earlier releases see:
[1.0.6](https://github.com/kbilsted/StatePrinter/blob/1.0.6/README.md), [1.0.5](https://github.com/kbilsted/StatePrinter/blob/1.0.5/README.md), [1.0.4](https://github.com/kbilsted/StatePrinter/blob/1.0.4/README.md)
Upgrading from v1.xx to v2.0.x should be a matter of configuring the `Configuration.LegacyBehaviour`
Upgrading from v2.0 to v2.1 simply follow the documentation in the obsolete attributes.
## Requirements
Requires .NET 3.5 or newer.
## License
Stateprinter is under the Apache License 2.0, meaning that you can freely use this in other open source or commercial products. If you use it for commercial products please have the courtesy to leave me an email with a 'thank you'.
**THIS PROJECT IS BEING SUPERSEDED BY *ReassureTest*! GO TO https://github.com/kbilsted/ReassureTest.Net**
Have fun!
Kasper B. Graversen