Merge pull request #3 from undergroundwires/releasing-1.7

Released 1.7

Author: undergroundwires

src/AsyncWindowsClipboard.Tests/WindowsClipboardServiceTests.cs

@@ -18,6 +18,7 @@ public async Task Can_set_and_get_text()
             var actual = await sut.GetTextAsync();
             Assert.That(actual, Is.EqualTo(expected));
         }
+
         [Test]
         public void Ctor_SetsTheTimeoutProperty()
         {
@@ -26,4 +27,4 @@ public void Ctor_SetsTheTimeoutProperty()
             Assert.That(span, Is.EqualTo(sut.Timeout));
         }
     }
-}
+}

src/AsyncWindowsClipboard.Tests/WindowsClipboardSessionTests.cs

@@ -8,6 +8,7 @@ namespace AsyncWindowsClipboard.Tests
     [TestFixture]
     public class WindowsClipboardSessionTests
     {
+        private static IWindowsClipboardSession GetSut() => new WindowsClipboardSession();
 
         [Test]
         public void IsOpen_InstanceClosed_ReturnsFalse()
@@ -21,56 +22,54 @@ public void IsOpen_InstanceClosed_ReturnsFalse()
         }
 
         [Test]
-        public void IsOpen_InstanceOpened_ReturnsTrue()
+        public void IsOpen_InstanceClosed_ReturnsTrue()
         {
             // Arrange
             var sut = GetSut();
-            // Act
             sut.Open();
+            // Act
+            sut.Close();
             var actual = sut.IsOpen;
             // Assert
-            Assert.True(actual);
+            Assert.False(actual);
         }
 
         [Test]
-        public void IsOpen_InstanceClosed_ReturnsTrue()
+        public void IsOpen_InstanceOpened_ReturnsTrue()
         {
             // Arrange
             var sut = GetSut();
-            sut.Open();
             // Act
-            sut.Close();
+            sut.Open();
             var actual = sut.IsOpen;
             // Assert
-            Assert.False(actual);
+            Assert.True(actual);
         }
 
         [Test]
-        public void IsSuccessful_InstanceOpened_ReturnsTrue()
+        public void IsSuccessful_InstanceClosed_ReturnsTrue()
         {
             // Arrange
             var sut = GetSut();
             sut.Open();
             // Act
-            var openResult = sut.Open();
-            var actual = openResult.IsSuccessful;
+            var closeResult = sut.Close();
+            var actual = closeResult.IsSuccessful;
             // Assert
             Assert.True(actual);
         }
 
         [Test]
-        public void IsSuccessful_InstanceClosed_ReturnsTrue()
+        public void IsSuccessful_InstanceOpened_ReturnsTrue()
         {
             // Arrange
             var sut = GetSut();
             sut.Open();
             // Act
-            var closeResult = sut.Close();
-            var actual = closeResult.IsSuccessful;
+            var openResult = sut.Open();
+            var actual = openResult.IsSuccessful;
             // Assert
             Assert.True(actual);
         }
-
-        private static IWindowsClipboardSession GetSut() => new WindowsClipboardSession();
     }
 }

src/AsyncWindowsClipboard.WpfTests/App.config

@@ -1,6 +1,7 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
+
 <configuration>
-    <startup> 
-        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
-    </startup>
+  <startup>
+    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
+  </startup>
 </configuration>

src/AsyncWindowsClipboard.WpfTests/App.xaml

@@ -4,6 +4,6 @@
              xmlns:local="clr-namespace:AsyncWindowsClipboard.WpfTests"
              StartupUri="MainWindow.xaml">
     <Application.Resources>
-         
+
     </Application.Resources>
-</Application>
+</Application>

src/AsyncWindowsClipboard.WpfTests/App.xaml.cs

@@ -4,13 +4,13 @@
 namespace AsyncWindowsClipboard.WpfTests
 {
     /// <summary>
-    /// Interaction logic for App.xaml
+    ///     Interaction logic for App.xaml
     /// </summary>
     public partial class App : Application
     {
         public App()
         {
-            var bitmap = new WindowsClipboardService(timeout:TimeSpan.FromMilliseconds(100));
+            var bitmap = new WindowsClipboardService(timeout: TimeSpan.FromMilliseconds(100));
         }
     }
-}
+}

src/AsyncWindowsClipboard.WpfTests/MainWindow.xaml.cs

