View Source MishkaInstaller.Event.ModuleStateCompiler (Mishka installer v0.1.1)

The MishkaInstaller.Event.ModuleStateCompiler module is designed to dynamically create and manage event-driven modules that handle state and plugins within the Mishka Installer system. This module provides functions to create, purge, and verify the initialization state of these event modules.

In fact, this system creates a runtime module for each event based on system requirements and conditions in the MishkaInstaller.Event.Event and MishkaInstaller.Event.Hook modules, which also contains a series of essential functions.

Security considerations

It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.

This module is a read-only in-memory storage optimized for the fastest possible read times not for write strategies.

Compile path: MishkaInstaller.Event.ModuleStateCompiler.State.YourEvent.

Note:

When you are writing, you should always make an effort to be more careful because you might get reconditioned during times of high traffic. When it comes to reading and running all plugins, this problem only occurs when a module is being created and destroyed during the compilation process.

Summary

Types

error_return()

Functions

compile_initialize?(event)

Checks if the event module is compiled and loaded.

create(plugins, event)

Creates a new module based on the provided event name and plugins.

initialize?(event)

Checks if the event module is initialized.

module_event_name(event)

Generates a module name based on the event name.

purge(events)

Purges the specified event modules or a module.

purge_create(plugins, event)

Purges (purge/1) an existing module and creates a new one (create/2) with the provided plugins and event name.

rescue_initialize?(event)

Safely checks if the event module is initialized, rescuing any errors.

safe_initialize?(event)

Checks if the event module has an initialize? function exported.

Types

error_return()

@type error_return() ::
  {:error, [%{action: atom(), field: atom(), message: String.t()}]}

Functions

compile_initialize?(event)

@spec compile_initialize?(String.t()) :: boolean()

Checks if the event module is compiled and loaded.

Just should be used when you need one time or in compile time

Examples 

compile_initialize?("event_name")

create(plugins, event)

@spec create([struct()], String.t()) :: :ok | error_return()

Creates a new module based on the provided event name and plugins.

Parameters

  • plugins (list): A list of plugin(ishkaInstaller.Event.Event) structs to be included in the new module.
  • event (String.t()): The name of the event for which the module is created.

Security considerations

It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measure

Examples 

alias MishkaInstaller.Event.Event
create([%Event{name: MyPlugin}], "event_name")

initialize?(event)

@spec initialize?(String.t()) :: boolean()

Checks if the event module is initialized.

Examples 

initialize?("event_name")

module_event_name(event)

@spec module_event_name(String.t()) :: module()

Generates a module name based on the event name.

Security considerations

It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measure

Examples 

module_event_name("event_name")

purge(events)

@spec purge([String.t()] | String.t()) :: :ok

Purges the specified event modules or a module.

Security considerations

It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measure

Examples 

purge("event_name")

purge_create(plugins, event)

@spec purge_create([struct()], String.t()) :: :ok | error_return()

Purges (purge/1) an existing module and creates a new one (create/2) with the provided plugins and event name.

Security considerations

It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measure

Examples 

alias MishkaInstaller.Event.Event
purge_create([%Event{name: MyPlugin}], "event_name")

rescue_initialize?(event)

@spec rescue_initialize?(String.t()) :: boolean()

Safely checks if the event module is initialized, rescuing any errors.

Examples 

rescue_initialize?("event_name")

safe_initialize?(event)

@spec safe_initialize?(String.t()) :: boolean()

Checks if the event module has an initialize? function exported.

Examples 

safe_initialize?("event_name")