0.1.0

Author: Adrien Moreau

README.md

@@ -1,3 +1,81 @@
 # buffer
 Provide read and write buffers for Elixir
 
+[![Hex.pm](https://img.shields.io/hexpm/v/buffer.svg?style=flat-square)](https://hex.pm/packages/buffer)
+
+## Description
+
+buffer is a library to create read or write buffer easily.
+
+## Usage
+
+### Write Buffer for KeyList
+
+```elixir
+## Declaration of the buffer
+defmodule BufferKeyListLimit do
+  use Buffer.Write.KeyList
+  buffer interval: 1000, limit: 10, write: &write/1
+  def write(keylists) do
+    ## Write here your flushing function
+  end
+end
+
+## Usage
+BufferKeyListLimit.add(:key1, "value1")
+BufferKeyListLimit.add(:key1, "value2")
+BufferKeyListLimit.add(:key2, "value3")
+
+## The write function will receive this value
+[{:key1, ["value1", "value2"]}, {:key2, ["value3"]}]
+
+## API
+BufferKeyListLimit.sync()
+BufferKeyListLimit.sync(:key1)
+```
+
+### Write Buffer for Counters
+
+```elixir
+## Declaration of the buffer
+defmodule BufferCount do
+  use Buffer.Write.Count
+  buffer interval: 1000, write: &write/1
+  def write(counters) do
+    ## Write here your flushing function
+  end
+end
+
+## Usage
+BufferCount.incr(:key1)
+BufferCount.incr(:key1)
+BufferCount.incr(:key2, 10)
+BufferCount.incr(:key2, 15)
+
+## The write function will receive this value
+[{:key1, 2}, {:key2, 25}]
+
+## API
+BufferCount.sync()
+```
+
+### Read Buffer
+
+```elixir
+## Declaration of the buffer
+defmodule BufferRead do
+  use Buffer.Read
+  buffer interval: 1000, read: &read/0
+  def read() do
+    ## Write here your reading function
+    [{:key1, "value1"}, {:key2, "value2"}]
+  end
+end
+
+## Usage
+"value" = BufferRead.read(:key1)
+
+## API
+BufferRead.sync()
+
+```

VERSION

@@ -0,0 +1 @@
+0.1.0

mix.exs

@@ -1,10 +1,12 @@
 defmodule Buffer.Mixfile do
   use Mix.Project
 
+  @version File.read!("VERSION") |> String.strip
+
   def project do
     [
       app: :buffer,
-      version: "0.0.1",
+      version: @version,
       elixir: "~> 1.2",
       build_embedded: Mix.env == :prod,
       start_permanent: Mix.env == :prod,

test/buffer_test.exs

@@ -11,7 +11,7 @@ defmodule BufferTest do
     {:ok, []}
   end
 
-  test "0000# KeyList, Limit + Sync" do
+  test "0000# Write, KeyList, Limit + Sync" do
     for x <- 1..4, do: BufferKeyListLimit.add(1, x)
     for x <- 1..25, do: BufferKeyListLimit.add(2, x)
 
@@ -27,7 +27,7 @@ defmodule BufferTest do
     assert(result == [{1,Enum.map(1..4, &(&1))}, {2,Enum.map(21..25, &(&1))}])
   end
 
-  test "0001# KeyList, Interval" do
+  test "0001# Write, KeyList, Interval" do
     1..4 |> Enum.map(&(BufferKeyListInterval.add(1, &1)))
 
     result = BufferKeyListResult.dump_table()
@@ -39,15 +39,20 @@ defmodule BufferTest do
     assert([{_, [{1, [1, 2, 3, 4]}]}] = result)
   end
 
-  test "0010# Count, Sync" do
-    for x <- 1..100, do: BufferCount.incr(:key1)
+  test "0010# Read, Count, Sync" do
+    for _ <- 1..100, do: BufferCount.incr(:key1)
     for x <- 1..100, do: BufferCount.incr(:key2, x)
 
     BufferCount.sync()
 
     result = BufferKeyListResult.dump_table()
     assert([{_, [key2: 5050, key1: 100]}] = result)
   end
+
+  test "0100# Read, Read" do
+    BufferRead.sync()
+    assert(BufferRead.read(:key1) == "value1")
+  end
 end
 
 defmodule TestSupervisor do
@@ -61,7 +66,8 @@ defmodule TestSupervisor do
       BufferKeyListResult.worker,
       BufferKeyListLimit.worker,
       BufferKeyListInterval.worker,
-      BufferCount.worker
+      BufferCount.worker,
+      BufferRead.worker
     ]
     supervise(children, strategy: :one_for_one, max_restarts: 1, max_seconds: 1)
   end
@@ -96,3 +102,11 @@ defmodule BufferCount do
     BufferKeyListResult.add(__MODULE__, counters)
   end
 end
+
+defmodule BufferRead do
+  use Buffer.Read
+  buffer interval: 1000, read: &read/0
+  def read() do
+    [{:key1, "value1"}, {:key2, "value2"}]
+  end
+end