Display an "Add comment" box at the bottom of a PR.

github · StanleyGoldman · Feb 21, 2019 · Oct 26, 2018 · Oct 26, 2018 · Oct 26, 2018
commit abeb1b8f125e6f46bd03cc04481c35a70aae543b
diff --git a/src/GitHub.App/SampleData/CommentViewModelDesigner.cs b/src/GitHub.App/SampleData/CommentViewModelDesigner.cs
@@ -24,7 +24,9 @@ public CommentViewModelDesigner()
         public CommentEditState EditState { get; set; }
         public bool IsReadOnly { get; set; }
         public bool IsSubmitting { get; set; }
+        public bool CanCancel { get; } = true;
         public bool CanDelete { get; } = true;
+        public string CommitCaption { get; set; } = "Comment";
         public ICommentThreadViewModel Thread { get; }
         public DateTimeOffset CreatedAt => DateTime.Now.Subtract(TimeSpan.FromDays(3));
         public IActorViewModel Author { get; set; }

diff --git a/src/GitHub.App/ViewModels/CommentViewModel.cs b/src/GitHub.App/ViewModels/CommentViewModel.cs
@@ -22,7 +22,9 @@ public class CommentViewModel : ReactiveObject, ICommentViewModel
     {
         static readonly ILogger log = LogManager.ForContext<CommentViewModel>();
         readonly ICommentService commentService;
+        readonly ObservableAsPropertyHelper<bool> canCancel;
         readonly ObservableAsPropertyHelper<bool> canDelete;
+        ObservableAsPropertyHelper<string> commitCaption;
         string id;
         IActorViewModel author;
         IActorViewModel currentUser;
@@ -74,6 +76,9 @@ public CommentViewModel(ICommentService commentService)
                     (ro, body) => !ro && !string.IsNullOrWhiteSpace(body)));
             AddErrorHandler(CommitEdit);
 
+            canCancel = this.WhenAnyValue(x => x.Id)
+                .Select(id => id != null)
+                .ToProperty(this, x => x.CanCancel);
             CancelEdit = ReactiveCommand.Create(DoCancelEdit, CommitEdit.IsExecuting.Select(x => !x));
             AddErrorHandler(CancelEdit);
 
@@ -144,6 +149,9 @@ public bool IsSubmitting
             protected set => this.RaiseAndSetIfChanged(ref isSubmitting, value);
         }
 
+        /// <inheritdoc/>
+        public bool CanCancel => canCancel.Value;
+
         /// <inheritdoc/>
         public bool CanDelete => canDelete.Value;
 
@@ -154,6 +162,9 @@ public DateTimeOffset CreatedAt
             private set => this.RaiseAndSetIfChanged(ref createdAt, value);
         }
 
+        /// <inheritdoc/>
+        public string CommitCaption => commitCaption.Value;
+
         /// <inheritdoc/>
         public ICommentThreadViewModel Thread
         {
@@ -200,6 +211,8 @@ public Task InitializeAsync(
             CreatedAt = comment?.CreatedAt ?? DateTimeOffset.MinValue;
             WebUrl = comment?.Url != null ? new Uri(comment.Url) : null;
 
+            commitCaption = GetCommitCaptionObservable().ToProperty(this, x => x.CommitCaption);
+
             return Task.CompletedTask;
         }
 
@@ -208,6 +221,12 @@ protected void AddErrorHandler(ReactiveCommand command)
             command.ThrownExceptions.Subscribe(x => ErrorMessage = x.Message);
         }
 
