Merge branch 'chore/increase-code-coverage'

Author: Christopher Keathley

config/config.exs

@@ -15,7 +15,12 @@ defmodule CircularBuffer do
 
   defstruct [:a, :b, :max_size, :count]
   @typedoc "A circular buffer"
-  @opaque t() :: %__MODULE__{a: list(), b: list(), max_size: pos_integer(), count: non_neg_integer()}
+  @opaque t() :: %__MODULE__{
+            a: list(),
+            b: list(),
+            max_size: pos_integer(),
+            count: non_neg_integer()
+          }
 
   alias __MODULE__, as: CB
 
@@ -37,7 +42,7 @@ defmodule CircularBuffer do
 
   def insert(%CB{count: count, max_size: max_size} = cb, item) when count < max_size do
     %CB{cb | a: [item | cb.a], count: cb.count + 1}
-    end
+  end
 
   def insert(%CB{b: []} = cb, item) do
     new_b = cb.a |> Enum.reverse() |> tl()
@@ -55,6 +60,16 @@ defmodule CircularBuffer do
 
   @doc """
   Returns the newest element in the buffer
+
+  ## Examples
+
+      iex> cb = CircularBuffer.new(3)
+      iex> CircularBuffer.newest(cb)
+      nil
+      iex> cb = Enum.reduce(1..4, cb, fn n, cb -> CircularBuffer.insert(cb, n) end)
+      iex> CircularBuffer.newest(cb)
+      4
+
   """
   @spec newest(t()) :: any()
   def newest(%CB{a: [newest | _rest]}), do: newest
@@ -69,6 +84,17 @@ defmodule CircularBuffer do
 
   @doc """
   Checks the buffer to see if its empty
+
+  Returns `true` if the given circular buffer is empty, otherwise `false`.
+
+  ## Examples
+
+      iex> cb = CircularBuffer.new(1)
+      iex> CircularBuffer.empty?(cb)
+      true
+      iex> cb |> CircularBuffer.insert(1) |> CircularBuffer.empty?()
+      false
+
   """
   @spec empty?(t()) :: boolean()
   def empty?(%CB{} = cb) do

lib/circular_buffer.ex

@@ -1,12 +1,12 @@
 %{
   "bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm", "7af5c7e09fe1d40f76c8e4f9dd2be7cebd83909f31fee7cd0e9eadc567da8353"},
