command_proposal 1.0.0

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

@@ -0,0 +1,44 @@
+<%= render partial: "task_detail_table" %>
+
+<%= form_for @iteration, url: cmd_path(@iteration) do |f| %>
+  <% if current_is_author?(@iteration) %>
+
+    <% case @iteration.status.to_sym %>
+    <% 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
+        ><div contenteditable="true" autofocus=true class="line cmd-entry"></div
+      ></div>
+
+        <%= f.hidden_field :command, value: :close %>
+        <%= f.submit "Close Session" %>
+    <% when :created, nil %>
+      <% 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 %>
+    <% else %>
+      <% if @task.first_iteration.success? %>
+        <p>Session closed.</p>
+      <% end %>
+      <div class="cmd-console" read-only=true><%= render partial: "lines", locals: { lines: @lines } %></div>
+    <% end %>
+
+  <% else %>
+
+    <% if can_approve?(@iteration) && @iteration.pending? %>
+      <%= f.hidden_field :command, value: :approve %>
+      <%= f.submit "Approve!" %>
+    <% end %>
+    <% 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>
+
+  <% end %>
+<% end %>

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

@@ -0,0 +1,54 @@
+<%= 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?) %>
+    <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="">
+      <% end %>
+    </div>
+  <% end %>
+
+  <% if @iteration.approved_at? %>
+    <%= f.hidden_field :command, value: :run %>
+    <%= f.submit "Execute" %>
+  <% 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 %>
+
+  <% if current_is_author?(@iteration) %>
+
+    <% case @iteration.status&.to_sym %>
+    <% when :created, :failed, :cancelled %>
+      <% 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 :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" %>

data/app/views/command_proposal/tasks/_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/_module_show.html.erb

@@ -0,0 +1,33 @@
+<%= render partial: "task_detail_table" %>
+
+<%= form_for @iteration, url: cmd_path(@iteration) do |f| %>
+  <% if current_is_author?(@iteration) %>
+
+    <% case @iteration.status&.to_sym %>
+    <% when :created %>
+      <% 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 :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? %>
+      <%= f.hidden_field :command, value: :approve %>
+      <%= f.submit "Approve!" %>
+    <% end %>
+
+  <% end %>
+<% end %>
+
+<textarea class="cmd-terminal" readonly=true><%= @iteration&.code %></textarea>
+
+<% render partial: "past_iterations_list" %>

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

@@ -0,0 +1,20 @@
+<% if @task.iterations.many? %>
+  <table class="cmd-table">
+    <thead>
+      <th>Timestamp / Link</th>
+      <th>Status</th>
+      <!-- <th># Comments</th> -->
+      <!-- <th>Diff</th> -->
+    </thead>
+    <tbody>
+      <% @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><%= iteration.status.capitalize %></td>
+          <!-- <td><%= iteration.comments.count %></td> -->
+          <!-- <td><%= link_to "Diff", cmd_path(@task, iteration: @iteration.id, diff: iteration.id) %></td> -->
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>

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

@@ -0,0 +1,31 @@
+<table class="cmd-table">
+  <thead>
+    <th>Requester</th>
+    <th>Approver</th>
+    <th>Started</th>
+    <th>Status</th>
+    <th>Duration</th>
+  </thead>
+  <tbody>
+    <tr>
+      <td><%= @iteration&.requester_name %></td>
+      <td><%= @iteration&.approver_name %></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>
+    </tr>
+  </tbody>
+</table>
+
+<% if @iteration&.args.present? %>
+  <table class="cmd-table">
+    <tbody>
+      <% @iteration.args.each do |arg_k, arg_v| %>
+        <tr>
+          <th><%= arg_k %></th>
+          <td><%= arg_v %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>

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

@@ -0,0 +1,55 @@
+<%= render partial: "task_detail_table" %>
+
+<% if @iteration.present? %>
+  <%= form_for @iteration, url: cmd_path(@iteration) do |f| %>
+    <% @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 @iteration&.started_at? %>
+      <textarea class="cmd-terminal" readonly=true data-status="<%= @iteration.status %>" data-feed="<%= runner_path(@task, @iteration) %>"><%= @iteration&.result %></textarea>
+    <% end %>
+
+    <% if current_is_author?(@iteration) %>
+
+      <% case @iteration.status&.to_sym %>
+      <% when :created, :cancelled %>
+        <% 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 %>
+
+    <% 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 %>
+<% end %>
+
+<br>
+<textarea class="cmd-terminal" readonly=true><%= @iteration&.code %></textarea>
+
+<%= render partial: "past_iterations_list" %>

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

@@ -0,0 +1,4 @@
+<div class="cmd-wrapper">
+  <h3>Error:</h3>
+  <p><%= flash.alert.presence || "Something went wrong" %></p>
+</div>

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

