module Backburner module Helpers # Loads in instance and class levels def self.included(base) base.extend self end # Prints out exception_message based on specified e def exception_message(e) msg = [ "Exception #{e.class} -> #{e.message}" ] base = File.expand_path(Dir.pwd) + '/' e.backtrace.each do |t| msg << " #{File.expand_path(t).gsub(/#{base}/, '')}" end if e.backtrace msg.join("\n") end # Given a word with dashes, returns a camel cased version of it. # # @example # classify('job-name') # => 'JobName' # def classify(dashed_word) dashed_word.to_s.split('-').each { |part| part[0] = part[0].chr.upcase }.join end # Given a class, dasherizes the name, used for getting tube names # # @example # dasherize('JobName') # => "job-name" # def dasherize(word) classify(word).to_s.gsub(/::/, '/'). gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2'). gsub(/([a-z\d])([A-Z])/,'\1_\2'). tr("_", "-").downcase end # Tries to find a constant with the name specified in the argument string: # # @example # constantize("Module") # => Module # constantize("Test::Unit") # => Test::Unit # # NameError is raised when the constant is unknown. def constantize(camel_cased_word) camel_cased_word = camel_cased_word.to_s if camel_cased_word.include?('-') camel_cased_word = classify(camel_cased_word) end names = camel_cased_word.split('::') names.shift if names.empty? || names.first.empty? constant = Object names.each do |name| args = Module.method(:const_get).arity != 1 ? [false] : [] if constant.const_defined?(name, *args) constant = constant.const_get(name) else constant = constant.const_missing(name) end end constant end # Returns configuration options for backburner # # @example # queue_config.max_job_retries => 3 # def queue_config Backburner.configuration end # Expands a tube to include the prefix # # @example # expand_tube_name("foo_with_settings:3:100:6") # => .foo_with_settings # expand_tube_name("foo") # => .foo # expand_tube_name(FooJob) # => .foo-job # def expand_tube_name(tube) prefix = queue_config.tube_namespace separator = queue_config.namespace_separator queue_name = if tube.is_a?(String) tube elsif tube.respond_to?(:queue) # use queue name queue = tube.queue queue.is_a?(Proc) ? queue.call(tube) : queue elsif tube.is_a?(Proc) tube.call elsif tube.is_a?(Class) # no queue name, use default queue_config.primary_queue # tube.name else # turn into a string tube.to_s end [prefix.gsub(/\.$/, ''), dasherize(queue_name).gsub(/^#{prefix}/, '')].join(separator).gsub(/#{Regexp::escape(separator)}+/, separator).split(':').first end # Resolves job priority based on the value given. Can be integer, a class or nothing # # @example # resolve_priority(1000) => 1000 # resolve_priority(FooBar) => # resolve_priority(nil) => # def resolve_priority(pri) if pri.respond_to?(:queue_priority) resolve_priority(pri.queue_priority) elsif pri.is_a?(String) || pri.is_a?(Symbol) # named priority resolve_priority(Backburner.configuration.priority_labels[pri.to_sym]) elsif pri.is_a?(Integer) # numerical pri else # default Backburner.configuration.default_priority end end # Resolves job respond timeout based on the value given. Can be integer, a class or nothing # # @example # resolve_respond_timeout(1000) => 1000 # resolve_respond_timeout(FooBar) => # resolve_respond_timeout(nil) => # def resolve_respond_timeout(ttr) if ttr.respond_to?(:queue_respond_timeout) resolve_respond_timeout(ttr.queue_respond_timeout) elsif ttr.is_a?(Integer) # numerical ttr else # default Backburner.configuration.respond_timeout end end # Resolves max retries based on the value given. Can be integer, a class or nothing # # @example # resolve_max_job_retries(5) => 5 # resolve_max_job_retries(FooBar) => # resolve_max_job_retries(nil) => # def resolve_max_job_retries(retries) if retries.respond_to?(:queue_max_job_retries) resolve_max_job_retries(retries.queue_max_job_retries) elsif retries.is_a?(Integer) # numerical retries else # default Backburner.configuration.max_job_retries end end # Resolves retry delay based on the value given. Can be integer, a class or nothing # # @example # resolve_retry_delay(5) => 5 # resolve_retry_delay(FooBar) => # resolve_retry_delay(nil) => # def resolve_retry_delay(delay) if delay.respond_to?(:queue_retry_delay) resolve_retry_delay(delay.queue_retry_delay) elsif delay.is_a?(Integer) # numerical delay else # default Backburner.configuration.retry_delay end end # Resolves retry delay proc based on the value given. Can be proc, a class or nothing # # @example # resolve_retry_delay_proc(proc) => proc # resolve_retry_delay_proc(FooBar) => # resolve_retry_delay_proc(nil) => # def resolve_retry_delay_proc(proc) if proc.respond_to?(:queue_retry_delay_proc) resolve_retry_delay_proc(proc.queue_retry_delay_proc) elsif proc.is_a?(Proc) proc else # default Backburner.configuration.retry_delay_proc end end end # Helpers end # Backburner