PerfectStorm Wiki & Documentation Rss Feed

Updated Wiki: Home

chriseyre2000 — Mon, 23 Mar 2009 21:02:21 GMT

Project Description
Perfect Storm started life as a code generation utility.

It now includes workflow utilities.

It requires .NET 3.0 to be installed.

PerfectStorm.CodeGen

Design Philosophy XML as a Domain Specific Language

This is a one stop code generation utility.
It permits model driven development leaving the user in total control.

Now includes the ability for the user to define their own Transformation Filters

The initial utility has the following syntax:

CodeGen model transform target [name value]*

This can be used to create a batch file which when run against the model document can be used to generate whatever source you want.
Look in the demo folder for an example.

The transform is an xslt document.

Since the transforms and the model are entirely customizable by the user this can be used to create almost anything.

This project was inspired by Code Generation in Microsoft.NET.

The application now includes a small suite of xslt Functions.

There are a number of demo projects.

Here is a quick xslt tutorial. I am not claiming to be an expert, but I can read xslt.

I would love to get feedback on this project - ideas for expansion, contributed samples, success stories (or otherwise).
All contributions will be credited.

About Version Numbers

Things I Have Generated

PerfectStorm.Rules

I have taken to experimenting with the rules engine from the WF framework. This is a place for me to keep the rules engine parts.

Updated Wiki: Home

chriseyre2000 — Sat, 30 Aug 2008 10:01:31 GMT

Project Description
Perfect Storm is a code generation utility.

It requires .NET 2.0 to be installed. This also works with Mono.
It is written in C#, but that should not prevent it from being used to generate anything (it can make raw text files and xml - what else do you need?).

Design Philosophy XML as a Domain Specific Language

This is a one stop code generation utility.
It permits model driven development leaving the user in total control.

Now includes the ability for the user to define their own Transformation Filters

The initial utility has the following syntax:

CodeGen model transform target [name value]*

This can be used to create a batch file which when run against the model document can be used to generate whatever source you want.
Look in the demo folder for an example.

The transform is an xslt document.

Since the transforms and the model are entirely customizable by the user this can be used to create almost anything.

This project was inspired by Code Generation in Microsoft.NET.

The application now includes a small suite of xslt Functions.

There are a number of demo projects.

Here is a quick xslt tutorial. I am not claiming to be an expert, but I can read xslt.

I would love to get feedback on this project - ideas for expansion, contributed samples, success stories (or otherwise).
All contributions will be credited.

About Version Numbers

Things I Have Generated

This project will not be updated during September as I am getting married. Updates will resume when I am back from my Honeymoon

Updated Wiki: Things I Have Generated

chriseyre2000 — Wed, 20 Aug 2008 21:11:31 GMT

Things I Have Generated

In addition to being the developer of this project I am also a user of it.

Here are a list of the items that I have generated:

Sharepoint Content Type and Field defintions (as feature.xml)
Table creation scripts
Index creation scripts
Trigger creation scripts
Monorail Model components
Monorail Controller components

The real benefit of this is that you can create a whole project worth of identically structured files.
Any improvements that you think of will be applied everywhere.
You end up with very consistent code and the business analysts can keep changing their minds and you are not driven to distraction!

The only catch I have found is getting the whitespace to work properly. The trick is to use <xsl:value-of select="' '"/> between consectutive xslt tags where you want a space.

Updated Wiki: Things I Have Generated

chriseyre2000 — Wed, 20 Aug 2008 21:11:04 GMT

!Things I Have Generated

In addition to being the developer of this project I am also a user of it.

Here are a list of the items that I have generated:

Sharepoint Content Type and Field defintions (as feature.xml)
Table creation scripts
Index creation scripts
Trigger creation scripts
Monorail Model components
Monorail Controller components

Updated Wiki: Home

chriseyre2000 — Wed, 20 Aug 2008 21:03:59 GMT

Updated Wiki: Home

chriseyre2000 — Wed, 20 Aug 2008 21:02:55 GMT

Updated Wiki: Code Generation in Microsoft.NET

chriseyre2000 — Wed, 20 Aug 2008 21:00:11 GMT

Code Generation in Microsoft.NET

by Kathleen Dollard

This is the book that inspired the writing of this tool.

The price of the book is worth it for the xslt tutorial chapters alone!

The book describes a set of principles and techniques that can be used to develop code using code generation techniques.
The book intended to provide the reader with the knowledge required to create their own code generation utility.
However as the book provided a sample suite of generation tools to act as examples most discussions of the book treats it as an introduction to the supplied generation tools.
I have taken the other approach and have created my own tool based upon the presented techniques.

Here are the principles:

You have control of the templates that generate your code and can change them as required.
Collect metadata as a separate, distinct step with usable output that can independently evolve.
You or someone unfamiliar with the project can regenerate your code precisely as a one click process - now or at any point in the future.
You embrace handcrafted code by isolation and protecting it. Code generation is a supporting player to human programming and doesn't overwrite files unless they were generated and haven't been edited.
The code generated application is a high quality application. It allows more effective testing, has equal or better performance and is more easily maintained than a similar fully handcrafted application.

