我如何使用Ruby来着色文本输出到终端?

使用Ruby,我如何在终端中为输出执行背景和前景文本着色?

我记得,在编程Pascal时,我们都习惯编写自己的textcolor(…)程序,以使我们的小教育程序看起来更漂亮,更有代表性。

我该如何在Ruby中编写类似的代码呢?核心库中是否有任何内置的支持来实现这一点?如果不是,什么是添加它的惯用方式?

168310 次浏览

这可能会帮助你:彩色红宝石输出

您可以在控制台中使用ANSI转义序列来完成此操作。我知道这适用于Linux和Mac OS X,但我不确定Windows控制台(cmd)是否支持ANSI。

我是用Java写的,但思想是一样的。

// Foreground color
public static final String BLACK_TEXT()   { return "\033[30m";}
public static final String RED_TEXT()     { return "\033[31m";}
public static final String GREEN_TEXT()   { return "\033[32m";}
public static final String BROWN_TEXT()   { return "\033[33m";}
public static final String BLUE_TEXT()    { return "\033[34m";}
public static final String MAGENTA_TEXT() { return "\033[35m";}
public static final String CYAN_TEXT()    { return "\033[36m";}
public static final String GRAY_TEXT()    { return "\033[37m";}


// Background color
public static final String BLACK_BACK()   { return "\033[40m";}
public static final String RED_BACK()     { return "\033[41m";}
public static final String GREEN_BACK()   { return "\033[42m";}
public static final String BROWN_BACK()   { return "\033[43m";}
public static final String BLUE_BACK()    { return "\033[44m";}
public static final String MAGENTA_BACK() { return "\033[45m";}
public static final String CYAN_BACK()    { return "\033[46m";}
public static final String WHITE_BACK()   { return "\033[47m";}


// ANSI control characters
public static final String RESET_COLORS() { return "\033[0m";}
public static final String BOLD_ON()      { return "\033[1m";}
public static final String BLINK_ON()     { return "\033[5m";}
public static final String REVERSE_ON()   { return "\033[7m";}
public static final String BOLD_OFF()     { return "\033[22m";}
public static final String BLINK_OFF()    { return "\033[25m";}
public static final String REVERSE_OFF()  { return "\033[27m";}

着色是我最喜欢的宝石!: -)

看看吧:

https://github.com/fazibear/colorize

安装:

gem install colorize

用法:

require 'colorize'


puts "I am now red".red
puts "I am now blue".blue
puts "Testing".yellow

我发现了一些:

http://github.com/ssoroka/ansi/tree/master

例子:

puts ANSI.color(:red) { "hello there" }
puts ANSI.color(:green) + "Everything is green now" + ANSI.no_color

http://flori.github.com/term-ansicolor/

例子:

print red, bold, "red bold", reset, "\n"
print red(bold("red bold")), "\n"
print red { bold { "red bold" } }, "\n"

http://github.com/sickill/rainbow

例子:

puts "this is red".foreground(:red) + " and " + "this on yellow bg".background(:yellow) + " and " + "even bright underlined!".underline.bright

如果你在Windows上,你可能需要做一个“gem install win32console”来启用对颜色的支持。

另外,如果你需要创建自己的gem,文章为控制台ruby脚本输出上色也很有用。它解释了如何向字符串添加ANSI着色。你可以用这个知识把它包装在一些类中,这些类扩展了字符串或其他东西。

结合上面的答案,您可以实现一些类似于gem colorize的东西,而不需要另一个依赖项。

class String
# colorization
def colorize(color_code)
"\e[#{color_code}m#{self}\e[0m"
end


def red
colorize(31)
end


def green
colorize(32)
end


def yellow
colorize(33)
end


def blue
colorize(34)
end


def pink
colorize(35)
end


def light_blue
colorize(36)
end
end

以下是我不需要任何宝石就能让它工作的方法:

def red(mytext) ; "\e[31m#{mytext}\e[0m" ; end
puts red("hello world")

然后,只有引号中的文本是有颜色的,您将返回到定期安排的节目。

作为String类方法(仅限Unix):

