easy_flow 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ff52593be51a666b42de7e2b05f7fea31de7b09240a21884d341ee0d7bfc1d2
-  data.tar.gz: cb2902b162132cdbfa5060b64acc49835fdbfaeacffc83665a8d2ab74a5de722
+  metadata.gz: 047aff1880613e32482420c7b478d5000d0c719ba1aa71c16f417b7d452fc439
+  data.tar.gz: 0e844849204cd09a8cf19eb589135aff9baa01feb95f5d9df35b30e74b1852e4
 SHA512:
-  metadata.gz: 10a1e356dfcddc779ffc9f0ada50195c03a676ff2717ed64f0e6bbbbab1df3e834e6f7be22758a0de79c7ee6e490fe471c1654d4f4af97f1172a9bed69f2749b
-  data.tar.gz: 4cb65c539b7a12d104e0c12db6cb304267ef966b892ba3cdfe920e0e4e50d703936189ad685a2412761e5f4c4e9bed292048723c8c1c84e9ff43408a83eb193b
+  metadata.gz: 1ff1a5d9237fa30f12bf00c0bad7b1d79be71908a2f798b7e90c82c40f3dd95c8c49791619535b8f4db6540721ed91649a11d4370f32f5b5e3ba50d3560f769b
+  data.tar.gz: 69e16473303ea08c45ed0027cf9a07a2b75d027d4955e88703fe10d17998ebdfd9477949e4f53b09f42bf78feb41249fcf70ff79151a30faa698845631770cce

data/app/controllers/concerns/easy_flow/hosted.rb

@@ -0,0 +1,21 @@
+module EasyFlow
+  module Hosted
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :named_flow_host, instance_accessor: false
+    end
+
+    class_methods do
+      def hosted_by(name)
+        self.named_flow_host = name.to_s
+      end
+    end
+
+    private
+
+    def flow_host
+      @flow_host ||= EasyFlow.host_named(self.class.named_flow_host || request.path_parameters[:easy_flow_host])
+    end
+  end
+end

data/app/controllers/concerns/easy_flow/manage/authenticates_admin.rb

@@ -10,9 +10,9 @@ module EasyFlow
       private
 
       def authenticate_admin
-        return unless EasyFlow.admin_authentication_method
+        return unless flow_host.admin_authentication_method
 
-        send(EasyFlow.admin_authentication_method)
+        send(flow_host.admin_authentication_method)
       end
     end
   end

data/app/controllers/easy_flow/application_controller.rb

@@ -1,16 +1,24 @@
 module EasyFlow
   class ApplicationController < EasyFlow.base_controller.constantize
-    layout -> { EasyFlow.layout }
+    include Hosted
+
+    layout -> { flow_host.layout }
     helper KeystoneUiHelper
 
     rescue_from NotPublished, NotPermitted, Withdrawn, with: :refuse
 
-    helper_method :flow_start_path
+    helper_method :flow_start_path, :flow_routes
 
     private
 
+    def flow_routes
+      return easy_flow unless request.routes.equal?(EasyFlow::Engine.routes)
+
+      @flow_routes ||= ActionDispatch::Routing::RoutesProxy.new(_routes, self, _routes.url_helpers)
+    end
+
     def flow_start_path(slug)
-      easy_flow.flow_path(slug)
+      flow_routes.flow_path(slug)
     end
 
     def admit(flow)
@@ -18,15 +26,15 @@ module EasyFlow
     end
 
     def permitted?(flow)
-      return false unless EasyFlow.visitor_authorization_method
+      return false unless flow_host.visitor_authorization_method
 
-      send(EasyFlow.visitor_authorization_method, flow)
+      send(flow_host.visitor_authorization_method, flow)
     end
 
     def refuse(refusal)
-      return head :not_found unless EasyFlow.refusal_method
+      return head :not_found unless flow_host.refusal_method
 
-      send(EasyFlow.refusal_method, refusal)
+      send(flow_host.refusal_method, refusal)
     end
   end
 end

data/app/controllers/easy_flow/flows_controller.rb

@@ -34,7 +34,7 @@ module EasyFlow
     end
 
     def run_location(run)
