The methods defined on {Text} are available to custom commands via {Pry::Command#text}.
Returns text as bold text for use on a terminal. Pry.color must be true for this method to perform any transformations.
@param [String, to_s] text @return [String] text
# File lib/pry/helpers/text.rb, line 45 def bold text Pry.color ? "\e[1m#{text}\e[0m" : text.to_s end
Returns `text` in the default foreground colour. Use this instead of "black" or "white" when you mean absence of colour.
@param [String, to_s] text @return [String]
# File lib/pry/helpers/text.rb, line 54 def default(text) text.to_s end
Returns text indented by chars spaces.
@param [String] text @param [Fixnum] chars
# File lib/pry/helpers/text.rb, line 99 def indent(text, chars) text.lines.map { |l| "#{' ' * chars}#{l}" }.join end
Executes the block with `Pry.color` set to false. @yield @return [void]
# File lib/pry/helpers/text.rb, line 62 def no_color &block boolean = Pry.config.color Pry.config.color = false yield ensure Pry.config.color = boolean end
Executes the block with `Pry.config.pager` set to false. @yield @return [void]
# File lib/pry/helpers/text.rb, line 73 def no_pager &block boolean = Pry.config.pager Pry.config.pager = false yield ensure Pry.config.pager = boolean end
Remove any color codes from text.
@param [String, to_s] text @return [String] text stripped of any color codes.
# File lib/pry/helpers/text.rb, line 36 def strip_color text text.to_s.gsub(/\e\[.*?(\d)+m/ , '') end
Returns text in a numbered list, beginning at offset.
@param [each_line] text @param [Fixnum] offset @return [String]
# File lib/pry/helpers/text.rb, line 86 def with_line_numbers(text, offset, color=:blue) lines = text.each_line.to_a max_width = (offset + lines.count).to_s.length lines.each_with_index.map do |line, index| adjusted_index = (index + offset).to_s.rjust(max_width) "#{self.send(color, adjusted_index)}: #{line}" end.join end
Generated with the Darkfish Rdoc Generator 2.