Prepare 3.1.0 (#341)

* fix dialyzer warnings

* fix credo

* update changelog

* update version

* fix a couple treetops

* fix io device name in doc

Author: mitchellhenke

.credo.exs

@@ -83,7 +83,7 @@
         {Credo.Check.Refactor.CyclomaticComplexity},
         {Credo.Check.Refactor.NegatedConditionsInUnless},
         {Credo.Check.Refactor.NegatedConditionsWithElse},
-        {Credo.Check.Refactor.Nesting},
+        {Credo.Check.Refactor.Nesting, max_nesting: 3},
         {Credo.Check.Refactor.UnlessWithElse},
 
         {Credo.Check.Warning.IExPry},
@@ -106,4 +106,4 @@
       ]
     }
   ]
-}
+}

CHANGELOG.md

@@ -10,6 +10,10 @@ Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Changed
+
+## [3.1.0] - 2019-02-25
+
 ### Changed
 
   - `Timber.InvalidAPIKeyError` is now `Timber.Errors.InvalidAPIKeyError`
@@ -26,6 +30,7 @@ Versioning](http://semver.org/spec/v2.0.0.html).
   - Errors are no longer automatically parsed in the logger backend. Please use the
     [`:timber_exceptions`](https://github.com/timberio/timber-elixir-exceptions) library if you'd
     like to structure errors. This is a proper approach to structuring these events.
+  - Handle unencodable content
 
 ## 3.0.0 - 2018-12-20
 
@@ -57,4 +62,5 @@ Versioning](http://semver.org/spec/v2.0.0.html).
     expected
   - Removed the test event Mix task
 
-[Unreleased]: https://github.com/timberio/timber-elixir/compare/v3.0.0...HEAD
+[Unreleased]: https://github.com/timberio/timber-elixir/compare/v3.1.0...HEAD
+[3.1.0]: https://github.com/timberio/timber-elixir/compare/v3.0.0...v3.1.0

README.md

@@ -29,7 +29,7 @@ The result: Beautiful, fast, powerful Elixir logging.
 
     ```elixir
     defp deps do
-      [{:timber, "~> 3.0"}]
+      [{:timber, "~> 3.1"}]
     end
     ```
 

lib/mix/tasks/test_the_pipes.ex

@@ -35,7 +35,7 @@ defmodule Mix.Tasks.Timber.TestThePipes do
     {:ok, _} = Application.ensure_all_started(:timber)
 
     header = ~S"""
-     ^  ^    ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^
+      ^  ^   ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^
      /|\/|\ /|\/|\/|\ /|\    /\-_--\    /|\/|\ /|\/|\/|\ /|\/|\
      /|\/|\ /|\/|\/|\ /|\   /  \_-__\   /|\/|\ /|\/|\/|\ /|\/|\
      /|\/|\ /|\/|\/|\ /|\   |[]| [] |   /|\/|\ /|\/|\/|\ /|\/|\
@@ -116,7 +116,7 @@ defmodule Mix.Tasks.Timber.TestThePipes do
 
     api_key = Config.api_key()
     message = "Testing the pipes (click the inspect icon to view more details)"
-    log_entry = LogEntry.new(DateTime.utc_now(), "debug", message)
+    log_entry = LogEntry.new(Timber.Utils.Timestamp.now(), :debug, message)
     log_map = LogEntry.to_map!(log_entry)
     body = Msgpax.pack!([log_map])
 

lib/timber.ex

@@ -35,7 +35,7 @@ defmodule Timber do
 
   See `add_context/2`
   """
-  @spec add_context(Context.element()) :: :ok
+  @spec add_context(map()) :: :ok
   def add_context(data, location \\ :local)
 
   @doc """
@@ -44,7 +44,7 @@ defmodule Timber do
   The second parameter indicates where you want the context to be
   stored. See `context_location` for more details.
   """
-  @spec add_context(Context.element(), context_location) :: :ok
+  @spec add_context(map(), context_location) :: :ok
   def add_context(data, :local) do
     LocalContext.add(data)
   end

lib/timber/config.ex

@@ -60,7 +60,7 @@ defmodule Timber.Config do
   ## Example
 
       config :timber,
-        debug_io_device: :stdout
+        debug_io_device: :stdio
 
   """
   def debug_io_device do

lib/timber/contextable.ex

@@ -46,7 +46,7 @@ defprotocol Timber.Contextable do
   @doc """
   Converts the data structure into a `Timber.Context.t`.
   """
-  @spec to_context(map() | list()) :: Timber.Context.element()
+  @spec to_context(map() | list()) :: map()
   def to_context(data)
 end
 

lib/timber/global_context.ex

@@ -15,7 +15,7 @@ defmodule Timber.GlobalContext do
   @doc """
   Merges the provided context into the existing context
   """
-  @spec add(Context.element()) :: :ok
+  @spec add(map()) :: :ok
   def add(context) do
     load()
     |> Context.merge(context)

lib/timber/http_clients/fake.ex

@@ -58,7 +58,7 @@ defmodule Timber.HTTPClients.Fake do
   end
 
   def wait_on_response(_ref, _timeout) do
-    :pass
+    {:ok, 200}
   end
 
   def request(method, url, headers, body) do

lib/timber/local_context.ex

@@ -16,7 +16,7 @@ defmodule Timber.LocalContext do
   `Timber.Context.add/2` is called to merge the existing context
   with the provided context.
   """
-  @spec add(Context.element()) :: :ok
+  @spec add(map()) :: :ok
   def add(context) do
     load()
     |> Context.merge(context)