-      easy_flow.run_path(run)
+      flow_routes.run_path(run)
     end
 
     def start_run(flow)
@@ -42,11 +42,11 @@ module EasyFlow
     end
 
     def flow_start_path(slug)
-      easy_flow.flow_path(slug)
+      flow_routes.flow_path(slug)
     end
 
     def flow_step_path(slug)
-      easy_flow.flow_step_path(slug)
+      flow_routes.flow_step_path(slug)
     end
 
     def previewing?
@@ -89,13 +89,13 @@ module EasyFlow
     end
 
     def admitted_run
-      found = Run.find(params[:id])
+      found = Run.where(flow: flow_host.flows).find(params[:id])
 
       Admission.of_run(found, permitted: permitted?(found.flow))
     end
 
     def flow
-      @stored_flow ||= admit(Definition.find_by(slug: params[:slug]))
+      @stored_flow ||= admit(flow_host.flows.find_by(slug: params[:slug]))
     end
 
     def flowing_definition(flow)

data/app/controllers/easy_flow/manage/base_controller.rb

@@ -3,12 +3,22 @@ require "keystone_ui/react/mount_helper"
 module EasyFlow
   module Manage
     class BaseController < EasyFlow.base_controller.constantize
+      include Hosted
+
+      before_action :refuse_a_host_not_set_up
+
       include AuthenticatesAdmin
 
-      layout -> { EasyFlow.admin_layout }
+      layout -> { flow_host.admin_layout }
 
       helper KeystoneUiHelper
       helper KeystoneUi::React::MountHelper
+
+      private
+
+      def refuse_a_host_not_set_up
+        head :not_found unless flow_host.set_up?
+      end
     end
   end
 end

data/app/controllers/easy_flow/manage/canvas_controller.rb

@@ -83,7 +83,7 @@ module EasyFlow
       end
 
       def flow
-        @flow ||= Definition.find(params[:flow_id])
+        @flow ||= flow_host.flows.find(params[:flow_id])
       end
 
       def document

data/app/controllers/easy_flow/manage/definitions_controller.rb

@@ -2,11 +2,11 @@ module EasyFlow
   module Manage
     class DefinitionsController < BaseController
       def edit
-        @flow = Definition.find(params[:flow_id])
+        @flow = flow_host.flows.find(params[:flow_id])
       end
 
       def update
-        @flow = Definition.find(params[:flow_id])
+        @flow = flow_host.flows.find(params[:flow_id])
         @flow.edit_history.edit_document(JSON.parse(params.require(:definition)))
         redirect_to manage_flow_path(@flow), notice: "Definition saved."
       end

data/app/controllers/easy_flow/manage/flows_controller.rb

@@ -7,7 +7,7 @@ module EasyFlow
       end
 
       def create
-        @flow = Definition.new(create_params)
+        @flow = flow_host.flows.new(create_params)
 
         if @flow.save
           redirect_to manage_flow_path(@flow), notice: "Flow created."
@@ -18,29 +18,29 @@ module EasyFlow
       end
 
       def show
-        @flow = Definition.find(params[:id])
+        @flow = flow_host.flows.find(params[:id])
         @canvas = canvas_payload(@flow)
       end
 
       def edit
-        @flow = Definition.find(params[:id])
+        @flow = flow_host.flows.find(params[:id])
       end
 
       def update
-        @flow = Definition.find(params[:id])
+        @flow = flow_host.flows.find(params[:id])
         @flow.update!(flow_params)
         redirect_to manage_flow_path(@flow), notice: "Saved."
       end
 
       def destroy
-        Definition.find(params[:id]).destroy!
+        flow_host.flows.find(params[:id]).destroy!
         redirect_to manage_flows_path, notice: "Flow removed."
       end
 
       private
 
       def ordered_flows
-        Definition.order(:slug)
+        flow_host.flows.order(:slug)
       end
 
       def create_params

data/app/controllers/easy_flow/manage/previews_controller.rb

@@ -11,11 +11,11 @@ module EasyFlow
       private
 
       def flow_start_path(_slug)
