workflowable 1.0

data/app/models/workflowable/stage_action.rb

@@ -0,0 +1,24 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+module Workflowable
+  class StageAction < ActiveRecord::Base
+    belongs_to :stage
+    belongs_to :action
+
+    delegate :position, to: :action
+
+  end
+end

data/app/models/workflowable/stage_next_step.rb

@@ -0,0 +1,21 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+module Workflowable
+  class StageNextStep < ActiveRecord::Base
+    belongs_to :current_stage, :class_name=>'Stage'
+    belongs_to :next_stage, :class_name=>'Stage'
+  end
+end

data/app/models/workflowable/workflow.rb

@@ -0,0 +1,57 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+module Workflowable
+    class Workflow < ActiveRecord::Base
+        has_many :stages, :inverse_of=>:workflow
+        belongs_to :initial_stage, :class_name=>Stage
+        has_many :workflow_actions, -> { order("position ASC") }
+        has_many :actions, :through=>:workflow_actions
+        accepts_nested_attributes_for :stages, :allow_destroy => true
+        accepts_nested_attributes_for :actions, :allow_destroy => true
+
+
+
+        validates :name, :presence=>true
+        validates :name, :uniqueness=>true
+
+
+
+        def run_workflow_actions(options={}, object, current_stage, next_stage, user)
+            actions.each do |action|
+                action.run(options.try(:[],action.name), self, object, current_stage, next_stage, user)
+            end
+        end
+
+        def workflow_action_options(options={}, object, current_stage, next_stage, user)
+            options ||= {}
+            workflow_action_options = {}
+            actions.each do |action|
+                workflow_action_options[action.name] = action.available_options(options.try(:[],action.name) || {}, self, object, current_stage, next_stage, user)
+            end
+            workflow_action_options
+        end
+
+        def validate_action_options(options={}, object, current_stage, next_stage, user)
+            options ||= {}
+            action_errors = {}
+            actions.each do |action|
+                errors = action.validate_options(options[action.name] || {}, self, object, current_stage, next_stage, user)
+                action_errors[action.name] = errors if errors.present?
+            end
+            action_errors
+        end
+    end
+end

data/app/models/workflowable/workflow_action.rb

@@ -0,0 +1,23 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+module Workflowable
+  class WorkflowAction < ActiveRecord::Base
+    belongs_to :workflow
+    belongs_to :action
+
+
+  end
+end

data/app/views/layouts/workflowable/application.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Workflowable</title>
+    <%= stylesheet_link_tag    "workflowable/application", media: "all" %>
+    <%= javascript_include_tag "workflowable/application" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <nav class="top-bar hide-for-small" data-topbar="">
+      <ul class="title-area">
+        <li class="name">
+          <h1><%= link_to "Workflowable", workflows_path %></h1>
+        </li>
+      </ul>
+    </nav>
+    <div class="row">
+      <div class="large-12 columns">
+        <%= yield %>
+      </div>
+    </div>
+  </body>
+</html>

data/app/views/shared/actions/_details.html.erb

@@ -0,0 +1,30 @@
+<% if actions.count == 0 %>
+  <b>No actions defined</b>
+<% else %>
+  <% actions.each do |action| %>
+    <h6><b><%= action.name %></b>
+      (<%= action.action_plugin %>)</h6>
+    <table>
+      <thead>
+        <tr>
+          <th>Option</th>
+          <th>Value Specified</th>
+          <th>Default Value</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% if action.options.present? %>
+          <% action.options.each do |k,v| %>
+            <tr>
+              <td><%= k %></td>
+              <td><%= v.try(:[],:value) %></td>
+              <td><%= v.try(:[],:default) %></td>
+            </tr>
+          <% end %>
+        <% else %>
+          <tr ><td colspan="3">No options defined</td></tr>
+        <% end %>
+      </tbody>
+    </table>
+  <% end %>
+<% end %>

data/app/views/shared/actions/_fields.html.erb

