sidekiq_adhoc_job 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ece8cf911f7c7046c4d59ad86410a7bc872134b5bf6f547c83e2455c8a10bc6c
-  data.tar.gz: b19931f872a2f0b2cfb0bcae70fba1d536442d6b162f9a8a0696a1e125ebfd71
+  metadata.gz: 96ab7b918f79f69babbe8ef14bc9d697b9f14c9ea0ede25ee3af10b5a10068f6
+  data.tar.gz: '069bb2cce767dbfd9a9dcd08db9e8e56a3da12c6bb786d42dc843d5e12a77019'
 SHA512:
-  metadata.gz: 5b47320bbb8f31dcc3ad5726cc2394f3b15388fbb0a62b5cc137e32ba87972f971569c8a36b33a6d7ab5c3b58ecebe42f5c978d8d4cee97124fd74a34dfd7b81
-  data.tar.gz: 35bd8f61906e60b27da27bbea92016a868ad38d7a5d0bd2597c034b1820b214afbb13945773725f1c6f05aeafe12c6821ac06fffb9c4a33b7132f5f5b929ab07
+  metadata.gz: 03c23e8eff7b09ec21fba9009f64fd98a74005b82a789ef143d87878b4283441d90667d9674004c085e02e297e3e6b64f964b4f0bd7b2a8ccfe6535a05cdafae
+  data.tar.gz: cd7c6c9dc6cd04664738b3c7b445fc6cb9d2038f5d7523a05f9c223edccd06fabf63db42060dcbf5b0de2b1e704bddf9bb5399e06aca6128d0cbacd6d1025847

data/lib/sidekiq_adhoc_job/version.rb

@@ -1,3 +1,3 @@
 module SidekiqAdhocJob
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.1'.freeze
 end

data/lib/sidekiq_adhoc_job/web/job_presenter.rb

@@ -4,12 +4,21 @@ module SidekiqAdhocJob
     class JobPresenter
       include Sidekiq::WebHelpers
 
-      attr_reader :name, :path_name, :queue, :required_args, :optional_args, :required_kw_args, :optional_kw_args, :has_rest_args
+      attr_reader :name,
+                  :path_name,
+                  :queue,
+                  :required_args,
+                  :optional_args,
+                  :required_kw_args,
+                  :optional_kw_args,
+                  :has_rest_args,
+                  :require_confirm,
+                  :confirm_prompt_message
 
       StringUtil ||= ::SidekiqAdhocJob::Utils::String
 
       # args: { req: [], opt: [] }
-      def initialize(name, path_name, queue, args)
+      def initialize(name, path_name, queue, args, require_confirm)
         @name = name
         @path_name = path_name
         @queue = queue
@@ -18,6 +27,8 @@ module SidekiqAdhocJob
         @required_kw_args = args[:keyreq] || []
         @optional_kw_args = args[:key] || []
         @has_rest_args = !!args[:rest]
+        @require_confirm = require_confirm
+        @confirm_prompt_message = SidekiqAdhocJob.config.require_confirm_prompt_message
       end
 
       # Builds the presenter instances for the schedule hash
@@ -42,7 +53,8 @@ module SidekiqAdhocJob
         queue = SidekiqAdhocJob.config.strategy.get_queue_name(klass_name)
         class_inspector = SidekiqAdhocJob::Utils::ClassInspector.new(klass_name)
         args = class_inspector.parameters(:perform)
-        new(klass_name, path_name, queue, args)
+        require_confirm = SidekiqAdhocJob.config.require_confirmation?(klass_name.to_s)
+        new(klass_name, path_name, queue, args, require_confirm)
       end
 
       def no_arguments?

data/lib/sidekiq_adhoc_job/web/locales/en.yml

@@ -7,6 +7,7 @@ en:
   adhoc_jobs_optional_arguments: Optional Arguments
   adhoc_jobs_go_back: Go Back
   adhoc_jobs_has_rest_arguments: Has Rest Arguments
+  adhoc_jobs_confirm_required: Confirm Required
   adhoc_jobs_name: Job Name
   adhoc_jobs_queue: Job Queue
   adhoc_jobs_run_job: Run Job

