Refactorings based on microsoft ruleset.

Author: niemyjski

README.md

@@ -1,4 +1,4 @@
-# Generic C# Geocoding API [![CI](https://github.com/exceptionless/Geocoding.net/actions/workflows/build.yml/badge.svg)](https://github.com/exceptionless/Geocoding.net/actions/workflows/build.yml) [![Publish Packages](https://github.com/exceptionless/Geocoding.net/actions/workflows/publish-packages.yml/badge.svg)](https://github.com/exceptionless/Geocoding.net/actions/workflows/publish-packages.yml) [![CodeQL](https://github.com/exceptionless/Geocoding.net/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/exceptionless/Geocoding.net/actions/workflows/codeql-analysis.yml)
+# Generic C# Geocoding API [![CI](https://github.com/exceptionless/Geocoding.net/actions/workflows/build.yml/badge.svg)](https://github.com/exceptionless/Geocoding.net/actions/workflows/build.yml) [![CodeQL](https://github.com/exceptionless/Geocoding.net/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/exceptionless/Geocoding.net/actions/workflows/codeql-analysis.yml)
 
 Includes a model and interface for communicating with five popular Geocoding providers.  Current implementations include:
 
@@ -65,7 +65,7 @@ The Microsoft and Yahoo implementations each provide their own address class as
 
 ## API Keys
 