@@ -0,0 +1,26 @@
+<%= f.fields_for association do |action_form| %>
+  <fieldset>
+    <legend><%= label.humanize %>
+      details -
+      <%= action_form.link_to_remove "Remove" %></legend>
+    <div class="field">
+      <%= action_form.label :action_name %>
+      <%= action_form.text_field :name %>
+      <%= action_form.label :position %>
+      <%= action_form.text_field :position %>
+    </div>
+    <div class="field">
+      <%= action_form.label :action %>
+      <%= action_form.collection_select :action_plugin, Workflowable::Actions.constants, :to_s, :to_s, {include_blank: true},  {class: "action_plugin_select"} %>
+    </div>
+    <div class="action_options_fields" data-url="<%= options_actions_url %>" data-context="<%= action_form.object_name %>">
+      <% available_options = action_form.object.available_options(action_form.object.options) %>
+      <% if available_options %>
+        <%= render :partial=>"workflowable/actions/options", :locals => {:options=>available_options , context: action_form.object_name } %>
+      <% end %>
+    </div>
+    <br/>
+  </fieldset>
+  <br/>
+<% end %>
+<p><%= f.link_to_add "Add #{label}", association %></p>

data/app/views/workflowable/actions/_options.html.erb

@@ -0,0 +1,39 @@
+<%= fields_for "#{context}[options]", OpenStruct.new({}) do |options_form| %>
+  <% options.each do |key, value| %>
+    <div class="field">
+      <div class="row">
+        <div class="medium-5 columns">
+          <%= label_tag do  %>
+            Specify Value:
+            <%= value.try(:[],:name) || key.to_s %>
+            <%= "(required)" if value[:required] == true %>
+          <% end %>
+          <% if value[:type] == :choice %>
+            <%= options_form.select "#{key}][value", value[:choices].collect{|v| [v[:name],v.to_json]},{ include_blank: true, selected: value[:value].to_json} %>
+          <% elsif value[:type] == :boolean %>
+            <%= options_form.check_box "#{key}][value", :checked=>value[:value] == "1" %>
+          <% else %>
+            <%= options_form.text_field "#{key}][value", :value=>value[:value] %>
+          <% end %>
+        </div>
+        <div class="medium-1 columns">
+          <br/>
+          <b>OR</b>
+        </div>
+        <div class="medium-6 columns">
+          <%= label_tag do  %>
+            Default Value:
+            <%= value.try(:[],:name) || key.to_s %>
+          <% end %>
+          <% if value[:type] == :choice %>
+            <%= options_form.select "#{key}][default", value[:choices].collect{|v| [v[:name],v.to_json]},{ include_blank: true, selected: value[:default].to_json} %>
+          <% elsif value[:type] == :boolean %>
+            <%= options_form.check_box "#{key}][default", :checked=>value[:default] == "1" %>
+          <% else %>
+            <%= options_form.text_field "#{key}][default", :value=>value[:default] %>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  <% end %>
+<% end %>

data/app/views/workflowable/actions/options.js.erb

@@ -0,0 +1,2 @@
+$('.action_options_fields.active').html("<%= escape_javascript(render :partial=>"options", :locals => {:options=>@options, context: params[:context]}) %>");  
+$('.action_options_fields.active').removeClass("active");

data/app/views/workflowable/workflows/_form.html.erb