-        easy_flow.manage_flow_preview_path(previewed)
+        manage_flow_preview_path(previewed)
       end
 
       def flow_step_path(_slug)
-        easy_flow.step_manage_flow_preview_path(previewed)
+        step_manage_flow_preview_path(previewed)
       end
 
       def previewing?
@@ -27,7 +27,7 @@ module EasyFlow
       end
 
       def previewed
-        @previewed ||= Definition.find(params[:flow_id])
+        @previewed ||= flow_host.flows.find(params[:flow_id])
       end
 
       def admit(_flow)

data/app/controllers/easy_flow/manage/versions_controller.rb

@@ -15,7 +15,7 @@ module EasyFlow
       private
 
       def flow
-        @flow ||= Definition.find(params[:flow_id])
+        @flow ||= flow_host.flows.find(params[:flow_id])
       end
     end
   end

data/app/models/easy_flow/definition.rb

@@ -6,7 +6,7 @@ module EasyFlow
     enum :kind, { scored: "scored", guide: "guide" }
     enum :persists, { unsaved: "unsaved", each_step: "each_step", on_finish: "on_finish" }
 
-    validates :slug, presence: true
+    validates :host, :slug, presence: true
 
     after_initialize :begin_the_flow, if: :new_record?
 
@@ -17,8 +17,8 @@ module EasyFlow
     has_many :runs, class_name: "EasyFlow::Run", foreign_key: :flow_id, dependent: :destroy
     has_many :definition_versions, class_name: "EasyFlow::Version", foreign_key: :flow_id, dependent: :destroy
 
-    def self.upsert_definition(definition)
-      find_or_initialize_by(slug: definition["slug"]).tap do |flow|
+    def self.upsert_definition(definition, host:)
+      find_or_initialize_by(host: host, slug: definition["slug"]).tap do |flow|
         flow.save!
         flow.record_definition(definition) unless flow.definition == definition
       end

data/app/views/easy_flow/flows/show.html.erb

@@ -6,7 +6,7 @@
   <%= ui_section do %>
     <div class="flex flex-wrap items-center gap-3">
       <% if @flow.each_step? && @flow.definition.present? && !previewing? %>
-        <%= ui_form(action: easy_flow.flow_runs_path(@flow.slug), method: :post) do %>
+        <%= ui_form(action: flow_routes.flow_runs_path(@flow.slug), method: :post) do %>
           <%= ui_button(label: @flow.start_label.presence || "Start", type: :submit) %>
         <% end %>
       <% else %>

data/app/views/easy_flow/manage/definitions/edit.html.erb

@@ -1,11 +1,11 @@
 <%= ui_page(max_width: :lg) do %>
   <p class="mb-4">
-    <%= link_to "← Back to the flow", easy_flow.manage_flow_path(@flow), class: "text-sm text-accent-600 hover:text-accent-700" %>
+    <%= link_to "← Back to the flow", manage_flow_path(@flow), class: "text-sm text-accent-600 hover:text-accent-700" %>
   </p>
 
-  <%= ui_form_page(title: "Definition", back_url: easy_flow.manage_flow_path(@flow), subtitle: @flow.slug) %>
+  <%= ui_form_page(title: "Definition", back_url: manage_flow_path(@flow), subtitle: @flow.slug) %>
 
-  <%= ui_form(action: easy_flow.manage_flow_definition_path(@flow), method: :patch) do %>
+  <%= ui_form(action: manage_flow_definition_path(@flow), method: :patch) do %>
     <%= ui_textarea(name: "definition", value: JSON.pretty_generate(@flow.document), rows: 30) %>
 
     <%= ui_button(label: "Save", type: :submit) %>

data/app/views/easy_flow/manage/flows/edit.html.erb

@@ -1,11 +1,11 @@
 <%= ui_page(max_width: :lg) do %>
   <p class="mb-4">
-    <%= link_to "← Back to the flow", easy_flow.manage_flow_path(@flow), class: "text-sm text-accent-600 hover:text-accent-700" %>
+    <%= link_to "← Back to the flow", manage_flow_path(@flow), class: "text-sm text-accent-600 hover:text-accent-700" %>
   </p>
 
