Merge branch 'version-5' of https://github.com/typinghard/azure-devops-tracker into feature/68

elvissouza-gruposize · elvissouza-gruposize · commit 30876eeb8570 · 2022-06-20T18:19:52.000-03:00
diff --git a/AzureDevopsTracker/AzureDevopsTracker.csproj b/AzureDevopsTracker/AzureDevopsTracker.csproj
@@ -17,9 +17,9 @@
     <NeutralLanguage>en</NeutralLanguage>
     <PackageLicenseFile>LICENSE.md.txt</PackageLicenseFile>
     <Description>A NuGet that allows you to use a Azure DevOps Service Hook to track workitems changes in a simply and detailed way.</Description>
-    <AssemblyVersion>5.1.0.0</AssemblyVersion>
-    <FileVersion>5.0.0-rc</FileVersion>
-    <Version>5.0.0-rc</Version>
+    <AssemblyVersion>5.0.0.0</AssemblyVersion>
+    <FileVersion>5.0.3</FileVersion>
+    <Version>5.0.3</Version>
     <PackageReleaseNotes>Add ChangeLog Feature</PackageReleaseNotes>
   </PropertyGroup>
 
diff --git a/AzureDevopsTracker/Entities/ChangeLogItem.cs b/AzureDevopsTracker/Entities/ChangeLogItem.cs
@@ -10,6 +10,7 @@ public class ChangeLogItem : Entity
         public string Description { get; private set; }
         public string WorkItemType { get; private set; }
         public string ChangeLogId { get; private set; }
+        public bool WasReleased => string.IsNullOrEmpty(ChangeLogId?.Trim());
 
         /*EF*/
         public ChangeLog ChangeLog { get; private set; }
diff --git a/AzureDevopsTracker/Entities/WorkItem.cs b/AzureDevopsTracker/Entities/WorkItem.cs
@@ -31,6 +31,7 @@ public class WorkItem : Entity
         private readonly List<TimeByState> _timeByState;
         public IReadOnlyCollection<TimeByState> TimeByStates => _timeByState;
         public string CurrentStatus => _workItemsChanges?.OrderBy(x => x.CreatedAt)?.LastOrDefault()?.NewState;
+        public string LastStatus => _workItemsChanges?.OrderBy(x => x.CreatedAt)?.ToList()?.Skip(1)?.LastOrDefault()?.OldState;
 
         private WorkItem()
         {
@@ -119,6 +120,11 @@ public void ClearTimesByState()
             _timeByState.Clear();
         }
 
