View Source Changelog
This format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v0-4-2-2023-11-01
v0.4.2 (2023-11-01)
fixes
Fixes
- Fix a crash that would occur if a test file containing an auto-assertion is changed before the auto-assertion is run (for instance, while Mneme is waiting on input from an auto-assertion in a different test file).
v0-4-1-2023-10-25
v0.4.1 (2023-10-25)
fixed
Fixed
- Fix a crash that could occur when diffing sigils.
v0-4-0-2023-07-04
v0.4.0 (2023-07-04)
added
Added
Mneme.start/1
now accepts all of Mneme's configuration options that will be applied to the entire test run.
removed
Removed
Breaking: Removed support for
:mneme
application config. This has been replaced by passing config options directly toMneme.start/1
:# Old: config/test.exs config :mneme, defaults: [default_pattern: :last, ...] # New: test/test_helper.exs Mneme.start(default_pattern: :last, ...)
v0-3-5-2023-06-30
v0.3.5 (2023-06-30)
fixed-1
Fixed
- Support multi-letter sigils when using Elixir 1.15.0+.
v0-3-4-2023-05-22
v0.3.4 (2023-05-22)
added-1
Added
- Tested to support OTP 26.0 when using Elixir 1.14.4.
- Support expressions that return functions, serializing them with an
is_function(fun, arity)
guard. - When generating a pattern for a MapSet, add a note suggesting using
MapSet.to_list/1
for better serialization.
changed
Changed
- Format pattern notes to be more obvious when they're present.
- Generate charlist patterns using
sigil_c
instead of single quotes, e.g.~c"foo"
instead of'foo'
. See this discussion for more context.
fixed-2
Fixed
- Numerous fixes related to vars used in guards:
- Generated vars will no longer shadow variables in scope (e.g. if
pid
is in scope, a different pid will use the varpid1
). - The same var will no longer be used for different values of the same type.
- Multiple, redundant guards will no longer be emitted for the same var (e.g.
[self(), self()]
would result in[pid, pid] when is_pid(pid) and is_pid(pid)
).
- Generated vars will no longer shadow variables in scope (e.g. if
- Numerous fixes related to pattern generation, especially in regards to map keys.
v0-3-3-2023-05-01
v0.3.3 (2023-05-01)
changed-1
Changed
- Improve stacktraces and ExUnit assertion errors when an auto-assertion fails or is rejected.
- When an
auto_assert
updates, a default pattern that is more similar to the existing one will be selected in more cases when the:default_pattern
option is set to:infer
(the default). - When updating an assertion with an existing map pattern that only asserts a subset of keys, generate a pattern using that subset as well.
v0-3-2-2023-04-16
v0.3.2 (2023-04-16)
changed-2
Changed
- Multi-line string patterns will now always appear in the same order (heredoc format will always be the last option).
fixed-3
Fixed
- Raise a more comprehensible error if
Mneme.start()
is called multiple times withoutrestart: true
. - Fix an incorrect guard that could cause semantic diffing to fail and fall back to text diffing.
- Fix multi-line string formatting issues with
auto_assert_raise
,auto_assert_receive
, andauto_assert_received
.
v0-3-1-2023-04-14
v0.3.1 (2023-04-14)
changed-3
Changed
- Multi-line strings will now generate both a heredoc and a single-line option.
removed-1
Removed
- No longer depend on
libgraph
.
v0-3-0-2023-04-10
v0.3.0 (2023-04-10)
It is recommended to now use Elixir v1.14.4 or later.
added-2
Added
- Add three new auto-assertions:
- Add a
:force_update
option that forces re-generating assertion patterns even when they succeed. See the Options documentation for more info. - Prompts will now show options that were overridden from the defaults.
- Mneme now prints a one-line summary at the end of the test run.
changed-4
Changed
- For falsy values,
auto_assert
now generates<-
pattern matches instead of==
value comparisons, which have been removed. - Existing auto-assertions will now run when
Mneme.start()
is not called, but new or failing auto-assertions will fail without prompting (#32). - Ranges now use range syntax like
1..10
and1..10//2
instead of generating a%Range{}
struct.
removed-2
Removed
- Breaking:
auto_assert
no longer supports value comparisons using==
.
fixed-4
Fixed
- Fix a configuration precedence bug that caused options set in application config to always override module, describe, or test options.
- Fix a compatibility issue with Ecto ~> 3.9.4 (#34).
- Fix a confusing diff result that could occur with some binary operations (#11).
- Preceding comments are no longer shown in diffs (#26).
- Fix a number of diffing errors related to structs.
v0-2-7-2023-03-29
v0.2.7 (2023-03-29)
fixed-5
Fixed
- Fix a crash related to escaped string interpolation characters (#29).
v0-2-6-2023-03-27
v0.2.6 (2023-03-27)
added-3
Added
- Auto-assertion prompts can now be skipped (
s
) in addition to accepted (y
) or rejected (n
). This allows the test clause to continue so that later assertions might be run, but fails the test run once the suite finishes. - Semantic diffs will now be displayed side-by-side if terminal width allows. To always display diffs stacked, use the
diff_style: :stacked
option; see the "Configuration" section of theMneme
module doc for more.
changed-5
Changed
- Semantic diff formatting has been improved for clarity.
fixed-6
Fixed
- Don't overwrite test files if their content changes after starting the test run (#23).
- Fix a crash that occurred when a value contained nested strings with newlines, e.g.
{:ok, "hello\nworld"}
(#25). - The
j/k
options will no longer be rendered when prompting if there is only a single pattern option.
v0-2-4-v0-2-5-2023-03-25
v0.2.4, v0.2.5 (2023-03-25)
fixed-7
Fixed
- Remove unnecessary files from Hex package. This cuts the package size down drastically.
v0-2-3-2023-03-25
v0.2.3 (2023-03-25)
fixed-8
Fixed
- Fix diffing for certain sigil variations.
- Fix
dbg
-related error when runningMIX_ENV=test iex -S mix
(#20). - Fix ETS-related error when calling
Mneme.start/1
multiple times (#20).
v0-2-2-2023-03-20
v0.2.2 (2023-03-20)
fixed-9
Fixed
- Disable a semantic diffing optimization that caused poor diff results in certain cases, usually manifesting as incorrect branches being compared.
v0-2-1-2023-03-19
v0.2.1 (2023-03-19)
changed-6
Changed
- More consistent formatting between
:semantic
and:text
diffs.
v0-2-0-2023-03-18
v0.2.0 (2023-03-18)
added-4
Added
- Adds semantic diffs which selectively highlight only meaningful changes when updating an assertion. This can be disabled with the
diff: :text
option; see the "Configuration" section of theMneme
module doc for more.
changed-7
Changed
- Breaking: Mneme now requires Elixir v1.14 or later.
fixed-10
Fixed
- Invalid options now cause a warning instead of crashing test process.
- Internal errors now show an error instead of crashing test process.
- Fix bug causing multiple identical choices to be presented in some cases where empty lists were a part of the value.
v0-1-6-2023-03-04
v0.1.6 (2023-03-04)
changed-8
Changed
- Improved compile-time error message when
auto_assert
is used outside of atest
block (#9).
v0-1-5-2023-02-25
v0.1.5 (2023-02-25)
changed-9
Changed
- More consistent handling of charlists: lists of integers will now generate themselves as a pattern as well as a charlist if the list is ASCII printable (#6).
v0-1-4-2023-02-23
v0.1.4 (2023-02-23)
fixed-11
Fixed
- Fix a bug that could cause
auto_assert
expressions to revert to the previous value when usingMneme.start(restart: true)
(#7).
v0-1-3-2023-02-22
v0.1.3 (2023-02-22)
added-5
Added
- Add a
:default_pattern
configuration option for auto-assertions which controls the pattern that should be selected by default when prompted.
fixed-12
Fixed
- When converting an auto-assertion to an ExUnit assertion, select the identical pattern when the
:default_pattern
is:infer
(set by default).
v0-1-2-2023-02-21
v0.1.2 (2023-02-21)
added-6
Added
- Add a
:restart
option toMneme.start/1
to restart Mneme if called multiple times.
v0-1-1-2023-02-20
v0.1.1 (2023-02-20)
changed-10
Changed
- Dramatically reduce the performance gap between
auto_assert
and ExUnit'sassert
.
v0-1-0-2023-02-19
v0.1.0 (2023-02-19)
First release.