Optify for Elixir

Copy Markdown View Source

Hex.pm

An Elixir library for Optify powered by Rust NIFs via Rustler.

See the homepage, Hex package, and HexDocs for details about how feature files are combined to build the options to process at runtime.

Requirements

  • Elixir >= 1.18
  • Erlang/OTP >= 27
  • Rust toolchain (for compiling the NIF)

Installation

Add :optify to your list of dependencies in mix.exs:

{:optify, "~> 0.2.0"}

Then fetch dependencies and compile the Rust NIF:

mix deps.get

If Rust is not installed yet, install it first, for example with rustup.

Usage

alias Optify.{GetOptionsPreferences, OptionsProvider, OptionsProviderBuilder}

# Build a provider from a directory of configuration files
provider = OptionsProvider.build!("path/to/configs")

# Get all options for enabled features
options = OptionsProvider.get_all_options(provider, ["feature_A", "B"])
# %{
#   "myConfig" => %{
#     "myArray" => ["example item 1"],
#     "myObject" => %{
#       "deeper" => %{"list" => [1, 2], "wtv" => 3},
#       "one" => 1,
#       "string" => "string",
#       "two" => 2
#     },
#     "rootString" => "root string same",
#     "rootString2" => "override"
#   }
# }

# Get options for a specific key
options = OptionsProvider.get_options(provider, "myConfig", ["feature_A", "B"])
# %{
#   "myArray" => ["example item 1"],
#   "myObject" => %{...},
#   "rootString" => "root string same",
#   "rootString2" => "override"
# }

# Use preferences for configurable strings and constraints
prefs = GetOptionsPreferences.new()
prefs = GetOptionsPreferences.enable_configurable_strings(prefs)
options = OptionsProvider.get_all_options(provider, ["feature_A"], prefs)

# Set overrides using a native Elixir map
prefs = GetOptionsPreferences.set_overrides(prefs, %{"myConfig" => %{"rootString" => "new value"}})

# Or using a JSON string
prefs = GetOptionsPreferences.set_overrides_json(prefs, ~s({"myConfig": {"rootString": "new value"}}))

# Use the builder for multiple directories
builder = OptionsProviderBuilder.new()
builder = OptionsProviderBuilder.add_directory!(builder, "path/to/configs1")
builder = OptionsProviderBuilder.add_directory!(builder, "path/to/configs2")
provider = OptionsProviderBuilder.build!(builder)

Development

Prerequisites

Install Erlang and Elixir using asdf:

asdf install

Running Tests

mix deps.get
mix test

Formatting

Elixir:

mix format
mix format --check-formatted

Rust (NIF code):

cd native/optify_nif
cargo fmt
cargo fmt -- --check

Linting

cd native/optify_nif
cargo clippy --no-deps -- -D warnings