sidekiq_adhoc_job 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c08df33b8e1dd616b297a6cc7af3b8e6a5766619bef5175a5d4bbbf673d14ca1
-  data.tar.gz: 9b8adc3d77092e4901e379b9b73c3ae65f25dac7e301b3334b55a0f109903757
+  metadata.gz: e0eb1cd817107c67f9c597017c3fd7e0fc8e79cd783b934d3b6ebc0fb69f5224
+  data.tar.gz: deaae8c8f3de455976885dddd699fd29295cdcd0ae26a013bac38190d5d5e9a1
 SHA512:
-  metadata.gz: f74a004d5b115ed9a545aa10eba699368e23e332da01dacab2e0cc09a0c786df67f5bab224213068f417fd878597018fe309d01299d45e0ef5b6cf60f6799c38
-  data.tar.gz: 2249e2a24c8ff5eb6e9e65fa487e2bab255a7e176723b57f822cd8ca1158be6b437ee6d57600c879243daed97bf53340758bfab3dda271983a525c8e41955f9a
+  metadata.gz: a5955dc23c535cfe30380fb24dabfecaa95dfb8b1bdb251d9def1ddc47bd263f0dda19cca2a2dcbaa45edcf2c974d2bebd2a2fdd371e10e19d263be757478261
+  data.tar.gz: fdb6a47dc6c58d2054f6d6d21b6c10e67a9d38efe5bd76de5dca355df28125f569b6db1ddd4ca5c648faa948cfba2b8293541e1baa7685be6ec68b9984383843

data/lib/sidekiq_adhoc_job/services/schedule_adhoc_job.rb

@@ -10,28 +10,43 @@ module SidekiqAdhocJob
       end
       @worker_klass = WorkerClassesLoader.find_worker_klass(job_name)
       @worker_klass_inspector = Utils::ClassInspector.new(worker_klass)
-      @allowed_params = worker_klass_inspector.required_parameters(:perform) + worker_klass_inspector.optional_parameters(:perform)
 
       parse_params
     end
 
     def call
-      SidekiqAdhocJob.config.strategy.perform_async(worker_klass, *worker_params)
+      SidekiqAdhocJob.config.strategy.perform_async(worker_klass, *worker_positional_params, **worker_keyword_params)
     end
 
     private
 
-    attr_reader :request_params, :worker_klass, :worker_klass_inspector,
-                :allowed_params, :worker_params
+    attr_reader :request_params, :worker_klass, :worker_klass_inspector, :worker_positional_params, :worker_keyword_params
 
     def parse_params
-      @worker_params = allowed_params
+      @worker_positional_params = positional_params
         .reject { |key| request_params[key].empty? }
         .map { |key| StringUtil.parse(request_params[key], symbolize: true) }
+      @worker_keyword_params = keyword_params
+        .each_with_object({}) { |key, obj| obj[key.to_sym] = request_params[key] }
+        .compact
       if !!request_params[:rest_args] && !request_params[:rest_args].empty?
-        @worker_params << StringUtil.parse_json(request_params[:rest_args].strip, symbolize: true)
+        @worker_positional_params << StringUtil.parse_json(request_params[:rest_args].strip, symbolize: true)
       end
     end
 
+    def allowed_params
+      worker_positional_params + worker_keyword_params
+    end
+
+    def positional_params
+      worker_klass_inspector.required_parameters(:perform) +
+        worker_klass_inspector.optional_parameters(:perform)
+    end
+
+    def keyword_params
+      worker_klass_inspector.required_kw_parameters(:perform) +
+        worker_klass_inspector.optional_kw_parameters(:perform)
+    end
+
   end
 end

data/lib/sidekiq_adhoc_job/strategies/active_job.rb

@@ -11,8 +11,8 @@ module SidekiqAdhocJob
         klass_name.queue_name
       end
 
-      def perform_async(klass, *params)
-        klass.perform_later(*params)
+      def perform_async(klass, *params, **kw_params)
+        klass.perform_later(*params, **kw_params)
       end
     end
   end

data/lib/sidekiq_adhoc_job/strategies/default.rb

@@ -11,8 +11,8 @@ module SidekiqAdhocJob
         klass_name.sidekiq_options['queue']
       end
 
-      def perform_async(klass, *params)
-        klass.perform_async(*params)
+      def perform_async(klass, *params, **kw_params)
+        klass.perform_async(*params, **kw_params)
       end
     end
   end

data/lib/sidekiq_adhoc_job/strategies/rails_application_job.rb

@@ -11,8 +11,8 @@ module SidekiqAdhocJob
         klass_name.queue_name
       end
 
