{"id":18002867,"url":"https://github.com/am-kantox/exvalibur","last_synced_at":"2025-03-26T08:31:19.613Z","repository":{"id":57501147,"uuid":"155722067","full_name":"am-kantox/exvalibur","owner":"am-kantox","description":"Elixir Validator Generator","archived":false,"fork":false,"pushed_at":"2019-05-09T06:17:04.000Z","size":236,"stargazers_count":15,"open_issues_count":6,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-30T00:47:08.561Z","etag":null,"topics":["elixir","elixir-lang","guards","validation"],"latest_commit_sha":null,"homepage":null,"language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/am-kantox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-01T13:48:16.000Z","updated_at":"2022-10-29T18:44:12.000Z","dependencies_parsed_at":"2022-09-03T00:42:00.460Z","dependency_job_id":null,"html_url":"https://github.com/am-kantox/exvalibur","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/am-kantox%2Fexvalibur","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/am-kantox%2Fexvalibur/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/am-kantox%2Fexvalibur/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/am-kantox%2Fexvalibur/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/am-kantox","download_url":"https://codeload.github.com/am-kantox/exvalibur/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245618753,"owners_count":20645061,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","elixir-lang","guards","validation"],"created_at":"2024-10-29T23:24:18.057Z","updated_at":"2025-03-26T08:31:18.998Z","avatar_url":"https://github.com/am-kantox.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![Logo](/stuff/logo-48x48.png?raw=true) Exvalibur\n\n[![CircleCI](https://circleci.com/gh/am-kantox/exvalibur.svg?style=svg)](https://circleci.com/gh/am-kantox/exvalibur)     **generator for blazingly fast validators of maps based on sets of predefined rules**\n\n## Installation\n\nSimply add `exvalibur` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:exvalibur, \"~\u003e 0.1\"}\n  ]\nend\n```\n\n## Usage\n\n```elixir\nrules = [\n  %{matches: %{currency_pair: \"EURUSD\"},\n    conditions: %{rate: %{min: 1.0, max: 2.0}}}]\nExvalibur.validator!(rules, module_name: Exvalibur.Validator)\nExvalibur.Validator.valid?(%{currency_pair: \"EURUSD\", rate: 1.5})\n#⇒ {:ok, %{currency_pair: \"EURUSD\", rate: 1.5}}\nExvalibur.Validator.valid?(%{currency_pair: \"EURGBP\", rate: 1.5})\n#⇒ :error\nExvalibur.Validator.valid?(%{currency_pair: \"EURUSD\", rate: 0.5})\n#⇒ :error\n\nrules = [\n  %{matches: %{currency_pair: \"EURGBP\"},\n    conditions: %{rate: %{min: 1.0, max: 2.0}}}]\nExvalibur.validator!(rules, module_name: Exvalibur.Validator)\nExvalibur.Validator.valid?(%{currency_pair: \"EURGBP\", rate: 1.5})\n#⇒ {:ok, %{currency_pair: \"EURGBP\", rate: 1.5}}\nExvalibur.Validator.valid?(%{currency_pair: \"EURUSD\", rate: 1.5})\n#⇒ {:ok, %{currency_pair: \"EURUSD\", rate: 1.5}}\n```\n\n## Sigils To Pattern Match Data\n\nStarting with `v0.4.0` we support `~q` and `~Q` sigils to use validator with\npattern matching.\n\n```elixir\n  import Exvalibur.Sigils\n\n  starting_with = \"bar\"\n  rules = [%{matches: %{foo: ~q[\u003c\u003c\"#{starting_with}\", _::binary\u003e\u003e]}}]\n\n  Exvalibur.validator!(rules, module_name: TestValidator)\n\n  assert TestValidator.valid?(%{foo: \"bar\"}) == {:ok, %{foo: \"bar\"}}\n  assert TestValidator.valid?(%{foo: \"zzz\"}) == :error\n  assert TestValidator.valid?(%{foo: 42}) == :error\n```\n\n## Binary Conditions\n\nStarting with `v0.5.0` we support binary conditions for the declared guards.\n\n```elixir\n  import Exvalibur.Sigils\n\n  rules = [%{conditions: \"num \u003e= 0 and num \u003c= 100\"}]\n\n  Exvalibur.validator!(rules, module_name: TestValidator)\n\n  assert TestValidator.valid?(%{num: \"bar\"}) == :error\n  assert TestValidator.valid?(%{num: 200}) == :error\n  assert TestValidator.valid?(%{num: 42}) == {:ok, %{num: 42}}\n```\n\nAny match expression allowed in function head matching clause is allowed here.\n\n```elixir\n  import Exvalibur.Sigils\n\n  rules = [%{matches: %{foo: ~Q[%{} = _]}}]\n\n  Exvalibur.validator!(rules, module_name: TestValidator)\n\n  assert TestValidator.valid?(%{foo: %{bar: \"baz\"}}) == {:ok, %{foo: %{bar: \"baz\"}}}\n  assert TestValidator.valid?(%{foo: 42}) == :error\n```\n\n## Custom Guards\n\nStarting with `v0.6.0` we support arbitrary custom guards in rules. The variables\nused in these guards should be explicitly declared under the `matches` key in rules,\nin the form `foo: ~Q[foo]`.\n\n```elixir\n  import Exvalibur.Sigils\n\n  rules = [%{\n    matches: %{num: ~Q[num]},\n    guards: [\"num \u003e= 0 and num \u003c= 100\"]\n  }]\n\n  Exvalibur.validator!(rules, module_name: TestValidator)\n\n  assert TestValidator.valid?(%{num: \"bar\"}) == :error\n  assert TestValidator.valid?(%{num: 200}) == :error\n  assert TestValidator.valid?(%{num: 42}) == {:ok, %{num: 42}}\n```\n\n## Module-based validators\n\n```elixir\ndefmodule Validator do\n  use Exvalibur, rules: [\n    %{\n      matches: %{currency_pair: \u003c\u003c\"EUR\", _ :: binary\u003e\u003e},\n      conditions: %{foo: %{min: 0, max: 100}},\n      guards: %{num: num \u003e 0 and num \u003c 100}}]\nend\nValidator.valid?(%{currency_pair: \"EURUSD\", foo: 50, num: 50})\n#⇒ {:ok, %{currency_pair: \"EURUSD\", foo: 50, num: 50}}\n\nValidator.valid?(%{currency_pair: \"USDEUR\", foo: 50, num: 50})\n#⇒ :error\nValidator.valid?(%{currency_pair: \"EURUSD\", foo: -50, num: 50})\n#⇒ :error\nValidator.valid?(%{currency_pair: \"EURUSD\", foo: 50, num: -50})\n#⇒ :error\n```\n\n## Changelog\n\n#### `0.11.0`\n\n- Descriptive errors\n\n#### `0.10.0`\n\n- `@behaviour Exvalibur.Validatable` with overridable `custom_validate/1`\n\n#### `0.9.0`\n\n- `valid?/1` is deprecated in favor of `validate/1`; starting with `v1.0` `valid?/1` will return `boolean` value\n\n#### `0.8.0`\n\n- module-based validators\n\n## [Documentation](https://hexdocs.pm/exvalibur).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fam-kantox%2Fexvalibur","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fam-kantox%2Fexvalibur","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fam-kantox%2Fexvalibur/lists"}