Add ability to add scripts based on wildcard patterns. Closes #60

Author: Daniel15

src/React.Core/FileSystemBase.cs

@@ -7,7 +7,9 @@
  *  of patent rights can be found in the PATENTS file in the same directory.
  */
 
+using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Text;
 
 namespace React
@@ -17,19 +19,35 @@ namespace React
 	/// </summary>
 	abstract public class FileSystemBase : IFileSystem
 	{
+		/// <summary>
+		/// Prefix for relative paths
+		/// </summary>
+		public const string RELATIVE_PREFIX = "~/";
+
 		/// <summary>
 		/// Converts a path from an application relative path (~/...) to a full filesystem path
 		/// </summary>
 		/// <param name="relativePath">App-relative path of the file</param>
 		/// <returns>Full path of the file</returns>
 		public abstract string MapPath(string relativePath);
 
+		/// <summary>
+		/// Converts a path from a full filesystem path to anan application relative path (~/...)
+		/// </summary>
+		/// <param name="absolutePath">Full path of the file</param>
+		/// <returns>App-relative path of the file</returns>
+		public virtual string ToRelativePath(string absolutePath)
+		{
+			var root = MapPath(RELATIVE_PREFIX);
+			return absolutePath.Replace(root, RELATIVE_PREFIX).Replace('\\', '/');
+		}
+
 		/// <summary>
 		/// Reads the contents of a file as a string.
 		/// </summary>
 		/// <param name="relativePath">App-relative path of the file</param>
 		/// <returns>Contents of the file</returns>
-		public string ReadAsString(string relativePath)
+		public virtual string ReadAsString(string relativePath)
 		{
 			return File.ReadAllText(MapPath(relativePath), Encoding.UTF8);
 		}
@@ -39,7 +57,7 @@ public string ReadAsString(string relativePath)
 		/// </summary>
 		/// <param name="relativePath">App-relative path of the file</param>
 		/// <param name="contents">Contents of the file</param>
-		public void WriteAsString(string relativePath, string contents)
+		public virtual void WriteAsString(string relativePath, string contents)
 		{
 			File.WriteAllText(MapPath(relativePath), contents, Encoding.UTF8);
 		}
@@ -49,9 +67,21 @@ public void WriteAsString(string relativePath, string contents)
 		/// </summary>
 		/// <param name="relativePath">App-relative path of the file</param>
 		/// <returns><c>true</c> if the file exists</returns>
-		public bool FileExists(string relativePath)
+		public virtual bool FileExists(string relativePath)
 		{
 			return File.Exists(MapPath(relativePath));
 		}
+
+		/// <summary>
+		/// Gets all the file paths that match the specified pattern
+		/// </summary>
+		/// <param name="glob">Pattern to search for (eg. "~/Scripts/*.js")</param>
+		/// <returns>File paths that match the pattern</returns>
+		public virtual IEnumerable<string> Glob(string glob)
+		{
+			var path = MapPath(Path.GetDirectoryName(glob));
+			var searchPattern = Path.GetFileName(glob);
+			return Directory.EnumerateFiles(path, searchPattern).Select(ToRelativePath);
+		}
 	}
 }

src/React.Core/FileSystemExtensions.cs

@@ -0,0 +1,30 @@
+/*
+ *  Copyright (c) 2014-2015, 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.IO;
+
+namespace React
+{
+	/// <summary>
+	/// Extension methods relating to file system paths.
+	/// </summary>
+	public static class FileSystemExtensions
+	{
+		/// <summary>
+		/// Determines if the specified string is a glob pattern that can be used with 
+		/// <see cref="Directory.GetFiles(string, string)"/>.
+		/// </summary>
+		/// <param name="input">String</param>
+		/// <returns><c>true</c> if the specified string is a glob pattern</returns>
+		public static bool IsGlobPattern(this string input)
+		{
+			return input.Contains("*") || input.Contains("?");
+		}
+	}
+}

src/React.Core/IFileSystem.cs

@@ -7,6 +7,8 @@
  *  of patent rights can be found in the PATENTS file in the same directory.
  */
 
+using System.Collections.Generic;
+
 namespace React
 {
 	/// <summary>
@@ -21,6 +23,13 @@ public interface IFileSystem
 		/// <returns>Full path of the file</returns>
 		string MapPath(string relativePath);
 
+		/// <summary>
+		/// Converts a path from a full filesystem path to anan application relative path (~/...)
+		/// </summary>
+		/// <param name="absolutePath">Full path of the file</param>
+		/// <returns>App-relative path of the file</returns>
+		string ToRelativePath(string absolutePath);
+
 		/// <summary>
 		/// Reads the contents of a file as a string.
 		/// </summary>
@@ -41,5 +50,12 @@ public interface IFileSystem
 		/// <param name="relativePath">App-relative path of the file</param>
 		/// <returns><c>true</c> if the file exists</returns>
 		bool FileExists(string relativePath);
+
+		/// <summary>
+		/// Gets all the files that match the specified pattern
+		/// </summary>
+		/// <param name="glob">Pattern to search for (eg. "~/Scripts/*.js")</param>
+		/// <returns>File names that match the pattern</returns>
+		IEnumerable<string> Glob(string glob);
 	}
 }

src/React.Core/IReactSiteConfiguration.cs

@@ -46,13 +46,13 @@ public interface IReactSiteConfiguration
 		/// Gets a list of all the scripts that have been added to this configuration and require JSX
 		/// transformation to be run.
 		/// </summary>
