Update Nebulex

Author: cabol

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
       - main
 
 jobs:
-  nebulex_test:
+  test:
     name: >-
       Nebulex.Adapters.Local Test (Elixir ${{ matrix.elixir }} /
       OTP ${{ matrix.otp }} /
@@ -19,29 +19,26 @@ jobs:
     strategy:
       matrix:
         include:
-          - elixir: 1.17.x
+          - elixir: 1.18.x
             otp: 27.x
             os: 'ubuntu-latest'
-            style: true
+            lint: true
             coverage: true
             sobelow: true
             dialyzer: true
-            doctor: true
           - elixir: 1.17.x
-            otp: 26.x
-            os: 'ubuntu-latest'
-          - elixir: 1.16.x
-            otp: 26.x
+            otp: 27.x
             os: 'ubuntu-latest'
-          - elixir: 1.15.x
+          - elixir: 1.17.x
             otp: 25.x
             os: 'ubuntu-latest'
           - elixir: 1.14.x
-            otp: 23.x
-            os: 'ubuntu-20.04'
+            otp: 24.x
+            os: 'ubuntu-latest'
 
     env:
       GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+      CODECOV_TOKEN: '${{ secrets.CODECOV_TOKEN }}'
       MIX_ENV: test
       NEBULEX_PATH: nebulex
 
@@ -85,23 +82,42 @@ jobs:
           mix deps.get
         if: ${{ steps.mix-cache.outputs.cache-hit != 'true' }}
 
-      - name: Compile code
+      - name: Compile deps
+        run: mix deps.compile
+
+      - name: Check unused dependencies
+        run: mix deps.unlock --check-unused
+        if: ${{ matrix.lint }}
+
+      - name: Compile lint
         run: mix compile --warnings-as-errors
+        if: ${{ matrix.lint }}
 
       - name: Run style and code consistency checks
         run: |
           mix format --check-formatted
           mix credo --strict
-        if: ${{ matrix.style }}
+        if: ${{ matrix.lint }}
 
       - name: Run tests
         run: mix test --trace
         if: ${{ !matrix.coverage }}
 
       - name: Run tests with coverage
-        run: mix coveralls.github
+        run: mix coveralls.json
         if: ${{ matrix.coverage }}
 
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          fail_ci_if_error: true
+          flags: unittests-elixir-${{ matrix.elixir }}-otp-${{ matrix.otp }}
+        if: ${{ matrix.coverage }}
+
+      - name: Run sobelow
+        run: mix sobelow --skip --exit Low
+        if: ${{ matrix.sobelow }}
+
       - name: Restore PLT Cache
         uses: actions/cache@v3
         id: plt-cache

.tool-versions

@@ -1,2 +1,2 @@
-elixir 1.17.0-otp-27
-erlang 27.0
+elixir 1.18.2-otp-27
+erlang 27.2.1

LICENSE renamed to LICENSE.md

@@ -1,6 +1,6 @@
-MIT License
+# MIT License
 
-Copyright (c) 2023 Carlos Andres Bolaños R.A.
+Copyright (c) 2024 Carlos Andres Bolaños R.A.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,16 +1,12 @@
 # Nebulex Local
 > A generational local cache adapter for [Nebulex][Nebulex].
 
-[Nebulex]: https://github.com/cabol/nebulex
+[Nebulex]: http://github.com/cabol/nebulex
 
-![CI](https://github.com/nebulex-project/nebulex_local/workflows/CI/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/nebulex-project/nebulex_local/badge.svg?branch=main)](https://coveralls.io/github/nebulex-project/nebulex_local?branch=main)
-[![Hex Version](https://img.shields.io/hexpm/v/nebulex_local.svg)](https://hex.pm/packages/nebulex_local)
-[![Docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/nebulex_local)
-
-See the [online documentation][online_docs] for more information.
-
-[online_docs]: https://hexdocs.pm/nebulex_local/
+![CI](http://github.com/elixir-nebulex/nebulex_local/workflows/CI/badge.svg)
+[![Codecov](http://codecov.io/gh/elixir-nebulex/nebulex_local/graph/badge.svg)](http://codecov.io/gh/elixir-nebulex/nebulex_local/graph/badge.svg)
+[![Hex Version](http://img.shields.io/hexpm/v/nebulex_local.svg)](http://hex.pm/packages/nebulex_local)
+[![Documentation](http://img.shields.io/badge/Documentation-ff69b4)](http://hexdocs.pm/nebulex_local)
 
 ## Installation
 
@@ -19,7 +15,7 @@ Add `:nebulex_local` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:nebulex_local, "~> 3.0"}
+    {:nebulex_local, "~> 3.0.0-rc.1"}
   ]
 end
 ```
@@ -65,11 +61,13 @@ end
 
 See the [online documentation][online_docs] for more information.
 
+[online_docs]: http://hexdocs.pm/nebulex_local/
+
 ## Testing
 
-Since `Nebulex.Adapters.Local` 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.
+Since this adapter uses support modules and shared tests from `Nebulex`,
+but the test folder is not included in the Hex dependency, the following
+steps are required to run the tests.
 
 First of all, make sure you set the environment variable `NEBULEX_PATH`
 to `nebulex`:
@@ -114,7 +112,7 @@ the directory [benchmarks](./benchmarks).
 To run a benchmark test you have to run:
 
 ```
-$ MIX_ENV=test mix run benchmarks/{BENCH_TEST_FILE}
+$ MIX_ENV=test mix run benchmarks/BENCH_TEST_FILE
 ```
 
 Where `BENCH_TEST_FILE` can be any of:
@@ -132,23 +130,23 @@ $ MIX_ENV=test mix run benchmarks/local_with_shards_bench.exs
 ```
 
 Additionally, you can also run performance tests using `:basho_bench`.
-See [nebulex_bench example](https://github.com/cabol/nebulex_examples/tree/master/nebulex_bench)
+See [nebulex_bench example](http://github.com/elixir-nebulex/nebulex_examples/tree/master/nebulex_bench)
 for more information.
 
 ## Contributing
 
 Contributions to Nebulex are very welcome and appreciated!
 
-Use the [issue tracker](https://github.com/nebulex-project/nebulex_local/issues)
+Use the [issue tracker](https://github.com/elixir-nebulex/nebulex_local/issues)
 for bug reports or feature requests. Open a
-[pull request](https://github.com/nebulex-project/nebulex_local/pulls)
+[pull request](https://github.com/elixir-nebulex/nebulex_local/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
+Before to submit a PR it is highly recommended to run `mix test.ci` and ensure
 all checks run successfully.
 
 ## Copyright and License

lib/nebulex/adapters/local.ex

@@ -237,6 +237,9 @@ defmodule Nebulex.Adapters.Local do
   # Inherit default info implementation
   use Nebulex.Adapters.Common.Info
 
+  # Inherit default observable implementation
+  use Nebulex.Adapter.Observable
+
   import Nebulex.Utils
   import Record
 
@@ -344,7 +347,6 @@ defmodule Nebulex.Adapters.Local do
 
     # Build adapter metadata
     adapter_meta = %{
-      cache: cache,
       name: opts[:name] || cache,
       telemetry: telemetry,
       telemetry_prefix: telemetry_prefix,
@@ -648,6 +650,7 @@ defmodule Nebulex.Adapters.Local do
       |> list_gen()
       |> Enum.reduce([], &(backend.select(&1, in_match_spec(chunk, select)) ++ &2))
     end)
+    |> Stream.flat_map(& &1)
     |> wrap_ok()
   end
 
@@ -680,7 +683,7 @@ defmodule Nebulex.Adapters.Local do
           {[], {result, generations}}
 
         {{elements, cont}, [_ | _] = generations} ->
-          {[elements], {backend.select(cont), generations}}
+          {elements, {backend.select(cont), generations}}
       end,
       & &1
     )
@@ -728,7 +731,7 @@ defmodule Nebulex.Adapters.Local do
     quote do
       case unquote(backend).unquote(fun)(unquote(tab), unquote(key)) do
         [] ->
-          wrap_error(Nebulex.KeyError, key: unquote(key), cache: unquote(name))
+          wrap_error Nebulex.KeyError, key: unquote(key), cache: unquote(name)
 
         [entry(exp: :infinity) = entry] ->
           {:ok, entry}
@@ -769,7 +772,7 @@ defmodule Nebulex.Adapters.Local do
     if Time.now() >= exp do
       true = backend.delete(tab, key)
 
-      wrap_error(Nebulex.KeyError, key: key, cache: name, reason: :expired)
+      wrap_error Nebulex.KeyError, key: key, cache: name, reason: :expired
     else
       {:ok, entry}
     end

mix.exs

@@ -1,9 +1,10 @@
 defmodule NebulexAdaptersLocal.MixProject do
   use Mix.Project
 
-  @source_url "https://github.com/nebulex-project/nebulex_local"
-  @version "3.0.0-dev"
-  # @nbx_vsn "3.0.0"
+  @source_url "https://github.com/elixir-nebulex/nebulex_local"
+  @version "3.0.0-rc.1"
+  @nbx_tag "3.0.0-rc.1"
+  @nbx_vsn "3.0.0-rc.1"
 
   def project do
     [
@@ -14,13 +15,14 @@ defmodule NebulexAdaptersLocal.MixProject do
       deps: deps(),
 
       # Testing
-      test_coverage: [tool: ExCoveralls],
+      test_coverage: [tool: ExCoveralls, export: "test-coverage"],
       preferred_cli_env: [
-        check: :test,
         coveralls: :test,
         "coveralls.detail": :test,
         "coveralls.post": :test,
-        "coveralls.html": :test
+        "coveralls.html": :test,
+        "coveralls.json": :test,
+        "test.ci": :test
       ],
 
       # Dialyzer
@@ -60,25 +62,25 @@ defmodule NebulexAdaptersLocal.MixProject do
       {:benchee_html, "~> 1.0", only: [:dev, :test]},
 
       # Docs
-      {:ex_doc, "~> 0.32", only: [:dev, :test], runtime: false}
+      {:ex_doc, "~> 0.36", only: [:dev, :test], runtime: false}
     ]
   end
 
   defp nebulex_dep do
     if path = System.get_env("NEBULEX_PATH") do
       {:nebulex, path: path}
     else
-      {:nebulex, github: "cabol/nebulex", branch: "v3.0.0-dev"}
+      {:nebulex, "~> #{@nbx_vsn}"}
     end
   end
 
   defp aliases do
     [
       "nbx.setup": [
         "cmd rm -rf nebulex",
-        "cmd git clone --depth 1 --branch v3.0.0-dev https://github.com/cabol/nebulex"
+        "cmd git clone --depth 1 --branch v#{@nbx_tag} https://github.com/elixir-nebulex/nebulex"
       ],
-      check: [
+      "test.ci": [
         "compile --warnings-as-errors",
         "format --check-formatted",
         "credo --strict",
@@ -92,12 +94,10 @@ defmodule NebulexAdaptersLocal.MixProject do
   defp package do
     [
       name: :nebulex_local,
-      maintainers: [
-        "Carlos Bolanos",
-        "Felipe Ripoll"
-      ],
+      maintainers: ["Carlos Bolanos"],
       licenses: ["MIT"],
-      links: %{"GitHub" => @source_url}
+      links: %{"GitHub" => @source_url},
+      files: ~w(lib .formatter.exs mix.exs README* CHANGELOG* LICENSE*)
     ]
   end