Perform maintenance

* Fix typo README
* Format code
* Update dependencies
* Add `@impl`

Author: adriankumpf

Makefile

@@ -1,6 +1,6 @@
 # LoggerTelegramBackend
 
-A logger backend for [Telegram]( https://telegram.org/).
+A logger backend for [Telegram](https://telegram.org/).
 
 ## Installation
 
@@ -18,8 +18,8 @@ First of all you need to create a [Telegram
 bot](https://core.telegram.org/bots). Follow the [instructions
 here](https://core.telegram.org/bots#6-botfather) to create one and get the
 `token` for the bot. Since bots are not allowed to contact users, you need to
-send a message first. Afterwards, retrieve your `chat_id` with `$ curl -X GET
-https://api.telegram.org/botYOUR_TOKEN/getUpdates`.
+send a message first. Afterwards, retrieve your `chat_id` with
+`$ curl -X GET https://api.telegram.org/botYOUR_TOKEN/getUpdates`.
 
 Then add `LoggerTelegramBackend` to the `:backends` configuration, configure
 the telegram `chat_id` and bot `token`:
@@ -41,16 +41,15 @@ with environment variables.
 
 The following options are available:
 
-  * `:level` - the level to be logged by this backend (either `:debug`,
-    `:info`, `:warn` or `:error`). Note that messages are filtered by the
-    general `:level` configuration for the `:logger` application first. If not
-    explicitly configured all levels are logged.
-  * `:metadata` - the metadata to be included in the telegram message. Defaults
-    to  `[:line, :function, :module, :application, :file]`. Setting `:metadata`
-    to `:all` gets all metadata.
-  * `:metadata_filter` - the metadata which is required in order for a message
-    to be logged. Example: `metadata_filter: [application: :ui]`.
-
+* `:level` - the level to be logged by this backend (either `:debug`,
+  `:info`, `:warn` or `:error`). Note that messages are filtered by the
+  general `:level` configuration for the `:logger` application first. If not
+  explicitly configured all levels are logged.
+* `:metadata` - the metadata to be included in the telegram message. Defaults
+  to `[:line, :function, :module, :application, :file]`. Setting `:metadata`
+  to `:all` gets all metadata.
+* `:metadata_filter` - the metadata which is required in order for a message
+  to be logged. Example: `metadata_filter: [application: :ui]`.
 
 #### Example
 

README.md

@@ -14,8 +14,7 @@ defmodule LoggerTelegramBackend do
   @default_sender {Telegram, [:token, :chat_id]}
   @default_metadata [:line, :function, :module, :application, :file]
 
-  # Callbacks
-
+  @impl :gen_event
   def init(__MODULE__), do: init({__MODULE__, @default_name})
 
   def init({__MODULE__, name}) when is_atom(name) do
@@ -26,10 +25,12 @@ defmodule LoggerTelegramBackend do
     {:ok, state}
   end
 
+  @impl :gen_event
   def handle_call({:configure, options}, state) do
     {:ok, :ok, configure(options, state)}
   end
 
+  @impl :gen_event
   def handle_event({_level, gl, _event}, state) when node(gl) != node() do
     {:ok, state}
   end
@@ -49,6 +50,7 @@ defmodule LoggerTelegramBackend do
     {:ok, state}
   end
 
+  @impl :gen_event
   def handle_info(_message, state) do
     {:ok, state}
   end

lib/telegram_logger_backend.ex

@@ -5,10 +5,8 @@ defmodule LoggerTelegramBackend.Formatter do
 
   alias LoggerTelegramBackend.Manager
 
-  @name __MODULE__
-
   def start_link([min_demand, max_demand]) do
-    GenStage.start_link(__MODULE__, {min_demand, max_demand}, name: @name)
+    GenStage.start_link(__MODULE__, {min_demand, max_demand}, name: __MODULE__)
   end
 
   # Callbacks

lib/telegram_logger_backend/formatter.ex

@@ -5,16 +5,16 @@ defmodule LoggerTelegramBackend.Manager do
 
   @name __MODULE__
 
+  def start_link(_args) do
+    GenStage.start_link(__MODULE__, :ok, name: @name)
+  end
+
   def add_event(event) do
     GenStage.cast(@name, {:add, event})
   end
 
   # Callbacks
 
-  def start_link(_args) do
-    GenStage.start_link(__MODULE__, :ok, name: @name)
-  end
-
   def init(:ok) do
     {:producer, {:queue.new(), 0}}
   end
@@ -35,11 +35,8 @@ defmodule LoggerTelegramBackend.Manager do
 
   defp dispatch_events(queue, demand, events) when demand > 0 do
     case :queue.out(queue) do
-      {:empty, queue} ->
-        {:noreply, events, {queue, demand}}
-
-      {{:value, event}, queue} ->
-        dispatch_events(queue, demand - 1, [event | events])
+      {:empty, queue} -> {:noreply, events, {queue, demand}}
+      {{:value, event}, queue} -> dispatch_events(queue, demand - 1, [event | events])
     end
   end
 

lib/telegram_logger_backend/manager.ex

@@ -5,10 +5,8 @@ defmodule LoggerTelegramBackend.Sender do
 
   alias LoggerTelegramBackend.Formatter
 
-  @name __MODULE__
-
   def start_link(args) do
-    GenStage.start_link(__MODULE__, args, name: @name)
+    GenStage.start_link(__MODULE__, args, name: __MODULE__)
   end
 
   # Callbacks
@@ -21,6 +19,8 @@ defmodule LoggerTelegramBackend.Sender do
     process_events(events, state)
   end
 
+  # Private
+
   defp process_events([], state) do
     {:noreply, [], state}
   end

lib/telegram_logger_backend/sender.ex

@@ -4,7 +4,7 @@ defmodule LoggerTelegramBackend.Mixfile do
   def project do
     [
       app: :logger_telegram_backend,
-      version: "1.0.2",
+      version: "1.0.3",
       elixir: "~> 1.5",
       start_permanent: Mix.env() == :prod,
       deps: deps(),

mix.exs

@@ -1,18 +1,19 @@
 %{
-  "certifi": {:hex, :certifi, "2.0.0", "a0c0e475107135f76b8c1d5bc7efb33cd3815cb3cf3dea7aefdd174dabead064", [:rebar3], [], "hexpm"},
-  "earmark": {:hex, :earmark, "1.2.4", "99b637c62a4d65a20a9fb674b8cffb8baa771c04605a80c911c4418c69b75439", [:mix], [], "hexpm"},
+  "certifi": {:hex, :certifi, "2.3.1", "d0f424232390bf47d82da8478022301c561cf6445b5b5fb6a84d49a9e76d2639", [:rebar3], [{:parse_trans, "3.2.0", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm"},
+  "earmark": {:hex, :earmark, "1.2.5", "4d21980d5d2862a2e13ec3c49ad9ad783ffc7ca5769cf6ff891a4553fbaae761", [:mix], [], "hexpm"},
   "ex_doc": {:hex, :ex_doc, "0.18.3", "f4b0e4a2ec6f333dccf761838a4b253d75e11f714b85ae271c9ae361367897b7", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
   "exactor": {:hex, :exactor, "2.2.4", "5efb4ddeb2c48d9a1d7c9b465a6fffdd82300eb9618ece5d34c3334d5d7245b1", [:mix], [], "hexpm"},
   "exjsx": {:hex, :exjsx, "4.0.0", "60548841e0212df401e38e63c0078ec57b33e7ea49b032c796ccad8cde794b5c", [:mix], [{:jsx, "~> 2.8.0", [hex: :jsx, repo: "hexpm", optional: false]}], "hexpm"},
-  "exvcr": {:hex, :exvcr, "0.10.1", "cb266e5cc0d4fef12572ce6673d13f97aa3c302911010d64d51cee0690f566d1", [:mix], [{:exactor, "~> 2.2", [hex: :exactor, repo: "hexpm", optional: false]}, {:exjsx, "~> 4.0", [hex: :exjsx, repo: "hexpm", optional: false]}, {:httpoison, "~> 1.0", [hex: :httpoison, repo: "hexpm", optional: true]}, {:httpotion, "~> 3.1", [hex: :httpotion, repo: "hexpm", optional: true]}, {:ibrowse, "~> 4.4", [hex: :ibrowse, repo: "hexpm", optional: true]}, {:meck, "~> 0.8", [hex: :meck, repo: "hexpm", optional: false]}], "hexpm"},
+  "exvcr": {:hex, :exvcr, "0.10.2", "a66a0fa86d03153e5c21e38b1320d10b537038d7bc7b10dcc1ab7f0343569822", [:mix], [{:exactor, "~> 2.2", [hex: :exactor, repo: "hexpm", optional: false]}, {:exjsx, "~> 4.0", [hex: :exjsx, repo: "hexpm", optional: false]}, {:httpoison, "~> 1.0", [hex: :httpoison, repo: "hexpm", optional: true]}, {:httpotion, "~> 3.1", [hex: :httpotion, repo: "hexpm", optional: true]}, {:ibrowse, "~> 4.4", [hex: :ibrowse, repo: "hexpm", optional: true]}, {:meck, "~> 0.8", [hex: :meck, repo: "hexpm", optional: false]}], "hexpm"},
   "gen_stage": {:hex, :gen_stage, "0.13.1", "edff5bca9cab22c5d03a834062515e6a1aeeb7665fb44eddae086252e39c4378", [:mix], [], "hexpm"},
-  "hackney": {:hex, :hackney, "1.11.0", "4951ee019df102492dabba66a09e305f61919a8a183a7860236c0fde586134b6", [:rebar3], [{:certifi, "2.0.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},
-  "httpoison": {:hex, :httpoison, "1.0.0", "1f02f827148d945d40b24f0b0a89afe40bfe037171a6cf70f2486976d86921cd", [:mix], [{:hackney, "~> 1.8", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm"},
-  "idna": {:hex, :idna, "5.1.0", "d72b4effeb324ad5da3cab1767cb16b17939004e789d8c0ad5b70f3cea20c89a", [:rebar3], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm"},
+  "hackney": {:hex, :hackney, "1.12.1", "8bf2d0e11e722e533903fe126e14d6e7e94d9b7983ced595b75f532e04b7fdc7", [:rebar3], [{:certifi, "2.3.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.1", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},
+  "httpoison": {:hex, :httpoison, "1.1.1", "96ed7ab79f78a31081bb523eefec205fd2900a02cda6dbc2300e7a1226219566", [:mix], [{:hackney, "~> 1.8", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm"},
+  "idna": {:hex, :idna, "5.1.1", "cbc3b2fa1645113267cc59c760bafa64b2ea0334635ef06dbac8801e42f7279c", [:rebar3], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm"},
   "jsx": {:hex, :jsx, "2.8.3", "a05252d381885240744d955fbe3cf810504eb2567164824e19303ea59eef62cf", [:mix, :rebar3], [], "hexpm"},
   "meck": {:hex, :meck, "0.8.9", "64c5c0bd8bcca3a180b44196265c8ed7594e16bcc845d0698ec6b4e577f48188", [:rebar3], [], "hexpm"},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm"},
   "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], [], "hexpm"},
+  "parse_trans": {:hex, :parse_trans, "3.2.0", "2adfa4daf80c14dc36f522cf190eb5c4ee3e28008fc6394397c16f62a26258c2", [:rebar3], [], "hexpm"},
   "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], [], "hexpm"},
   "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], [], "hexpm"},
   "unicode_util_compat": {:hex, :unicode_util_compat, "0.3.1", "a1f612a7b512638634a603c8f401892afbf99b8ce93a45041f8aaca99cadb85e", [:rebar3], [], "hexpm"},

mix.lock

@@ -7,11 +7,6 @@ defmodule LoggerTelegramBackendTest do
     Logger.remove_backend(:console)
   end
 
-  setup do
-    Logger.remove_backend(LoggerTelegramBackend)
-    :ok
-  end
-
   test "logs the message to the specified sender" do
     :ok = configure()
 
@@ -33,8 +28,7 @@ defmodule LoggerTelegramBackendTest do
         <<_line::size(16)>> <>
         "\n" <>
         "Function: \"test formats the message with markdown/1\"\n" <>
-        "Module: LoggerTelegramBackendTest\n" <>
-        "File:" <> _file
+        "Module: LoggerTelegramBackendTest\n" <> "File:" <> _file
     }
   end
 
@@ -87,6 +81,7 @@ defmodule LoggerTelegramBackendTest do
     with true <- Process.register(self(), :logger_telegram_backend_test),
          :ok <-
            Application.put_env(:logger, :telegram, Keyword.merge(opts, sender: {TestSender, []})),
+         _ <- Logger.remove_backend(LoggerTelegramBackend),
          {:ok, _} <- Logger.add_backend(LoggerTelegramBackend) do
       :ok
     end