From ddcd971ede43a5fe498d42a2d45d020311394445 Mon Sep 17 00:00:00 2001 From: Felipe Sere Date: Sat, 14 May 2016 00:12:42 +0200 Subject: [PATCH] To improve testing, add a layer of indirection around colours. --- lib/colours.ex | 13 ----------- lib/display/colours.ex | 36 ++++++++++++++++++++++++++++++ lib/display/failure.ex | 14 +++++++----- lib/display/intro.ex | 2 ++ lib/display/notification.ex | 6 +++-- lib/display/progress_bar.ex | 2 ++ test/display/failure_test.exs | 4 ++-- test/display/notification_test.exs | 2 +- 8 files changed, 55 insertions(+), 24 deletions(-) delete mode 100644 lib/colours.ex create mode 100644 lib/display/colours.ex diff --git a/lib/colours.ex b/lib/colours.ex deleted file mode 100644 index e654df4..0000000 --- a/lib/colours.ex +++ /dev/null @@ -1,13 +0,0 @@ -defmodule Colours do - alias IO.ANSI - - def red(str), do: colourize(ANSI.red, str) - - def cyan(str), do: colourize(ANSI.cyan, str) - - def green(str), do: colourize(ANSI.green, str) - - defp colourize(color, message) do - Enum.join([color, message, ANSI.reset], "") - end -end diff --git a/lib/display/colours.ex b/lib/display/colours.ex new file mode 100644 index 0000000..d0344fc --- /dev/null +++ b/lib/display/colours.ex @@ -0,0 +1,36 @@ +defmodule Display.Paint do + def red(str), do: painter().red(str) + + def cyan(str), do: painter().cyan(str) + + def green(str), do: painter().green(str) + + defp painter do + case Mix.env do + :test -> Display.Uncoloured + _ -> Display.Colours + end + end +end + +defmodule Display.Colours do + alias IO.ANSI + + def red(str), do: colourize(ANSI.red, str) + + def cyan(str), do: colourize(ANSI.cyan, str) + + def green(str), do: colourize(ANSI.green, str) + + defp colourize(color, message) do + Enum.join([color, message, ANSI.reset], "") + end +end + +defmodule Display.Uncoloured do + def red(str), do: str + + def cyan(str), do: str + + def green(str), do: str +end diff --git a/lib/display/failure.ex b/lib/display/failure.ex index 6a02bae..734870e 100644 --- a/lib/display/failure.ex +++ b/lib/display/failure.ex @@ -1,10 +1,12 @@ defmodule Display.Failure do + alias Display.Paint + @no_value :ex_unit_no_meaningful_value def format_failure(%{error: %ExUnit.AssertionError{expr: @no_value, message: message}, file: file, line: line}) do """ - #{Colours.cyan("Assertion failed in #{file}:#{line}")} - #{Colours.red(message)} + #{Paint.cyan("Assertion failed in #{file}:#{line}")} + #{Paint.red(message)} """ end def format_failure(%{error: %ExUnit.AssertionError{expr: expr}, file: file, line: line}) do @@ -12,21 +14,21 @@ defmodule Display.Failure do end def format_failure(%{error: error, file: file, line: line}) do """ - #{Colours.cyan("Error in #{file}:#{line}")} + #{Paint.cyan("Error in #{file}:#{line}")} #{format_error(error)} """ end defp format_assertion_error(error, file, line) do """ - #{Colours.cyan("Assertion failed in #{file}:#{line}")} - #{Colours.red(Macro.to_string(error))} + #{Paint.cyan("Assertion failed in #{file}:#{line}")} + #{Paint.red(Macro.to_string(error))} """ end defp format_error(error) do trace = System.stacktrace |> Enum.take(2) - Colours.red(Exception.format(:error, error, trace)) + Paint.red(Exception.format(:error, error, trace)) end def show_compile_error(error) do diff --git a/lib/display/intro.ex b/lib/display/intro.ex index da21587..8e2115b 100644 --- a/lib/display/intro.ex +++ b/lib/display/intro.ex @@ -1,4 +1,6 @@ defmodule Display.Intro do + alias Display.Colours + def intro(module, modules) do if not module in modules do show_intro(module.intro) diff --git a/lib/display/notification.ex b/lib/display/notification.ex index 6ecd612..a586dac 100644 --- a/lib/display/notification.ex +++ b/lib/display/notification.ex @@ -1,6 +1,8 @@ defmodule Display.Notifications do + alias Display.Paint + def congratulate do - Colours.green("\nYou have learned much. You must find your own path now.") + Paint.green("\nYou have learned much. You must find your own path now.") end def invalid_koan(koan, modules) do @@ -13,7 +15,7 @@ defmodule Display.Notifications do |> Enum.map(&Atom.to_string/1) |> Enum.map(&name/1) |> Enum.join(", ") - |> Colours.red + |> Paint.red end defp name("Elixir." <> module), do: module diff --git a/lib/display/progress_bar.ex b/lib/display/progress_bar.ex index 4f349ec..428777c 100644 --- a/lib/display/progress_bar.ex +++ b/lib/display/progress_bar.ex @@ -1,4 +1,6 @@ defmodule Display.ProgressBar do + alias Display.Colours + @progress_bar_length 30 def progress_bar(%{current: current, total: total}) do diff --git a/test/display/failure_test.exs b/test/display/failure_test.exs index f335eeb..6d97c0d 100644 --- a/test/display/failure_test.exs +++ b/test/display/failure_test.exs @@ -5,13 +5,13 @@ defmodule FailureTests do test "assertion failure with proper expression" do error = error(%ExUnit.AssertionError{expr: "hi"}) - assert Failure.format_failure(error) == "\e[36mAssertion failed in some_file.ex:42\e[0m\n\e[31m\"hi\"\e[0m\n" + assert Failure.format_failure(error) == "Assertion failed in some_file.ex:42\n\"hi\"\n" end test "assertion failure with message" do error = error(%ExUnit.AssertionError{expr: :ex_unit_no_meaningful_value, message: "hola"}) - assert Failure.format_failure(error) == "\e[36mAssertion failed in some_file.ex:42\e[0m\n\e[31mhola\e[0m\n" + assert Failure.format_failure(error) == "Assertion failed in some_file.ex:42\nhola\n" end defp error(error) do diff --git a/test/display/notification_test.exs b/test/display/notification_test.exs index 9e7de1d..debbdb8 100644 --- a/test/display/notification_test.exs +++ b/test/display/notification_test.exs @@ -4,6 +4,6 @@ defmodule NotificationTest do test "shows possible koans when a koan can not be found" do message = Notifications.invalid_koan(SampleKoan, [PassingKoan]) - assert message == "Did not find koan SampleKoan in \e[31mPassingKoan\e[0m" + assert message == "Did not find koan SampleKoan in PassingKoan" end end