-  "credo": {:hex, :credo, "1.5.5", "e8f422026f553bc3bebb81c8e8bf1932f498ca03339856c7fec63d3faac8424b", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2.8", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "dd8623ab7091956a855dc9f3062486add9c52d310dfd62748779c4315d8247de"},
+  "credo": {:hex, :credo, "1.6.4", "ddd474afb6e8c240313f3a7b0d025cc3213f0d171879429bf8535d7021d9ad78", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2.8", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "c28f910b61e1ff829bffa056ef7293a8db50e87f2c57a9b5c3f57eee124536b7"},
   "dialyxir": {:hex, :dialyxir, "1.1.0", "c5aab0d6e71e5522e77beff7ba9e08f8e02bad90dfbeffae60eaf0cb47e29488", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "07ea8e49c45f15264ebe6d5b93799d4dd56a44036cf42d0ad9c960bc266c0b9a"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.13", "0c98163e7d04a15feb62000e1a891489feb29f3d10cb57d4f845c405852bbef8", [:mix], [], "hexpm", "d602c26af3a0af43d2f2645613f65841657ad6efc9f0e361c3b6c06b578214ba"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "ex_doc": {:hex, :ex_doc, "0.24.2", "e4c26603830c1a2286dae45f4412a4d1980e1e89dc779fcd0181ed1d5a05c8d9", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "e134e1d9e821b8d9e4244687fb2ace58d479b67b282de5158333b0d57c6fb7da"},
   "file_system": {:hex, :file_system, "0.2.10", "fb082005a9cd1711c05b5248710f8826b02d7d1784e7c3451f9c1231d4fc162d", [:mix], [], "hexpm", "41195edbfb562a593726eda3b3e8b103a309b733ad25f3d642ba49696bf715dc"},
-  "jason": {:hex, :jason, "1.2.2", "ba43e3f2709fd1aa1dce90aaabfd039d000469c05c56f0b8e31978e03fa39052", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "18a228f5f0058ee183f29f9eae0805c6e59d61c3b006760668d8d18ff0d12179"},
+  "jason": {:hex, :jason, "1.3.0", "fa6b82a934feb176263ad2df0dbd91bf633d4a46ebfdffea0c8ae82953714946", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "53fc1f51255390e0ec7e50f9cb41e751c260d065dcba2bf0d08dc51a4002c2ac"},
   "libgraph": {:hex, :libgraph, "0.13.3", "20732b7bafb933dcf7351c479e03076ebd14a85fd3202c67a1c197f4f7c2466b", [:mix], [], "hexpm", "78f2576eef615440b46f10060b1de1c86640441422832052686df53dc3c148c6"},
   "makeup": {:hex, :makeup, "1.0.5", "d5a830bc42c9800ce07dd97fa94669dfb93d3bf5fcf6ea7a0c67b2e0e4a7f26c", [:mix], [{:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cfa158c02d3f5c0c665d0af11512fed3fba0144cf1aadee0f2ce17747fba2ca9"},
   "makeup_elixir": {:hex, :makeup_elixir, "0.15.1", "b5888c880d17d1cc3e598f05cdb5b5a91b7b17ac4eaf5f297cb697663a1094dd", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "db68c173234b07ab2a07f645a5acdc117b9f99d69ebf521821d89690ae6c6ec8"},

mix.lock

@@ -1,6 +1,7 @@
 defmodule CircularBufferTest do
   use ExUnit.Case, async: false
   use PropCheck
+  doctest CircularBuffer
 
   alias CircularBuffer, as: CB
 
@@ -39,6 +40,7 @@ defmodule CircularBufferTest do
 
   property "member?/1" do
     items = such_that({a, b} <- {pos_integer(), pos_integer()}, when: a != b)
+
     forall {a, b} <- items do
       cb = CB.new(1) |> CB.insert(a)
       !Enum.member?(cb, b) && Enum.member?(cb, a)
@@ -47,7 +49,7 @@ defmodule CircularBufferTest do
 
   property "implements Enumerable" do
     forall is <- list(integer()) do
-      buffer = Enum.reduce(is, CB.new(length(is)+1), fn i, cb -> CB.insert(cb, i) end)
+      buffer = Enum.reduce(is, CB.new(length(is) + 1), fn i, cb -> CB.insert(cb, i) end)
 
       Enum.reduce(buffer, 0, fn acc, i -> acc + i end) == Enum.sum(is)
     end
@@ -103,15 +105,15 @@ defmodule CircularBufferTest do
       oldest =
         iis
         |> Enum.reverse()
-        |> Enum.drop(size-1)
+        |> Enum.drop(size - 1)
         |> Enum.at(0)
 
       CB.oldest(buffer) == oldest
     end
   end
 
   test "can be inspected" do
-    str = inspect(Enum.into([1,2,3,4], CB.new(4)))
+    str = inspect(Enum.into([1, 2, 3, 4], CB.new(4)))
     assert str == "#CircularBuffer<[1, 2, 3, 4]>"
   end
 
@@ -148,16 +150,17 @@ defmodule CircularBufferTest do
 
   def size_and_list do
     let size <- pos_integer() do
-      let is <- ints(size*2, []) do
+      let is <- ints(size * 2 + 1, []) do
         {size, is}
       end
     end
   end
 
   defp ints(0, acc), do: acc
+
   defp ints(size, acc) do
     let i <- integer() do
-      ints(size-1, [i | acc])
+      ints(size - 1, [i | acc])
     end
   end
 end