Add benchmarks and improve docs

Author: cabol

.formatter.exs

@@ -1,4 +1,4 @@
 # Used by "mix format"
 [
-  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test,benchmarks}/**/*.{ex,exs}"]
 ]

.github/workflows/ci.yml

@@ -64,8 +64,8 @@ jobs:
         run: |
           mix local.hex --force
           mix local.rebar --force
+          mix nbx.setup
           mix deps.get
-          git clone --depth 1 --branch master https://github.com/cabol/nebulex.git
 
       - name: Run style and code consistency checks
         run: |

README.md

@@ -9,7 +9,13 @@
 [![Hex Version](https://img.shields.io/hexpm/v/nebulex_adapters_cachex.svg)](https://hex.pm/packages/nebulex_adapters_cachex)
 [![Docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/nebulex_adapters_cachex)
 
-See the [docs](https://hexdocs.pm/nebulex_adapters_cachex/)
+This adapter allows to use Cachex (a widely used and powerful cache in Elixir)
+via Nebulex, which means, you can use Nebulex as usual taking advantage of all
+its benefits (like the cache abstraction layer, distributed caching topologies,
+declarative caching annotations, and so on), and at the same time using Cachex
+as cache backend.
+
+See the [online documentation](https://hexdocs.pm/nebulex_adapters_cachex/)
 for more information.
 
 ## Installation
@@ -19,7 +25,7 @@ Add `:nebulex_adapters_cachex` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:nebulex_adapters_cachex, "~> 0.1.0"}
+    {:nebulex_adapters_cachex, "~> 1.0"}
   ]
 end
 ```
@@ -103,7 +109,8 @@ defp cachex_opts do
 end
 ```
 
-> See [Cachex.start_link/1][cachex_start_link] for more information.
+> See [Cachex.start_link/1][cachex_start_link] for more information
+  about options.
 
 [cachex_start_link]: https://hexdocs.pm/cachex/Cachex.html#start_link/1
 
@@ -158,3 +165,76 @@ Redis; for all examples you can just replace `Nebulex.Adapters.Local` by
 `Nebulex.Adapters.Cachex`.
 
 [nbx_redis_adapter]: https://github.com/cabol/nebulex_redis_adapter
+
+## Testing
+
+Since `Nebulex.Adapters.Cachex` uses the support modules and shared tests
+from `Nebulex` and by default its test folder is not included in the Hex
+dependency, the following steps are required for running the tests.
+
+First of all, make sure you set the environment variable `NEBULEX_PATH`
+to `nebulex`:
+
+```
+export NEBULEX_PATH=nebulex
+```
+
+Second, make sure you fetch `:nebulex` dependency directly from GtiHub
+by running:
+
+```
+mix nbx.setup
+```
+
+Third, fetch deps:
+
+```
+mix deps.get
+```
+
+Finally, you can run the tests:
+
+```
+mix test
+```
+
+Running tests with coverage:
+
+```
+mix coveralls.html
+```
+
+You will find the coverage report within `cover/excoveralls.html`.
+
+## Benchmarks
+
+Benchmarks were added using [benchee](https://github.com/PragTob/benchee), and
+they are located within the directory [benchmarks](./benchmarks).
+
+To run the benchmarks:
+
+```
+MIX_ENV=test mix run benchmarks/benchmark.exs
+```
+
+## Contributing
+
+Contributions to Nebulex are very welcome and appreciated!
+
+Use the [issue tracker](https://github.com/cabol/nebulex_adapters_cachex/issues)
+for bug reports or feature requests. Open a
+[pull request](https://github.com/cabol/nebulex_adapters_cachex/pulls)
+when you are ready to contribute.
+
+When submitting a pull request you should not update the
+[CHANGELOG.md](CHANGELOG.md), and also make sure you test your changes
+thoroughly, include unit tests alongside new or changed code.
+
+Before to submit a PR it is highly recommended to run `mix check` and ensure
+all checks run successfully.
+
+## Copyright and License
+
+Copyright (c) 2020, Carlos Bolaños.
+
+Nebulex.Adapters.Cachex source code is licensed under the [MIT License](LICENSE).

benchmarks/benchmark.exs

@@ -0,0 +1,75 @@
+## Benchmarks
+
+defmodule Cache do
+  @moduledoc false
+  use Nebulex.Cache,
+    otp_app: :nebulex,
+    adapter: Nebulex.Adapters.Cachex
+end
+
+benchmarks = %{
+  "get" => fn input ->
+    Cache.get(input)
+  end,
+  "get_all" => fn input ->
+    Cache.get_all([input, "foo", "bar"])
+  end,
+  "put" => fn input ->
+    Cache.put(input, input)
+  end,
+  "put_new" => fn input ->
+    Cache.put_new(input, input)
+  end,
+  "replace" => fn input ->
+    Cache.replace(input, input)
+  end,
+  "put_all" => fn input ->
+    Cache.put_all([{input, input}, {"foo", "bar"}])
+  end,
+  "delete" => fn input ->
+    Cache.delete(input)
+  end,
+  "take" => fn input ->
+    Cache.take(input)
+  end,
+  "has_key?" => fn input ->
+    Cache.has_key?(input)
+  end,
+  "size" => fn _input ->
+    Cache.size()
+  end,
+  "ttl" => fn input ->
+    Cache.ttl(input)
+  end,
+  "expire" => fn input ->
+    Cache.expire(input, 1)
+  end,
+  "incr" => fn _input ->
+    Cache.incr(:counter, 1)
+  end,
+  "update" => fn input ->
+    Cache.update(input, 1, &Kernel.+(&1, 1))
+  end,
+  "all" => fn _input ->
+    Cache.all()
+  end
+}
+
+# start local cache
+{:ok, local} = Cache.start_link()
+
+Benchee.run(
+  benchmarks,
+  inputs: %{"rand" => 100_000},
+  before_each: fn n -> :rand.uniform(n) end,
+  formatters: [
+    {Benchee.Formatters.Console, comparison: false, extended_statistics: true},
+    {Benchee.Formatters.HTML, extended_statistics: true, auto_open: false}
+  ],
+  print: [
+    fast_warning: false
+  ]
+)
+
+# stop cache
+if Process.alive?(local), do: Supervisor.stop(local)

lib/nebulex/adapters/cachex.ex

@@ -1,15 +1,14 @@
 defmodule Nebulex.Adapters.Cachex do
   @moduledoc """
-  Nebulex adapter for Cachex.
+  Nebulex adapter for [Cachex][Cachex].
 
-  Cachex is one of the most used cache (maybe the most used one) in Elixir.
-  For that reason, Nebulex provides this adapter to use Cachex via Nebulex
-  taking advantage of all their benefits and/or features.
+  [Cachex]: http://hexdocs.pm/cachex/Cachex.html
 
-  Cachex is now a very good alternative for local caching aside from the
-  built-in local adapter provided by Nebulex. Besides, you can setup distributed
-  topologies by using the distributed adapters Nebulex brings with it and set up
-  Cachex as local cache.
+  This adapter allows to use Cachex (a widely used and powerful cache in Elixir)
+  via Nebulex, which means, you can use Nebulex as usual taking advantage of all
+  its benefits (e.g.: cache abstraction layer, distributed caching topologies,
+  declarative caching annotations, and so on), and at the same time using Cachex
+  as cache backend.
 
   ## Options
 

mix.exs

@@ -77,6 +77,9 @@ defmodule NebulexAdaptersCachex.MixProject do
 
   defp aliases do
     [
+      "nbx.setup": [
+        "cmd git clone --depth 1 --branch master https://github.com/cabol/nebulex.git"
+      ],
       check: [
         "compile --warnings-as-errors",
         "format --check-formatted",

mix.lock

@@ -22,6 +22,7 @@
   "makeup_elixir": {:hex, :makeup_elixir, "0.15.0", "98312c9f0d3730fde4049985a1105da5155bfe5c11e47bdc7406d88e01e4219b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "75ffa34ab1056b7e24844c90bfc62aaf6f3a37a15faa76b07bc5eba27e4a8b4a"},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"},
   "mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"},
+  "nebulex": {:hex, :nebulex, "2.0.0-rc.1", "ad9fdc3b2b91b7de9d55dabfaac2994b91be29602b2715daf530bdd54509b4db", [:mix], [{:decorator, "~> 1.3", [hex: :decorator, repo: "hexpm", optional: true]}, {:shards, "~> 1.0", [hex: :shards, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4", [hex: :telemetry, repo: "hexpm", optional: true]}], "hexpm", "1d78bd1f9e648e5600cb2a349114957296f824641b57e72545ace6cb6cc22110"},
   "nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"},
   "parse_trans": {:hex, :parse_trans, "3.3.0", "09765507a3c7590a784615cfd421d101aec25098d50b89d7aa1d66646bc571c1", [:rebar3], [], "hexpm", "17ef63abde837ad30680ea7f857dd9e7ced9476cdd7b0394432af4bfc241b960"},
   "sleeplocks": {:hex, :sleeplocks, "1.1.1", "3d462a0639a6ef36cc75d6038b7393ae537ab394641beb59830a1b8271faeed3", [:rebar3], [], "hexpm", "84ee37aeff4d0d92b290fff986d6a95ac5eedf9b383fadfd1d88e9b84a1c02e1"},