Improved documentation on FileReader

arthur-here · Oct 12, 2015 · b059a7d · b059a7d
1 parent 6ed5eae
commit b059a7d
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 2 deletions.
diff --git a/TextEditor/FileManager/ASCIIFileReader.cs b/TextEditor/FileManager/ASCIIFileReader.cs
@@ -21,6 +21,10 @@ public ASCIIFileReader(string fileName)
         {
         }
 
+        /// <summary>
+        /// Reads data from file.
+        /// </summary>
+        /// <returns>Array of read strings.</returns>
         public override string[] Read()
         {
             return File.ReadAllLines(this.FileName, Encoding.ASCII);

diff --git a/TextEditor/FileManager/TextEditorFileManager.cs b/TextEditor/FileManager/TextEditorFileManager.cs
@@ -51,6 +51,10 @@ public TextEditorDocument OpenFileUsingEncoding(string fileName, Encoding encodi
             {
                 fileReader = new UTF8FileReader(fileName);
             }
+            else if (encoding == Encoding.Unicode)
+            {
+                fileReader = new UnicodeFileReader(fileName);
+            }
             else
             {
                 fileReader = new DefaultFileReader(fileName);

diff --git a/TextEditor/FileManager/UTF8FileReader.cs b/TextEditor/FileManager/UTF8FileReader.cs
@@ -9,15 +9,23 @@
 namespace TextEditor.FileManager
 {
     /// <summary>
-    /// Provides agorythm to reading UTF-8 encoded file
+    /// Provides algorithm to reading UTF-8 encoded file.
     /// </summary>
     public class UTF8FileReader : FileReaderStrategy
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="UTF8FileReader"/> class.
+        /// </summary>
+        /// <param name="fileName">Path to read file.</param>
         public UTF8FileReader(string fileName)
             : base(fileName)
         {
         }
 
+        /// <summary>
+        /// Reads data from file.
+        /// </summary>
+        /// <returns>Array of read strings.</returns>
         public override string[] Read()
         {
             return File.ReadAllLines(this.FileName, Encoding.UTF8);

diff --git a/TextEditor/FileManager/UnicodeFileReader.cs b/TextEditor/FileManager/UnicodeFileReader.cs
@@ -0,0 +1,33 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace TextEditor.FileManager
+{
+    /// <summary>
+    /// Provides algorithm to reading Unicode encoded file.
+    /// </summary>
+    public class UnicodeFileReader : FileReaderStrategy
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="UnicodeFileReader"/> class.
+        /// </summary>
+        /// <param name="fileName">Path to read file.</param>
+        public UnicodeFileReader(string fileName) 
+            : base(fileName)
+        {
+        }
+
+        /// <summary>
+        /// Reads data from file.
+        /// </summary>
+        /// <returns>Array of read strings.</returns>
+        public override string[] Read()
+        {
+            return File.ReadAllLines(this.FileName, Encoding.Unicode);
+        }
+    }
+}
diff --git a/TextEditor/MainWindow.xaml b/TextEditor/MainWindow.xaml
@@ -50,8 +50,9 @@
                     </MenuItem.Header>
                     <MenuItem Header="Encoding" Background="#FF2A2F3A" HorizontalAlignment="Left" Width="145">
                         <MenuItem Header="Auto" Background="#FF2A2F3A" HorizontalAlignment="Left" Width="145"  Click="EncodingMenuItem_Click"/>
-                        <MenuItem Header="UTF8" Background="#FF2A2F3A" HorizontalAlignment="Left" Width="145"  Click="EncodingMenuItem_Click"/>
                         <MenuItem Header="ASCII" Background="#FF2A2F3A" HorizontalAlignment="Left" Width="145"  Click="EncodingMenuItem_Click"/>
+                        <MenuItem Header="Unicode" Background="#FF2A2F3A" HorizontalAlignment="Left" Width="145"  Click="EncodingMenuItem_Click"/>
+                        <MenuItem Header="UTF8" Background="#FF2A2F3A" HorizontalAlignment="Left" Width="145"  Click="EncodingMenuItem_Click"/>
                     </MenuItem>
                 </MenuItem>
             </Menu>

diff --git a/TextEditor/MainWindow.xaml.cs b/TextEditor/MainWindow.xaml.cs
@@ -102,6 +102,9 @@ private void EncodingMenuItem_Click(object sender, RoutedEventArgs e)
                 case "ASCII":
                     encoding = Encoding.ASCII;
                     break;
+                case "Unicode":
+                    encoding = Encoding.Unicode;
+                    break;
                 default:
                     throw new ArgumentException("Unknown encoding");
             }

diff --git a/TextEditor/TextEditor.csproj b/TextEditor/TextEditor.csproj
@@ -97,6 +97,7 @@
       <ExcludeFromStyleCop>True</ExcludeFromStyleCop>
     </Compile>
     <Compile Include="FileManager\DefaultFileReader.cs" />
+    <Compile Include="FileManager\UnicodeFileReader.cs" />
     <Compile Include="FileManager\UTF8FileReader.cs">
       <ExcludeFromStyleCop>True</ExcludeFromStyleCop>
     </Compile>

diff --git a/TextEditorTests/FileManagerTests.cs b/TextEditorTests/FileManagerTests.cs
@@ -38,6 +38,12 @@ public void TextEditorFileManager_OpenFileUsingEncoding()
         {
             this.document = this.fileManager.OpenFileUsingEncoding(@"Resources\DocumentExample.txt", Encoding.Default);
             Assert.IsNotNull(this.document, "FileManager couldn't open document");
+            this.document = this.fileManager.OpenFileUsingEncoding(@"Resources\DocumentExample.txt", Encoding.ASCII);
+            Assert.IsNotNull(this.document, "FileManager couldn't open document");
+            this.document = this.fileManager.OpenFileUsingEncoding(@"Resources\DocumentExample.txt", Encoding.Unicode);
+            Assert.IsNotNull(this.document, "FileManager couldn't open document");
+            this.document = this.fileManager.OpenFileUsingEncoding(@"Resources\DocumentExample.txt", Encoding.UTF8);
+            Assert.IsNotNull(this.document, "FileManager couldn't open document");
         }
 
         [TestMethod]