module Sidekiq::WebHelpers
This is not a public API
Constants
- RETRY_JOB_KEYS
- SAFE_QPARAMS
Public Instance Methods
add_to_head() { || ... }
click to toggle source
This view helper provide ability display you html code in to head of page. Example:
<% add_to_head do %> <link rel="stylesheet" .../> <meta .../> <% end %>
# File lib/sidekiq/web/helpers.rb, line 55 def add_to_head @head_html ||= [] @head_html << yield.dup if block_given? end
available_locales()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 35 def available_locales @@available_locales ||= locale_files.map { |path| File.basename(path, '.yml') }.uniq end
clear_caches()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 23 def clear_caches @@strings = nil @@locale_files = nil @@available_locales = nil end
csrf_tag()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 221 def csrf_tag "<input type='hidden' name='authenticity_token' value='#{session[:csrf]}'/>" end
current_path()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 168 def current_path @current_path ||= request.path_info.gsub(/^\//,'') end
current_status()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 172 def current_status workers.size == 0 ? 'idle' : 'active' end
delete_or_add_queue(job, params)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 316 def delete_or_add_queue(job, params) if params['delete'] job.delete elsif params['add_to_queue'] job.add_to_queue end end
display_args(args, truncate_after_chars = 2000)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 208 def display_args(args, truncate_after_chars = 2000) return "Invalid job payload, args is nil" if args == nil return "Invalid job payload, args must be an Array, not #{args.class.name}" if !args.is_a?(Array) begin args.map do |arg| h(truncate(to_display(arg), truncate_after_chars)) end.join(", ") rescue "Illegal job arguments: #{h args.inspect}" end end
display_custom_head()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 60 def display_custom_head @head_html.join if defined?(@head_html) end
environment_title_prefix()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 285 def environment_title_prefix environment = Sidekiq.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development' "[#{environment.upcase}] " unless environment == "production" end
filtering(*)
click to toggle source
This is a hook for a Sidekiq Pro feature. Please don't touch.
# File lib/sidekiq/web/helpers.rb, line 44 def filtering(*) end
find_locale_files(lang)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 39 def find_locale_files(lang) locale_files.select { |file| file =~ /\/#{lang}\.yml$/ } end
get_locale()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 118 def get_locale strings(locale) end
h(text)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 265 def h(text) ::Rack::Utils.escape_html(text) rescue ArgumentError => e raise unless e.message.eql?('invalid byte sequence in UTF-8') text.encode!('UTF-16', 'UTF-8', invalid: :replace, replace: '').encode!('UTF-8', 'UTF-16') retry end
job_params(job, score)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 181 def job_params(job, score) "#{score}-#{job['jid']}" end
locale()
click to toggle source
Given an Accept-Language header like “fr-FR,fr;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2” this method will try to best match the available locales to the user's preferred languages.
Inspiration taken from github.com/iain/http_accept_language/blob/master/lib/http_accept_language/parser.rb
# File lib/sidekiq/web/helpers.rb, line 97 def locale @locale ||= begin matched_locale = user_preferred_languages.map do |preferred| preferred_language = preferred.split('-', 2).first lang_group = available_locales.select do |available| preferred_language == available.split('-', 2).first end lang_group.find { |lang| lang == preferred } || lang_group.min_by(&:length) end.compact.first matched_locale || 'en' end end
locale_files()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 29 def locale_files @@locale_files ||= settings.locales.flat_map do |path| Dir["#{path}/*.yml"] end end
namespace()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 156 def namespace @ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil } end
number_with_delimiter(number)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 252 def number_with_delimiter(number) begin Float(number) rescue ArgumentError, TypeError return number end options = {delimiter: ',', separator: '.'} parts = number.to_s.to_str.split('.') parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{options[:delimiter]}") parts.join(options[:separator]) end
parse_params(params)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 185 def parse_params(params) score, jid = params.split("-", 2) [score.to_f, jid] end
poll_path()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 64 def poll_path if current_path != '' && params['poll'] root_path + current_path else "" end end
processes()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 135 def processes @processes ||= Sidekiq::ProcessSet.new end
product_version()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 291 def product_version "Sidekiq v#{Sidekiq::VERSION}" end
qparams(options)
click to toggle source
Merge options with current params, filter safe params, and stringify to query string
# File lib/sidekiq/web/helpers.rb, line 193 def qparams(options) # stringify options.keys.each do |key| options[key.to_s] = options.delete(key) end params.merge(options).map do |key, value| SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next end.compact.join("&") end
redirect_with_query(url)
click to toggle source
Any paginated list that performs an action needs to redirect back to the proper page after performing that action.
# File lib/sidekiq/web/helpers.rb, line 275 def redirect_with_query(url) r = request.referer if r && r =~ /\?/ ref = URI(r) redirect("#{url}?#{ref.query}") else redirect url end end
redis_connection()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 149 def redis_connection Sidekiq.redis do |conn| c = conn.connection "redis://#{c[:location]}/#{c[:db]}" end end
redis_connection_and_namespace()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 299 def redis_connection_and_namespace @redis_connection_and_namespace ||= begin namespace_suffix = namespace == nil ? '' : "##{namespace}" "#{redis_connection}#{namespace_suffix}" end end
redis_info()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 160 def redis_info Sidekiq.redis_info end
relative_time(time)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 176 def relative_time(time) stamp = time.getutc.iso8601 %{<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>} end
retries_with_score(score)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 143 def retries_with_score(score) Sidekiq.redis do |conn| conn.zrangebyscore('retry', score, score) end.map { |msg| Sidekiq.load_json(msg) } end
retry_extra_items(retry_job)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 244 def retry_extra_items(retry_job) @retry_extra_items ||= {}.tap do |extra| retry_job.item.each do |key, value| extra[key] = value unless RETRY_JOB_KEYS.include?(key) end end end
retry_or_delete_or_kill(job, params)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 306 def retry_or_delete_or_kill(job, params) if params['retry'] job.retry elsif params['delete'] job.delete elsif params['kill'] job.kill end end
root_path()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 164 def root_path "#{env['SCRIPT_NAME']}/" end
rtl?()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 76 def rtl? text_direction == 'rtl' end
server_utc_time()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 295 def server_utc_time Time.now.utc.strftime('%H:%M:%S UTC') end
stats()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 139 def stats @stats ||= Sidekiq::Stats.new end
strings(lang)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 9 def strings(lang) @@strings ||= {} @@strings[lang] ||= begin # Allow sidekiq-web extensions to add locale paths # so extensions can be localized settings.locales.each_with_object({}) do |path, global| find_locale_files(lang).each do |file| strs = YAML.load(File.open(file)) global.merge!(strs[lang]) end end end end
t(msg, options={})
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 122 def t(msg, options={}) string = get_locale[msg] || strings('en')[msg] || msg if options.empty? string else string % options end end
text_direction()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 72 def text_direction get_locale['TextDirection'] || 'ltr' end
to_display(arg)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 225 def to_display(arg) begin arg.inspect rescue begin arg.to_s rescue => ex "Cannot display argument: [#{ex.class.name}] #{ex.message}" end end end
truncate(text, truncate_after_chars = 2000)
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 204 def truncate(text, truncate_after_chars = 2000) truncate_after_chars && text.size > truncate_after_chars ? "#{text[0..truncate_after_chars]}..." : text end
unfiltered?() { || ... }
click to toggle source
mperham/sidekiq#3243
# File lib/sidekiq/web/helpers.rb, line 114 def unfiltered? yield unless env['PATH_INFO'].start_with?("/filter/") end
user_preferred_languages()
click to toggle source
See www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
# File lib/sidekiq/web/helpers.rb, line 81 def user_preferred_languages languages = env['HTTP_ACCEPT_LANGUAGE'] languages.to_s.downcase.gsub(/\s+/, '').split(',').map do |language| locale, quality = language.split(';q=', 2) locale = nil if locale == '*' # Ignore wildcards quality = quality ? quality.to_f : 1.0 [locale, quality] end.sort do |(_, left), (_, right)| right <=> left end.map(&:first).compact end
workers()
click to toggle source
# File lib/sidekiq/web/helpers.rb, line 131 def workers @workers ||= Sidekiq::Workers.new end