(GH-21) Expanded YAML Configuration

gep13 · gep13 · commit 2955a784fc0b · 2015-03-12T22:03:57.000Z
- To include options for creating release notes
- Options for exporting release notes
- Changed Tests to include changing FakeRepo to FakeRepository
diff --git a/Source/GitHubReleaseManager.Cli/Program.cs b/Source/GitHubReleaseManager.Cli/Program.cs
@@ -82,7 +82,7 @@ private static int Main(string[] args)
                             var exportSubOptions = baseSubOptions as ExportSubOptions;
                             if (exportSubOptions != null)
                             {
-                                result = ExportReleasesAsync(exportSubOptions).Result;
+                                result = ExportReleasesAsync(exportSubOptions, fileSystem).Result;
                             }
                         }
 
@@ -170,13 +170,14 @@ private static async Task<int> CloseAndPublishReleaseAsync(PublishSubOptions sub
             }
         }
 
-        private static async Task<int> ExportReleasesAsync(ExportSubOptions subOptions)
+        private static async Task<int> ExportReleasesAsync(ExportSubOptions subOptions, IFileSystem fileSystem)
         {
             try
             {
                 var github = subOptions.CreateGitHubClient();
+                var configuration = ConfigurationProvider.Provide(subOptions.TargetPath, fileSystem);
 
-                var releasesMarkdown = await ExportReleases(github, subOptions.RepositoryOwner, subOptions.RepositoryName);
+                var releasesMarkdown = await ExportReleases(github, subOptions.RepositoryOwner, subOptions.RepositoryName, configuration);
 
                 using (var sw = new StreamWriter(File.Open(subOptions.FileOutputPath, FileMode.OpenOrCreate)))
                 {
@@ -220,9 +221,9 @@ private static async Task CreateRelease(GitHubClient github, string owner, strin
             }
         }
 
-        private static async Task<string> ExportReleases(GitHubClient github, string owner, string repository)
+        private static async Task<string> ExportReleases(GitHubClient github, string owner, string repository, Config configuration)
         {
-            var releaseNotesExporter = new ReleaseNotesExporter(new DefaultGitHubClient(github, owner, repository));
+            var releaseNotesExporter = new ReleaseNotesExporter(new DefaultGitHubClient(github, owner, repository), configuration);
 
             var result = await releaseNotesExporter.GetReleases();
 
diff --git a/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SingularCommitsNoIssues.approved.txt b/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SingularCommitsNoIssues.approved.txt
@@ -1,4 +1,4 @@
-﻿As part of this release we had [1 commit](https://github.com/TestUser/FakeRepo/commits/1.2.3).
+﻿As part of this release we had [1 commit](https://github.com/TestUser/FakeRepository/commits/1.2.3).
 
 
 ### Where to get it
diff --git a/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SingularCommitsSingularIssues.approved.txt b/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SingularCommitsSingularIssues.approved.txt
@@ -1,4 +1,4 @@
-﻿As part of this release we had [1 commit](https://github.com/TestUser/FakeRepo/commits/1.2.3) which resulted in [1 issue](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) being closed.
+﻿As part of this release we had [1 commit](https://github.com/TestUser/FakeRepository/commits/1.2.3) which resulted in [1 issue](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) being closed.
 
 
 __Bug__
diff --git a/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SingularCommitsSomeIssues.approved.txt b/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SingularCommitsSomeIssues.approved.txt
@@ -1,4 +1,4 @@
-﻿As part of this release we had [1 commit](https://github.com/TestUser/FakeRepo/commits/1.2.3) which resulted in [3 issues](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) being closed.
+﻿As part of this release we had [1 commit](https://github.com/TestUser/FakeRepository/commits/1.2.3) which resulted in [3 issues](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) being closed.
 
 
 __Bug__
diff --git a/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SomeCommitsNoIssues.approved.txt b/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SomeCommitsNoIssues.approved.txt
@@ -1,4 +1,4 @@
-﻿As part of this release we had [5 commits](https://github.com/TestUser/FakeRepo/commits/1.2.3).
+﻿As part of this release we had [5 commits](https://github.com/TestUser/FakeRepository/commits/1.2.3).
 
 
 ### Where to get it
diff --git a/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SomeCommitsSingularIssues.approved.txt b/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SomeCommitsSingularIssues.approved.txt
@@ -1,4 +1,4 @@
-﻿As part of this release we had [5 commits](https://github.com/TestUser/FakeRepo/commits/1.2.3) which resulted in [1 issue](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) being closed.
+﻿As part of this release we had [5 commits](https://github.com/TestUser/FakeRepository/commits/1.2.3) which resulted in [1 issue](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) being closed.
 
 
 __Bug__
diff --git a/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SomeCommitsSomeIssues.approved.txt b/Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.SomeCommitsSomeIssues.approved.txt
@@ -1,4 +1,4 @@
-﻿As part of this release we had [5 commits](https://github.com/TestUser/FakeRepo/commits/1.2.3) which resulted in [3 issues](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) being closed.
+﻿As part of this release we had [5 commits](https://github.com/TestUser/FakeRepository/commits/1.2.3) which resulted in [3 issues](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) being closed.
 
 
 __Bug__
diff --git a/Source/GitHubReleaseManager/Configuration/Config.cs b/Source/GitHubReleaseManager/Configuration/Config.cs
@@ -7,14 +7,30 @@
 namespace GitHubReleaseManager.Configuration
 {
     using System.Collections.Generic;
-
     using YamlDotNet.Serialization;
 
     public class Config
     {
         public Config()
         {
-            this.ExportRegex = @"### Where to get it(\r\n)*You can .*\)";
+            this.Create = new CreateConfig
+                              {
+                                  IncludeFooter = true,
+                                  FooterHeading = "Where to get it",
+                                  FooterContent = "You can download this release from [chocolatey](https://chocolatey.org/packages/ChocolateyGUI/{milestone})",
+                                  FooterIncludesMilestone = true,
+                                  MilestoneReplaceText = "{milestone}"
+                              };
+
+            this.Export = new ExportConfig
+                              {
+                                  IncludeCreatedDateInTitle = true,
+                                  CreatedDateStringFormat = "MMMM dd, yyyy",
+                                  PerformRegexRemoval = true,
+                                  RegexText = @"### Where to get it(\r\n)*You can .*\)",
+                                  IsMultilineRegex = true
+                              };
+
             this.IssueLabelsInclude = new List<string>
                                    {
                                        "Bug",
@@ -28,8 +44,11 @@ public Config()
                                    };
         }
 
-        [YamlMember(Alias = "export-regex")]
-        public string ExportRegex { get; set; }
+        [YamlMember(Alias = "create")]
+        public CreateConfig Create { get; private set; }
+
+        [YamlMember(Alias = "export")]
+        public ExportConfig Export { get; private set; }
 
         [YamlMember(Alias = "issue-labels-include")]
         public IList<string> IssueLabelsInclude { get; private set; }
diff --git a/Source/GitHubReleaseManager/Configuration/ConfigSerializer.cs b/Source/GitHubReleaseManager/Configuration/ConfigSerializer.cs
@@ -32,6 +32,7 @@ public static void Write(Config config, TextWriter writer)
             serializer.Serialize(writer, config);
         }
 
+        // TODO: Need to expand this to include all options
         public static void WriteSample(TextWriter writer)
         {
             if (writer == null)
diff --git a/Source/GitHubReleaseManager/Configuration/CreateConfig.cs b/Source/GitHubReleaseManager/Configuration/CreateConfig.cs
@@ -0,0 +1,28 @@
+﻿//-----------------------------------------------------------------------
+// <copyright file="CreateConfig.cs" company="gep13">
+//     Copyright (c) gep13. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace GitHubReleaseManager.Configuration
+{
+    using YamlDotNet.Serialization;
+
+    public class CreateConfig
+    {
+        [YamlMember(Alias = "include-footer")]
+        public bool IncludeFooter { get; set; }
+
+        [YamlMember(Alias = "footer-heading")]
+        public string FooterHeading { get; set; }
+
+        [YamlMember(Alias = "footer-content")]
+        public string FooterContent { get; set; }
+
+        [YamlMember(Alias = "footer-includes-milestone")]
+        public bool FooterIncludesMilestone { get; set; }
+
+        [YamlMember(Alias = "milestone-replace-text")]
+        public string MilestoneReplaceText { get; set; }
+    }
+}
diff --git a/Source/GitHubReleaseManager/Configuration/ExportConfig.cs b/Source/GitHubReleaseManager/Configuration/ExportConfig.cs
@@ -0,0 +1,28 @@
+﻿//-----------------------------------------------------------------------
+// <copyright file="ExportConfig.cs" company="gep13">
+//     Copyright (c) gep13. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace GitHubReleaseManager.Configuration
+{
+    using YamlDotNet.Serialization;
+
+    public class ExportConfig
+    {
+        [YamlMember(Alias = "include-created-date-in-title")]
+        public bool IncludeCreatedDateInTitle { get; set; }
+
+        [YamlMember(Alias = "created-date-string-format")]
+        public string CreatedDateStringFormat { get; set; }
+
+        [YamlMember(Alias = "perform-regex-removal")]
+        public bool PerformRegexRemoval { get; set; }
+
+        [YamlMember(Alias = "regex-text")]
+        public string RegexText { get; set; }
+
+        [YamlMember(Alias = "multiline-regex")]
+        public bool IsMultilineRegex { get; set; }
+    }
+}
diff --git a/Source/GitHubReleaseManager/GitHubReleaseManager.csproj b/Source/GitHubReleaseManager/GitHubReleaseManager.csproj
@@ -62,6 +62,8 @@
     <Compile Include="Configuration\Config.cs" />
     <Compile Include="Configuration\ConfigSerializer.cs" />
     <Compile Include="Configuration\ConfigurationProvider.cs" />
+    <Compile Include="Configuration\CreateConfig.cs" />
+    <Compile Include="Configuration\ExportConfig.cs" />
     <Compile Include="DefaultGitHubClient.cs" />
     <Compile Include="GlobalSuppressions.cs" />
     <Compile Include="Helpers\FileSystem.cs" />
diff --git a/Source/GitHubReleaseManager/ReleaseNotesBuilder.cs b/Source/GitHubReleaseManager/ReleaseNotesBuilder.cs
@@ -78,11 +78,14 @@ public async Task<string> BuildReleaseNotes()
 
             this.AddIssues(stringBuilder, issues);
 
-            await this.AddFooter(stringBuilder);
+            if (this.configuration.Create.IncludeFooter)
+            {
+                this.AddFooter(stringBuilder);
+            }
 
             return stringBuilder.ToString();
         }
-        
+
         private static void Append(IEnumerable<Issue> issues, string label, StringBuilder stringBuilder)
         {
             var features = issues.Where(x => x.Labels.Any(l => l.Name == label)).ToList();
@@ -144,26 +147,22 @@ private string GetCommitsLink(Milestone previousMilestone)
 
             return string.Format(CultureInfo.InvariantCulture, "https://github.com/{0}/{1}/compare/{2}...{3}", this.user, this.repository, previousMilestone.Title, this.targetMilestone.Title);
         }
-        
-        private async Task AddFooter(StringBuilder stringBuilder)
+
+        private void AddFooter(StringBuilder stringBuilder)
         {
-            var file = new FileInfo("footer.md");
+            stringBuilder.AppendLine(string.Format(CultureInfo.InvariantCulture, "### {0}", this.configuration.Create.FooterHeading));
 
-            if (!file.Exists)
-            {
-                file = new FileInfo("footer.txt");
-            }
+            var footerContent = this.configuration.Create.FooterContent;
 
-            if (!file.Exists)
+            if (this.configuration.Create.FooterIncludesMilestone)
             {
-                stringBuilder.AppendFormat(@"### Where to get it{0}You can download this release from [chocolatey](https://chocolatey.org/packages/ChocolateyGUI/{1})", Environment.NewLine, this.milestoneTitle);
-                return;
+                if (!string.IsNullOrEmpty(this.configuration.Create.MilestoneReplaceText))
+                {
+                    footerContent = footerContent.Replace(this.configuration.Create.MilestoneReplaceText, this.milestoneTitle);
+                }
             }
 
-            using (var reader = file.OpenText())
-            {
-                stringBuilder.Append(await reader.ReadToEndAsync());
-            }
+            stringBuilder.Append(footerContent);
         }
 
         private void LoadMilestones()
diff --git a/Source/GitHubReleaseManager/ReleaseNotesExporter.cs b/Source/GitHubReleaseManager/ReleaseNotesExporter.cs
@@ -11,13 +11,17 @@ namespace GitHubReleaseManager
     using System.Text.RegularExpressions;
     using System.Threading.Tasks;
 
+    using GitHubReleaseManager.Configuration;
+
     public class ReleaseNotesExporter
     {
         private IGitHubClient gitHubClient;
+        private Config configuration;
 
-        public ReleaseNotesExporter(IGitHubClient gitHubClient)
+        public ReleaseNotesExporter(IGitHubClient gitHubClient, Config configuration)
         {
             this.gitHubClient = gitHubClient;
+            this.configuration = configuration;
         }
 
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "Not appropriate.")]
@@ -31,13 +35,28 @@ public async Task<string> GetReleases()
             {
                 foreach (var release in releases)
                 {
-                    stringBuilder.AppendLine(string.Format("## {0} ({1})", release.TagName, release.CreatedAt.ToString("MMMM dd, yyyy")));
+                    if (this.configuration.Export.IncludeCreatedDateInTitle)
+                    {
+                        stringBuilder.AppendLine(string.Format("## {0} ({1})", release.TagName, release.CreatedAt.ToString(this.configuration.Export.CreatedDateStringFormat)));
+                    }
+                    else
+                    {
+                        stringBuilder.AppendLine(string.Format("## {0}", release.TagName));
+                    }
+                    
                     stringBuilder.AppendLine(Environment.NewLine);
 
-                    var regexPattern = new Regex(@"### Where to get it(\r\n)*You can .*\)", RegexOptions.Multiline);
-                    var replacement = string.Empty;
-                    var replacedBody = regexPattern.Replace(release.Body, replacement);
-                    stringBuilder.AppendLine(replacedBody);
+                    if (this.configuration.Export.PerformRegexRemoval)
+                    {
+                        var regexPattern = new Regex(this.configuration.Export.RegexText, this.configuration.Export.IsMultilineRegex ? RegexOptions.Multiline : RegexOptions.Singleline);
+                        var replacement = string.Empty;
+                        var replacedBody = regexPattern.Replace(release.Body, replacement);
+                        stringBuilder.AppendLine(replacedBody);
+                    }
+                    else
+                    {
+                        stringBuilder.AppendLine(release.Body);
+                    }
                 }
             }
 

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ private static int Main(string[] args)`
`82`	`82`	`var exportSubOptions = baseSubOptions as ExportSubOptions;`
`83`	`83`	`if (exportSubOptions != null)`
`84`	`84`	`{`
`85`		`- result = ExportReleasesAsync(exportSubOptions).Result;`
	`85`	`+ result = ExportReleasesAsync(exportSubOptions, fileSystem).Result;`
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`
`@@ -170,13 +170,14 @@ private static async Task<int> CloseAndPublishReleaseAsync(PublishSubOptions sub`
`170`	`170`	`}`
`171`	`171`	`}`
`172`	`172`
`173`		`- private static async Task<int> ExportReleasesAsync(ExportSubOptions subOptions)`
	`173`	`+ private static async Task<int> ExportReleasesAsync(ExportSubOptions subOptions, IFileSystem fileSystem)`
`174`	`174`	`{`
`175`	`175`	`try`
`176`	`176`	`{`
`177`	`177`	`var github = subOptions.CreateGitHubClient();`
	`178`	`+ var configuration = ConfigurationProvider.Provide(subOptions.TargetPath, fileSystem);`
`178`	`179`
`179`		`- var releasesMarkdown = await ExportReleases(github, subOptions.RepositoryOwner, subOptions.RepositoryName);`
	`180`	`+ var releasesMarkdown = await ExportReleases(github, subOptions.RepositoryOwner, subOptions.RepositoryName, configuration);`
`180`	`181`
`181`	`182`	`using (var sw = new StreamWriter(File.Open(subOptions.FileOutputPath, FileMode.OpenOrCreate)))`
`182`	`183`	`{`
`@@ -220,9 +221,9 @@ private static async Task CreateRelease(GitHubClient github, string owner, strin`
`220`	`221`	`}`
`221`	`222`	`}`
`222`	`223`
`223`		`- private static async Task<string> ExportReleases(GitHubClient github, string owner, string repository)`
	`224`	`+ private static async Task<string> ExportReleases(GitHubClient github, string owner, string repository, Config configuration)`
`224`	`225`	`{`
`225`		`- var releaseNotesExporter = new ReleaseNotesExporter(new DefaultGitHubClient(github, owner, repository));`
	`226`	`+ var releaseNotesExporter = new ReleaseNotesExporter(new DefaultGitHubClient(github, owner, repository), configuration);`
`226`	`227`
`227`	`228`	`var result = await releaseNotesExporter.GetReleases();`
`228`	`229`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-As part of this release we had [1 commit](https://github.com/TestUser/FakeRepo/commits/1.2.3).`
	`1`	`+As part of this release we had [1 commit](https://github.com/TestUser/FakeRepository/commits/1.2.3).`
`2`	`2`
`3`	`3`
`4`	`4`	`### Where to get it`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-As part of this release we had [5 commits](https://github.com/TestUser/FakeRepo/commits/1.2.3).`
	`1`	`+As part of this release we had [5 commits](https://github.com/TestUser/FakeRepository/commits/1.2.3).`
`2`	`2`
`3`	`3`
`4`	`4`	`### Where to get it`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ public static void Write(Config config, TextWriter writer)`
`32`	`32`	`serializer.Serialize(writer, config);`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ // TODO: Need to expand this to include all options`
`35`	`36`	`public static void WriteSample(TextWriter writer)`
`36`	`37`	`{`
`37`	`38`	`if (writer == null)`