sidekiq_adhoc_job 1.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66953581bfb24c498a01eaaf26fabdd822e39195179b9e3624b8eb4fd2dab287
-  data.tar.gz: 67dedc0f7f9e1d6e053f5df711c16c489e3c9e1b3996da84243e164dc224ddf5
+  metadata.gz: fc98e44d532226e46f53fbe1b7bdb0d5ad300d28298b0288f4d190d7f08cb3e3
+  data.tar.gz: 03de6a6069557e9368c4f118783ea114202262418142acb4805c441d475b25e1
 SHA512:
-  metadata.gz: bbc917b706c381e9a49d29cdd46d30efc4840d4f52a6dc4506dd05b567df8a5f86f7ba17dd09d2765931131d1bec008cf28cbd6be1bce17ecf5a7780e35c3d75
-  data.tar.gz: 371a29635a981a812fb5dd31412d656d85e2723a158dedad143610eccdc382ba5f1f3c53312ce2d4b1a229b1e49ace6f33c027aa467779b223475adc01a59980
+  metadata.gz: 56847a1d3e01b8f5b185bdc2610ae132801bd036ef99a093f99a70d85683980518d7f39cd636d7e74da7e55d9c964c587b55d17313e99aa40cb8a72130c52cfb
+  data.tar.gz: ffca00494c55f11bce5fde758b0d4ad0c3e07ac61e5d53a668abc0607c29d90b138095bf0a55084c3b2861752eb44fbd79b4dd2450ca6f460489456ecf2c712d

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 = '1.0.1'.freeze
+  VERSION = '2.1.1'.freeze
 end

data/lib/sidekiq_adhoc_job/web/job_presenter.rb

@@ -4,7 +4,7 @@ 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
 
       StringUtil ||= ::SidekiqAdhocJob::Utils::String
 
@@ -15,6 +15,8 @@ module SidekiqAdhocJob
         @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]
       end
 
@@ -43,6 +45,10 @@ module SidekiqAdhocJob
         new(klass_name, path_name, queue, args)
       end
 
+      def no_arguments?
+        required_args.empty? && optional_args.empty? && required_kw_args.empty? && optional_kw_args.empty? && !has_rest_args
+      end
+
     end
   end
 end

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

@@ -1,6 +1,8 @@
 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

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,6 +8,8 @@
         <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_actions') %></th>
       </tr>
@@ -20,9 +22,11 @@
           <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 class="text-center">
-            <a class="btn btn-warn btn-xs" href="<%= root_path %>adhoc-jobs/<%= URI.escape(job.path_name) %>">
+            <a class="btn btn-warn btn-xs" href="<%= root_path %>adhoc-jobs/<%= CGI.escape(job.path_name) %>">
               <%= t('adhoc_jobs_view_job') %>
             </a>
           </td>

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/<%= URI.escape(@presented_job.path_name) %>/schedule">
+<form method="POST" action="<%= root_path %>adhoc-jobs/<%= CGI.escape(@presented_job.path_name) %>/schedule">
   <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>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_adhoc_job
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Goh Khoon Hiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -145,9 +145,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="