Currently Perfect Storm's CodeGen fails to acheive protection of handcrafted code - but I intend to add this as a feature soon.

Protection of handcrafted code can be implemented as a transform filter.

Updated Wiki: Transformation Filters

chriseyre2000 — Wed, 20 Aug 2008 20:54:46 GMT

!Transformation Filters

A transformation filter is a class that implements the ITransformFilter interface.

It is registered by adding an entry in the app.config file under filters.

The following is the definition of ITransformFilter:

public interface ITransformFilter
{
bool BeforeTransform(XmlDocument model, XmlDocument xslt, string outputFilename, Hashtable data, params string[] arguments);

MemoryStream AfterTransform(XmlDocument model, XmlDocument xslt, MemoryStream priorOutput, MemoryStream output, string outputFilename, Hashtable data, params string[] arguments);
}

BeforeTransform is used to prevent the transformation taking place.
If any registered filter returns false from the BeforeTransform then the output will not be written.
This allows specific files to be protected (effectively they can become write once)
It is passed:

the model file (as xml),
the transform file (as xml)
the name of the file to be created
A hashtable (intended to allow the filters to communicate with one another)
the command line parameters initially passed in

If it returns true then the filter permits the code generation to continue,

AfterTransform is used to alter the output. It can do anything to the output.
If it does not return null then the returned memorystream is used in place of the output.
It is passed:

the model file (as xml),
the transform file (as xml)
the previous output as a memorystream (or null if it did not previously exist).
the current output.
A hashtable (intended to allow the filters to communicate with one another)
the command line parameters initially passed in

If it returns a non-null memory stream then this is used in place of the current memory stream.

The minimal null transform would return true from the BeforeTransform and null from the AfterTransform.

Updated Wiki: Transformation Filters

chriseyre2000 — Wed, 20 Aug 2008 20:53:08 GMT

the model file (as xml),
the transform file (as xml)
the name of the file to be created
A hashtable (intended to allow the filters to communicate with one another)
the command line parameters initially passed in

the model file (as xml),
the transform file (as xml)
the previous output as a memorystream (or null if it did not previously exist).
the current output.
A hashtable (intended to allow the filters to communicate with one another)
the command line parameters initially passed in

If it returns a non-null memory stream then this is used in place of the current memory stream.

Updated Wiki: Home

chriseyre2000 — Wed, 20 Aug 2008 20:39:36 GMT

Project Description
Perfect Storm is a code generation utility.

It requires .NET 2.0 to be installed. This also works with Mono.
It is written in C#, but that should not prevent it from being used to generate anything (it can make raw text files and xml - what else do you need?).

This is a one stop code generation utility.
It permits model driven development leaving the user in total control.

Now includes the ability for the user to define their own Transformation Filters

The initial utility has the following syntax:

CodeGen model transform target [name value]*

This can be used to create a batch file which when run against the model document can be used to generate whatever source you want.
Look in the demo folder for an example.

The transform is an xslt document.

Since the transforms and the model are entirely customizable by the user this can be used to create almost anything.

This project was inspired by Code Generation in Microsoft.NET.

The application now includes a small suite of xslt Functions.

There are a number of demo projects.

Here is a quick xslt tutorial. I am not claiming to be an expert, but I can read xslt.

Design Philosophy

I would love to get feedback on this project - ideas for expansion, contributed samples, success stories (or otherwise).
All contributions will be credited.

XML as a Domain Specific Language

About Version Numbers

Updated Wiki: About Version Numbers

chriseyre2000 — Sat, 09 Aug 2008 10:00:24 GMT

Version Numbers

There are so many conventions for version numbers but here is the one that I am using.

Version numbers are of the form:

A.B.C.D

A will change with a major rewrite

B will change when a change will require templates to change.

C will change when a change will require the CodeGen.exe.config to be altered.

D will change for additive updates and bug fixes.

If an item is changed all of the lesser ones reset to zero.

Updated Wiki: Home

chriseyre2000 — Sat, 09 Aug 2008 09:54:58 GMT

Project Description
Perfect Storm is a code generation utility.

It requires .NET 2.0 to be installed.
It is written in C#, but that should not prevent it from being used to generate anything (it can make raw text files and xml - what else do you need?).

Currently Mono support is broken but it is intended to fix it.

This is a one stop code generation utility.
It permits model driven development leaving the user in total control.

The initial utility has the following syntax:

CodeGen model transform target [name value]*

This can be used to create a batch file which when run against the model document can be used to generate whatever source you want.
Look in the demo folder for an example.

The transform is an xslt document.

Since the transforms and the model are entirely customizable by the user this can be used to create almost anything.

This project was inspired by Code Generation in Microsoft.NET.

