Added shout outs

Author: Jake Ginnivan

src/GitReleaseNotes.Tests/IssueTrackers/GitHub/GitHubIssueTrackerTests.cs

@@ -7,6 +7,7 @@
 using LibGit2Sharp;
 using NSubstitute;
 using Octokit;
+using Shouldly;
 using Xunit;
 using Xunit.Extensions;
 
@@ -50,13 +51,21 @@ public void CreatesReleaseNotesForClosedGitHubIssues()
                         Number = 1,
                         Title = "Issue Title",
                         Labels = new Collection<Label>(),
-                        ClosedAt = DateTimeOffset.Now
+                        ClosedAt = DateTimeOffset.Now,
+                        PullRequest = new PullRequest(),
+                        User = new User
+                        {
+                            Login = "User",
+                            Name = "Foo",
+                            Url = "http://github.com/foo"
+                        }
                     }
                 }.AsReadOnly()));
 
             var closedIssues = _sut.GetClosedIssues(DateTimeOffset.Now.AddDays(-2));
-
-            Assert.Equal("Issue Title", closedIssues.Single().Title);
+            var onlineIssue = closedIssues.Single();
+            onlineIssue.Title.ShouldBe("Issue Title");
+            onlineIssue.Contributors.ShouldContain(c => c.Username == "User" && c.Name == "Foo" && c.Url == "http://github.com/foo");
         }
 
         [Fact]
@@ -65,7 +74,7 @@ public void ErrorLoggedWhenRepoIsNotSpecified()
             _arguments.Repo = null;
             var result = _sut.VerifyArgumentsAndWriteErrorsToConsole();
 
-            Assert.False(result);
+            result.ShouldBe(false);
             _log.Received().WriteLine("GitHub repository name must be specified [/Repo .../...]");
         }
 
@@ -81,11 +90,11 @@ public void RepositoryMustBeInCorrectFormat(string repo, bool success)
 
             if (success)
             {
-                Assert.True(result);
+                result.ShouldBe(true);
             }
             else
             {
-                Assert.False(result);
+                result.ShouldBe(false);
                 _log.Received().WriteLine("GitHub repository name should be in format Organisation/RepoName");
             }
         }
@@ -97,9 +106,7 @@ public void CanGetRepoFromRemote()
 
             _sut.GetClosedIssues(DateTimeOffset.Now.AddDays(-2));
 
-            _issuesClient
-                .Received()
-                .GetForRepository("Org", "Repo.With.Dots", Arg.Any<RepositoryIssueRequest>());
+            _issuesClient.Received().GetForRepository("Org", "Repo.With.Dots", Arg.Any<RepositoryIssueRequest>());
         }
 
         [Fact]
@@ -110,7 +117,7 @@ public void MustSpecifyVersionWhenPublishFlagIsSet()
             _arguments.Publish = true;
             var result = _sut.VerifyArgumentsAndWriteErrorsToConsole();
 
-            Assert.False(result);
+            result.ShouldBe(false);
             _log.Received().WriteLine("You must specifiy the version [/Version ...] (will be tag) when using the /Publish flag");
         }
 
@@ -122,10 +129,8 @@ public void CanCreateReleaseOnGitHub()
             const string releaseNotesOutput = " - A thingy was fixed";
             _sut.PublishRelease(releaseNotesOutput);
 
-            _gitHubClient.Release
-                .Received()
-                .CreateRelease("Foo", "Baz",
-                    Arg.Is<ReleaseUpdate>(r => r.TagName == "1.2.0" && r.Body == releaseNotesOutput && r.Name == "1.2.0"));
+            var releaseUpdateSpec = Arg.Is<ReleaseUpdate>(r => r.TagName == "1.2.0" && r.Body == releaseNotesOutput && r.Name == "1.2.0");
+            _gitHubClient.Release.Received().CreateRelease("Foo", "Baz", releaseUpdateSpec);
         }
     }
 }

src/GitReleaseNotes.Tests/ReleaseNotesGeneratorTests.ApproveSimpleTests.approved.txt

@@ -1,4 +1,4 @@
- - Issue 1 [#1](http://github.com/org/repo/issues/1)
+ - Issue 1 [#1](http://github.com/org/repo/issues/1) contributed by Foo Bar ([@foo](http://url.com/foo))
  - Issue 1
 
 Commits: 12345678...67890123

src/GitReleaseNotes.Tests/ReleaseNotesGeneratorTests.cs

@@ -27,8 +27,8 @@ public void ApproveSimpleTests()
             {
                 new SemanticRelease("", null, new List<ReleaseNoteItem>
                 {
-                    new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"), new string[0], DateTime.Now),
-                    new ReleaseNoteItem("Issue 1", null, null, new string[0], DateTime.Now)
+                    new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"), new string[0], DateTime.Now, new[]{ new Contributor("Foo Bar", "@foo", "http://url.com/foo") }),
+                    new ReleaseNoteItem("Issue 1", null, null, new string[0], DateTime.Now, new Contributor[0])
                 }, new ReleaseDiffInfo
                 {
                     BeginningSha = "12345678",
@@ -52,8 +52,8 @@ public void ApproveSimpleUpdateTests()
             {
                 new SemanticRelease("", null, new List<ReleaseNoteItem>
                 {
-                    new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"), new string[0], DateTime.Now.AddDays(-2)),
-                    new ReleaseNoteItem("Issue 2", "#2", new Uri("http://github.com/org/repo/issues/2"), new string[0], DateTime.Now)
+                    new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"), new string[0], DateTime.Now.AddDays(-2), new Contributor[0]),
+                    new ReleaseNoteItem("Issue 2", "#2", new Uri("http://github.com/org/repo/issues/2"), new string[0], DateTime.Now, new Contributor[0])
                 }, new ReleaseDiffInfo
                 {
                     BeginningSha = "12345678",
@@ -66,7 +66,8 @@ public void ApproveSimpleUpdateTests()
             {
                 new SemanticRelease("", previousReleaseNotesGeneratedOn, new List<ReleaseNoteItem>
                 {
-                    new ReleaseNoteItem("Customised title for Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"), new string[0], previousReleaseNotesGeneratedOn)
+                    new ReleaseNoteItem("Customised title for Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"), new string[0], previousReleaseNotesGeneratedOn,
+                        new Contributor[0])
                 }, new ReleaseDiffInfo
                 {
                     BeginningSha = "asd39424",
@@ -89,7 +90,7 @@ public void ItemIsCategorised()
                 new SemanticRelease("", null, new List<ReleaseNoteItem>
                 {
                     new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"),
-                        new[] {"feature"}, DateTimeOffset.Now)
+                        new[] {"feature"}, DateTimeOffset.Now, new Contributor[0])
                 }, new ReleaseDiffInfo
                 {
                     BeginningSha = "12345678",
@@ -114,7 +115,7 @@ public void MultipleReleases()
                 new SemanticRelease("", null, new List<ReleaseNoteItem>
                 {
                     new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"),
-                        new[] {"feature"}, DateTimeOffset.Now)
+                        new[] {"feature"}, DateTimeOffset.Now, new Contributor[0])
                 }, new ReleaseDiffInfo
                 {
                     BeginningSha = "12345678",
@@ -123,9 +124,9 @@ public void MultipleReleases()
                 new SemanticRelease("1.2.0", new DateTimeOffset(2013, 12, 06, 0,0,0, new TimeSpan()), new List<ReleaseNoteItem>
                 {
                     new ReleaseNoteItem("Issue 2", "#2", new Uri("http://github.com/org/repo/issues/2"),
-                        new[] {"feature"}, DateTimeOffset.Now),
+                        new[] {"feature"}, DateTimeOffset.Now, new Contributor[0]),
                         new ReleaseNoteItem("Issue 3", "#3", new Uri("http://github.com/org/repo/issues/3"),
-                        new[] {"bug"}, DateTimeOffset.Now)
+                        new[] {"bug"}, DateTimeOffset.Now, new Contributor[0])
                 }, new ReleaseDiffInfo
                 {
                     BeginningSha = "asdsadaf",
@@ -149,7 +150,7 @@ public void LabelOfBugIsCategorisedAsFix()
             {
                 new SemanticRelease("", null, new List<ReleaseNoteItem>
                 {
-                    new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"), new[] {"bug"}, DateTimeOffset.Now)
+                    new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"), new[] {"bug"}, DateTimeOffset.Now, new Contributor[0])
                 }, new ReleaseDiffInfo
                 {
                     BeginningSha = "12345678",
@@ -175,7 +176,7 @@ public void AdditionalCategoriesCanBeSpecifiedOnCommandLine()
                 new SemanticRelease("", null, new List<ReleaseNoteItem>
                 {
                     new ReleaseNoteItem("Issue 1", "#1", new Uri("http://github.com/org/repo/issues/1"),
-                        new[] {"internal refactoring"}, DateTimeOffset.Now)
+                        new[] {"internal refactoring"}, DateTimeOffset.Now, new Contributor[0])
                 }, new ReleaseDiffInfo
                 {
                     BeginningSha = "12345678",

src/GitReleaseNotes/Contributor.cs

@@ -0,0 +1,16 @@
+namespace GitReleaseNotes
+{
+    public class Contributor
+    {
+        public Contributor(string name, string username, string url)
+        {
+            Name = name;
+            Username = username;
+            Url = url;
+        }
+
+        public string Name { get; private set; }
+        public string Username { get; private set; }
+        public string Url { get; private set; }
+    }
+}

src/GitReleaseNotes/GenerationStrategy/ByClosedIssues.cs

@@ -20,7 +20,7 @@ public SemanticReleaseNotes GetReleaseNotes(Dictionary<ReleaseInfo, List<Commit>
                     .Where(i => 
                         (reloadLocal.Key.When == null || i.DateClosed < reloadLocal.Key.When) && 
                         (reloadLocal.Key.PreviousReleaseDate == null || i.DateClosed > reloadLocal.Key.PreviousReleaseDate))
-                    .Select(i => new ReleaseNoteItem(i.Title, i.Id, i.HtmlUrl, i.Labels, i.DateClosed))
+                    .Select(i => new ReleaseNoteItem(i.Title, i.Id, i.HtmlUrl, i.Labels, i.DateClosed, i.Contributors))
                     .ToList();
                 semanticReleases.Add(new SemanticRelease(release.Key.Name, release.Key.When, releaseNoteItems, new ReleaseDiffInfo
                 {

src/GitReleaseNotes/GenerationStrategy/ByMentionedCommits.cs

@@ -55,7 +55,7 @@ public SemanticReleaseNotes GetReleaseNotes(Dictionary<ReleaseInfo, List<Commit>
                 var releaseNoteItems = r.IssuesForRelease.Select(i =>
                 {
                     var labels = i.Labels ?? new string[0];
-                    return new ReleaseNoteItem(i.Title, string.Format("{0}", i.Id), i.HtmlUrl, labels, i.DateClosed);
+                    return new ReleaseNoteItem(i.Title, string.Format("{0}", i.Id), i.HtmlUrl, labels, i.DateClosed, i.Contributors);
                 }).ToList();
                 return new SemanticRelease(r.ReleaseInfo.Name, r.ReleaseInfo.When, releaseNoteItems, new ReleaseDiffInfo
                 {

src/GitReleaseNotes/GitReleaseNotes.csproj

@@ -59,6 +59,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="ArgumentVerifier.cs" />
+    <Compile Include="Contributor.cs" />
     <Compile Include="GenerationStrategy\ByClosedIssues.cs" />
     <Compile Include="GenerationStrategy\ByMentionedCommits.cs" />
     <Compile Include="CommitGrouper.cs" />

src/GitReleaseNotes/IssueTrackers/GitHub/GitHubIssueTracker.cs

@@ -126,14 +126,16 @@ public IEnumerable<OnlineIssue> GetClosedIssues(DateTimeOffset? since)
                 State = ItemState.Closed
             });
             var readOnlyList = forRepository.Result;
+
             return readOnlyList.Select(i => new OnlineIssue
             {
                 HtmlUrl = i.HtmlUrl,
                 Id = i.Number.ToString(CultureInfo.InvariantCulture),
                 IssueType = i.PullRequest == null ? IssueType.Issue : IssueType.PullRequest,
                 Labels = i.Labels.Select(l => l.Name).ToArray(),
                 Title = i.Title,
-                DateClosed = i.ClosedAt.Value
+                DateClosed = i.ClosedAt.Value,
+                Contributors = i.PullRequest == null ? new Contributor[0] : new[] { new Contributor(i.User.Name, i.User.Login, i.User.Url) }
             });
         }
     }

src/GitReleaseNotes/IssueTrackers/OnlineIssue.cs

@@ -9,6 +9,7 @@ public class OnlineIssue
         public Uri HtmlUrl { get; set; }
         public string Title { get; set; }
         public string[] Labels { get; set; }
+        public Contributor[] Contributors { get; set; }
         public DateTimeOffset DateClosed { get; set; }
     }
 }

src/GitReleaseNotes/ReleaseNoteItem.cs

@@ -9,14 +9,16 @@ public class ReleaseNoteItem
         private readonly Uri _htmlUrl;
         private readonly string[] _tags;
         private readonly DateTimeOffset? _resolvedOn;
+        private Contributor[] _contributors;
 
-        public ReleaseNoteItem(string title, string issueNumber, Uri htmlUrl, string[] tags, DateTimeOffset? resolvedOn)
+        public ReleaseNoteItem(string title, string issueNumber, Uri htmlUrl, string[] tags, DateTimeOffset? resolvedOn, Contributor[] contributors)
         {
             _title = title;
             _issueNumber = issueNumber;
             _htmlUrl = htmlUrl;
             _tags = tags ?? new string[0];
             _resolvedOn = resolvedOn;
+            _contributors = contributors;
         }
 
         public string Title
@@ -43,5 +45,7 @@ public DateTimeOffset? ResolvedOn
         {
             get { return _resolvedOn; }
         }
+
+        public Contributor[] Contributors { get { return _contributors; }}
     }
 }