-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
720b25d
commit a23b65a
Showing
2 changed files
with
175 additions
and
129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,174 +1,197 @@ | ||
| # Mishka Installer is a system plugin(event) manager and run time installer for elixir. | ||
| # Mishka Installer is a system plugin(event) manager and run time installer for Elixir. | ||
|
|
||
| [](https://github.com/mishka-group/mishka_installer/actions/workflows/ci.yml) [](https://hex.pm/packages/mishka_installer) [](https://raw.githubusercontent.com/mishka-group/mishka_installer/master/LICENSE)  | ||
| [](https://github.com/mishka-group/mishka_installer/actions/workflows/ci.yml) [](https://hex.pm/packages/mishka_installer) [](https://raw.githubusercontent.com/mishka-group/mishka_installer/master/LICENSE)  | ||
|
|
||
| ## Build purpose | ||
| --- | ||
| ## Build purpose | ||
| --- | ||
|
|
||
| Imagine you are going to make an application that will have many plugins built for it in the future. | ||
| But the fact that many manipulations will be made on your source code makes it difficult to | ||
| maintain the application. For example, you present a content management system for your users, | ||
| and now they need to activate a section for registration and `SMS`; the system allows you to | ||
| present your desired input/output absolutely plugin oriented to your users and makes it | ||
| possible for the developers to write their required applications beyond the core source code. | ||
| Imagine you are going to make an application that will have many plugins built for it in the future. | ||
| But the fact that many manipulations will be made on your source code makes it difficult to | ||
| maintain the application. For example, you present a content management system for your users, | ||
| and now they need to activate a section for registration and `SMS`; the system allows you to | ||
| present your desired input/output absolutely plugin oriented to your users and makes it | ||
| possible for the developers to write their required applications beyond the core source code. | ||
|
|
||
| **NOTICE: Do not use the master branch; this library is under heavy development. Expect version 0.1.0, | ||
| and for using the new features, please wait until a new release is out.** | ||
| **NOTICE: Do not use the master branch; this library is under heavy development. Expect version 0.1.0, | ||
| and for using the new features, please wait until a new release is out.** | ||
|
|
||
| ### Events and Hook | ||
| --- | ||
| ##### This library is divided into the following main sections: | ||
|
|
||
| In this section, you can define a series of events for each event, | ||
| for example: after **successful registration** or **unsuccessful purchase** from “the store”, | ||
| and for each event, put a set of callbacks in one module. | ||
| - [Events and Hook](#events-and-hook) | ||
| - [Plugin management system theory and installation of Elixir libraries at runtime](#plugin-management-system-theory-and-installation-of-elixir-libraries-at-runtime) | ||
|
|
||
| After completing this step, when the user wants to create his own plugin, | ||
| the Macro `behaviour` and `Hook` module will call you in its action module. | ||
|
|
||
| This helps you have a regular and `error-free` system, and the library uses an almost | ||
| integrated structure in all of its events. | ||
| ### Events and Hook | ||
| --- | ||
|
|
||
| In **Mishka Installer** Library, a series of action or hook functions are | ||
| given to the developer of the main plugin or software, which helps build plugins outside/inside | ||
| the system and convert software sections into separate events. | ||
| In this section, you can define a series of events for each event, | ||
| for example: after **successful registration** or **unsuccessful purchase** from “the store”, | ||
| and for each event, put a set of callbacks in one module. | ||
|
|
||
| Some of the functions of this module include the following: | ||
| After completing this step, when the user wants to create his own plugin, | ||
| the Macro `behaviour` and `Hook` module will call you in its action module. | ||
|
|
||
| - Retrieves the merged configuration for the hook module. | ||
| - Register a plugin for a specific event. | ||
| - Start a plugin of a specific event. | ||
| - Restart a plugin of a specific event. | ||
| - Stop a plugin of a specific event. | ||
| - Unregister a plugin of a specific event. | ||
| - Retrieves a Plugin `GenServer` state. | ||
| - Each plugin has A `GenServer` to do some auto jobs. | ||
| This helps you have a regular and `error-free` system, and the library uses an almost | ||
| integrated structure in all of its events. | ||
|
|
||
| > For more information please see the `MishkaInstaller.Event.Hook` module. | ||
| In **Mishka Installer** Library, a series of action or hook functions are | ||
| given to the developer of the main plugin or software, which helps build plugins outside/inside | ||
| the system and convert software sections into separate events. | ||
|
|
||
| ### Example: | ||
| Some of the functions of this module include the following: | ||
|
|
||
| ```elixir | ||
| defmodule RegisterEmailSender do | ||
| use MishkaInstaller.Event.Hook, event: "after_success_login" | ||
| - Retrieves the merged configuration for the hook module. | ||
| - Register a plugin for a specific event. | ||
| - Start a plugin of a specific event. | ||
| - Restart a plugin of a specific event. | ||
| - Stop a plugin of a specific event. | ||
| - Unregister a plugin of a specific event. | ||
| - Retrieves a Plugin `GenServer` state. | ||
| - Each plugin has A `GenServer` to do some auto jobs. | ||
|
|
||
| def call(entries) do | ||
| {:reply, entries} | ||
| end | ||
| end | ||
| ``` | ||
| > For more information please see the `MishkaInstaller.Event.Hook` module. | ||
| ##### Example: | ||
|
|
||
| If you want to change a series of default information, do this: | ||
| ```elixir | ||
| defmodule RegisterEmailSender do | ||
| use MishkaInstaller.Event.Hook, event: "after_success_login" | ||
|
|
||
| ```elixir | ||
| use MishkaInstaller.Event.Hook, | ||
| event: "after_success_login", | ||
| initial: %{depends: [SomeEvent], priority: 20} | ||
| ``` | ||
| def call(entries) do | ||
| {:reply, entries} | ||
| end | ||
| end | ||
| ``` | ||
|
|
||
| #### You can call all plugins of an event: | ||
| If you want to change a series of default information, do this: | ||
|
|
||
| ```elixir | ||
| alias MishkaInstaller.Event.Hook | ||
| ```elixir | ||
| use MishkaInstaller.Event.Hook, | ||
| event: "after_success_login", | ||
| initial: %{depends: [SomeEvent], priority: 20} | ||
| ``` | ||
|
|
||
| # Normal call an event plugins | ||
| Hook.call("after_success_login", params) | ||
| #### You can call all plugins of an event: | ||
|
|
||
| # If you want certain entries not to change | ||
| Hook.call("after_success_login", params, [private: something_based_on_your_data]) | ||
| ```elixir | ||
| alias MishkaInstaller.Event.Hook | ||
|
|
||
| # If you want the initial entry to be displayed at the end | ||
| Hook.call("after_success_login", params, [return: true]) | ||
| ``` | ||
| # Normal call an event plugins | ||
| Hook.call("after_success_login", params) | ||
|
|
||
| **Note: If you want your plugin to execute automatically, | ||
| all you need to do is send the name of the module in which you utilized | ||
| the `MishkaInstaller.Event.Hook` to the Application module.*** | ||
| # If you want certain entries not to change | ||
| Hook.call("after_success_login", params, [private: something_based_on_your_data]) | ||
|
|
||
| ```elixir | ||
| children = [ | ||
| ... | ||
| RegisterEmailSender | ||
| ] | ||
| # If you want the initial entry to be displayed at the end | ||
| Hook.call("after_success_login", params, [return: true]) | ||
| ``` | ||
|
|
||
| **Note: If you want your plugin to execute automatically, | ||
| all you need to do is send the name of the module in which you utilized | ||
| the `MishkaInstaller.Event.Hook` to the Application module.*** | ||
|
|
||
| ```elixir | ||
| children = [ | ||
| ... | ||
| opts = [strategy: :one_for_one, name: SomeModule.Supervisor] | ||
| Supervisor.start_link(children, opts) | ||
| ``` | ||
| RegisterEmailSender | ||
| ] | ||
|
|
||
| ### Plugin management system theory and installation of Elixir libraries at `runtime` | ||
| --- | ||
| The functionality of this library can be conceptualized as an architectural potential that is | ||
| composed of two primary components, which are as follows: | ||
| ... | ||
| opts = [strategy: :one_for_one, name: SomeModule.Supervisor] | ||
| Supervisor.start_link(children, opts) | ||
| ``` | ||
|
|
||
| 1. Event management (Plugin Hook powered by **Elixir Macro**) | ||
| 2. Managing removal and installation of Elixir libraries at `runtime`. | ||
| > This module is a read-only in-memory storage optimized for the fastest possible read times | ||
| > not for write strategies. | ||
| When a programmer uses this library for his own software development, we sought to | ||
| ensure that in addition to the established capabilities, he also has access to a set of | ||
| appropriate standards for software development that are based on preset behaviors that can be applied. | ||
| ### Plugin management system theory and installation of Elixir libraries at runtime | ||
| --- | ||
| The functionality of this library can be conceptualized as an architectural potential that is | ||
| composed of two primary components, which are as follows: | ||
|
|
||
| This was our goal. It streamlines and organizes the work of a group working on a project while | ||
| also facilitating the creation of software. | ||
| 1. Event management (Plugin Hook powered by **Elixir Macro**) | ||
| 2. Managing removal and installation of Elixir libraries at `runtime`. | ||
|
|
||
| Error control and tree structure, which enable us to develop a system that is robust and trustworthy, | ||
| are two of the guiding ideas behind the construction of this library, which has garnered attention | ||
| from people all around the world. | ||
| When a programmer uses this library for his own software development, we sought to | ||
| ensure that in addition to the established capabilities, he also has access to a set of | ||
| appropriate standards for software development that are based on preset behaviors that can be applied. | ||
|
|
||
| The MishkaInstaller library can be created in various systems, and it provides fundamental | ||
| capabilities such as the management of plugin states and the application of standard behaviors. | ||
| These features can all be accessed by specified hooks in the library. | ||
| This was our goal. It streamlines and organizes the work of a group working on a project while | ||
| also facilitating the creation of software. | ||
|
|
||
| > This module is a read-only in-memory storage optimized for the fastest possible read times | ||
| > not for write strategies. | ||
| Error control and tree structure, which enable us to develop a system that is robust and trustworthy, | ||
| are two of the guiding ideas behind the construction of this library, which has garnered attention | ||
| from people all around the world. | ||
|
|
||
| The MishkaInstaller library can be created in various systems, and it provides fundamental | ||
| capabilities such as the management of plugin states and the application of standard behaviors. | ||
| These features can all be accessed by specified hooks in the library. | ||
|
|
||
| ## Installing the library: | ||
| --- | ||
| It should be noted that this library must be installed in two parts of the plugin and the software that wants to display the plugins, and due to its small dependencies, it does not cause any problems. To install, just add this library to your "mix.exs" in the "deps" function as follows: | ||
| ##### Example: | ||
|
|
||
| ```elixir | ||
| def deps do | ||
| [ | ||
| {:mishka_installer, "~> 0.1.0"} | ||
| ] | ||
| end | ||
| ``` | ||
| ```elixir | ||
| alias MishkaInstaller.Installer.Installer | ||
|
|
||
| # Normal calling | ||
| Installer.install(%__MODULE__{app: "some_name", path: "some_name", type: :hex}) | ||
|
|
||
| # Normal calling | ||
| Installer.uninstall(%__MODULE__{app: "some_name", path: "some_name", type: :hex}) | ||
|
|
||
| # Normal calling | ||
| Installer.async_install(%__MODULE__{app: "some_name", path: "some_name", type: :hex}) | ||
| ``` | ||
|
|
||
| > For more information please see the `MishkaInstaller.Installer.Installer` module. | ||
|
|
||
| ## Installing the library: | ||
| --- | ||
| It should be noted that this library must be installed in two parts of the plugin and the software that wants to display the plugins, and due to its small dependencies, it does not cause any problems. To install, just add this library to your "mix.exs" in the "deps" function as follows: | ||
|
|
||
| ```elixir | ||
| def deps do | ||
| [ | ||
| {:mishka_installer, "~> 0.1.0"} | ||
| ] | ||
| end | ||
| ``` | ||
|
|
||
| --- | ||
| --- | ||
|
|
||
| # Donate | ||
| # Donate | ||
|
|
||
| If the project was useful for you, the only way you can donate to me is the following ways | ||
| If the project was useful for you, the only way you can donate to me is the following ways | ||
|
|
||
| | **BTC** | **ETH** | **DOGE** | **TRX** | | ||
| | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | ||
| | <img src="https://github.com/mishka-group/mishka_developer_tools/assets/8413604/230ea4bf-7e8f-4f18-99c9-0f940dd3c6eb" width="200"> | <img src="https://github.com/mishka-group/mishka_developer_tools/assets/8413604/0c8e677b-7240-4b0d-8b9e-bd1efca970fb" width="200"> | <img src="https://github.com/mishka-group/mishka_developer_tools/assets/8413604/3de9183e-c4c0-40fe-b2a1-2b9bb4268e3a" width="200"> | <img src="https://github.com/mishka-group/mishka_developer_tools/assets/8413604/aaa1f103-a7c7-43ed-8f39-20e4c8b9975e" width="200"> | | ||
| | **BTC** | **ETH** | **DOGE** | **TRX** | | ||
| | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | ||
| | <img src="https://github.com/mishka-group/mishka_developer_tools/assets/8413604/230ea4bf-7e8f-4f18-99c9-0f940dd3c6eb" width="200"> | <img src="https://github.com/mishka-group/mishka_developer_tools/assets/8413604/0c8e677b-7240-4b0d-8b9e-bd1efca970fb" width="200"> | <img src="https://github.com/mishka-group/mishka_developer_tools/assets/8413604/3de9183e-c4c0-40fe-b2a1-2b9bb4268e3a" width="200"> | <img src="https://github.com/mishka-group/mishka_developer_tools/assets/8413604/aaa1f103-a7c7-43ed-8f39-20e4c8b9975e" width="200"> | | ||
|
|
||
| <details> | ||
| <summary>Donate addresses</summary> | ||
| <details> | ||
| <summary>Donate addresses</summary> | ||
|
|
||
| **BTC**: | ||
| **BTC**: | ||
|
|
||
| ``` | ||
| bc1q24pmrpn8v9dddgpg3vw9nld6hl9n5dkw5zkf2c | ||
| ``` | ||
| ``` | ||
| bc1q24pmrpn8v9dddgpg3vw9nld6hl9n5dkw5zkf2c | ||
| ``` | ||
|
|
||
| **ETH**: | ||
| **ETH**: | ||
|
|
||
| ``` | ||
| 0xD99feB9db83245dE8B9D23052aa8e62feedE764D | ||
| ``` | ||
| ``` | ||
| 0xD99feB9db83245dE8B9D23052aa8e62feedE764D | ||
| ``` | ||
|
|
||
| **DOGE**: | ||
| **DOGE**: | ||
|
|
||
| ``` | ||
| DGGT5PfoQsbz3H77sdJ1msfqzfV63Q3nyH | ||
| ``` | ||
| ``` | ||
| DGGT5PfoQsbz3H77sdJ1msfqzfV63Q3nyH | ||
| ``` | ||
|
|
||
| **TRX**: | ||
| **TRX**: | ||
|
|
||
| ``` | ||
| TBamHas3wAxSEvtBcWKuT3zphckZo88puz | ||
| ``` | ||
| ``` | ||
| TBamHas3wAxSEvtBcWKuT3zphckZo88puz | ||
| ``` | ||
|
|
||
| </details> | ||
| </details> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters