Merge pull request #15 from kapokmarketing/development

Development

.editorconfig

@@ -0,0 +1,204 @@
+# editorconfig.org
+# Source: .NET Runtime Coding Standards
+# See: https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/coding-style.md
+# See Also: https://github.com/dotnet/runtime/blob/main/.editorconfig
+
+# top-most EditorConfig file
+root = true
+
+# Default settings:
+# A newline ending every file
+# Use 4 spaces as indentation
+[*]
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[project.json]
+indent_size = 2
+
+# Generated code
+[*{_AssemblyInfo.cs,.notsupported.cs}]
+generated_code = true
+
+# C# files
+[*.cs]
+# New line preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_switch_labels = true
+csharp_indent_labels = one_less_than_current
+
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+
+# avoid this. unless absolutely necessary
+dotnet_style_qualification_for_field = false:suggestion
+dotnet_style_qualification_for_property = false:suggestion
+dotnet_style_qualification_for_method = false:suggestion
+dotnet_style_qualification_for_event = false:suggestion
+
+# Types: use keywords instead of BCL types, and permit var only when the type is clear
+csharp_style_var_for_built_in_types = true:warning
+csharp_style_var_when_type_is_apparent = true:warning
+csharp_style_var_elsewhere = true:suggestion
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+dotnet_style_predefined_type_for_member_access = true:suggestion
+
+# name all constant fields using PascalCase
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
+dotnet_naming_symbols.constant_fields.applicable_kinds   = field
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+dotnet_naming_style.pascal_case_style.capitalization = pascal_case
+
+# static fields should have s_ prefix
+dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
+dotnet_naming_rule.static_fields_should_have_prefix.symbols  = static_fields
+dotnet_naming_rule.static_fields_should_have_prefix.style    = static_prefix_style
+dotnet_naming_symbols.static_fields.applicable_kinds   = field
+dotnet_naming_symbols.static_fields.required_modifiers = static
+dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
+dotnet_naming_style.static_prefix_style.required_prefix = s_
+dotnet_naming_style.static_prefix_style.capitalization = camel_case
+
+# internal and private fields should be _camelCase
+dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
+dotnet_naming_rule.camel_case_for_private_internal_fields.symbols  = private_internal_fields
+dotnet_naming_rule.camel_case_for_private_internal_fields.style    = camel_case_underscore_style
+dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
+dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
+dotnet_naming_style.camel_case_underscore_style.required_prefix = _
+dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
+
+# Code style defaults
+csharp_using_directive_placement = outside_namespace:suggestion
+dotnet_sort_system_directives_first = true
+csharp_prefer_braces = true:silent
+csharp_preserve_single_line_blocks = true:none
+csharp_preserve_single_line_statements = false:none
+csharp_prefer_static_local_function = true:suggestion
+csharp_prefer_simple_using_statement = false:none
+csharp_style_prefer_switch_expression = true:suggestion
+
+# Code quality
+dotnet_style_readonly_field = true:suggestion
+dotnet_code_quality_unused_parameters = non_public:suggestion
+
+# Expression-level preferences
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+csharp_prefer_simple_default_expression = true:suggestion
+
+# Expression-bodied members
+csharp_style_expression_bodied_methods = true:silent
+csharp_style_expression_bodied_constructors = true:silent
+csharp_style_expression_bodied_operators = true:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = true:silent
+
+# Pattern matching
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+
+# Null checking preferences
+csharp_style_throw_expression = true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Other features
+csharp_style_prefer_index_operator = false:none
+csharp_style_prefer_range_operator = false:none
+csharp_style_pattern_local_over_anonymous_function = false:none
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = do_not_ignore
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# Analyzers
+dotnet_code_quality.CA1052.api_surface = private, internal
+dotnet_code_quality.CA1802.api_surface = private, internal
+dotnet_code_quality.CA1822.api_surface = private, internal
+dotnet_code_quality.CA2208.api_surface = public
+
+# License header (NOTE: this deviates from the original file)
+file_header_template = Copyright (c) Kapok Marketing, Inc. All Rights Reserved. CONFIDENTIAL & PROPRIETARY SOURCE CODE. See License.txt in the solution root for license information.
+
+# C++ Files
+[*.{cpp,h,in}]
+curly_bracket_next_line = true
+indent_brace_style = Allman
+
+# Xml project files
+[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
+indent_size = 2
+
+[*.{csproj,vbproj,proj,nativeproj,locproj}]
+charset = utf-8
+
+# Xml build files
+[*.builds]
+indent_size = 2
+
+# Xml files
+[*.{xml,stylecop,resx,ruleset}]
+indent_size = 2
+
+# Xml config files
+[*.{props,targets,config,nuspec}]
+indent_size = 2
+
+# YAML config files
+[*.{yml,yaml}]
+indent_size = 2
+
+# Shell scripts
+[*.sh]
+end_of_line = lf
+[*.{cmd,bat}]
+end_of_line = crlf

Kapok.IpToGeolocation.Tests/BaseTests.cs

@@ -1,8 +1,5 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-using System;
-using System.Collections.Generic;
-using System.Text;
 
 namespace Kapok.IpToGeolocation.Tests
 {

Kapok.IpToGeolocation.Tests/JsonTests.cs

@@ -1,28 +1,23 @@
-using Microsoft.Extensions.Configuration;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using System.Collections.Generic;
 using System.Linq;
-using System.Net.Http;
-using System.Text.Json;
-using System.Threading;
-using System.Threading.Tasks;
 
 namespace Kapok.IpToGeolocation.Tests
 {
     [TestClass]
     [DeploymentItem("Data")]
     public class JsonTests : BaseTests
     {
-        private static IEnumerable<Provider> Sources;
+        private static IEnumerable<Provider> s_sources;
 
         [ClassInitialize]
         public static void Initialize(TestContext context)
         {
-            Sources = new Provider[] { Provider.AbstractApi, Provider.IpRegistry, Provider.IpStack };
+            s_sources = new Provider[] { Provider.AbstractApi, Provider.IpRegistry, Provider.IpStack };
         }
 
         public static IEnumerable<object[]> GetSources()
-            => Sources.Select(source => new object[] { source });
+            => s_sources.Select(source => new object[] { source });
 
         public static IEnumerable<object[]> GetSourcesWithCities()
         {
@@ -35,9 +30,13 @@ public static IEnumerable<object[]> GetSourcesWithCities()
         [DataTestMethod]
         public void JsonData_ShouldDeserializeWithData(Provider source)
         {
+            // Arrange
             var json = GetJson(source);
+
+            // Act
             var result = GeolocationSerializer.Deserialize(source, json);
 
+            // Assert
             Assert.IsNotNull(result);
             Assert.IsNotNull(result.City);
             Assert.IsNotNull(result.RegionCode);
@@ -52,9 +51,13 @@ public void JsonData_ShouldDeserializeWithData(Provider source)
         [DataTestMethod]
         public void JsonData_ShouldDeserializeWithCorrectCity(Provider source, string expectedValue)
         {
+            // Arrange
             var json = GetJson(source);
+
+            // Act
             var result = GeolocationSerializer.Deserialize(source, json);
 
+            // Assert
             Assert.AreEqual(expectedValue, result?.City);
         }
     }

Kapok.IpToGeolocation.Tests/Kapok.IpToGeolocation.Tests.csproj

@@ -33,6 +33,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="3.1.15" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="3.1.15" />
     <PackageReference Include="Microsoft.Extensions.Http" Version="3.1.15" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.4" />

Kapok.IpToGeolocation.Tests/ServiceTests.cs

@@ -1,13 +1,9 @@
-using Microsoft.Extensions.Configuration;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Moq;
 using Moq.Protected;
-using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Net;
 using System.Net.Http;
-using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -28,10 +24,13 @@ public static IEnumerable<object[]> GetSourcesWithIpAddresses()
         [DataTestMethod]
         public async Task Service_WhenOneProvider_ShouldReturnWithValidDataLive(Provider provider, string ipAddress, bool expectSuccess)
         {
+            // Arrange
             var service = GetGeolocationService();
 
+            // Act
             var result = await service.GetAsync(ipAddress, new Provider[] { provider }, CancellationToken.None);
 
+            // Assert
             if (expectSuccess)
             {
                 Assert.IsNotNull(result);
@@ -52,10 +51,13 @@ public async Task Service_WhenOneProvider_ShouldReturnWithValidDataLive(Provider
         [DataTestMethod]
         public async Task Service_WhenOneProvider_ShouldReturnWithValidData(Provider provider, string ipAddress, bool expectSuccess)
         {
+            // Arrange
             var service = GetGeolocationServiceWithMockHttpMessageHandler(provider);
 
+            // Act
             var result = await service.GetAsync(ipAddress, new [] { provider }, CancellationToken.None);
 
+            // Assert
             Assert.IsNotNull(result);
             Assert.IsNotNull(result.Location);
             Assert.AreEqual(provider, result.Provider);
@@ -66,10 +68,13 @@ public async Task Service_WhenOneProvider_ShouldReturnWithValidData(Provider pro
         [DataTestMethod]
         public async Task Service_WhenNoProviders_ShouldReturnNullAndUnknown(Provider provider, string ipAddress, bool expectSuccess)
         {
+            // Arrange
             var service = GetGeolocationServiceWithMockHttpMessageHandler(provider);
 
+            // Act
             var result = await service.GetAsync(ipAddress, new Provider[] { }, CancellationToken.None);
 
+            // Assert
             Assert.IsNotNull(result);
             Assert.IsNull(result.Location);
             Assert.AreEqual(Provider.Unknown, result.Provider);

Kapok.IpToGeolocation.sln

@@ -9,7 +9,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Kapok.IpToGeolocation.Tests
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{625013D7-1D1C-4585-AED3-AA4C2B331362}"
 	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
 		.gitignore = .gitignore
+		.git\config = .git\config
 		LICENSE = LICENSE
 	EndProjectSection
 EndProject

Kapok.IpToGeolocation/AbstractApi/Currency.cs

@@ -8,9 +8,9 @@ namespace Kapok.IpToGeolocation.AbstractApi
     public class Currency
     {
         [JsonPropertyName("currency_name")]
-        public string CurrencyName { get; set; }
+        public string? CurrencyName { get; set; }
 
         [JsonPropertyName("currency_code")]
-        public string CurrencyCode { get; set; }
+        public string? CurrencyCode { get; set; }
     }
 }

Kapok.IpToGeolocation/AbstractApi/Flag.cs

@@ -8,15 +8,15 @@ namespace Kapok.IpToGeolocation.AbstractApi
     public class Flag
     {
         [JsonPropertyName("emoji")]
-        public string Emoji { get; set; }
+        public string? Emoji { get; set; }
 
         [JsonPropertyName("unicode")]
-        public string Unicode { get; set; }
+        public string? Unicode { get; set; }
 
         [JsonPropertyName("png")]
-        public string Png { get; set; }
+        public string? Png { get; set; }
 
         [JsonPropertyName("svg")]
-        public string Svg { get; set; }
+        public string? Svg { get; set; }
     }
 }

Kapok.IpToGeolocation/GeolocationProviderConfiguration.cs

@@ -14,6 +14,6 @@ public class GeolocationProviderConfiguration
         public string? UrlPattern { get; set; }
         public string? PrivateKey { get; set; }
         public string? UrlPatternWithPrivateKey
-            => _urlPatternWithPrivateKey ?? (_urlPatternWithPrivateKey = PrivateKey != null ? UrlPattern?.Replace("{Key}", PrivateKey) : UrlPattern);
+            => _urlPatternWithPrivateKey ??= PrivateKey != null ? UrlPattern?.Replace("{Key}", PrivateKey) : UrlPattern;
     }
-}
+}