@@ -0,0 +1,57 @@
+<%= nested_form_for(@workflow) do |f| %>
+  <% if @workflow.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@workflow.errors.count, "error") %>
+        prohibited this workflow from being saved:</h2>
+      <ul>
+        <% @workflow.errors.full_messages.each do |msg| %>
+          <li><%= msg %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+  <div data-magellan-expedition="fixed">
+    <dl class="sub-nav">
+      <dd data-magellan-arrival="basic"><a href="#basic">Basic Details</a></dd>
+      <dd data-magellan-arrival="global_actions"><a href="#global_actions">Global Actions</a></dd>
+      <dd data-magellan-arrival="stages"><a href="#stages">Stages</a></dd>
+    </dl>
+  </div>
+  <a name="basic"></a>
+  <fieldset>
+    <legend data-magellan-destination="basic">Basic Details</legend>
+    <div class="field">
+      <%= f.label :name %>
+      <%= f.text_field :name %>
+    </div>
+  </fieldset>
+  <hr/>
+  <a name="global_actions"></a>
+  <h4 data-magellan-destination="global_actions">Global Actions<br/><small>These actions will be run every time the stage changes</small></h4>
+  <%= render partial: 'shared/actions/fields', locals: {f: f, label: 'global action', association: :actions} %>
+  <hr/>
+  <a name="stages"></a>
+  <h4 data-magellan-destination="stages">Stages<br/><small>The available states for the workflow</small></h4>
+  <%= f.fields_for :stages do |stage_form| %>
+    <fieldset>
+      <legend>Stage Details -
+        <%= stage_form.link_to_remove "Remove this stage" %></legend>
+      <div class="field">
+        <%= stage_form.label :name %>
+        <%= stage_form.text_field :name %>
+      </div>
+      <hr/>
+      <h5>Before Actions<br/><small>These actions will be run when leaving this stage</small></h5>
+      <%= render partial: 'shared/actions/fields', locals: {f: stage_form, association: :before_actions, label: 'before action'} %>
+      <hr/>
+      <h5>After Actions<br/><small>These actions will run before entering this stage</small></h5>
+      <%= render partial: 'shared/actions/fields', locals: {f: stage_form, association: :after_actions, label: 'after action'} %>
+      <hr/>
+    </fieldset>
+    <br/>
+  <% end %>
+  <br/>
+  <p><%= f.link_to_add "Add a stage", :stages %></p>
+  <%= f.submit class: "button" %>
+  <%= link_to 'Back', workflows_path, class: "button secondary" %>
+<% end %>

data/app/views/workflowable/workflows/configure_stages.html.erb

@@ -0,0 +1,34 @@
+<%= nested_form_for(@workflow) do |f| %>
+  <% if @workflow.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@workflow.errors.count, "error") %>
+        prohibited this workflow from being saved:</h2>
+      <ul>
+        <% @workflow.errors.full_messages.each do |msg| %>
+          <li><%= msg %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+  <h2>Workflow Options</h2>
+  <div class="field">
+    <%= f.label :initial_stage %>
+    <%= f.collection_select :initial_stage_id, @workflow.stages, :id, :name, include_blank: true %>
+  </div>
+  <h2>Stage Transitions</h2>
+  <%= f.fields_for :stages do |stage_form| %>
+    <div class="field">
+      <h3><%= stage_form.object.name %></h3>
+      <%= stage_form.fields_for :stage_next_steps do |next_steps_form| %>
+        <div class="field">
+          <%= next_steps_form.label :next_step %>
+          <%= next_steps_form.collection_select :next_stage_id, @workflow.stages, :id, :name, include_blank: true %>
+        </div>
+        <%= next_steps_form.link_to_remove "Remove this step" %>
+      <% end %>
+      <p><%= stage_form.link_to_add "Add a next step", :stage_next_steps %></p>
+    </div>
+  <% end %>
+  <%= f.submit class: "button" %>
+  <%= link_to 'Back', workflows_path, class: "button secondary" %>
+<% end %>

data/app/views/workflowable/workflows/edit.html.erb

@@ -0,0 +1,2 @@
+<h1>Edit workflow</h1>
+<%= render 'form' %>

data/app/views/workflowable/workflows/index.html.erb

@@ -0,0 +1,16 @@
+<table>
+  <tr>
+    <th>Name</th>
+    <th></th>
+  </tr>
+  <% @workflows.each do |workflow| %>
+    <tr>
+      <td><%= link_to workflow.name, workflow %></td>
+      <td>
+        <%= link_to 'Edit', edit_workflow_path(workflow), class: "button tiny" %>
+        <%= link_to 'Destroy', workflow, method: :delete, data: { confirm: 'Are you sure?' }, class: "button tiny alert" %></td>
+    </tr>
+  <% end %>
+</table>
+<br />
+<%= link_to 'New Workflow', new_workflow_path, class: "button" %>

