command_proposal 1.0.0

data/lib/command_proposal/services/command_interpreter.rb

@@ -0,0 +1,108 @@
+# require_relative "command_proposal/permissions_helper"
+
+module CommandProposal
+  module Services
+    class CommandInterpreter
+      class Error < StandardError; end
+      include ::CommandProposal::PermissionsHelper
+
+      def self.command(iteration, command, user, params={})
+        new(iteration, command, user, params).command
+      end
+
+      def initialize(iteration, command, user, params={})
+        @iteration = iteration
+        @task = iteration.task
+        @command = command.to_s.to_sym
+        @user = user
+        @params = params
+        command_user(@user) if @user.present?
+      end
+
+      def command
+        case @command
+        when :request then command_request
+        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
+
+        @iteration
+      end
+
+      def command_request
+        check_can_command?
+        if @iteration.complete? && (@task.task? || @task.function?)
+          previous_iteration = @iteration
+          # Creates a new iteration with the same code so we don't lose results
+          @task.user = @user # Sets the task user to assign as the requester
+          @task.update(code: @iteration.code)
+          @iteration = @task.current_iteration
+
+          if @task.function? && previous_iteration.approved_at?
+            @params.merge!(previous_iteration.attributes.slice("approved_at", "approver_id"))
+            @params.merge!(status: :approved)
+            return # Don't trigger the callback
+          end
+        end
+
+        proposal = ::CommandProposal::Service::ProposalPresenter.new(@iteration)
+        ::CommandProposal.configuration.proposal_callback&.call(proposal)
+      end
+
+      def command_approve
+        error!("Command is not ready for approval.") unless @iteration.pending?
+        check_can_command? && check_can_approve?
+
+        @iteration.update(status: :approved, approver: @user, approved_at: Time.current)
+      end
+
+      def command_run
+        check_can_command?
+
+        # Rollback the create/update if anything fails
+        ActiveRecord::Base.transaction do
+          command_request if @task.function? && @iteration.approved_at? && @iteration.complete?
+          @iteration.update(@params)
+
+          error!("Cannot run without approval.") unless has_approval?(@task)
+        end
+
+        ::CommandProposal::CommandRunnerJob.perform_later(@iteration.id)
+      end
+
+      def command_cancel
+        check_can_command?
+        return if @iteration.complete?
+
+        @iteration.update(status: :cancelling)
+      end
+
+      def command_close
+        check_can_command?
+        return unless @iteration.task.console?
+
+        @task.first_iteration.update(status: :success, completed_at: Time.current)
+        ::CommandProposal.sessions.delete("task:#{@task.id}")
+      end
+
+      def check_can_command?
+        return true if can_command?
+
+        error!("Sorry, you do not have permission to do this.")
+      end
+
+      def check_can_approve?
+        return true if can_approve?(@iteration)
+
+        error!("You cannot approve your own command.")
+      end
+
+      def error!(msg)
+        raise ::CommandProposal::Services::CommandInterpreter::Error.new(msg)
+      end
+    end
+  end
+end

data/lib/command_proposal/services/runner.rb