-		IList<string> Scripts { get; }
+		IEnumerable<string> Scripts { get; }
 
 		/// <summary>
 		/// Gets a list of all the scripts that have been added to this configuration and do not 
 		/// require JSX transformation to be run.
 		/// </summary>
-		IList<string> ScriptsWithoutTransform { get; } 
+		IEnumerable<string> ScriptsWithoutTransform { get; } 
 
 		/// <summary>
 		/// A value indicating if es6 syntax should be rewritten.

src/React.Core/React.Core.csproj

@@ -90,6 +90,7 @@
     </Compile>
     <Compile Include="AssemblyRegistration.cs" />
     <Compile Include="Exceptions\ReactNotInitialisedException.cs" />
+    <Compile Include="FileSystemExtensions.cs" />
     <Compile Include="JavaScriptEngineUtils.cs" />
     <Compile Include="VroomJsEngine.cs" />
     <Compile Include="Exceptions\ClearScriptV8InitialisationException.cs" />

src/React.Core/ReactSiteConfiguration.cs

@@ -10,6 +10,7 @@
 using Newtonsoft.Json;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.Linq;
 
 namespace React
 {
@@ -83,21 +84,43 @@ public IReactSiteConfiguration AddScriptWithoutTransform(string filename)
 			return this;
 		}
 
+		/// <summary>
+		/// Gets all the file paths that match the specified pattern. If the pattern is a plain
+		/// path, just returns that path verbatim.
+		/// </summary>
+		/// <param name="glob">
+		/// Patterns to search for (eg. <c>~/Scripts/*.js</c> or <c>~/Scripts/Awesome.js</c>
+		/// </param>
+		/// <returns>File paths that match this pattern</returns>
+		private IEnumerable<string> Glob(string glob)
+		{
+			if (!glob.IsGlobPattern())
+			{
+				return new[] {glob};
+			}
+			// Directly touching the IoC container is not ideal, but we only want to pull the FileSystem
+			// dependency if it's absolutely necessary.
+			var fileSystem = AssemblyRegistration.Container.Resolve<IFileSystem>();
+			return fileSystem.Glob(glob);
+		}
+
 		/// <summary>
 		/// Gets a list of all the scripts that have been added to this configuration and require JSX
 		/// transformation to be run.
 		/// </summary>
-		public IList<string> Scripts
+		public IEnumerable<string> Scripts
 		{
-			get { return new ReadOnlyCollection<string>(_scriptFiles); }
+			// TODO: It's a bit strange to do the globbing here, ideally this class should just be a simple
+			// bag of settings with no logic.
+			get { return _scriptFiles.SelectMany(Glob); }
 		}
 
 		/// <summary>
 		/// Gets a list of all the scripts that have been added to this configuration.
 		/// </summary>
-		public IList<string> ScriptsWithoutTransform
+		public IEnumerable<string> ScriptsWithoutTransform
 		{
-			get { return new ReadOnlyCollection<string>(_scriptFilesWithoutTransform); }
+			get { return _scriptFilesWithoutTransform.SelectMany(Glob); }
 		}
 
 		/// <summary>

src/React.Sample.Cassette/React.Sample.Cassette.csproj

@@ -44,6 +44,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <NoWarn>1607</NoWarn>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="AjaxMin, Version=4.84.4790.14405, Culture=neutral, PublicKeyToken=21ef50ce11b5d80f, processorArchitecture=MSIL">

src/React.Tests/Core/FileSystemBaseTests.cs

@@ -0,0 +1,33 @@
+/*
+ *  Copyright (c) 2014-2015, 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 NUnit.Framework;
+
+namespace React.Tests.Core
+{
+	[TestFixture]
+	public class FileSystemBaseTests
+	{
+		[TestCase("~/Test.txt", "C:\\Test.txt")]
+		[TestCase("~/Scripts/lol.js", "C:\\Scripts\\lol.js")]
+		public void ToRelativePath(string expected, string input)
+		{
+			var fileSystem = new TestFileSystem();
+			Assert.AreEqual(expected, fileSystem.ToRelativePath(input));
+		}
+
+		private class TestFileSystem : FileSystemBase
+		{
+			public override string MapPath(string relativePath)
+			{
+				return "C:\\" + relativePath.Replace("~/", string.Empty);
+			}
+		}
+	}
+}

src/React.Tests/Core/FileSystemExtensionsTest.cs

@@ -0,0 +1,28 @@
+/*
+ *  Copyright (c) 2014-2015, 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 NUnit.Framework;
+
+namespace React.Tests.Core
+{
+	[TestFixture]
+	public class FileSystemExtensionsTests
+	{
+		[TestCase("*.txt", true)]
+		[TestCase("foo?.js", true)]
+		[TestCase("first\\second\\third\\*.js", true)]
+		[TestCase("lol.js", false)]
+		[TestCase("", false)]
+		[TestCase("hello\\world.js", false)]
+		public void IsGlobPattern(string input, bool expected)
+		{
+			Assert.AreEqual(expected, input.IsGlobPattern());
+		}
+	}
+}

src/React.Tests/React.Tests.csproj

@@ -96,6 +96,8 @@
       <Link>Properties\SharedAssemblyVersionInfo.cs</Link>
     </Compile>
     <Compile Include="Core\FileCacheHashTests.cs" />
+    <Compile Include="Core\FileSystemBaseTests.cs" />
+    <Compile Include="Core\FileSystemExtensionsTest.cs" />
     <Compile Include="Core\JavaScriptEngineFactoryTest.cs" />
     <Compile Include="Core\JavaScriptEngineUtilsTests.cs" />
     <Compile Include="Core\JsxTransformerTests.cs" />