christhekeele / Mnemonix
Programming Languages
Labels
Projects that are alternatives of or similar to Mnemonix
Mnemonix
A unified interface to key/value stores.
Synopsis
Mnemonix
aims to help you:
- Get running with key/value stores with minimal ceremony
- Experiment with different key/value store backends for your application
- Allow end-users of your library liberty to choose their preferred backend
- Enable composing access to different key/value stores with different read/write strategies
It encodes the behaviour, lifecycle, and feature set of a key/value store behind a common GenServer
interface, normalizes different store APIs to conform to that interface, polyfills stores lacking features, and exposes access to them through a familiar Map
API.
Learn more about starting a store and manipulating it with the Mnemonix
API in the documentation.
/nɛˈmɑːnɪks/
– noo-MAHN-icks
Pronunciation: Mnemonic systems are techniques or strategies consciously used to improve memory. They help use information already stored in long-term memory to make memorization an easier task.
— Mnemonics, Wikipedia
Status
👍 | Continuous Integration | Test Coverage |
---|---|---|
Master | ||
Development |
Features
Naturally, Mnemonix
gives you Map
-style functions to manipulate various key/value stores. However, Mnemonix
also offers extra features beyond simple Map functions. Stores that don't natively support these features have the capability added through an Elixir polyfill, guaranteeing you can use and switch stores without worrying about what features they support under the hood.
Available features are:
-
Mnemonix.Features.Map
- The key/value manipulation you know and love -
Mnemonix.Features.Bump
- Increment/decrement integer values -
Mnemonix.Features.Expiry
- Set entries to remove themselves from the store with a ttl -
Mnemonix.Features.Enumerable
- Iterate over all key/value pairs in supported stores
Installation
Add Mnemonix
to your project's dependencies in its mix.exs
:
def deps do
[
# ...
{:mnemonix, "~> 0.10.0"},
# ...
]
end
Contributing
Pull requests are welcome and greatly appreciated!
Please submit them against the development
branch rather than master
––this allows useful changes to be finessed before release. The GitHub UI should do this by default.
Here are some useful commands if you've just forked the project and want to contribute:
-
mix deps.get
- Get development dependencies -
mix test
- Run the test suite -
mix credo list
- Run static code analysis for style pointers on Elixir source -
mix dialyzer
- Run static code analysis for type checking on compiled BEAM bytecode -
mix coveralls.html
- Generate test suite coverage report -
mix docs
- Generate documentation pages -
mix inch
- Evaluate quality of documentation -
mix checks
- Run all of the above checks and analyses -
mix clean
- If any of the above stop behaving as expected
For more information on helping the development of Mnemonix, check out the contributing guide.
Notes
- Not to be confused with the mnemonicode library,
Mnemonex
.