-Google [requires a new Server API Key](https://developers.google.com/maps/documentation/javascript/tutorial#api_key) to access its service.
+Google can use a [Server API Key](https://developers.google.com/maps/documentation/javascript/tutorial#api_key), and some environments now require one to access the service reliably.
 
 Bing [requires an API key](http://msdn.microsoft.com/en-us/library/ff428642.aspx) to access its service.
 

samples/Example.Web/Program.cs

@@ -1,4 +1,4 @@
-using Geocoding;
+using Geocoding;
 using Geocoding.Google;
 using Geocoding.Here;
 using Geocoding.MapQuest;
@@ -219,13 +219,13 @@ static IResult ProviderProblem(string provider, ProviderOptions options, Excepti
     return Results.Problem(title: "Geocoding provider request failed.", detail: detail, statusCode: StatusCodes.Status502BadGateway);
 }
 
-sealed record GeocodeResponse(string Provider, string Address, AddressResponse[] Results);
+internal sealed record GeocodeResponse(string Provider, string Address, AddressResponse[] Results);
 
-sealed record ReverseGeocodeResponse(string Provider, double Latitude, double Longitude, AddressResponse[] Results);
+internal sealed record ReverseGeocodeResponse(string Provider, double Latitude, double Longitude, AddressResponse[] Results);
 
-sealed record AddressResponse(string FormattedAddress, string Provider, double Latitude, double Longitude);
+internal sealed record AddressResponse(string FormattedAddress, string Provider, double Latitude, double Longitude);
 
-sealed class ProviderOptions
+internal sealed class ProviderOptions
 {
     public GoogleProviderOptions Google { get; init; } = new();
     public BingProviderOptions Bing { get; init; } = new();
@@ -234,29 +234,29 @@ sealed class ProviderOptions
     public YahooProviderOptions Yahoo { get; init; } = new();
 }
 
-sealed class GoogleProviderOptions
+internal sealed class GoogleProviderOptions
 {
     public String ApiKey { get; init; } = String.Empty;
 }
 
-sealed class BingProviderOptions
+internal sealed class BingProviderOptions
 {
     public String ApiKey { get; init; } = String.Empty;
 }
 
-sealed class HereProviderOptions
+internal sealed class HereProviderOptions
 {
     public String AppId { get; init; } = String.Empty;
     public String AppCode { get; init; } = String.Empty;
 }
 
-sealed class MapQuestProviderOptions
+internal sealed class MapQuestProviderOptions
 {
     public String ApiKey { get; init; } = String.Empty;
     public bool UseOsm { get; init; }
 }
 
-sealed class YahooProviderOptions
+internal sealed class YahooProviderOptions
 {
     public String ConsumerKey { get; init; } = String.Empty;
     public String ConsumerSecret { get; init; } = String.Empty;

src/Geocoding.Core/Address.cs

@@ -6,9 +6,9 @@ namespace Geocoding;
 /// </summary>
 public abstract class Address
 {
-    string formattedAddress = string.Empty;
-    Location coordinates;
-    string provider = string.Empty;
+    private string _formattedAddress = string.Empty;
+    private Location _coordinates;
+    private string _provider = string.Empty;
 
     /// <summary>
     /// Initializes a new address instance.
@@ -28,13 +28,13 @@ public Address(string formattedAddress, Location coordinates, string provider)
     /// </summary>
     public virtual string FormattedAddress
     {
-        get { return formattedAddress; }
+        get { return _formattedAddress; }
         set
         {
             if (string.IsNullOrWhiteSpace(value))
                 throw new ArgumentException("FormattedAddress is null or blank");
 
-            formattedAddress = value.Trim();
+            _formattedAddress = value.Trim();
         }
     }
 
@@ -43,13 +43,13 @@ public virtual string FormattedAddress
     /// </summary>
     public virtual Location Coordinates
     {
-        get { return coordinates; }
+        get { return _coordinates; }
         set
         {
             if (value == null)
                 throw new ArgumentNullException("Coordinates");
 
-            coordinates = value;
+            _coordinates = value;
         }
     }
 
@@ -58,13 +58,13 @@ public virtual Location Coordinates
     /// </summary>
     public virtual string Provider
     {
-        get { return provider; }
+        get { return _provider; }
         protected set
         {
             if (string.IsNullOrWhiteSpace(value))
                 throw new ArgumentException("Provider can not be null or blank");
 
-            provider = value;
+            _provider = value;
         }
     }
 
@@ -75,7 +75,7 @@ protected set
     /// <returns>The distance between the two addresses.</returns>
     public virtual Distance DistanceBetween(Address address)
     {
-        return this.Coordinates.DistanceBetween(address.Coordinates);
+        return Coordinates.DistanceBetween(address.Coordinates);
     }
 
     /// <summary>
@@ -86,7 +86,7 @@ public virtual Distance DistanceBetween(Address address)
     /// <returns>The distance between the two addresses.</returns>
     public virtual Distance DistanceBetween(Address address, DistanceUnits units)
     {
-        return this.Coordinates.DistanceBetween(address.Coordinates, units);
+        return Coordinates.DistanceBetween(address.Coordinates, units);
     }
 
     /// <summary>

src/Geocoding.Core/Bounds.cs

@@ -7,23 +7,23 @@ namespace Geocoding;
 /// </summary>
 public class Bounds
 {
-    readonly Location southWest;
-    readonly Location northEast;
+    private readonly Location _southWest;
+    private readonly Location _northEast;
 
     /// <summary>
     /// Gets the southwest corner.
     /// </summary>
     public Location SouthWest
     {
-        get { return southWest; }
+        get { return _southWest; }
     }
 
     /// <summary>
     /// Gets the northeast corner.
     /// </summary>
     public Location NorthEast
     {
-        get { return northEast; }
+        get { return _northEast; }
     }
 
     /// <summary>
@@ -53,8 +53,8 @@ public Bounds(Location southWest, Location northEast)
         if (southWest.Latitude > northEast.Latitude)
             throw new ArgumentException("southWest latitude cannot be greater than northEast latitude");
 
-        this.southWest = southWest;
-        this.northEast = northEast;
+        _southWest = southWest;
+        _northEast = northEast;
     }
 
     /// <summary>
@@ -77,7 +77,7 @@ public bool Equals(Bounds bounds)
         if (bounds == null)
             return false;
 
-        return (this.SouthWest.Equals(bounds.SouthWest) && this.NorthEast.Equals(bounds.NorthEast));
+        return SouthWest.Equals(bounds.SouthWest) && NorthEast.Equals(bounds.NorthEast);
     }
 
     /// <summary>
@@ -95,6 +95,6 @@ public override int GetHashCode()
     /// <returns>A string representation of the bounds.</returns>
     public override string ToString()
     {
-        return string.Format("{0} | {1}", southWest, northEast);
+        return $"{_southWest} | {_northEast}";
     }
 }

src/Geocoding.Core/Distance.cs

@@ -15,23 +15,23 @@ public struct Distance
     public const double EarthRadiusInKilometers = 6378.135;
     private const double ConversionConstant = 0.621371192;
 
-    private readonly double value;
-    private readonly DistanceUnits units;
+    private readonly double _value;
+    private readonly DistanceUnits _units;
 
     /// <summary>
     /// Gets the numeric distance value.
     /// </summary>
     public double Value
     {
-        get { return value; }
+        get { return _value; }
     }
 
     /// <summary>
     /// Gets the units of the distance value.
     /// </summary>
     public DistanceUnits Units
     {
-        get { return units; }
+        get { return _units; }
     }
 
     /// <summary>
@@ -41,8 +41,8 @@ public DistanceUnits Units
     /// <param name="units">The units for the value.</param>
     public Distance(double value, DistanceUnits units)
     {
-        this.value = Math.Round(value, 8);
-        this.units = units;
+        _value = Math.Round(value, 8);
+        _units = units;
     }
 
     #region Helper Factory Methods
@@ -73,16 +73,16 @@ public static Distance FromKilometers(double kilometers)
 
     private Distance ConvertUnits(DistanceUnits units)
     {
-        if (this.units == units) return this;
+        if (_units == units) return this;
 
         double newValue;
         switch (units)
         {
             case DistanceUnits.Miles:
-                newValue = value * ConversionConstant;
+                newValue = _value * ConversionConstant;
                 break;
             case DistanceUnits.Kilometers:
-                newValue = value / ConversionConstant;
+                newValue = _value / ConversionConstant;
                 break;
             default:
                 newValue = 0;
@@ -160,7 +160,7 @@ public override int GetHashCode()
     /// <returns>A string representation of this distance.</returns>
     public override string ToString()
     {
-        return string.Format("{0} {1}", value, units);
+        return $"{_value} {_units}";
     }
 
     #region Operators
@@ -231,7 +231,7 @@ public override string ToString()
     /// <returns><c>true</c> when left is less than right; otherwise <c>false</c>.</returns>
     public static bool operator <(Distance left, Distance right)
     {
-        return (left.Value < right.ConvertUnits(left.Units).Value);
+        return left.Value < right.ConvertUnits(left.Units).Value;
     }
 
     /// <summary>
@@ -242,7 +242,7 @@ public override string ToString()
     /// <returns><c>true</c> when left is less than or equal to right; otherwise <c>false</c>.</returns>
     public static bool operator <=(Distance left, Distance right)
     {
-        return (left.Value <= right.ConvertUnits(left.Units).Value);
+        return left.Value <= right.ConvertUnits(left.Units).Value;
     }
 
     /// <summary>
@@ -253,7 +253,7 @@ public override string ToString()
     /// <returns><c>true</c> when left is greater than right; otherwise <c>false</c>.</returns>
     public static bool operator >(Distance left, Distance right)
     {
-        return (left.Value > right.ConvertUnits(left.Units).Value);
+        return left.Value > right.ConvertUnits(left.Units).Value;
     }
 
     /// <summary>
@@ -264,7 +264,7 @@ public override string ToString()
     /// <returns><c>true</c> when left is greater than or equal to right; otherwise <c>false</c>.</returns>
     public static bool operator >=(Distance left, Distance right)
     {
-        return (left.Value >= right.ConvertUnits(left.Units).Value);
+        return left.Value >= right.ConvertUnits(left.Units).Value;
     }
 
     /// <summary>

src/Geocoding.Core/Extensions.cs

@@ -1,4 +1,4 @@
-using Newtonsoft.Json;
+using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
 namespace Geocoding;
@@ -40,7 +40,7 @@ public static void ForEach<T>(this IEnumerable<T> self, Action<T> actor)
     }
 
     //Universal ISO DT Converter
-    static readonly JsonConverter[] JSON_CONVERTERS = new JsonConverter[]
+    private static readonly JsonConverter[] JSON_CONVERTERS = new JsonConverter[]
     {
         new IsoDateTimeConverter { DateTimeStyles = System.Globalization.DateTimeStyles.AssumeUniversal },
         new StringEnumConverter(),