Merge pull request #44 from IowaComputerGurus/Feature/NewRelease

Roll-up of new functionality for 5.0.x release

Author: mitchelsellers

README.md

@@ -18,6 +18,7 @@ Install from NuGet
 ```
 Install-Package ICG.AspNetCore.Utilities
 ```
+
 ### Register Dependencies
 
 Inside of of your project's Startus.cs within the RegisterServices method add this line of code.
@@ -26,7 +27,13 @@ Inside of of your project's Startus.cs within the RegisterServices method add th
 services.UseIcgAspNetCoreUtilities();
 ```
 
-### Included Features
+If you desire to use the included Taghelpers inside of your `_viewimports.cshtml` add
+
+```
+@addTagHelper *, ICG.AspNetCore.Utilities
+```
+
+### Included C# Objects
 
 | Object | Purpose |
 | ---- | --- |
@@ -43,3 +50,23 @@ services.UseIcgAspNetCoreUtilities();
 Detailed information can be found in the XML Comment documentation for the objects, we are working to add to this document as well.
 
 **Caution:** As expected the use of both ForceNonWwwRewriteRule and ForceWwwRewriteRule in the same installation will result in broken sites.
+
+### Included Tag Helpers
+
+#### HideCondition 
+This tag helper will hide the content of the target element if the condition is true, an example.
+
+```
+<div hide-condition="Model.Deleted">
+
+</div>
+```
+
+#### Show Condition
+This tag helper will show the content of the target element if the condition is true, an example.
+
+```
+<div show-condition="Model.Published">
+
+</div>
+```

src/AspNetCore.Utilities.Tests/AspNetCore.Utilities.Tests.csproj

@@ -1,17 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.0</TargetFramework>
-
+    <TargetFramework>net5.0</TargetFramework>
     <IsPackable>false</IsPackable>
-
     <RootNamespace>ICG.AspNetCore.Utilities.Tests</RootNamespace>
-
-    <ApplicationIcon />
-
     <OutputType>Library</OutputType>
-
-    <StartupObject />
   </PropertyGroup>
 
   <ItemGroup>

src/AspNetCore.Utilities.Tests/CurrentEnvironmentInfoServicesTests.cs

@@ -10,13 +10,13 @@ namespace ICG.AspNetCore.Utilities.Tests
     public class CurrentEnvironmentInfoServicesTests
     {
         private readonly ICurrentEnvironmentInfoService _currentEnvironmentInfoService;
-        private readonly Mock<IHostingEnvironment> _hostingEnvironmentMock;
+        private readonly Mock<IWebHostEnvironment> _hostingEnvironmentMock;
         private readonly Mock<IConfiguration> _configurationMock;
         private readonly Mock<IDatabaseEnvironmentModelFactory> _databaseEnvironmentModelFactoryMock;
 
         public CurrentEnvironmentInfoServicesTests()
         {
-            _hostingEnvironmentMock = new Mock<IHostingEnvironment>();
+            _hostingEnvironmentMock = new Mock<IWebHostEnvironment>();
             _configurationMock = new Mock<IConfiguration>();
             _databaseEnvironmentModelFactoryMock = new Mock<IDatabaseEnvironmentModelFactory>();
             _currentEnvironmentInfoService = new CurrentEnvironmentInfoService(_hostingEnvironmentMock.Object,

src/AspNetCore.Utilities.Tests/TimeProviderTests.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Runtime.InteropServices;
 using ICG.AspNetCore.Utilities;
 using Xunit;
 
@@ -109,5 +110,43 @@ public void SecondsSinceEpoch_ShouldReturnProperValue()
             //Assert
             Assert.Equal(expectedResult, actualResult);
         }
+
+        [Fact]
+        public void ConvertTimeFromUtc_ShouldThrowException_WhenUnknownTimezoneTarget()
+        {
+            //Arrange
+            var startDate = DateTime.Now;
+            var targetTimezone = "Happy Place";
+
+            //Act.Assert
+            Assert.Throws<TimeZoneNotFoundException>(() => _timeProvider.ConvertTimeFromUtc(targetTimezone, startDate));
+        }
+
+        [Fact]
+        public void ConvertTimeToUtc_ShouldThrowException_WhenUnknownTimezoneTarget()
+        {
+            //Arrange
+            var startDate = DateTime.Now;
+            var targetTimezone = "Happy Place";
+
+            //Act.Assert
+            Assert.Throws<TimeZoneNotFoundException>(() => _timeProvider.ConvertTimeToUtc(targetTimezone, startDate));
+        }
+
+        [Fact]
+        public void ConvertTimes_ShouldSupportConversionBothDirections()
+        {
+            //Arrange
+            var startDate = DateTime.UtcNow;
+            var targetTimezone = Timezones.CentralStandardTime;
+
+            //Act
+            var convertedLocal = _timeProvider.ConvertTimeFromUtc(targetTimezone, startDate);
+            var convertedUtc = _timeProvider.ConvertTimeToUtc(targetTimezone, convertedLocal);
+
+            //Assert
+            Assert.Equal(startDate, convertedUtc);
+
+        }
     }
 }

src/AspNetCore.Utilities/AspNetCore.Utilities.csproj

@@ -3,29 +3,44 @@
   <PropertyGroup>
     <Version>0.0.0</Version>
   </PropertyGroup>
+
+  <PropertyGroup>
+    <TargetFramework>net5.0</TargetFramework>
+    <RootNamespace>ICG.AspNetCore.Utilities</RootNamespace>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <ApplicationIcon />
+    <OutputType>Library</OutputType>
+    <StartupObject />
+  </PropertyGroup>
+
   <PropertyGroup>
     <PackageId>ICG.AspNetCore.Utilities</PackageId>
     <Title>AspNetCore Utilities</Title>
     <Description>A collection of utilities designed to impove the unit-testability or speed development of AspNetCore development projects.</Description>
-    <Copyright>Copyright 2019, IowaComputerGurus, Subject to the MIT License</Copyright>
+    <Copyright>Copyright 2021, IowaComputerGurus, Subject to the MIT License</Copyright>
     <PackageProjectUrl>https://github.com/IowaComputerGurus/aspnetcore.utilities</PackageProjectUrl>
     <PackageTags>aspnetcore;utility;unit-testing</PackageTags>
     <RepositoryUrl>https://github.com/IowaComputerGurus/aspnetcore.utilities</RepositoryUrl>
     <Authors>MitchelSellers;IowaComputerGurus</Authors>
     <Owners>IowaComputerGurus</Owners>
     <PackageIconUrl>https://raw.githubusercontent.com/IowaComputerGurus/aspnetcore.utilities/master/icgAppIcon.png</PackageIconUrl>
     <IsPackable>True</IsPackable>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
   </PropertyGroup>
-  <PropertyGroup>
-    <TargetFramework>netcoreapp3.0</TargetFramework>
-    <RootNamespace>ICG.AspNetCore.Utilities</RootNamespace>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <ApplicationIcon />
-    <OutputType>Library</OutputType>
-    <StartupObject />
+
+  <PropertyGroup Condition="'$(TF_BUILD)' == 'true'">
+    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
   </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.0.0-preview7.19362.4" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
 </Project>

src/AspNetCore.Utilities/CurrentEnvironmentInfoService.cs

@@ -23,7 +23,7 @@ public interface ICurrentEnvironmentInfoService
     /// <inheritdoc />
     public class CurrentEnvironmentInfoService : ICurrentEnvironmentInfoService
     {
-        private readonly IHostingEnvironment _hostingEnvironment;
+        private readonly IWebHostEnvironment _hostingEnvironment;
         private readonly IConfiguration _configuration;
         private readonly IDatabaseEnvironmentModelFactory _databaseEnvironmentModelFactory;
 
@@ -33,7 +33,7 @@ public class CurrentEnvironmentInfoService : ICurrentEnvironmentInfoService
         /// <param name="hostingEnvironment">The current hosting environment information</param>
         /// <param name="configuration">The current configuration</param>
         /// <param name="databaseEnvironmentModelFactory">Factory to create new objects</param>
-        public CurrentEnvironmentInfoService(IHostingEnvironment hostingEnvironment, IConfiguration configuration, IDatabaseEnvironmentModelFactory databaseEnvironmentModelFactory)
+        public CurrentEnvironmentInfoService(IWebHostEnvironment hostingEnvironment, IConfiguration configuration, IDatabaseEnvironmentModelFactory databaseEnvironmentModelFactory)
         {
             _hostingEnvironment = hostingEnvironment;
             _configuration = configuration;

src/AspNetCore.Utilities/DirectoryProvider.cs

@@ -355,7 +355,7 @@ IEnumerable<string> EnumerateFileSystemEntries(string path, string searchPattern
         DateTime GetLastWriteTimeUtc(string path);
 
         /// <summary>
-        ///     Retrieves the names of the logical drives on this computer in the form "<drive letter>:\".
+        ///     Retrieves the names of the logical drives on this computer in the form "&lt;drive letter&gt;:\".
         /// </summary>
         /// <returns></returns>
         string[] GetLogicalDrives();
@@ -424,6 +424,7 @@ IEnumerable<string> EnumerateFileSystemEntries(string path, string searchPattern
         void SetLastWriteTimeUtc(string path, DateTime lastWriteTimeUtc);
     }
 
+    /// <inheritdoc />
     public class DirectoryProvider : IDirectoryProvider
     {
         /// <inheritdoc />

src/AspNetCore.Utilities/TagHelpers/HideConditionTagHelper.cs

@@ -0,0 +1,27 @@
+using Microsoft.AspNetCore.Razor.TagHelpers;
+
+namespace ICG.AspNetCore.Utilities.TagHelpers
+{
+    /// <summary>
+    ///     A tag helper that if passed a tre value will suppress rendering content
+    /// </summary>
+    [HtmlTargetElement(Attributes = nameof(HideCondition))]
+    public class HideConditionTagHelper : TagHelper
+    {
+        /// <summary>
+        ///     The boolean indicator if the element should be hidden
+        /// </summary>
+        public bool HideCondition { get; set; }
+
+        /// <summary>
+        ///     Processes the tag
+        /// </summary>
+        /// <param name="context">The input context</param>
+        /// <param name="output">The output content</param>
+        public override void Process(TagHelperContext context, TagHelperOutput output)
+        {
+            if (HideCondition)
+                output.SuppressOutput();
+        }
+    }
+}

src/AspNetCore.Utilities/TagHelpers/ShowConditionTagHelper.cs

@@ -0,0 +1,27 @@
+using Microsoft.AspNetCore.Razor.TagHelpers;
+
+namespace ICG.AspNetCore.Utilities.TagHelpers
+{
+    /// <summary>
+    ///     A tag helper that if passed a false value will suppress rendering content
+    /// </summary>
+    [HtmlTargetElement(Attributes = nameof(ShowCondition))]
+    public class ShowConditionTagHelper : TagHelper
+    {
+        /// <summary>
+        ///     The boolean indicator if the element should be shown
+        /// </summary>
+        public bool ShowCondition { get; set; }
+
+        /// <summary>
+        ///     Processes the tag
+        /// </summary>
+        /// <param name="context">The input context</param>
+        /// <param name="output">The output content</param>
+        public override void Process(TagHelperContext context, TagHelperOutput output)
+        {
+            if (!ShowCondition) 
+                output.SuppressOutput();
+        }
+    }
+}

src/AspNetCore.Utilities/TimeProvider.cs

@@ -158,6 +158,24 @@ bool TryParseExact(string s, string[] formats, IFormatProvider provider, DateTim
         ///     The Total # of Seconds since Epoch, based on the difference between <see cref="DateTime.UtcNow"/> and 1/1/1970
         /// </returns>
         ulong UtcNowSecondsSinceEpoch();
+
+        /// <summary>
+        ///     Provides a method to convert a UTC time to a time in the targeted timezone
+        /// </summary>
+        /// <param name="destinationTimeZone">The Timezone Targeted such as "Central Standard Time"</param>
+        /// <param name="utcDateTime">The UTC date to be converted</param>
+        /// <returns>The passed date, adjusted for the target timezone.</returns>
+        /// <exception cref="TimeZoneNotFoundException">Thrown if the requested timezone doesn't exist</exception>
+        DateTime ConvertTimeFromUtc(string destinationTimeZone, DateTime utcDateTime);
+
+        /// <summary>
+        ///     Provides a method to convert time from a local timezone back to UTC
+        /// </summary>
+        /// <param name="currentTimeZone">The current timezone</param>
+        /// <param name="localDateTime">The current time</param>
+        /// <returns>The updated time</returns>
+        /// <exception cref="TimeZoneNotFoundException">Thrown if the requested timezone doesn't exist</exception>
+        DateTime ConvertTimeToUtc(string currentTimeZone, DateTime localDateTime);
     }
 
     /// <summary>
@@ -213,5 +231,19 @@ public ulong UtcNowSecondsSinceEpoch()
         {
             return SecondsSinceEpoch(UtcNow);
         }
+
+        /// <inheritdoc />
+        public DateTime ConvertTimeFromUtc(string destinationTimeZone, DateTime utcDateTime)
+        {
+            var targetTimeZone = TimeZoneInfo.FindSystemTimeZoneById(destinationTimeZone);
+            return TimeZoneInfo.ConvertTimeFromUtc(utcDateTime, targetTimeZone);
+        }
+
+        /// <inheritdoc />
+        public DateTime ConvertTimeToUtc(string currentTimeZone, DateTime localDateTime)
+        {
+            var sourceTimezone = TimeZoneInfo.FindSystemTimeZoneById(currentTimeZone);
+            return TimeZoneInfo.ConvertTimeToUtc(localDateTime, sourceTimezone);
+        }
     }
 }