-  <%= ui_form_page(title: "Edit details", back_url: easy_flow.manage_flow_path(@flow)) %>
+  <%= ui_form_page(title: "Edit details", back_url: manage_flow_path(@flow)) %>
 
-  <%= ui_form(action: easy_flow.manage_flow_path(@flow), method: :patch) do %>
+  <%= ui_form(action: manage_flow_path(@flow), method: :patch) do %>
     <%= ui_section(title: "How this is introduced") do %>
       <label class="block text-sm font-medium mb-1">Title</label>
       <%= ui_input(name: "flow[title]", value: @flow.title) %>

data/app/views/easy_flow/manage/flows/index.html.erb

@@ -6,9 +6,9 @@
     columns: [ { title: "Title" }, { slug: "Slug" }, { kind: "Kind" }, { status: "Status" } ],
     empty_message: "No flows yet."
   ) do |table| %>
-    <% table.link(:title) { |flow| easy_flow.manage_flow_path(flow) } %>
+    <% table.link(:title) { |flow| manage_flow_path(flow) } %>
     <% table.actions do |flow| %>
-      <%= ui_form(action: easy_flow.manage_flow_path(flow), method: :delete) do %>
+      <%= ui_form(action: manage_flow_path(flow), method: :delete) do %>
         <%= ui_button(label: "Remove", type: :submit, variant: :secondary) %>
       <% end %>
     <% end %>
@@ -19,7 +19,7 @@
       <%= ui_alert(message: @flow.errors.full_messages.to_sentence, type: :error) %>
     <% end %>
 
-    <%= ui_form(action: easy_flow.manage_flows_path, method: :post) do %>
+    <%= ui_form(action: manage_flows_path, method: :post) do %>
       <label class="block text-sm font-medium mb-1">Slug</label>
       <%= ui_input(name: "flow[slug]", placeholder: "e.g. business-scorecard") %>
 

data/app/views/easy_flow/manage/flows/show.html.erb

@@ -14,13 +14,13 @@
               onclick="document.dispatchEvent(new CustomEvent('easy_flow:open-flow'))"
               class="inline-flex items-center justify-center font-semibold rounded-lg border-0 cursor-pointer bg-accent-600 text-white hover:bg-accent-700 text-base px-4 py-2">This flow</button>
 
-      <%= ui_button(label: "Try it", href: easy_flow.manage_flow_preview_path(@flow), variant: :secondary) %>
+      <%= ui_button(label: "Try it", href: manage_flow_preview_path(@flow), variant: :secondary) %>
 
-      <%= ui_button(label: "All flows", href: easy_flow.manage_flows_path, variant: :secondary) %>
+      <%= ui_button(label: "All flows", href: manage_flows_path, variant: :secondary) %>
     </div>
   </header>
 