data/lib/sidekiq_adhoc_job/web/routes/jobs/index.rb

@@ -5,7 +5,7 @@ module SidekiqAdhocJob
 
         def self.register(app)
           app.get '/adhoc-jobs' do
-            @presented_jobs = SidekiqAdhocJob::Web::JobPresenter.build_collection
+            @presented_jobs = SidekiqAdhocJob::Web::JobPresenter.build_collection.sort_by { |j| j.name.to_s }
 
             erb File.read(File.join(VIEW_PATH, 'jobs/index.html.erb'))
           end

data/lib/sidekiq_adhoc_job/web/templates/jobs/index.html.erb

@@ -11,6 +11,7 @@
         <th><%= t('adhoc_jobs_required_keyword_arguments') %></th>
         <th><%= t('adhoc_jobs_optional_keyword_arguments') %></th>
         <th><%= t('adhoc_jobs_has_rest_arguments') %></th>
+        <th><%= t('adhoc_jobs_confirm_required') %></th>
         <th><%= t('adhoc_jobs_actions') %></th>
       </tr>
     </thead>
@@ -25,6 +26,7 @@
           <td><%= job.required_kw_args.join(', ') %></td>
           <td><%= job.optional_kw_args.join(', ') %></td>
           <td><%= job.has_rest_args %></td>
+          <td><%= job.require_confirm %></td>
           <td class="text-center">
             <a class="btn btn-warn btn-xs" href="<%= root_path %>adhoc-jobs/<%= CGI.escape(job.path_name) %>">
               <%= t('adhoc_jobs_view_job') %>

data/lib/sidekiq_adhoc_job/web/templates/jobs/show.html.erb

@@ -2,7 +2,7 @@
 
 <h4><%= SidekiqAdhocJob::Utils::String.classify(@presented_job.path_name) %></h4>
 
-<form method="POST" action="<%= root_path %>adhoc-jobs/<%= CGI.escape(@presented_job.path_name) %>/schedule">
+<form method="POST" action="<%= root_path %>adhoc-jobs/<%= CGI.escape(@presented_job.path_name) %>/schedule" id="adhoc-jobs-submit-form">
   <input type="hidden" name="authenticity_token" value="<%= @csrf_token %>" />
   <% if @presented_job.no_arguments? %>
     <p>No job arguments</p>
@@ -55,3 +55,13 @@
     </div>
   </div>
 </form>
+
+<% if @presented_job.require_confirm %>
+  <script>
+    document.getElementById('adhoc-jobs-submit-form').addEventListener('submit', (event) => {
+      const confirmPrompt = "<%= @presented_job.confirm_prompt_message %>";
+      if (prompt(`Please enter "${confirmPrompt}" to confirm`) !== confirmPrompt)
+        event.preventDefault();
+    })
+  </script>
+<% end %>

data/lib/sidekiq_adhoc_job.rb

@@ -41,18 +41,38 @@ module SidekiqAdhocJob
   end
 
   class Configuration
-    attr_accessor :load_paths, :module_names, :strategy_name
+    attr_accessor :load_paths,
+                  :module_names,
+                  :strategy_name,
+                  :require_confirm_worker_names
+
+    attr_reader :require_confirm_prompt_message
 
     def initialize
       @load_paths = []
       @module_names = []
       @strategy_name = :default
+      @require_confirm_prompt_message = 'confirm'
     end
 
     def module_names
       Array(@module_names).map(&:to_s)
     end
 
+    def require_confirm
+      @require_confirm ||= Array(@require_confirm_worker_names).map(&:to_s)
+    end
+
+    def require_confirm_prompt_message=(message)
+      raise 'require_confirm_prompt_message must be string' unless message.is_a? String
+
+      @require_confirm_prompt_message = message
+    end
+
+    def require_confirmation?(worker_name)
+      require_confirm.include?(worker_name)
+    end
+
     def strategy
       @strategy ||= case strategy_name
                     when :default

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_adhoc_job
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Goh Khoon Hiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry