Daniel Glyde

TDD with ASP.NET MVC 3, Moq and Dependency Injection

2011-07-12T14:29:00.000-07:00

Introduction

Purpose
The purpose of this article is to explain what TDD is and give an example in terms of the process.

So what does TDD stand for, well according to Wikipedia it is Test Driven Development but having read around the subject looking at blogs from Brad Wilson it should really be Test Driven Design, or as his want Design By Example but this doesn't fit in the acronym. I'll stick with Test Driven Design.

Approach
Instead of writing the controller and repository first instead I will create the test and use Visual Studio 2010 to automatically generate the classes, methods and properties as dictated by the test.

Patterns
So what about patterns? Well in this example I will use the Dependency Injection, Repository, Mock Object Design and MVC patterns.

Project

A simple repository call that returns a list of blog entries with URLs built from the title field.

Toolset

To use Moq for the Mock Object Framework

Version: 4.0.10827

Mock objects are faked objects that imitate the activities of real objects in a controlled manner.

To mock an interface to the data access component while testing the business logic. This avoids writing code until you are ready to do so.

Moq takes advantage of recent VB.NET and C# language features such as lambdas and generics. When creating mock objects with Moq, you use lambda expressions to represent the methods and properties that you want to mock.

Download instructions

Download Moq from: http://code.google.com/p/moq/downloads/list
Ensure you unblock the zip file once you have downloaded it.
For this example I am using .NET 4 so I will need to use the Moq DLL from:
\Moq.4.0.10827.Final\Moq.4.0.10827\NET40

NUnit

Version: 2.5.10.11092

NUnit is a unit testing framework for .NET. The units of code are tested to ascertain if they are fit for use.

Download instructions

Download NUnit from here: http://www.nunit.org/index.php?p=download
Use the .msi file.
Install with Typical and use the defaults.
Follow the installation guide here:
http://www.nunit.org/index.php?p=installation&r=2.5.10
C:\Program Files (x86)\NUnit 2.5.10\bin\net-2.0\nunit.exe.config
To add NUnit to Visual Studio tools menu in VS 2010

In Visual Studio have the test project highlighted before running NUnit from the Tool menu.

MVC for the Web Application Framework

Version: ASP.NET MVC 3.

The Model View Controller is a software architecture software pattern.

Coding
Ok, let's get our hands dirty.

Firstly I know that I want to use MVC for this project so we kick off with an empty MVC framework.

Create the MVC project
In Visual Studio 2010: New Project...

ASP.NET MVC 3 Web Application

TDDBlog

Empty

View engine: Razor

Create the test project
Create a new Class Library Project called TDDBlog.Tests

Right Click and Add a reference to TDDBlog from the Projects tab

Right click and Add a reference to nunit.framework from the .NET

Create a new folder structure \Library

Copy the Moq.dll to \Library\Moq

Right click and Add a reference to Moq.dll

Delete Class1.cs

Create a test for the controller
So we know that we are dealing with a Blog so I will want a BlogController. But before I go ahead and start building that up I will create the test first.

So in the TDDBlog.Tests

Create a new folder structure \Controllers

Add a new class: BlogControllerTest and make it public, as we are using NUnit we want to tell NUnit that the class we are using is testable, this requires us to reference the NUnit framework in our code and add the TestFixture attribute to the class:

using NUnit.Framework;

namespace TDDBlog.Tests.Controllers

