Merge pull request #1086 from code-corps/code-and-comment-cleanups-for-issue-comment

Code and comment cleanups for IssueComment

Author: begedin

lib/code_corps/github/event/issue_comment/comment_linker.ex

@@ -1,9 +1,10 @@
 defmodule CodeCorps.GitHub.Event.IssueComment.CommentLinker do
   @moduledoc ~S"""
-  In charge of finding a issue to link with a Task when processing an Issues
-  webhook.
+  In charge of finding a `CodeCorps.GithubComment` to link with a
+  `CodeCorps.Comment` when processing an Issue Comment webhook, or handling a
+  `CodeCorpsWeb.CommentController` request.
 
-  The only entry point is `create_or_update_issue/1`.
+  The only entry point is `create_or_update_comment/1`.
   """
 
   alias CodeCorps.{
@@ -29,24 +30,29 @@ defmodule CodeCorps.GitHub.Event.IssueComment.CommentLinker do
   payload data.
   """
   @spec create_or_update_comment(GithubIssue.t, map) :: linking_result
-  def create_or_update_comment(%GithubIssue{} = github_issue, %{"id" => github_comment_id} = attrs) do
+  def create_or_update_comment(%GithubIssue{} = github_issue, %{} = attrs) do
     params = Adapters.Comment.to_github_comment(attrs)
 
-    case Repo.get_by(GithubComment, github_id: github_comment_id) do
+    case attrs |> find_comment() do
       nil -> create_comment(github_issue, params)
-      %GithubComment{} = github_comment -> github_comment |> update_issue(params)
+      %GithubComment{} = github_comment -> github_comment |> update_comment(params)
     end
   end
 
-  defp create_comment(%GithubIssue{id: github_issue_id}, params) do
+  @spec find_comment(map) :: GithubComment.t | nil
+  defp find_comment(%{"id" => github_id}), do: GithubComment |> Repo.get_by(github_id: github_id)
+
+  @spec create_comment(GithubIssue.t, map) :: linking_result
+  defp create_comment(%GithubIssue{id: github_issue_id}, %{} = params) do
     params = Map.put(params, :github_issue_id, github_issue_id)
 
     %GithubComment{}
     |> GithubComment.create_changeset(params)
     |> Repo.insert
   end
 
-  defp update_issue(%GithubComment{} = github_comment, params) do
+  @spec update_comment(GithubComment.t, map) :: linking_result
+  defp update_comment(%GithubComment{} = github_comment, %{} = params) do
     github_comment
     |> GithubComment.update_changeset(params)
     |> Repo.update

lib/code_corps/github/event/issue_comment/comment_syncer.ex

@@ -1,4 +1,12 @@
 defmodule CodeCorps.GitHub.Event.IssueComment.CommentSyncer do
+  @moduledoc ~S"""
+  In charge of syncing `CodeCorps.Comment` records with a GitHub comment
+  payload.
+
+  A single GitHub comment always matches a single `CodeCorps.GithubComment`, but
+  it can match multiple `CodeCorps.Comment` records. This module handles
+  creating or updating all those records.
+  """
 
   import Ecto.Query
 
@@ -17,10 +25,15 @@ defmodule CodeCorps.GitHub.Event.IssueComment.CommentSyncer do
   @type outcome :: {:ok, list(Comment.t)} |
                    {:error, {list(Comment.t), list(Changeset.t)}}
 
-  @doc """
-  When provided a list of `Task`s, a `User` and a GitHub API payload, for each
-  `Comment` associated to those `Task`s it creates or updates a `Comment`
-  associated to the specified `User`.
+  @doc ~S"""
+  Creates or updates `CodeCorps.Comment` records for the speciifed list of
+  `CodeCorps.Task` records.
+
+  When provided a list of `CodeCorps.Task` records, a `CodeCorps.GithubComment`,
+  a `CodeCorps.User`, and a GitHub API payload , for each `CodeCorps.Task`
+  record, it creates or updates a `CodeCorps.Comment` record, using the provided
+  GitHub API payload, associated to the specified `CodeCorps.GithubComment` and
+  `CodeCorps.User`
   """
   @spec sync_all(list(Task.t), GithubComment.t, User.t, map) :: outcome
   def sync_all(tasks, %GithubComment{} = github_comment, %User{} = user, %{} = payload) do

priv/repo/structure.sql

@@ -2,7 +2,7 @@
 -- PostgreSQL database dump
 --
 
--- Dumped from database version 9.5.9
+-- Dumped from database version 10.0
 -- Dumped by pg_dump version 10.0
 
 SET statement_timeout = 0;