Merged the latest work on testing and improvement into the master development channel

Author: craigfowler

Parser/AssemblyInfo.cs

@@ -17,7 +17,7 @@
 // The form "{Major}.{Minor}.*" will automatically update the build and revision,
 // and "{Major}.{Minor}.{Build}.*" will update just the revision.
 
-[assembly: AssemblyVersion("0.0.1.0")]
+[assembly: AssemblyVersion("0.1.0.0")]
 
 // The following attributes are used to specify the signing key for the assembly, 
 // if desired. See the Mono documentation for more information about signing.

ZptViewEngine/ZptView.cs renamed to Parser/Mvc/ZptView.cs

@@ -2,7 +2,7 @@
 using System.Web.Mvc;
 using System.IO;
 
-namespace CraigFowler.Web.ZPT
+namespace CraigFowler.Web.ZPT.Mvc
 {
   /// <summary>
   /// <para>Represents an <see cref="IView"/> that represents a ZPT page.</para>
@@ -43,7 +43,7 @@ protected ZptViewEngine Engine  {
     /// </param>
     public void Render (ViewContext viewContext, TextWriter writer)
     {
-      ZptDocument document = this.Engine.GetZptDocument(this.RelativeViewPath);
+      IZptDocument document = this.Engine.GetZptDocument(this.RelativeViewPath);
       ITemplateDocument template = document.GetTemplateDocument();
 
       template.TalesContext.AddDefinition("documents", this.Engine.GetViewCache());

ZptViewEngine/ZptViewEngine.cs renamed to Parser/Mvc/ZptViewEngine.cs

@@ -4,7 +4,7 @@
 using System.IO;
 using CraigFowler.Web.ZPT.Tales;
 
-namespace CraigFowler.Web.ZPT
+namespace CraigFowler.Web.ZPT.Mvc
 {
   /// <summary>
   /// <para>Provides an MVC2 <see cref="IViewEngine"/> implementation for serving ZPT pages.</para>
@@ -41,12 +41,12 @@ public string ViewRoot
     /// <returns>
     /// A <see cref="ZptDocument"/>
     /// </returns>
-    public ZptDocument GetZptDocument(string path)
+    public IZptDocument GetZptDocument(string path)
     {
-      ZptDocument output;
+      IZptDocument output;
       ZptDocumentCollection viewCache = GetViewCache();
 
-      output = viewCache.RetrieveItem(ReformatPath(path)) as ZptDocument;
+      output = viewCache.RetrieveItem(ReformatPath(path)) as IZptDocument;
 
       if(output == null)
       {

Parser/Parser.csproj

@@ -8,7 +8,7 @@
     <ProjectGuid>{B887669F-17F7-45E9-BE79-A87570BFFA80}</ProjectGuid>
     <OutputType>Library</OutputType>
     <RootNamespace>CraigFowler.Web.ZPT</RootNamespace>
-    <AssemblyName>parser</AssemblyName>
+    <AssemblyName>zpt-parser</AssemblyName>
     <TargetFrameworkVersion>v2.0</TargetFrameworkVersion>
     <newfilesearch>OnLoadAutoInsert</newfilesearch>
   </PropertyGroup>
@@ -37,6 +37,8 @@
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="System.Xml" />
+    <Reference Include="System.Web" />
+    <Reference Include="System.Web.Mvc, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" />
   </ItemGroup>
   <ItemGroup>
     <Compile Include="AssemblyInfo.cs" />
@@ -81,6 +83,8 @@
     <Compile Include="ZptDocumentCollection.cs" />
     <Compile Include="Metal\IMetalDocument.cs" />
     <Compile Include="Metal\MetalMacroCollection.cs" />
+    <Compile Include="Mvc\ZptView.cs" />
+    <Compile Include="Mvc\ZptViewEngine.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
   <ItemGroup>
@@ -91,6 +95,7 @@
     <Folder Include="Tal\Exceptions\" />
     <Folder Include="Metal\" />
     <Folder Include="Metal\Exceptions\" />
+    <Folder Include="Mvc\" />
   </ItemGroup>
   <ProjectExtensions>
     <MonoDevelop>

Parser/ZptDocument.cs

@@ -108,13 +108,15 @@ private MetalMacroCollection MacroCache {
 		/// <returns>
 		/// An object instance that implements <see cref="ITemplateDocument"/>.
 		/// </returns>
-		public virtual ITemplateDocument GetTemplateDocument()
+		public ITemplateDocument GetTemplateDocument()
 		{
 			if(this.UnderlyingDocument == null)
 			{
 				this.UnderlyingDocument = this.Metadata.LoadDocument();
 			}
-			
+      
+      this.AssignModelData(this.UnderlyingDocument.TalesContext);
+      
 			return this.UnderlyingDocument;
 		}
 
@@ -147,6 +149,32 @@ public MetalMacroCollection GetMacros()
 
       return this.MacroCache;
     }
+    
+    /// <summary>
+    /// <para>
+    /// Helper method to perform assignments of data (perhaps from a domain model of some kind) to the root
+    /// <see cref="TalesContext"/> of the ZPT document that is to be rendered by this view.
+    /// </para>
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// This method does nothing on its own, it serves as a hook that implementing classes may override in order to
+    /// provide data to the TALES context of the view that will be rendering.
+    /// </para>
+    /// <para>
+    /// In a derived class, data may be added to the <paramref name="talesContext"/> using the
+    /// <see cref="TalesContext.AddDefinition(string,object)"/> method.  These definitions are added at the root level
+    /// of the TALES context of the document.  This data to be added may be taken from a domain model of some kind or
+    /// from a session state or any other source.
+    /// </para>
+    /// </remarks>
+    /// <param name="talesContext">
+    /// A <see cref="TalesContext"/>
+    /// </param>
+    protected virtual void AssignModelData(TalesContext talesContext)
+    {
+      // Intentionally do nothing here.  It is up to implementing classes to add code to overrides of this method.
+    }
 
 		#endregion
 

Parser/ZptMetadata.cs

@@ -70,6 +70,7 @@ public class ZptMetadata
 		#region fields
 
 		private Type documentClass;
+    private static Type defaultDocumentClass;
 
 		#endregion
 
@@ -95,21 +96,28 @@ public ZptDocumentType DocumentType
 		public Type DocumentClass
 		{
 			get {
-				return documentClass;
+        Type output = documentClass;
+        
+        if(output == null)
+        {
+          output = DefaultDocumentClass;
+        }
+        
+				return output;
 			}
 			set {
+        /* If we are passed a null reference then fall back to the default type.
+         * If we are passed a concrete type then try using that (if it implements the required interface)
+         * Otherwise throw an exception.
+         */
 				if(value == null)
 				{
-					throw new ArgumentNullException("value");
-				}
-				
-				bool implementsIZptDocument = ImplementsRequiredInterface(value);
-				
-				// If we found a type that implements IZptDocument then we use it, otherwise throw an exception
-				if(implementsIZptDocument)
-				{
-					documentClass = value;
+					documentClass = DefaultDocumentClass;
 				}
+        else if(ImplementsRequiredInterface(value))
+        {
+          documentClass = value;
+        }
 				else
 				{
 					throw new ArgumentOutOfRangeException("value",
@@ -161,6 +169,35 @@ public string DocumentFilePath
 			get;
 			set;
 		}
+    
+    /// <summary>
+    /// <para>Gets and sets a default value for <see cref="DocumentClass"/>.</para>
+    /// </summary>
+    public static Type DefaultDocumentClass
+    {
+      get {
+        return defaultDocumentClass;
+      }
+      set {
+        /* If we are passed a null reference then throw an exception (this property may not be null).
+         * If we are passed a concrete type then try using that (if it implements the required interface)
+         * Otherwise throw an exception.
+         */
+        if(value == null)
+        {
+          throw new ArgumentNullException("value");
+        }
+        else if(ImplementsRequiredInterface(value))
+        {
+          defaultDocumentClass = value;
+        }
+        else
+        {
+          throw new ArgumentOutOfRangeException("value",
+                                                "The type passed to this property does not implement IZptDocument.");
+        }
+      }
+    }
 
 		/// <summary>
 		/// <para>
@@ -303,8 +340,8 @@ private void WriteToXml(TextWriter writer)
 		public ZptMetadata()
 		{
 			this.DocumentType = ZptDocumentType.Metal;
-			this.DocumentClass = typeof(ZptDocument);
 			this.DocumentFilePath = null;
+      this.DocumentClass = null;
 		}
 
 		/// <summary>
@@ -313,6 +350,7 @@ public ZptMetadata()
 		static ZptMetadata()
 		{
 			ForeignDocumentClasses = new Dictionary<string, Type>();
+      DefaultDocumentClass = typeof(ZptDocument);
 		}
 
 		#endregion
@@ -491,6 +529,41 @@ public static void RegisterDocumentClass(Type typeToRegister)
 
       ForeignDocumentClasses.Add(typeToRegister.FullName, typeToRegister);
 		}
+    
+    /// <summary>
+    /// <para>
+    /// Registers all of the compatible types within an <see cref="Assembly"/> using
+    /// <see cref="RegisterDocumentClass"/>.
+    /// </para>
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// This method is a shortcut to separately calling <see cref="RegisterDocumentClass"/> on each type within an
+    /// <see cref="Assembly"/>.  Instead this method scans the assembly for every compatible type and registers them.
+    /// </para>
+    /// </remarks>
+    /// <param name="fromAssembly">
+    /// A <see cref="Assembly"/>
+    /// </param>
+    public static void RegisterDocumentClasses(Assembly fromAssembly)
+    {
+      Type[] allTypes;
+      
+      if(fromAssembly == null)
+      {
+        throw new ArgumentNullException("fromAssembly");
+      }
+      
+      allTypes = fromAssembly.GetExportedTypes();
+      
+      foreach(Type type in allTypes)
+      {
+        if(ImplementsRequiredInterface(type))
+        {
+          RegisterDocumentClass(type);
+        }
+      }
+    }
 
 		/// <summary>
 		/// <para>

SampleMvcSite/Content/Member.cs

@@ -1,7 +1,7 @@
 using System;
 using CraigFowler.Web.ZPT.Tales;
 
-namespace SampleMvcSite.Content
+namespace CraigFowler.Samples.Mvc.Content
 {
   /// <summary>
   /// <para>Stub class for testing a member-like object.</para>

SampleMvcSite/Controllers/HomeController.cs

@@ -4,9 +4,9 @@
 using System.Web;
 using System.Web.Mvc;
 using System.Web.Mvc.Ajax;
-using SampleMvcSite.Content;
+using CraigFowler.Samples.Mvc.Content;
 
-namespace Controllers
+namespace CraigFowler.Samples.Mvc.Controllers
 {
   [HandleError]
   public class HomeController : Controller

SampleMvcSite/Controllers/TestController.cs

@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Web;
+using System.Web.Mvc;
+using System.Web.Mvc.Ajax;
+namespace CraigFowler.Samples.Mvc.Controllers
+{
+  public class TestController : Controller
+  {
+    public ActionResult Index()
+    {
+      return View("test-page");
+    }
+  }
+}
+

SampleMvcSite/Global.asax

@@ -1 +1 @@
-<%@ Application Inherits="SampleMvcSite.MvcApplication" %>
+<%@ Application Inherits="CraigFowler.Samples.Mvc.MvcApplication" %>