@@ -0,0 +1,157 @@
+module CommandProposal
+  module Services
+    class Runner
+      attr_accessor :session
+      # Add expiration and things like that...
+
+      def initialize
+        @session = session
+      end
+
+      def execute(iteration, inline=false)
+        @iteration = iteration
+        @inline = inline
+        prepare
+
+        run
+
+        complete
+        @iteration = nil
+      end
+
+      def quick_run(iteration)
+        raise CommandProposal::Error, ":#{iteration.task.friendly_id} does not have approval to run." unless iteration.approved?
+
+        @session.eval(iteration.code)
+      end
+
+      private
+
+      def session
+        binding
+      end
+
+      def prepare
+        raise CommandProposal::Error, "Cannot run task without approval" unless @iteration.approved?
+        raise CommandProposal::Error, "Modules cannot be run independently" if @iteration.task.module?
+
+        @iteration.task.update(last_executed_at: Time.current)
+        @iteration.update(started_at: Time.current, status: :started)
+      end
+
+      def run
+        begin
+          @session.eval("#{bring_function};params = #{@iteration.args || {}}.with_indifferent_access")
+        rescue Exception => e # rubocop:disable Lint/RescueException - Yes, rescue full Exception so that we can catch typos in evals as well
+          return @iteration.result = results_from_exception(e)
+        end
+
+        stored_stdout = $stdout
+        $stdout = StringIO.new
+        result = nil # Init var for scope
+
+        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.
+          rescue Exception => e # rubocop:disable Lint/RescueException - Yes, rescue full Exception so that we can catch typos in evals as well
+            @iteration.status = :failed
+
+            result = results_from_exception(e)
+          end
+        end
+
+        while running_thread.status.present?
+          @iteration.reload
+
+          if $stdout.try(:string) != @iteration.result
+            @iteration.update(result: $stdout.try(:string).dup)
+          end
+
+          running_thread.exit if @iteration.cancelling?
+
+          sleep 1
+        end
+
+        output = $stdout.try(:string)
+        output = nil if output == ""
+        # Not using presence because we want to maintain other empty objects such as [] and {}
+
+        $stdout = stored_stdout
+        @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"
+      end
+
+      def complete
+        @iteration.completed_at = Time.current
+        if @iteration.cancelling? || @iteration.cancelled?
+          @iteration.result += "\n\n~~~~~ CANCELLED ~~~~~"
+          @iteration.status = :cancelled
+        elsif @iteration.failed?
+          # No-op
+        else
+          @iteration.status = :success
+        end
+        @iteration.save!
+
+        return if @iteration.task.console? # Don't notify for every console entry
+        proposal = ::CommandProposal::Service::ProposalPresenter.new(@iteration)
+        if @iteration.success?
+          ::CommandProposal.configuration.success_callback&.call(proposal)
+        else
+          ::CommandProposal.configuration.failed_callback&.call(proposal)
+        end
+      end
+
+      def results_from_exception(exc)
+        klass = exc.class
+        msg = exc.try(:message) || exc.try(:body) || exc.to_s
+        # Remove proposal context
+        msg.gsub!(/ for \#\<CommandProposal.*/, "")
+        msg.gsub!(/(::)?CommandProposal::Services::Runner(::)?/, "")
+        # Remove gem lines
+        msg.gsub!(/\/?((\w|(\\ ))*\/)*command_proposal\/services(\/(\w|(\\ ))*)*\.\w+\:\d+\: /, "")
+        info = gather_exception_info(exc)
+
+        ["#{klass}: #{msg}", info.presence].compact.join("\n")
+      end
+
+      def gather_exception_info(exception)
+        error_info = []
+        backtrace = full_trace_from_exception(exception)
+
+        eval_trace = backtrace.select { |row| row.include?("(eval)") }.presence || []
+        eval_trace = eval_trace.map do |row|
+          eval_row_number = row[/\(eval\)\:\d+/].to_s[7..-1]
+          next if eval_row_number.blank?
+
+          error_line = @iteration.code.split("\n")[eval_row_number.to_i - 1]
+          "#{eval_row_number}: #{error_line}" if error_line.present?
+        end.compact
+        error_info += ["\n>> Command Trace"] + eval_trace if eval_trace.any?
+
+        app_trace = backtrace.select { |row|
+          row.include?("/app/") && !row.match?(/command_proposal\/(lib|app)/)
+        }.presence || []
+        error_info += ["\n>> App Trace"] + app_trace if app_trace.any?
+
+        error_info.uniq.join("\n")
+      end
+
+      def full_trace_from_exception(exception)
+        trace = exception.try(:backtrace).presence
+        return trace if trace.present?
+
+        trace = @session.send(:caller).dup
+        return trace if trace.present?
+
+        trace = caller.dup
+        trace
+      end
+    end
+  end
+end

data/lib/command_proposal/version.rb

@@ -0,0 +1,3 @@
+module CommandProposal
+  VERSION = '1.0.0'
+end

data/lib/command_proposal.rb

@@ -0,0 +1,27 @@
+require "command_proposal/configuration"
+require "command_proposal/version"
+require "command_proposal/engine"
+require "command_proposal/services/runner"
+
+module CommandProposal
+  class Error < StandardError; end
+  def self.sessions
+    @sessions ||= {}
+  end
+
+  def self.clear_sessions
+    @sessions = {}
+  end
+
+  def self.configuration
+    @configuration ||= ::CommandProposal::Configuration.new
+  end
+
+  def self.reset
+    @configuration = ::CommandProposal::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/generators/command_proposal/install/install_generator.rb

@@ -0,0 +1,28 @@
+require "rails/generators/migration"
+
+module CommandProposal
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+      desc "add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "install_command_proposal.rb", "db/migrate/install_command_proposal.rb"
+      end
+
+      def create_initializer_file
+        copy_file "initializer.rb", "config/initializers/command_proposal.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+::CommandProposal.configure do |config|
+  # Change if your base user class has a different model name
+  config.user_class_name = "User"
+
+  # Helper method used by controllers to identify the currently logged in account.
+  config.controller_var = :current_user
+
+  # 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.
+  config.role_scope = :admin
+
+  # Method called to display a user's name
+  config.user_name = :name
+
+  # Callbacks for proposal state changes
+  # `proposal` is the current proposal
+  # Methods available:
+  # `proposal.url`
+  # `proposal.type`
+  # `proposal.name`
+  # `proposal.description`
+  # `proposal.args`
+  # `proposal.code`
+  # `proposal.result`
+  # `proposal.status`
+  # `proposal.requester`
+  # `proposal.approver`
+  # `proposal.approved_at`
+  # `proposal.started_at`
+  # `proposal.completed_at`
+  # `proposal.stopped_at`
+  # `proposal.duration`
+
+  # 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.")
+  }
+  # 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.")
+  }
+  # 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.")
+  }
+end

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

