command_proposal 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fe3241c83226bc2aebbc46b3b8deaec5886dcd6ed8dea95d53e4d84510fb9c5
-  data.tar.gz: '09e82ce7d547624f6da07c2536c0c235e4205ff70e76bc8c4e20c07dcbb818da'
+  metadata.gz: 31a6d83b17c11473a1b540ed85ee8d9f9eb18e7c0e19e2a5ba3d5dec32ecec48
+  data.tar.gz: 8c98bf481ccb61042260928daf5f2b89783b9cdb577db44ff5ce6c9ddd264579
 SHA512:
-  metadata.gz: 57055fced9213819d5d0b9dfbcd3d1d28430a3f34bae8ff6b16b7b48034d68ae71e50411d5d4db90c83502fa7a1bd7ceb02e6861da8f16a558f952d16dbba7d8
-  data.tar.gz: 2288b1576b1019d3d1c937d9fa6e346e2facc4b7e58756bed2b6517fb453733c2ec256eda3dec0973c9ffff6ac5331e7b3ff7ee8d8415c241b02543737fe1209
+  metadata.gz: 0c70f51608c1d81770bf4cbe084f445da6a1aac249243e8c05ebb8fca375ef21c33d9b7bb118085d60853b483480675c4ed723ed9fd5074067fd1d12d6fc990e
+  data.tar.gz: ec49a4f24e8384a56fb24add427e26b56df0b414fb3916830b414440f92a97a6183762696f7e995f0a12baab224c7176ac1cc0a43610b1200b3ad6db9240eb0f

data/app/controllers/command_proposal/iterations_controller.rb

@@ -48,7 +48,7 @@ class ::CommandProposal::IterationsController < ::CommandProposal::EngineControl
     begin
       alter_command if params.dig(:command_proposal_iteration, :command).present?
     rescue ::CommandProposal::Services::CommandInterpreter::Error => e
-      return redirect_to cmd_path(:tasks, :error), alert: e.message
+      return redirect_to cmd_path(:error, :tasks), alert: e.message
     end
 
     sleep 0.2

data/app/helpers/command_proposal/application_helper.rb

@@ -21,9 +21,13 @@ module CommandProposal
       args << { host: host, port: nil } if host.present?
 
       begin
-        command_proposal_engine.url_for(args.compact)
+        engine.url_for(args.compact)
       rescue NoMethodError => e
-        raise "Error generating route! Please make sure `config.action_mailer.default_url_options` are set."
+        if e.message.match?(/\_(url|path)\'/)
+          raise e
+        else
+          raise "Error generating route! Please make sure `config.action_mailer.default_url_options` are set."
+        end
       end
     end
 
@@ -40,24 +44,31 @@ module CommandProposal
     end
 
     def string_path(*args)
-      [command_proposal_engine.command_proposal_tasks_url + args.shift, args.to_param.presence].compact.join("?")
+      [engine.command_proposal_tasks_url + args.shift, args.to_param.presence].compact.join("?")
+    end
+
+    def engine
+      @engine ||= begin
+        name = `rails routes | grep command_proposal_engine`[/\w*command_proposal_engine/]
+        send(name)
+      end
     end
 
     # Runner controller doesn't map to a model, so needs special handling
     def runner_path(task, iteration=nil)
       if iteration.present?
-        command_proposal_engine.command_proposal_task_runner_path(task, iteration)
+        engine.command_proposal_task_runner_path(task, iteration)
       else
-        command_proposal_engine.command_proposal_task_runner_index_path(task)
+        engine.command_proposal_task_runner_index_path(task)
       end
     end
 
     # 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)
+        engine.command_proposal_task_runner_url(task, iteration)
       else
-        command_proposal_engine.command_proposal_task_runner_index_url(task)
+        engine.command_proposal_task_runner_index_url(task)
       end
     end
   end

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?

data/app/models/command_proposal/iteration.rb

@@ -42,7 +42,7 @@ class ::CommandProposal::Iteration < ApplicationRecord
   delegate :session_type, to: :task
 
   def params
-    code.scan(/params\[[:\"\'](.*?)[\'\"]?\]/).flatten
+    code.scan(/params\[[:\"\'](.*?)[\'\"]?\]/).flatten.uniq
   end
 
   def brings

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

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

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>

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
@@ -26,6 +26,7 @@ module CommandProposal
 
       # Optional
       @proposal_callback = nil
+      @approval_callback = nil
       @success_callback = nil
       @failed_callback = nil
     end

data/lib/command_proposal/services/command_interpreter.rb

@@ -56,6 +56,8 @@ module CommandProposal
         check_can_command? && check_can_approve?
 
         @iteration.update(status: :approved, approver: @user, approved_at: Time.current)
+        proposal = ::CommandProposal::Service::ProposalPresenter.new(@iteration)
+        ::CommandProposal.configuration.approval_callback&.call(proposal)
       end
 
       def command_run
@@ -86,7 +88,11 @@ module CommandProposal
         check_can_command?
         return unless @iteration.task.console?
 
-        @task.first_iteration.update(status: :success, completed_at: Time.current)
+        if ::CommandProposal.sessions.key?("task:#{@task.id}")
+          @task.first_iteration.update(status: :success, completed_at: Time.current)
+        else
+          @task.first_iteration.update(status: :terminated, completed_at: Time.current)
+        end
         ::CommandProposal.sessions.delete("task:#{@task.id}")
       end
 

data/lib/command_proposal/services/runner.rb

@@ -125,7 +125,8 @@ module CommandProposal
 
       def results_from_exception(exc)
         klass = exc.class
-        msg = exc.try(:message) || exc.try(:body) || exc.to_s
+        # Dup to avoid frozen string errors
+        msg = (exc.try(:message) || exc.try(:body) || exc.to_s).dup
         # Remove proposal context
         msg.gsub!(/ for \#\<CommandProposal.*/, "")
         msg.gsub!(/(::)?CommandProposal::Services::Runner(::)?/, "")
@@ -142,7 +143,7 @@ module CommandProposal
 
         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]
+          eval_row_number = row[/\(eval\)\:\d+/].to_s.dup[7..-1]
           next if eval_row_number.blank?
 
           error_line = @iteration.code.split("\n")[eval_row_number.to_i - 1]

data/lib/command_proposal/version.rb

@@ -1,8 +1,3 @@
-# gem build command_proposal.gemspec
-# gam "Built version __ of gem."
-# gpo
-# gem push command_proposal-__.gem
-
 module CommandProposal
-  VERSION = '1.0.3'
+  VERSION = "1.0.7"
 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
@@ -36,6 +43,10 @@
   config.proposal_callback = Proc.new { |proposal|
     # Slack.notify("#{proposal.requester} has proposed #{proposal.name}.\n<#{proposal.url}|Click Here> to view this proposal and approve.")
   }
+  # Called when a command is approved
+  config.approval_callback = Proc.new { |proposal|
+    # Slack.notify("The task #{proposal.name} has been approved and is now ready to run.\n<#{proposal.url}|Click Here> to view.")
+  }
   # Called when a command runs and completes successfully
   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.")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_proposal
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.7
 platform: ruby
 authors:
 - Rocco Nicholls
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-28 00:00:00.000000000 Z
+date: 2021-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -147,7 +147,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Gives the ability to run approved commands through a UI in your browser
 test_files: []