[#189] Introducing Nebulex v3 🚀 (#149)

Nebulex `v3.0.0-rc.1`:
- Ok/Error tuple Cache API.
- Unify `all` and `get_all` into one callback `get_all`.
- Remove deprecated module `Nebulex.Hook`.
- Use `NimbleOptions` to define and validate cache options.
- Move adapters to separate repositories.
- All commands optionally support a dynamic cache as the first argument.
- Deprecate `Nebulex.Adapter.Stats` in favor of `Nebulex.Adapter.Info`.
- Deprecate `Nebulex.Adapter.Persistence` behaviour.
- Telemetry events for cache commands out-of-box.
- Rename the Telemetry metadata field from `:function_name` to `:command`.
- Option `:bypass_mode` to skip the cache while running tests
- Changes and improvements on Decorator API.
- Fix possible inconsistencies on decorators when using references (#215)
- Option `:keep_ttl` to determine whether to retain the TTL
- Observable API: A tagging interface for cache entry event handlers (experimental)
- Update Nebulex to `elixir-nebulex` org
- Update docs

Author: cabol

.credo.exs

@@ -117,9 +117,9 @@
         ## Refactoring Opportunities
         #
         {Credo.Check.Refactor.CondStatements, []},
-        {Credo.Check.Refactor.CyclomaticComplexity, []},
+        {Credo.Check.Refactor.CyclomaticComplexity, [max_complexity: 40]},
         {Credo.Check.Refactor.FunctionArity, []},
-        {Credo.Check.Refactor.LongQuoteBlocks, [max_line_count: 300, ignore_comments: true]},
+        {Credo.Check.Refactor.LongQuoteBlocks, [max_line_count: 200]},
         # {Credo.Check.Refactor.MapInto, []},
         {Credo.Check.Refactor.MatchInCondition, []},
         {Credo.Check.Refactor.NegatedConditionsInUnless, []},

.dialyzer_ignore.exs

@@ -1,17 +1,15 @@
 %Doctor.Config{
   ignore_modules: [
-    Nebulex.Adapter,
-    Nebulex.Adapters.Local.Metadata,
-    Nebulex.Adapters.Partitioned.Bootstrap,
-    Nebulex.Helpers,
-    Nebulex.Telemetry,
-    Nebulex.Cluster,
-    Nebulex.NodeCase,
-    Nebulex.TestCache.Common,
+    Nebulex.Cache.Helpers,
+    Nebulex.Cache.Options,
+    Nebulex.Cache.QuerySpec,
+    Nebulex.Caching.Options,
+    Nebulex.Adapter.Transaction.Options,
+    Nebulex.Adapters.Nil.Options,
     Nebulex.Dialyzer.CachingDecorators
   ],
   ignore_paths: [],
-  min_module_doc_coverage: 30,
+  min_module_doc_coverage: 40,
   min_module_spec_coverage: 0,
   min_overall_doc_coverage: 80,
   min_overall_moduledoc_coverage: 100,

.doctor.exs

@@ -1,5 +1,21 @@
 locals_without_parens = [
+  # Nebulex.Utils
+  unwrap_or_raise: 1,
+  wrap_ok: 1,
+  wrap_error: 1,
+  wrap_error: 2,
+
+  # Nebulex.Cache.Utils
+  defcacheapi: 2,
+
+  # Nebulex.Adapter
+  defcommand: 1,
+  defcommand: 2,
+  defcommandp: 1,
+  defcommandp: 2,
+
   # Nebulex.Caching
+  dynamic_cache: 2,
   keyref: 1,
   keyref: 2,
 
@@ -9,7 +25,17 @@ locals_without_parens = [
   setup_with_cache: 1,
   setup_with_cache: 2,
   setup_with_dynamic_cache: 2,
-  setup_with_dynamic_cache: 3
+  setup_with_dynamic_cache: 3,
+  with_telemetry_handler: 2,
+  with_telemetry_handler: 3,
+  wait_until: 1,
+  wait_until: 2,
+  wait_until: 3,
+  assert_error_module: 2,
+  assert_error_reason: 2,
+  assert_eventually: 1,
+  assert_eventually: 2,
+  assert_eventually: 3
 ]
 
 [

.formatter.exs

@@ -3,10 +3,10 @@ name: CI
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   nebulex_test:
@@ -18,32 +18,28 @@ jobs:
     strategy:
       matrix:
         include:
-          - elixir: 1.17.x
+          - elixir: 1.18.x
             otp: 27.x
             os: 'ubuntu-latest'
+            lint: true
             style: true
             coverage: true
             sobelow: true
             dialyzer: true
-            doctor: true
+            docs: 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: 24.x
             os: 'ubuntu-latest'
-          - elixir: 1.12.x
-            otp: 23.x
-            os: 'ubuntu-20.04'
 
     env:
       GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+      CODECOV_TOKEN: '${{ secrets.CODECOV_TOKEN }}'
       MIX_ENV: test
 
     steps:
@@ -83,37 +79,48 @@ 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: |
-          epmd -daemon
-          mix test --trace
+        run: mix test
         if: ${{ !matrix.coverage }}
 
       - name: Run tests with coverage
-        run: |
-          epmd -daemon
-          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 --exit --skip
+        run: mix sobelow --skip --exit Low
         if: ${{ matrix.sobelow }}
 
       - name: Restore PLT Cache
         uses: actions/cache@v3
         id: plt-cache
         with:
           path: priv/plts
-          key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt-v1
+          key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt-v3-1
         if: ${{ matrix.dialyzer }}
 
       - name: Create PLTs
@@ -126,10 +133,6 @@ jobs:
         run: mix dialyzer --format github
         if: ${{ matrix.dialyzer && steps.plt-cache.outputs.cache-hit != 'true' }}
 
-      - name: Doc coverage report
-        run: MIX_ENV=docs mix inch.report
-        if: ${{ matrix.inch-report }}
-
       - name: Run documentation health check
         run: mix doctor
-        if: ${{ matrix.doctor }}
+        if: ${{ matrix.docs }}

.github/workflows/ci.yml

@@ -37,3 +37,4 @@ erl_crash.dump
 /priv
 .sobelow*
 /config
+Elixir*

.gitignore

@@ -1,2 +1,2 @@
-elixir 1.17.3-otp-27
-erlang 27.1.1
+elixir 1.18.3-otp-27
+erlang 27.3.3

.tool-versions

@@ -4,103 +4,6 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [v2.6.4](https://github.com/cabol/nebulex/tree/v2.6.4) (2024-10-19)
-
-[Full Changelog](https://github.com/cabol/nebulex/compare/v2.6.3...v2.6.4)
-
-**Closed issues:**
-
-- [Proposal] A New GC Strategy for Local Generation
-  [#184](https://github.com/cabol/nebulex/issues/184)
-
-**Merged pull requests:**
-
-- Fix race condition in multilevel cache replication
-  [#232](https://github.com/cabol/nebulex/pull/232)
-  ([costaraphael](https://github.com/costaraphael))
-- Fix typos again
-  [#230](https://github.com/cabol/nebulex/pull/230)
-  ([kianmeng](https://github.com/kianmeng))
-
-## [v2.6.3](https://github.com/cabol/nebulex/tree/v2.6.3) (2024-08-05)
-
-[Full Changelog](https://github.com/cabol/nebulex/compare/v2.6.2...v2.6.3)
-
-**Closed issues:**
-
-- `Cache.all(nil, return: :value)` with a partitioned cache gives incorrect
-  results
-  [#228](https://github.com/cabol/nebulex/issues/228)
-- 2.6.2 is missing from tags and releases on github
-  [#227](https://github.com/cabol/nebulex/issues/227)
-
-**Merged pull requests:**
-
-- `Cache.all(nil, return: :value)` did not correctly handle values that are
-  lists.
-  [#229](https://github.com/cabol/nebulex/pull/229)
-  ([jweinkam](https://github.com/jweinkam))
-
-## [v2.6.2](https://github.com/cabol/nebulex/tree/v2.6.2) (2024-06-15)
-
-[Full Changelog](https://github.com/cabol/nebulex/compare/v2.6.1...v2.6.2)
-
-**Closed issues:**
-
-- Having a cache per user ID
-  [#224](https://github.com/cabol/nebulex/issues/224)
-
-**Merged pull requests:**
-
-- Fix some compiler warnings in Elixir 1.17
-  [#222](https://github.com/cabol/nebulex/pull/222)
-  ([peaceful-james](https://github.com/peaceful-james))
-
-## [v2.6.1](https://github.com/cabol/nebulex/tree/v2.6.1) (2024-02-24)
-
-[Full Changelog](https://github.com/cabol/nebulex/compare/v2.6.0...v2.6.1)
-
-**Merged pull requests:**
-
-- Improve variable handing in key generators
-  [#221](https://github.com/cabol/nebulex/pull/221)
-  ([hissssst](https://github.com/hissssst))
-
-## [v2.6.0](https://github.com/cabol/nebulex/tree/v2.6.0) (2024-01-21)
-
-[Full Changelog](https://github.com/cabol/nebulex/compare/v2.5.2...v2.6.0)
-
-**Fixed bugs:**
-
-- Fix compatibility with Elixir 1.15 and 1.16
-  [#220](https://github.com/cabol/nebulex/issues/220)
-
-**Closed issues:**
-
-- `Multilevel` inclusive cache doesn't duplicate entries backwards on
-  `get_all/2`
-  [#219](https://github.com/cabol/nebulex/issues/219)
-- Empty arguments list passed to `generate/3` in Elixir 1.16
-  [#218](https://github.com/cabol/nebulex/issues/218)
-- Regression on decorated functions and Elixir 1.16
-  [#216](https://github.com/cabol/nebulex/issues/216)
-- Bug on Local adapter when using `delete_all` and keys are nested tuples:
-  not a valid match specification
-  [#211](https://github.com/cabol/nebulex/issues/211)
-- `Nebulex.RegistryLookupError`
-  [#207](https://github.com/cabol/nebulex/issues/207)
-- Docs on Migrating to v2 from Nebulex.Adapters.Dist.Cluster
-  [#198](https://github.com/cabol/nebulex/issues/198)
-
-**Merged pull requests:**
-
-- Partitioned Adapter supports two-item tuples as keys
-  [#214](https://github.com/cabol/nebulex/pull/214)
-  ([twinn](https://github.com/twinn))
-- Adds nebulex Ecto adapter
-  [#212](https://github.com/cabol/nebulex/pull/212)
-  ([hissssst](https://github.com/hissssst))
-
 ## [v2.5.2](https://github.com/cabol/nebulex/tree/v2.5.2) (2023-07-14)
 
 [Full Changelog](https://github.com/cabol/nebulex/compare/v2.5.1...v2.5.2)

CHANGELOG.md

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) 2017 Carlos Andres Bolaños R.A.