+        public void RemoveChangeLogItem()
+        {
+            ChangeLogItem = null;
+        }
+
         public void VinculateChangeLogItem(ChangeLogItem changeLogItem)
         {
             if (changeLogItem == null)
diff --git a/AzureDevopsTracker/Helpers/RawTextHelper.cs b/AzureDevopsTracker/Helpers/RawTextHelper.cs
@@ -1,10 +1,18 @@
 ﻿using System;
-using System.Collections.Generic;
-using System.Text;
+using System.Text.RegularExpressions;
 
 namespace AzureDevopsTracker.Helpers
 {
     internal static class RawTextHelper
     {
+        public static string HtmlToRawText(this string source)
+        {
+            source = source.Replace("</div>", "\n");
+            source = source.Replace("<li>", "\n• ");
+            source = Regex.Replace(source, "<.*?>|&.*?;", string.Empty, RegexOptions.Compiled, TimeSpan.FromMilliseconds(250));
+            source = source.Trim().EndsWith(".") ? source[0..^1] : source.Trim();
+
+            return source;
+        }
     }
 }
diff --git a/AzureDevopsTracker/Integrations/DiscordIntegration.cs b/AzureDevopsTracker/Integrations/DiscordIntegration.cs
@@ -1,4 +1,6 @@
 ﻿using AzureDevopsTracker.Entities;
+using AzureDevopsTracker.Helpers;
+using AzureDevopsTracker.Statics;
 using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
@@ -101,11 +103,14 @@ private IEnumerable<Field> GetText(ChangeLog changeLog)
 
             var listFields = new List<Field>();
 
-            var features = changeLogItemsAgrupado.Where(x => !x.Key.Equals("bug")).SelectMany(x => x).Select(x => x).ToList();
-            var bugFixes = changeLogItemsAgrupado.Where(x => x.Key.Equals("bug")).SelectMany(x => x).Select(x => x).ToList();
+            var features = changeLogItemsAgrupado.Where(x => !x.Key.Equals(WorkItemStatics.WORKITEM_TYPE_BUG)).SelectMany(x => x).Select(x => x).ToList();
+            var bugFixes = changeLogItemsAgrupado.Where(x => x.Key.Equals(WorkItemStatics.WORKITEM_TYPE_BUG)).SelectMany(x => x).Select(x => x).ToList();
 
-            listFields.Add(new Field() { Name = "Atualizações", Value = string.Join("\n", features.Select(d => string.Format(" {0} -   {1}.", d.WorkItemId, d.Description))), IsInline = false });
-            listFields.Add(new Field() { Name = "Correções", Value = string.Join("\n", bugFixes.Select(d => string.Format(" {0} -   {1}.", d.WorkItemId, d.Description))), IsInline = false });
+            if (features.Any())
+                listFields.Add(new Field() { Name = "Atualizações", Value = string.Join("\n", features.Select(d => string.Format("\n{0} -   {1}", d.WorkItemId, d.Description.HtmlToRawText()))), IsInline = false });
+
+            if (bugFixes.Any())
+                listFields.Add(new Field() { Name = "Correções", Value = string.Join("\n", bugFixes.Select(d => string.Format("\n{0} -   {1}", d.WorkItemId, d.Description.HtmlToRawText()))), IsInline = false });
 
             return listFields;
         }
diff --git a/AzureDevopsTracker/Integrations/MicrosoftTeamsIntegration.cs b/AzureDevopsTracker/Integrations/MicrosoftTeamsIntegration.cs
@@ -66,54 +66,41 @@ private string GetText(ChangeLog changeLog)
         {
             if (changeLog == null || !changeLog.ChangeLogItems.Any()) return string.Empty;
 
-            StringBuilder text = new StringBuilder();
-            text.Append(GetWorkItemsDescriptionSection("Features", changeLog.ChangeLogItems.Where(x => x.WorkItemType != WorkItemStatics.WORKITEM_TYPE_BUG)));
-            text.Append(GetWorkItemsDescriptionSection("Correções", changeLog.ChangeLogItems.Where(x => x.WorkItemType == WorkItemStatics.WORKITEM_TYPE_BUG)));
+            StringBuilder text = new();
+            text.AppendLine(GetWorkItemsDescriptionSection("Features", changeLog.ChangeLogItems.Where(x => x.WorkItemType != WorkItemStatics.WORKITEM_TYPE_BUG)));
+            text.AppendLine(GetWorkItemsDescriptionSection("Correções", changeLog.ChangeLogItems.Where(x => x.WorkItemType == WorkItemStatics.WORKITEM_TYPE_BUG)));
 
-            text.Append(GetFooter());
+            text.AppendLine(GetFooter());
             return text.ToString();
         }
 
         private string GetWorkItemsDescriptionSection(string sectionName, IEnumerable<ChangeLogItem> changeLogItems)
         {
-            StringBuilder text = new StringBuilder();
+            StringBuilder text = new();
             if (!changeLogItems.Any()) return string.Empty;
 
-            text.Append("<br>");
-            text.AppendLine("\n");
-
-            text.Append($"\n  # **{ sectionName }**\n");
+            text.AppendLine($"\n# **{ sectionName }**\n");
             foreach (var workItem in changeLogItems)
-            {
-                text.Append(GetWorkItemDescriptionLine(workItem));
-            }
+                text.AppendLine(GetWorkItemDescriptionLine(workItem));
 
-            text.Append("<br>");
             text.AppendLine("\n");
             return text.ToString();
         }
 
         private string GetWorkItemDescriptionLine(ChangeLogItem workItem)
         {
             var description = GetDescription(workItem.Description);
-            var descriptionLine = $"<em>**{ workItem.WorkItemId }**</em> - { description }";
-            if (description.Length > MicrosoftTeamsStatics.TEXT_SIZE_TO_BREAK_LINE)
-                return $"<br>{ descriptionLine }<br>";
-            return descriptionLine;
+            return $"<em>**{ workItem.WorkItemId }**</em> - { description } <br>";
         }
 
         private string GetDescription(string description)
         {
-            if (description.StartsWith("<div>"))
-                description = description[MicrosoftTeamsStatics.OPENING_DIV_SIZE..];
-            if(description.EndsWith("</div>"))
-                description = description[0..^MicrosoftTeamsStatics.CLOSING_DIV_SIZE];
-            return description;
+            return description.Replace("<div>", "").Replace("</div>", "").Replace("<br>", "");
         }
 
         private string GetFooter()
         {
-            return $"<br><sup> <img src='{ GetLogoTypingHard16x16Url() }' /> { GetNugetVersion() }</sup>";
+            return $"<br><sup> <img style='width: 16px; height: 16px;' src='{ GetLogoTypingHard16x16Url() }' /> { GetNugetVersion() }</sup>";
         }
     }
 }