class String
def black;          "\e[30m#{self}\e[0m" end
def red;            "\e[31m#{self}\e[0m" end
def green;          "\e[32m#{self}\e[0m" end
def brown;          "\e[33m#{self}\e[0m" end
def blue;           "\e[34m#{self}\e[0m" end
def magenta;        "\e[35m#{self}\e[0m" end
def cyan;           "\e[36m#{self}\e[0m" end
def gray;           "\e[37m#{self}\e[0m" end


def bg_black;       "\e[40m#{self}\e[0m" end
def bg_red;         "\e[41m#{self}\e[0m" end
def bg_green;       "\e[42m#{self}\e[0m" end
def bg_brown;       "\e[43m#{self}\e[0m" end
def bg_blue;        "\e[44m#{self}\e[0m" end
def bg_magenta;     "\e[45m#{self}\e[0m" end
def bg_cyan;        "\e[46m#{self}\e[0m" end
def bg_gray;        "\e[47m#{self}\e[0m" end


def bold;           "\e[1m#{self}\e[22m" end
def italic;         "\e[3m#{self}\e[23m" end
def underline;      "\e[4m#{self}\e[24m" end
def blink;          "\e[5m#{self}\e[25m" end
def reverse_color;  "\e[7m#{self}\e[27m" end
end

和用法:

puts "I'm back green".bg_green
puts "I'm red and back cyan".red.bg_cyan
puts "I'm bold and green and backround red".bold.green.bg_red

在我的控制台:

Enter image description here

此外,

