Enable the elixir code formatter (#231)

and run it, obviously.

Author: brienw

.formatter.exs

@@ -0,0 +1,4 @@
+[
+  inputs: ["mix.exs",
+  "{config,lib,test}/**/*.{ex,exs}"]
+]

circle.yml

@@ -13,6 +13,7 @@ test:
   override:
     - mkdir -p $CIRCLE_TEST_REPORTS/test
     - script/ci/run-mix.sh dialyzer
+    - script/ci/run-mix.sh formatter --check-formatted
     - script/ci/run-mix.sh credo --strict
     - script/ci/run-mix.sh test
     - script/ci/run-mix.sh coveralls.html

lib/bootleg/config.ex

@@ -8,9 +8,24 @@ defmodule Bootleg.Config do
 
   defmacro __using__(_) do
     quote do
-      import Bootleg.Config, only: [role: 2, role: 3, config: 2, config: 1, config: 0,
-        before_task: 2, after_task: 2, invoke: 1, task: 2, remote: 1, remote: 2,
-        remote: 3, load: 1, upload: 3, download: 3]
+      import Bootleg.Config,
+        only: [
+          role: 2,
+          role: 3,
+          config: 2,
+          config: 1,
+          config: 0,
+          before_task: 2,
+          after_task: 2,
+          invoke: 1,
+          task: 2,
+          remote: 1,
+          remote: 2,
+          remote: 3,
+          load: 1,
+          upload: 3,
+          download: 3
+        ]
     end
   end
 
@@ -45,20 +60,24 @@ defmodule Bootleg.Config do
     if name == :all do
       raise ArgumentError, ":all is reserved by bootleg and refers to all defined roles."
     end
+
     user = Keyword.get(options, :user, System.get_env("USER"))
-    ssh_options = Enum.filter(options, &Enum.member?(SSH.supported_options, elem(&1, 0)) == true)
+
+    ssh_options =
+      Enum.filter(options, &(Enum.member?(SSH.supported_options(), elem(&1, 0)) == true))
+
+    # identity needs to be present in both options lists
     role_options =
-      options -- ssh_options
+      (options -- ssh_options)
       |> Keyword.put(:user, user)
-      # identity needs to be present in both options lists
       |> Keyword.put(:identity, ssh_options[:identity])
       |> Keyword.get_and_update(:identity, fn val ->
-          if val || Keyword.has_key?(ssh_options, :identity) do
-            {val, val || ssh_options[:identity]}
-          else
-            :pop
-          end
-        end)
+        if val || Keyword.has_key?(ssh_options, :identity) do
+          {val, val || ssh_options[:identity]}
+        else
+          :pop
+        end
+      end)
       |> elem(1)
 
     quote bind_quoted: binding() do
@@ -73,6 +92,7 @@ defmodule Bootleg.Config do
         hosts: [],
         options: role_options
       }
+
       role =
         :roles
         |> Bootleg.Config.Agent.get()
@@ -165,19 +185,29 @@ defmodule Bootleg.Config do
   defp add_callback(task, position, caller, do: block) do
     file = caller.file()
     line = caller.line()
+
     quote do
       hook_number = Bootleg.Config.Agent.increment(:next_hook_number)
-      module_name = String.to_atom("Elixir.Bootleg.DynamicCallbacks." <>
-        String.capitalize("#{unquote(position)}") <> String.capitalize("#{unquote(task)}") <>
-        "#{hook_number}")
+
+      module_name =
+        String.to_atom(
+          "Elixir.Bootleg.DynamicCallbacks." <>
+            String.capitalize("#{unquote(position)}") <>
+            String.capitalize("#{unquote(task)}") <> "#{hook_number}"
+        )
+
       defmodule module_name do
         @file unquote(file)
         def execute, do: unquote(block)
         def location, do: {unquote(file), unquote(line)}
         hook_list_name = :"#{unquote(position)}_hooks"
         hooks = Keyword.get(Bootleg.Config.Agent.get(hook_list_name), unquote(task), [])
-        Bootleg.Config.Agent.merge(hook_list_name, unquote(task), hooks ++
-          [[module_name, :execute]])
+
+        Bootleg.Config.Agent.merge(
+          hook_list_name,
+          unquote(task),
+          hooks ++ [[module_name, :execute]]
+        )
       end
     end
   end
@@ -283,9 +313,12 @@ defmodule Bootleg.Config do
 
       if Code.ensure_compiled?(module_name) do
         {orig_file, orig_line} = module_name.location
