Update Nebulex

Author: cabol

.credo.exs

@@ -8,20 +8,9 @@
       },
       color: true,
       checks: [
-        # Design Checks
-        {Credo.Check.Design.AliasUsage, priority: :low},
-
-        # Deactivate due to they're not compatible with current Elixir version
-        {Credo.Check.Refactor.MapInto, false},
-        {Credo.Check.Warning.LazyLogging, false},
-
         # Readability Checks
         {Credo.Check.Readability.MaxLineLength, priority: :low, max_length: 100},
 
-        # Refactoring Opportunities
-        {Credo.Check.Refactor.LongQuoteBlocks, false},
-        {Credo.Check.Refactor.CyclomaticComplexity, max_complexity: 15},
-
         # TODO and FIXME do not cause the build to fail
         {Credo.Check.Design.TagTODO, exit_status: 0},
         {Credo.Check.Design.TagFIXME, exit_status: 0}

README.md

@@ -1,20 +1,14 @@
 # Nebulex.Adapters.Cachex
-> ### Nebulex adapter for [Cachex][Cachex]
-> Cachex via Nebulex out-of-box.
+> A [Nebulex][Nebulex] adapter for [Cachex][Cachex].
 
+[Nebulex]: https://github.com/cabol/nebulex
 [Cachex]: https://github.com/whitfin/cachex
 
 ![CI](https://github.com/cabol/nebulex_adapters_cachex/workflows/CI/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/cabol/nebulex_adapters_cachex/badge.svg?branch=main)](https://coveralls.io/github/cabol/nebulex_adapters_cachex?branch=main)
+[![Coverage Status](https://img.shields.io/coveralls/cabol/nebulex_adapters_cachex.svg)](https://coveralls.io/github/cabol/nebulex_adapters_cachex)
 [![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)
 
-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.
 
@@ -161,8 +155,8 @@ config :my_app, MyApp.NearCache,
 
 See [Nebulex examples](https://github.com/cabol/nebulex_examples). You will
 find examples for all different topologies, even using other adapters like
-Redis; for all examples you can just replace `Nebulex.Adapters.Local` by
-`Nebulex.Adapters.Cachex`.
+Redis; for all examples you just have to replace `Nebulex.Adapters.Local`
+by `Nebulex.Adapters.Cachex`.
 
 [nbx_redis_adapter]: https://github.com/cabol/nebulex_redis_adapter
 

lib/nebulex/adapters/cachex.ex

@@ -141,20 +141,22 @@ defmodule Nebulex.Adapters.Cachex do
 
   # Provide Cache Implementation
   @behaviour Nebulex.Adapter
+  @behaviour Nebulex.Adapter.Entry
   @behaviour Nebulex.Adapter.Queryable
   @behaviour Nebulex.Adapter.Persistence
+  @behaviour Nebulex.Adapter.Stats
 
   # Inherit default transaction implementation
   use Nebulex.Adapter.Transaction
 
   import Nebulex.Helpers
 
-  alias Cachex.Query
+  alias Cachex.{Options, Query}
   alias Nebulex.Entry
 
   @compile {:inline, to_ttl: 1}
 
-  ## Adapter
+  ## Nebulex.Adapter
 
   @impl true
   defmacro __before_compile__(_), do: :ok
@@ -167,14 +169,24 @@ defmodule Nebulex.Adapters.Cachex do
         Cachex
       ])
 
+    stats =
+      if opts[:stats_counter] do
+        true
+      else
+        Options.get(opts, :stats, &is_boolean/1, false)
+      end
+
     child_spec =
       opts
       |> Keyword.put(:name, name)
+      |> Keyword.put(:stats, stats)
       |> Cachex.child_spec()
 
-    {:ok, child_spec, %{name: name}}
+    {:ok, child_spec, %{name: name, stats: stats}}
   end
 
+  ## Nebulex.Adapter.Entry
+
   @impl true
   def get(%{name: name}, key, _opts) do
     Cachex.get!(name, key)
@@ -278,41 +290,45 @@ defmodule Nebulex.Adapters.Cachex do
   end
 
   @impl true
-  def incr(%{name: name}, key, incr, :infinity, opts) do
-    Cachex.incr!(name, key, incr, initial: opts[:default] || 0)
+  def update_counter(%{name: name}, key, amount, :infinity, default, _opts) do
+    Cachex.incr!(name, key, amount, initial: default)
   end
 
-  def incr(%{name: name}, key, incr, ttl, opts) do
+  def update_counter(%{name: name}, key, incr, ttl, default, _opts) do
     # FIXME: This is a workaround since Cachex does not support `:ttl` here.
     #        Fix it if a better solution comes up.
     Cachex.transaction!(name, [key], fn worker ->
-      counter = Cachex.incr!(worker, key, incr, initial: opts[:default] || 0)
+      counter = Cachex.incr!(worker, key, incr, initial: default)
       if ttl = to_ttl(ttl), do: Cachex.expire!(worker, key, ttl)
       counter
     end)
   end
 
+  ## Nebulex.Adapter.Queryable
+
   @impl true
-  def size(%{name: name}) do
+  def execute(%{name: name}, :count_all, nil, _opts) do
     Cachex.size!(name)
   end
 
-  @impl true
-  def flush(%{name: name}) do
-    size = Cachex.size!(name)
-    true = Cachex.reset!(name)
-    size
+  def execute(%{name: name}, :delete_all, nil, _opts) do
+    Cachex.clear!(name)
   end
 
-  ## Queryable
+  def execute(%{name: name}, :delete_all, :expired, _opts) do
+    Cachex.purge!(name)
+  end
 
-  @impl true
-  def all(adapter_meta, query, opts) do
+  def execute(adapter_meta, :all, query, opts) do
     adapter_meta
     |> stream(query, opts)
     |> Enum.to_list()
   end
 
+  def execute(_adapter_meta, operation, query, _opts) do
+    raise Nebulex.QueryError, message: "unsupported #{operation}", query: query
+  end
+
   @impl true
   def stream(adapter_meta, nil, opts) do
     stream(adapter_meta, Query.create(true, :key), opts)
@@ -344,7 +360,7 @@ defmodule Nebulex.Adapters.Cachex do
 
   defp maybe_return_entry(query, _return), do: query
 
-  ## Persistence
+  ## Nebulex.Adapter.Persistence
 
   @impl true
   def dump(%{name: name}, path, opts) do
@@ -362,6 +378,25 @@ defmodule Nebulex.Adapters.Cachex do
     end
   end
 
+  ## Nebulex.Adapter.Stats
+
+  @impl true
+  def stats(%{name: name, stats: stats}) do
+    if stats do
+      # IO.puts "#=> Stats: #{inspect(Cachex.stats(name))}"
+
+      {meta, stats} =
+        name
+        |> Cachex.stats!()
+        |> Map.pop(:meta, %{})
+
+      %Nebulex.Stats{
+        measurements: stats,
+        metadata: meta
+      }
+    end
+  end
+
   ## Private Functions
 
   defp to_ttl(:infinity), do: nil

mix.exs

@@ -1,8 +1,9 @@
 defmodule NebulexAdaptersCachex.MixProject do
   use Mix.Project
 
-  @version "1.0.0-dev"
   @source_url "https://github.com/cabol/nebulex_adapters_cachex"
+  @version "1.0.0-dev"
+  @nbx_vsn "2.0.0-rc.2"
 
   def project do
     [
@@ -28,7 +29,7 @@ defmodule NebulexAdaptersCachex.MixProject do
 
       # Hex
       package: package(),
-      description: "Nebulex adapter for Cachex",
+      description: "A Nebulex adapter for Cachex",
 
       # Docs
       docs: [
@@ -69,16 +70,18 @@ defmodule NebulexAdaptersCachex.MixProject do
 
   defp nebulex_dep do
     if path = System.get_env("NEBULEX_PATH") do
-      {:nebulex, "~> 2.0.0-rc.1", path: path}
+      {:nebulex, "~> #{@nbx_vsn}", path: path}
     else
-      {:nebulex, "~> 2.0.0-rc.1"}
+      # {:nebulex, "~> #{@nbx_vsn}"}
+      {:nebulex, github: "cabol/nebulex"}
     end
   end
 
   defp aliases do
     [
       "nbx.setup": [
-        "cmd git clone --depth 1 --branch master https://github.com/cabol/nebulex.git"
+        "cmd rm -rf nebulex",
+        "cmd git clone --depth 1 --branch master https://github.com/cabol/nebulex"
       ],
       check: [
         "compile --warnings-as-errors",

mix.lock

@@ -19,14 +19,14 @@
   "jason": {:hex, :jason, "1.2.2", "ba43e3f2709fd1aa1dce90aaabfd039d000469c05c56f0b8e31978e03fa39052", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "18a228f5f0058ee183f29f9eae0805c6e59d61c3b006760668d8d18ff0d12179"},
   "jumper": {:hex, :jumper, "1.0.1", "3c00542ef1a83532b72269fab9f0f0c82bf23a35e27d278bfd9ed0865cecabff", [:mix], [], "hexpm", "318c59078ac220e966d27af3646026db9b5a5e6703cb2aa3e26bcfaba65b7433"},
   "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.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"},
+  "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"},
   "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"},
+  "nebulex": {:git, "https://github.com/cabol/nebulex.git", "de11a4b0694a860ba4ce8ee42638ad982fe74494", []},
   "nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"},
-  "parse_trans": {:hex, :parse_trans, "3.3.0", "09765507a3c7590a784615cfd421d101aec25098d50b89d7aa1d66646bc571c1", [:rebar3], [], "hexpm", "17ef63abde837ad30680ea7f857dd9e7ced9476cdd7b0394432af4bfc241b960"},
+  "parse_trans": {:hex, :parse_trans, "3.3.1", "16328ab840cc09919bd10dab29e431da3af9e9e7e7e6f0089dd5a2d2820011d8", [:rebar3], [], "hexpm", "07cd9577885f56362d414e8c4c4e6bdf10d43a8767abb92d24cbe8b24c54888b"},
   "sleeplocks": {:hex, :sleeplocks, "1.1.1", "3d462a0639a6ef36cc75d6038b7393ae537ab394641beb59830a1b8271faeed3", [:rebar3], [], "hexpm", "84ee37aeff4d0d92b290fff986d6a95ac5eedf9b383fadfd1d88e9b84a1c02e1"},
-  "sobelow": {:hex, :sobelow, "0.10.6", "ac9ebd742035b119eb00a4b1416098b88a4d54d2f262a42602e1e9e3ed4c2afd", [:mix], [], "hexpm", "06e426b8dc0bc80ab1333ce89b904c720474824825b9ceb3dc424eb0f731b6e9"},
+  "sobelow": {:hex, :sobelow, "0.11.0", "cdc17e3a9f1ea78dc55dbe0a03121cb6767fef737c6d9f1e62ee7e78730abccc", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "c57807bfe6f231338b657781f89ef0320b66a0dbe779aa911d6ed27cfa14ae6e"},
   "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.6", "cf344f5692c82d2cd7554f5ec8fd961548d4fd09e7d22f5b62482e5aeaebd4b0", [:make, :mix, :rebar3], [], "hexpm", "bdb0d2471f453c88ff3908e7686f86f9be327d065cc1ec16fa4540197ea04680"},
   "stream_data": {:hex, :stream_data, "0.5.0", "b27641e58941685c75b353577dc602c9d2c12292dd84babf506c2033cd97893e", [:mix], [], "hexpm", "012bd2eec069ada4db3411f9115ccafa38540a3c78c4c0349f151fc761b9e271"},
   "unicode_util_compat": {:hex, :unicode_util_compat, "0.7.0", "bc84380c9ab48177092f43ac89e4dfa2c6d62b40b8bd132b1059ecc7232f9a78", [:rebar3], [], "hexpm", "25eee6d67df61960cf6a794239566599b09e17e668d3700247bc498638152521"},

test/nebulex_adapters_cachex/local_test.exs

@@ -7,4 +7,20 @@ defmodule NebulexAdaptersCachex.LocalTest do
   alias NebulexAdaptersCachex.TestCache.Local, as: Cache
 
   setup_with_dynamic_cache(Cache, :local_with_cachex)
+
+  describe "count_all/2 error:" do
+    test "unsupported query", %{cache: cache} do
+      assert_raise Nebulex.QueryError, ~r"unsupported count_all in query", fn ->
+        cache.count_all(:unexpired)
+      end
+    end
+  end
+
+  describe "delete_all/2 error:" do
+    test "unsupported query", %{cache: cache} do
+      assert_raise Nebulex.QueryError, ~r"unsupported delete_all in query", fn ->
+        cache.delete_all(:unexpired)
+      end
+    end
+  end
 end