-  <%= react_ui("easy_flow/flow-editor", { base: easy_flow.manage_flow_canvas_path(@flow), token: form_authenticity_token, initial: @canvas },
+  <%= react_ui("easy_flow/flow-editor", { base: manage_flow_canvas_path(@flow), token: form_authenticity_token, initial: @canvas },
                class: "min-h-0 flex-1",
                data: { flow_canvas: true }) %>
 </div>

data/app/views/easy_flow/manage/versions/index.html.erb

@@ -1,6 +1,6 @@
 <%= ui_page(max_width: :lg) do %>
   <p class="mb-4">
-    <%= link_to "← Back to the flow", easy_flow.manage_flow_path(@flow), class: "text-sm text-accent-600 hover:text-accent-700" %>
+    <%= link_to "← Back to the flow", manage_flow_path(@flow), class: "text-sm text-accent-600 hover:text-accent-700" %>
   </p>
 
   <%= ui_page_header(title: "History", subtitle: @flow.title.presence || @flow.slug) %>
@@ -30,7 +30,7 @@
 
           <% unless version == @versions.first %>
             <%= button_to "Return the flow to this version",
-                  easy_flow.return_manage_flow_version_path(@flow, version),
+                  return_manage_flow_version_path(@flow, version),
                   form: { data: { turbo: false } }, data: { return: true },
                   class: "mt-3 inline-flex items-center rounded-lg border border-gray-300 bg-white px-3 py-1.5 text-sm text-gray-900 hover:bg-gray-50 cursor-pointer" %>
           <% end %>

data/db/migrate/20260924130000_add_host_to_easy_flow_definitions.rb

@@ -0,0 +1,9 @@
+class AddHostToEasyFlowDefinitions < ActiveRecord::Migration[8.1]
+  def change
+    add_column :easy_flow_definitions, :host, :string, null: false, default: ""
+    change_column_default :easy_flow_definitions, :host, from: "", to: nil
+
+    remove_index :easy_flow_definitions, :slug, unique: true
+    add_index :easy_flow_definitions, [ :host, :slug ], unique: true
+  end
+end

data/lib/easy_flow/host.rb

@@ -0,0 +1,27 @@
+module EasyFlow
+  class Host
+    attr_reader :name
+    attr_writer :layout, :admin_layout
+    attr_accessor :admin_authentication_method, :visitor_authorization_method, :refusal_method
+
+    def initialize(name)
+      @name = name.to_s
+    end
+
+    def layout
+      @layout || "easy_flow/application"
+    end
+
+    def admin_layout
+      @admin_layout || "application"
+    end
+
+    def flows
+      Definition.where(host: name)
+    end
+
+    def set_up?
+      true
+    end
+  end
+end

data/lib/easy_flow/unset_host.rb

@@ -0,0 +1,15 @@
+module EasyFlow
+  class UnsetHost < Host
+    def initialize
+      super(nil)
+    end
+
+    def flows
+      Definition.none
+    end
+
+    def set_up?
+      false
+    end
+  end
+end

data/lib/easy_flow/version.rb

@@ -1,3 +1,3 @@
 module EasyFlow
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/easy_flow.rb

@@ -1,5 +1,7 @@
 require "json"
 require "easy_flow/version"
+require "easy_flow/host"
+require "easy_flow/unset_host"
 require "easy_flow/engine"
 
 module EasyFlow
@@ -21,19 +23,24 @@ module EasyFlow
   DRAWING = "easy_flow/steps/choosing".freeze
 
   class << self
-    attr_writer :layout, :base_controller, :admin_layout
-    attr_accessor :visitor_authorization_method, :refusal_method, :admin_authentication_method
-
-    def layout
-      @layout || "easy_flow/application"
-    end
+    attr_writer :base_controller
 
     def base_controller
       @base_controller || "ActionController::Base"
     end
 
-    def admin_layout
-      @admin_layout || "application"
+    def host(name)
+      raise ArgumentError, "a host needs a name" if name.blank?
+
+      hosts[name.to_s] = Host.new(name).tap { |host| yield host if block_given? }
+    end
+
+    def hosts
+      @hosts ||= {}
+    end
+
+    def host_named(name)
+      hosts.fetch(name.to_s) { UnsetHost.new }
     end
 
     def draws_with(template)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_flow
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - tylercschneider
@@ -50,6 +50,7 @@ files:
 - README.md
 - Rakefile
 - app/assets/builds/easy_flow/canvas.js
+- app/controllers/concerns/easy_flow/hosted.rb
 - app/controllers/concerns/easy_flow/manage/authenticates_admin.rb
 - app/controllers/concerns/easy_flow/manage/draws_canvas.rb
 - app/controllers/easy_flow/application_controller.rb
@@ -131,8 +132,11 @@ files:
 - db/migrate/20260924120000_create_easy_flow_definitions.rb
 - db/migrate/20260924120100_create_easy_flow_versions.rb
 - db/migrate/20260924120200_create_easy_flow_runs.rb
+- db/migrate/20260924130000_add_host_to_easy_flow_definitions.rb
 - lib/easy_flow.rb
 - lib/easy_flow/engine.rb
+- lib/easy_flow/host.rb
+- lib/easy_flow/unset_host.rb
 - lib/easy_flow/version.rb
 homepage: https://github.com/DYB-Development/easy_flow
 licenses: