Merge pull request #17 from antonmi/remove_broadcaster

Remove Broadcaster. It can be done with a composer

README.md

@@ -279,17 +279,6 @@ defmodule MySwitchModule do
 end
 ```
 
-### broadcaster
-
-Broadcaster an IP to all the stages connected.
-
-```elixir
-[
-  broadcaster(:my_broadcast),
-  stage(:foo, count: 5)
-]
-```
-
 ### Goto
 
 Send packet to a given `goto_point`

TODO.md

@@ -1,3 +1,2 @@
 TODOs:
 - Composer docs
-- Broadcaster docs

lib/components/goto.ex

@@ -51,12 +51,16 @@ defmodule ALF.Components.Goto do
 
   @impl true
   def handle_call({:find_where_to_go, components}, _from, state) do
-    goto_point =
-      components
-      |> Enum.filter(&(&1.name == state.to and &1.__struct__ == GotoPoint))
-      |> Enum.random()
+    state =
+      case Enum.filter(components, &(&1.name == state.to and &1.__struct__ == GotoPoint)) do
+        [] ->
+          state
+
+        goto_points ->
+          goto_point = Enum.random(goto_points)
+          %{state | to_pid: goto_point.pid}
+      end
 
-    state = %{state | to_pid: goto_point.pid}
     {:reply, state, [], state}
   end
 

lib/dsl.ex

@@ -3,7 +3,6 @@ defmodule ALF.DSL do
     Basic,
     Stage,
     Switch,
-    Broadcaster,
     DeadEnd,
     GotoPoint,
     Goto,
@@ -41,19 +40,6 @@ defmodule ALF.DSL do
     end
   end
 
-  defmacro broadcaster(name, options \\ []) do
-    count = options[:count] || 1
-
-    quote do
-      Broadcaster.validate_options(unquote(name), unquote(options))
-
-      broadcaster =
-        Basic.build_component(Broadcaster, unquote(name), unquote(count), %{}, __MODULE__)
-
-      %{broadcaster | count: unquote(count)}
-    end
-  end
-
   defmacro goto(name, options \\ [opts: []]) do
     to = options[:to]
     opts = options[:opts] || []

test/builder_test.exs

@@ -2,7 +2,7 @@ defmodule ALF.BuilderTest do
   use ExUnit.Case, async: true
 
   alias ALF.Builder
-  alias ALF.Components.{Stage, Switch, Broadcaster}
+  alias ALF.Components.{Stage, Switch}
 
   setup do
     sup_pid = Process.whereis(ALF.DynamicSupervisor)
@@ -38,16 +38,6 @@ defmodule ALF.BuilderTest do
     end
   end
 
-  defmodule PipelineWithBroadcaster do
-    def alf_components do
-      [
-        %Broadcaster{name: :broadcaster},
-        %Stage{name: :stage1, count: 2},
-        %Stage{name: :stage2}
-      ]
-    end
-  end
-
   describe "simple pipeline" do
     test "build simple pipeline", %{sup_pid: sup_pid} do
       {:ok, pipeline} = Builder.build(SimplePipeline, sup_pid, :pipeline)
@@ -95,18 +85,6 @@ defmodule ALF.BuilderTest do
     end
   end
 
-  describe "broadcaster" do
-    test "build pipeline with broadcaster", %{sup_pid: sup_pid} do
-      {:ok, pipeline} = Builder.build(PipelineWithBroadcaster, sup_pid, :pipeline)
-
-      [broadcaster, _stage11, _stage12, stage2] = pipeline.components
-
-      assert %Broadcaster{name: :broadcaster, pid: broadcaster_pid} = broadcaster
-      assert is_pid(broadcaster_pid)
-      assert %Stage{name: :stage2} = stage2
-    end
-  end
-
   describe "build_sync" do
     test "build with spec_simple_sync" do
       [producer, stage, consumer] = Builder.build_sync(SimplePipeline, true)
@@ -141,19 +119,5 @@ defmodule ALF.BuilderTest do
 
       assert consumer.subscribed_to == [{stage1.pid, :sync}, {stage2.pid, :sync}]
     end
-
-    test "build with spec_with_broadcaster" do
-      [producer, broadcaster, stage1, stage2, consumer] =
-        Builder.build_sync(PipelineWithBroadcaster, true)
-
-      assert broadcaster.telemetry
-      assert broadcaster.subscribed_to == [{producer.pid, :sync}]
-
-      assert stage1.name == :stage1
-      assert stage1.pid
-      assert stage1.subscribed_to == [{broadcaster.pid, :sync}]
-
-      assert consumer.subscribed_to == [{stage2.pid, :sync}]
-    end
   end
 end

test/dsl/dsl_test.exs

@@ -6,7 +6,6 @@ defmodule ALF.DSLTest do
   alias ALF.Components.{
     Stage,
     Switch,
-    Broadcaster,
     GotoPoint,
     Goto,
     Plug,
@@ -29,7 +28,6 @@ defmodule ALF.DSLTest do
 
     @components [
       goto_point(:goto_point),
-      broadcaster(:broadcaster),
       stage(Mod1, count: 2),
       switch(:cond_function,
         branches: %{
@@ -82,10 +80,9 @@ defmodule ALF.DSLTest do
     test "build PipelineB", %{sup_pid: sup_pid} do
       {:ok, pipeline} = Builder.build(PipelineB, sup_pid, false)
 
-      [goto_point, broadcaster, _stage11, _stage12, switch, goto] = pipeline.components
+      [goto_point, _stage11, _stage12, switch, goto] = pipeline.components
 
       assert %GotoPoint{name: :goto_point} = goto_point
-      assert %Broadcaster{name: :broadcaster} = broadcaster
 
       assert %Switch{
                name: :cond_function,

test/dsl/validations_test.exs

@@ -63,21 +63,6 @@ defmodule ALF.DSL.ValidationsTest do
     end
   end
 
-  describe "Broadcaster" do
-    test "invalid options", %{sup_pid: sup_pid} do
-      assert_raise DSLError,
-                   "Wrong options for the broadcaster broadcaster: [:foo]. " <>
-                     "Available options are [:count]",
-                   fn ->
-                     defmodule BroadcasterWithWrongRequiredOpts do
-                       use ALF.DSL
-
-                       @components [broadcaster(:broadcaster, foo: :bar)]
-                     end
-                   end
-    end
-  end
-
   describe "Goto" do
     test "required options", %{sup_pid: sup_pid} do
       assert_raise DSLError,