@@ -0,0 +1,40 @@
+class InstallCommandProposal < ActiveRecord::Migration[5.0]
+  def change
+    create_table :command_proposal_tasks do |t|
+      # has_many :iterations
+      t.text :name
+      t.text :friendly_id
+      t.text :description
+      t.integer :session_type, default: 0 # [task, console, function]
+      t.datetime :last_executed_at
+
+      t.timestamps
+    end
+
+    create_table :command_proposal_iterations do |t|
+      # has_many :comments
+      t.belongs_to :task
+      t.text :args
+      t.text :code
+      t.text :result
+      t.integer :status, default: 0 # [created approved started failed success]
+      t.belongs_to :requester
+      t.belongs_to :approver
+      t.datetime :approved_at
+      t.datetime :started_at
+      t.datetime :completed_at
+      t.datetime :stopped_at
+
+      t.timestamps
+    end
+
+    create_table :command_proposal_comments do |t|
+      t.belongs_to :iteration
+      t.integer :line_number
+      t.belongs_to :author
+      t.text :body
+
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/command_proposal_tasks.rake

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

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: command_proposal
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rocco Nicholls
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-25 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: font-awesome-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rather than creating rake tasks, which have to go through CI/CD, then
+  some deploy process, eventually make it to production, only to be run once, and
+  then never get deleted and litter your code base- this gem allows you to create
+  command proposals via a UI that can be immediately reviewed by your peers and then
+  run- keeping a history of what happened, when, and what the results were.
+email:
+- rocco11nicholls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/command_proposal_manifest.js
+- app/assets/javascripts/command_proposal.js
+- app/assets/javascripts/command_proposal/_codemirror.js
+- app/assets/javascripts/command_proposal/_helpers.js
+- app/assets/javascripts/command_proposal/codemirror-addon-searchcursor.js
+- app/assets/javascripts/command_proposal/codemirror-keymap-sublime.js
+- app/assets/javascripts/command_proposal/codemirror-mode-ruby.js
+- app/assets/javascripts/command_proposal/console.js
+- app/assets/javascripts/command_proposal/feed.js
+- app/assets/javascripts/command_proposal/terminal.js
+- app/assets/stylesheets/command_proposal.scss
+- app/assets/stylesheets/command_proposal/_variables.scss
+- app/assets/stylesheets/command_proposal/codemirror-rubyblue.scss
+- app/assets/stylesheets/command_proposal/codemirror.scss
+- app/assets/stylesheets/command_proposal/command_proposal.scss
+- app/assets/stylesheets/command_proposal/components.scss
+- app/assets/stylesheets/command_proposal/containers.scss
+- app/assets/stylesheets/command_proposal/icons.scss
+- app/assets/stylesheets/command_proposal/tables.scss
+- app/assets/stylesheets/command_proposal/terminal.scss
+- app/controllers/command_proposal/engine_controller.rb
+- app/controllers/command_proposal/iterations_controller.rb
+- app/controllers/command_proposal/runner_controller.rb
+- app/controllers/command_proposal/tasks_controller.rb
+- app/helpers/command_proposal/application_helper.rb
+- app/helpers/command_proposal/icons_helper.rb
+- app/helpers/command_proposal/params_helper.rb
+- app/helpers/command_proposal/permissions_helper.rb
+- app/jobs/command_proposal/application_job.rb
+- app/jobs/command_proposal/command_runner_job.rb
+- app/models/command_proposal/comment.rb
+- app/models/command_proposal/iteration.rb
+- app/models/command_proposal/service/external_belong.rb
+- 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_show.html.erb
+- app/views/command_proposal/tasks/_function_show.html.erb
+- app/views/command_proposal/tasks/_lines.html.erb
+- app/views/command_proposal/tasks/_module_show.html.erb
+- app/views/command_proposal/tasks/_past_iterations_list.html.erb
+- app/views/command_proposal/tasks/_task_detail_table.html.erb
+- app/views/command_proposal/tasks/_task_show.html.erb
+- app/views/command_proposal/tasks/error.html.erb
+- app/views/command_proposal/tasks/form.html.erb
+- app/views/command_proposal/tasks/index.html.erb
+- app/views/command_proposal/tasks/show.html.erb
+- config/routes.rb
+- lib/command_proposal.rb
+- lib/command_proposal/configuration.rb
+- lib/command_proposal/engine.rb
+- lib/command_proposal/services/command_interpreter.rb
+- lib/command_proposal/services/runner.rb
+- lib/command_proposal/version.rb
+- lib/generators/command_proposal/install/install_generator.rb
+- lib/generators/command_proposal/install/templates/initializer.rb
+- lib/generators/command_proposal/install/templates/install_command_proposal.rb
+- lib/tasks/command_proposal_tasks.rake
+homepage: https://github.com/Rockster160/command_proposal
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Rockster160/command_proposal
+  source_code_uri: https://github.com/Rockster160/command_proposal
+  changelog_uri: https://github.com/Rockster160/command_proposal/blob/master/README.md
+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.1.4
+signing_key: 
+specification_version: 4
+summary: Gives the ability to run approved commands through a UI in your browser
+test_files: []