command_proposal 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8248eae2534ebab49931beca4a77666ef958bc854eeb39a790808ae6112443b1
-  data.tar.gz: 8915714938d8caf78dc757cf32f47f71a447078204290711403c9ee1eecce60a
+  metadata.gz: 4d0b2ef7f0cf5f9044adaab75cb1b28b762086ff77ce659d461b976dd0533e3d
+  data.tar.gz: c4c50205f7e2260a9d7659e7c6938808366c07aa00f0e85511fd1269de768e95
 SHA512:
-  metadata.gz: 2147b8ebcda3d8b747db413981592c915dfdae50b27ba07e1a39b6b9130b416a11bd9b5f1e728e5a2b2edc73c25302c21473d509165be38030160af7b62c70d5
-  data.tar.gz: 0d07701e418d21123a28463180104b5464ca0f45a7398015a44302e94af34f8f88be6f9592315505aa9fe95cf56c2b25cf46f0125d7c3a18f80a40c80c1b979d
+  metadata.gz: 9ee3a6d919ea22545e62488fc0291d476b168b26412433288b6acde185d96bba8e4f9df313d13596faf508f7faabcea1d5d8539e7794a47d897eb117d4fe70e1
+  data.tar.gz: faca82d2f612e2a0ec8b78ac09655d794b9e04b108b93b075b2097aff0dd0959dc75c21410fa7a6be4d71fac93f52428d0e497298a66c71b4b7caa6d6930329a

data/README.md

@@ -59,7 +59,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/command_proposal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/command_proposal/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/rockster160/command_proposal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rockster160/command_proposal/blob/master/CODE_OF_CONDUCT.md).
 
 ## TODO
 
@@ -74,4 +74,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the CommandProposal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/command_proposal/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CommandProposal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rockster160/command_proposal/blob/master/CODE_OF_CONDUCT.md).

data/app/assets/javascripts/command_proposal/_codemirror.js

@@ -5279,7 +5279,7 @@
     }
 
     // Possibly split or suppress the update based on the presence