{

[TestFixture]

public class BlogControllerTest

{

}

Let's check to see if it builds.

Ok, hopefully you had some joy there. So I want to return a list of blog entries and check the format of the URL.

As we are using MVC the test is a call on the Index Action:

Index returns a list of blog entries with correct Urls

[Test]

public void IndexReturnsAListOfBlogEntriesWithCorrectUrls()

{

}

You will notice the [Test] attribute on the method, this as you may have guessed tells NUnit that this is a test.

Hook up with NUnit
Now we have our empty test lets run it in NUnit.

Now we have NUnit set up in the Tools menu we can run it from there. Ensure you highlight the TDDBlog.Tests project.

If it does not load with the correct DLL, simply: File > Open Project and select the TDDBlog.Tests.dll.

Click Run to execute the test.

We will see a green light, this is the default behaviour; if no test content is present then the is nothing to fail.

Start building the test and let the compiler guide you
So our blog will have BlogEntry class objects, to set this up we will Mock a list of these.

A Mock defines the results from calls it does not set the content on objects. I like Moq as it uses Lambda expressions.

Create a Mock for BlogEntry:

var mockBlogEntry1 = new Mock(<BlogEntry>);

Add a reference to Moq in your code:

using Moq;

Build the project, it will fail with:

The type or namespace name 'BlogEntry' could not be found (are you missing a using directive or an assembly reference?)

So no surprise, we need to create this class.

Left click on BlogEntry in the test method. If you have reSharper installed you will get a red light bulb appear on the left allowing you to create a new class called BlogEntry Visual Studio 2010 has the same functionality. Hover over BlogEntry and a icon with a tool tip of, 'Options to help bind the selected item' appears; extend this and click on 'Generate new type...'.

This will allow you to specify the location and access:

Access: public
Kind: class
Location: TDDBlog
Create new file: Models\BlogEntry.cs

It will also add the reference to the file.

Next we want to set some fields on the new class again this do this from the test.

const int id1 = 1;

const string title1 = "My first blog Entry";

const string content1 = "I love blogging, it is so cool";

mockBlogEntry1.SetupGet(x => x.Id).Returns(id1);

mockBlogEntry1.SetupGet(x => x.Title).Returns(title1);

mockBlogEntry1.SetupGet(x => x.Content).Returns(content1);

So we know that this won't compile and from what we have learnt we can get our test to do some work for us. Click on Id, hover and 'Generate property stub for 'ID' in 'TDDBlog.Models.BlogEntry'.

So your BlogEntry class should look like:

namespace TDDBlog.Models

{

public class BlogEntry

{

public Id Id { get; set; }

public Title Title { get; set; }

public Content Content { get; set; }

}

Modify the class to use the correct types and add virtual (this is required for Moq):

namespace TDDBlog.Models

{

public class BlogEntry

{

public virtual int Id { get; set; }

public virtual string Title { get; set; }

public virtual string Content { get; set; }

}

Create a couple of other BlogEntries.

const int id2 = 2;

const string title2 = "I'm still in to this";

const string content2 = "I'm still enjoying my blogging";

var mockBlogEntry2 = new Mock(<BlogEntry>);

mockBlogEntry2.SetupGet(x => x.Id).Returns(id2);

mockBlogEntry2.SetupGet(x => x.Title).Returns(title2);

mockBlogEntry2.SetupGet(x => x.Content).Returns(content2);

const int id3 = 3;

const string title3 = "OK!";

const string content3 = "Ok, I'm done!";

var mockBlogEntry3 = new Mock(<BlogEntry>);

mockBlogEntry3.SetupGet(x => x.Id).Returns(id3);

mockBlogEntry3.SetupGet(x => x.Title).Returns(title3);

mockBlogEntry3.SetupGet(x => x.Content).Returns(content3);

SetupGet is used for Properties on a Class.

The next thing to do is to work out how we are going to store this, notice I say how not where. Let's say we are going to use a repository pattern. Mock an IBlogsRepository (again don't create it first).

var blogRepository = new Mock(<IBlogsRepository>);

Follow the same process as before:

Access: public
Kind: interface
Project: TDDBlog
Create new file: Models\IBlogsRepository

Ok, so we now have a new interface, lets Mock a call on it:

blogRepository

.Setup(p => p.GetAllBlogEntries())

.Returns(new List<BlogEntry> { newBlogEntry.Object });

You will need to add a reference to Systems.Collections.Generic.

Setup works in the same way as SetupGet but is for method calls not Properties on a Class.

Add the interface method for GetAllBlogEntries by clicking on the method and generating from the test: 'Generate method stub for 'GetAllBlogEntries' for 'TDDBlog.Models.IBlogsRepository'

The interface will look like:

namespace TDDBlog.Models

{

public interface IBlogsRepository

{

object GetAllBlogEntries();

}

Add the correct return type:

namespace TDDBlog.Models

{

public interface IBlogsRepository

{

IEnumerable<BlogEntry> GetAllBlogEntries();

}

So that is our repository set up and Mocked, and the objects inside it Mocked.

Test the Controller
We will inject the controller with the repository.

In the test we will initialise the controller - we will start with the test code before getting the test code to create the Controller:

BlogController blogController = new BlogController((IBlogsRepository)blogRepository.Object);

You know the steps by now:

Access: public
Kind: class
Project: TDDBlog
Create new file: Controllers\BlogController.cs

Next we need to create the constructor.

Again click and hover on the BlogController, and 'Generate constructor stub in 'TDDBlog.Controllers.BlogController'.

This generates:

namespace TDDBlog.Controllers

{

public class BlogController

{

private Models.IBlogsRepository iBlogsRepository;

public BlogController(Models.IBlogsRepository iBlogsRepository)

{

// TODO: Complete member initialization

this.iBlogsRepository = iBlogsRepository;

}

Inherit the BlogController from Controller and add a reference to System.Web.Mvc.

Next we need to call the controller method to get the result. We are going to assume that the Index call is going to be used:

ViewResult viewResult = blogController.Index() as ViewResult;

We need to ensure out test project knows what a ViewResult is, add System.Web.Mvc to the TDDBlog.Tests project.

Then get Visual Studio 2010 add the reference to the file by hover etc...

Create the Index method in the Controller by the usual method as described above.

public ViewResult Index()

{

throw new NotImplementedException();

}

Start testing
We want to get the URL for each blog entry but this will not be in the repository.

List<BlogEntry> blogEntries = (System.Collections.Generic.List)viewResult.ViewData.Model;

BlogEntry blogEntry1 = blogEntries[0];

Assert.AreEqual(id1, blogEntry1.Id);

Assert.AreEqual(title1, blogEntry1.Title);

const string url1 = "my-first-blog-entry";

Assert.AreEqual(url1, blogEntry1.Url);

Assert.AreEqual(content1, blogEntry1.Content);

BlogEntry blogEntry2 = blogEntries[1];

Assert.AreEqual(id2, blogEntry2.Id);

Assert.AreEqual(title2, blogEntry2.Title);

const string url2 = "I'm still in to this";

Assert.AreEqual(url2, blogEntry2.Url);

Assert.AreEqual(content2, blogEntry2.Content);

BlogEntry blogEntry3 = blogEntries[2];

Assert.AreEqual(id3, blogEntry3.Id);

Assert.AreEqual(title3, blogEntry3.Title);

const string url3 = "ok";

Assert.AreEqual(url3, blogEntry3.Url);

Assert.AreEqual(content3, blogEntry3.Content);

The Url property does not exist at this point in the BlogEntry, so add the property stub from the test, set the correct type:

public string Url { get; set; }

Notice this is not set to virtual as it is not going to be Mocked or used by the repository.

Right, that is the test code complete, so what happens when we run our test?

Expected failure
So we are seeing red! Let's look at the output window:

TDDBlog.Tests.Controllers.BlogControllerTest.IndexReturnsAListOfBlogEntriesWithCorrectUrls:

TDDBlog.Tests.Controllers.BlogControllerTest.IndexReturnsAListOfBlogEntriesWithCorrectUrls:

System.NotImplementedException : The method or operation is not implemented.

Not a big shock as we have not implemented the Index method on the controller yet.

Let's do this now:

public ViewResult Index()

{

return View(iBlogsRepository.GetAllBlogEntries());

}

Ok, run again. Hmm red again what now:

TDDBlog.Tests.Controllers.BlogControllerTest.IndexReturnsAListOfBlogEntriesWithCorrectUrls:

Expected: "my-first-blog-entry"

But was: null

Ok, that makes sense, we have not changed the controller to set the Url, this is a good test as before we were just returning what we put in the Mock framework.

So we need to change the controller:

public ViewResult Index()

{

IEnumerable<BlogEntry> blogEntries = iBlogsRepository.GetAllBlogEntries();

foreach (BlogEntry blogEntry in blogEntries)

{

blogEntry.Url = blogEntry.Title.

Replace("'", string.Empty).

Replace("!", string.Empty).

Replace(" ", "-").

ToLower();

}

return View(blogEntries);

}

The test now passes; woo and indeed hoo!

Summary
So, we created an MVC project designed by our tests. We only implemented what was required so there was no redundant code which is something that can happen when just cracking out the code.

As I used Moq, I did not have to configure or populate a database or some other repository.

By using Dependency Injection the code would be easily extendable to inject a repository to the Controller using a dependency injector like Ninject.

One gotcha that you may have come across is that if the BlogEntry Url property is set to virtual then the value will not be set in the controller.

I have uploaded the source code for TDD with ASP.NET MVC 3, Moq and Dependency Injection on githib, take a look and fork it.

Introduction to WCF

2011-03-05T13:39:00.000-08:00

This blog shows how to create a Visual Studio 2010 C# console application that hosts a Windows Communication Foundation (WCF) service exposing string manipulation methods.

The purpose of WCF is to simplify the communication of distributed applications on Windows. Because WCF uses RESTful communication and implements SOAP it can therefore operate with multiple platforms.

Creating the service

In Visual Studio 2010:
File > New > Console Application > Name: Service

Open the project’s properties and change the namespace to: Glyde.ServiceModel.Examples
Change the Program.cs namespace to use the Glyde.ServiceModel.Examples namespace.

Add System.ServiceModel.dll to the project.
Create a new public interface: IStringManipulator.cs, this will expose methods to add two strings together, replace part of a string and remove a substring.

Add a reference to System.ServiceModel in the interface.

Add a service contract to the interface:

[ServiceContract(Namespace = http://Glyde.ServiceModel.Examples)]

And add [OperationContract] to the exposed methods:

[OperationContract]
string Add(string s1, string s2);
[OperationContract]
string Delete(string s1, string s2);
[OperationContract]
string Replace(string s1, string s2, string s3);

Next we create a WCF service contract.

Create a StringManipulatorService class to implement the interface methods.

public string Add(string s1, string s2)
{
return s1 + s2;
}

public string Delete(string s1, string s2)
{
return s1.Replace(s2, string.Empty);
}

public string Replace(string s1, string s2, string s3)
{
return s1.Replace(s2, s3);
}

In the Program.cs create a URI object to serve as the base address – this will be used by the client to call the service:

Uri baseAddress = new Uri("http://localhost:8000/GlydeServiceModelExamples/Service");

Create a service host for the StringManipulatorService

ServiceHost selfHost = new ServiceHost(typeof(StringManipulatorService), baseAddress);

Add a service end point

selfHost.AddServiceEndpoint(
typeof(IStringManipulator),
new WSHttpBinding(),
"StringManipulatorService");

Enable the metadata exchange, for HTTP:

ServiceMetadataBehavior smb = new ServiceMetadataBehavior(); smb.HttpGetEnabled = true;
selfHost.Description.Behaviors.Add(smb);

Start the service
selfHost.Open();
Add a
Console.ReadLine();
…to keep the service running.
Call close to stop the service from running:
selfHost.Close();

Create a WCF client

Create a console application called Client, implement this in a separate application so the service and client can be run from a separate debug solutions – this will help your understanding and allow you to debug both.

Add System.ServiceModel.dll to the project and add the reference to Program.cs

How to use the service utility to create the client proxy

Switch back to the service solution and start the console application by F5

Start the Visual Studio command promptNavigate to the client projectRun the ServiceModel

Metadata Utility Tool to create the client code and configuration file (generated proxy):

svcutil.exe /language:cs /out:generatedProxy.cs /config:app.config http://localhost:8000/GlydeServiceModelExamples/Service

This will generate the files in the client project folder:
generatedProxy
app.config

Add these to the client project by using ‘Add existing item’.

Remember, if you modify or add new methods in the service, the client proxy will have to be recreated.

The app.config specifies the location of the service, the binding and contract interface.
Call the service via the proxy

Create an endpoint address and a WCF instance client in the Program.cs.

StringManipulatorClient client = new StringManipulatorClient();

By adding the app.config and generatedProxy.cs the StringManipulatorClient is automatically available in the project.

Don’t forget to add System.ServiceModel to the project and add a reference in the Program.cs file.

Make a call to the client:

string value1 = "Hello Hannah, ";
string value2 = "how are you today";
string result = client.Add(value1, value2);
Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result);

value1 = result;
value2 = "Hannah";
string value3 = "Emma";
result = client.Replace(value1, value2, value3);
Console.WriteLine("Replace({0},{1}) = {2}", value1, value2, result);

value1 = result;value2 = ", how are you today";
result = client.Delete(value1, value2);
Console.WriteLine("Delete({0},{1}) = {2}", value1, value2, result);

Close the client after use:

client.Close();

So that’s it, I hope I have wept your appetite to learn more about WCF – As ever I have uploaded my source to GitHub click here to get the source from my introduction to WCF.

Agile Software Development

2011-03-01T10:30:00.000-08:00

What does it mean to be Agile?

There are a number of strategies and working practices available for Agile software development, I have included the process that works for me; this is based on my real life experiences working with stakeholders (more about these in a moment), developers and testers.

Scrum

What is Scrum? During a project the customers can change their minds about what they want and need (also called churn) these challenges cannot be addressed in a planned manner. Scrum uses a pragmatic approach, in most instances these problems cannot be fully understood therefore a focus on capitalising on the team's ability to delivery quickly and respond to emerging requirements.

Daily Scrum

A stand up meeting called a Daily Scrum takes place at precisely the same time every day - 10 am is a good time as the team members have had the time to know what they are doing by this point. If your team is distributed then use a video conferencing tool (e.g. Skype).

There are three roles in a Daily Scrum:

On the officials in the 2007 Tech-Texas game in Austin:

"It's a little like breakfast; you eat ham and eggs. As coaches and players, we're like the ham. You see, the chicken's involved but the pig's committed. We're like the pig, they're like the chicken. They're involved, but everything we have rides on this."

Pigs

The developers and testers play the part of Pigs, they have no longer than one minute to describe what they did since the last Daily Scrum, what they are doing today and what blockers they think they may have to do today's tasks.

If anyone has an questions or comments they should take place outside of the Daily Scrum.

Chickens

The stakeholders (customers) play the role of chickens - they can listen but not speak. If they have any questions they should go through the Scrum Master outside of the Daily Scrum meeting.

Scrum Master

The senior member of the software team usual a Team Leader will take the role of Scrum Master, they ensure the Daily Scrum starts on time and that everyone takes turns to speak. The Scrum Master can also be a Pig.

Sprint

Sprints are a part of the Scrum methodology.

Sprint planning meeting

A sprint cycle lasts for two weeks.

Select the work to be done

User Stories

The Scrum Master meets with all the Stakeholders in a single meeting to gather the user stories.

In order to process the user stories quickly cards should be used to write a short sentence that describes the functionality in the form:

As a [role] I want [requirement] so that [business need].

The Stakeholder writes the card and passes it back to the Scrum Master, only one card is completed at a time after being discussed with the other Stakeholders.

The number of User Stories gathered in the Sprint Planning Meeting will vary depending on the size of the team for a small team of four developers, ten User Stories would be a fair number.

Each User Story will have a number of scenarios written on the back; these will form the tests.

Story Points and Planning Poker

After the User Stories are gathered the Software Developers and Testers go through each User Story and assign it a number of Story Points.

The highest number is the most complex and time consuming, the lowest is the simplest and shortest: 0,1,2,3,5,8,13,20,100. 100 alerts you to the fact that you have an Epic Story which should be split in to multiple stories.

A game of Planner Poker should be played, this can be done with Planning Poker cards or if your team are distributed - this can be done over an IM - The Scrum Master asks everyone to get their numbers ready and all hit Enter at the same time.

The Scrum Master records the Story Points against each User Story, no more than 5 minutes should be spent on each User Story.

Prioritisation

The User Stories with Story Points should be reported to the Stakeholders in person, they then order the cards by relative priority.

Tasks and durations

The Scrum Master asks each of the Developers if they have any holiday booked for the next two weeks, this is subtracted from the number of hours in the Sprint.

A Sprint is always two weeks long, due to outside forces, answering emails, meetings, urgent issues (real life) I allow for six hours per day on a Sprint. So if a Developer is in then they are available for sixty hours for the two weeks. I recommend using Pair Programming so this will be the hours shared between your developers (i.e. sixty hours for two Developers).

Get the Developers and Testers together, take each User Story ordered by highest priority first, split in to Tasks i.e. Analysis, Design, Database schema changes, Development, Testing, Deployment. Speak directly to the individuals most likely to implement the User Story (Developers and Testers should work on a single User Story rather than a single Task), ask them to say how long they think the Tasks will take. The other Developers and Testers can verify this.

Create a table in a spreadsheet with sixty at the top and subtract the hours for each User Story from the Developers available hours, eventually this will get to less than zero, all User Stories in positive numbers will be what the team can commit to.

The Scrum Master meets with the Stakeholders and provides them with the list of User Stories that can be committed to in the two week Sprint.

Story board

A Story board is created for each Sprint, User Stories have a state during the Sprint:

Backlog > In progress > Code ready for review > Code reviewed > QA Ready > [QA Passed][QA Failed] > Deployed

There is another state called Waste, this is used for any duplicate or erroneous User Stories.

The Developers are encouraged to move their User Story to the next Sprint, this should be viewable by the Stakeholders, web based story boards are available this is useful for distributed teams.

Sprint review meeting

Once the two week Sprint is completed, the Developers and Testers meet with the Stakeholders to review the work that was completed and not completed. A demonstration of the completed work is shown to the Stakeholders. There should be a four hour limit to this meeting.

Any User Stories not completed in the Sprint go in to the Sprint Backlog.

Velocity

The number of Story Points completed in the Sprint gets recorded against the User Story, this becomes the velocity of the team.

After three Sprints the velocity will start to even out and give the Stakeholders an idea of the amount of work that can be done in a Sprint.

Charts

There are two charts I have found useful, the first is a Daily Burndown Chart, this is where the number of hours the Developers spent on the Sprint each day is recorded against the number of available hours.

The second is the Release Burndown Chart, this shows the estimated number of Story Points in the Sprint against the actual Story Points completed, this chart can be extended to also include the velocity.

Sprint retrospective

This meeting is attended by the Developers and Testers, all team members reflect on the past Sprint, make continuous process improvements , what went well and what can be improved, there should be a three hour limit to this meeting.

Extreme Programming (XP)

There are a number of XP elements, the one I find most useful is Pair programming. Software developers sit at a single Development workstation they take it in turns to be at the keyboard - known as the Driver, as a Developer types they describe what they are doing to the Observer. The Observer reviews the code as it is being typed, therefore code reviews do not need to be done after a task is completed and the quality of the code is far superior than if done on their own.

One common issue is one of swapping, if this does not feel natural then switching every thirty minutes is a good compromise. Other benefits include a lack of fatigue, knowledge sharing, a boost in morale, not skipping unit tests. New Developers can pick up the workings of the team quickly and people are less likely to interrupt a pair of programmers.

Other distractions can be email, one solution to this is to have a separate PC that individuals can use to read their email.

Summary

By employing these Agile Software Development methods my team are able to work in a more efficient way, there is little or no context switching between tasks, the quality of work has improved and the implementation matches the requirements closely. The Stakeholders feel engaged with the development process and see results more frequently than through the waterfall model.

Introduction to Ruby on Rails

2011-01-16T09:45:00.000-08:00

Introduction

I am a .NET developer and have been programming ASP.NET in C# for a number of years, I have been hearing some pretty wonderful stuff about Ruby on Rails and wanted to see for myself. This post is about my discovery of this framework from the unknown to creating an ecommerce site from scratch.

Environment

IDE: NetBeans IDE 6.8

Ruby Platform: Build-in JRuby 1.4.0

Server: GlassFish v3 Domain

Database: MySQL

Application

The application is simple and one that followers of this blog will recognise. It is a simple eCommerce shop with the data structured in to Products, Categories and Basket.

The purpose is to show how quickly an application in Rails can be created and takes you through the steps to set this up.

Prerequisite

You will have loaded in the Ruby and Rails plugin for NetBeans

Create the Project

In the NetBean IDE select File > New Project

Give your project a name e.g. ‘RailsShop’

See the environment section above for other settings.

Unselect ‘Add Rake Targets to Support App Server Development’

Database Configuration: Specify Database Information Directly

Database adapter: mysql (jdbc)

Database name: RailsShop_development (it will also create ‘_test’; ‘_production’

User name: localhost

Password xxxxxx

Install rails: 2.3.4

Create and set up the database

Right click on the project in the Project window > Run/Debug Rake Task> db:create

Add the tables

Right click on the project > Generate

Generator: model

Arguments: category name:string

Arguments: product category_id: integer name:string price:decimal url:string

Arguments: basket product_id: count:integer

Note that the model is created in the Models folder – this does not define the fields in the model, these are specified in the Database migrations folder. The database will not be updated until the database migration has been called.

The convention is to use the foreign key to be the model_id.

Primary key ids are created automatically as are time stamps.

Define the association between the models

A basket has products, edit the \models\basket.rb to:

class Basket < ActiveRecord::Base
 belongs_to :product
end

and so on with the rest of the models

class Category < ActiveRecord::Base
 has_many :products
end

class Product < ActiveRecord::Base
 belongs_to :category
 has_many :baskets
end

Update the database

Right click on the project > Migrate Database > To Current Version

If you get an error like this:

The driver encountered an error: com.mysql.jdbc.exceptions.MySQLSyntaxErrorException: Unknown database 'railsshop_development'

rake aborted!

The db:create failed silently in which case you will need to create the database manually – I did this in mySQL Workbench – this is a known issue and is discussed in the Knowledge base.

You should be able to update the database to the current version.

If for any reason you need to reset the database to its empty state run:

Right click on the project > Migrate Database > To Version 0 - Clear

Adding sample data

Right click on lib\tasks

Create db_load_dev_data.rake (using Other\Empty file) – these isn’t support for the .rake extension by default.

namespace :db_load_dev_data do
 desc "This loads the development data."
 task :seed => :environment do
   require 'active_record/fixtures'
   Dir.glob(RAILS_ROOT + '/db/fixtures/*.yml').each do file
     base_name = File.basename(file, '.*')
     #say "Loading #{base_name}..."
     Fixtures.create_fixtures('db/fixtures', base_name)
   end
 end
 desc "This drops the db, builds the db, and seeds the data."
 task :reseed => [:environment, 'db:reset', 'db:seed']
end

The code reads the yml files and loads the data in the database:

Create a new fixtures folder under the \db\ folder and create a file for each table i.e. products.yml.

Note: in Files view \db\ equates to Database Migrations in the Projects view.

Right click on the project > Run/Debug Rake task… > [refresh tasks] > db_load_dev_data: seed

It is important to specify the id of using test data – this allows for the foreign keys to be specified otherwise the id will automatically generated.

Here is an example with two products:

Concorde Bikes PDM Team Replica Road Bike:

category_id: 1

name: "Concorde Bikes PDM Team Replica Road Bike"

price: 699.99

url: "concorde-bike-pdm-ind.jpg"

Kestrel Talon Tri 105 2010:

category_id: 1

name: "Kestrel Talon Tri 105 2010"

price: 147.99

url: "kestral-talon-tri-ind.jpg"

To remove the sample data right click on the application > Run/Debug Rake Task… > db_load_dev_data:reseed

Routes

To utilise shorthand like:

<%= link_to category.name, category%>

Ensure you have entries in the \Configuration\routes.rb:

map.resources :category
map.resources :product
map.resources :basket

MVC 2.0 with DB4O

2010-11-14T12:58:00.000-08:00

Object-Oriented Databases

The aim of this blog is to firstly give an introduction of what an object-oriented database is, showing how to install DB4O, any shortcomings and finally to give an example in a C# .NET 4 MVC 2 shopping cart project.

What is an Object-Oriented Database?

An object-oriented database is a database model (OODBMS), unlike relational database management systems which hold data in relational rows and columns the OODBMS holds information as objects in the same way as object-oriented programming.

OODBMS is useful when used with object-oriented programming as no translation needs to take place between objects in code and objects in a database, the same objects can be referenced in each.

Why choose OODBMS over RDBMS?

OODBMS are faster than RDBMS and can be programmed without making changes to the full system.

As navigation with OODBMS is done with pointers data access is done very efficiently.

On the negative, OODBMS are optimised for specific search routes and will tend to be slower for general-purpose queries than relational however direct object references may be maintained to allow for both types of access.

So what OODBMS should I choose?

This depends on the language you are programming in, I’m pro open source and the language I am writing for this example is in .Net I have selected the highly rated db4o: http://www.db4o.com/about/productinformation/db4o/

This o-o database has libraries for both Java and .NET, for a full list and comparison of OODBMS see this wiki link: http://en.wikipedia.org/wiki/Comparison_of_object_database_management_systems

Installation guide of db4o for .NET

Download the production release from the following location: http://developer.db4o.com/Downloads.aspx

The following steps are for db4o-7.12-net35.msi

Setup type: Typical
Accept the default installation location
Go though the defaults and click Finish to complete the installation

If you have more than one version of Visual Studio installed you get the choice of plugin to install.

‘To proceed with the installation of the Object Manager Enterprise plugin for VS please choose the appropriate shortcut from your db4objects Start menu’

The plugin does not work with Microsoft Visual Web Developer – you will need the fully blown version of the Visual Studio.

The tutorial automatically loads on completion of installation from here code examples can be obtained for processes such as opening databases to CRUD to LINQ and SODA queries.

The only DLL you need to build against is C:\Program Files\db4o\db4o-7.12\bin\net-3.5\ Db4objects.Db4o.dll.

Issues
Cache
Db40 has its own caching, the default is ‘CachingStorage’, db4o uses a LRU/Q2 caching strategy. http://developer.db4o.com/Documentation/Reference/db4o-8.0/net35/reference/index_Left.html#CSHID=configuration%2Ffile%2Fstorage%2Fisolated_storage.htmStartTopic=Content%2Fconfiguration%2Ffile%2Fstorage%2Fisolated_storage.htmSkinName=RedVersant

Load balancing
http://developer.db4o.com/Documentation/Reference/db4o-8.0/net35/reference/index_Left.html#CSHID=configuration%2Ffile%2Fstorage%2Fisolated_storage.htmStartTopic=Content%2Fconfiguration%2Ffile%2Fstorage%2Fisolated_storage.htmSkinName=RedVersant

Locking
http://www.gamlor.info/wordpress/?p=779

Serialized objects
As soon as objects are serialized the object-identity is lost, this is typical in web-scenarios or web-services, there are a number of different ids, one of which is “ID-Field On Classes With a ID-Generator”.

The project

I developed this MVC 2.0 project using Visual Studio 2010 Ultimate.

The source is available on GitHub.

It is assumed you have working knowledge of the MVC framework.

The only DLLs I referenced from my application are:

Db4objects.Db4o
Db4objects.Db4o.Linq

The second was included as I used Linq queries on the object database.

To keep this example simple I have not addressed the issues of load balancing and isolated storage.

I have created a new class in the Models folder: StoreDB4O

In the class I define the yap file – this is the file DB4O uses to store the database.

   1:  readonly static string StoreYapFileName = Path.Combine(

   2:    Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),

   3:    "store.yap");

...and obtain it using the following method:

   1:  private static IObjectContainer GetDB()

   2:  {

   3:    returnDb4oEmbedded.OpenFile(Db4oEmbedded.NewConfiguration(), StoreYapFileName);

   4:  }

In order to get test data in to the project I have created a method called LoadTestData(), this is called from Application_Start() in Global.asax and removes the content of the database:

   1:  File.Delete(StoreYapFileName);

And stores the sample data in Category and Product objects:

   1:  IObjectContainer db = GetDB();

   2:  try

   3:  {

   4:      Category category = new Category { CategoryId = 1, Name = "Bikes" };

   5:      StoreCategory(db, category);

…

   1:  private static void StoreCategory(IObjectContainer db, Category category)

   2:  {

   3:      db.Store(category);

   4:  }

There is nothing special about the objects that are stored in the database.

   1:  namespace MvcDB4O.Models

   2:  {

   3:      public class Category

   4:      {

   5:          public int CategoryId { get; set; }

   6:          public string Name { get; set; }

   7:      }

   8:  }

In addition to storing data in object I have implemented methods that return data using Linq queries as example of which returns a list of products by category name:

   1:  public static IEnumerable<Product> GetProductsByCategoryName(string name)

   2:          {

   3:              IObjectContainer db = GetDB();

4:

   5:              try

   6:              {

   7:                  return new List<Product>(from Product p in db

   8:                                            where p.Category.Name == name

   9:                                            orderby p.Name

  10:                                            select p).Distinct(new ProductByNameEquality());

11:

  12:              }

  13:              finally

  14:              {

  15:                  db.Close();

  16:              }

  17:          }

One important thing to mention is to always return a copy of the object from the database otherwise the connection of the database will be required to be open when accessing data from the objects.

Another gotcha is that when updating existing data, the same object will be required from the database within the same session i.e. In this example, the basket has the count decremented and the basket is then placed back in the object database, if this was done in two separate sessions with the database a second basket will be added to the database and the existing one will also exist.

   1:  public static IEnumerable<Product> GetProductsByCategoryName(string name)

   2:          {

   3:              IObjectContainer db = GetDB();

4:

   5:              try

   6:              {

   7:                  return new List<Product>(from Product p in db

   8:                                            where p.Category.Name == name

   9:                                            orderby p.Name

  10:                                            select p).Distinct(new ProductByNameEquality());

11:

  12:              }

  13:              finally

  14:              {

  15:                  db.Close();

  16:              }

  17:          }

The MVC structure here is nothing new, the Home\Index.aspx shows the categories and a link to the StoreController Browse method:

   1:          <% foreach (MvcDB4O.Models.Category category in Model.Categories)

   2:             { %>

   3:          <li>

   4:              <%: Html.ActionLink(category.Name, "Browse", "Store", new { category = category.Name }, null)%>

   5:          </li>

   6:          <% } %>

7:

   8:          public ActionResult Browse(string category)

   9:          {

  10:              // Retrieve Category and Products from database

  11:              var storeBrowseViewModel = new StoreBrowseViewModel()

  12:                  {

  13:                      Category = StoreDB4O.GetCategory(category),

  14:                      Products = StoreDB4O.GetProductsByCategoryName(category)

  15:                  };

  16:              return View(storeBrowseViewModel);

  17:          }

The View Model is populated and used in the Store\Browse.aspx page.

   1:      public class StoreBrowseViewModel

   2:      {

   3:          public Category Category { get; set; }

   4:          public IEnumerable<Product> Products { get; set; }

   5:      }

6:

   7:          <% foreach (MvcDB4O.Models.Product product in Model.Products)

   8:             { %>

   9:          <li>

  10:              <%: Html.ActionLink(product.Name, "Details", "Store", new { id = product.ProductId }, null)%>

  11:          </li>

  12:          <% } %>

I hope this has served to show how to connect to an object database in particular DB4O using MVC.

Please ask any questions you may have and I welcome your comments.

How to download, install, configure and upload content to GitHub

2010-10-19T13:49:00.000-07:00

Introduction

This post describes how to download, install, configure and upload content to GitHub.

What is GitHub?

Git is a distributed version control system. GitHub provides a way for sharing content in Git with other people

How do I get GitHub?

Sign up for a free account here: https://github.com/signup/free

Once you have your account, create a new repository: http://github.com/repositories/new

After setting up your account you will need to Download and Install Git on your PC.

msysgit is the Windows version, available here: http://code.google.com/p/msysgit/downloads/list?can=3

At the time of writing the latest version is: 1.7.3.1

Accept the defaults when installing

So how do I set it up?

Once Git is installed, run the application Git > Git GUI > Create New Repository > [enter a name] > Create

This will create a new folder in your Documents and Settings folder with the name of your repository

Copy or create your new project in the folder.

In Explorer, right click on the new top level folder > Git add all files now

Run the command prompt: Git > Git Bash

git config --global user.name "Your Name"
git config --global user.email "Your email address"

Next set up a SSH public key on your PC that links you to the repository:

http://help.github.com/msysgit-key-setup/

Change to the location of the new repository:
cd MvcDB4O

git init
ssh-keygen –t rsc –C "Your email address"

You will be prompted for a location for the key, hit enter for the default
Enter a passphrase

You will be told the location of the ssh public key

Create an SSH public key from the website: https://github.com/account > add another public key

Give it a title and the key you created in Git Bash

So how do I push my files to GitHub?

In Git Bash
Change to the directory of the repository

git remote add origin git@github.com:your-git-username/repository-name.git

git push origin master (you will be asked for your passphrase)

(ensure the .ssh folder exists in the repository you are uploading)

Switch to GitHub to view the uploaded files

Conclusion

Hopefully you have found this information useful - good luck with your Git friends.

Welcome

2010-07-30T13:50:00.000-07:00

Hello,

I hold the post of Project Technical Lead at Wiggle Limited.

I will be posting my thoughts, ideas and comments on technical and managerial solutions I come across on a day to day basis.

Please feel free to make any comments to my posts and I will get back to you as soon as possible.

Check out my linkedin and twitter accounts or contact me via email.