Contact Me

Software Factories:
45+ new jQuery techniques for good user-experience 

If you’re using jQuery and want to improve the user-experience on your website, then take some time over a coffee and read this article.

It outlines more than 45 jQuery based solutions to improving website user-experience, including iPod style drilldown menus, Facebook like dynamic input, context menus, pagination, and light-box techniques.
[ add comment ] [ 0 trackbacks ] permalink
Mock-you... this is how I mock! 

Mocking Frameworks are becoming more prominent in our development activities as unit testing, and hopefully test driven development, become much more mainstream. Like most technical topics, the choice of Mocking Framework can lead to long debates. I’ve been involved in these debates myself, and a fairly recent Phil Haack post that compares Rhino Mocks to Moq sums up these typical discussions.

Like Phil (and I would suspect most other Developers), I too have only recently discovered Moq (pronounced “mock-you”), and I’ve started to favour it over Rhino Mocks. Expectations are much more easily set up, and playback is more implicit. This simply suits my style and I also like the use of lambda’s in setting up the expectations. Perhaps my style makes me a mockist.
[ add comment ] [ 0 trackbacks ] permalink
Explicit or implicit interface implementation 

I accidentally came across this blog post yesterday that discusses the use of explicit and implicit interface implementations in C#. I have to admit, although I’ve known about these two approaches of interface implementation, I’ve never really given them any serious thought. I normally implement interfaces implicitly:
public interface IFoo
{
   void Bar();
}

public class Foo : IFoo
{
   public void Bar()
   {
      // implementation
   }
}

The explicit version basically requires that you qualify the method in the implementing type (IFoo.Bar()), and remove the access modifier (since it must be public as in the interface itself). So far the only changes are in the syntax, therefore the differences must manifest themselves during compilation:

Given the explicit implementation of IFoo:
public class Foo : IFoo
{
   void IFoo.Bar()
   {
      // implementation
   }
}

you cannot directly invoke Bar() on a Foo object without first casting it to IFoo:
Foo f = new Foo();
f.Bar(); // causes a compilation error

Foo f = new Foo();
((IFoo)f).Bar(); // works fine

In my opinion (coming from a C++ background), this is counter-intuitive. Since the Bar() method is public I would like it to be callable without a cast. After all, there is nothing stopping me from performing the cast in order to call the method, so why does the compiler force you through the hoops?

Brad Adams has some interesting thoughts on explicit interface implementations and where they should be used. In brief, he recommends their usage for hiding implementation details (i.e., the interface is typically only used internally), therefore approximating a private interface implementation. As I already mentioned, you can still directly call the methods through a cast, but the methods are effectively hidden from public view. Given this, I would generally think of explicit interface implementation as an implementation pattern, and I feel safe continuing to implement interfaces implicitly.

One final thought: if you use explicit interface implementation on a value type (i.e., on a struct), there will be a boxing performance penalty when you call any of the implemented methods.
[ 1 comment ] ( 19 views ) [ 0 trackbacks ] permalink
Design for Test 

As Developers we have quickly learnt how important unit testing is. Moreover we have also learnt, sometimes through hard lessons, that to implement unit tests we need to design and build our code so that it is actually testable. In my mind, this is a benefit, since it forces us to think about the code we’re writing, and more often than not, a better design emerges from our efforts.

We all know that one of the biggest advantages of unit testing is that it affords us confidence when making future changes. We know we’re going to make them, so let’s help ourselves when we do. Unit testing is also an important ally when refactoring code (especially if you also practice continuous refactoring – like all good Developers should). A good example of what I mean by “design for test” came about with the release of ASP.NET MVC Preview 3.

Although based on a pattern which itself leads to increased testability (Model-View-Controller), prior to Preview 3 there were still some fiddly points that made testing controllers and their actions awkward. Actions were void which meant it was difficult to observe and test expectations about what the action did. With Preview 3 actions can now optionally return an ActionResult object, which is then executed later on in the rendering process by the MVC Framework. This refactoring increases the ability to unit test controllers and actions, and more importantly, it makes writing those tests easier since there is less of a requirement to mock. This is a good example of “design for test”.

[ add comment ] [ 0 trackbacks ] permalink
“var”: a contentious little keyword 

It’s old news but most of us will know that C# 3.0 introduced a new keyword: var. This tiny keyword brings with it a great deal of power behind the scenes, most of which was intended for use with another C# 3.0 language feature, namely LINQ. Simply put, what var does is tell the compiler to infer the type being used rather than having it specified explicitly.

You can appreciate this benefit when working with LINQ, since the type being returned from a query may not be known in advance. Consider anonymous types for example, and their use with LINQ projection where you cannot explicitly determine the result type. With this scenario you have to utilize the var keyword:
string[] words = {"AA","BB", "Hello", "World", "CCC", "DDDD"};

var result = 
  from s in words 
  where s.Length >= 5
  select new { Word = s, Length = s.Length };

So, in the above example we’re returning instances of an anonymous type from a query that will contain two properties: Word, and Length. We have two options, either explicitly create a new type that defines those two properties, or use var. If we use a var declaration then we understand that those anonymously typed object instances can only be used locally. I have no problem at all with this use of var (since it is really what var was designed for). The same goes for anonymous types – they should only be used in the context of LINQ (unless they’re used for very localized purposes).

What about the following query instead?
string[] words = {"AA","BB", "Hello", "World", "CCC", "DDDD"};

var result = 
  from s in words 
  where s.Length >= 5
  select s;

