# File lib/heroku/helpers.rb, line 270 def self.error_with_failure @@error_with_failure ||= false end
# File lib/heroku/helpers.rb, line 274 def self.error_with_failure=(new_error_with_failure) @@error_with_failure = new_error_with_failure end
# File lib/heroku/helpers.rb, line 290 def self.extended(base) extended_into << base end
# File lib/heroku/helpers.rb, line 282 def self.extended_into @@extended_into ||= [] end
# File lib/heroku/helpers.rb, line 286 def self.included(base) included_into << base end
# File lib/heroku/helpers.rb, line 278 def self.included_into @@included_into ||= [] end
DISPLAY HELPERS
# File lib/heroku/helpers.rb, line 233 def action(message, options={}) display("#{message}... ", false) Heroku::Helpers.error_with_failure = true ret = yield Heroku::Helpers.error_with_failure = false display((options[:success] || "done"), false) if @status display(", #{@status}", false) @status = nil end display ret end
# File lib/heroku/helpers.rb, line 78 def ask $stdin.gets.to_s.strip end
# File lib/heroku/helpers.rb, line 47 def confirm(message="Are you sure you wish to continue? (y/n)") display("#{message} ", false) ['y', 'yes'].include?(ask.downcase) end
# File lib/heroku/helpers.rb, line 37 def confirm_billing display display "This action will cause your account to be billed at the end of the month" display "For more information, see https://devcenter.heroku.com/articles/usage-and-billing" if confirm Heroku::Auth.client.confirm_billing true end end
# File lib/heroku/helpers.rb, line 52 def confirm_command(app_to_confirm = app, message=nil) if confirmed_app = Heroku::Command.current_options[:confirm] unless confirmed_app == app_to_confirm raise(Heroku::Command::CommandFailed, "Confirmed app #{confirmed_app} did not match the selected app #{app_to_confirm}.") end return true else display message ||= "WARNING: Destructive Action\nThis command will affect the app: #{app_to_confirm}" message << "\nTo proceed, type \"#{app_to_confirm}\" or re-run this command with --confirm #{app_to_confirm}" output_with_bang(message) display display "> ", false if ask.downcase != app_to_confirm error("Confirmation did not match #{app_to_confirm}. Aborted.") else true end end end
# File lib/heroku/helpers.rb, line 155 def create_git_remote(remote, url) return if git('remote').split("\n").include?(remote) return unless File.exists?(".git") git "remote add #{remote} #{url}" display "Git remote #{remote} added" end
# File lib/heroku/helpers.rb, line 33 def deprecate(message) display "WARNING: #{message}" end
# File lib/heroku/helpers.rb, line 20 def display(msg="", new_line=true) if new_line puts(msg) else print(msg) $stdout.flush end end
# File lib/heroku/helpers.rb, line 294 def display_header(message="", new_line=true) return if message.to_s.strip == "" display("=== " + message.to_s.split("\n").join("\n=== "), new_line) end
# File lib/heroku/helpers.rb, line 299 def display_object(object) case object when Array # list of objects object.each do |item| display_object(item) end when Hash # if all values are arrays, it is a list with headers # otherwise it is a single header with pairs of data if object.values.all? {|value| value.is_a?(Array)} object.keys.sort_by {|key| key.to_s}.each do |key| display_header(key) display_object(object[key]) hputs end end else hputs(object.to_s) end end
# File lib/heroku/helpers.rb, line 181 def display_row(row, lengths) row_data = [] row.zip(lengths).each do |column, length| format = column.is_a?(Fixnum) ? "%#{length}s" : "%-#{length}s" row_data << format % column end display(row_data.join(" ")) end
# File lib/heroku/helpers.rb, line 166 def display_table(objects, columns, headers) lengths = [] columns.each_with_index do |column, index| header = headers[index] lengths << longest([header].concat(objects.map { |o| o[column].to_s })) end lines = lengths.map {|length| "-" * length} lengths[-1] = 0 # remove padding from last column display_row headers, lengths display_row lines, lengths objects.each do |row| display_row columns.map { |column| row[column] }, lengths end end
# File lib/heroku/helpers.rb, line 261 def error(message) if Heroku::Helpers.error_with_failure display("failed") Heroku::Helpers.error_with_failure = false end $stderr.puts(format_with_bang(message)) exit(1) end
# File lib/heroku/helpers.rb, line 227 def fail(message) raise Heroku::Command::CommandFailed, message end
# File lib/heroku/helpers.rb, line 142 def format_bytes(amount) amount = amount.to_i return '(empty)' if amount == 0 return amount if amount < @@kb return "#{(amount / @@kb).round}k" if amount < @@mb return "#{(amount / @@mb).round}M" if amount < @@gb return "#{(amount / @@gb).round}G" end
# File lib/heroku/helpers.rb, line 73 def format_date(date) date = Time.parse(date).utc if date.is_a?(String) date.strftime("%Y-%m-%d %H:%M %Z").gsub('GMT', 'UTC') end
# File lib/heroku/helpers.rb, line 374 def format_error(error, message='Heroku client internal error.') formatted_error = [] formatted_error << " ! #{message}" formatted_error << ' ! Search for help at: https://help.heroku.com' formatted_error << ' ! Or report a bug at: https://github.com/heroku/heroku/issues/new' formatted_error << '' formatted_error << " Error: #{error.message} (#{error.class})" formatted_error << " Backtrace: #{error.backtrace.first}" error.backtrace[1..-1].each do |line| formatted_error << " #{line}" end if error.backtrace.length > 1 formatted_error << '' end command = ARGV.map do |arg| if arg.include?(' ') arg = %Q{"#{arg}"} else arg end end.join(' ') formatted_error << " Command: heroku #{command}" require 'heroku/auth' unless Heroku::Auth.host == Heroku::Auth.default_host formatted_error << " Host: #{Heroku::Auth.host}" end if http_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY'] formatted_error << " HTTP Proxy: #{http_proxy}" end if https_proxy = ENV['https_proxy'] || ENV['HTTPS_PROXY'] formatted_error << " HTTPS Proxy: #{https_proxy}" end plugins = Heroku::Plugin.list.sort unless plugins.empty? formatted_error << " Plugins: #{plugins.first}" plugins[1..-1].each do |plugin| formatted_error << " #{plugin}" end if plugins.length > 1 formatted_error << '' $stderr.puts end end formatted_error << " Version: #{Heroku.user_agent}" formatted_error << "\n" formatted_error.join("\n") end
# File lib/heroku/helpers.rb, line 251 def format_with_bang(message) return '' if message.to_s.strip == "" " ! " + message.split("\n").join("\n ! ") end
# File lib/heroku/helpers.rb, line 221 def get_terminal_environment { "TERM" => ENV["TERM"], "COLUMNS" => %xtput cols`.strip, "LINES" => %xtput lines`.strip } rescue { "TERM" => ENV["TERM"] } end
# File lib/heroku/helpers.rb, line 107 def git(args) return "" unless has_git? flattened_args = [args].flatten.compact.join(" ") %x{ git #{flattened_args} 2>&1 }.strip end
# File lib/heroku/helpers.rb, line 102 def has_git? %x{ git --version } $?.success? end
# File lib/heroku/helpers.rb, line 8 def home_directory running_on_windows? ? ENV['USERPROFILE'].gsub("\\","/") : ENV['HOME'] end
# File lib/heroku/helpers.rb, line 325 def hprint(string='') Kernel.print(string) $stdout.flush end
# File lib/heroku/helpers.rb, line 321 def hputs(string='') Kernel.puts(string) end
# File lib/heroku/helpers.rb, line 196 def json_decode(json) Heroku::OkJson.decode(json) rescue Heroku::OkJson::Error nil end
# File lib/heroku/helpers.rb, line 190 def json_encode(object) Heroku::OkJson.encode(object) rescue Heroku::OkJson::Error nil end
# File lib/heroku/helpers.rb, line 334 def launchy(message, url) action(message) do require("launchy") launchy = Launchy.open(url) if launchy.respond_to?(:join) launchy.join end end end
produces a printf formatter line for an array of items if an individual line item is an array, it will create columns that are lined-up
#line_formatter([“foo”, “barbaz”]) # => “%-6s” #line_formatter([“foo”, “barbaz”], [“bar”, “qux”]) # => “%-3s %-6s”
# File lib/heroku/helpers.rb, line 351 def line_formatter(array) if array.any? {|item| item.is_a?(Array)} cols = [] array.each do |item| if item.is_a?(Array) item.each_with_index { |val,idx| cols[idx] = [cols[idx]||0, (val || '').length].max } end end cols.map { |col| "%-#{col}s" }.join(" ") else "%s" end end
# File lib/heroku/helpers.rb, line 162 def longest(items) items.map { |i| i.to_s.length }.sort.last end
# File lib/heroku/helpers.rb, line 256 def output_with_bang(message="", new_line=true) return if message.to_s.strip == "" display(format_with_bang(message), new_line) end
# File lib/heroku/helpers.rb, line 151 def quantify(string, num) "%d %s" % [ num, num.to_i == 1 ? string : "#{string}s" ] end
# File lib/heroku/helpers.rb, line 29 def redisplay(line, line_break = false) display("\r\e[0K#{line}", line_break) end
# File lib/heroku/helpers.rb, line 90 def retry_on_exception(*exceptions) retry_count = 0 begin yield rescue *exceptions => ex raise ex if retry_count >= 3 sleep 3 retry_count += 1 retry end end
# File lib/heroku/helpers.rb, line 86 def run_command(command, args=[]) Heroku::Command.run(command, args) end
# File lib/heroku/helpers.rb, line 16 def running_on_a_mac? RUBY_PLATFORM =~ /-darwin\d/ end
# File lib/heroku/helpers.rb, line 12 def running_on_windows? RUBY_PLATFORM =~ /mswin32|mingw32/ end
# File lib/heroku/helpers.rb, line 202 def set_buffer(enable) with_tty do if enable %xstty icanon echo` else %xstty -icanon -echo` end end end
# File lib/heroku/helpers.rb, line 82 def shell(cmd) FileUtils.cd(Dir.pwd) {|d| return %x#{cmd}`} end
# File lib/heroku/helpers.rb, line 330 def spinner(ticks) %w(/ - \\ |)[ticks % 4] end
# File lib/heroku/helpers.rb, line 247 def status(message) @status = message end
# File lib/heroku/helpers.rb, line 462 def string_distance(first, last) distances = [] # 0x0s 0.upto(first.length) do |index| distances << [index] + [0] * last.length end distances[0] = 0.upto(last.length).to_a 1.upto(last.length) do |last_index| 1.upto(first.length) do |first_index| first_char = first[first_index - 1, 1] last_char = last[last_index - 1, 1] if first_char == last_char distances[first_index][last_index] = distances[first_index - 1][last_index - 1] # noop else distances[first_index][last_index] = [ distances[first_index - 1][last_index], # deletion distances[first_index][last_index - 1], # insertion distances[first_index - 1][last_index - 1] # substitution ].min + 1 # cost if first_index > 1 && last_index > 1 first_previous_char = first[first_index - 2, 1] last_previous_char = last[last_index - 2, 1] if first_char == last_previous_char && first_previous_char == last_char distances[first_index][last_index] = [ distances[first_index][last_index], distances[first_index - 2][last_index - 2] + 1 # transposition ].min end end end end end distances[first.length][last.length] end
# File lib/heroku/helpers.rb, line 365 def styled_array(array, options={}) fmt = line_formatter(array) array = array.sort unless options[:sort] == false array.each do |element| display((fmt % element).rstrip) end display end
# File lib/heroku/helpers.rb, line 422 def styled_error(error, message='Heroku client internal error.') if Heroku::Helpers.error_with_failure display("failed") Heroku::Helpers.error_with_failure = false end $stderr.puts(format_error(error, message)) end
# File lib/heroku/helpers.rb, line 434 def styled_hash(hash, keys=nil) max_key_length = hash.keys.map {|key| key.to_s.length}.max + 2 keys ||= hash.keys.sort {|x,y| x.to_s <=> y.to_s} keys.each do |key| case value = hash[key] when Array if value.empty? next else elements = value.sort {|x,y| x.to_s <=> y.to_s} display("#{key}: ".ljust(max_key_length), false) display(elements[0]) elements[1..-1].each do |element| display("#{' ' * max_key_length}#{element}") end if elements.length > 1 display end end when nil next else display("#{key}: ".ljust(max_key_length), false) display(value) end end end
# File lib/heroku/helpers.rb, line 430 def styled_header(header) display("=== #{header}") end
# File lib/heroku/helpers.rb, line 496 def suggestion(actual, possibilities) distances = Hash.new {|hash,key| hash[key] = []} possibilities.each do |suggestion| distances[string_distance(actual, suggestion)] << suggestion end minimum_distance = distances.keys.min if minimum_distance < 4 suggestions = distances[minimum_distance].sort if suggestions.length == 1 "Perhaps you meant `#{suggestions.first}`." else "Perhaps you meant #{suggestions[0...-1].map {|suggestion| "`#{suggestion}`"}.join(', ')} or `#{suggestions.last}`." end else nil end end
# File lib/heroku/helpers.rb, line 113 def time_ago(since) if since.is_a?(String) since = Time.parse(since) end elapsed = Time.now - since message = since.strftime("%Y/%m/%d %H:%M:%S") if elapsed <= 60 message << " (~ #{elapsed.floor}s ago)" elsif elapsed <= (60 * 60) message << " (~ #{(elapsed / 60).floor}m ago)" elsif elapsed <= (60 * 60 * 25) message << " (~ #{(elapsed / 60 / 60).floor}h ago)" end message end
# File lib/heroku/helpers.rb, line 131 def truncate(text, length) if text.size > length text[0, length - 2] + '..' else text end end
# File lib/heroku/helpers.rb, line 212 def with_tty(&block) return unless $stdin.isatty begin yield rescue # fails on windows end end