-      def perform_async(klass, *params)
-        klass.perform_later(*params)
+      def perform_async(klass, *params, **kw_params)
+        klass.perform_later(*params, **kw_params)
       end
     end
   end

data/lib/sidekiq_adhoc_job/utils/class_inspector.rb

@@ -35,12 +35,20 @@ module SidekiqAdhocJob
         parameters(method_name)[:opt] || []
       end
 
+      def required_kw_parameters(method_name)
+        parameters(method_name)[:keyreq] || []
+      end
+
+      def optional_kw_parameters(method_name)
+        parameters(method_name)[:key] || []
+      end
+
       def has_rest_parameter?(method_name)
         !!parameters(method_name)[:rest]
       end
 
       def klass_method(method)
-        return method unless method.super_method
+        return method if method.owner == klass_name
 
         klass_method(method.super_method)
       end

data/lib/sidekiq_adhoc_job/version.rb

@@ -1,3 +1,3 @@
 module SidekiqAdhocJob
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/sidekiq_adhoc_job/web/job_presenter.rb

@@ -4,18 +4,29 @@ module SidekiqAdhocJob
     class JobPresenter
       include Sidekiq::WebHelpers
 
-      attr_reader :name, :path_name, :queue, :required_args, :optional_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
 
       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
         @required_args = args[:req] || []
         @optional_args = args[:opt] || []
+        @required_kw_args = args[:keyreq] || []
+        @optional_kw_args = args[:key] || []
         @has_rest_args = !!args[:rest]
+        @require_confirm = require_confirm
       end
 
       # Builds the presenter instances for the schedule hash
@@ -40,7 +51,12 @@ 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?
+        required_args.empty? && optional_args.empty? && required_kw_args.empty? && optional_kw_args.empty? && !has_rest_args
       end
 
     end

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

@@ -1,10 +1,13 @@
 en:
   adhoc_jobs: Adhoc Jobs
   adhoc_jobs_actions: Actions
+  adhoc_jobs_required_keyword_arguments: Required Keyword Arguments
+  adhoc_jobs_optional_keyword_arguments: Optional Keyword Arguments
   adhoc_jobs_required_arguments: Required Arguments
   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

@@ -8,7 +8,10 @@
         <th><%= t('adhoc_jobs_queue') %></th>
         <th><%= t('adhoc_jobs_required_arguments') %></th>
         <th><%= t('adhoc_jobs_optional_arguments') %></th>
+        <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>
@@ -20,7 +23,10 @@
           <td><%= job.queue %></td>
           <td><%= job.required_args.join(', ') %></td>
           <td><%= job.optional_args.join(', ') %></td>
+          <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,9 +2,9 @@
 
 <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.required_args.empty? && @presented_job.optional_args.empty? && !@presented_job.has_rest_args %>
+  <% if @presented_job.no_arguments? %>
     <p>No job arguments</p>
   <% else %>
     <% @presented_job.required_args.each do |arg| %>
@@ -23,6 +23,22 @@
         </div>
       </div>
     <% end %>
+    <% @presented_job.required_kw_args.each do |arg| %>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="<%= arg %>"><%= arg %>:</label>
+        <div class="col-sm-4">
+          <input class="form-control" type="text" name="<%= arg %>" id="<%= arg %>" required/>
+        </div>
+      </div>
+    <% end %>
+    <% @presented_job.optional_kw_args.each do |arg| %>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="<%= arg %>"><%= arg %>:</label>
+        <div class="col-sm-4">
+          <input class="form-control" type="text" name="<%= arg %>" id="<%= arg %>"/>
+        </div>
+      </div>
+    <% end %>
     <% if @presented_job.has_rest_args %>
       <div class="form-group row">
         <label class="col-sm-2 col-form-label" for="rest_args">Rest arguments (please provide a json string representing the arguments):</label>
@@ -39,3 +55,12 @@
     </div>
   </div>
 </form>
+
+<% if @presented_job.require_confirm %>
+  <script>
+    document.getElementById('adhoc-jobs-submit-form').addEventListener('submit', (event) => {
+      if (!confirm('Are you sure?'))
+        event.preventDefault();
+    })
+  </script>
+<% end %>

data/lib/sidekiq_adhoc_job.rb

@@ -41,7 +41,10 @@ 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
 
     def initialize
       @load_paths = []
@@ -53,6 +56,14 @@ module SidekiqAdhocJob
       Array(@module_names).map(&:to_s)
     end
 
+    def require_confirm
+      @require_confirm ||= Array(@require_confirm_worker_names).map(&:to_s)
+    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.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Goh Khoon Hiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry