command_proposal 1.0.0

data/app/helpers/command_proposal/application_helper.rb

@@ -0,0 +1,58 @@
+module CommandProposal
+  module ApplicationHelper
+    # 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)
+      return string_path(*args) if args.first.is_a?(String)
+      model_names = [:tasks, :iterations, :comments, :task, :iteration, :comment]
+      host = nil
+      args.map! { |arg|
+        next host ||= arg.delete(:host) if arg.is_a?(Hash) && arg.key?(:host)
+        if arg.in?(model_names)
+          "command_proposal_#{arg}".to_sym
+        elsif arg == :task_iterations
+          :iterations
+        else
+          arg
+        end
+      }
+      args << { host: host, port: nil } if host.present?
+
+      begin
+        router.url_for(args.compact)
+      rescue NoMethodError => e
+        raise "Error generating route! Please make sure `default_url_options` are set."
+      end
+    end
+
+    def string_path(*args)
+      [router.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)
+      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
+      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"
+      end
+    end
+  end
+end

data/app/helpers/command_proposal/icons_helper.rb

@@ -0,0 +1,15 @@
+module CommandProposal
+  module IconsHelper
+    def icon(status)
+      {
+        created: "cmd-icon-grey fa fa-check",
+        approved: "cmd-icon-green fa fa-check",
+        started: "cmd-icon-grey fa fa-clock-o",
+        cancelling: "cmd-icon-yellow fa fa-hourglass-half",
+        cancelled: "cmd-icon-yellow 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"
+    end
+  end
+end

data/app/helpers/command_proposal/params_helper.rb

@@ -0,0 +1,63 @@
+module ::CommandProposal::ParamsHelper
+  def sort_order
+    params[:order] == "desc" ? "desc" : "asc"
+  end
+
+  def toggled_sort_order
+    params[:order] == "desc" ? "asc" : "desc"
+  end
+
+  def current_params(merged={})
+    params.except(:action, :controller, :host, :port, :authenticity_token, :utf8, :commit).to_unsafe_h.merge(merged)
+  end
+
+  def toggled_param(toggle_h)
+    toggle_key = toggle_h.keys.first
+    toggle_val = toggle_h.values.first
+
+    if params[toggle_key].to_s == toggle_val.to_s
+      cmd_path(:tasks, current_params.except(toggle_key))
+    else
+      cmd_path(:tasks, current_params(toggle_h))
+    end
+  end
+
+  def truthy?(val)
+    val.to_s.downcase.in?(["true", "t", "1"])
+  end
+
+  def true_param?(*param_keys)
+    truthy?(params&.dig(*param_keys))
+  end
+
+  def humanized_duration(seconds)
+    return "N/A" if seconds.blank?
+
+    remaining = seconds.round
+    str_parts = []
+
+    durations = {
+      w: 7 * 24 * 60 * 60,
+      d: 24 * 60 * 60,
+      h: 60 * 60,
+      m: 60,
+      s: 1,
+    }
+
+    durations.each do |label, length|
+      count_at_length = 0
+
+      while remaining > length do
+        remaining -= length
+        count_at_length += 1
+      end
+
+      next if count_at_length == 0
+
+      str_parts.push("#{count_at_length}#{label}")
+    end
+
+    return "< 1s" if str_parts.none?
+    str_parts.join(" ")
+  end
+end

data/app/helpers/command_proposal/permissions_helper.rb

@@ -0,0 +1,42 @@
+module CommandProposal
+  module PermissionsHelper
+    def can_command?(user=command_user)
+      return true unless cmd_config.approval_required?
+
+      command_user.try("#{cmd_config.role_scope}?")
+    end
+
+    def can_approve?(iteration)
+      return true unless cmd_config.approval_required?
+      return if iteration.nil?
+
+      command_user.try("#{cmd_config.role_scope}?") && !current_is_author?(iteration)
+    end
+
+    def has_approval?(task)
+      return true unless cmd_config.approval_required?
+
+      task&.approved?
+    end
+
+    def current_is_author?(iteration)
+      command_user&.id == iteration&.requester&.id
+    end
+
+    def command_user(user=nil)
+      @command_user ||= begin
+        if user.present?
+          user
+        elsif cmd_config.controller_var.blank?
+          nil
+        else
+          try(cmd_config.controller_var)
+        end
+      end
+    end
+
+    def cmd_config
+      ::CommandProposal.configuration
+    end
+  end
+end

data/app/jobs/command_proposal/application_job.rb

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

data/app/jobs/command_proposal/command_runner_job.rb

@@ -0,0 +1,11 @@
+module CommandProposal
+  class CommandRunnerJob < ApplicationJob
+    queue_as :default
+
+    def perform(iteration_id)
+      iteration = ::CommandProposal::Iteration.find(iteration_id)
+
+      ::CommandProposal::Services::Runner.new.execute(iteration)
+    end
+  end
+end

data/app/models/command_proposal/comment.rb

@@ -0,0 +1,14 @@
+# belongs_to :iteration
+# integer :line_number
+# belongs_to :author
+# text :body
+
+require "command_proposal/service/external_belong"
+
+class ::CommandProposal::Comment < ApplicationRecord
+  self.table_name = :command_proposal_comments
+  include ::CommandProposal::Service::ExternalBelong
+
+  belongs_to :iteration, optional: true
+  external_belongs_to :author
+end

data/app/models/command_proposal/iteration.rb

@@ -0,0 +1,78 @@
+# has_many :comments
+# belongs_to :task
+# text :args
+# text :code
+# text :result
+# integer :status
+# belongs_to :requester
+# belongs_to :approver
+# datetime :approved_at
+# datetime :started_at
+# datetime :completed_at
+# datetime :stopped_at
+
+# ADD: iteration_count?
+
+require "command_proposal/service/external_belong"
+require "command_proposal/service/json_wrapper"
+
+class ::CommandProposal::Iteration < ApplicationRecord
+  self.table_name = :command_proposal_iterations
+  serialize :args, ::CommandProposal::Service::JSONWrapper
+  include ::CommandProposal::Service::ExternalBelong
+
+  has_many :comments
+  belongs_to :task
+  external_belongs_to :requester
+  external_belongs_to :approver
+
+  enum status: {
+    created:    0,
+    approved:   1,
+    started:    2,
+    failed:     3,
+    cancelling: 4, # Running, but told to stop
+    cancelled:  5,
+    success:    6,
+  }
+
+  delegate :name, to: :task
+  delegate :description, to: :task
+  delegate :session_type, to: :task
+
+  def params
+    code.scan(/params\[[:\"\'](.*?)[\'\"]?\]/).flatten
+  end
+
+  def brings
+    bring_str = code.scan(/bring.*?\n/).flatten.first
+    return [] unless bring_str.present?
+
+    ::CommandProposal::Task.module.where(friendly_id: bring_str.scan(/\s+\:(\w+),?/).flatten)
+  end
+
+  def complete?
+    success? || failed? || cancelled?
+  end
+
+  def pending?
+    created?
+  end
+
+  def duration
+    return unless started_at?
+
+    (completed_at || stopped_at || Time.current) - started_at
+  end
+
+  def force_reset
+    # Debugging method. Should never actually be called.
+    update(status: :approved, result: nil, completed_at: nil, stopped_at: nil, started_at: nil)
+  end
+
+  def line_count
+    return 0 if code.blank?
+
+    code.count("\n")
+  end
+end

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

@@ -0,0 +1,48 @@
+module CommandProposal
+  module Service
+    module ExternalBelong
+      extend ActiveSupport::Concern
+
+      included do
+        def self.external_belongs_to key
+          define_getters key
+          define_setters key
+        end
+
+        def self.define_getters key
+          define_method key do
+            return if user_class.blank?
+
+            if role_scope.present?
+              user_class.send(role_scope).find_by(id: public_send("#{key}_id"))
+            else
+              user_class.find_by(id: public_send("#{key}_id"))
+            end
+          end
+
+          define_method "#{key}_name" do
+            public_send(key)&.public_send(user_name)
+          end
+        end
+
+        def self.define_setters key
+          define_method "#{key}=" do |obj|
+            self.send("#{key}_id=", obj&.id)
+          end
+        end
+
+        def user_class
+          ::CommandProposal.configuration.user_class
+        end
+
+        def role_scope
+          ::CommandProposal.configuration.role_scope
+        end
+
+        def user_name
+          ::CommandProposal.configuration.user_name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module CommandProposal
+  module Service
+    class JSONWrapper
+      # Allows directly setting pre-stringified JSON.
+      def self.dump(obj)
+        return obj if obj.is_a?(String)
+
+        JSON.dump(obj)
+      end
+
+      def self.load(str)
+        return {} unless str.present?
+
+        JSON.parse(str).with_indifferent_access
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module CommandProposal
+  module Service
+    class ProposalPresenter
+      include ::CommandProposal::ApplicationHelper
+      attr_accessor :iteration
+
+      def initialize(iteration)
+        @iteration = iteration
+      end
+
+      delegate :name, to: :iteration
+      delegate :description, to: :iteration
+      delegate :args, to: :iteration
+      delegate :code, to: :iteration
+      delegate :status, to: :iteration
+      delegate :approved_at, to: :iteration
+      delegate :started_at, to: :iteration
+      delegate :completed_at, to: :iteration
+      delegate :stopped_at, to: :iteration
+      delegate :duration, to: :iteration
+
+      def url(host: nil)
+        cmd_path(@iteration.task, host: host)
+      end
+
+      def requester
+        @iteration.requester_name
+      end
+
+      def approver
+        @iteration.approver_name
+      end
+
+      def type
+        @iteration.session_type
+      end
+    end
+  end
+end

data/app/models/command_proposal/task.rb

@@ -0,0 +1,106 @@
+# has_many :iterations
+# text :name
+# text :friendly_id
+# text :description
+# integer :session_type
+# datetime :last_executed_at
+
+class ::CommandProposal::Task < ApplicationRecord
+  self.table_name = :command_proposal_tasks
+  attr_accessor :user
+
+  has_many :iterations
+  has_many :ordered_iterations, -> { order(created_at: :desc) }, class_name: "CommandProposal::Iteration"
+
+  scope :search, ->(text) {
+    where("name ILIKE :q OR description ILIKE :q", q: "%#{text}%")
+  }
+
+  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,
+    # Modules are included in tasks and not run independently
+    module:   3,
+  }
+
+  validates :name, presence: true
+
+  after_initialize -> { self.session_type ||= :task }
+  before_save -> { self.friendly_id = to_param }
+
+  delegate :line_count, to: :current_iteration, allow_nil: true
+  delegate :code, to: :current_iteration, allow_nil: true
+  delegate :result, to: :current_iteration, allow_nil: true
+  delegate :status, to: :primary_iteration, allow_nil: true
+  delegate :duration, to: :primary_iteration, allow_nil: true
+
+  def lines
+    iterations.order(created_at: :asc).where.not(id: first_iteration.id)
+  end
+
+  def to_param
+    friendly_id || generate_friendly_id
+  end
+
+  def approved?
+    primary_iteration&.approved_at?
+  end
+
+  def first_iteration
+    ordered_iterations.last
+  end
+
+  def current_iteration
+    ordered_iterations.first
+  end
+
+  def primary_iteration
+    console? ? first_iteration : current_iteration
+  end
+
+  def current_iteration_at
+    current_iteration&.completed_at
+  end
+
+  def current_iteration_by
+    current_iteration&.requester_name
+  end
+
+  def started_at
+    iterations.minimum(:started_at)
+  end
+
+  def completed_at
+    iterations.maximum(:completed_at)
+  end
+
+  def code=(new_code)
+    iterations.create(code: new_code, requester: user)
+  end
+
+  private
+
+  def reserved_names
+    [
+      "new",
+      "edit",
+    ]
+  end
+
+  def generate_friendly_id
+    return if name.blank?
+    temp_id = name.downcase.gsub(/\s+/, "_").gsub(/[^a-z_]/, "")
+
+    loop do
+      duplicate_names = self.class.where(friendly_id: temp_id).where.not(id: id)
+
+      return temp_id if duplicate_names.none? && reserved_names.exclude?(temp_id)
+
+      temp_id = "#{temp_id}_#{duplicate_names.count}"
+    end
+  end
+end