data/app/views/workflowable/workflows/new.html.erb

@@ -0,0 +1,2 @@
+<h1>New workflow</h1>
+<%= render 'form' %>

data/app/views/workflowable/workflows/show.html.erb

@@ -0,0 +1,49 @@
+<h1>Workflow:
+  <%= @workflow.name %></h1>
+<h5>Global Actions</h5>
+<dl class="accordion" data-accordion>
+  <dd>
+    <a href="<%= "#workflow_#{@workflow.id}_actions" %>">Actions (<%= @workflow.actions.count %>)</a>
+    <div id="<%= "workflow_#{@workflow.id}_actions" %>" class="content">
+      <%= render partial: 'shared/actions/details', locals: {actions: @workflow.actions, uuid: "workflow_#{@workflow.id}_actions"} %>
+    </div>
+  </dd>
+</dl>
+<% @workflow.stages.each do |stage| %>
+  <dl class="accordion" data-accordion>
+    <dd>
+      <a href="#<%= "stage_#{stage.id}" %>"><%= stage.name %></a>
+      <div id="<%= "stage_#{stage.id}" %>" class="content">
+        <dl class="tabs" data-tab>
+          <dd class="active"><a href="<%= "#stage_#{stage.id}_before" %>">Before Actions (<%= stage.before_actions.count %>)</a></dd>
+          <dd><a href="<%= "#stage_#{stage.id}_after" %>">After Actions (<%= stage.after_actions.count %>)</a></dd>
+          <dd><a href="<%= "#stage_#{stage.id}_next_steps" %>">Next Steps (<%= stage.next_steps.count %>)</a></dd>
+        </dl>
+        <div class="tabs-content">
+          <div id="<%= "stage_#{stage.id}_before" %>" class="content active">
+            <%= render partial: 'shared/actions/details', locals: {actions: stage.before_actions, uuid: "stage_#{stage.id}_before"} %>
+          </div>
+          <div id="<%= "stage_#{stage.id}_after" %>" class="content">
+            <%= render partial: 'shared/actions/details', locals: {actions: stage.after_actions, uuid: "stage_#{stage.id}_after"} %>
+          </div>
+          <div id="<%= "stage_#{stage.id}_next_steps" %>" class="content">
+            <% if stage.next_steps.count == 0 %>
+              <b>No next steps defined</b>
+            <% else %>
+              <% stage.next_steps.each do |step| %>
+                <%= step.name %><br/>
+              <% end %>
+            <% end %>
+          </div>
+        </div>
+      </div>
+    </dd>
+  </dl>
+<% end %>
+<br/>
+<%= link_to "Edit", edit_workflow_path(@workflow), class:"button" %>
+<%= link_to "Configure Stages", configure_stages_workflow_path(@workflow), class:"button" %>
+<%= link_to "Back", workflows_path , class:"button secondary"%>
+<%= content_tag :svg, class: "workflow_diagram", data: {url: stages_workflow_url(@workflow, format: :json)} do %>
+  <g transform="translate(20, 20)" />
+<% end %>

data/app/views/workflowable/workflows/stages.json.jbuilder

@@ -0,0 +1,8 @@
+json.nodes @workflow.stages, :id, :name
+
+
+
+next_steps=[]
+@workflow.stages.each{|s| next_steps += s.stage_next_steps}
+
+json.edges next_steps, :current_stage_id, :next_stage_id

data/config/routes.rb

@@ -0,0 +1,34 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+Workflowable::Engine.routes.draw do
+  resources :workflows do
+    member do
+      get 'stages'
+      get 'configure_stages'
+      post 'update_stages'
+    end
+  end
+
+  resources :actions, only: [] do
+    collection do
+      get 'options'
+    end
+  end
+
+  root to: "workflows#index"
+
+
+end