+        protected virtual IObservable<string> GetCommitCaptionObservable()
+        {
+            return this.WhenAnyValue(x => x.Id)
+                .Select(x => x == null ? Resources.Comment : Resources.UpdateComment);
+        }
+
         async Task DoDelete()
         {
             if (commentService.ConfirmCommentDelete())

diff --git a/src/GitHub.App/ViewModels/Documents/IIssueishCommentViewModel.cs b/src/GitHub.App/ViewModels/Documents/IIssueishCommentViewModel.cs
@@ -0,0 +1,45 @@
+using System.Reactive;
+using System.Threading.Tasks;
+using GitHub.Models;
+using ReactiveUI;
+
+namespace GitHub.ViewModels.Documents
+{
+    /// <summary>
+    /// View model for comments on an issue or pull request.
+    /// </summary>
+    public interface IIssueishCommentViewModel : ICommentViewModel
+    {
+        /// <summary>
+        /// Gets a value indicating whether the comment will show a 
+        /// a button for <see cref="CloseIssueish"/>.
+        /// </summary>
+        bool CanCloseIssueish { get; }
+
+        /// <summary>
+        /// Gets a a caption for the <see cref="CloseIssueish"/> command.
+        /// </summary>
+        string CloseIssueishCaption { get; }
+
+        /// <summary>
+        /// Gets a command which when executed will close the issue or pull request.
+        /// </summary>
+        ReactiveCommand<Unit, Unit> CloseIssueish { get; }
+
+        /// <summary>
+        /// Initializes the view model with data.
+        /// </summary>
+        /// <param name="thread">The thread that the comment is a part of.</param>
+        /// <param name="currentUser">The current user.</param>
+        /// <param name="comment">The comment model. May be null.</param>
+        /// <param name="closeCaption">
+        /// The caption for the <see cref="CloseIssueish"/> command, or null if the user cannot
+        /// close the issue/pr from this comment.
+        /// </param>
+        Task InitializeAsync(
+            ICommentThreadViewModel thread,
+            ActorModel currentUser,
+            CommentModel comment,
+            string closeCaption);
+    }
+}
diff --git a/src/GitHub.App/ViewModels/Documents/IssueishCommentThreadViewModel.cs b/src/GitHub.App/ViewModels/Documents/IssueishCommentThreadViewModel.cs
diff --git a/src/GitHub.App/ViewModels/Documents/IssueishCommentViewModel.cs b/src/GitHub.App/ViewModels/Documents/IssueishCommentViewModel.cs
@@ -0,0 +1,55 @@
+using System;
+using System.ComponentModel.Composition;
+using System.Reactive;
+using System.Threading.Tasks;
+using GitHub.Models;
+using GitHub.Services;
+using ReactiveUI;
+
+namespace GitHub.ViewModels.Documents
+{
+    /// <summary>
+    /// View model for comments on an issue or pull request.
+    /// </summary>
+    [Export(typeof(IIssueishCommentViewModel))]
+    [PartCreationPolicy(CreationPolicy.NonShared)]
+    public class IssueishCommentViewModel : CommentViewModel, IIssueishCommentViewModel
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CommentViewModel"/> class.
+        /// </summary>
+        /// <param name="commentService">The comment service.</param>
+        [ImportingConstructor]
+        public IssueishCommentViewModel(ICommentService commentService)
+            : base(commentService)
+        {
+        }
+
+        /// <inheritdoc/>
+        public bool CanCloseIssueish { get; private set; }
+
+        /// <inheritdoc/>
+        public string CloseIssueishCaption { get; private set; }
+
+        /// <inheritdoc/>
+        public ReactiveCommand<Unit, Unit> CloseIssueish { get; }
+
+        /// <inheritdoc/>
+        public async Task InitializeAsync(
+            ICommentThreadViewModel thread,
+            ActorModel currentUser,
+            CommentModel comment,
+            string closeCaption)
+        {
+            await base.InitializeAsync(
+                thread,
+                currentUser,
+                comment,
+                comment == null ? CommentEditState.Editing : CommentEditState.None)
+                    .ConfigureAwait(true);
+
+            CanCloseIssueish = closeCaption != null;
+            CloseIssueishCaption = closeCaption;
+        }
+    }
+}
diff --git a/src/GitHub.App/ViewModels/Documents/PullRequestPageViewModel.cs b/src/GitHub.App/ViewModels/Documents/PullRequestPageViewModel.cs
@@ -89,8 +89,8 @@ public async Task InitializeAsync(
                         break;
                     case CommentModel comment:
                         {
-                            var vm = factory.CreateViewModel<ICommentViewModel>();
-                            await vm.InitializeAsync(this, currentUser, comment, CommentEditState.None).ConfigureAwait(true);
+                            var vm = factory.CreateViewModel<IIssueishCommentViewModel>();
+                            await vm.InitializeAsync(this, currentUser, comment, null).ConfigureAwait(true);
                             timeline.Add(vm);
                         }
                         break;
@@ -102,6 +102,14 @@ public async Task InitializeAsync(
                 timeline.Add(new CommitSummariesViewModel(commits));
             }
 
+            var placeholder = factory.CreateViewModel<IIssueishCommentViewModel>();
+            await placeholder.InitializeAsync(
+                this,
+                currentUser,
+                null,
+                Resources.ClosePullRequest).ConfigureAwait(true);
+            timeline.Add(placeholder);
+
             Timeline = timeline;
         }
 

diff --git a/src/GitHub.App/ViewModels/PullRequestReviewCommentViewModel.cs b/src/GitHub.App/ViewModels/PullRequestReviewCommentViewModel.cs
@@ -19,7 +19,6 @@ namespace GitHub.ViewModels
     public class PullRequestReviewCommentViewModel : CommentViewModel, IPullRequestReviewCommentViewModel
     {
         readonly ObservableAsPropertyHelper<bool> canStartReview;
-        readonly ObservableAsPropertyHelper<string> commitCaption;
         IPullRequestSession session;
         bool isPending;
 
@@ -31,19 +30,12 @@ public class PullRequestReviewCommentViewModel : CommentViewModel, IPullRequestR
         public PullRequestReviewCommentViewModel(ICommentService commentService)
             : base(commentService)
         {
-            var pendingAndIsNew = this.WhenAnyValue(
+            canStartReview = this.WhenAnyValue(
                 x => x.IsPending,
                 x => x.Id,
-                (isPending, id) => (isPending, isNewComment: id == null));
-
-            canStartReview = pendingAndIsNew
-                .Select(arg => !arg.isPending && arg.isNewComment)
+                (isPending, id) => !isPending && id == null)
                 .ToProperty(this, x => x.CanStartReview);
 
-            commitCaption = pendingAndIsNew
-                .Select(arg => !arg.isNewComment ? Resources.UpdateComment : arg.isPending ? Resources.AddReviewComment : Resources.AddSingleComment)
-                .ToProperty(this, x => x.CommitCaption);
-
             StartReview = ReactiveCommand.CreateFromTask(DoStartReview, CommitEdit.CanExecute);
             AddErrorHandler(StartReview);
         }
@@ -82,9 +74,6 @@ await InitializeAsync(
         /// <inheritdoc/>
         public bool CanStartReview => canStartReview.Value;
 
-        /// <inheritdoc/>
-        public string CommitCaption => commitCaption.Value;
-
         /// <inheritdoc/>
         public bool IsPending
         {
@@ -95,6 +84,16 @@ public bool IsPending
         /// <inheritdoc/>
         public ReactiveCommand<Unit, Unit> StartReview { get; }
 
+        protected override IObservable<string> GetCommitCaptionObservable()
+        {
+            return this.WhenAnyValue(
+                x => x.IsPending,
+                x => x.Id,
+                (pending, id) => id != null ?
+                    Resources.UpdateComment :
+                    pending ? Resources.AddReviewComment : Resources.AddSingleComment);
+        }
+
         async Task DoStartReview()
         {
             IsSubmitting = true;