View Source GuardedStruct (Mishka developer tools v0.1.0)
The creation of this macro will allow you to build Structs
that provide you with a number of important options, including the following:
- Validation
- Sanitizing
- Constructor
- It provides the capacity to operate in a nested style simultaneously.
Suppose you are going to collect a number of pieces of information from the user, and before doing anything else, you are going to sanitize them. After that, you are going to validate each piece of data, and if there are no issues, you will either display it in a proper output or save it somewhere else. All of the characteristics that are associated with this macro revolve around cleaning and validating the data.
The features that we list below are individually based on a particular strategy and requirement, but thankfully, they may be combined and mixed in any way that you see fit.
It bestows to you a significant amount of authority in this sphere.
After the initial version of this macro was obtained from the source of the typed_struct
library, many sections of it were rewritten, or new concepts were taken from libraries in Rust and Scala and added to this library in the form of Elixir base.
The initial version of this macro can be found in the typed_struct
library. Its base is a syntax that is very easy to comprehend, especially for non-technical product managers, and highly straightforward.
Before explaining the copyright, I must point out that the primary library, which is typed_struct
, is no longer supported for a long time, so please pay attention to the following copyright.
Copyright
The code in this module is based on the 'typed_struct' library (https://github.com/ejpcmac/typed_struct), which is licensed under the MIT License.
Modifications and additions have been made to enhance its capabilities as part of the current project.
MIT License
Adding new Copyright (c) [2023] [Shahryar Tavakkoli at Mishka Group]
Note: If the license changes during the support of this project, this file will always remain on MIT
Summary
Functions
Defines a guarded struct
The beginning of the block consists of the introduction of a Struct
with the guardedstruct
macro, which is solely responsible for recording a series of information in order to create a struct, as well as all of the fields with the field
macro, and if you need to create another struct within this struct (in actuality, a module child within another module), you must use the sub_field
macro.
Functions
Defines a guarded struct
The beginning of the block consists of the introduction of a Struct
with the guardedstruct
macro, which is solely responsible for recording a series of information in order to create a struct, as well as all of the fields with the field
macro, and if you need to create another struct within this struct (in actuality, a module child within another module), you must use the sub_field
macro.
Note: there is no restriction on the number of times you can call the sub_field
macro or the field macro within the context of the sub_field
macro.
Note: Because Stract
does not prioritize the display of keys depending on your requirements, you do not need to follow the priority of the fields and call them in order to utilize the app.
Implement the program's logic, regardless of what it might be.
Note: Because of different limitations, if you want to write a test, you must first place the module in which you built the struct outside of the test macro. Once the struct has been built, you may then test it by calling it within the test macro itself. The examples it provides can also be found in the testing done by this library itself.
Note: this library is only supported on versions of Elixir 1.15
and higher, as well as OTP 26
, and that the manufacturer does not offer bug patches for problems that occur in older software versions.
Note: All of this library's dependencies are optional; nonetheless, if you require their use in your program, you will need to include them. We provide further explanation on the topic in the area you're looking for.
Before continuing with the discussion about the library section and also offering practical examples in this field, it is important to understand that when you construct a struct in a module, after compilation in the runtime of the program, each module includes the following functional functions:
The
builder()
function is actually an action function, and it requires you to provide it with information in the form of amap
.The
enforce_keys()
function: this method returns the necessary keys of the first layer of the struct. However, if you want to display all of the keys of the nested struct, you will need to enter the:all
input, which is not yet implemented in this version.The
keys()
function has the same requirements as theenforce_keys()
function, with the exception that it returns all of the keys, including the ones that aren't necessary.
And also, any data that enters the builder
function must go through the following path:
If the
map
currently uses thestring
data type, it will be converted to theatom
data type.Eliminates the keys from the
struct
that are not present in the listDetermines whether or not all of the essential keys have been transmitted.
If you write your own custom validation, each field's validations will be checked.
It is important to notice that regardless of the circumstances, this macro also inspects the module itself. If there is a
validator
function but none of the functions are set, it calls the validator function directly from the module itself into the field itself.
- The output of the complete
struct
is entered into the mother validation, and the programmer is given the opportunity to write for the final output in this validation. This validation also provides the possibility of writing for the output of the struct.
This macro will call the struct's
main_validator
directly from the module it has been placed in if, in this section, themain_validator
is not set in the struct but is found in the module that contains the struct.
If there were no problems in the previous phases (it is important to note that options 4 and 5 are not required), it will proceed to the next level of the program, which is the validation and custom Sanitizer stage.
To begin, the Sanitizer will alter the data so that it corresponds to what you have called in each field, and it will not return any errors. Even if the Sanitizer programmer is not utilized in the required type as a result of an accidental oversight, the data will still be passed to the following stage.
At this point, it will return an error or data for each field, depending on the validations that you called.
At the end of the process, you will receive a tuple that will either have problems in it or the final data with an ok status.
It is important to keep in mind that if your
struct
is nested, all of the internal errors of these structs are also included in the list of problems. Additionally, the data will be sent to you when the status is positive, but only if you have called the parent of this struct.
Note that each nested struct can be used on its own and possesses all of the capabilities that have been discussed thus far. For instance, if you have module
A
and you utilized thesub_field
that is namedauth
in it, you may now use it separately from theA.Auth
Use. Use.
Examples
Defining a struct layer without additional options
defmodule MyStruct do
use GuardedStruct
guardedstruct do
field :field_one, String.t()
field :field_two, integer(), enforce: true
field :field_three, boolean(), enforce: true
field :field_four, atom(), default: :hey
end
end
Define a struct with settings related to essential keys or
opaque
type
Options
enforce
- if set to true, setsenforce: true
to all fields by default. This can be overridden by settingenforce: false
or a default value on individual fields.opaque
- if set to true, creates an opaque type for the struct.module
- if set, creates the struct in a submodule namedmodule
.
defmodule MyModule do
use GuardedStruct
guardedstruct enforce: true do
field(:enforced_by_default, term())
field(:not_enforced, term(), enforce: false)
field(:with_default, integer(), default: 1)
field(:with_false_default, boolean(), default: false)
field(:with_nil_default, term(), default: nil)
end
end
# OR opaque
defmodule MyModule do
use GuardedStruct
guardedstruct opaque: true do
field(:enforced_by_default, term())
field(:not_enforced, term(), enforce: false)
field(:with_default, integer(), default: 1)
field(:with_false_default, boolean(), default: false)
field(:with_nil_default, term(), default: nil)
end
end
# OR opaque
defmodule MyModule do
use GuardedStruct
guardedstruct do
field(:enforced_by_default, term())
field(:not_enforced, term(), enforce: true)
field(:with_default, integer(), default: 1)
field(:with_false_default, boolean(), default: false)
field(:with_nil_default, term(), default: nil)
end
end
# OR create sub module
defmodule TestModule do
use GuardedStruct
guardedstruct module: Struct do
field(:field, term())
end
end
Defining the struct by calling the validation module or calling from the module that contains the struct
Options
validator
- if set as tuple like this {ModuleName, :function_name} for each field, in fact you have abuilder
function that check the validation.
# First, it looks at whether a validator has been set for each field,
# otherwise it looks inside the module.
defmodule MyModule do
alias MyModule.AnotherModule
use GuardedStruct
guardedstruct do
field(:name, String.t(), validator: {AnotherModule, :validator})
field(:title, String.t())
end
def validator(:title, value) do
{:ok, :title, value}
end
# You can not use it, but it is mentioned here for test clarity
def validator(name, value) do
{:ok, name, value}
end
end
- Output without error:
{:ok, :field_name, value}
- Output with error:
{:error, :field_name, ERROR MESSAGE}
Define the struct by calling the
main_validator
for full access on the output
Options
main_validator
- if set as tuple like this {ModuleName, :function_name}, for guardedstruct, in fact you have a global validation.
# First, it looks at whether a main_validator has been set for each field,
# otherwise it looks inside the module.
defmodule MyModule do
alias MyModule.AnotherModule
use GuardedStruct
guardedstruct main_validator: {AnotherModule, :main_validator} do
field(:name, String.t())
field(:title, String.t())
end
# if `guardedstruct` has no `main_validator` which is configed
def main_validator(value) do
{:ok, value}
end
end
- Output without error:
{:ok, value}
- Output with error:
{:error, :generalـreason, errors_list}
Define struct with
derive
derive is divided into two parts:
validate
andsanitize
, which is priority withsanitize
It should be noted that in the following tables you can see that in order to use some derives, you need to add its dependency on your project.
Sanitize
How to use | Dependencies | Description |
---|---|---|
"sanitize(trim)" | NO | Trim your string |
"sanitize(upcase)" | NO | Upcase your string |
"sanitize(downcase)" | NO | Downcase your string |
"sanitize(capitalize)" | NO | Capitalize your string |
"sanitize(basic_html)" | :html_sanitize_ex | Sanitize your string base on basic_html |
"sanitize(html5)" | :html_sanitize_ex | Sanitize your string base on html5 |
"sanitize(markdown_html)" | :html_sanitize_ex | Sanitize your string base on markdown_html |
"sanitize(strip_tags)" | :html_sanitize_ex | Sanitize your string base on strip_tags |
"sanitize(tag)" | :html_sanitize_ex | Sanitize your string base on html_sanitize_ex selection |
Validate
How to use | Dependencies | Description |
---|---|---|
"validate(string)" | NO | Validate if the data is string |
"validate(integer)" | NO | Validate if the data is integer |
"validate(list)" | NO | Validate if the data is list |
"validate(atom)" | NO | Validate if the data is atom |
"validate(bitstring)" | NO | Validate if the data is bitstring |
"validate(boolean)" | NO | Validate if the data is boolean |
"validate(exception)" | NO | Validate if the data is exception |
"validate(float)" | NO | Validate if the data is float |
"validate(function)" | NO | Validate if the data is function |
"validate(map)" | NO | Validate if the data is map |
"validate(nil_value)" | NO | Validate if the data is nil value |
"validate(not_nil_value)" | NO | Validate if the data is not nil value |
"validate(number)" | NO | Validate if the data is number |
"validate(pid)" | NO | Validate if the data is Elixir pid |
"validate(port)" | NO | Validate if the data is Elixir port |
"validate(reference)" | NO | Validate if the data is Elixir reference |
"validate(struct)" | NO | Validate if the data is struct |
"validate(tuple)" | NO | Validate if the data is tuple |
"validate(not_empty)" | NO | Validate if the data is not empty - binary, map, list |
"validate(max_len=10)" | NO | Validate if the data is more than 10 - Range, integer, binary |
"validate(min_len=10)" | NO | Validate if the data is less than 10 - Range, integer, binary |
"validate(url)" | NO | Validate if the data is url |
"validate(geo_url)" | ex_url | Validate if the data is geo url |
"validate(tell)" | ex_url | Validate if the data is tell |
"validate(tell=98)" | ex_url | Validate if the data is tell with country code |
"validate(email)" | email_checker | Validate if the data is email |
"validate(location)" | ex_url | Validate if the data is location |
"validate(string_boolean)" | NO | Validate if the data is string boolean |
"validate(datetime)" | NO | Validate if the data is datetime |
"validate(range)" | NO | Validate if the data is datetime |
"validate(date)" | NO | Validate if the data is datetime |
"validate(regex='^[a-zA-Z]+@mishka.group$')" | NO | Validate if the data is match with regex |
"validate(ipv4)" | NO | Validate if the data is ipv4 |
"validate(not_empty_string)" | NO | Validate if the data is not empty string |
"validate(uuid)" | NO | Validate if the data is uuid |
"validate(enum=String[admin::user::banned])" | NO | Validate if the data is one of the enum value, which is String |
"validate(enum=Atom[admin::user::banned])" | NO | Validate if the data is one of the enum value, which is Atom |
"validate(enum=Integer[1::2::3])" | NO | Validate if the data is one of the enum value, which is Integer |
"validate(enum=Float[1.5::2.0::4.5])" | NO | Validate if the data is one of the enum value, which is Float |
"validate(enum=Map[%{status: 1}::%{status: 2}::%{status: 3}])" | NO | Validate if the data is one of the enum value, which is Map |
"validate(enum=Tuple[{:admin, 1}::{:user, 2}::{:banned, 3}])" | NO | Validate if the data is one of the enum value, which is Tuple |
defmodule MyModule do
use GuardedStruct
guardedstruct do
field(:id, integer(), derive: "sanitize(trim) validate(integer, max_len=20, min_len=5)")
field(:title, String.t(), derive: "sanitize(trim, upcase) validate(not_empty_string)")
field(:name, String.t(), derive: "sanitize(trim, capitalize) validate(string, not_empty, max_len=20)")
end
end
Extending
derive
section
Options
validate_derive
- It can be just one module or a list of modulessanitize_derive
- It can be just one module or a list of modules
defmodule TestValidate do
def validate(:testv1, input, field) do
if is_binary(input),
do: input,
else: {:error, field, :testv1, "The name field must not be empty"}
end
end
defmodule TestValidate2 do
def validate(:testv2, input, field) do
if is_binary(input),
do: input,
else: {:error, field, :testv1, "The name field must not be empty"}
end
end
defmodule TestSanitize do
def sanitize(:capitalize_v1, input) do
if is_binary(input), do: String.capitalize(input), else: input
end
end
defmodule TestSanitize2 do
def sanitize(:capitalize_v2, input) do
if is_binary(input), do: String.capitalize(input), else: input
end
end
defmodule MyModule do
use GuardedStruct
guardedstruct validate_derive: TestValidate, sanitize_derive: TestSanitize do
field(:id, integer(), derive: "sanitize(trim) validate(not_exist)")
field(:title, String.t(), derive: "sanitize(trim) validate(string)")
field(:name, String.t(), derive: "sanitize(capitalize_v2) validate(string)")
end
end
# OR you can extend with list of modules
defmodule MyModule do
use GuardedStruct
guardedstruct validate_derive: [TestValidate, TestValidate2], sanitize_derive: [TestSanitize, TestSanitize2] do
field(:id, integer(), derive: "validate(ineteger)")
field(:title, String.t(), derive: "sanitize(trim) validate(string)")
field(:name, String.t(), derive: "sanitize(capitalize_v2) validate(string)")
end
end
Struct definition with
validator
andderive
simultaneously
# In this code, name field has not custom validator module and function
# Then it see the caller module for it
defmodule MyModule do
use GuardedStruct
guardedstruct do
field(:name, String.t(),
enforce: true,
derive: "sanitize(trim, upcase) validate(not_empty)"
)
field(:title, String.t(), derive: "sanitize(trim, capitalize) validate(not_empty)")
end
def validator(:name, value) do
if is_binary(value), do: {:ok, :name, "Mishka "}, else: {:error, :name, "No, never"}
end
def validator(name, value) do
{:ok, name, value}
end
end
# OR with custom validator
defmodule MyModule do
alias MyModule.AnotherModule
use GuardedStruct
guardedstruct do
field(:name, String.t(), enforce: true, derive: "sanitize(trim, capitalize) validate(not_empty)" validator: {AnotherModule, :validator})
field(:title, String.t(), derive: "sanitize(trim, capitalize) validate(not_empty)")
end
# You can not use it, but it is mentioned here for test clarity
def validator(name, value) do
{:ok, name, value}
end
end
Define a nested and complex struct
defmodule TestNestedStruct do
use GuardedStruct
guardedstruct do
field(:name, String.t(),
derive:
"sanitize(strip_tags, trim, capitalize) validate(string, not_empty, max_len=20, min_len=3)"
)
field(:family, String.t(),
derive:
"sanitize(basic_html, trim, capitalize) validate(string, not_empty, max_len=20, min_len=3)"
)
field(:age, integer(), enforce: true, derive: "validate(integer, max_len=110, min_len=18)")
sub_field(:auth, struct(), enforce: true) do
field(:server, String.t(), derive: "validate(regex='^[a-zA-Z]+@mishka.group$')")
field(:identity_provider, String.t(),
derive: "sanitize(strip_tags, trim, lowercase) validate(not_empty)"
)
sub_field(:role, struct(), enforce: true) do
field(:name, String.t(),
derive:
"sanitize(strip_tags, trim, lowercase) validate(enum=Atom[admin::user::banned])"
)
field(:action, String.t(), derive: "validate(string_boolean)")
field(:status, String.t(),
derive: "validate(enum=Map[%{status: 1}::%{status: 2}::%{status: 3}])"
)
end
field(:last_activity, String.t(), derive: "sanitize(strip_tags, trim) validate(datetime)")
end
sub_field(:profile, struct()) do
field(:site, String.t(), derive: "validate(url)")
field(:nickname, String.t(), validator: {TestNestedStruct, :validator})
end
field(:username, String.t(),
enforce: true,
derive: "sanitize(tag=strip_tags) validate(not_empty, max_len=20, min_len=3)"
)
end
def validator(:nickname, value) do
if is_binary(value),
do: {:ok, :nickname, value},
else: {:error, :nickname, "Invalid nickname"}
end
def validator(field, value) do
{:ok, field, value}
end
end
Error and data output sample
# Error
{:error, :bad_parameters,
[
%{
field: :profile,
errors: {:bad_parameters, [%{message: "Invalid nickname", field: :nickname}]}
},
%{
field: :auth,
errors:
{:bad_parameters,
[
%{message: _msg, field: :last_activity, action: :datetime},
%{
field: :role,
errors:
{:bad_parameters,
[
%{message: _msg1, field: :action, action: :string_boolean}
]}
}
]}
}
]}
# Data
{:ok,
%MishkaDeveloperToolsTest.GuardedStructTest.TestNestedStruct{
username: "mishka",
profile: %MishkaDeveloperToolsTest.GuardedStructTest.TestNestedStruct.Profile{
nickname: "mishka",
site: "https://elixir-lang.org"
},
auth: %MishkaDeveloperToolsTest.GuardedStructTest.TestNestedStruct.Auth{
last_activity: "2023-08-20 16:54:07.841434Z",
role: %MishkaDeveloperToolsTest.GuardedStructTest.TestNestedStruct.Auth.Role{
action: "true",
name: :user,
status: %{status: 2}
},
identity_provider: "google",
server: "users@mishka.group"
},
age: 18,
family: "Group",
name: "Mishka"
}}