sidekiq_adhoc_job 0.1.6 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b485f48179615a49f00e4a39c0ff9b7d4ffe77ef9336e331d875633c1ccdf82
-  data.tar.gz: c0f7d9316a7cff046ebe6ef03fea42206ff0c195c5e6081fe80750e5de5f98c9
+  metadata.gz: c21a2663558c918e59402c9180737fdc70f7520003413770eecaa73cabf86db8
+  data.tar.gz: f0eb1fd9b4c6e9d7b7fd52eaa157bd468bc02585438413c27b42a933097b5ca9
 SHA512:
-  metadata.gz: 427a776633fa687204e6a7d73f7ef95c0e3fc3a77995fccbb4ab84a78bd3a51c731f98ee7ffa3886df6f9e98bd735dd5a73136c2bf5f45e028d3de1a0c60edbe
-  data.tar.gz: c4897277ab341b525cd4dcf1b4943cac66ba27a46d581d91334f32eb8867c0bf300d96eb342093c10530a43d4cb0f1e85cb08b1dad852e0f746e20d1ffd6b8bd
+  metadata.gz: cc04bca685843cdc4f68758fbef688bfaaca75ab64deaaece3cb3e082dd54c028230753e1c8d7d2b8001089584c8b6a4fb578fbb2582f22fd604c0a30b492bb9
+  data.tar.gz: 5c3bb8282be7d70ff5a5937b41e7be4db4d4ab4568b302030aef2da554ede3a89e8d9b45afafbd5820b4bc68fc22b75bebb7ffbce183c9c8c773878c5bbb8fa0

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,6 +11,13 @@ require 'sidekiq_adhoc_job/web'
 
 module SidekiqAdhocJob
 
+  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
     yield @_config
@@ -20,23 +28,40 @@ module SidekiqAdhocJob
   end
 
   def self.init
-    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 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
 
 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,9 @@ module SidekiqAdhocJob
                 :allowed_params, :worker_params
 
     def parse_params
-      @worker_params = allowed_params.map { |key| StringUtil.parse(request_params[key]) }
+      @worker_params = allowed_params.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/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.6'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/sidekiq_adhoc_job/web/job_presenter.rb

@@ -38,7 +38,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/templates/jobs/show.html.erb

@@ -1,5 +1,7 @@
 <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 %>
@@ -15,7 +17,7 @@
     <% 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

@@ -2,12 +2,10 @@ module SidekiqAdhocJob
   class WorkerClassesLoader
     @_worker_klasses = {}
 
-    def self.load(module_names)
-      ObjectSpace.each_object(Class).each do |klass|
-        if worker_class?(klass) && allowed_namespace?(klass.name, allowlist: module_names)
-          @_worker_klasses[worker_path_name(klass.name)] = klass
-        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
@@ -18,21 +16,8 @@ module SidekiqAdhocJob
       @_worker_klasses[path_name]
     end
 
-    def self.worker_class?(klass)
-      klass.included_modules.include?(Sidekiq::Worker)
+    def self.require_files(load_paths)
+      Dir[File.join("", load_paths)].each { |path| require path } unless load_paths.empty?
     end
-    private_class_method :worker_class?
-
-    def self.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
-    private_class_method :allowed_namespace?
-
-    def self.worker_path_name(worker_name)
-      Utils::String.underscore(worker_name).gsub('/', '_')
-    end
-    private_class_method :worker_path_name
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_adhoc_job
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors:
 - Goh Khoon Hiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -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,9 @@ 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