Skip to content

Commit a7eda39

Browse files
cabolcabol
committed
Overall refactoring for naming and style
1 parent e6a8849 commit a7eda39

13 files changed

Lines changed: 68 additions & 72 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010

1111
jobs:
1212
nebulex_test:
13-
name: 'NebulexCachexAdapter Test (Elixir ${{ matrix.elixir }} OTP ${{ matrix.otp }})'
13+
name: 'Nebulex.Adapters.Cachex Test (Elixir ${{ matrix.elixir }} OTP ${{ matrix.otp }})'
1414
runs-on: ubuntu-latest
1515

1616
strategy:

‎README.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,26 @@
1-
# NebulexCachexAdapter
2-
> ### Nebulex adapter for [Cachex][Cachex].
1+
# Nebulex.Adapters.Cachex
2+
> ### Nebulex adapter for [Cachex][Cachex]
33
44
[Cachex]: https://github.com/whitfin/cachex
55

6-
![CI](https://github.com/cabol/nebulex_cachex_adapter/workflows/CI/badge.svg)
6+
![CI](https://github.com/cabol/nebulex_adapters_cachex/workflows/CI/badge.svg)
7+
[![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)
8+
[![Hex Version](https://img.shields.io/hexpm/v/nebulex_adapters_cachex.svg)](https://hex.pm/packages/nebulex_adapters_cachex)
9+
[![Docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/nebulex_adapters_cachex)
10+
11+
See the [docs](https://hexdocs.pm/nebulex_adapters_cachex/)
12+
for more information.
713

814
*Still WIP*
915

1016
## Installation
1117

12-
Add `nebulex_cachex_adapter` to your list of dependencies in `mix.exs`:
18+
Add `:nebulex_adapters_cachex` to your list of dependencies in `mix.exs`:
1319

1420
```elixir
1521
def deps do
1622
[
17-
{:nebulex_cachex_adapter, "~> 0.1.0"}
23+
{:nebulex_adapters_cachex, "~> 0.1.0"}
1824
]
1925
end
2026
```

lib/nebulex_cachex_adapter.ex renamed to lib/nebulex/adapters/cachex.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
defmodule NebulexCachexAdapter do
1+
defmodule Nebulex.Adapters.Cachex do
22
@moduledoc """
33
Nebulex adapter for Cachex.
44
"""

‎mix.exs‎

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
1-
defmodule NebulexCachexAdapter.MixProject do
1+
defmodule NebulexAdaptersCachex.MixProject do
22
use Mix.Project
33

4-
@version "0.1.0"
4+
@version "1.0.0-dev"
5+
@source_url "https://github.com/cabol/nebulex_adapters_cachex"
56

67
def project do
78
[
8-
app: :nebulex_cachex_adapter,
9+
app: :nebulex_adapters_cachex,
910
version: @version,
1011
elixir: "~> 1.9",
1112
elixirc_paths: elixirc_paths(Mix.env()),
1213
aliases: aliases(),
1314
deps: deps(),
1415

15-
# Docs
16-
name: "NebulexCachexAdapter",
17-
docs: docs(),
18-
1916
# Testing
2017
test_coverage: [tool: ExCoveralls],
2118
preferred_cli_env: [
@@ -31,7 +28,14 @@ defmodule NebulexCachexAdapter.MixProject do
3128

3229
# Hex
3330
package: package(),
34-
description: "Nebulex adapter for Cachex"
31+
description: "Nebulex adapter for Cachex",
32+
33+
# Docs
34+
docs: [
35+
main: "Nebulex.Adapters.Cachex",
36+
source_ref: "v#{@version}",
37+
source_url: @source_url
38+
]
3539
]
3640
end
3741

@@ -86,19 +90,10 @@ defmodule NebulexCachexAdapter.MixProject do
8690

8791
defp package do
8892
[
89-
name: :nebulex_cachex_adapter,
93+
name: :nebulex_adapters_cachex,
9094
maintainers: ["Carlos Bolanos"],
9195
licenses: ["MIT"],
92-
links: %{"GitHub" => "https://github.com/cabol/nebulex_cachex_adapter"}
93-
]
94-
end
95-
96-
defp docs do
97-
[
98-
main: "NebulexCachexAdapter",
99-
source_ref: "v#{@version}",
100-
canonical: "http://hexdocs.pm/nebulex_cachex_adapter",
101-
source_url: "https://github.com/cabol/nebulex_cachex_adapter"
96+
links: %{"GitHub" => @source_url}
10297
]
10398
end
10499

‎test/nebulex_adapters_cachex/local_test.exs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
defmodule NebulexAdaptersCachex.LocalTest do
2+
use ExUnit.Case, async: true
3+
use Nebulex.Adapters.CachexTest
4+
5+
import Nebulex.CacheCase
6+
7+
alias NebulexAdaptersCachex.TestCache.Local, as: Cache
8+
9+
setup_with_dynamic_cache(Cache, :local_with_cachex)
10+
end

test/nebulex_cachex_adapter/multilevel_test.exs renamed to test/nebulex_adapters_cachex/multilevel_test.exs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
defmodule NebulexCachexAdapter.MultilevelTest do
1+
defmodule NebulexAdaptersCachex.MultilevelTest do
22
use ExUnit.Case, async: true
33
use Nebulex.NodeCase
44
use Nebulex.MultilevelTest
@@ -8,8 +8,8 @@ defmodule NebulexCachexAdapter.MultilevelTest do
88
import Nebulex.CacheCase
99

1010
alias Nebulex.Time
11-
alias NebulexCachexAdapter.TestCache.Multilevel
12-
alias NebulexCachexAdapter.TestCache.Multilevel.{L1, L2, L3}
11+
alias NebulexAdaptersCachex.TestCache.Multilevel
12+
alias NebulexAdaptersCachex.TestCache.Multilevel.{L1, L2, L3}
1313

1414
@gc_interval Time.expiry_time(1, :hour)
1515

test/nebulex_cachex_adapter/partitioned_test.exs renamed to test/nebulex_adapters_cachex/partitioned_test.exs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
defmodule NebulexCachexAdapter.PartitionedTest do
1+
defmodule NebulexAdaptersCachex.PartitionedTest do
22
use Nebulex.NodeCase
3-
use NebulexCachexAdapter.CacheTest
3+
use Nebulex.Adapters.CachexTest
44

5-
alias NebulexCachexAdapter.TestCache.Partitioned
5+
alias NebulexAdaptersCachex.TestCache.Partitioned
66

77
@primary :"primary@127.0.0.1"
88

99
setup do
1010
cluster =
1111
:lists.usort([
1212
@primary
13-
| Application.get_env(:nebulex_cachex_adapter, :nodes, [])
13+
| Application.get_env(:nebulex_adapters_cachex, :nodes, [])
1414
])
1515

1616
node_pid_list =

test/nebulex_cachex_adapter/replicated_test.exs renamed to test/nebulex_adapters_cachex/replicated_test.exs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
defmodule NebulexCachexAdapter.ReplicatedTest do
1+
defmodule NebulexAdaptersCachex.ReplicatedTest do
22
use Nebulex.NodeCase
3-
use NebulexCachexAdapter.CacheTest
3+
use Nebulex.Adapters.CachexTest
44

5-
alias NebulexCachexAdapter.TestCache.Replicated
5+
alias NebulexAdaptersCachex.TestCache.Replicated
66

77
setup do
88
node_pid_list = start_caches([node() | Node.list()], [{Replicated, []}])

‎test/nebulex_cachex_adapter/local_test.exs‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

test/shared/cache_test.exs renamed to test/shared/cachex_test.exs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
defmodule NebulexCachexAdapter.CacheTest do
1+
defmodule Nebulex.Adapters.CachexTest do
22
@moduledoc """
33
Shared Tests
44
"""
@@ -7,7 +7,7 @@ defmodule NebulexCachexAdapter.CacheTest do
77
quote do
88
use Nebulex.Cache.EntryTest
99
use Nebulex.Cache.EntryExpirationTest
10-
use NebulexCachexAdapter.QueryableTest
10+
use Nebulex.Adapters.Cachex.QueryableTest
1111
end
1212
end
1313
end

0 commit comments

Comments
 (0)