sidekiq_adhoc_job 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d343fd5493049cf0f38225bfde6a3d5329e1bf9aa97d9c57a78b2896cd615ad1
-  data.tar.gz: 3e5b08a0e5a81ab52070158ec10e64c6f92a34726244d356a096259981a0d62d
+  metadata.gz: 8c0e73d782590b6b44e800550261cb9c64414eac41a516542beeee8f77345b0a
+  data.tar.gz: 063c9caff1f9b63a7fac67bb8e033153a60531c9bbde195bc1aeb2d509dcd9b9
 SHA512:
-  metadata.gz: f0b0a21ab330712ab59a2c0a356f5ca6c1c31ff9a704b9c08ab3b5ced2f22d11deee0a831c4e1bac51592e9420f74cbfea18aa4bab5f184e44e51f9e36c17d2a
-  data.tar.gz: c37d32257e371b2cf4851733ee3f9f32a31d495e372801411c6c491aae2ce482f654e409561e8300dfa602d63d01506b6962a4e6201fcd817d8bb18fbd360964
+  metadata.gz: 27604c34ae4f16f120ed722dcb92fe4d5e8ce271f2353260f4265212bbd89b7e0ab28a1d5ac606cbfd2b66afab1ed0abeefb61ff2790dc52e09f0d6ff9b5f19a
+  data.tar.gz: 9056e87feb58fb3d38e70eb8a0d7689123bc98ee6e22d0d83f5fcdfb14497533859dd45c7bf8e58dfb8e25514205d27081e74bb3ff5e8c178e3185a82f596f89

data/lib/sidekiq_adhoc_job.rb

@@ -2,6 +2,8 @@ require 'sidekiq'
 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'
@@ -9,7 +11,12 @@ 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'
+  end
 
   def self.configure
     @_config = Configuration.new
@@ -21,24 +28,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

@@ -9,22 +9,27 @@ module SidekiqAdhocJob
         acc
       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
-      worker_klass.perform_async(*worker_params)
+      SidekiqAdhocJob.config.strategy.perform_async(worker_klass, *worker_params)
     end
 
     private
 
-    attr_reader :request_params, :worker_klass, :allowed_params, :worker_params
+    attr_reader :request_params, :worker_klass, :worker_klass_inspector,
+                :allowed_params, :worker_params
 
     def parse_params
-      @allowed_params = worker_klass.new.method(:perform).parameters.reject { |type, _| type == :rest }.flat_map(&:last)
-      @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/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/class_inspector.rb

@@ -0,0 +1,50 @@
+module SidekiqAdhocJob
+  module Utils
+    class ClassInspector
+
+      attr_reader :klass_name, :klass_obj, :method_parameters
+
+      def initialize(klass_name)
+        @klass_name = klass_name
+        @klass_obj = klass_name.new
+        @method_parameters = {}
+      end
+
+      def parameters(method_name)
+        return method_parameters[method_name] if method_parameters[method_name]
+
+        klass_method = klass_method(klass_obj.method(method_name))
+        params = klass_method
+                 .parameters
+                 .group_by { |type, _| type }
+                 .inject({}) do |acc, (type, params)|
+                   acc[type] = params.map(&:last)
+                   acc
+                 end
+
+        method_parameters[method_name] = params
+
+        params
+      end
+
+      def required_parameters(method_name)
+        parameters(method_name)[:req] || []
+      end
+
+      def optional_parameters(method_name)
+        parameters(method_name)[:opt] || []
+      end
+
+      def has_rest_parameter?(method_name)
+        !!parameters(method_name)[:rest]
+      end
+
+      def klass_method(method)
+        return method unless method.super_method
+
+        klass_method(method.super_method)
+      end
+
+    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,17 +76,29 @@ 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'
           true
         elsif input == 'false'
           false
+        elsif input == 'nil'
+          nil
         elsif (i = parse_integer(input))
           i
         elsif (f = parse_float(input))
           f
+        elsif (j = parse_json(input, symbolize: symbolize))
+          j
         else
           input
         end
@@ -103,6 +116,12 @@ module SidekiqAdhocJob
         nil
       end
 
+      def self.parse_json(input, symbolize: false)
+        JSON.parse(input, symbolize_names: symbolize)
+      rescue JSON::ParserError => _e
+        nil
+      end
+
     end
   end
 end

data/lib/sidekiq_adhoc_job/version.rb

@@ -1,3 +1,3 @@
 module SidekiqAdhocJob
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.2'.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,16 +37,9 @@ module SidekiqAdhocJob
       end
 
       def self.convert_klass_name_to_presenter(path_name, klass_name)
-        klass_obj = klass_name.new
-        queue = klass_name.sidekiq_options['queue']
-        args = klass_obj
-               .method(:perform)
-               .parameters
-               .group_by { |type, _| type }
-               .inject({}) do |acc, (type, params)|
-                 acc[type] = params.map(&:last)
-                 acc
-               end
+        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)
       end
 

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,9 +15,17 @@
         </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/>
         </div>

data/lib/sidekiq_adhoc_job/worker_classes_loader.rb

@@ -1,20 +1,11 @@
 module SidekiqAdhocJob
   class WorkerClassesLoader
-
-    VALID_QUALIFIED_CLASS_NAME ||= /\A(([A-Z]{1}[a-z]+)(::)*)+\z/
-    VALID_WORKER_CLASS_NAME ||= /^.+[^(::)]+Worker$/
-
-    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
@@ -25,28 +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
-      return unless VALID_QUALIFIED_CLASS_NAME.match?(qualified_name)
-
-      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 VALID_WORKER_CLASS_NAME.match?(qualified_name)
-        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.3
+  version: 0.2.2
 platform: ruby
 authors:
 - Goh Khoon Hiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 2020-06-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
@@ -98,14 +98,14 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.7
 description: Trigger jobs adhoc from Sidekiq web admin
@@ -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/strategy.rb
+- lib/sidekiq_adhoc_job/utils/class_inspector.rb
 - lib/sidekiq_adhoc_job/utils/string.rb
 - lib/sidekiq_adhoc_job/version.rb
 - lib/sidekiq_adhoc_job/web.rb
@@ -149,7 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Trigger jobs adhoc from Sidekiq web admin