To some this is acceptable, but to me it’s problematic. If we look at the line of code defining the query, we have no way of determining the type of the result variable other than to scan the lines of code above it (maybe you could call this human inference). Why would this be acceptable? Why would you want to have to scan code in order to determine a variable’s type?

Instead, I would use the following query and be explicit about the type (after all, it’s not anonymous):
IEnumerable<string> result = 
  from s in words 
  where s.Length >= 5
  select s;

Now it’s easy to see what the query is projecting (a collection of strings). It might be a few more characters to type, but it is much more readable by myself and my fellow Developers.

In short, I think that the over use of var can easily lead to unreadable code, and that as Developers, we owe it to ourselves to keep our code readable. One use of var outside the context of LINQ that I really like is shown below:

var hashtable = new Hashtable<int, List<MyClass>>();

You can still easily determine the type of the hashtable variable from the same line of code, and you’ve saved yourself from typing the type-name twice.

Another example of var laziness is shown below:
foreach (var word in words)
{
  word.??
}

Reliance on Intellisence is simply not an answer.

[ add comment ] [ 0 trackbacks ] permalink
Setting up Team Foundation User Permissions 

So you've installed Team Foundation Server and now you need to setup your permissions. There's quite a lot to follow in the TFS Installation Guide, so if you're using Active Directory, here's a digest of how I've recently defined permissions on a single-server deployment (this should work with both 2005 and 2008):

First, we have to remember that there are three areas where permissions have to be managed. TFS itself, SharePoint Services, and SQL Server Reporting Services. As far as I can tell, SQL Server Reporting Services appear to be the least secure of the three. When a user is assigned a Role Assignment it is not in relation to any particular Team Project.

There are also four distinct role types that we have to consider when thinking about permissions (summarized below):

  • TFS administrators are those users who create Team Projects
  • TFS project administrators are those users who manage Team Projects
  • Everyone else is either a Contributor or a Reader
The approach that I have taken (obviously working in conjunction with an Active Directory Administrator), is to define two Active Directory domain groups called TFSAdministrators and TFSProjectAdministrators. TFSAdministrators is added to the SharePoint Administration Group (or the Farm Administration Group in SharePoint 2007). It is also added as a System Administrator for the site-wide security settings in SQL Server Reporting Services. Basically any user added to this group will then have the appropriate permissions to create Team Project Portals and Reports in both SharePoint and SQL Server Reporting Services.

The second group (TFSProjectAdministrators), gives Team Project Administrators the Content Manager Role Assignment within SQL Server Reporting Services. Finally, to support the Contributor and the Reader roles, we define a new Browser Role Assignment within SQL Sever Reporting Services for the Domain Users group (i.e., the group to which everyone on the Domain in a member).

The combination of these two Active Directory groups and their permissions within SharePoint and SQL Server Reporting Services, effectively means that there is no longer a need to manually add users to the appropriate Role Assignment in SQL Server Reporting Services. Instead, a user can be added to their appropriate Active Directory group. Since permissions in SQL Server Reporting Services are not relative to a Team Project, this makes things much more intuitive going forward. In fact, it is now possible to forget about SQL Server Reporting Services altogether, and instead focus on adding users to the Team Foundation Server groups (i.e., Team Foundation Administrators or [project_name]\Project Administrators), and then adding the user to an appropriate group in the Team Project Portal.

I think that this provides a sensible and intuitive approach in managing user permissions within TFS. One change that I might consider is not adding the Domain Users group to the Browser Role Assignment in SQL Server Reporting Services, since this effectively gives every user in the Domain the ability to view all reports.
[ add comment ] [ 0 trackbacks ] permalink
Introducing Partial Methods (that's right... methods) 

Since the early betas, and now with the final RTM release of Visual Studio 2008, developers have the opportunity to begin exploring some new language features. Perhaps the most talked about language feature is LINQ (Language INtegrated Query), that provides a ubiquitous way in which to query data sources right from within the language itself, whether it be memory resident objects, XML, or relational data. There is however, one new language feature that has not been publicized that much: Partial Methods.

By now, most developers will have encountered partial classes and seen their benefits. They provide a means by which code-generation can be easily implemented and managed. Authored code and generated code can exist side-by-side in separate files, and the compiler will perform the task of stitching everything together during compilation. The Form designer provides a good example of this separation in action. Thinking beyond the Form designer however, it is safe to assume that many of the motivations for partial classes was driven by Microsoft's Software Factory thinking. Code that is generated by a DSL for example, can be easily interwoven with code provided by the developer using the DSL. There is no longer the need to mark areas of a source-file as protected from the code-generator, as was often the case in the past. The value gained from partial classes is clear, but not immediately obvious for partial methods.

Partial methods are made up of a method-declaration using the partial keyword, and an optional method-body. The method can accept parameters, including parameters modified with the ref, this, or params keyword. Methods must also be private and must return void, and more significantly, they can only be declared within a partial class. The following example demonstrates a partial method declaration (in bold).
Read More...
[ add comment ] [ 0 trackbacks ] permalink
T4 Template Editor for Visual Studio 2005/8 

Clarius have released a new T4 Templating Transformation Toolkit that provides a better experience when working with T4 templates. Although T4 templates are predominately used for Guidance Automation and DSL work, with the T4 components being included out of the box in Visual Studio 2008, it is likely that more and more developers will begin using them for their own code-generation work. Well worth taking a look.
[ add comment ] [ 0 trackbacks ] permalink

Back Next