diff --git a/AzureDevopsTracker/Services/AzureDevopsTrackerService.cs b/AzureDevopsTracker/Services/AzureDevopsTrackerService.cs
@@ -17,12 +17,16 @@ public class AzureDevopsTrackerService : IAzureDevopsTrackerService
     {
         public readonly IWorkItemRepository _workItemRepository;
         public readonly IWorkItemAdapter _workItemAdapter;
+        public readonly IChangeLogItemRepository _changeLogItemRepository;
 
         public AzureDevopsTrackerService(
-            IWorkItemAdapter workItemAdapter, IWorkItemRepository workItemRepository)
+            IWorkItemAdapter workItemAdapter,
+            IWorkItemRepository workItemRepository,
+            IChangeLogItemRepository changeLogItemRepository)
         {
             _workItemAdapter = workItemAdapter;
             _workItemRepository = workItemRepository;
+            _changeLogItemRepository = changeLogItemRepository;
         }
 
         public async Task Create(CreateWorkItemDTO create, bool addWorkItemChange = true)
@@ -225,6 +229,12 @@ public void RemoveTimeByStateFromDataBase(WorkItem workItem)
 
         public void CheckWorkItemAvailableToChangeLog(WorkItem workItem, Fields fields)
         {
+            if (workItem.CurrentStatus != "Closed" &&
+                workItem.LastStatus == "Closed" &&
+                workItem.ChangeLogItem != null &&
+                !workItem.ChangeLogItem.WasReleased)
+                RemoveChangeLogItem(workItem);
+
             if (workItem.CurrentStatus != "Closed" ||
                 fields.ChangeLogDescription.IsNullOrEmpty())
                 return;
@@ -250,6 +260,18 @@ public ChangeLogItem ToChangeLogItem(WorkItem workItem, Fields fields)
         {
             return new ChangeLogItem(workItem.Id, workItem.Title, fields.ChangeLogDescription, workItem.Type);
         }
+
+        public void RemoveChangeLogItem(WorkItem workItem)
+        {
+            var changeLogItem = _changeLogItemRepository.GetById(workItem.ChangeLogItem?.Id).Result;
+            if (changeLogItem != null)
+            {
+                _changeLogItemRepository.Delete(changeLogItem);
+                _changeLogItemRepository.SaveChangesAsync().Wait();
+
+                workItem.RemoveChangeLogItem();
+            }
+        }
         #endregion
     }
 }
