Add support for passing a filter to IFileSystemWatcherFactory.CreateNew (#585)

Fixes #577

BREAKING CHANGE: IFileSystemWatcherFactory.FromPath is removed. Use  IFileSystemWatcherFactory.CreateNew instead.

Author: nathanpovo

System.IO.Abstractions.TestingHelpers.Tests/MockFileSystemTests.cs

@@ -341,23 +341,43 @@ public void MockFileSystem_DefaultState_CurrentDirectoryExists(string currentDir
         }
 
         [Test]
-        public void MockFileSystem_FileSystemWatcher_ShouldBeAssignable()
+        public void MockFileSystem_FileSystemWatcher_PathShouldBeAssignable()
         {
             var path = XFS.Path(@"C:\root");
             var fileSystem = new MockFileSystem { FileSystemWatcher = new TestFileSystemWatcherFactory() };
-            var watcher = fileSystem.FileSystemWatcher.FromPath(path);
+            var watcher = fileSystem.FileSystemWatcher.CreateNew(path);
             Assert.AreEqual(path, watcher.Path);
         }
 
+        [Test]
+        public void MockFileSystem_FileSystemWatcher_PathAndFilterShouldBeAssignable()
+        {
+            var path = XFS.Path(@"C:\root");
+            var filter = "*.txt";
+            var fileSystem = new MockFileSystem { FileSystemWatcher = new TestFileSystemWatcherFactory() };
+            var watcher = fileSystem.FileSystemWatcher.CreateNew(path, filter);
+            Assert.AreEqual(path, watcher.Path);
+            Assert.AreEqual(filter, watcher.Filter);
+        }
+
         private class TestFileSystemWatcherFactory : IFileSystemWatcherFactory
         {
             public IFileSystemWatcher CreateNew() => new TestFileSystemWatcher(null);
+            public IFileSystemWatcher CreateNew(string path) => new TestFileSystemWatcher(path);
+            public IFileSystemWatcher CreateNew(string path, string filter) => new TestFileSystemWatcher(path, filter);
             public IFileSystemWatcher FromPath(string path) => new TestFileSystemWatcher(path);
         }
 
         private class TestFileSystemWatcher : FileSystemWatcherBase
         {
             public TestFileSystemWatcher(string path) => Path = path;
+
+            public TestFileSystemWatcher(string path, string filter)
+            {
+                Path = path;
+                Filter = filter;
+            }
+
             public override string Path { get; set; }
             public override bool IncludeSubdirectories { get; set; }
             public override bool EnableRaisingEvents { get; set; }

System.IO.Abstractions.TestingHelpers.Tests/MockFileSystemWatcherFactoryTests.cs

@@ -13,6 +13,23 @@ public void MockFileSystemWatcherFactory_CreateNew_ShouldThrowNotImplementedExce
             Assert.Throws<NotImplementedException>(() => factory.CreateNew());
         }
 
+        [Test]
+        public void MockFileSystemWatcherFactory_CreateNewWithPath_ShouldThrowNotImplementedException()
+        {
+            var path = XFS.Path(@"y:\test");
+            var factory = new MockFileSystemWatcherFactory();
+            Assert.Throws<NotImplementedException>(() => factory.CreateNew(path));
+        }
+
+        [Test]
+        public void MockFileSystemWatcherFactory_CreateNewWithPathAndFilter_ShouldThrowNotImplementedException()
+        {
+            var path = XFS.Path(@"y:\test");
+            var filter = "*.txt";
+            var factory = new MockFileSystemWatcherFactory();
+            Assert.Throws<NotImplementedException>(() => factory.CreateNew(path, filter));
+        }
+
         [Test]
         public void MockFileSystemWatcherFactory_FromPath_ShouldThrowNotImplementedException()
         {

System.IO.Abstractions.TestingHelpers/MockFileSystemWatcherFactory.cs

@@ -6,6 +6,12 @@ public class MockFileSystemWatcherFactory : IFileSystemWatcherFactory
         public IFileSystemWatcher CreateNew() =>
             throw new NotImplementedException(StringResources.Manager.GetString("FILE_SYSTEM_WATCHER_NOT_IMPLEMENTED_EXCEPTION"));
 
+        public IFileSystemWatcher CreateNew(string path) =>
+            throw new NotImplementedException(StringResources.Manager.GetString("FILE_SYSTEM_WATCHER_NOT_IMPLEMENTED_EXCEPTION"));
+
+        public IFileSystemWatcher CreateNew(string path, string filter) =>
+            throw new NotImplementedException(StringResources.Manager.GetString("FILE_SYSTEM_WATCHER_NOT_IMPLEMENTED_EXCEPTION"));
+
         public IFileSystemWatcher FromPath(string path) =>
             throw new NotImplementedException(StringResources.Manager.GetString("FILE_SYSTEM_WATCHER_NOT_IMPLEMENTED_EXCEPTION"));
     }

System.IO.Abstractions/FileSystemWatcherFactory.cs

@@ -1,9 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-
-namespace System.IO.Abstractions
+namespace System.IO.Abstractions
 {
     [Serializable]
     public class FileSystemWatcherFactory : IFileSystemWatcherFactory
@@ -13,9 +8,10 @@ public IFileSystemWatcher CreateNew()
             return new FileSystemWatcherWrapper();
         }
 
-        public IFileSystemWatcher FromPath(string path)
-        {
-            return new FileSystemWatcherWrapper(path);
-        }
+        public IFileSystemWatcher CreateNew(string path) =>
+            new FileSystemWatcherWrapper(path);
+
+        public IFileSystemWatcher CreateNew(string path, string filter)
+            => new FileSystemWatcherWrapper(path, filter);
     }
 }

System.IO.Abstractions/IFileSystemWatcherFactory.cs

@@ -1,9 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-
-namespace System.IO.Abstractions
+namespace System.IO.Abstractions
 {
     public interface IFileSystemWatcherFactory
     {
@@ -14,10 +9,18 @@ public interface IFileSystemWatcherFactory
         IFileSystemWatcher CreateNew();
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="FileSystemWatcherBase"/> class, which acts as a wrapper for a FileSystemWatcher
+        /// Initializes a new instance of the <see cref="FileSystemWatcherBase"/> class, given the specified directory to monitor, which acts as a wrapper for a FileSystemWatcher
+        /// </summary>
+        /// <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
+        /// <returns></returns>
+        IFileSystemWatcher CreateNew(string path);
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="FileSystemWatcherBase"/> class, given the specified directory and type of files to monitor, which acts as a wrapper for a FileSystemWatcher
         /// </summary>
-        /// <param name="path">Path to generate the FileSystemWatcherBase for</param>
+        /// <param name="path">The directory to monitor, in standard or Universal Naming Convention (UNC) notation.</param>
+        /// <param name="filter">The type of files to watch. For example, "*.txt" watches for changes to all text files.</param>
         /// <returns></returns>
-        IFileSystemWatcher FromPath(string path);
+        IFileSystemWatcher CreateNew(string path, string filter);
     }
 }

version.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "10.0",
+  "version": "11.0",
   "assemblyVersion": {
     "precision": "major"
   },