Merge pull request #30 from matteobortolazzo/code-analyzer

Adds code analyzers.

Author: matteobortolazzo

CHANGELOG.md

@@ -1,4 +1,15 @@
-# 1.0.1-beta.1 (2019-04-03)
+# 1.0.1-beta.3 (2019-04-03)
+
+## Breaking Changes
+* **_find:** from r.prop.FieldExists() to r.FieldExists("someprop").
+
+## Features
+* **CouchClient:** implements protected virtual void Dispose(bool disposing).
+
+## Improvements
+* **Global:** FxCop analizers add to the project.
+
+# 1.0.1-beta.2 (2019-04-03)
 
 ## Bug Fixes
 * **_find:** Guid support, and all other constants  ([#PR26](https://github.com/matteobortolazzo/couchdb-net/pull/26))

LATEST_CHANGE.md

@@ -1,2 +1,8 @@
-## Bug Fixes
-* **_find:** Guid support, and all other constants  ([#PR26](https://github.com/matteobortolazzo/couchdb-net/pull/26))
+## Breaking Changes
+* **_find:** from r.prop.FieldExists() to r.FieldExists("someprop").
+
+## Features
+* **CouchClient:** implements protected virtual void Dispose(bool disposing).
+
+## Improvements
+* **Global:** FxCop analizers add to the project.

README.md

@@ -151,7 +151,7 @@ If the Where method is not called in the expression, it will at an empty selecto
 | $ne            | !=                 |
 | $gte           | >=                 |
 | $gt            | >                  |
-| $exists        | o.FieldExists()    |
+| $exists        | o.FieldExists(s)   |
 | $type          | o.IsCouchType(...) |
 | $in            | o.In(list)         |
 | $nin           | !o.In(list)        |

src/CouchDB.Driver/CouchClient.cs

@@ -10,6 +10,8 @@
 using System.Threading.Tasks;
 using System.Linq;
 using CouchDB.Driver.Settings;
+using CouchDB.Driver.DTOs;
+using CouchDB.Driver.Exceptions;
 
 namespace CouchDB.Driver
 {
@@ -34,7 +36,9 @@ public partial class CouchClient : IDisposable
         public CouchClient(string connectionString, Action<CouchSettings> couchSettingsFunc = null, Action<ClientFlurlHttpSettings> flurlSettingsFunc = null)
         {
             if (string.IsNullOrEmpty(connectionString))
+            {
                 throw new ArgumentNullException(nameof(connectionString));
+            }
 
             _settings = new CouchSettings();
             couchSettingsFunc?.Invoke(_settings);
@@ -68,11 +72,13 @@ public CouchClient(string connectionString, Action<CouchSettings> couchSettingsF
         public CouchDatabase<TSource> GetDatabase<TSource>(string database) where TSource : CouchDocument
         {
             if (database == null)
+            {
                 throw new ArgumentNullException(nameof(database));
+            }
 
             if (_settings.CheckDatabaseExists)
             {
-                var dbs = AsyncContext.Run(() => GetDatabasesNamesAsync());
+                IEnumerable<string> dbs = AsyncContext.Run(() => GetDatabasesNamesAsync());
                 if (!dbs.Contains(database))
                 {
                     return AsyncContext.Run(() => CreateDatabaseAsync<TSource>(database));
@@ -94,28 +100,37 @@ public CouchDatabase<TSource> GetDatabase<TSource>(string database) where TSourc
         public async Task<CouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string database, int? shards = null, int? replicas = null) where TSource : CouchDocument
         {
             if (database == null)
+            {
                 throw new ArgumentNullException(nameof(database));
+            }
 
             if (!_systemDatabases.Contains(database) && !new Regex(@"^[a-z][a-z0-9_$()+/-]*$").IsMatch(database))
             {
-                throw new ArgumentException(nameof(database), $"Name {database} contains invalid characters. Please visit: https://docs.couchdb.org/en/stable/api/database/common.html#put--db");
+                throw new ArgumentException($"Name {database} contains invalid characters. Please visit: https://docs.couchdb.org/en/stable/api/database/common.html#put--db", nameof(database));
             }
 
-            var request = NewRequest()
+            IFlurlRequest request = NewRequest()
                 .AppendPathSegment(database);
 
             if (shards.HasValue)
             {
-                request.SetQueryParam("q", shards.Value);
+                request = request.SetQueryParam("q", shards.Value);
             }
             if (replicas.HasValue)
             {
-                request.SetQueryParam("n", replicas.Value);
+                request = request.SetQueryParam("n", replicas.Value);
             }
 
-            await request
+            OperationResult result = await request
                 .PutAsync(null)
-                .SendRequestAsync();
+                .ReceiveJson<OperationResult>()
+                .SendRequestAsync()
+                .ConfigureAwait(false);
+
+            if (!result.Ok)
+            {
+                throw new CouchException("Something went wrong during the creation");
+            }
 
             return new CouchDatabase<TSource>(_flurlClient, _settings, ConnectionString, database);
         }
@@ -129,12 +144,20 @@ await request
         public async Task DeleteDatabaseAsync<TSource>(string database) where TSource : CouchDocument
         {
             if (database == null)
+            {
                 throw new ArgumentNullException(nameof(database));
+            }
 
-            await NewRequest()
+            OperationResult result = await NewRequest()
                 .AppendPathSegment(database)
                 .DeleteAsync()
-                .SendRequestAsync();
+                .ReceiveJson<OperationResult>()
+                .SendRequestAsync()
+                .ConfigureAwait(false);
+
+            if (!result.Ok) {
+                throw new CouchException("Something went wrong during the delete.", "S");
+            }
         }
 
         #endregion
@@ -175,7 +198,7 @@ public Task DeleteDatabaseAsync<TSource>() where TSource : CouchDocument
         }
         private string GetClassName<TSource>()
         {
-            var type = typeof(TSource);
+            Type type = typeof(TSource);
             return type.GetName(_settings);
         }
 
@@ -216,13 +239,14 @@ public async Task<bool> IsUpAsync()
         {
             try
             {
-                await NewRequest()
+                StatusResult result = await NewRequest()
                     .AppendPathSegment("/_up")
-                    .GetAsync()
-                    .SendRequestAsync();
-                return true;
+                    .GetJsonAsync<StatusResult>()
+                    .SendRequestAsync()
+                    .ConfigureAwait(false);
+                return result.Status == "ok";
             }
-            catch
+            catch(CouchNotFoundException)
             {
                 return false;
             }
@@ -237,7 +261,8 @@ public async Task<IEnumerable<string>> GetDatabasesNamesAsync()
             return await NewRequest()
                 .AppendPathSegment("_all_dbs")
                 .GetJsonAsync<IEnumerable<string>>()
-                .SendRequestAsync();
+                .SendRequestAsync()
+                .ConfigureAwait(false);
         }
 
         /// <summary>
@@ -249,16 +274,17 @@ public async Task<IEnumerable<CouchActiveTask>> GetActiveTasksAsync()
             return await NewRequest()
                 .AppendPathSegment("_active_tasks")
                 .GetJsonAsync<IEnumerable<CouchActiveTask>>()
-                .SendRequestAsync();
+                .SendRequestAsync()
+                .ConfigureAwait(false);
         }
 
         #endregion
-        
+
         #endregion
-        
+
         #region Implementations
 
-            private IFlurlRequest NewRequest()
+        private IFlurlRequest NewRequest()
         {
             return _flurlClient.Request(ConnectionString);
         }
@@ -267,11 +293,22 @@ private IFlurlRequest NewRequest()
         /// Performs the logout and disposes the HTTP client.
         /// </summary>
         public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        protected virtual void Dispose(bool disposing)
         {
             AsyncContext.Run(() => LogoutAsync());
             _flurlClient.Dispose();
         }
 
+        ~CouchClient()
+        {
+            Dispose(false);
+        }
+
         #endregion
     }
 }

src/CouchDB.Driver/CouchClientAuthentication.cs

@@ -1,19 +1,22 @@
-using CouchDB.Driver.Settings;
+using CouchDB.Driver.DTOs;
+using CouchDB.Driver.Exceptions;
+using CouchDB.Driver.Settings;
 using Flurl.Http;
 using Nito.AsyncEx;
 using System;
 using System.Linq;
+using System.Net.Http;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 
 namespace CouchDB.Driver
 {
     public partial class CouchClient
     {
-        protected virtual void OnBeforeCall(HttpCall call)
+        protected virtual void OnBeforeCall(HttpCall httpCall)
         {
             // If session requests no authorization needed
-            if (call.Request.RequestUri.ToString().Contains("_session"))
+            if (httpCall.Request.RequestUri.ToString().Contains("_session"))
             {
                 return;
             }
@@ -22,7 +25,7 @@ protected virtual void OnBeforeCall(HttpCall call)
                 case AuthenticationType.None:
                     break;
                 case AuthenticationType.Basic:
-                    call.FlurlRequest.WithBasicAuth(_settings.Username, _settings.Password);
+                    httpCall.FlurlRequest.WithBasicAuth(_settings.Username, _settings.Password);
                     break;
                 case AuthenticationType.Cookie:
                     var isTokenExpired =
@@ -32,7 +35,7 @@ protected virtual void OnBeforeCall(HttpCall call)
                     {
                         AsyncContext.Run(() => LoginAsync());
                     }
-                    call.FlurlRequest.EnableCookies().WithCookie("AuthSession", _cookieToken);
+                    httpCall.FlurlRequest.EnableCookies().WithCookie("AuthSession", _cookieToken);
                     break;
                 default:
                     throw new NotSupportedException($"Authentication of type {_settings.AuthenticationType} is not supported.");
@@ -41,21 +44,22 @@ protected virtual void OnBeforeCall(HttpCall call)
 
         private async Task LoginAsync()
         {
-            var response = await _flurlClient.Request(ConnectionString)
+            HttpResponseMessage response = await _flurlClient.Request(ConnectionString)
                 .AppendPathSegment("_session")
                 .PostJsonAsync(new
                 {
                     name = _settings.Username,
                     password = _settings.Password
-                });
+                })
+                .ConfigureAwait(false);
 
             _cookieCreationDate = DateTime.Now;
 
             if (response.Headers.TryGetValues("Set-Cookie", out var values))
             {
                 var dirtyToken = values.First();
                 var regex = new Regex(@"^AuthSession=(.+); Version=1; .*Path=\/; HttpOnly$");
-                var match = regex.Match(dirtyToken);
+                Match match = regex.Match(dirtyToken);
                 if (match.Success)
                 {
                     _cookieToken = match.Groups[1].Value;
@@ -67,9 +71,16 @@ private async Task LoginAsync()
         }
         private async Task LogoutAsync()
         {
-            await _flurlClient.Request(ConnectionString)
+            OperationResult result = await _flurlClient.Request(ConnectionString)
                 .AppendPathSegment("_session")
-                .DeleteAsync();
+                .DeleteAsync()
+                .ReceiveJson<OperationResult>()
+                .ConfigureAwait(false);
+
+            if (!result.Ok)
+            {
+                throw new CouchDeleteException();
+            }
         }
     }
 }

src/CouchDB.Driver/CouchDB.Driver.csproj

@@ -6,7 +6,7 @@
     <Authors>Matteo Bortolazzo</Authors>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <Description>A .NET Standard driver for CouchDB.</Description>
-    <PackageProjectUrl>https://github.com/matteobortolazzo/couchdb-ne</PackageProjectUrl>
+    <PackageProjectUrl>https://github.com/matteobortolazzo/couchdb-net</PackageProjectUrl>
     <RepositoryUrl>https://github.com/matteobortolazzo/couchdb-ne</RepositoryUrl>
     <PackageTags>couchdb,driver,nosql,netstandard,pouchdb,xamarin</PackageTags>
     <PackageReleaseNotes>Complete rewrite.
@@ -16,11 +16,18 @@ All selectors support.</PackageReleaseNotes>
     <ApplicationIcon />
     <OutputType>Library</OutputType>
     <StartupObject />
+    <NeutralLanguage>en</NeutralLanguage>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsAsErrors />
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Flurl.Http" Version="2.4.1" />
     <PackageReference Include="Humanizer.Core" Version="2.6.2" />
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.1" />
     <PackageReference Include="Nito.AsyncEx.Context" Version="1.1.0" />
   </ItemGroup>