♻️ Refactor Actions to accept email for GitLab

config/config.exs

@@ -21,6 +21,9 @@ import Config
 #     config :logger, level: :info
 #
 
+config :git_pair,
+  storage: GitPair.Storage
+
 config :git_pair,
   command_runner: System
 

config/test.exs

@@ -2,3 +2,6 @@ import Config
 
 config :git_pair,
   command_runner: GitPair.SystemMock
+
+config :git_pair,
+  storage: GitPair.StorageMock

lib/git_pair.ex

@@ -3,7 +3,7 @@ defmodule GitPair do
   Documentation for `GitPair`.
   """
 
-  @version Mix.Project.config[:version]
+  @version Mix.Project.config()[:version]
 
   def version(), do: @version
 end

lib/git_pair/actions.ex

@@ -1,7 +1,6 @@
 defmodule GitPair.Actions do
   @git_config "config"
-  @key "pair.coauthor"
-
+  @key "pair"
   @success_exit_status 0
 
   @commit_msg_hook_content """
@@ -14,6 +13,8 @@ defmodule GitPair.Actions do
 
   @commit_msg_hook_path "./.git/hooks/commit-msg"
 
+  alias GitPair.Storage
+
   def init() do
     File.mkdir_p!(Path.dirname(@commit_msg_hook_path))
 
@@ -33,10 +34,16 @@ defmodule GitPair.Actions do
     end
   end
 
+  def add([username, email]) do
+    {result, user_data} = storage().add([username, email])
+
+    output(result, "User #{user_data[:identifier]} (#{user_data[:email]}) added")
+  end
+
   def add(username) do
-    result = command("--add", username)
+    {result, user_data} = storage().add(username)
 
-    output(result, "User #{username} added")
+    output(result, "User #{user_data[:identifier]} (#{user_data[:email]}) added")
   end
 
   def rm(username) do
@@ -89,6 +96,14 @@ defmodule GitPair.Actions do
        |> Enum.join("\n"))
   end
 
+  defp output(:ok, message) do
+    {:ok, message}
+  end
+
+  defp output(:error, _message) do
+    {:error, "Failed to execute command"}
+  end
+
   defp output({"", @success_exit_status}, message) do
     {:ok, message}
   end
@@ -122,6 +137,10 @@ defmodule GitPair.Actions do
     {:error, "Unsuported multiple users"}
   end
 
+  def storage() do
+    Application.get_env(:git_pair, :storage, Storage)
+  end
+
   def command_runner() do
     Application.get_env(:git_pair, :command_runner, System)
   end

lib/git_pair/behaviours/storage_behaviour.ex

@@ -0,0 +1,6 @@
+defmodule GitPair.StorageBehaviour do
+  @moduledoc false
+
+  @callback add(String.t()) :: {atom(), list()}
+  @callback add(list(String.t())) :: {atom(), list()}
+end

lib/storage.ex

@@ -0,0 +1,28 @@
+defmodule GitPair.Storage do
+  @git_config "config"
+  @key "pair"
+  @github_noreply_email "@users.noreply.github.com"
+
+  def add([identifier, email]) do
+    run(["--add", "#{@key}.#{identifier}.identifier", identifier])
+    run(["--add", "#{@key}.#{identifier}.email", email])
+
+    {:ok,
+     [
+       identifier: identifier,
+       email: email
+     ]}
+  end
+
+  def add(identifier) do
+    add([identifier, identifier <> @github_noreply_email])
+  end
+
+  def run(command) do
+    runner().cmd("git", [@git_config | command])
+  end
+
+  def runner() do
+    Application.get_env(:git_pair, :command_runner, System)
+  end
+end

test/actions_test.exs

@@ -4,19 +4,39 @@ defmodule GitPair.ActionsTest do
   import Mox
 
   alias GitPair.Actions
+  alias GitPair.StorageMock
   alias GitPair.SystemMock
 
   setup :verify_on_exit!
 
-  test ".add calls git config add command" do
-    expect(SystemMock, :cmd, fn _cmd, _options ->
-      {"", 0}
+  test ".add calls git config add command passing username" do
+    expect(StorageMock, :add, fn identifier ->
+      {:ok,
+       [
+         identifier: identifier,
+         email: "[email protected]"
+       ]}
+    end)
+
+    {result, message} = Actions.add(["fake_user"])
+
+    assert result == :ok
+    assert message == "User fake_user ([email protected]) added"
+  end
+
+  test ".add calls git config add command passing identifier and email" do
+    expect(StorageMock, :add, fn [identifier, email] ->
+      {:ok,
+       [
+         identifier: identifier,
+         email: "[email protected]"
+       ]}
     end)
 
-    {result, message} = Actions.add(["fake-user"])
+    {result, message} = Actions.add(["fake_user", "[email protected]"])
 
     assert result == :ok
-    assert message == "User fake-user added"
+    assert message == "User fake_user ([email protected]) added"
   end
 
   test ".rm calls git config unset command" do

test/storage_test.exs

@@ -0,0 +1,62 @@
+defmodule GitPair.StorageTest do
+  use ExUnit.Case, async: true
+
+  import Mox
+
+  alias GitPair.Storage
+  alias GitPair.SystemMock
+
+  setup :verify_on_exit!
+
+  describe "add/1" do
+    test "store user with identifier with GitHub no-reply email" do
+      command_prefix = ["config", "--add"]
+
+      expect(SystemMock, :cmd, fn _cmd, options ->
+        assert options == command_prefix ++ ["pair.fake_user.identifier", "fake_user"]
+        {"", 0}
+      end)
+
+      expect(SystemMock, :cmd, fn _cmd, options ->
+        assert options ==
+                 command_prefix ++ ["pair.fake_user.email", "[email protected]"]
+
+        {"", 0}
+      end)
+
+      {result, user_data} = Storage.add("fake_user")
+
+      assert result == :ok
+
+      assert user_data == [
+               identifier: "fake_user",
+               email: "[email protected]"
+             ]
+    end
+  end
+
+  describe "add/2" do
+    test "stores user with identifier and email" do
+      command_prefix = ["config", "--add"]
+
+      expect(SystemMock, :cmd, fn _cmd, options ->
+        assert options == command_prefix ++ ["pair.fake_user.identifier", "fake_user"]
+        {"", 0}
+      end)
+
+      expect(SystemMock, :cmd, fn _cmd, options ->
+        assert options == command_prefix ++ ["pair.fake_user.email", "[email protected]"]
+        {"", 0}
+      end)
+
+      {result, user_data} = Storage.add(["fake_user", "[email protected]"])
+
+      assert result == :ok
+
+      assert user_data == [
+               identifier: "fake_user",
+               email: "[email protected]"
+             ]
+    end
+  end
+end

test/test_helper.exs

@@ -1,3 +1,4 @@
 Mox.defmock(GitPair.SystemMock, for: GitPair.SystemBehaviour)
+Mox.defmock(GitPair.StorageMock, for: GitPair.StorageBehaviour)
 
 ExUnit.start()