def no_colors
self.gsub /\e\[\d+m/, ""
end

删除格式化字符。

请注意

puts "\e[31m" # set format (red foreground)
puts "\e[0m"   # clear format
puts "green-#{"red".red}-green".green # will be green-red-normal, because of \e[0

根据Erik Skoglund和其他人的回答,我写了一个小方法来测试基本的颜色模式。

#outputs color table to console, regular and bold modes
def colortable
names = %w(black red green yellow blue pink cyan white default)
fgcodes = (30..39).to_a - [38]


s = ''
reg  = "\e[%d;%dm%s\e[0m"
bold = "\e[1;%d;%dm%s\e[0m"
puts '                       color table with these background codes:'
puts '          40       41       42       43       44       45       46       47       49'
names.zip(fgcodes).each {|name,fg|
s = "#{fg}"
puts "%7s "%name + "#{reg}  #{bold}   "*9 % [fg,40,s,fg,40,s,  fg,41,s,fg,41,s,  fg,42,s,fg,42,s,  fg,43,s,fg,43,s,
fg,44,s,fg,44,s,  fg,45,s,fg,45,s,  fg,46,s,fg,46,s,  fg,47,s,fg,47,s,  fg,49,s,fg,49,s ]
}
end
< p >示例输出: ruby colortest

.

我发现前面的答案很有用。然而,如果我想使用任何第三方库为日志输出没有这样的东西着色,它们就不符合要求。下面的方法帮我解决了这个问题:

red = 31
green = 32
blue = 34


def color (color=blue)
printf "\033[#{color}m";
yield
printf "\033[0m"
end


color { puts "this is blue" }
color(red) { logger.info "and this is red" }

我发明了这个方法。这不是什么大事,但很有效:

def colorize(text, color = "default", bgColor = "default")
colors = {"default" => "38","black" => "30","red" => "31","green" => "32","brown" => "33", "blue" => "34", "purple" => "35",
"cyan" => "36", "gray" => "37", "dark gray" => "1;30", "light red" => "1;31", "light green" => "1;32", "yellow" => "1;33",
"light blue" => "1;34", "light purple" => "1;35", "light cyan" => "1;36", "white" => "1;37"}
bgColors = {"default" => "0", "black" => "40", "red" => "41", "green" => "42", "brown" => "43", "blue" => "44",
"purple" => "45", "cyan" => "46", "gray" => "47", "dark gray" => "100", "light red" => "101", "light green" => "102",
"yellow" => "103", "light blue" => "104", "light purple" => "105", "light cyan" => "106", "white" => "107"}
color_code = colors[color]
bgColor_code = bgColors[bgColor]
return "\033[#{bgColor_code};#{color_code}m#{text}\033[0m"
end

下面是如何使用它:

puts "#{colorize("Hello World")}"
puts "#{colorize("Hello World", "yellow")}"
puts "#{colorize("Hello World", "white","light red")}"

可能的改进包括:

  • colorsbgColors在每次调用方法时都被定义,并且它们不会改变。
  • 添加其他选项,如boldunderlinedim等。

此方法不适用于p,因为p对其参数执行inspect。例如:

p "#{colorize("Hello World")}"

将显示“\e[0;38mHello World\e[0m”

我用putsprint和Logger gem测试了它,它工作得很好。


我对此进行了改进,并创建了一个类,因此colorsbgColors是类常量,colorize是类方法:

编辑:更好的代码风格,定义常量而不是类变量,使用符号而不是字符串,增加了更多的选项,如粗体,斜体等。

class Colorizator
COLOURS = { default: '38', black: '30', red: '31', green: '32', brown: '33', blue: '34', purple: '35',
cyan: '36', gray: '37', dark_gray: '1;30', light_red: '1;31', light_green: '1;32', yellow: '1;33',
light_blue: '1;34', light_purple: '1;35', light_cyan: '1;36', white: '1;37' }.freeze
BG_COLOURS = { default: '0', black: '40', red: '41', green: '42', brown: '43', blue: '44',
purple: '45', cyan: '46', gray: '47', dark_gray: '100', light_red: '101', light_green: '102',
yellow: '103', light_blue: '104', light_purple: '105', light_cyan: '106', white: '107' }.freeze


FONT_OPTIONS = { bold: '1', dim: '2', italic: '3', underline: '4', reverse: '7', hidden: '8' }.freeze


def self.colorize(text, colour = :default, bg_colour = :default, **options)
colour_code = COLOURS[colour]
bg_colour_code = BG_COLOURS[bg_colour]
font_options = options.select { |k, v| v && FONT_OPTIONS.key?(k) }.keys
font_options = font_options.map { |e| FONT_OPTIONS[e] }.join(';').squeeze
return "\e[#{bg_colour_code};#{font_options};#{colour_code}m#{text}\e[0m".squeeze(';')
end
end

你可以这样使用它:

Colorizator.colorize "Hello World", :gray, :white
Colorizator.colorize "Hello World", :light_blue, bold: true
Colorizator.colorize "Hello World", :light_blue, :white, bold: true, underline: true

虽然其他答案对大多数人来说都很好,但应该提到“正确的”Unix方式。由于所有类型的文本终端都不支持这些序列,所以可以查询terminfo数据库,它是对各种文本终端功能的抽象。这似乎主要是出于历史兴趣。目前使用的软件终端通常支持ANSI序列–但它确实(至少)有一个实际效果:有时能够将环境变量TERM设置为dumb以避免所有此类样式化是有用的,例如在将输出保存到文本文件时。而且,做事情感觉很好。: -)

你可以使用ruby-terminfo宝石。它需要一些C编译来安装;我可以在我的Ubuntu 14.10系统下安装它:

$ sudo apt-get install libncurses5-dev
$ gem install ruby-terminfo --user-install

然后你可以像这样查询数据库(查看终端手册页中可用代码的列表):

require 'terminfo'
TermInfo.control("bold")
puts "Bold text"
TermInfo.control("sgr0")
puts "Back to normal."
puts "And now some " + TermInfo.control_string("setaf", 1) +
"red" + TermInfo.control_string("sgr0") + " text."

这里有一个小的包装器类,我把它放在一起使事情更容易使用。

require 'terminfo'


class Style
def self.style()
@@singleton ||= Style.new
end


colors = %w{black red green yellow blue magenta cyan white}
colors.each_with_index do |color, index|
define_method(color) { get("setaf", index) }
define_method("bg_" + color) { get("setab", index) }
end


def bold()  get("bold")  end
def under() get("smul")  end
def dim()   get("dim")   end
def clear() get("sgr0")  end


def get(*args)
begin
TermInfo.control_string(*args)
rescue TermInfo::TermInfoError
""
end
end
end

用法:

c = Style.style
C = c.clear
puts "#{c.red}Warning:#{C} this is #{c.bold}way#{C} #{c.bg_red}too much #{c.cyan + c.under}styling#{C}!"
puts "#{c.dim}(Don't you think?)#{C}"

以上Ruby脚本的输出

(编辑)最后,如果你不想需要一个gem,你可以依赖tput程序,如这里所述 –Ruby的例子:

puts "Hi! " + `tput setaf 1` + "This is red!" + `tput sgr0`