Add examples, mermaid diagram and exit step

[PerezIgnacio]

No description provided.

[santib]

for now I'm ok, but I'd like to have any diagraming code completely decoupled from the main code. Something like Mars::UI::Renderer.new(workflow).to_mermaid. WDYT?

[santib]

I mean decoupled in a way that it could actually live on its own in a different gem, but Mars don't really need to care about the rendering part (now is mermaid, but we could have multiple different renderers)

[PerezIgnacio]

I liked this approach because we could use polymorphism to keep it easy to extend to new objects (each component only needs to know how to render itself), so adding a new component requires just implementing the interface.

That being said, I agree that this is a separate concern and could live in a different layer, possibly different gem, since it's not the core logic and so the objects shouldn't be coupled to it. Let me think of something more aligned to this separation while still keeping the extensibility.

[santib]

I think this is a good example (see how visualize_packs is separate from packs)

I'm not saying to have separate gems (it's not worth it for now) but if we can have clear boundaries from the beginning then that could be helpful.

Regarding the solution maybe we can still benefit from this polymorphic solution without having to couple things, for example doing something like:

module Mars
  class Agent
    # core logic
  end
end

module Mars
  module UI
    module Agent
      def to_mermaid
        "#{sanitized_name}[\"#{name}\"]"
      end
    end
  end
end

# Dynamically inject in `lib/mars.rb`
Mars::Agent.include(Mars::UI::Agent)

In the future we may also allow to configure turning on/off the UI module, or changing it for a different UI module for example?

WDYT?

[PerezIgnacio]

sounds good, I will try something like that.

[santib]

hmmm why only agents can end workflows?

[PerezIgnacio]

The start workflow can end on a gate for example, here it branches out to another component but doesn't end the main flow. However, it ends if the last node is an agent instead. Later on, I think aggregators could also indicate that the flow ended.

[santib]

not sure I'm following. I don't really see the value of this method