sidekiq_adhoc_job 0.1.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f35c0912b36fde038556110a6a116b789aaaf62cab80bd43521e1c50eec4ec
-  data.tar.gz: 18913f33c03e1a976bafeac7fa03f575f87c43f6a325c00d92f9b22370014667
+  metadata.gz: 756b8b12f8763a43f6fdcf9608c244e7c6858cb05c7b342414377fb4f37184d3
+  data.tar.gz: 8ebbe33d96929bd6a50a5cd11a10cbd969a2d19aee72ca39e64cbca1e0a8e98c
 SHA512:
-  metadata.gz: 1790167e58fe6b6cfe2ec654e00801b31249e04041463505130f4d0857162dd4b55f2234e3ea2fb1cba1ad0d54e2601ca8d640eff7bb4e2aac94bd33f9cf0845
-  data.tar.gz: a7e0161b04b1cfbe0a7b0b7e9038f8c0802952925b33ed05ec3f356160d0ba2c9dd967f16e04bc4d9cfad70c178c31cd8311a61c434e60fc689a7cc1fc1fc76b
+  metadata.gz: eaaa17c4ef1866a26d479d24b8c7c0d7d1c26987a77aec481bf5541df9c1e65910e275f9728ec9cbc1058f05982ea9e3514bd9447a22a19034f6273badaf3e21
+  data.tar.gz: b1287b3d6205a94ef56cd4d4d7daf98dc00662b0fc40c22555678836131082cee76414d493760e52a3e395bc52130785988f38a215af00e19e0c2e7e8d74cc5c

data/lib/sidekiq_adhoc_job.rb

@@ -3,6 +3,7 @@ require 'sidekiq/web'
 
 require 'sidekiq_adhoc_job/utils/string'
 require 'sidekiq_adhoc_job/utils/class_inspector'
+require 'sidekiq_adhoc_job/strategy'
 require 'sidekiq_adhoc_job/worker_classes_loader'
 require 'sidekiq_adhoc_job/web/job_presenter'
 require 'sidekiq_adhoc_job/services/schedule_adhoc_job'
@@ -10,7 +11,13 @@ require 'sidekiq_adhoc_job/web'
 
 module SidekiqAdhocJob
 
-  InvalidConfigurationError ||= Class.new(RuntimeError)
+  StringUtil ||= Utils::String
+
+  module Strategies
+    autoload :Default, 'sidekiq_adhoc_job/strategies/default'
+    autoload :ActiveJob, 'sidekiq_adhoc_job/strategies/active_job'
+    autoload :RailsApplicationJob, 'sidekiq_adhoc_job/strategies/rails_application_job'
+  end
 
   def self.configure
     @_config = Configuration.new
@@ -22,24 +29,39 @@ module SidekiqAdhocJob
   end
 
   def self.init
-    raise InvalidConfigurationError, 'Must configure before init' unless @_config&.configured?
-
-    SidekiqAdhocJob::WorkerClassesLoader.load(@_config.module_names)
+    SidekiqAdhocJob::WorkerClassesLoader.load(@_config.module_names, load_paths: @_config.load_paths, strategy: @_config.strategy)
 
     Sidekiq::Web.register(SidekiqAdhocJob::Web)
     Sidekiq::Web.tabs['adhoc_jobs'] = 'adhoc-jobs'
     Sidekiq::Web.locales << File.expand_path('sidekiq_adhoc_job/web/locales', __dir__)
   end
 
+  def self.strategies
+    @_strategies ||= []
+  end
+
   class Configuration
-    attr_accessor :module_names
+    attr_accessor :load_paths, :module_names, :strategy_name
 
     def initialize
+      @load_paths = []
       @module_names = []
+      @strategy_name = :default
+    end
+
+    def module_names
+      Array(@module_names).map(&:to_s)
     end
 
-    def configured?
-      !@module_names.empty?
+    def strategy
+      @strategy ||= case strategy_name
+                    when :default
+                      SidekiqAdhocJob::Strategies::Default.new(module_names)
+                    else
+                      strategy_klass = SidekiqAdhocJob::Strategies.const_get(StringUtil.camelize(strategy_name.to_s).to_s)
+                      raise InvalidConfigurationError, "Invalid strategy name" unless strategy_klass
+                      strategy_klass.new(module_names)
+                    end
     end
   end
 

data/lib/sidekiq_adhoc_job/services/schedule_adhoc_job.rb

@@ -16,7 +16,7 @@ module SidekiqAdhocJob
     end
 
     def call
-      worker_klass.perform_async(*worker_params)
+      SidekiqAdhocJob.config.strategy.perform_async(worker_klass, *worker_params)
     end
 
     private
@@ -25,9 +25,11 @@ module SidekiqAdhocJob
                 :allowed_params, :worker_params
 
     def parse_params
-      @worker_params = allowed_params.map { |key| StringUtil.parse(request_params[key]) }
+      @worker_params = allowed_params
+        .reject { |key| request_params[key].empty? }
+        .map { |key| StringUtil.parse(request_params[key], symbolize: true) }
       if !!request_params[:rest_args] && !request_params[:rest_args].empty?
