From 76d96c2fe25bfeeaf9037171e24dcb3bfc6095b7 Mon Sep 17 00:00:00 2001
From: Alek Ratzloff <alekratz@gmail.com>
Date: Sun, 14 Jun 2020 17:34:06 -0400
Subject: [PATCH] Rename Omnibot.Module -> Omnibot.Module.Base, add
 Omnibot.Module with agent

Previously, all modules were Agents. This renames the Omnibot.Module to
be the base module, and the new Omnibot.Module uses an Agent by default.

This opens the doors to possibly allowing metamodule supervisors for
modules that may be more complex.

Signed-off-by: Alek Ratzloff <alekratz@gmail.com>
---
 lib/{module.ex => module/base.ex} | 38 +++++++------------------------
 lib/module/module.ex              | 29 +++++++++++++++++++++++
 2 files changed, 37 insertions(+), 30 deletions(-)
 rename lib/{module.ex => module/base.ex} (82%)
 create mode 100644 lib/module/module.ex

diff --git a/lib/module.ex b/lib/module/base.ex
similarity index 82%
rename from lib/module.ex
rename to lib/module/base.ex
index 8772493..403a5a7 100644
--- a/lib/module.ex
+++ b/lib/module/base.ex
@@ -1,4 +1,4 @@
-defmodule Omnibot.Module do
+defmodule Omnibot.Module.Base do
   defmodule Hooks do
     defmacro __before_compile__(_env) do
       quote generated: true do
@@ -30,35 +30,13 @@ defmodule Omnibot.Module do
 
   defmacro __using__([]) do
     quote do
-      use Agent
       alias Omnibot.{Irc, Module}
-      import Omnibot.Module
+      import Omnibot.Module.Base
       require Logger
 
-      @behaviour Module
+      @behaviour Module.Base
 
-      def start_link(opts) do
-        cfg = opts[:cfg]
-        Agent.start_link(fn -> {cfg, on_init(cfg)} end, opts ++ [name: __MODULE__])
-      end
-
-      def cfg do
-        Agent.get(__MODULE__, fn {cfg, _} -> cfg end)
-      end
-
-      def state do
-        Agent.get(__MODULE__, fn {_, state} -> state end)
-      end
-
-      def update_state(update, timeout \\ 5000) do
-        Agent.update(
-          __MODULE__,
-          fn {cfg, state} -> {cfg, apply(update, [state])} end,
-          timeout
-        )
-      end
-
-      @impl Module
+      @impl Module.Base
       def on_msg(irc, msg) do
         # TODO - instead of using a router for modules, consider using a PubSub with a Registry:
         # https://hexdocs.pm/elixir/master/Registry.html#module-using-as-a-pubsub
@@ -97,11 +75,11 @@ defmodule Omnibot.Module do
         end
       end
 
-      defoverridable Module
+      defoverridable Module.Base
 
       @commands MapSet.new()
       @default_config []
-      @before_compile Omnibot.Module.Hooks
+      @before_compile Omnibot.Module.Base.Hooks
     end
   end
 
@@ -123,7 +101,7 @@ defmodule Omnibot.Module do
   defmacro command(cmd, opts) do
     quote generated: true do
       @commands MapSet.put(@commands, unquote(cmd))
-      @impl Omnibot.Module
+      @impl Omnibot.Module.Base
       def on_channel_msg(var!(irc), var!(channel), var!(nick), unquote(cmd), var!(params)) do
         unquote(opts[:do])
       end
@@ -144,7 +122,7 @@ defmodule Omnibot.Module do
 
     quote generated: true do
       @commands MapSet.put(@commands, unquote(cmd))
-      @impl Omnibot.Module
+      @impl Omnibot.Module.Base
       def on_channel_msg(var!(irc), var!(channel), var!(nick), unquote(cmd), unquote(params)) do
         unquote(opts[:do])
       end
diff --git a/lib/module/module.ex b/lib/module/module.ex
new file mode 100644
index 0000000..bb5d6a4
--- /dev/null
+++ b/lib/module/module.ex
@@ -0,0 +1,29 @@
+defmodule Omnibot.Module do
+  defmacro __using__([]) do
+    quote do
+      use Omnibot.Module.Base
+      use Agent
+
+      def start_link(opts) do
+        cfg = opts[:cfg]
+        Agent.start_link(fn -> {cfg, on_init(cfg)} end, opts ++ [name: __MODULE__])
+      end
+
+      def cfg do
+        Agent.get(__MODULE__, fn {cfg, _} -> cfg end)
+      end
+
+      def state do
+        Agent.get(__MODULE__, fn {_, state} -> state end)
+      end
+
+      def update_state(update, timeout \\ 5000) do
+        Agent.update(
+          __MODULE__,
+          fn {cfg, state} -> {cfg, apply(update, [state])} end,
+          timeout
+        )
+      end
+    end
+  end
+end