An outlet for my obsession with technology
Posts tagged fluent interface
Checkers – Fluent “Checking” Framework
Aug 9th
What:
A “validation” “framework” that, by default convention, does not throw exceptions but instead sets a failed property and builds a list of fail messages.
“Validation”
I took inspiration from the many other server-side validation frameworks.
“Framework”
It’ is just one (fugly) class, < 300 LOC and 70+ tests.
Samples
Take a look at the tests!
http://github.com/detroitpro/Checkers/blob/master/CheckersTests/FluentAPIDesignTests.cs
check.That(2).IsA(typeof(string)).Or("2 is not a string fail");
Features
- That – the item to be checked
- IsNotNull – null check
- IsGreaterThan, IsGreatherThanOrEqualTo, IsLessThan, IsLessThanOrEqualTo
- Is – equality checking for int and string
- IsA – type checking
- Or – Override default fail message
- Fail – No more checks if current check fails
- EpicFail – throw exception
Source
http://github.com/detroitpro/Checkers
Why?
There are so many ways I could answer this question. I’ll just tell you how I thought it would be used.
In a SOA environment where we:
- Don’t want to use exceptions to control business logic flow.
- Don’t want to send exceptions over the wire to our UI/Web servers.
- Don’t want to send exceptions up to our partner API.
- Need to squeeze performance out of our underpowered servers.
AutoDeploy.NET to GitHub
Jul 20th
First; When I pushed to GitHub I decided to rename the project to AutoDeploy.NET.
In the hopes of keeping my sanity and in the context of working in an organization that strictly follows a 50+ page “release management handbook” I started working on AutoDeploy.NET; a deployment automation tool.
As with all my personal projects I took an academic approach to the design and implementation. Instead of building an entire application I created a class library (dll) and used a few 3rd party libraries that I was either unfamiliar.
Class Library
My thought here is that by just creating the class library I would have a chance to create a fluent interface and if I did that well enough, creating a UI would be a trivial task. I have not hit a brick wall with this decision but messaging and logging might soon bite me in the…end.
Sharp SVN
SharpSvn is a binding of the Subversion Client API for .Net 2.0 applications contained within a set of xcopy-deployable dll’s
Working with source control should be part of every deployment, build process, or continuous integration. I use SVN for my source control and so did organization. As I, along with what seems like the rest of the world, move to Git I might find time to write a Git service for AutoDeploy.NET
Html Agility Pack
The Html Agility Pack is an agile HTML parser that builds a read/write DOM and supports plain XPATH or XSLT (you actually don’t HAVE to understand XPATH nor XSLT to use it, don’t worry…). It is a .NET code library that allows you to parse "out of the web" HTML files. The parser is very tolerant with "real world" malformed HTML. The object model is very similar to what proposes System.Xml, but for HTML documents (or streams).
Instead of using Sharp SVN or simple the .NET webclient I used the agility pack to parse the html that is returned when browsing a SVN repo. This is done to monitor the repo for new tags and kick off deployments based on the tag convention x.x.x.
The use is purely academic and limited in scope. It could easily be removed in order to cut-down on the number of 3rd party libraries required.
MEF
The Managed Extensibility Framework (MEF) is a new library in .NET that enables greater reuse of applications and components. Using MEF, .NET applications can make the shift from being statically compiled to dynamically composed. If you are building extensible applications, extensible frameworks and application extensions, then MEF is for you.
Extensibility! The decision to use MEF at such an early stage was purely academic but the result is perfect. I only wanted to code for the common scenarios.
In the environment I worked the process was very manual with SharePoint forms being touted as progress…I planed on writing a class library that implemented ICustomTask and called WaitN to fill out the endless, mind-numbing, pointless, wasteful, costly, wow….sorry..off track.
Unity
The Unity Application Block (Unity) is a lightweight extensible dependency injection container with support for constructor, property, and method call injection.
I choose unity because I am familiar with it. I should have used ninject or autofac or StructureMap or .. well you get the point.
Fluent Interface
A fluent interface is a way of implementing an object oriented API in a way that aims to provide for more readable code.
It started off as a way to work with the buzz word of the day…but the first time I wrote an AutoDeploy.NET parent application using the fluent interface I was hooked!
Point In Time
I made, what I consider, significent progress on AutoDeploy.NET before parting ways with said organization. And while I hope to never ever need such a tool I feel for those solders I left behind. Seriously; we’ve identified many different scenarios where automating one or more of the common deployment tasks would be helpful to any developer.
Logging, Auditing and Messaging are the missing pieces at this time.
Introducing: AutoDeploy
Jun 11th
A class library to help automate simple deployment tasks.
Warning: pre-alpha.
AutoDeploy has 2 main components; deployment objects and a deployment controller. A deployment object holds n+1 deployment tasks. The deployment controller is responsible for executing scheduled, interval and on demand deployment tasks.
AutoDeploy is complete enough for me to start dog fooding it this week. I’ll have a road-map soon after.
Features
- Deployment Controller
- Scheduled Deployments
- Interval Deployments
- SVN Checkout
- SVN Commit
- ASP.NET Build
Example 1: Fluent Interface, SVN Checkout, Interval
1: var deploymentController = AutoDeploy.Controllers.DeploymentController.GetInstance;
2: new AutoDeploy.Mappings.FluentMapping().Named("TestMapping")
3: .FromSvnHttpRepositoryUrl("URL")
4: .UsingSvnCredentials(new System.Net.NetworkCredential("UID", "PASS"))
5: .SvnCheckoutToDirectory("C:/Temp")
6: .AtTime(6)
7: .Save();
First, or last, or never..we create a controller. The controller will check every minute for interval and scheduled deployments. In this example we checkout every day @ 6am.
Example 1: Fluent Interface, Compile, Publish, One Time
1: new AutoDeploy.Mappings.FluentMapping()
2: .SvnCheckoutToDirectory("C:/Temp")
3: .BuildAndOutputToDirectory("C:/TempCompiled")
4: .Execute();
shhh..I know the source directory name is horrible…
