[#7] Migrate adapter to Nebulex v3

.credo.exs

@@ -1,19 +1,188 @@
+# This file contains the configuration for Credo and you are probably reading
+# this after creating it with `mix credo.gen.config`.
+#
+# If you find anything wrong or unclear in this file, please report an
+# issue on GitHub: https://github.com/rrrene/credo/issues
+#
 %{
+  #
+  # You can have as many configs as you like in the `configs:` field.
   configs: [
     %{
+      #
+      # Run any config using `mix credo -C <name>`. If no config name is given
+      # "default" is used.
+      #
       name: "default",
+      #
+      # These are the files included in the analysis:
       files: %{
-        included: ["lib/", "src/", "test/", "benchmarks/"],
-        excluded: [~r"/_build/", ~r"/deps/"]
+        #
+        # You can give explicit globs or simply directories.
+        # In the latter case `**/*.{ex,exs}` will be used.
+        #
+        included: [
+          "lib/",
+          "src/",
+          "test/",
+          "benchmarks/",
+          "web/",
+          "apps/*/lib/",
+          "apps/*/src/",
+          "apps/*/test/",
+          "apps/*/web/"
+        ],
+        excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
       },
+      #
+      # Load and configure plugins here:
+      #
+      plugins: [],
+      #
+      # If you create your own checks, you must specify the source files for
+      # them here, so they can be loaded by Credo before running the analysis.
+      #
+      requires: [],
+      #
+      # If you want to enforce a style guide and need a more traditional linting
+      # experience, you can change `strict` to `true` below:
+      #
+      strict: true,
+      #
+      # To modify the timeout for parsing files, change this value:
+      #
+      parse_timeout: 5000,
+      #
+      # If you want to use uncolored output by default, you can change `color`
+      # to `false` below:
+      #
       color: true,
+      #
+      # You can customize the parameters of any check by adding a second element
+      # to the tuple.
+      #
+      # To disable a check put `false` as second element:
+      #
+      #     {Credo.Check.Design.DuplicatedCode, false}
+      #
       checks: [
-        # Readability Checks
-        {Credo.Check.Readability.MaxLineLength, priority: :low, max_length: 100},
+        #
+        ## Consistency Checks
+        #
+        {Credo.Check.Consistency.ExceptionNames, []},
+        {Credo.Check.Consistency.LineEndings, []},
+        {Credo.Check.Consistency.ParameterPatternMatching, []},
+        {Credo.Check.Consistency.SpaceAroundOperators, []},
+        {Credo.Check.Consistency.SpaceInParentheses, []},
+        {Credo.Check.Consistency.TabsOrSpaces, []},
 
-        # TODO and FIXME do not cause the build to fail
-        {Credo.Check.Design.TagTODO, exit_status: 0},
-        {Credo.Check.Design.TagFIXME, exit_status: 0}
+        #
+        ## Design Checks
+        #
+        # You can customize the priority of any check
+        # Priority values are: `low, normal, high, higher`
+        #
+        {Credo.Check.Design.AliasUsage, [priority: :low]},
+        # You can also customize the exit_status of each check.
+        # If you don't want TODO comments to cause `mix credo` to fail, just
+        # set this value to 0 (zero).
+        #
+        {Credo.Check.Design.TagTODO, [exit_status: 0]},
+        {Credo.Check.Design.TagFIXME, [exit_status: 0]},
+
+        #
+        ## Readability Checks
+        #
+        {Credo.Check.Readability.AliasOrder, []},
+        {Credo.Check.Readability.FunctionNames, []},
+        {Credo.Check.Readability.LargeNumbers, []},
+        {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 100]},
+        {Credo.Check.Readability.ModuleAttributeNames, []},
+        {Credo.Check.Readability.ModuleDoc, []},
+        {Credo.Check.Readability.ModuleNames, []},
+        {Credo.Check.Readability.ParenthesesInCondition, []},
+        {Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
+        {Credo.Check.Readability.PredicateFunctionNames, []},
+        {Credo.Check.Readability.PreferImplicitTry, []},
+        {Credo.Check.Readability.RedundantBlankLines, []},
+        {Credo.Check.Readability.Semicolons, []},
+        {Credo.Check.Readability.SpaceAfterCommas, []},
+        {Credo.Check.Readability.StringSigils, []},
+        {Credo.Check.Readability.TrailingBlankLine, []},
+        {Credo.Check.Readability.TrailingWhiteSpace, []},
+        {Credo.Check.Readability.UnnecessaryAliasExpansion, []},
+        {Credo.Check.Readability.VariableNames, []},
+
+        #
+        ## Refactoring Opportunities
+        #
+        {Credo.Check.Refactor.CondStatements, []},
+        {Credo.Check.Refactor.CyclomaticComplexity, [max_complexity: 40]},
+        {Credo.Check.Refactor.FunctionArity, []},
+        {Credo.Check.Refactor.LongQuoteBlocks, [max_line_count: 200]},
+        # {Credo.Check.Refactor.MapInto, []},
+        {Credo.Check.Refactor.MatchInCondition, []},
+        {Credo.Check.Refactor.NegatedConditionsInUnless, []},
+        {Credo.Check.Refactor.NegatedConditionsWithElse, []},
+        {Credo.Check.Refactor.Nesting, []},
+        {Credo.Check.Refactor.UnlessWithElse, []},
+        {Credo.Check.Refactor.WithClauses, []},
+
+        #
+        ## Warnings
+        #
+        {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
+        {Credo.Check.Warning.BoolOperationOnSameValues, []},
+        {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
+        {Credo.Check.Warning.IExPry, []},
+        {Credo.Check.Warning.IoInspect, []},
+        # {Credo.Check.Warning.LazyLogging, []},
+        {Credo.Check.Warning.MixEnv, false},
+        {Credo.Check.Warning.OperationOnSameValues, []},
+        {Credo.Check.Warning.OperationWithConstantResult, []},
+        {Credo.Check.Warning.RaiseInsideRescue, []},
+        {Credo.Check.Warning.UnusedEnumOperation, []},
+        {Credo.Check.Warning.UnusedFileOperation, []},
+        {Credo.Check.Warning.UnusedKeywordOperation, []},
+        {Credo.Check.Warning.UnusedListOperation, []},
+        {Credo.Check.Warning.UnusedPathOperation, []},
+        {Credo.Check.Warning.UnusedRegexOperation, []},
+        {Credo.Check.Warning.UnusedStringOperation, []},
+        {Credo.Check.Warning.UnusedTupleOperation, []},
+        {Credo.Check.Warning.UnsafeExec, []},
+
+        #
+        # Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`)
+
+        #
+        # Controversial and experimental checks (opt-in, just replace `false` with `[]`)
+        #
+        {Credo.Check.Consistency.MultiAliasImportRequireUse, false},
+        {Credo.Check.Consistency.UnusedVariableNames, false},
+        {Credo.Check.Design.DuplicatedCode, false},
+        {Credo.Check.Readability.AliasAs, false},
+        {Credo.Check.Readability.BlockPipe, false},
+        {Credo.Check.Readability.ImplTrue, false},
+        {Credo.Check.Readability.MultiAlias, false},
+        {Credo.Check.Readability.SeparateAliasRequire, false},
+        {Credo.Check.Readability.SinglePipe, false},
+        {Credo.Check.Readability.Specs, false},
+        {Credo.Check.Readability.StrictModuleLayout, false},
+        {Credo.Check.Readability.WithCustomTaggedTuple, false},
+        {Credo.Check.Refactor.ABCSize, false},
+        {Credo.Check.Refactor.AppendSingleItem, false},
+        {Credo.Check.Refactor.DoubleBooleanNegation, false},
+        {Credo.Check.Refactor.ModuleDependencies, false},
+        {Credo.Check.Refactor.NegatedIsNil, false},
+        {Credo.Check.Refactor.PipeChainStart, false},
+        {Credo.Check.Refactor.VariableRebinding, false},
+        {Credo.Check.Warning.LeakyEnvironment, false},
+        {Credo.Check.Warning.MapGetUnsafePass, false},
+        {Credo.Check.Warning.UnsafeToAtom, false}
+
+        #
+        # Custom checks can be created using `mix credo.gen.check`.
+        #
       ]
     }
   ]

.formatter.exs

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

.github/workflows/ci.yml

@@ -9,25 +9,33 @@ on:
       - main
 
 jobs:
-  nebulex_test:
+  test:
     name: >-
-      Nebulex.Adapters.Cachex Test (Elixir ${{ matrix.elixir }}
-      / OTP ${{ matrix.otp }} / OS ${{ matrix.os }})
+      Nebulex.Adapters.Cachex Test (Elixir ${{ matrix.elixir }} /
+      OTP ${{ matrix.otp }} /
+      OS ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
         include:
-          - elixir: 1.14.x
-            otp: 25.x
+          - elixir: 1.18.x
+            otp: 27.x
             os: 'ubuntu-latest'
             style: true
             coverage: true
+            sobelow: true
             dialyzer: true
-          - elixir: 1.13.x
-            otp: 24.x
+          - elixir: 1.17.x
+            otp: 26.x
+            os: 'ubuntu-latest'
+          - elixir: 1.16.x
+            otp: 26.x
             os: 'ubuntu-latest'
-          - elixir: 1.12.x
+          - elixir: 1.15.x
+            otp: 25.x
+            os: 'ubuntu-latest'
+          - elixir: 1.14.x
             otp: 23.x
             os: 'ubuntu-20.04'
 
@@ -53,6 +61,8 @@ jobs:
           key: >-
             ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-${{
             hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
 
       - name: Cache _build
         uses: actions/cache@v3
@@ -61,6 +71,8 @@ jobs:
           key: >-
             ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-build-${{
             hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-build-
 
       - name: Install Nebulex
         run: mix nbx.setup
@@ -98,7 +110,7 @@ jobs:
         id: plt-cache
         with:
           path: priv/plts
-          key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt-v2
+          key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt-v1
         if: ${{ matrix.dialyzer }}
 
       - name: Create PLTs

.gitignore

@@ -37,3 +37,5 @@ erl_crash.dump
 /priv
 .sobelow*
 /nebulex
+Elixir*
+*.coverdata

.tool-versions

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

README.md

@@ -21,7 +21,7 @@ Add `:nebulex_adapters_cachex` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:nebulex_adapters_cachex, "~> 2.1"}
+    {:nebulex_adapters_cachex, "~> 3.0"}
   ]
 end
 ```
@@ -43,7 +43,6 @@ environment, usually defined in your `config/config.exs`:
 
 ```elixir
 config :my_app, MyApp.Cache,
-  limit: 1_000_000,
   stats: true,
   ...
 ```
@@ -82,42 +81,31 @@ defp cachex_opts do
 
   [
     expiration: expiration(
-      # default record expiration
-      default: :timer.seconds(60),
-
       # how often cleanup should occur
       interval: :timer.seconds(30),
 
+      # default record expiration
+      default: :timer.seconds(60),
+
       # whether to enable lazy checking
       lazy: true
     ),
 
-    # complex limit
-    limit: limit(
-      size: 500,
-      policy: Cachex.Policy.LRW,
-      reclaim: 0.5,
-      options: []
-    ),
-
     ...
   ]
 end
 ```
 
-> See [Cachex.start_link/1][cachex_start_link] for more information
+> See [Cachex.start_link/2][cachex_start_link] for more information
   about the options.
 
-[cachex_start_link]: https://hexdocs.pm/cachex/Cachex.html#start_link/1
+[cachex_start_link]: https://hexdocs.pm/cachex/Cachex.html#start_link/2
 
 ## Distributed caching topologies
 
-In the same way we use the distributed adapters and the multilevel one to
-create distributed topologies, we can also do the same but instead of using
-the built-in local adapter using Cachex.
-
-For example, let's define a multi-level cache (near cache topology), where
-the L1 is a local cache using Cachex and the L2 is a partitioned cache.
+Using the distributed adapters with `Cachex` as a primary storage is possible.
+  For example, let's define a multi-level cache (near cache topology), where
+  the L1 is a local cache using Cachex and the L2 is a partitioned cache.
 
 ```elixir
 defmodule MyApp.NearCache do
@@ -146,8 +134,8 @@ And the configuration may look like:
 config :my_app, MyApp.NearCache,
   model: :inclusive,
   levels: [
-    {MyApp.NearCache.L1, [limit: 100_000]},
-    {MyApp.NearCache.L2, primary: [limit: 1_000_000]}
+    {MyApp.NearCache.L1, []},
+    {MyApp.NearCache.L2, primary: [transactions: true]}
   ]
 ```
 
@@ -164,9 +152,9 @@ by `Nebulex.Adapters.Cachex`.
 
 ## 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.
+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`: