Add assembly registration for VroomJs. Throw exception if error occurs while initialising on a supported environment (Linux or Mac)

Author: Daniel15

src/React.JavaScriptEngine.VroomJs/AssemblyRegistration.cs

@@ -0,0 +1,35 @@
+/*
+ *  Copyright (c) 2014, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the BSD-style license found in the
+ *  LICENSE file in the root directory of this source tree. An additional grant 
+ *  of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+using React.TinyIoC;
+
+namespace React.JavaScriptEngine.VroomJs
+{
+	/// <summary>
+	/// Handles registration of VroomJS for ReactJS.NET.
+	/// </summary>
+	public class AssemblyRegistration : IAssemblyRegistration
+	{
+		/// <summary>
+		/// Registers components in the React IoC container
+		/// </summary>
+		/// <param name="container">Container to register components in</param>
+		public void Register(TinyIoCContainer container)
+		{
+			// Only supported on Linux or Mac
+			if (!VroomJsUtils.IsEnvironmentSupported())
+			{
+				return;
+			}
+
+			JavaScriptEngineFactory.AddFactoryWithPriority(() => new VroomJsEngine(), priority: 10);
+			VroomJsUtils.EnsureEngineFunctional();
+		}
+	}
+}

src/React.JavaScriptEngine.VroomJs/React.JavaScriptEngine.VroomJs.csproj

@@ -8,7 +8,7 @@
     <OutputType>Library</OutputType>
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>React.JavaScriptEngine.VroomJs</RootNamespace>
-    <AssemblyName>React.JavaScriptEngine.VroomJs.original</AssemblyName>
+    <AssemblyName>React.JavaScriptEngine.VroomJs</AssemblyName>
     <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
   </PropertyGroup>
@@ -20,7 +20,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
-    <DocumentationFile>..\..\bin\Debug\React.JavaScriptEngine.VroomJs\React.JavaScriptEngine.VroomJs.original.xml</DocumentationFile>
+    <DocumentationFile>..\..\bin\Debug\React.JavaScriptEngine.VroomJs\React.JavaScriptEngine.VroomJs.xml</DocumentationFile>
     <NoWarn>1607</NoWarn>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
@@ -30,7 +30,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
-    <DocumentationFile>..\..\bin\Release\React.JavaScriptEngine.VroomJs\React.JavaScriptEngine.VroomJs.original.xml</DocumentationFile>
+    <DocumentationFile>..\..\bin\Release\React.JavaScriptEngine.VroomJs\React.JavaScriptEngine.VroomJs.xml</DocumentationFile>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <NoWarn>1607</NoWarn>
   </PropertyGroup>
@@ -62,8 +62,11 @@
     <Compile Include="..\SharedAssemblyVersionInfo.cs">
       <Link>Properties\SharedAssemblyVersionInfo.cs</Link>
     </Compile>
+    <Compile Include="AssemblyRegistration.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="VroomJsEngine.cs" />
+    <Compile Include="VroomJsInitialisationException.cs" />
+    <Compile Include="VroomJsUtils.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />

src/React.JavaScriptEngine.VroomJs/VroomJsInitialisationException.cs

@@ -0,0 +1,47 @@
+/*
+ *  Copyright (c) 2014, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the BSD-style license found in the
+ *  LICENSE file in the root directory of this source tree. An additional grant 
+ *  of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+using System;
+using System.Runtime.Serialization;
+using React.Exceptions;
+
+namespace React.JavaScriptEngine.VroomJs
+{
+	/// <summary>
+	/// Thrown when the JavaScript engine does not support JSX transformation
+	/// </summary>
+	[Serializable]
+	public class VroomJsInitialisationException : ReactException
+	{
+		/// <summary>
+		/// Initializes a new instance of the <see cref="VroomJsInitialisationException"/> class.
+		/// </summary>
+		public VroomJsInitialisationException(string innerMessage) : 
+			base(GetMessage(innerMessage)) { }
+
+		/// <summary>
+		/// Used by deserialization
+		/// </summary>
+		protected VroomJsInitialisationException(SerializationInfo info, StreamingContext context)
+			: base(info, context) { }
+
+		/// <summary>
+		/// Gets a message that describes the current exception.
+		/// </summary>
+		private static string GetMessage(string innerMessage)
+		{
+			return
+				"Failed to initialise VroomJs. This is most likely caused by the native library " +
+				"(libvroomjs.so) being out of date or your system lacking a compatible version of " +
+				"V8. Please run Mono with the `MONO_LOG_LEVEL=debug` environment variable for " +
+				"more debugging information. \n\n " +
+				"More details: " + innerMessage;
+		}
+	}
+}

src/React.JavaScriptEngine.VroomJs/VroomJsUtils.cs

@@ -0,0 +1,54 @@
+/*
+ *  Copyright (c) 2014, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the BSD-style license found in the
+ *  LICENSE file in the root directory of this source tree. An additional grant 
+ *  of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+using System;
+using React.Exceptions;
+
+namespace React.JavaScriptEngine.VroomJs
+{
+	/// <summary>
+	/// Utility methods for VroomJs JavaScript engine
+	/// </summary>
+	public static class VroomJsUtils
+	{
+		/// <summary>
+		/// Determines if the current environment supports the VroomJs engine
+		/// </summary>
+		/// <returns></returns>
+		public static bool IsEnvironmentSupported()
+		{
+			return Environment.OSVersion.Platform == PlatformID.Unix;
+		}
+
+		/// <summary>
+		/// If the user is explicitly referencing this assembly, they probably want to use it.
+		/// Attempt to use the engine and throw an exception if it doesn't work.
+		/// </summary>
+		public static void EnsureEngineFunctional()
+		{
+			int result = 0;
+			try
+			{
+				using (var engine = new VroomJsEngine())
+				{
+					result = engine.Evaluate<int>("1 + 1");
+				}
+			}
+			catch (Exception ex)
+			{
+				throw new VroomJsInitialisationException(ex.Message);
+			}
+
+			if (result != 2)
+			{
+				throw new ReactException("Mathematics is broken. 1 + 1 = " + result);
+			}
+		}
+	}
+}

src/React.Sample.Mvc4/React.Sample.Mvc4.csproj

@@ -136,6 +136,10 @@
     <Content Include="Views\Web.config" />
   </ItemGroup>
   <ItemGroup>
+    <ProjectReference Include="..\React.JavaScriptEngine.VroomJs\React.JavaScriptEngine.VroomJs.csproj">
+      <Project>{b4a5902a-70e2-4fa4-817d-dcc78d31e9b9}</Project>
+      <Name>React.JavaScriptEngine.VroomJs</Name>
+    </ProjectReference>
     <ProjectReference Include="..\React.Web.Mvc4\React.Web.Mvc4.csproj">
       <Project>{662d52ac-1ee9-4372-bd74-379f9ac56451}</Project>
       <Name>React.Web.Mvc4</Name>