@@ -0,0 +1,64 @@
+<div class="cmd-wrapper">
+  <% if @task.persisted? %>
+    <a href="<%= cmd_path(@task) %>">&larr; Back to <%= @task.session_type.capitalize %></a>
+    <h2>Edit <%= @task.name.presence || "Command" %></h2>
+  <% else %>
+    <a href="<%= cmd_path(:tasks) %>">&larr; Back to Command</a>
+    <h2>New Command</h2>
+  <% end %>
+
+  <%= form_for(@task, url: cmd_path(@task)) do |f| %>
+    <div class="cmd-field">
+      <%= f.text_field :name, placeholder: "Title", class: "cmd-input" %>
+    </div>
+
+    <div class="cmd-field">
+      <%= f.text_area :description, placeholder: "Description", class: "cmd-input" %>
+    </div>
+
+    <% unless @task.persisted? %>
+      <div class="cmd-field">
+        <p>
+          <%= f.radio_button :session_type, :task %>
+          <%= f.label :session_type, value: :task do %>
+            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, :module %>
+          <%= f.label :session_type, value: :module do %>
+            Module - An includable batch of code that can give accessible methods to a function or task. Requires approval on code changes.
+          <% end %>
+        </p>
+      </div>
+    <% end %>
+
+    <% if @task.persisted? && !@task.console? %>
+      <% if @task.function? %>
+        <p>Use <code>params[:key]</code> to reference values that can be passed in. UI will provide fields when running.</p>
+        <p>NOTE: All params will come through as strings.</p>
+      <% end %>
+
+      <div class="cmd-field">
+        <%= f.label :code %>
+        <%= f.text_area :code, class: "cmd-terminal" %>
+      </div>
+    <% end %>
+
+    <div class="cmd-submission">
+      <%= f.submit %>
+    </div>
+  <% end %>
+</div>

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

@@ -0,0 +1,44 @@
+<div class="cmd-wrapper">
+  <%= link_to "New 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| %><%=
+    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}"
+  %><% end %>
+  <br>
+  <br>
+
+  <%= form_for "", url: cmd_path(:search, :tasks, current_params.except(:search)) do |f| %>
+    <div class="cmd-flex-row">
+      <%= text_field_tag :search, params[:search], placeholder: "Search", class: "cmd-input" %>
+      <%= f.submit "Search" %>
+    </div>
+  <% end %>
+
+  <div class="cmd-index-table">
+    <% @tasks.each do |task| %>
+      <%= link_to cmd_path(task), class: "cmd-index-table-row" do %>
+        <div class="cmd-index-col cmd-col-status">
+          <div class="cmd-status" data-status="<%= task.status %>"><i class="<%= icon(task.status) %>"></i></div>
+        </div>
+        <div class="cmd-index-col cmd-col-title">
+          <div>
+            <span class="cmd-name"><%= task.name %></span>
+            <% if task.duration.present? %>
+              <span class="cmd-duration"><%= humanized_duration(task.duration) %><%= "..." unless task.primary_iteration.complete? %></span>
+            <% end %>
+          </div>
+          <div class="cmd-desc"><%= task.description %></div>
+        </div>
+        <div class="cmd-index-col cmd-col-type">
+          <div class="cmd-type"><%= task.session_type.capitalize %></div>
+        </div>
+        <div class="cmd-index-col cmd-col-info">
+          <div class="cmd-timestamp"><%= task.last_executed_at&.strftime("%b %-d '%y, %-l:%M%P") || "Never Run" %></div>
+          <div class="cmd-author"><%= task.current_iteration_by %></div>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+</div>

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

@@ -0,0 +1,10 @@
+<div class="cmd-wrapper">
+  <%= link_to "All Tasks", cmd_path(:tasks) %> | <%= link_to "Edit #{@task.session_type.humanize}", cmd_path(:edit, @task) %>
+
+  <h2><%= @task.name %></h2>
+  <% if @task.description.present? %>
+    <p><%= @task.description %></p>
+  <% end %>
+
+  <%= render partial: "#{@task.session_type}_show" %>
+</div>

data/config/routes.rb

@@ -0,0 +1,11 @@
+CommandProposal::Engine.routes.draw do
+  namespace :command_proposal, path: "/" do
+    resources :tasks, path: "/", as: :tasks do
+      post :search, on: :collection
+      get :error, on: :collection
+
+      resources :runner, only: [:create, :show]
+      resources :iterations, shallow: true
+    end
+  end
+end

data/lib/command_proposal/configuration.rb

@@ -0,0 +1,41 @@
+module CommandProposal
+  class Configuration
+    attr_accessor(
+      # Required
+      :user_class_name,
+      :role_scope,
+      :user_name,
+      :controller_var,
+      # Default
+      :approval_required,
+      # Optional
+      :proposal_callback,
+      :success_callback,
+      :failed_callback,
+    )
+
+    def initialize
+      # Default
+      @approval_required = true
+
+      # Required (if approval needed)
+      @user_class_name = nil
+      @role_scope = nil
+      @user_name = nil
+      @controller_var = nil
+
+      # Optional
+      @proposal_callback = nil
+      @success_callback = nil
+      @failed_callback = nil
+    end
+
+    def user_class
+      @user_class ||= @user_class_name&.constantize
+    end
+
+    def approval_required?
+      !!approval_required
+    end
+  end
+end

data/lib/command_proposal/engine.rb

@@ -0,0 +1,6 @@
+require "font-awesome-rails"
+
+module CommandProposal
+  class Engine < ::Rails::Engine
+  end
+end