feat: poc polymorphism for journey

Author: dennyabrain

lib/block.ex

@@ -0,0 +1,9 @@
+defprotocol BlockFunction do
+  def init(state)
+  def run(state)
+end
+
+defmodule Block do
+  @callback init(state :: term) :: {:ok, new_state :: term} | {:error, reason :: String.t()}
+  @callback run(state :: term) :: {:ok, result :: term} | {:error, reason :: String.t()}
+end

lib/conversation.ex

@@ -0,0 +1,29 @@
+defmodule IfBlock do
+  defstruct state: nil, validator: nil
+  @behaviour Block
+
+  def new(arg) do
+    %IfBlock{state: arg}
+  end
+
+  def init(state) do
+    {:ok, state}
+  end
+
+  def run(state) do
+    IO.puts("if block")
+    IO.inspect(state)
+    {:ok, state}
+  end
+
+  defimpl BlockFunction do
+    def init(state) do
+      IO.puts("initing")
+    end
+
+    def run(state) do
+      IO.puts("state")
+      IO.inspect(state)
+    end
+  end
+end

lib/if_block.ex

@@ -0,0 +1,26 @@
+defmodule Journey do
+  @moduledoc """
+  vertices are just atoms
+    how are they linked to a block(?)
+  edges are links between atoms
+  """
+  defstruct graph: Graph.new()
+
+  def new() do
+    %Journey{}
+  end
+
+  def insert_block() do
+  end
+
+  def insert_block(from, to) do
+  end
+
+  @doc """
+  Returns the block id where the user's conversation is at.
+  """
+  def where_is(user) do
+  end
+
+  defdelegate run(block), to: BlockFunction
+end

lib/journey.ex

@@ -1,6 +1,27 @@
 defmodule Kabootar do
   @moduledoc """
-  Documentation for `Kabootar`.
+  Build human-in-the-loop conversation bot.
+
+  Kabootar helps you model a conversation between users and the system. There are two types of conversations - pre-determined and free-flowing. In a free flowing conversation users and the bot can talk to each other in any order. In a pre-determined conversation who says what at each instant is modelled using a rule based system.
+
+  For a pre-determined conversation, message events occur in a fixed order. The message event is used to determine the next steps in a conversation.
+
+  Define Conversations using easy to configure functions called Blocks.
+
+  Conversation -> Journey -> Blocks
+    Every event in a conversation belongs to a journey
+
+  Conversation is a graph. It stores the state and using the event, you can determine the next node.
+
+  What the human in the loop means is that a user can move the user from one part of the conversation to another, override the output of an automated system without disrupting the user experience for the user.
+
+  ## Usage
+  Journey.create()
+  Journey.add_block()
+  Journey.add_blocks()
+  Conversation.start(user, journey)
+  Conversation.move(user, journey)
+  Journey.run(if_block)
   """
 
   @doc """

lib/kabootar.ex

@@ -0,0 +1,13 @@
+defmodule MessageBlock do
+  @behaviour Block
+
+  def init(state) do
+    {:ok, state}
+  end
+
+  def run(state) do
+    IO.inspect("message block")
+    IO.inspect(state)
+    {:ok, state}
+  end
+end

lib/message_block.ex

@@ -46,7 +46,8 @@ defmodule Kabootar.MixProject do
   defp deps do
     [
       {:ex_doc, "~> 0.34.2", only: :dev, runtime: false},
-      {:versioce, "~> 2.0.0"}
+      {:versioce, "~> 2.0.0"},
+      {:libgraph, "~> 0.16.0"}
     ]
   end
 end

mix.exs

@@ -1,6 +1,7 @@
 %{
   "earmark_parser": {:hex, :earmark_parser, "1.4.41", "ab34711c9dc6212dda44fcd20ecb87ac3f3fce6f0ca2f28d4a00e4154f8cd599", [:mix], [], "hexpm", "a81a04c7e34b6617c2792e291b5a2e57ab316365c2644ddc553bb9ed863ebefa"},
   "ex_doc": {:hex, :ex_doc, "0.34.2", "13eedf3844ccdce25cfd837b99bea9ad92c4e511233199440488d217c92571e8", [:mix], [{:earmark_parser, "~> 1.4.39", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "5ce5f16b41208a50106afed3de6a2ed34f4acfd65715b82a0b84b49d995f95c1"},
+  "libgraph": {:hex, :libgraph, "0.16.0", "3936f3eca6ef826e08880230f806bfea13193e49bf153f93edcf0239d4fd1d07", [:mix], [], "hexpm", "41ca92240e8a4138c30a7e06466acc709b0cbb795c643e9e17174a178982d6bf"},
   "makeup": {:hex, :makeup, "1.1.2", "9ba8837913bdf757787e71c1581c21f9d2455f4dd04cfca785c70bbfff1a76a3", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cce1566b81fbcbd21eca8ffe808f33b221f9eee2cbc7a1706fc3da9ff18e6cac"},
   "makeup_elixir": {:hex, :makeup_elixir, "0.16.2", "627e84b8e8bf22e60a2579dad15067c755531fea049ae26ef1020cad58fe9578", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "41193978704763f6bbe6cc2758b84909e62984c7752b3784bd3c218bb341706b"},
   "makeup_erlang": {:hex, :makeup_erlang, "1.0.1", "c7f58c120b2b5aa5fd80d540a89fdf866ed42f1f3994e4fe189abebeab610839", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "8a89a1eeccc2d798d6ea15496a6e4870b75e014d1af514b1b71fa33134f57814"},