-        @worker_params += request_params[:rest_args].split(',').map { |arg| StringUtil.parse(arg.strip) }
+        @worker_params << StringUtil.parse_json(request_params[:rest_args].strip, symbolize: true)
       end
     end
 

data/lib/sidekiq_adhoc_job/strategies/active_job.rb

@@ -0,0 +1,19 @@
+module SidekiqAdhocJob
+  module Strategies
+    class ActiveJob
+      include SidekiqAdhocJob::Strategy
+
+      def worker_class?(klass)
+        klass.superclass&.name == 'ActiveJob::Base'
+      end
+
+      def get_queue_name(klass_name)
+        klass_name.queue_name
+      end
+
+      def perform_async(klass, *params)
+        klass.perform_later(*params)
+      end
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/strategies/default.rb

@@ -0,0 +1,19 @@
+module SidekiqAdhocJob
+  module Strategies
+    class Default
+      include SidekiqAdhocJob::Strategy
+
+      def worker_class?(klass)
+        klass.included_modules.include?(Sidekiq::Worker)
+      end
+
+      def get_queue_name(klass_name)
+        klass_name.sidekiq_options['queue']
+      end
+
+      def perform_async(klass, *params)
+        klass.perform_async(*params)
+      end
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/strategies/rails_application_job.rb

@@ -0,0 +1,19 @@
+module SidekiqAdhocJob
+  module Strategies
+    class RailsApplicationJob
+      include SidekiqAdhocJob::Strategy
+
+      def worker_class?(klass)
+        klass.superclass&.name == 'ApplicationJob'
+      end
+
+      def get_queue_name(klass_name)
+        klass_name.queue_name
+      end
+
+      def perform_async(klass, *params)
+        klass.perform_later(*params)
+      end
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/strategy.rb

@@ -0,0 +1,43 @@
+module SidekiqAdhocJob
+  module Strategy
+    def self.included(base)
+      SidekiqAdhocJob.strategies << base
+
+      base.extend ClassMethods
+      base.class_eval do
+      end
+    end
+
+    attr_reader :module_names, :worker_klasses
+
+    StringUtil ||= SidekiqAdhocJob::Utils::String
+
+    def initialize(module_names)
+      @module_names = module_names
+      @worker_klasses = {}
+    end
+
+    def load
+      ObjectSpace.each_object(Class).each do |klass|
+        next unless klass
+
+        if worker_class?(klass) && allowed_namespace?(klass.name, allowlist: module_names)
+          @worker_klasses[worker_path_name(klass.name)] = klass
+        end
+      end
+    end
+
+    def allowed_namespace?(class_name, allowlist:)
+      return true if allowlist.empty? || allowlist.include?('Module') # allow any namespace
+
+      allowlist.any? { |prefix| class_name.start_with?(prefix) }
+    end
+
+    def worker_path_name(worker_name)
+      Utils::String.underscore(worker_name).gsub('/', '_')
+    end
+
+    module ClassMethods
+    end
+  end
+end

data/lib/sidekiq_adhoc_job/utils/string.rb

@@ -1,4 +1,5 @@
 # References: https://github.com/hanami/utils/blob/master/lib/hanami/utils/string.rb
+#             https://github.com/omniauth/omniauth/blob/cc0f5522621b4a372f4dff0aa608822aa082cb60/lib/omniauth.rb#L156
 module SidekiqAdhocJob
   module Utils
     class String
@@ -75,7 +76,15 @@ module SidekiqAdhocJob
         constant
       end
 
-      def self.parse(input)
+      def self.camelize(word, first_letter_in_uppercase = true)
+        if first_letter_in_uppercase
+          word.to_s.gsub(%r{/(.?)}) { '::' + Regexp.last_match[1].upcase }.gsub(/(^|_)(.)/) { Regexp.last_match[2].upcase }
+        else
+          word.first + self.camelize(word)[1..-1]
+        end
+      end
+
+      def self.parse(input, symbolize: false)
         return unless input
 
         if input == 'true'
@@ -88,7 +97,7 @@ module SidekiqAdhocJob
           i
         elsif (f = parse_float(input))
           f
-        elsif (j = parse_json(input))
+        elsif (j = parse_json(input, symbolize: symbolize))
           j
         else
           input
@@ -107,8 +116,8 @@ module SidekiqAdhocJob
         nil
       end
 
-      def self.parse_json(input)
-        JSON.parse(input)
+      def self.parse_json(input, symbolize: false)
+        JSON.parse(input, symbolize_names: symbolize)
       rescue JSON::ParserError => _e
         nil
       end

data/lib/sidekiq_adhoc_job/version.rb

@@ -1,3 +1,3 @@
 module SidekiqAdhocJob
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.3.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, :has_rest_args, :args
+      attr_reader :name, :path_name, :queue, :required_args, :optional_args, :has_rest_args
 
       StringUtil ||= ::SidekiqAdhocJob::Utils::String
 
@@ -16,7 +16,6 @@ module SidekiqAdhocJob
         @required_args = args[:req] || []
         @optional_args = args[:opt] || []
         @has_rest_args = !!args[:rest]
-        @args = @required_args + @optional_args
       end
 
       # Builds the presenter instances for the schedule hash