diff --git a/AzureDevopsTracker/Statics/WorkItemStatics.cs b/AzureDevopsTracker/Statics/WorkItemStatics.cs
@@ -1,8 +1,4 @@
-﻿using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace AzureDevopsTracker.Statics
+﻿namespace AzureDevopsTracker.Statics
 {
     internal class WorkItemStatics
     {
diff --git a/README.md b/README.md
@@ -36,13 +36,15 @@ The **Azure DevOps Tracker** brings automatically tracking of Workitems and will
   
   ✅ A Project
 
+ ### - Changelog: With Azure DevOps Tracker you can easily inform what was done by your team. Actually, we have integration with Microsoft Teams and Discord!
+
  ### Possibility to connect to a BI Tool 📊
  ### Your creativity is the limit! 🚀
 
 
 # Installation
 ```c#
-PM > Install-Package AzureDevOpsTracker -Version 1.0.1
+PM > Install-Package AzureDevOpsTracker
 ``` 
 For more instructions and examples, go to our [Wiki](https://github.com/typinghard/azure-devops-tracker/wiki). 
  - [English](https://github.com/typinghard/azure-devops-tracker/wiki/English) 🇺🇸

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ public class WorkItem : Entity`
`31`	`31`	`private readonly List<TimeByState> _timeByState;`
`32`	`32`	`public IReadOnlyCollection<TimeByState> TimeByStates => _timeByState;`
`33`	`33`	`public string CurrentStatus => _workItemsChanges?.OrderBy(x => x.CreatedAt)?.LastOrDefault()?.NewState;`
	`34`	`+ public string LastStatus => _workItemsChanges?.OrderBy(x => x.CreatedAt)?.ToList()?.Skip(1)?.LastOrDefault()?.OldState;`
`34`	`35`
`35`	`36`	`private WorkItem()`
`36`	`37`	`{`
`@@ -119,6 +120,11 @@ public void ClearTimesByState()`
`119`	`120`	`_timeByState.Clear();`
`120`	`121`	`}`
`121`	`122`
	`123`	`+ public void RemoveChangeLogItem()`
	`124`	`+ {`
	`125`	`+ ChangeLogItem = null;`
	`126`	`+ }`
	`127`	`+`
`122`	`128`	`public void VinculateChangeLogItem(ChangeLogItem changeLogItem)`
`123`	`129`	`{`
`124`	`130`	`if (changeLogItem == null)`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,18 @@`
`1`	`1`	`using System;`
`2`		`-using System.Collections.Generic;`
`3`		`-using System.Text;`
	`2`	`+using System.Text.RegularExpressions;`
`4`	`3`
`5`	`4`	`namespace AzureDevopsTracker.Helpers`
`6`	`5`	`{`
`7`	`6`	`internal static class RawTextHelper`
`8`	`7`	`{`
	`8`	`+ public static string HtmlToRawText(this string source)`
	`9`	`+ {`
	`10`	`+ source = source.Replace("</div>", "\n");`
	`11`	`+ source = source.Replace("<li>", "\n• ");`
	`12`	`+ source = Regex.Replace(source, "<.?>\|&.?;", string.Empty, RegexOptions.Compiled, TimeSpan.FromMilliseconds(250));`
	`13`	`+ source = source.Trim().EndsWith(".") ? source[0..^1] : source.Trim();`
	`14`	`+`
	`15`	`+ return source;`
	`16`	`+ }`
`9`	`17`	`}`
`10`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,54 +66,41 @@ private string GetText(ChangeLog changeLog)`
`66`	`66`	`{`
`67`	`67`	`if (changeLog == null \|\| !changeLog.ChangeLogItems.Any()) return string.Empty;`
`68`	`68`
`69`		`- StringBuilder text = new StringBuilder();`
`70`		`- text.Append(GetWorkItemsDescriptionSection("Features", changeLog.ChangeLogItems.Where(x => x.WorkItemType != WorkItemStatics.WORKITEM_TYPE_BUG)));`
`71`		`- text.Append(GetWorkItemsDescriptionSection("Correções", changeLog.ChangeLogItems.Where(x => x.WorkItemType == WorkItemStatics.WORKITEM_TYPE_BUG)));`
	`69`	`+ StringBuilder text = new();`
	`70`	`+ text.AppendLine(GetWorkItemsDescriptionSection("Features", changeLog.ChangeLogItems.Where(x => x.WorkItemType != WorkItemStatics.WORKITEM_TYPE_BUG)));`
	`71`	`+ text.AppendLine(GetWorkItemsDescriptionSection("Correções", changeLog.ChangeLogItems.Where(x => x.WorkItemType == WorkItemStatics.WORKITEM_TYPE_BUG)));`
`72`	`72`
`73`		`- text.Append(GetFooter());`
	`73`	`+ text.AppendLine(GetFooter());`
`74`	`74`	`return text.ToString();`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`private string GetWorkItemsDescriptionSection(string sectionName, IEnumerable<ChangeLogItem> changeLogItems)`
`78`	`78`	`{`
`79`		`- StringBuilder text = new StringBuilder();`
	`79`	`+ StringBuilder text = new();`
`80`	`80`	`if (!changeLogItems.Any()) return string.Empty;`
`81`	`81`
`82`		`- text.Append("<br>");`
`83`		`- text.AppendLine("\n");`
`84`		`-`
`85`		`- text.Append($"\n # { sectionName }\n");`
	`82`	`+ text.AppendLine($"\n# { sectionName }\n");`
`86`	`83`	`foreach (var workItem in changeLogItems)`
`87`		`- {`
`88`		`- text.Append(GetWorkItemDescriptionLine(workItem));`
`89`		`- }`
	`84`	`+ text.AppendLine(GetWorkItemDescriptionLine(workItem));`
`90`	`85`
`91`		`- text.Append("<br>");`
`92`	`86`	`text.AppendLine("\n");`
`93`	`87`	`return text.ToString();`
`94`	`88`	`}`
`95`	`89`
`96`	`90`	`private string GetWorkItemDescriptionLine(ChangeLogItem workItem)`
`97`	`91`	`{`
`98`	`92`	`var description = GetDescription(workItem.Description);`
`99`		`- var descriptionLine = $"<em>{ workItem.WorkItemId }</em> - { description }";`
`100`		`- if (description.Length > MicrosoftTeamsStatics.TEXT_SIZE_TO_BREAK_LINE)`
`101`		`- return $"<br>{ descriptionLine }<br>";`
`102`		`- return descriptionLine;`
	`93`	`+ return $"<em>{ workItem.WorkItemId }</em> - { description } <br>";`
`103`	`94`	`}`
`104`	`95`
`105`	`96`	`private string GetDescription(string description)`
`106`	`97`	`{`
`107`		`- if (description.StartsWith("<div>"))`
`108`		`- description = description[MicrosoftTeamsStatics.OPENING_DIV_SIZE..];`
`109`		`- if(description.EndsWith("</div>"))`
`110`		`- description = description[0..^MicrosoftTeamsStatics.CLOSING_DIV_SIZE];`
`111`		`- return description;`
	`98`	`+ return description.Replace("<div>", "").Replace("</div>", "").Replace("<br>", "");`
`112`	`99`	`}`
`113`	`100`
`114`	`101`	`private string GetFooter()`
`115`	`102`	`{`
`116`		`- return $"<br><sup> <img src='{ GetLogoTypingHard16x16Url() }' /> { GetNugetVersion() }</sup>";`
	`103`	`+ return $"<br><sup> <img style='width: 16px; height: 16px;' src='{ GetLogoTypingHard16x16Url() }' /> { GetNugetVersion() }</sup>";`
`117`	`104`	`}`
`118`	`105`	`}`
`119`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,4 @@`
`1`		`-using System;`
`2`		`-using System.Collections.Generic;`
`3`		`-using System.Text;`
`4`		`-`
`5`		`-namespace AzureDevopsTracker.Statics`
	`1`	`+namespace AzureDevopsTracker.Statics`
`6`	`2`	`{`
`7`	`3`	`internal class WorkItemStatics`
`8`	`4`	`{`