@@ -8,7 +8,8 @@ namespace AsyncWindowsClipboard.WpfTests
     /// </summary>
     public partial class MainWindow : Window
     {
-        private readonly IAsyncClipboardService _asyncClipboardService = new WindowsClipboardService(timeout:TimeSpan.FromMilliseconds(100));
+        private readonly IAsyncClipboardService _asyncClipboardService =
+            new WindowsClipboardService(timeout: TimeSpan.FromMilliseconds(100));
 
         public MainWindow()
         {
@@ -32,10 +33,7 @@ private async void ButtonPasteText_Click(object sender, RoutedEventArgs e)
         private async void ButtonDropFileListPaste_Click(object sender, RoutedEventArgs e)
         {
             var files = await _asyncClipboardService.GetFileDropListAsync();
-            if (files != null)
-            {
-                TextBoxText.Text = string.Join(System.Environment.NewLine, files);
-            }
+            if (files != null) TextBoxText.Text = string.Join(Environment.NewLine, files);
         }
 
         private async void ButtonDropFileListCopy_Click(object sender, RoutedEventArgs e)

src/AsyncWindowsClipboard/AsyncWindowsClipboard.csproj

@@ -1,44 +1,47 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net45;</TargetFrameworks>
-    <PackageId>AsyncWindowsClipboard</PackageId>
     <LangVersion>latest</LangVersion>
     <OutputType>Library</OutputType>
+    <AssemblyTitle>AsyncWindowsClipboard</AssemblyTitle>
+    <AssemblyName>AsyncWindowsClipboard</AssemblyName>
   </PropertyGroup>
   <ItemGroup>
     <None Include="..\..\LICENSE" Link="LICENSE" Pack="true" PackagePath="" />
     <Content Include="..\..\README.md" Link="README.md" Pack="true" PackagePath="" />
     <None Include="..\..\icon.png" Pack="true" PackagePath="\" />
   </ItemGroup>
-  <ItemGroup Condition="'$(TargetFramework)' == 'netstandard1.6'">
-    <PackageReference Include="System.Threading.Thread">
-      <Version>4.3.0</Version>
-    </PackageReference>
-  </ItemGroup>
   <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
     <Optimize>true</Optimize>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>Thread-safe, asynchronous windows clipboard service with timeout strategy for .NET, C#.</Description>
+    <PackageTags>asynchronous async clipboard timeout WPF windows forms</PackageTags>
     <Copyright>Copyright 2016 - 2019</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <AssemblyTitle>AsyncWindowsClipboard</AssemblyTitle>
+    <PackageId>AsyncClipboardService</PackageId>
     <Authors>undergroundwires</Authors>
-    <AssemblyName>AsyncWindowsClipboard</AssemblyName>
     <PackageProjectUrl>https://github.com/undergroundwires/AsyncWindowsClipboard</PackageProjectUrl>
-    <PackageLicenseUrl>https://raw.githubusercontent.com/undergroundwires/AsyncWindowsClipboard/master/LICENSE</PackageLicenseUrl>
     <RepositoryType>git</RepositoryType>
     <RepositoryUrl>https://github.com/undergroundwires/AsyncWindowsClipboard</RepositoryUrl>
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>AsyncWindowsClipboard</RootNamespace>
     <AssemblyName>AsyncClipboardService</AssemblyName>
-    <Version>1.6.0</Version>
+    <Version>1.7.0</Version>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
-
     <PackageReleaseNotes>
-      - Included documentation file
-      - Added support for net45, net451, net46, net462, net47, net471, net472
+      - Changed license to MIT.
+      - More documentation and typo fixes.
+      - Better exception messages for OS errors and fixed swollen exception.
+      - Changed locking logic to support all types of applications (not Window only).
+      - Namespace changes in internal classes.
+      - Support for .netstandard2.0
     </PackageReleaseNotes>
-    <PackageIconUrl>https://raw.githubusercontent.com/undergroundwires/AsyncWindowsClipboard/master/icon.png</PackageIconUrl>
+    <PackageIcon>icon.png</PackageIcon>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <!-- including PDB files in NuGet for source link because symbolsource.org does not support portable PDBs -->
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
 </Project>

src/AsyncWindowsClipboard/Clipboard/ClipboardDataType.cs

@@ -7,9 +7,9 @@ namespace AsyncWindowsClipboard.Clipboard
     /// </summary>
     /// <remarks>
     ///     The clipboard formats defined by the system are called standard clipboard formats.
-    ///     See more at : https://msdn.microsoft.com/en-us/library/windows/desktop/ff729168%28v=vs.85%29.aspx?f=255&MSPPError=-2147217396
+    ///     See more at : https://kutt.it/EGdSiY
     /// </remarks>
-    /// <seealso cref="NativeMethods"/>
+    /// <seealso cref="NativeMethods" />
     internal enum ClipboardDataType : uint
     {
         /// <summary>

src/AsyncWindowsClipboard/Clipboard/ClipboardOperationResultCode.cs

@@ -1,26 +1,43 @@
 namespace AsyncWindowsClipboard.Clipboard
 {
+    /// <summary>
+    ///     Result of the Clipboard operation
+    /// </summary>
     public enum ClipboardOperationResultCode
     {
         /// <summary>
-        /// Clipboard operations was successful
+        ///     Clipboard operations was successful
         /// </summary>
         Success = 0,
+
         /// <summary>
-        /// Clipboard operation failed due to an error during opening clipboard.
+        ///     Clipboard operation failed due to an error during opening clipboard.
         /// </summary>
         ErrorOpenClipboard,
+
         /// <summary>
-        /// Clipboard operation failed due to an error during closing clipboard.
+        ///     Clipboard operation failed due to an error during closing clipboard.
         /// </summary>
         ErrorCloseClipboard,
+
         /// <summary>
-        /// Clipboard operation failed due to an error during clearing clipboard.
+        ///     Clipboard operation failed due to an error during clearing clipboard.
         /// </summary>
         ErrorClearClipboard,
 
+        /// <summary>
+        ///     Clipboard operation when allocating native bytes for the clipboard.
+        /// </summary>
         ErrorGlobalAlloc,
+
+        /// <summary>
+        ///     Clipboard operation when communicating native bytes with the clipboard.
+        /// </summary>
         ErrorGlobalLock,
+
+        /// <summary>
+        ///     Clipboard operation when communicating wit the clipboard.
+        /// </summary>
         ErrorSetClipboardData
-    };
-}
+    }
+}

src/AsyncWindowsClipboard/Clipboard/Connection/ClipboardOpenerWithTimeout.cs

@@ -9,12 +9,15 @@ internal sealed class ClipboardOpenerWithTimeout : IClipboardOpenerWithTimeout
     {
         public const int DefaultDelayMilliseconds = 30;
 
-        /// <exception cref="T:System.ArgumentNullException"><paramref name="session"/> is <see langword="null"/></exception>
+        /// <exception cref="T:System.ArgumentNullException"><paramref name="session" /> is <see langword="null" /></exception>
         /// <exception cref="T:System.ArgumentOutOfRangeException">
-        /// <p><paramref name="timeout" /> is too short. It must be higher than 30.</p>
+        ///     <p><paramref name="timeout" /> is too short. It must be higher than 30.</p>
         ///     <p><paramref name="delayMilliseconds" /> is too short. It must be higher than 15.</p>
         /// </exception>
-        /// <exception cref="T:System.ArgumentException"><paramref name="timeout" /> must is lower than <paramref name="delayMilliseconds" /></exception>
+        /// <exception cref="T:System.ArgumentException">
+        ///     <paramref name="timeout" /> must is lower than
+        ///     <paramref name="delayMilliseconds" />
+        /// </exception>
         public IClipboardOperationResult Open(IWindowsClipboardSession session, TimeSpan timeout,
             int delayMilliseconds = DefaultDelayMilliseconds)
         {
@@ -33,7 +36,8 @@ public IClipboardOperationResult Open(IWindowsClipboardSession session, TimeSpan
             return result ? ClipboardOperationResult.SuccessResult : GetErrorResult(errorCodes, counter);
         }
 
-        private static bool TryOpenSession(IWindowsClipboardSession session, ICollection<uint> errorCodes, ref int counter)
+        private static bool TryOpenSession(IWindowsClipboardSession session, ICollection<uint> errorCodes,
+            ref int counter)
         {
             counter++;
             var result = session.Open();
@@ -50,23 +54,25 @@ private static ClipboardOperationResult GetErrorResult(IEnumerable<uint> errorCo
             if (errors.Any())
                 return GetResultForMultipleErrors(errors, counter);
             return new ClipboardOperationResult(
-                resultCode: ClipboardOperationResultCode.ErrorOpenClipboard, 
+                resultCode: ClipboardOperationResultCode.ErrorOpenClipboard,
                 message: $"Clipboard could not be opened after {counter} tries");
         }
 
         private static ClipboardOperationResult GetResultForSingleError(uint error, int counter)
         {
             return new ClipboardOperationResult(
                 resultCode: ClipboardOperationResultCode.ErrorOpenClipboard,
-                message: $"Clipboard has been tried to be reached {counter} times and all of them returned {error} error code.",
+                message:
+                $"Clipboard has been tried to be reached {counter} times and all of them returned {error} error code.",
                 errorCode: error);
         }
 
         private static ClipboardOperationResult GetResultForMultipleErrors(IEnumerable<uint> errorList, int counter)
         {
             return new ClipboardOperationResult(
                 resultCode: ClipboardOperationResultCode.ErrorOpenClipboard,
-                message: $"Clipboard has been tried to be reached {counter} times and returned {errorList.Count()} unique errors.");
+                message:
+                $"Clipboard has been tried to be reached {counter} times and returned {errorList.Count()} unique errors.");
         }
     }
 }