-        UI.warn "warning: task '#{unquote(task)}' is being redefined. " <>
-        "The most recent definition will win, but this is probably not what you meant to do. " <>
-        "The previous definition was at: #{orig_file}:#{orig_line}"
+
+        UI.warn(
+          "warning: task '#{unquote(task)}' is being redefined. " <>
+            "The most recent definition will win, but this is probably not what you meant to do. " <>
+            "The previous definition was at: #{orig_file}:#{orig_line}"
+        )
       end
 
       original_opts = Code.compiler_options()
@@ -300,6 +333,7 @@ defmodule Bootleg.Config do
       after
         Code.compiler_options(original_opts)
       end
+
       :ok
     end
   end
@@ -309,7 +343,7 @@ defmodule Bootleg.Config do
     agent_key
     |> Bootleg.Config.Agent.get()
     |> Keyword.get(task, [])
-    |> Enum.each(fn([module, fnref]) -> apply(module, fnref, []) end)
+    |> Enum.each(fn [module, fnref] -> apply(module, fnref, []) end)
   end
 
   @spec module_for_task(atom) :: atom
@@ -352,6 +386,7 @@ defmodule Bootleg.Config do
     invoke_task_callbacks(task, :before_hooks)
 
     module_name = module_for_task(task)
+
     if Code.ensure_compiled?(module_name) do
       apply(module_name, :execute, [])
     end