@@ -38,7 +37,7 @@ module SidekiqAdhocJob
       end
 
       def self.convert_klass_name_to_presenter(path_name, klass_name)
-        queue = klass_name.sidekiq_options['queue']
+        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)

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

@@ -1,7 +1,8 @@
 en:
   adhoc_jobs: Adhoc Jobs
   adhoc_jobs_actions: Actions
-  adhoc_jobs_arguments: Required 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_name: Job Name

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

@@ -6,7 +6,8 @@
       <tr>
         <th><%= t('adhoc_jobs_name') %></th>
         <th><%= t('adhoc_jobs_queue') %></th>
-        <th><%= t('adhoc_jobs_arguments') %></th>
+        <th><%= t('adhoc_jobs_required_arguments') %></th>
+        <th><%= t('adhoc_jobs_optional_arguments') %></th>
         <th><%= t('adhoc_jobs_has_rest_arguments') %></th>
         <th><%= t('adhoc_jobs_actions') %></th>
       </tr>
@@ -17,7 +18,8 @@
         <tr>
           <td><%= job.name %></td>
           <td><%= job.queue %></td>
-          <td><%= job.args.join(', ') %></td>
+          <td><%= job.required_args.join(', ') %></td>
+          <td><%= job.optional_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) %>">

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

@@ -1,11 +1,13 @@
 <h3><%= t('adhoc_jobs') %></h3>
 
+<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">
   <input type="hidden" name="authenticity_token" value="<%= @csrf_token %>" />
-  <% if @presented_job.args.empty? && !@presented_job.has_rest_args %>
+  <% if @presented_job.required_args.empty? && @presented_job.optional_args.empty? && !@presented_job.has_rest_args %>
     <p>No job arguments</p>
   <% else %>
-    <% @presented_job.args.each do |arg| %>
+    <% @presented_job.required_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">
@@ -13,11 +15,19 @@
         </div>
       </div>
     <% end %>
+    <% @presented_job.optional_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 separate each argument by comma):</label>
+        <label class="col-sm-2 col-form-label" for="rest_args">Rest arguments (please provide a json string representing the arguments):</label>
         <div class="col-sm-4">
-          <input class="form-control" type="text" name="rest_args" id="rest_args" required/>
+          <input class="form-control" type="text" name="rest_args" id="rest_args"/>
         </div>
       </div>
     <% end %>

data/lib/sidekiq_adhoc_job/worker_classes_loader.rb

@@ -1,17 +1,11 @@
 module SidekiqAdhocJob
   class WorkerClassesLoader
-
-    StringUtil ||= Utils::String
-
     @_worker_klasses = {}
 
-    def self.load(module_names)
-      module_consts = module_names.map { |name| StringUtil.constantize(name.to_s) }
-      module_consts.each do |module_const|
-        module_const.constants.each do |sub_module_const_sym|
-          load_workers(module_const, sub_module_const_sym, @_worker_klasses)
-        end
-      end
+    def self.load(module_names, strategy:, load_paths:)
+      require_files(load_paths)
+      strategy.load
+      @_worker_klasses = strategy.worker_klasses
     end
 
     def self.worker_klasses
@@ -22,27 +16,8 @@ module SidekiqAdhocJob
       @_worker_klasses[path_name]
     end
 
-    def self.load_workers(parent_module_const, module_sym, workers)
-      qualified_name = module_sym.to_s
-
-      module_const = begin
-                       StringUtil.constantize(qualified_name)
-                     rescue NameError => _e
-                       qualified_name = [parent_module_const, module_sym].compact.join('::')
-                       begin
-                         StringUtil.constantize(qualified_name)
-                       rescue NameError => _e
-                         nil
-                       end
-                     end
-      return unless module_const && module_const.is_a?(Class)
-
-      if module_const.include?(Sidekiq::Worker)
-        path_name = StringUtil.underscore(qualified_name).gsub('/', '_')
-        workers[path_name] = module_const
-        return
-      end
+    def self.require_files(load_paths)
+      Dir[File.join("", load_paths)].each { |path| require path } unless load_paths.empty?
     end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_adhoc_job
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Goh Khoon Hiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.26.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.26.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.2.7
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.2.7
+        version: '7'
 description: Trigger jobs adhoc from Sidekiq web admin
 email:
 - gohkhoonhiang@gmail.com
@@ -117,6 +117,10 @@ extra_rdoc_files: []
 files:
 - lib/sidekiq_adhoc_job.rb
 - lib/sidekiq_adhoc_job/services/schedule_adhoc_job.rb
+- lib/sidekiq_adhoc_job/strategies/active_job.rb
+- lib/sidekiq_adhoc_job/strategies/default.rb
+- lib/sidekiq_adhoc_job/strategies/rails_application_job.rb
+- lib/sidekiq_adhoc_job/strategy.rb
 - lib/sidekiq_adhoc_job/utils/class_inspector.rb
 - lib/sidekiq_adhoc_job/utils/string.rb
 - lib/sidekiq_adhoc_job/version.rb
@@ -141,16 +145,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Trigger jobs adhoc from Sidekiq web admin