-    // of read-only spans in its range.
+    // of readonly spans in its range.
     var split = sawReadOnlySpans && !ignoreReadOnly && removeReadOnlyRanges(doc, change.from, change.to);
     if (split) {
       for (var i = split.length - 1; i >= 0; --i)

data/app/assets/javascripts/command_proposal/_helpers.js

@@ -1,4 +1,4 @@
-function docReady(fn) {
+function cmdDocReady(fn) {
   // see if DOM is already available
   if (document.readyState === "complete" || document.readyState === "interactive") {
     // call on next available tick
@@ -7,3 +7,64 @@ function docReady(fn) {
     document.addEventListener("DOMContentLoaded", fn)
   }
 }
+
+function HttpClient() {
+  this.request = function(method, url, opts) {
+    var req = new XMLHttpRequest()
+    req.onreadystatechange = function() {
+      if (req.status != 0 && req.readyState == 4 && opts.done) {
+        opts.done(req.responseText, req.status, req)
+      }
+    }
+
+    req.open(method, url, true)
+    if (opts.headers) {
+      Object.keys(opts.headers).forEach(function(key) {
+        req.setRequestHeader(key, opts.headers[key])
+      })
+    }
+    req.send(opts.body)
+  }
+
+  this.get = function(url, opts) {
+    this.request("GET", url, opts)
+  }
+
+  this.post = function(url, opts) {
+    this.request("POST", url, opts)
+  }
+}
+
+function CommandQueue() {
+  this.queue = []
+  this.eventCurrentlyRunning = false
+  this.runningQueue = null
+
+  this.run = function() {
+    if (!this.eventCurrentlyRunning) {
+      if (this.queue.length == 0) {
+        clearInterval(this.runningQueue)
+        this.runningQueue = null
+        return
+      }
+      var nextEvent = this.queue.shift()
+      this.eventCurrentlyRunning = true
+      nextEvent(this)
+    }
+  }
+
+  this.add = function(queued_function) {
+    this.queue.push(queued_function)
+    this.process()
+  }
+
+  this.finish = function(ms) {
+    this.eventCurrentlyRunning = false
+  }
+
+  this.process = function() {
+    if (this.runningQueue) { return }
+    var q = this
+    this.runningQueue = setInterval(function() { q.run() }, 1)
+  }
+}

data/app/assets/javascripts/command_proposal/console.js

@@ -1,11 +1,11 @@
 // Add tab / shift-tab for changing indents
-docReady(function() {
+cmdDocReady(function() {
   var cmdconsole = document.querySelector(".cmd-console")
 
   if (cmdconsole) {
     var console_input = document.querySelector(".cmd-console .cmd-entry")
     var lines = document.querySelector(".cmd-console .lines")
-    var queue = Promise.resolve()
+    var queue = new CommandQueue
     var history_cmd_idx = undefined
     var stored_entry = undefined
     var commands = getPrevCommands()
@@ -152,43 +152,38 @@ docReady(function() {
       if (/^[\s\n]*$/.test(line.textContent)) { return }
 
       commands.push(line.textContent)
-      queue = queue.then(async function() {
+      queue.add(function(evt) {
         $.rails.refreshCSRFTokens()
 
         var params = { code: line.textContent, task_id: cmdconsole.dataset.task }
 
-        var res = await fetch(cmdconsole.dataset.exeUrl, {
-          method: "POST",
+        var client = new HttpClient()
+        client.post(cmdconsole.dataset.exeUrl, {
           headers: {
             "Content-Type": "application/json",
             "X-CSRF-Token": $.rails.csrfToken()
           },
-          body: JSON.stringify(params)
-        }).then(function(res) {
-          if (res.ok) {
-            return res.json()
-          } else {
-            throw new Error("Server error")
-          }
-        }).catch(function(err) {
-          return {
-            error: err,
+          body: JSON.stringify(params),
+          done: function(res, status, req) {
+            if (status == 200) {
+              var json = JSON.parse(res)
+              var result = document.createElement("div")
+              result.classList.add("result")
+
+              if (json.error) {
+                result.classList.add("cmd-error")
+                result.textContent = json.error
+              } else {
+                result.textContent = json.result
+              }
+
+              line.appendChild(result)
+            } else {
+              console.log("Error: ", res, req);
+            }
+            evt.finish()
           }
         })
-
-        var json = await res
-
-        var result = document.createElement("div")
-        result.classList.add("result")
-
-        if (json.error) {
-          result.classList.add("cmd-error")
-          result.textContent = json.error
-        } else {
-          result.textContent = json.result
-        }
-
-        line.appendChild(result)
       })
     }
   }

data/app/assets/javascripts/command_proposal/feed.js

@@ -1,6 +1,6 @@
-docReady(function() {
+cmdDocReady(function() {
   var terminals = document.querySelectorAll("[data-feed]")
-  var queue = Promise.resolve()
+  var queue = new CommandQueue
   var continue_statuses = ["started", "approved", "cancelling"]
 
   terminals.forEach(function(terminal) {
@@ -10,42 +10,39 @@ docReady(function() {
   })
 
   function pingFeed(terminal) {
-    queue = queue.then(async function() {
+    queue.add(function(evt) {
       $.rails.refreshCSRFTokens()
 
-      var res = await fetch(terminal.dataset.feed, {
-        method: "GET",
+      var client = new HttpClient()
+      client.get(terminal.dataset.feed, {
         headers: {
           "Content-Type": "text/html",
           "X-CSRF-Token": $.rails.csrfToken()
         },
-      }).then(function(res) {
-        if (res.ok) {
-          return res.json()
-        } else {
-          throw new Error("Server error")
-        }
-      }).catch(function(err) {
-        console.log("err:", err);
-      })
-
-      var json = await res
+        done: function(res, status, req) {
+          if (status == 200) {
+            var json = JSON.parse(res)
+            if (terminal.nextElementSibling && terminal.nextElementSibling.CodeMirror) {
+              terminal.nextElementSibling.CodeMirror.doc.setValue(json.result || "")
+            } else {
+              terminal.innerHTML = json.result_html
+            }
+            document.querySelector("td[data-iteration-status]").innerText = json.status
+            document.querySelector("td[data-iteration-duration]").innerText = json.duration
 
-      if (terminal.nextElementSibling && terminal.nextElementSibling.CodeMirror) {
-        terminal.nextElementSibling.CodeMirror.doc.setValue(json.result || "")
-      } else {
-        terminal.innerHTML = json.result_html
-      }
-      document.querySelector("td[data-iteration-status]").innerText = json.status
-      document.querySelector("td[data-iteration-duration]").innerText = json.duration
-
-      if (continue_statuses.includes(json.status)) {
-        setTimeout(function() { pingFeed(terminal) }, 1000)
-      } else {
-        if (document.querySelector(".cancel-btn")) {
-          document.querySelector(".cancel-btn").remove()
+            if (continue_statuses.includes(json.status)) {
+              setTimeout(function() { pingFeed(terminal) }, 1000)
+            } else {
+              if (document.querySelector(".cancel-btn")) {
+                document.querySelector(".cancel-btn").remove()
+              }
+            }
+          } else {
+            console.log("Error: ", res, req);
+          }
+          evt.finish()
         }
-      }
+      })
     })
   }
 })

data/app/assets/javascripts/command_proposal/terminal.js

@@ -1,4 +1,4 @@
-docReady(function() {
+cmdDocReady(function() {
   var terminals = document.querySelectorAll(".cmd-terminal")
 
   function setReadOnlyUI(cm) {

data/app/assets/stylesheets/command_proposal/tables.scss

@@ -68,6 +68,8 @@
   th, td {
     text-align: left;
     padding: 3px;
+
+    &.cmd-text-right { text-align: right; }
   }
   th {
     font-size: 12px;

data/app/assets/stylesheets/command_proposal/terminal.scss

@@ -18,7 +18,7 @@
   .line {
     min-height: 18px;
     counter-increment: line-count;
-    font-size: 16px;
+    font-size: 14px;
     padding-left: 5px;
     position: relative;
 
@@ -26,7 +26,7 @@
       content: "[" counter(line-count) "]>";
       position: absolute;
       left: -40px;
-      top: 3px;
+      top: 2px;
       width: 40px;
       font-size: 10px;
       vertical-align: middle;

data/app/controllers/command_proposal/runner_controller.rb

@@ -67,13 +67,18 @@ class ::CommandProposal::RunnerController < ::CommandProposal::EngineController
       duration: humanized_duration(@iteration.duration),
     }.tap do |response|
       if @iteration.started?
-        response[:endpoint] = runner_path(@task, @iteration)
+        response[:endpoint] = runner_url(@task, @iteration)
       end
       if @task.console?
         response[:result_html] = ApplicationController.render(
-          partial: "command_proposal/tasks/lines",
+          partial: "command_proposal/tasks/console_lines",
           locals: { lines: @task.lines }
         )
+      else
+        response[:result_html] = ApplicationController.render(
+          partial: "command_proposal/tasks/lines",
+          locals: { lines: @iteration.result }
+        )
       end
     end
   end

data/app/helpers/command_proposal/application_helper.rb

@@ -1,8 +1,10 @@
 module CommandProposal
   module ApplicationHelper
+    include ActionDispatch::Routing::PolymorphicRoutes
+    include Rails.application.routes.url_helpers
     # In order to keep the regular app's routes working in the base template, we have to manually
     #   render the engine routes. Built a helper for this because it's long and nasty otherwise.
-    def cmd_path(*args)
+    def cmd_url(*args)
       return string_path(*args) if args.first.is_a?(String)
       model_names = [:tasks, :iterations, :comments, :task, :iteration, :comment]
       host = nil
@@ -19,39 +21,43 @@ module CommandProposal
       args << { host: host, port: nil } if host.present?
 
       begin
-        router.url_for(args.compact)
+        command_proposal_engine.url_for(args.compact)
       rescue NoMethodError => e
-        raise "Error generating route! Please make sure `default_url_options` are set."
+        raise "Error generating route! Please make sure `config.action_mailer.default_url_options` are set."
       end
     end
 
+    def cmd_path(*args)
+      args.tap { |arg_list|
+        if arg_list.last.is_a?(Hash)
+          arg_list.last.merge!(only_path: true)
+        else
+          arg_list << { only_path: true }
+        end
+      }
+
+      cmd_url(*args)
+    end
+
     def string_path(*args)
-      [router.command_proposal_tasks_url + args.shift, args.to_param.presence].compact.join("?")
+      [command_proposal_engine.command_proposal_tasks_url + args.shift, args.to_param.presence].compact.join("?")
     end
 
     # Runner controller doesn't map to a model, so needs special handling
     def runner_path(task, iteration=nil)
       if iteration.present?
-        router.command_proposal_task_runner_url(task, iteration)
+        command_proposal_engine.command_proposal_task_runner_path(task, iteration)
       else
-        router.command_proposal_task_runner_index_url(task)
-      end
-    end
-
-    def router
-      @@router ||= begin
-        routes = ::CommandProposal::Engine.routes
-        routes.default_url_options = rails_default_url_options
-        routes.url_helpers
+        command_proposal_engine.command_proposal_task_runner_index_path(task)
       end
     end
 
-    def rails_default_url_options
-      Rails.application.config.action_mailer.default_url_options.tap do |default_opts|
-        default_opts ||= {}
-        default_opts[:host] ||= "localhost"
-        default_opts[:port] ||= "3000"
-        default_opts[:protocol] ||= "http"
+    # Runner controller doesn't map to a model, so needs special handling
+    def runner_url(task, iteration=nil)
+      if iteration.present?
+        command_proposal_engine.command_proposal_task_runner_url(task, iteration)
+      else
+        command_proposal_engine.command_proposal_task_runner_index_url(task)
       end
     end
   end

data/app/helpers/command_proposal/icons_helper.rb

@@ -7,6 +7,7 @@ module CommandProposal
         started: "cmd-icon-grey fa fa-clock-o",
         cancelling: "cmd-icon-yellow fa fa-hourglass-half",
         cancelled: "cmd-icon-yellow fa fa-stop-circle",
+        terminated: "cmd-icon-red fa fa-stop-circle",
         failed: "cmd-icon-red fa fa-times-circle",
         success: "cmd-icon-green fa fa-check-circle",
       }[status&.to_sym] || "cmd-icon-yellow fa fa-question"

data/app/helpers/command_proposal/permissions_helper.rb

@@ -1,12 +1,14 @@
 module CommandProposal
   module PermissionsHelper
     def can_command?(user=command_user)
+      return false unless permitted_to_use?
       return true unless cmd_config.approval_required?
 
       command_user.try("#{cmd_config.role_scope}?")
     end
 
     def can_approve?(iteration)
+      return false unless permitted_to_use?
       return true unless cmd_config.approval_required?
       return if iteration.nil?
 
@@ -14,15 +16,24 @@ module CommandProposal
     end
 
     def has_approval?(task)
+      return false unless permitted_to_use?
       return true unless cmd_config.approval_required?
 
       task&.approved?
     end
 
     def current_is_author?(iteration)
+      return false unless permitted_to_use?
+
       command_user&.id == iteration&.requester&.id
     end
 
+    def permitted_to_use?
+      return true if cmd_config.controller_var.blank?
+
+      command_user&.send("#{cmd_config.role_scope}?")
+    end
+
     def command_user(user=nil)
       @command_user ||= begin
         if user.present?
@@ -30,7 +41,7 @@ module CommandProposal
         elsif cmd_config.controller_var.blank?
           nil
         else
-          try(cmd_config.controller_var)
+          send(cmd_config.controller_var)
         end
       end
     end

data/app/models/command_proposal/comment.rb

@@ -3,7 +3,7 @@
 # belongs_to :author
 # text :body
 
-require "command_proposal/service/external_belong"
+require_dependency "command_proposal/service/external_belong"
 
 class ::CommandProposal::Comment < ApplicationRecord
   self.table_name = :command_proposal_comments

data/app/models/command_proposal/iteration.rb

@@ -13,8 +13,8 @@
 
 # ADD: iteration_count?
 
-require "command_proposal/service/external_belong"
-require "command_proposal/service/json_wrapper"
+require_dependency "command_proposal/service/external_belong"
+require_dependency "command_proposal/service/json_wrapper"
 
 class ::CommandProposal::Iteration < ApplicationRecord
   self.table_name = :command_proposal_iterations
@@ -34,6 +34,7 @@ class ::CommandProposal::Iteration < ApplicationRecord
     cancelling: 4, # Running, but told to stop
     cancelled:  5,
     success:    6,
+    terminated: 7, # Closed via server restart
   }
 
   delegate :name, to: :task
@@ -52,13 +53,17 @@ class ::CommandProposal::Iteration < ApplicationRecord
   end
 
   def complete?
-    success? || failed? || cancelled?
+    success? || failed? || cancelled? || terminated?
   end
 
   def pending?
     created?
   end
 
+  def running?
+    started? || cancelling?
+  end
+
   def duration
     return unless started_at?
 

data/app/models/command_proposal/service/proposal_presenter.rb

@@ -1,6 +1,7 @@
 module CommandProposal
   module Service
     class ProposalPresenter
+      include Rails.application.routes.url_helpers
       include ::CommandProposal::ApplicationHelper
       attr_accessor :iteration
 
@@ -19,8 +20,9 @@ module CommandProposal
       delegate :stopped_at, to: :iteration
       delegate :duration, to: :iteration
 
-      def url(host: nil)
-        cmd_path(@iteration.task, host: host)
+      def url
+        path = ::CommandProposal::Engine.routes.url_helpers.command_proposal_task_path(@iteration.task)
+        "#{base_path}#{path}"
       end
 
       def requester
@@ -34,6 +36,20 @@ module CommandProposal
       def type
         @iteration.session_type
       end
+
+      private
+
+      def base_path
+        url_opts = Rails.application.config.action_mailer.default_url_options || {}
+        url_opts.tap do |opts|
+          opts[:protocol] ||= "http"
+          opts[:host] ||= "localhost"
+          opts[:port] ||= 3000
+        end
+
+        port_str = url_opts[:host] == "localhost" ? ":#{url_opts[:port]}" : ""
+        "#{url_opts[:protocol] || 'http'}://#{url_opts[:host]}#{port_str}"
+      end
     end
   end
 end

data/app/models/command_proposal/task.rb

@@ -19,10 +19,10 @@ class ::CommandProposal::Task < ApplicationRecord
   enum session_type: {
     # Task will have multiple iterations that are all essentially the same just with code changes
     task:     0,
-    # Console iterations are actually line by line, so order matters
-    console:  1,
     # Function iterations are much like tasks
-    function: 2,
+    function: 1,
+    # Console iterations are actually line by line, so order matters
+    console:  2,
     # Modules are included in tasks and not run independently
     module:   3,
   }

data/app/views/command_proposal/tasks/_console_lines.html.erb

@@ -0,0 +1,8 @@
+<% if lines.none? && !(skip_empty ||= false) -%><div class="line"></div><% end
+-%><% lines.each do |iteration| -%>
+  <div class="line"><%= iteration.code -%><%
+    if iteration.result.present?
+      -%><div class="result"><%= iteration.result %></div><%
+    end
+  -%></div>
+<% end -%>

data/app/views/command_proposal/tasks/_console_show.html.erb

@@ -7,7 +7,7 @@
     <% when :approved, :started %>
       <%# Closing > offset to get rid of spacing issues. %>
       <div class="cmd-console" data-task="<%= @task.id %>" data-exe-url="<%= cmd_path(@task, :task_iterations) %>"
-        ><div class="lines"><%= render partial: "lines", locals: { lines: @lines, skip_empty: true }
+        ><div class="lines"><%= render partial: "console_lines", locals: { lines: @lines, skip_empty: true }
         %></div
         ><div contenteditable="true" autofocus=true class="line cmd-entry"></div
       ></div>
@@ -26,7 +26,7 @@
       <% if @task.first_iteration.success? %>
         <p>Session closed.</p>
       <% end %>
-      <div class="cmd-console" read-only=true><%= render partial: "lines", locals: { lines: @lines } %></div>
+      <div class="cmd-console" readonly=true><%= render partial: "console_lines", locals: { lines: @lines } %></div>
     <% end %>
 
   <% else %>
@@ -38,7 +38,7 @@
     <% if @task.first_iteration.success? %>
       <p>Session closed.</p>
     <% end %>
-    <div class="cmd-console" read-only=true data-status="<%= @iteration.status %>" data-feed="<%= runner_path(@task, @iteration) %>"><%= render partial: "lines", locals: { lines: @lines } %></div>
+    <div class="cmd-console" readonly=true data-status="<%= @iteration.status %>" data-feed="<%= runner_path(@task, @iteration) %>"><%= render partial: "console_lines", locals: { lines: @lines } %></div>
 
   <% end %>
 <% end %>

data/app/views/command_proposal/tasks/_function_show.html.erb

@@ -1,54 +1,67 @@
 <%= render partial: "task_detail_table" %>
 
-<textarea class="cmd-terminal" readonly=true><%= @iteration.code %></textarea>
-
 <%= form_for @iteration, url: cmd_path(@iteration), html: { id: "edit-form-1" } do |f| %>
-  <% if @iteration.params.any? && (@iteration.pending? || @iteration.complete?) %>
+  <% @iteration.brings.each do |bring_module| %>
+    <% needs_approval_str = " -- Module needs approval before running Task" unless bring_module.approved? %>
+    <%= link_to "Module: #{bring_module.name}#{needs_approval_str}", cmd_path("#{bring_module.friendly_id}") %>
+    <br>
+  <% end %>
+  <% if @task.approved? && @iteration.params.any? %>
     <div class="form-field">
       <% @iteration.params.each do |param_key| %>
-        <label for="iteration[args][<%= param_key %>]"><%= param_key %></label>
-        <input type="text" name="iteration[args][<%= param_key %>]" value="">
+        <label for="command_proposal_iteration[args][<%= param_key %>]"><%= param_key %></label>
+        <br>
+        <input type="text" name="command_proposal_iteration[args][<%= param_key %>]" value="">
+        <br>
       <% end %>
     </div>
   <% end %>
 
-  <% if @iteration.approved_at? %>
+  <% if @iteration.approved_at? && !params.key?(:iteration) %>
     <%= f.hidden_field :command, value: :run %>
     <%= f.submit "Execute" %>
+    <br>
   <% end %>
 <% end %>
 
-<%= form_for @iteration, url: cmd_path(@iteration), html: { id: "edit-form-2" } do |f| %>
-  <% if @iteration&.started_at? %>
-    <textarea class="cmd-terminal" readonly=true data-status="<%= @iteration.status %>" data-feed="<%= runner_path(@task, @iteration) %>"><%= @iteration&.result %></textarea>
-  <% end %>
+<% unless params.key?(:iteration) %>
+  <%= form_for @iteration, url: cmd_path(@iteration), html: { id: "edit-form-2" } do |f| %>
+    <% if current_is_author?(@iteration) %>
 
-  <% if current_is_author?(@iteration) %>
+      <% case @iteration.status&.to_sym %>
+      <% when :created, :failed, :cancelled, :terminated %>
+        <% unless @iteration.approved_at? %>
+          <% if can_approve?(@iteration) %>
+              <%= f.hidden_field :command, value: :approve %>
+              <%= f.submit "Approve!" %>
+          <% else %>
+            <%= f.hidden_field :command, value: :request %>
+            <%= f.submit "Request Access" %>
+          <% end %>
+        <% end %>
+      <% when :started %>
+        <%= f.hidden_field :command, value: :cancel %>
+        <%= f.submit "CANCEL!", class: "cancel-btn", data: { confirm: "WARNING: Cancelling a command mid-process can be dangerous. Any processes that have already run will not be rolled back. Do you wish to continue?" } %>
+      <% end %>
+
+    <% elsif can_approve?(@iteration) %>
 
-    <% case @iteration.status&.to_sym %>
-    <% when :created, :failed, :cancelled %>
-      <% if can_approve?(@iteration) %>
+      <% if @iteration.approved? %>
+        <p>Approved. Ready to run.</p>
+      <% elsif @iteration.pending? %>
         <%= f.hidden_field :command, value: :approve %>
         <%= f.submit "Approve!" %>
-      <% else %>
-        <%= f.hidden_field :command, value: :request %>
-        <%= f.submit "Request Access" %>
       <% end %>
-    <% when :started %>
-      <%= f.hidden_field :command, value: :cancel %>
-      <%= f.submit "CANCEL!", class: "cancel-btn", data: { confirm: "WARNING: Cancelling a command mid-process can be dangerous. Any processes that have already run will not be rolled back. Do you wish to continue?" } %>
-    <% end %>
 
-  <% elsif can_approve?(@iteration) %>
-
-    <% if @iteration.approved? %>
-      <p>Approved. Ready to run.</p>
-    <% elsif @iteration.pending? %>
-      <%= f.hidden_field :command, value: :approve %>
-      <%= f.submit "Approve!" %>
     <% end %>
-
   <% end %>
 <% end %>
 
-<% render partial: "past_iterations_list" %>
+<% if @iteration&.started_at? %>
+  <div class="cmd-console" readonly=true data-status="<%= @iteration.status %>" data-feed="<%= runner_path(@task, @iteration) %>"><%= render partial: "lines", locals: { lines: @iteration&.result } %></div>
+<% end %>
+
+<br>
+<textarea class="cmd-terminal" readonly=true><%= @iteration.code %></textarea>
+
+<%= render partial: "past_iterations_list" %>

data/app/views/command_proposal/tasks/_lines.html.erb

@@ -1,8 +1,4 @@
-<% if lines.none? && !(skip_empty ||= false) -%><div class="line"></div><% end
--%><% lines.each do |iteration| -%>
-  <div class="line"><%= iteration.code -%><%
-    if iteration.result.present?
-      -%><div class="result"><%= iteration.result %></div><%
-    end
-  -%></div>
-<% end -%>
+<% if lines.blank? && !(skip_empty ||= false) -%><div class="line"></div><% end
+-%><% lines.split("\n").each do |line|
+  -%><div class="line"><%= line -%></div><%
+end -%>

data/app/views/command_proposal/tasks/_module_show.html.erb

@@ -12,15 +12,11 @@
         <%= f.hidden_field :command, value: :request %>
         <%= f.submit "Request Access" %>
       <% end %>
-    <% when :approved %>
-      <p>Include this module in other commands by using <code>bring :<%= @task.friendly_id %></code> at the top of the file.</p>
     <% end %>
 
   <% elsif can_approve?(@iteration) %>
 
-    <% if @iteration.approved? %>
-      <p>Approved. Ready to include.</p>
-    <% elsif @iteration.pending? %>
+    <% if @iteration.pending? %>
       <%= f.hidden_field :command, value: :approve %>
       <%= f.submit "Approve!" %>
     <% end %>
@@ -28,6 +24,7 @@
   <% end %>
 <% end %>
 
+<p>Include this module in other commands by using <code>bring :<%= @task.friendly_id %></code> at the top of the file.</p>
 <textarea class="cmd-terminal" readonly=true><%= @iteration&.code %></textarea>
 
-<% render partial: "past_iterations_list" %>
+<%= render partial: "past_iterations_list" %>

data/app/views/command_proposal/tasks/_past_iterations_list.html.erb

@@ -7,9 +7,16 @@
       <!-- <th>Diff</th> -->
     </thead>
     <tbody>
+      <% primary_iteration = @task.primary_iteration %>
       <% @task.iterations.where.not(id: @iteration&.id).order(created_at: :desc).each do |iteration| %>
         <tr>
-          <td><%= link_to iteration.created_at.strftime("%b %-d, %Y at %H:%M"), cmd_path(@task, iteration: iteration.id) %></td>
+          <td>
+            <% if iteration.id == primary_iteration&.id %>
+              <%= link_to iteration.created_at.strftime("%b %-d, %Y at %H:%M"), cmd_path(@task) %>
+            <% else %>
+              <%= link_to iteration.created_at.strftime("%b %-d, %Y at %H:%M"), cmd_path(@task, iteration: iteration.id) %>
+            <% end %>
+          </td>
           <td><%= iteration.status.capitalize %></td>
           <!-- <td><%= iteration.comments.count %></td> -->
           <!-- <td><%= link_to "Diff", cmd_path(@task, iteration: @iteration.id, diff: iteration.id) %></td> -->

data/app/views/command_proposal/tasks/_task_detail_table.html.erb

@@ -8,8 +8,8 @@
   </thead>
   <tbody>
     <tr>
-      <td><%= @iteration&.requester_name %></td>
-      <td><%= @iteration&.approver_name %></td>
+      <td><%= @iteration&.requester_name.presence || "ID: #{@iteration&.requester_id}" if @iteration&.requester_id.present? %></td>
+      <td><%= @iteration&.approver_name.presence || "ID: #{@iteration&.approver_id}" if @iteration&.approver_id.present? %></td>
       <td><%= @iteration&.started_at&.strftime("%b %-d '%y, %-l:%M%P") %></td>
       <td data-iteration-status><%= @iteration&.status&.capitalize %></td>
       <td data-iteration-duration><%= humanized_duration(@iteration&.duration) %></td>
@@ -22,7 +22,7 @@
     <tbody>
       <% @iteration.args.each do |arg_k, arg_v| %>
         <tr>
-          <th><%= arg_k %></th>
+          <th class="cmd-text-right"><%= arg_k %></th>
           <td><%= arg_v %></td>
         </tr>
       <% end %>

data/app/views/command_proposal/tasks/_task_show.html.erb

@@ -8,43 +8,45 @@
       <br>
     <% end %>
 
-    <% if @iteration&.started_at? %>
-      <textarea class="cmd-terminal" readonly=true data-status="<%= @iteration.status %>" data-feed="<%= runner_path(@task, @iteration) %>"><%= @iteration&.result %></textarea>
-    <% end %>
+    <% unless params.key?(:iteration) %>
+      <% if current_is_author?(@iteration) %>
+
+        <% case @iteration.status&.to_sym %>
+        <% when :created, :cancelled, :terminated %>
+          <% if can_approve?(@iteration) %>
+            <%= f.hidden_field :command, value: :approve %>
+            <%= f.submit "Approve!" %>
+          <% else %>
+            <%= f.hidden_field :command, value: :request %>
+            <%= f.submit "Request Access" %>
+          <% end %>
+        <% when :failed %>
+          <p>Edit task to attempt to run again.</p>
+        <% when :approved %>
+          <%= f.hidden_field :command, value: :run %>
+          <%= f.submit "Execute" %>
+        <% when :started %>
+          <%= f.hidden_field :command, value: :cancel %>
+          <%= f.submit "CANCEL!", class: "cancel-btn", data: { confirm: "WARNING: Cancelling a command mid-process can be dangerous. Any processes that have already run will not be rolled back. Do you wish to continue?" } %>
+        <% when :success %>
+          <%= f.hidden_field :command, value: :request %>
+          <%= f.submit "Request Re-Run Access" %>
+        <% end %>
 
-    <% if current_is_author?(@iteration) %>
+      <% elsif can_approve?(@iteration) %>
 
-      <% case @iteration.status&.to_sym %>
-      <% when :created, :cancelled %>
-        <% if can_approve?(@iteration) %>
+        <% if @iteration.approved? %>
+          <p>Approved. Ready to run.</p>
+        <% elsif @iteration.pending? %>
           <%= f.hidden_field :command, value: :approve %>
           <%= f.submit "Approve!" %>
-        <% else %>
-          <%= f.hidden_field :command, value: :request %>
-          <%= f.submit "Request Access" %>
         <% end %>
-      <% when :failed %>
-        <p>Edit task to attempt to run again.</p>
-      <% when :approved %>
-        <%= f.hidden_field :command, value: :run %>
-        <%= f.submit "Execute" %>
-      <% when :started %>
-        <%= f.hidden_field :command, value: :cancel %>
-        <%= f.submit "CANCEL!", class: "cancel-btn", data: { confirm: "WARNING: Cancelling a command mid-process can be dangerous. Any processes that have already run will not be rolled back. Do you wish to continue?" } %>
-      <% when :success %>
-        <%= f.hidden_field :command, value: :request %>
-        <%= f.submit "Request Re-Run Access" %>
-      <% end %>
-
-    <% elsif can_approve?(@iteration) %>
 
-      <% if @iteration.approved? %>
-        <p>Approved. Ready to run.</p>
-      <% elsif @iteration.pending? %>
-        <%= f.hidden_field :command, value: :approve %>
-        <%= f.submit "Approve!" %>
       <% end %>
+    <% end %>
 
+    <% if @iteration&.started_at? %>
+      <div class="cmd-console" readonly=true data-status="<%= @iteration.status %>" data-feed="<%= runner_path(@task, @iteration) %>"><%= render partial: "lines", locals: { lines: @iteration&.result } %></div>
     <% end %>
   <% end %>
 <% end %>

data/app/views/command_proposal/tasks/form.html.erb

@@ -9,7 +9,7 @@
 
   <%= form_for(@task, url: cmd_path(@task)) do |f| %>
     <div class="cmd-field">
-      <%= f.text_field :name, placeholder: "Title", class: "cmd-input" %>
+      <%= f.text_field :name, placeholder: "Title", class: "cmd-input", required: true %>
     </div>
 
     <div class="cmd-field">
@@ -24,18 +24,18 @@
             Task - Batch of code that typically only needs to be executed once. Requires approval for every new run.
           <% end %>
         </p>
-        <p>
-          <%= f.radio_button :session_type, :console %>
-          <%= f.label :session_type, value: :console do %>
-            Console - Starts a session that allows line-by-line commands to be executed. Requires approval only to begin session.
-          <% end %>
-        </p>
         <p>
           <%= f.radio_button :session_type, :function %>
           <%= f.label :session_type, value: :function do %>
             Function - Reusable batch of code, can accept arguments. Only requires approval on code changes.
           <% end %>
         </p>
+        <p>
+          <%= f.radio_button :session_type, :console %>
+          <%= f.label :session_type, value: :console do %>
+            Console - Starts a session that allows line-by-line commands to be executed. Requires approval only to begin session.
+          <% end %>
+        </p>
         <p>
           <%= f.radio_button :session_type, :module %>
           <%= f.label :session_type, value: :module do %>

data/app/views/command_proposal/tasks/index.html.erb

@@ -1,7 +1,8 @@
 <div class="cmd-wrapper">
-  <%= link_to "New Command", cmd_path(:new, :task, session_type: params[:filter] || :task) %> <br>
+  <%= link_to "New #{params[:filter].presence&.capitalize || 'Command'}", cmd_path(:new, :task, session_type: params[:filter] || :task) %> <br>
   <br>
-  <% ::CommandProposal::Task.session_types.each_with_index do |(session_type, _session_enum), idx| %><%=
+  <%= link_to "All", cmd_path(:tasks, current_params.except(:filter)), class: "cmd-tab #{:active unless params.key?(:filter)}"
+  %><% ::CommandProposal::Task.session_types.each_with_index do |(session_type, _session_enum), idx| %><%=
     selected = params[:filter] == session_type.to_s
     # Offset closing RB tags to fix spacing issues
     link_to session_type.capitalize, toggled_param(filter: session_type), class: "cmd-tab #{:active if selected}"

data/lib/command_proposal/configuration.rb

@@ -18,7 +18,7 @@ module CommandProposal
       # Default
       @approval_required = true
 
-      # Required (if approval needed)
+      # User details - highly recommended
       @user_class_name = nil
       @role_scope = nil
       @user_name = nil

data/lib/command_proposal/services/command_interpreter.rb

@@ -25,7 +25,6 @@ module CommandProposal
         when :approve then command_approve
         when :run then command_run
         when :cancel then command_cancel
-        when :cancel then command_cancel
         when :close then command_close
         end
 
@@ -78,6 +77,9 @@ module CommandProposal
         return if @iteration.complete?
 
         @iteration.update(status: :cancelling)
+        return if ::CommandProposal.sessions.key?("task:#{@task.id}")
+
+        ::CommandProposal::Services::ShutDown.terminate(@iteration)
       end
 
       def command_close

data/lib/command_proposal/services/runner.rb

@@ -4,23 +4,33 @@ module CommandProposal
       attr_accessor :session
       # Add expiration and things like that...
 
+      def self.execute(friendly_id)
+        task = ::CommandProposal::Task.find_by!(friendly_id: friendly_id)
+
+        new.execute(task.primary_iteration)
+      end
+
       def initialize
         @session = session
       end
 
-      def execute(iteration, inline=false)
+      def execute(iteration)
         @iteration = iteration
-        @inline = inline
         prepare
 
         run
 
         complete
+        proposal = ::CommandProposal::Service::ProposalPresenter.new(@iteration)
         @iteration = nil
+        proposal
       end
 
-      def quick_run(iteration)
-        raise CommandProposal::Error, ":#{iteration.task.friendly_id} does not have approval to run." unless iteration.approved?
+      def quick_run(friendly_id)
+        task = ::CommandProposal::Task.module.find_by!(friendly_id: friendly_id)
+        iteration = task&.primary_iteration
+
+        raise CommandProposal::Error, ":#{friendly_id} does not have approval to run." unless iteration&.approved?
 
         @session.eval(iteration.code)
       end
@@ -49,14 +59,16 @@ module CommandProposal
         stored_stdout = $stdout
         $stdout = StringIO.new
         result = nil # Init var for scope
+        status = nil
 
         running_thread = Thread.new do
           begin
             # Run bring functions in here so we can capture any string outputs
             # OR! Run the full runner and instead of saving to an iteration, return the string for prepending here
             result = @session.eval("_ = (#{@iteration.code})").inspect # rubocop:disable Security/Eval - Eval is scary, but in this case it's exactly what we need.
+            status = :success
           rescue Exception => e # rubocop:disable Lint/RescueException - Yes, rescue full Exception so that we can catch typos in evals as well
-            @iteration.status = :failed
+            status = :failed
 
             result = results_from_exception(e)
           end
@@ -69,9 +81,12 @@ module CommandProposal
             @iteration.update(result: $stdout.try(:string).dup)
           end
 
-          running_thread.exit if @iteration.cancelling?
+          if @iteration.cancelling?
+            running_thread.exit
+            status = :cancelled
+          end
 
-          sleep 1
+          sleep 0.4
         end
 
         output = $stdout.try(:string)
@@ -79,11 +94,12 @@ module CommandProposal
         # Not using presence because we want to maintain other empty objects such as [] and {}
 
         $stdout = stored_stdout
+        @iteration.status = status
         @iteration.result = [output, "#{result || 'nil'}"].compact.join("\n")
       end
 
       def bring_function
-        "def bring(*func_names); func_names.each { |f| self.quick_run(::CommandProposal::Task.module.find_by!(friendly_id: f).current_iteration) }; end"
+        "def bring(*func_names); func_names.each { |f| self.quick_run(f) }; end"
       end
 
       def complete
@@ -91,7 +107,7 @@ module CommandProposal
         if @iteration.cancelling? || @iteration.cancelled?
           @iteration.result += "\n\n~~~~~ CANCELLED ~~~~~"
           @iteration.status = :cancelled
-        elsif @iteration.failed?
+        elsif @iteration.status&.to_sym == :failed
           # No-op
         else
           @iteration.status = :success

data/lib/command_proposal/services/shut_down.rb

@@ -0,0 +1,25 @@
+module CommandProposal
+  module Services
+    module ShutDown
+      module_function
+
+      def reset_all
+        pending = ::CommandProposal::Iteration.where(status: [:started, :cancelling])
+        pending.find_each do |iteration|
+          terminate(iteration)
+        end
+      end
+
+      def terminate(iteration)
+        return unless iteration.running?
+
+        terminated_result = iteration.result + "\n\n~~~~~ TERMINATED ~~~~~"
+        iteration.update(
+          status: :terminated,
+          result: terminated_result,
+          completed_at: Time.current
+        )
+      end
+    end
+  end
+end

data/lib/command_proposal/version.rb

@@ -1,3 +1,8 @@
+# gem build command_proposal.gemspec
+# gam "Built version __ of gem."
+# gpo
+# gem push command_proposal-__.gem
+
 module CommandProposal
-  VERSION = '1.0.0'
+  VERSION = '1.0.4'
 end

data/lib/command_proposal.rb

@@ -2,6 +2,7 @@ require "command_proposal/configuration"
 require "command_proposal/version"
 require "command_proposal/engine"
 require "command_proposal/services/runner"
+require "command_proposal/services/shut_down"
 
 module CommandProposal
   class Error < StandardError; end

data/lib/generators/command_proposal/install/templates/initializer.rb

@@ -1,4 +1,9 @@
 ::CommandProposal.configure do |config|
+  # Determines if a user needs a different user to approve their commands.
+  # Defaults to true, the recommended value.
+  # However, disabling in development could help with testing.
+  # config.approval_required = !Rails.env.development?
+
   # Change if your base user class has a different model name
   config.user_class_name = "User"
 
@@ -8,6 +13,8 @@
   # Scope for your user class that determines users who are permitted to interact with commands
   # It is highly recommended to make this very exclusive, as any users in this scope will be able
   # to interact with your database directly.
+  # Expected that the class will respond to `#{role_scope}` and
+  #   instances of the class respond to `#{role_scope}?`
   config.role_scope = :admin
 
   # Method called to display a user's name
@@ -34,14 +41,14 @@
 
   # Called when a command is proposed for review
   config.proposal_callback = Proc.new { |proposal|
-    # Slack.notify("#{proposal.requester} has proposed #{proposal.name}.\n<Click Here|#{proposal.url}> to view this proposal and approve.")
+    # Slack.notify("#{proposal.requester} has proposed #{proposal.name}.\n<#{proposal.url}|Click Here> to view this proposal and approve.")
   }
   # Called when a command runs and completes successfully
-  config.success_callback = Proc.new { |iteration|
-    # Slack.notify("The task #{proposal.name} has completed in #{proposal.duration}s.\n<Click Here|#{proposal.url}> to view the results.")
+  config.success_callback = Proc.new { |proposal|
+    # Slack.notify("The task #{proposal.name} has completed in #{proposal.duration}s.\n<#{proposal.url}|Click Here> to view the results.")
   }
   # Called when a command runs but fails to complete
-  config.failed_callback = Proc.new { |iteration|
-    # Slack.notify("The task #{proposal.name} has failed!\n<Click Here|#{proposal.url}> to see what went wrong.")
+  config.failed_callback = Proc.new { |proposal|
+    # Slack.notify("The task #{proposal.name} has failed!\n<#{proposal.url}|Click Here> to see what went wrong.")
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_proposal
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Rocco Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -116,6 +116,7 @@ files:
 - app/models/command_proposal/service/json_wrapper.rb
 - app/models/command_proposal/service/proposal_presenter.rb
 - app/models/command_proposal/task.rb
+- app/views/command_proposal/tasks/_console_lines.html.erb
 - app/views/command_proposal/tasks/_console_show.html.erb
 - app/views/command_proposal/tasks/_function_show.html.erb
 - app/views/command_proposal/tasks/_lines.html.erb
@@ -133,6 +134,7 @@ files:
 - lib/command_proposal/engine.rb
 - lib/command_proposal/services/command_interpreter.rb
 - lib/command_proposal/services/runner.rb
+- lib/command_proposal/services/shut_down.rb
 - lib/command_proposal/version.rb
 - lib/generators/command_proposal/install/install_generator.rb
 - lib/generators/command_proposal/install/templates/initializer.rb