@@ -460,6 +495,7 @@ defmodule Bootleg.Config do
   """
   defmacro remote(role, options, lines) do
     roles = unpack_role(role)
+
     quote bind_quoted: binding() do
       Enum.reduce(roles, [], fn role, outputs ->
         role
@@ -480,9 +516,12 @@ defmodule Bootleg.Config do
   @spec load(binary | charlist) :: :ok | {:error, :enoent}
   def load(file) do
     case File.regular?(file) do
-      true -> Code.eval_file(file)
-              :ok
-      false -> {:error, :enoent}
+      true ->
+        Code.eval_file(file)
+        :ok
+
+      false ->
+        {:error, :enoent}
     end
   end
 
@@ -527,6 +566,7 @@ defmodule Bootleg.Config do
   defmacro upload(role, local_path, remote_path) do
     {roles, filters} = split_roles_and_filters(role)
     roles = unpack_role(roles)
+
     quote bind_quoted: binding() do
       Enum.each(roles, fn role ->
         role
@@ -580,6 +620,7 @@ defmodule Bootleg.Config do
   defmacro download(role, remote_path, local_path) do
     {roles, filters} = split_roles_and_filters(role)
     roles = unpack_role(roles)
+
     quote bind_quoted: binding() do
       Enum.each(roles, fn role ->
         role
@@ -614,8 +655,8 @@ defmodule Bootleg.Config do
   @doc false
   @spec cache_project_config(atom) :: any
   def cache_project_config(prop) do
-    unless Project.umbrella? do
-      val = Project.config[prop]
+    unless Project.umbrella?() do
+      val = Project.config()[prop]
       Bootleg.Config.Agent.merge(:config, prop, val)
       val
     else
@@ -640,14 +681,15 @@ defmodule Bootleg.Config do
   @spec split_roles_and_filters(atom | keyword) :: {[atom], keyword}
   defp split_roles_and_filters(role) do
     role
-    |> List.wrap
+    |> List.wrap()
     |> Enum.split_while(fn term -> !is_tuple(term) end)
   end
 
   @doc false
   @spec unpack_role(atom | keyword) :: tuple
   defp unpack_role(role) do
     wrapped_role = List.wrap(role)
+
     if Enum.any?(wrapped_role, fn role -> role == :all end) do
       quote do: Keyword.keys(Bootleg.Config.Agent.get(:roles))
     else

lib/bootleg/config/agent.ex

@@ -10,14 +10,19 @@ defmodule Bootleg.Config.Agent do
     state_fn = fn ->
       [roles: [], config: [env: env], before_hooks: [], after_hooks: [], next_hook_number: 0]
     end
+
     case Agent.start_link(state_fn, name: Bootleg.Config.Agent) do
-      {:error, {:already_started, pid}} -> {:ok, pid}
+      {:error, {:already_started, pid}} ->
+        {:ok, pid}
+
       {:ok, pid} ->
         wait_cleanup()
         launch_monitor()
-        Tasks.load_tasks
+        Tasks.load_tasks()
         {:ok, pid}
-      val -> val
+
+      val ->
+        val
     end
   end
 
@@ -38,7 +43,7 @@ defmodule Bootleg.Config.Agent do
 
   @spec increment(atom) :: integer()
   def increment(key) do
-    Agent.get_and_update(agent_pid(), fn (state) ->
+    Agent.get_and_update(agent_pid(), fn state ->
       {state[key], Keyword.put(state, key, state[key] + 1)}
     end)
   end
@@ -49,6 +54,7 @@ defmodule Bootleg.Config.Agent do
       Process.sleep(10)
       wait_cleanup()
     end
+
     :ok
   end
 
@@ -57,14 +63,16 @@ defmodule Bootleg.Config.Agent do
     ref = Process.monitor(Bootleg.Config.Agent)
     Process.register(self(), :"Bootleg.Config.Agent.monitor")
     send(parent_pid, {:monitor_up, self()})
+
     receive do
       {:DOWN, ^ref, :process, _pid, _reason} ->
         Enum.each(:code.all_loaded(), fn {module, _file} ->
           if String.starts_with?(Atom.to_string(module), "Elixir.Bootleg.DynamicTasks.") ||
-            String.starts_with?(Atom.to_string(module), "Elixir.Bootleg.DynamicCallbacks.")do
+               String.starts_with?(Atom.to_string(module), "Elixir.Bootleg.DynamicCallbacks.") do
             unload_code(module)
           end
         end)
+
         Process.unregister(:"Bootleg.Config.Agent.monitor")
     end
   end
@@ -79,6 +87,7 @@ defmodule Bootleg.Config.Agent do
   defp launch_monitor do
     if Process.whereis(Bootleg.Config.Agent) do
       pid = Process.spawn(__MODULE__, :agent_monitor, [self()], [])
+
       receive do
         {:monitor_up, ^pid} -> :ok
       end
@@ -87,8 +96,7 @@ defmodule Bootleg.Config.Agent do
 
   @spec agent_pid() :: pid | atom
   defp agent_pid do
-    {:ok, pid} = Bootleg.Config.Agent.start_link
+    {:ok, pid} = Bootleg.Config.Agent.start_link()
     pid
   end
-
 end

lib/bootleg/host.ex

@@ -17,13 +17,15 @@ defmodule Bootleg.Host do
   def option(%__MODULE__{} = host, option) when is_atom(option) do
     get_in(host, [Access.key!(:options), option])
   end
+
   def option(%__MODULE__{} = host, option, value) when is_atom(option) do
     put_in(host, [Access.key!(:options), option], value)
   end
 
   def ssh_option(%__MODULE__{} = host, option) when is_atom(option) do
     get_in(host, [Access.key!(:host), Access.key!(:options), option])
   end
+
   def ssh_option(%__MODULE__{} = host, option, value) when is_atom(option) do
     put_in(host, [Access.key!(:host), Access.key!(:options), option], value)
   end
@@ -38,6 +40,7 @@ defmodule Bootleg.Host do
 
   defp do_combine_uniq([h | t], set, fun, acc) do
     value = fun.(h)
+
     case set do
       %{^value => true} -> do_combine_uniq(t, set, fun, Enum.map(acc, &combine_hosts(&1, h)))
       %{} -> do_combine_uniq(t, Map.put(set, value, true), fun, [h | acc])
@@ -50,7 +53,7 @@ defmodule Bootleg.Host do
 
   defp combine_hosts(host1, host2) do
     if host_id(host1) == host_id(host2) do
-      combine_host_options host1, host2
+      combine_host_options(host1, host2)
     else
       host1
     end

lib/bootleg/mix_task.ex

@@ -6,21 +6,23 @@ defmodule Bootleg.MixTask do
     quote do
       use Mix.Task
 
-      @spec run(OptionParser.argv) :: :ok
+      @spec run(OptionParser.argv()) :: :ok
       if is_atom(unquote(task)) && unquote(task) do
         def run(args) do
           {env, _} = Tasks.parse_env_task(args)
+
           if env do
             Config.env(env)
           end
 
           use Config
 
-          invoke unquote(task)
+          invoke(unquote(task))
         end
       else
         def run(args) do
           {env, _} = Tasks.parse_env_task(args)
+
           if env do
             Config.env(env)
           end
@@ -29,7 +31,7 @@ defmodule Bootleg.MixTask do
         end
       end
 
-      defoverridable [run: 1]
+      defoverridable run: 1
     end
   end
 end