Software Updates
I've been doing some work on my personal code projects... It has occurred to me that I write a lot of code that writes code for me so I don't have to write as much code...
All code is open source, and available as git repositories at Bitbucket
Traceability provides functionality to gather extremely detailed information on a running system. This data can be used for forensic analysis, troubleshooting, debugging, and code optimization.
Features:
- Automated code generation has been significantly improved. It now takes only two lines of code to generate a file.
- Three different class types are now generated: factory classes, trace classes, and trace factory classes.
This library lets you generate documentation for code that heavily uses Inversion of Control / Dependency Injection (i.e. rules based code). Its goals are
- A consistent interface to work with documentation.
- Relevant documentation about the code is kept with the code.
- Documentation is easier to update whenever the code is updated.
- Automated build systems may now extract the documentation and use it to create external documentation.
The default formatting of the documentation is comma separated values, thus it is very easy to put it all into a CSV spreadsheet.
This is a walk through covering how to add Traceability to a library. It starts with a basic library containing classes and unit tests. By the end we will have added factories, trace classes, and trace factories to the project.
Really neat part: it shows how to use dependency injection to set up the unit tests so that the trace classes may reuse the functional unit tests. The end result is that any time you update unit tests in the functional layer, the trace layer gets them with no additional work.
Another example project. In this case, it shows how to implement Traceability into a service such that you can dynamically turn tracing on and off. It uses multiple trace modes as well as formatting the output into XML or HTML.
Features
- Multiple trace modes
- Multiple data formatting showing how to implement data extraction.
- It also uses RuleDocs, which outputs CSV files showing the hierarchy of the formatter code.