The application now includes a small suite of xslt Functions.

There are a number of demo projects.

Here is a quick xslt tutorial. I am not claiming to be an expert, but I can read xslt.

Design Philosophy

I would love to get feedback on this project - ideas for expansion, contributed samples, success stories (or otherwise).
All contributions will be credited.

XML as a Domain Specific Language

About Version Numbers

Updated Wiki: XML as a Domain Specific Language

chriseyre2000 — Sun, 03 Aug 2008 21:29:18 GMT

XML as a Domain Specific Language

This is ideal for describing the structure of things.
Business analysts can sketch out entities very quickly in notepad if needed.

With a little xslt (and a suitable application framework) you can turn this into demo in a few hours top.

XML is not very good at loops and branching...

Updated Wiki: Home

chriseyre2000 — Sun, 03 Aug 2008 21:26:24 GMT

Updated Wiki: Home

chriseyre2000 — Sun, 03 Aug 2008 21:19:53 GMT

Updated Wiki: Design Philosophy

chriseyre2000 — Sun, 03 Aug 2008 21:16:58 GMT

Design Philosophy

This tool will be as simple as possible without compromising the power available.

Nothing is hidden behind a gui - anything that you do can be done on the command line.
There are plenty of codegen tools out there that have a very high startup cost.
The only price for this one is that you must learn some xlst.

Debugging can be done using the tool itself - simplify your problem into an xml document and a transform and solve it one item at a time.

The entire power of xslt is at your disposal.

Earlier versions of what inspired this required separate tools or documents for the creation of the specific data.
The original part is allowing you to supply xslt template parameters on the command line!
Everything changes once you can do that! All else is detail.

The project will supply additional functionality and bundle the same tool in other forms but the templates will always be transferable between versions.

If you don't like the .Net basis of this project then feel free to port it to another platform.
I can see this same idea working in Ruby or Java. The syntax would remain the same!

The templates and model are yours to define and extend however you wish.

Just because my examples all use batch files don't feel constrained - these are lowest common denominator examples - feel free to use Nant, MSBuild, Powershell, boo, perl whatever floats your boat.
The codegen tool even returns errorcode on failure so you can make the batch files even more sophisticated if you want to.

Updated Wiki: Design Philosophy

chriseyre2000 — Sun, 03 Aug 2008 21:11:52 GMT

Updated Wiki: Home

chriseyre2000 — Sun, 03 Aug 2008 21:02:57 GMT

Updated Wiki: xslt tutorial

chriseyre2000 — Sun, 03 Aug 2008 20:57:51 GMT

xslt Tutorial : Just Enough xslt to perform...

xslt is a complex language that is used to translate an xml document into anything else.

It is very powerful, yet can be odd to read for the uninitiated.
I cut my teeth on xslt when working on a project that used complex xlst transforms that I had to work out.
Eventually it becomes readable - but I will try to stick to the simple stuff.

This article is intended to become a basic primer.

To start with an xslt template needs the following goo at the start:


<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:PerfectStorm="urn:PerfectStorm">
<xsl:output method="text" standalone="yes" />
<xsl:preserve-space elements="*" />
<xsl:template match="/">

and the following goo at the end

</xsl:template>
</xsl:stylesheet>

This is the basic version of an xslt template - it can get far more involved.

There are several styles of xslt template:

One fills in a document based upon data supplied by an external xml document - this is typically the form that I use for codegen.
Others take an xml document and alter it's values following the structure of the document. This is harder to follow and I have yet to require it for codegen.
However it is there if needed.

Lets give a worked example of the first kind. Note this is not the trivial fill in the blanks option this does a lookup via xpath:

Here is the source document (what I call a model):

<model>
<data id="foo">42</data>
<entity name="Owner" id="foo">
</entity>
</model>

Here is the transform:


<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:PerfectStorm="urn:PerfectStorm">
<xsl:output method="text" standalone="yes" />
<xsl:preserve-space elements="*" />
<xsl:template match="/">
<xsl:for-each select="model/entity">
public class <xsl:value-of select="@name" /> {
//<xsl:value-of select="//data[@id=current()/@id]" />
}
</xsl:for-each>
</xsl:template>
</xsl:stylesheet>

This reads as loop through the model looking for entities (this is the xsl:for-each)
If you find an entity write out some text (the class bit).

Inside the class add a comment that is looked up from the data element with a matching id attribute.
The // in the xpath expression means find me the first item that satisfies the criteria from the top of the document.
It is a useful shorthand.

The bits inside the " " is a restriction clause. The current() refers to the node that we are currently looking at in the xsl:for-each loop.
Tests come in two flavors. This is an equality test. The other form is an xpath expression - in that case if the xpath expression finds a node then it is true, otherwise it is false.

Coming soon ... calling templates and passing parameters.

Updated Wiki: Home

chriseyre2000 — Sun, 03 Aug 2008 20:37:33 GMT