taskinator_ui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97f775b342af29cff581b4367d7ddd723a9efac20a7af5ddbbbb465d47b5a99f
+  data.tar.gz: ce586f511c32214c706964b941ad3d0e3d14bb2fd90ab4c164610d90b71c0e00
+SHA512:
+  metadata.gz: 4dc61c2f71155ced014d843addd3eba0c6037778f6d1bc61f16156fa0aa052982c771f9774ffb968735744c9e6052049b2497cf42318537bdfc8c2eb474a2bf2
+  data.tar.gz: a858248ed643e25f74e53e4bda2a34833512c3b79cc9b17e1ad5420d35f46c40f326b3304fe95af2ae4c463412d36f4d76180ebf4b965a4ce3b7981a559b9e6d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Bogdan Guban
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# TaskinatorUi
+Web interface for taskinator gem. It also allows to see the workflows and enqueue 
+a workflow from a specific place.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "taskinator_ui"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install taskinator_ui
+```
+
+Then add this line into `config/routes.rb`
+```ruby
+mount TaskinatorUi::Engine, at: '/taskinator'
+```
+
+Run `rails server` and navigate to `http://localhost:3000/taskinator/`
+
+## Known issues
+
+If you use Rails in API only mode it can happen that you have `Rack::MethodOverride` middleware disabled.
+This middleware needed to route HTML form requests. To fix the problem add this line into `config/application.rb`
+
+```ruby
+config.middleware.use Rack::MethodOverride
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/taskinator_ui_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/taskinator_ui .css

data/app/assets/stylesheets/taskinator_ui/application.scss

@@ -0,0 +1 @@
+@import "bootstrap";

data/app/controllers/taskinator_ui/application_controller.rb

@@ -0,0 +1,4 @@
+module TaskinatorUi
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/taskinator_ui/processes_controller.rb

@@ -0,0 +1,31 @@
+module TaskinatorUi
+  class ProcessesController < ApplicationController
+    layout false, only: [:children]
+
+    def index
+      @processes = Taskinator::Api::Processes.new.each.to_a.sort_by(&:created_at).reverse
+    end
+
+    def show
+      @process = Taskinator::Process.fetch(params[:id])
+    end
+
+    def run
+      uuids = params[:uuids].to_set
+      process = Taskinator::Process.fetch(params[:process_id])
+      PartialRunner.new(process, uuids: uuids).call
+
+      redirect_to action: :show, id: params[:process_id]
+    end
+
+    def children
+      @process = Taskinator::Process.fetch(params[:process_id])
+    end
+
+    def destroy
+      @process = Taskinator::Process.fetch(params[:id])
+      @process.cleanup
+      redirect_to processes_path
+    end
+  end
+end

data/app/decorators/taskinator_ui/process_decorator.rb

@@ -0,0 +1,60 @@
+module TaskinatorUi
+  class ProcessDecorator < SimpleDelegator
+    STATUS_COLORS = {
+      initial: 'primary',
+      enqueued: 'primary',
+      processing: 'info',
+      paused: 'warning',
+      resumed: 'warning',
+      completed: 'success',
+      cancelled: 'warning',
+      failed: 'danger',
+    }
+
+    def initialize(obj)
+      obj = obj.__getobj__ if obj.is_a?(Delegator)
+      obj = obj.sub_process if obj.is_a?(Taskinator::Task::SubProcess)
+
+      super(obj.is_a?(Delegator) ? obj.__getobj__ : obj)
+    end
+
+    def title
+      case __getobj__
+      when Taskinator::Task::Step
+        "Task <b>#{method}</b>"
+      when Taskinator::Task::Job
+        "Job <b>#{job}</b>"
+      when Taskinator::Process
+        "#{__getobj__.class.name.split('::').last}"
+      else
+        __getobj__.inspect
+      end.html_safe
+    end
+
+    def html_uuid
+      uuid.gsub(':', '').html_safe
+    end
+
+    def pending_tasks
+      @pending_tasks ||= Taskinator.redis do |conn|
+        conn.get("#{key}.pending")
+      end
+    end
+
+    def status_badge
+      "<span class=\"badge bg-#{STATUS_COLORS[current_state]}\">#{current_state}</span>".html_safe
+    end
+
+    def class_name
+      __getobj__.class.name
+    end
+
+    def method
+      __getobj__.is_a?(Taskinator::Task::Step) ? __getobj__.method : nil
+    end
+
+    def job
+      __getobj__.is_a?(Taskinator::Task::Job) ? __getobj__.job : nil
+    end
+  end
+end

data/app/helpers/taskinator_ui/application_helper.rb

@@ -0,0 +1,4 @@
+module TaskinatorUi
+  module ApplicationHelper
+  end
+end

data/app/helpers/taskinator_ui/processes_helper.rb

@@ -0,0 +1,5 @@
+module TaskinatorUi
+  module ProcessesHelper
+
+  end
+end

data/app/jobs/taskinator_ui/application_job.rb

@@ -0,0 +1,4 @@
+module TaskinatorUi
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/taskinator_ui/application_mailer.rb

@@ -0,0 +1,6 @@
+module TaskinatorUi
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/taskinator_ui/application_record.rb

@@ -0,0 +1,5 @@
+module TaskinatorUi
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/services/taskinator_ui/partial_runner.rb

@@ -0,0 +1,61 @@
+module TaskinatorUi
+  class PartialRunner
+    class ProcessWrapper < SimpleDelegator
+      def initialize(obj)
+        obj = obj.__getobj__ if obj.is_a?(Delegator)
+        super(obj)
+      end
+
+      def children
+        case __getobj__
+        when Taskinator::Task::Step, Taskinator::Task::Job
+          []
+        when Taskinator::Task::SubProcess
+          [self.class.new(sub_process)]
+        else
+          tasks.map { |task| self.class.new(task) }
+        end
+      end
+
+      def sequential?
+        __getobj__.is_a?(Taskinator::Process::Sequential)
+      end
+    end
+
+    def initialize(process, uuids:)
+      @process = ProcessWrapper.new(process)
+      @uuids = uuids
+      @queue = []
+    end
+
+    def call
+      traverse(@process)
+      @queue.each(&:enqueue!)
+    end
+
+    private
+
+    def traverse(process)
+      found = @uuids.include?(process.uuid) # process found
+
+      if found
+        @queue << process if found # exactly this process must be enqueued
+        return true
+      else
+        # check children if the needed process is there
+        process.children.each do |child|
+          if traverse(child)
+            process.current_state = :processing unless found
+            found = true
+            return true if process.sequential?
+          else
+            process.deincr_pending_tasks
+            child.current_state = :completed
+          end
+        end
+      end
+
+      found
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Taskinator ui</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65" crossorigin="anonymous">
+  <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-kenU1KFdBIe4zVF0s0G1M5b4hcpxyD9F7jL+jjXkk+Q2h455rYXK/7HAuoJl+0I4" crossorigin="anonymous"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
+  <script>
+    window.loadedProcessChildren ||= {}
+    function loadProcessChildren(uuid, indent) {
+      if(!window.loadedProcessChildren[uuid]){
+        window.loadedProcessChildren[uuid] = true
+        $('#children'+uuid.replaceAll(':', '')).load('<%= processes_path %>/' + uuid + '/children?indent=' + indent)
+      }
+    }
+    function selectGroup(uuid, indent) {
+      let checked = $('#select-group'+uuid)[0].checked;
+      $('#group'+uuid+' input.js-indent-' + (indent + 2)).each(function(i, el){
+        el.checked = checked
+      })
+    }
+  </script>
+</head>
+<body>
+
+<nav class="navbar bg-light mb-3">
+  <div class="container">
+    <a class="navbar-brand" href="<%= root_path %>">TaskinatorUI</a>
+  </div>
+</nav>
+
+<div class="container">
+  <%= yield %>
+</div>
+</body>
+</html>

data/app/views/taskinator_ui/processes/_process_children.html.erb

@@ -0,0 +1,44 @@
+<% if depth > 0 && process.is_a?(Taskinator::Process) %>
+  <% if process.is_a?(Taskinator::Process::Concurrent) %>
+    <% groups = process.tasks.each.to_a.map { |task| TaskinatorUi::ProcessDecorator.new(task) }.group_by { |task| [task.class_name, task.method, task.job] }.values %>
+    <% groups.each do |group| %>
+      <% if group.size > 1 %>
+        <li class="list-group-item">
+          <div style="margin-left: <%= (indent + 1) * 10 %>px">
+            <div class="row">
+              <div class="col">
+                <button class="btn btn-outline-secondary btn-sm" type="button" data-bs-toggle="collapse" data-bs-target="#group<%= group.first.uuid.gsub(':', '') %>" aria-expanded="false" aria-controls="collapseExample">
+                  +
+                </button>
+                <input class="form-check-input" type="checkbox" id="select-group<%= group.first.uuid.gsub(':', '') %>" onchange="selectGroup('<%= group.first.uuid.gsub(':', '') %>', <%= indent %>)">
+                <b>Group</b>
+                <%= group.first.title %>
+              </div>
+
+              <div class="col text-end">
+
+              </div>
+            </div>
+          </div>
+        </li>
+        <div class="collapse" id="group<%= group.first.uuid.gsub(':', '') %>">
+          <% group.each do |task| %>
+            <%= render partial: 'process_details', locals: { process: task, indent: indent + 2, depth: depth - 1 } %>
+          <% end %>
+        </div>
+      <% else %>
+        <%= render partial: 'process_details', locals: { process: group.first, indent: indent + 1, depth: depth - 1 } %>
+      <% end %>
+    <% end %>
+  <% else %>
+    <%= process.tasks.each do |task| %>
+      <%= render partial: 'process_details', locals: { process: task, indent: indent + 1, depth: depth - 1 } %>
+    <% end %>
+  <% end %>
+<% else %>
+  <li class="list-group-item text-center">
+    <div class="spinner-border text-primary" role="status">
+      <span class="visually-hidden">Loading...</span>
+    </div>
+  </li>
+<% end %>

data/app/views/taskinator_ui/processes/_process_details.html.erb

@@ -0,0 +1,65 @@
+<% process = process.__getobj__ if process.is_a?(Taskinator::Persistence::LazyLoader) %>
+
+<% if process.instance_of?(Taskinator::Task::SubProcess) %>
+  <%= render partial: 'process_details', locals: { process: process.sub_process, indent: indent, depth: depth } %>
+<% else %>
+  <% decorator = TaskinatorUi::ProcessDecorator.new(process) %>
+  <li class="list-group-item">
+    <div style="margin-left: <%= indent * 10 %>px">
+      <div class="row">
+        <div class="col">
+          <% if decorator.__getobj__.class.in?([Taskinator::Task::Step, Taskinator::Task::Job]) %>
+            <button class="btn btn-outline-secondary btn-sm disabled">x</button>
+          <% else %>
+            <button
+              <% if depth.zero? %>
+              onclick="loadProcessChildren('<%= process.uuid %>', <%= indent %>)"
+              <% end %>
+              class="btn btn-outline-secondary btn-sm"
+              type="button" data-bs-toggle="collapse"
+              data-bs-target="#children<%= decorator.html_uuid %>"
+              aria-expanded="false"
+              aria-controls="collapseExample">+</button>
+          <% end %>
+          <% if decorator.current_state.in?([:initial, :failed]) %>
+            <input class="form-check-input js-indent-<%= indent %>" type="checkbox" name="uuids[]" value="<%= decorator.uuid %>" id="checkbox<%= decorator.html_uuid %>">
+          <% end %>
+          <%= decorator.title %>
+        </div>
+
+        <div class="col text-end">
+          <%= decorator.status_badge %>
+          <button class="btn btn-outline-primary btn-sm" type="button" data-bs-toggle="collapse" data-bs-target="#collapse<%= decorator.html_uuid %>" aria-expanded="false" aria-controls="collapseExample">
+            Details
+          </button>
+        </div>
+      </div>
+
+      <div class="collapse" id="collapse<%= process.uuid.gsub(':', '') %>">
+        <table class="table table-stripped">
+          <tr>
+            <td>uuid:</td>
+            <td><%= process.uuid %></td>
+          </tr>
+          <tr>
+            <td>pending:</td>
+            <td><%= decorator.pending_tasks || 0 %> tasks</td>
+          </tr>
+          <tr>
+            <td>definition:</td>
+            <td><%= process.definition %></td>
+          </tr>
+          <% if process.respond_to?(:args) %>
+            <tr>
+              <td>args:</td>
+              <td><%= process.args %></td>
+            </tr>
+          <% end %>
+        </table>
+      </div>
+    </div>
+  </li>
+  <div class="collapse" id="children<%= process.uuid.gsub(':', '') %>">
+    <%= render partial: 'process_children', locals: { process: process, indent: indent, depth: depth } %>
+  </div>
+<% end %>

data/app/views/taskinator_ui/processes/children.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'process_children', locals: { process: @process, depth: 1, indent: params[:indent].to_i } %>

data/app/views/taskinator_ui/processes/index.html.erb

@@ -0,0 +1,30 @@
+<table class="table table-striped">
+  <thead>
+  <tr>
+    <th scope="col">#</th>
+    <th scope="col">State</th>
+    <th scope="col">Progress</th>
+    <th scope="col">Created at</th>
+  </tr>
+  </thead>
+  <tbody>
+  <% @processes.each do |process| %>
+  <% decorator = TaskinatorUi::ProcessDecorator.new(process) %>
+  <tr>
+    <td><%= link_to process.definition.name, process_path(id: process.uuid) %></td>
+    <td>
+      <div class="progress">
+        <div class="progress-bar" role="progressbar" aria-label="Basic example" style="width: <%= process.percentage_completed %>%" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100"></div>
+      </div>
+    </td>
+    <td><%= decorator.status_badge %></td>
+    <td><%= process.created_at %></td>
+    <td class="text-end">
+      <%= form_tag(process_path(id: process.uuid), method: :delete) do %>
+      <%= submit_tag 'Delete', class: 'btn btn-sm btn-danger' %>
+      <% end %>
+    </td>
+  </tr>
+  <% end %>
+  </tbody>
+</table>

data/app/views/taskinator_ui/processes/show.html.erb

@@ -0,0 +1,10 @@
+<h3><%= @process.definition.name %> <%= @process.uuid %></h3>
+
+<%= form_tag(process_run_path(process_id: @process.uuid)) do %>
+  <ul class="list-group">
+    <%= render partial: 'process_details', locals: { process: @process, indent: 0, depth: 0 } %>
+  </ul>
+  <div class="text-end mt-3">
+    <%= submit_tag 'Run from the selected tasks', class: 'btn btn-primary' %>
+  </div>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,7 @@
+TaskinatorUi::Engine.routes.draw do
+  root to: 'processes#index'
+  resources :processes do
+    get :children
+    post :run
+  end
+end

data/lib/taskinator_ui/engine.rb

@@ -0,0 +1,5 @@
+module TaskinatorUi
+  class Engine < ::Rails::Engine
+    isolate_namespace TaskinatorUi
+  end
+end

data/lib/taskinator_ui/version.rb

@@ -0,0 +1,3 @@
+module TaskinatorUi
+  VERSION = "0.1.0"
+end

data/lib/taskinator_ui.rb

@@ -0,0 +1,6 @@
+require "taskinator_ui/version"
+require "taskinator_ui/engine"
+
+module TaskinatorUi
+  # Your code goes here...
+end

data/lib/tasks/taskinator_ui_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :taskinator_ui do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: taskinator_ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bogdan Guban
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: taskinator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Web UI for taskinator gem.
+email:
+- biguban@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/taskinator_ui_manifest.js
+- app/assets/stylesheets/taskinator_ui/application.scss
+- app/controllers/taskinator_ui/application_controller.rb
+- app/controllers/taskinator_ui/processes_controller.rb
+- app/decorators/taskinator_ui/process_decorator.rb
+- app/helpers/taskinator_ui/application_helper.rb
+- app/helpers/taskinator_ui/processes_helper.rb
+- app/jobs/taskinator_ui/application_job.rb
+- app/mailers/taskinator_ui/application_mailer.rb
+- app/models/taskinator_ui/application_record.rb
+- app/services/taskinator_ui/partial_runner.rb
+- app/views/layouts/taskinator_ui/application.html.erb
+- app/views/taskinator_ui/processes/_process_children.html.erb
+- app/views/taskinator_ui/processes/_process_details.html.erb
+- app/views/taskinator_ui/processes/children.html.erb
+- app/views/taskinator_ui/processes/index.html.erb
+- app/views/taskinator_ui/processes/show.html.erb
+- config/routes.rb
+- lib/taskinator_ui.rb
+- lib/taskinator_ui/engine.rb
+- lib/taskinator_ui/version.rb
+- lib/tasks/taskinator_ui_tasks.rake
+homepage: https://github.com/bguban/taskinator_ui
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bguban/taskinator_ui
+  source_code_uri: https://github.com/bguban/taskinator_ui
+  changelog_uri: https://github.com/bguban/taskinator_ui
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Web UI for taskinator gem.
+test_files: []