278 lines
13 KiB
Ruby
278 lines
13 KiB
Ruby
# frozen_string_literal: false
|
|
require 'test/unit'
|
|
require 'irb/color'
|
|
require 'rubygems'
|
|
require 'stringio'
|
|
|
|
module TestIRB
|
|
class TestColor < Test::Unit::TestCase
|
|
CLEAR = "\e[0m"
|
|
BOLD = "\e[1m"
|
|
UNDERLINE = "\e[4m"
|
|
REVERSE = "\e[7m"
|
|
RED = "\e[31m"
|
|
GREEN = "\e[32m"
|
|
YELLOW = "\e[33m"
|
|
BLUE = "\e[34m"
|
|
MAGENTA = "\e[35m"
|
|
CYAN = "\e[36m"
|
|
|
|
def test_colorize
|
|
text = "text"
|
|
{
|
|
[:BOLD] => "#{BOLD}#{text}#{CLEAR}",
|
|
[:UNDERLINE] => "#{UNDERLINE}#{text}#{CLEAR}",
|
|
[:REVERSE] => "#{REVERSE}#{text}#{CLEAR}",
|
|
[:RED] => "#{RED}#{text}#{CLEAR}",
|
|
[:GREEN] => "#{GREEN}#{text}#{CLEAR}",
|
|
[:YELLOW] => "#{YELLOW}#{text}#{CLEAR}",
|
|
[:BLUE] => "#{BLUE}#{text}#{CLEAR}",
|
|
[:MAGENTA] => "#{MAGENTA}#{text}#{CLEAR}",
|
|
[:CYAN] => "#{CYAN}#{text}#{CLEAR}",
|
|
}.each do |seq, result|
|
|
assert_equal_with_term(result, text, seq: seq)
|
|
|
|
assert_equal_with_term(text, text, seq: seq, tty: false)
|
|
assert_equal_with_term(text, text, seq: seq, colorable: false)
|
|
assert_equal_with_term(result, text, seq: seq, tty: false, colorable: true)
|
|
end
|
|
end
|
|
|
|
def test_colorize_code
|
|
# Common behaviors. Warn parser error, but do not warn compile error.
|
|
tests = {
|
|
"1" => "#{BLUE}#{BOLD}1#{CLEAR}",
|
|
"2.3" => "#{MAGENTA}#{BOLD}2.3#{CLEAR}",
|
|
"7r" => "#{BLUE}#{BOLD}7r#{CLEAR}",
|
|
"8i" => "#{BLUE}#{BOLD}8i#{CLEAR}",
|
|
"['foo', :bar]" => "[#{RED}#{BOLD}'#{CLEAR}#{RED}foo#{CLEAR}#{RED}#{BOLD}'#{CLEAR}, #{YELLOW}:#{CLEAR}#{YELLOW}bar#{CLEAR}]",
|
|
"class A; end" => "#{GREEN}class#{CLEAR} #{BLUE}#{BOLD}#{UNDERLINE}A#{CLEAR}; #{GREEN}end#{CLEAR}",
|
|
"def self.foo; bar; end" => "#{GREEN}def#{CLEAR} #{CYAN}#{BOLD}self#{CLEAR}.#{BLUE}#{BOLD}foo#{CLEAR}; bar; #{GREEN}end#{CLEAR}",
|
|
'erb = ERB.new("a#{nil}b", trim_mode: "-")' => "erb = #{BLUE}#{BOLD}#{UNDERLINE}ERB#{CLEAR}.new(#{RED}#{BOLD}\"#{CLEAR}#{RED}a#{CLEAR}#{RED}\#{#{CLEAR}#{CYAN}#{BOLD}nil#{CLEAR}#{RED}}#{CLEAR}#{RED}b#{CLEAR}#{RED}#{BOLD}\"#{CLEAR}, #{MAGENTA}trim_mode:#{CLEAR} #{RED}#{BOLD}\"#{CLEAR}#{RED}-#{CLEAR}#{RED}#{BOLD}\"#{CLEAR})",
|
|
"# comment" => "#{BLUE}#{BOLD}# comment#{CLEAR}",
|
|
"def f;yield(hello);end" => "#{GREEN}def#{CLEAR} #{BLUE}#{BOLD}f#{CLEAR};#{GREEN}yield#{CLEAR}(hello);#{GREEN}end#{CLEAR}",
|
|
'"##@var]"' => "#{RED}#{BOLD}\"#{CLEAR}#{RED}\##{CLEAR}#{RED}\##{CLEAR}@var#{RED}]#{CLEAR}#{RED}#{BOLD}\"#{CLEAR}",
|
|
'"foo#{a} #{b}"' => "#{RED}#{BOLD}\"#{CLEAR}#{RED}foo#{CLEAR}#{RED}\#{#{CLEAR}a#{RED}}#{CLEAR}#{RED} #{CLEAR}#{RED}\#{#{CLEAR}b#{RED}}#{CLEAR}#{RED}#{BOLD}\"#{CLEAR}",
|
|
'/r#{e}g/' => "#{RED}#{BOLD}/#{CLEAR}#{RED}r#{CLEAR}#{RED}\#{#{CLEAR}e#{RED}}#{CLEAR}#{RED}g#{CLEAR}#{RED}#{BOLD}/#{CLEAR}",
|
|
"'a\nb'" => "#{RED}#{BOLD}'#{CLEAR}#{RED}a#{CLEAR}\n#{RED}b#{CLEAR}#{RED}#{BOLD}'#{CLEAR}",
|
|
"%[str]" => "#{RED}#{BOLD}%[#{CLEAR}#{RED}str#{CLEAR}#{RED}#{BOLD}]#{CLEAR}",
|
|
"%Q[str]" => "#{RED}#{BOLD}%Q[#{CLEAR}#{RED}str#{CLEAR}#{RED}#{BOLD}]#{CLEAR}",
|
|
"%q[str]" => "#{RED}#{BOLD}%q[#{CLEAR}#{RED}str#{CLEAR}#{RED}#{BOLD}]#{CLEAR}",
|
|
"%x[cmd]" => "#{RED}#{BOLD}%x[#{CLEAR}#{RED}cmd#{CLEAR}#{RED}#{BOLD}]#{CLEAR}",
|
|
"%r[reg]" => "#{RED}#{BOLD}%r[#{CLEAR}#{RED}reg#{CLEAR}#{RED}#{BOLD}]#{CLEAR}",
|
|
"%w[a b]" => "#{RED}#{BOLD}%w[#{CLEAR}#{RED}a#{CLEAR} #{RED}b#{CLEAR}#{RED}#{BOLD}]#{CLEAR}",
|
|
"%W[a b]" => "#{RED}#{BOLD}%W[#{CLEAR}#{RED}a#{CLEAR} #{RED}b#{CLEAR}#{RED}#{BOLD}]#{CLEAR}",
|
|
"%s[a b]" => "#{YELLOW}%s[#{CLEAR}#{YELLOW}a b#{CLEAR}#{YELLOW}]#{CLEAR}",
|
|
"%i[c d]" => "#{YELLOW}%i[#{CLEAR}#{YELLOW}c#{CLEAR}#{YELLOW} #{CLEAR}#{YELLOW}d#{CLEAR}#{YELLOW}]#{CLEAR}",
|
|
"%I[c d]" => "#{YELLOW}%I[#{CLEAR}#{YELLOW}c#{CLEAR}#{YELLOW} #{CLEAR}#{YELLOW}d#{CLEAR}#{YELLOW}]#{CLEAR}",
|
|
"{'a': 1}" => "{#{RED}#{BOLD}'#{CLEAR}#{RED}a#{CLEAR}#{RED}#{BOLD}':#{CLEAR} #{BLUE}#{BOLD}1#{CLEAR}}",
|
|
":Struct" => "#{YELLOW}:#{CLEAR}#{YELLOW}Struct#{CLEAR}",
|
|
'"#{}"' => "#{RED}#{BOLD}\"#{CLEAR}#{RED}\#{#{CLEAR}#{RED}}#{CLEAR}#{RED}#{BOLD}\"#{CLEAR}",
|
|
':"a#{}b"' => "#{YELLOW}:\"#{CLEAR}#{YELLOW}a#{CLEAR}#{YELLOW}\#{#{CLEAR}#{YELLOW}}#{CLEAR}#{YELLOW}b#{CLEAR}#{YELLOW}\"#{CLEAR}",
|
|
':"a#{ def b; end; \'c\' + "#{ :d }" }e"' => "#{YELLOW}:\"#{CLEAR}#{YELLOW}a#{CLEAR}#{YELLOW}\#{#{CLEAR} #{GREEN}def#{CLEAR} #{BLUE}#{BOLD}b#{CLEAR}; #{GREEN}end#{CLEAR}; #{RED}#{BOLD}'#{CLEAR}#{RED}c#{CLEAR}#{RED}#{BOLD}'#{CLEAR} + #{RED}#{BOLD}\"#{CLEAR}#{RED}\#{#{CLEAR} #{YELLOW}:#{CLEAR}#{YELLOW}d#{CLEAR} #{RED}}#{CLEAR}#{RED}#{BOLD}\"#{CLEAR} #{YELLOW}}#{CLEAR}#{YELLOW}e#{CLEAR}#{YELLOW}\"#{CLEAR}",
|
|
"[__FILE__, __LINE__, __ENCODING__]" => "[#{CYAN}#{BOLD}__FILE__#{CLEAR}, #{CYAN}#{BOLD}__LINE__#{CLEAR}, #{CYAN}#{BOLD}__ENCODING__#{CLEAR}]",
|
|
":self" => "#{YELLOW}:#{CLEAR}#{YELLOW}self#{CLEAR}",
|
|
":class" => "#{YELLOW}:#{CLEAR}#{YELLOW}class#{CLEAR}",
|
|
"[:end, 2]" => "[#{YELLOW}:#{CLEAR}#{YELLOW}end#{CLEAR}, #{BLUE}#{BOLD}2#{CLEAR}]",
|
|
"[:>, 3]" => "[#{YELLOW}:#{CLEAR}#{YELLOW}>#{CLEAR}, #{BLUE}#{BOLD}3#{CLEAR}]",
|
|
":Hello ? world : nil" => "#{YELLOW}:#{CLEAR}#{YELLOW}Hello#{CLEAR} ? world : #{CYAN}#{BOLD}nil#{CLEAR}",
|
|
'raise "foo#{bar}baz"' => "raise #{RED}#{BOLD}\"#{CLEAR}#{RED}foo#{CLEAR}#{RED}\#{#{CLEAR}bar#{RED}}#{CLEAR}#{RED}baz#{CLEAR}#{RED}#{BOLD}\"#{CLEAR}",
|
|
'["#{obj.inspect}"]' => "[#{RED}#{BOLD}\"#{CLEAR}#{RED}\#{#{CLEAR}obj.inspect#{RED}}#{CLEAR}#{RED}#{BOLD}\"#{CLEAR}]",
|
|
'URI.parse "#{}"' => "#{BLUE}#{BOLD}#{UNDERLINE}URI#{CLEAR}.parse #{RED}#{BOLD}\"#{CLEAR}#{RED}\#{#{CLEAR}#{RED}}#{CLEAR}#{RED}#{BOLD}\"#{CLEAR}",
|
|
"begin\nrescue\nend" => "#{GREEN}begin#{CLEAR}\n#{GREEN}rescue#{CLEAR}\n#{GREEN}end#{CLEAR}",
|
|
"foo %w[bar]" => "foo #{RED}#{BOLD}%w[#{CLEAR}#{RED}bar#{CLEAR}#{RED}#{BOLD}]#{CLEAR}",
|
|
"foo %i[bar]" => "foo #{YELLOW}%i[#{CLEAR}#{YELLOW}bar#{CLEAR}#{YELLOW}]#{CLEAR}",
|
|
"foo :@bar, baz, :@@qux, :$quux" => "foo #{YELLOW}:#{CLEAR}#{YELLOW}@bar#{CLEAR}, baz, #{YELLOW}:#{CLEAR}#{YELLOW}@@qux#{CLEAR}, #{YELLOW}:#{CLEAR}#{YELLOW}$quux#{CLEAR}",
|
|
"`echo`" => "#{RED}#{BOLD}`#{CLEAR}#{RED}echo#{CLEAR}#{RED}#{BOLD}`#{CLEAR}",
|
|
"\t" => "\t", # not ^I
|
|
"foo(*%W(bar))" => "foo(*#{RED}#{BOLD}%W(#{CLEAR}#{RED}bar#{CLEAR}#{RED}#{BOLD})#{CLEAR})",
|
|
"$stdout" => "#{GREEN}#{BOLD}$stdout#{CLEAR}",
|
|
"__END__" => "#{GREEN}__END__#{CLEAR}",
|
|
}
|
|
|
|
# specific to Ruby 2.7+
|
|
if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
|
|
tests.merge!({
|
|
"4.5.6" => "#{MAGENTA}#{BOLD}4.5#{CLEAR}#{RED}#{REVERSE}.6#{CLEAR}",
|
|
"\e[0m\n" => "#{RED}#{REVERSE}^[#{CLEAR}[#{BLUE}#{BOLD}0#{CLEAR}#{RED}#{REVERSE}m#{CLEAR}\n",
|
|
"<<EOS\nhere\nEOS" => "#{RED}<<EOS#{CLEAR}\n#{RED}here#{CLEAR}\n#{RED}EOS#{CLEAR}",
|
|
})
|
|
end
|
|
|
|
# specific to Ruby 3.0+
|
|
if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
|
|
tests.merge!({
|
|
"[1]]]\u0013" => "[#{BLUE}#{BOLD}1#{CLEAR}]#{RED}#{REVERSE}]#{CLEAR}#{RED}#{REVERSE}]#{CLEAR}#{RED}#{REVERSE}^S#{CLEAR}",
|
|
})
|
|
tests.merge!({
|
|
"def req(true) end" => "#{GREEN}def#{CLEAR} #{BLUE}#{BOLD}req#{CLEAR}(#{RED}#{REVERSE}true#{CLEAR}) #{RED}#{REVERSE}end#{CLEAR}",
|
|
"nil = 1" => "#{RED}#{REVERSE}nil#{CLEAR} = #{BLUE}#{BOLD}1#{CLEAR}",
|
|
"alias $x $1" => "#{GREEN}alias#{CLEAR} #{GREEN}#{BOLD}$x#{CLEAR} #{RED}#{REVERSE}$1#{CLEAR}",
|
|
"class bad; end" => "#{GREEN}class#{CLEAR} #{RED}#{REVERSE}bad#{CLEAR}; #{GREEN}end#{CLEAR}",
|
|
"def req(@a) end" => "#{GREEN}def#{CLEAR} #{BLUE}#{BOLD}req#{CLEAR}(#{RED}#{REVERSE}@a#{CLEAR}) #{GREEN}end#{CLEAR}",
|
|
})
|
|
else
|
|
tests.merge!({
|
|
"[1]]]\u0013" => "[1]]]^S",
|
|
})
|
|
tests.merge!({
|
|
"def req(true) end" => "def req(true) end",
|
|
"nil = 1" => "#{CYAN}#{BOLD}nil#{CLEAR} = #{BLUE}#{BOLD}1#{CLEAR}",
|
|
"alias $x $1" => "#{GREEN}alias#{CLEAR} #{GREEN}#{BOLD}$x#{CLEAR} $1",
|
|
"class bad; end" => "#{GREEN}class#{CLEAR} bad; #{GREEN}end#{CLEAR}",
|
|
"def req(@a) end" => "#{GREEN}def#{CLEAR} #{BLUE}#{BOLD}req#{CLEAR}(@a) #{GREEN}end#{CLEAR}",
|
|
})
|
|
end
|
|
|
|
tests.each do |code, result|
|
|
if colorize_code_supported?
|
|
assert_equal_with_term(result, code, complete: true)
|
|
assert_equal_with_term(result, code, complete: false)
|
|
|
|
assert_equal_with_term(code, code, complete: true, tty: false)
|
|
assert_equal_with_term(code, code, complete: false, tty: false)
|
|
|
|
assert_equal_with_term(code, code, complete: true, colorable: false)
|
|
|
|
assert_equal_with_term(code, code, complete: false, colorable: false)
|
|
|
|
assert_equal_with_term(result, code, complete: true, tty: false, colorable: true)
|
|
|
|
assert_equal_with_term(result, code, complete: false, tty: false, colorable: true)
|
|
else
|
|
assert_equal_with_term(code, code)
|
|
end
|
|
end
|
|
end
|
|
|
|
def test_colorize_code_complete_true
|
|
unless complete_option_supported?
|
|
pend '`complete: true` is the same as `complete: false` in Ruby 2.6-'
|
|
end
|
|
|
|
# `complete: true` behaviors. Warn end-of-file.
|
|
{
|
|
"'foo' + 'bar" => "#{RED}#{BOLD}'#{CLEAR}#{RED}foo#{CLEAR}#{RED}#{BOLD}'#{CLEAR} + #{RED}#{BOLD}'#{CLEAR}#{RED}#{REVERSE}bar#{CLEAR}",
|
|
"('foo" => "(#{RED}#{BOLD}'#{CLEAR}#{RED}#{REVERSE}foo#{CLEAR}",
|
|
}.each do |code, result|
|
|
assert_equal_with_term(result, code, complete: true)
|
|
|
|
assert_equal_with_term(code, code, complete: true, tty: false)
|
|
|
|
assert_equal_with_term(code, code, complete: true, colorable: false)
|
|
|
|
assert_equal_with_term(result, code, complete: true, tty: false, colorable: true)
|
|
end
|
|
end
|
|
|
|
def test_colorize_code_complete_false
|
|
# `complete: false` behaviors. Do not warn end-of-file.
|
|
{
|
|
"'foo' + 'bar" => "#{RED}#{BOLD}'#{CLEAR}#{RED}foo#{CLEAR}#{RED}#{BOLD}'#{CLEAR} + #{RED}#{BOLD}'#{CLEAR}#{RED}bar#{CLEAR}",
|
|
"('foo" => "(#{RED}#{BOLD}'#{CLEAR}#{RED}foo#{CLEAR}",
|
|
}.each do |code, result|
|
|
if colorize_code_supported?
|
|
assert_equal_with_term(result, code, complete: false)
|
|
|
|
assert_equal_with_term(code, code, complete: false, tty: false)
|
|
|
|
assert_equal_with_term(code, code, complete: false, colorable: false)
|
|
|
|
assert_equal_with_term(result, code, complete: false, tty: false, colorable: true)
|
|
|
|
unless complete_option_supported?
|
|
assert_equal_with_term(result, code, complete: true)
|
|
|
|
assert_equal_with_term(code, code, complete: true, tty: false)
|
|
|
|
assert_equal_with_term(code, code, complete: true, colorable: false)
|
|
|
|
assert_equal_with_term(result, code, complete: true, tty: false, colorable: true)
|
|
end
|
|
else
|
|
assert_equal_with_term(code, code)
|
|
end
|
|
end
|
|
end
|
|
|
|
def test_inspect_colorable
|
|
{
|
|
1 => true,
|
|
2.3 => true,
|
|
['foo', :bar] => true,
|
|
(a = []; a << a; a) => false,
|
|
(h = {}; h[h] = h; h) => false,
|
|
{ a: 4 } => true,
|
|
/reg/ => true,
|
|
(1..3) => true,
|
|
Object.new => false,
|
|
Struct => true,
|
|
Test => true,
|
|
Struct.new(:a) => false,
|
|
Struct.new(:a).new(1) => false,
|
|
}.each do |object, result|
|
|
assert_equal(result, IRB::Color.inspect_colorable?(object), "Case: inspect_colorable?(#{object.inspect})")
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
# `#colorize_code` is supported only for Ruby 2.5+. It just returns the original code in 2.4-.
|
|
def colorize_code_supported?
|
|
Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
|
|
end
|
|
|
|
# `complete: true` is the same as `complete: false` in Ruby 2.6-
|
|
def complete_option_supported?
|
|
Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
|
|
end
|
|
|
|
def with_term(tty: true)
|
|
stdout = $stdout
|
|
io = StringIO.new
|
|
def io.tty?; true; end if tty
|
|
$stdout = io
|
|
|
|
env = ENV.to_h.dup
|
|
ENV['TERM'] = 'xterm-256color'
|
|
|
|
yield
|
|
ensure
|
|
$stdout = stdout
|
|
ENV.replace(env) if env
|
|
end
|
|
|
|
def assert_equal_with_term(result, code, seq: nil, tty: true, **opts)
|
|
actual = with_term(tty: tty) do
|
|
if seq
|
|
IRB::Color.colorize(code, seq, **opts)
|
|
else
|
|
IRB::Color.colorize_code(code, **opts)
|
|
end
|
|
end
|
|
message = -> {
|
|
args = [code.dump]
|
|
args << seq.inspect if seq
|
|
opts.each {|kwd, val| args << "#{kwd}: #{val}"}
|
|
"Case: colorize#{seq ? "" : "_code"}(#{args.join(', ')})\nResult: #{humanized_literal(actual)}"
|
|
}
|
|
assert_equal(result, actual, message)
|
|
end
|
|
|
|
def humanized_literal(str)
|
|
str
|
|
.gsub(CLEAR, '@@@{CLEAR}')
|
|
.gsub(BOLD, '@@@{BOLD}')
|
|
.gsub(UNDERLINE, '@@@{UNDERLINE}')
|
|
.gsub(REVERSE, '@@@{REVERSE}')
|
|
.gsub(RED, '@@@{RED}')
|
|
.gsub(GREEN, '@@@{GREEN}')
|
|
.gsub(YELLOW, '@@@{YELLOW}')
|
|
.gsub(BLUE, '@@@{BLUE}')
|
|
.gsub(MAGENTA, '@@@{MAGENTA}')
|
|
.gsub(CYAN, '@@@{CYAN}')
|
|
.dump.gsub(/@@@/, '#')
|
|
end
|
|
end
|
|
end
|