Skip to content

Commit e3602a4

Browse files
cabolcabol
committed
feat: initial commit — Tidefall 1.0.0-dev 🌊
Tidefall is an ETS-backed buffer for Elixir — accumulate writes, drain in periodic batches. Originally developed at Appcues as `partitioned_buffer`; this repo is a fresh-start continuation under a new name and design direction. Upstream copyright preserved in LICENSE.md per the MIT terms.
0 parents  commit e3602a4

31 files changed

Lines changed: 6086 additions & 0 deletions

‎.credo.exs‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
# This file contains the configuration for Credo and you are probably reading
2+
# this after creating it with `mix credo.gen.config`.
3+
#
4+
# If you find anything wrong or unclear in this file, please report an
5+
# issue on GitHub: https://github.com/rrrene/credo/issues
6+
#
7+
%{
8+
#
9+
# You can have as many configs as you like in the `configs:` field.
10+
configs: [
11+
%{
12+
#
13+
# Run any config using `mix credo -C <name>`. If no config name is given
14+
# "default" is used.
15+
#
16+
name: "default",
17+
#
18+
# These are the files included in the analysis:
19+
files: %{
20+
#
21+
# You can give explicit globs or simply directories.
22+
# In the latter case `**/*.{ex,exs}` will be used.
23+
#
24+
included: [
25+
"lib/",
26+
"src/",
27+
"test/",
28+
"benchmarks/",
29+
"web/",
30+
"apps/*/lib/",
31+
"apps/*/src/",
32+
"apps/*/test/",
33+
"apps/*/web/"
34+
],
35+
excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
36+
},
37+
#
38+
# Load and configure plugins here:
39+
#
40+
plugins: [],
41+
#
42+
# If you create your own checks, you must specify the source files for
43+
# them here, so they can be loaded by Credo before running the analysis.
44+
#
45+
requires: [],
46+
#
47+
# If you want to enforce a style guide and need a more traditional linting
48+
# experience, you can change `strict` to `true` below:
49+
#
50+
strict: true,
51+
#
52+
# To modify the timeout for parsing files, change this value:
53+
#
54+
parse_timeout: 5000,
55+
#
56+
# If you want to use uncolored output by default, you can change `color`
57+
# to `false` below:
58+
#
59+
color: true,
60+
#
61+
# You can customize the parameters of any check by adding a second element
62+
# to the tuple.
63+
#
64+
# To disable a check put `false` as second element:
65+
#
66+
# {Credo.Check.Design.DuplicatedCode, false}
67+
#
68+
checks: [
69+
#
70+
## Consistency Checks
71+
#
72+
{Credo.Check.Consistency.ExceptionNames, []},
73+
{Credo.Check.Consistency.LineEndings, []},
74+
{Credo.Check.Consistency.ParameterPatternMatching, []},
75+
{Credo.Check.Consistency.SpaceAroundOperators, []},
76+
{Credo.Check.Consistency.SpaceInParentheses, []},
77+
{Credo.Check.Consistency.TabsOrSpaces, []},
78+
79+
#
80+
## Design Checks
81+
#
82+
# You can customize the priority of any check
83+
# Priority values are: `low, normal, high, higher`
84+
#
85+
{Credo.Check.Design.AliasUsage, [priority: :low]},
86+
# You can also customize the exit_status of each check.
87+
# If you don't want TODO comments to cause `mix credo` to fail, just
88+
# set this value to 0 (zero).
89+
#
90+
{Credo.Check.Design.TagTODO, [exit_status: 0]},
91+
{Credo.Check.Design.TagFIXME, [exit_status: 0]},
92+
93+
#
94+
## Readability Checks
95+
#
96+
{Credo.Check.Readability.AliasOrder, []},
97+
{Credo.Check.Readability.FunctionNames, []},
98+
{Credo.Check.Readability.LargeNumbers, []},
99+
{Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 100]},
100+
{Credo.Check.Readability.ModuleAttributeNames, []},
101+
{Credo.Check.Readability.ModuleDoc, []},
102+
{Credo.Check.Readability.ModuleNames, []},
103+
{Credo.Check.Readability.ParenthesesInCondition, []},
104+
{Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
105+
{Credo.Check.Readability.PredicateFunctionNames, []},
106+
{Credo.Check.Readability.PreferImplicitTry, []},
107+
{Credo.Check.Readability.RedundantBlankLines, []},
108+
{Credo.Check.Readability.Semicolons, []},
109+
{Credo.Check.Readability.SpaceAfterCommas, []},
110+
{Credo.Check.Readability.StringSigils, []},
111+
{Credo.Check.Readability.TrailingBlankLine, []},
112+
{Credo.Check.Readability.TrailingWhiteSpace, []},
113+
{Credo.Check.Readability.UnnecessaryAliasExpansion, []},
114+
{Credo.Check.Readability.VariableNames, []},
115+
116+
#
117+
## Refactoring Opportunities
118+
#
119+
{Credo.Check.Refactor.CondStatements, []},
120+
{Credo.Check.Refactor.CyclomaticComplexity, [max_complexity: 40]},
121+
{Credo.Check.Refactor.FunctionArity, []},
122+
{Credo.Check.Refactor.LongQuoteBlocks, [max_line_count: 200]},
123+
# {Credo.Check.Refactor.MapInto, []},
124+
{Credo.Check.Refactor.MatchInCondition, []},
125+
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
126+
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
127+
{Credo.Check.Refactor.Nesting, []},
128+
{Credo.Check.Refactor.UnlessWithElse, []},
129+
{Credo.Check.Refactor.WithClauses, []},
130+
131+
#
132+
## Warnings
133+
#
134+
{Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
135+
{Credo.Check.Warning.BoolOperationOnSameValues, []},
136+
{Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
137+
{Credo.Check.Warning.IExPry, []},
138+
{Credo.Check.Warning.IoInspect, []},
139+
# {Credo.Check.Warning.LazyLogging, []},
140+
{Credo.Check.Warning.MixEnv, false},
141+
{Credo.Check.Warning.OperationOnSameValues, []},
142+
{Credo.Check.Warning.OperationWithConstantResult, []},
143+
{Credo.Check.Warning.RaiseInsideRescue, []},
144+
{Credo.Check.Warning.UnusedEnumOperation, []},
145+
{Credo.Check.Warning.UnusedFileOperation, []},
146+
{Credo.Check.Warning.UnusedKeywordOperation, []},
147+
{Credo.Check.Warning.UnusedListOperation, []},
148+
{Credo.Check.Warning.UnusedPathOperation, []},
149+
{Credo.Check.Warning.UnusedRegexOperation, []},
150+
{Credo.Check.Warning.UnusedStringOperation, []},
151+
{Credo.Check.Warning.UnusedTupleOperation, []},
152+
{Credo.Check.Warning.UnsafeExec, []},
153+
154+
#
155+
# Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`)
156+
157+
#
158+
# Controversial and experimental checks (opt-in, just replace `false` with `[]`)
159+
#
160+
{Credo.Check.Consistency.MultiAliasImportRequireUse, false},
161+
{Credo.Check.Consistency.UnusedVariableNames, false},
162+
{Credo.Check.Design.DuplicatedCode, false},
163+
{Credo.Check.Readability.AliasAs, false},
164+
{Credo.Check.Readability.BlockPipe, false},
165+
{Credo.Check.Readability.ImplTrue, false},
166+
{Credo.Check.Readability.MultiAlias, false},
167+
{Credo.Check.Readability.SeparateAliasRequire, false},
168+
{Credo.Check.Readability.SinglePipe, false},
169+
{Credo.Check.Readability.Specs, false},
170+
{Credo.Check.Readability.StrictModuleLayout, false},
171+
{Credo.Check.Readability.WithCustomTaggedTuple, false},
172+
{Credo.Check.Refactor.ABCSize, false},
173+
{Credo.Check.Refactor.AppendSingleItem, false},
174+
{Credo.Check.Refactor.DoubleBooleanNegation, false},
175+
{Credo.Check.Refactor.ModuleDependencies, false},
176+
{Credo.Check.Refactor.NegatedIsNil, false},
177+
{Credo.Check.Refactor.PipeChainStart, false},
178+
{Credo.Check.Refactor.VariableRebinding, false},
179+
{Credo.Check.Warning.LeakyEnvironment, false},
180+
{Credo.Check.Warning.MapGetUnsafePass, false},
181+
{Credo.Check.Warning.UnsafeToAtom, false}
182+
183+
#
184+
# Custom checks can be created using `mix credo.gen.check`.
185+
#
186+
]
187+
}
188+
]
189+
}

‎.formatter.exs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Used by "mix format"
2+
[
3+
inputs: ["{mix,.formatter}.exs", "{config,lib,test,benchmarks}/**/*.{ex,exs}"],
4+
line_length: 100
5+
]

‎.github/workflows/ci.yml‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
tidefall_test:
13+
name: >-
14+
Tidefall Test (Elixir ${{ matrix.elixir }} / OTP ${{ matrix.otp }} /
15+
OS ${{ matrix.os }})
16+
runs-on: ${{ matrix.os }}
17+
18+
strategy:
19+
matrix:
20+
include:
21+
- elixir: 1.19.x
22+
otp: 28.x
23+
os: 'ubuntu-latest'
24+
lint: true
25+
coverage: true
26+
dialyzer: true
27+
- elixir: 1.18.x
28+
otp: 28.x
29+
os: 'ubuntu-latest'
30+
- elixir: 1.17.x
31+
otp: 25.x
32+
os: 'ubuntu-latest'
33+
34+
env:
35+
GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
36+
MIX_ENV: test
37+
38+
steps:
39+
- uses: actions/checkout@v4
40+
41+
- name: Install OTP and Elixir
42+
uses: erlef/setup-beam@v1
43+
with:
44+
otp-version: '${{ matrix.otp }}'
45+
elixir-version: '${{ matrix.elixir }}'
46+
47+
- name: Cache deps
48+
uses: actions/cache@v4
49+
id: mix-cache
50+
with:
51+
path: deps
52+
key: >-
53+
${{ matrix.elixir }}-${{ matrix.otp }}-${{ runner.os }}-mix-${{
54+
hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
55+
restore-keys: |
56+
${{ matrix.elixir }}-${{ matrix.otp }}-${{ runner.os }}-mix-
57+
58+
- name: Cache _build
59+
uses: actions/cache@v4
60+
with:
61+
path: _build
62+
key: >-
63+
${{ matrix.elixir }}-${{ matrix.otp }}-${{ runner.os }}-build-${{
64+
hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
65+
restore-keys: |
66+
${{ matrix.elixir }}-${{ matrix.otp }}-${{ runner.os }}-build-
67+
68+
- name: Install Hex and Rebar
69+
run: |
70+
mix local.hex --force
71+
mix local.rebar --force
72+
73+
- name: Install Dependencies
74+
run: mix deps.get
75+
if: ${{ steps.mix-cache.outputs.cache-hit != 'true' }}
76+
77+
- name: Compile deps
78+
run: mix deps.compile
79+
80+
- name: Check unused dependencies
81+
run: mix deps.unlock --check-unused
82+
if: ${{ matrix.lint }}
83+
84+
- name: Compile lint
85+
run: mix compile --warnings-as-errors
86+
if: ${{ matrix.lint }}
87+
88+
- name: Run style and code consistency checks
89+
run: |
90+
mix format --check-formatted
91+
mix credo --strict
92+
if: ${{ matrix.lint }}
93+
94+
- name: Run tests
95+
run: mix test
96+
if: ${{ !matrix.coverage }}
97+
98+
- name: Run tests with coverage
99+
run: mix coveralls.json
100+
if: ${{ matrix.coverage }}
101+
102+
- name: Restore PLT Cache
103+
uses: actions/cache@v4
104+
id: plt-cache
105+
with:
106+
path: priv/plts
107+
key: >-
108+
plt-${{ matrix.elixir }}-${{ matrix.otp }}-${{
109+
hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
110+
restore-keys: |
111+
plt-${{ matrix.elixir }}-${{ matrix.otp }}-
112+
if: ${{ matrix.dialyzer }}
113+
114+
- name: Create PLTs
115+
run: |
116+
mkdir -p priv/plts
117+
mix dialyzer --plt
118+
if: ${{ matrix.dialyzer && steps.plt-cache.outputs.cache-hit != 'true' }}
119+
120+
- name: Run dialyzer
121+
run: mix dialyzer --format github
122+
if: ${{ matrix.dialyzer }}

‎.gitignore‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# The directory Mix will write compiled artifacts to.
2+
/_build/
3+
4+
# If you run "mix test --cover", coverage assets end up here.
5+
/cover/
6+
7+
# The directory Mix downloads your dependencies sources to.
8+
/deps/
9+
10+
# Where third-party dependencies like ExDoc output generated docs.
11+
/doc/
12+
13+
# If the VM crashes, it generates a dump, let's ignore it too.
14+
erl_crash.dump
15+
16+
# Also ignore archive artifacts (built via "mix archive.build").
17+
*.ez
18+
19+
# Ignore package tarball (built via "mix hex.build").
20+
tidefall-*.tar
21+
22+
# Temporary files, for example, from tests.
23+
/tmp/
24+
25+
# Others
26+
*.o
27+
*.beam
28+
*.plt
29+
erl_crash.dump
30+
.DS_Store
31+
.elixir*
32+
.vs*
33+
/priv
34+
Elixir*
35+
36+
# Keep tracked usage-rules even though `Elixir*` matches case-insensitively on macOS
37+
!usage-rules/elixir*.md
38+
39+
# AI agent files
40+
CLAUDE.md
41+
/.claude
42+
/.cursor

‎.tool-versions‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
elixir 1.19.5-otp-28
2+
erlang 28.5

0 commit comments

Comments
 (0)