# Extensions for class String # # HighLine::String is a subclass of String with convenience methods added for colorization. # # Available convenience methods include: # * 'color' method e.g. highline_string.color(:bright_blue, :underline) # * colors e.g. highline_string.magenta # * RGB colors e.g. highline_string.rgb_ff6000 # or highline_string.rgb(255,96,0) # * background colors e.g. highline_string.on_magenta # * RGB background colors e.g. highline_string.on_rgb_ff6000 # or highline_string.on_rgb(255,96,0) # * styles e.g. highline_string.underline # # Additionally, convenience methods can be chained, for instance the following are equivalent: # highline_string.bright_blue.blink.underline # highline_string.color(:bright_blue, :blink, :underline) # HighLine.color(highline_string, :bright_blue, :blink, :underline) # # For those less squeamish about possible conflicts, the same convenience methods can be # added to the built-in String class, as follows: # # require 'highline' # Highline.colorize_strings class HighLine def self.String(s) HighLine::String.new(s) end module StringExtensions def self.included(base) HighLine::COLORS.each do |color| color = color.downcase base.class_eval <<-END undef :#{color} if method_defined? :#{color} def #{color} color(:#{color}) end END base.class_eval <<-END undef :on_#{color} if method_defined? :on_#{color} def on_#{color} on(:#{color}) end END HighLine::STYLES.each do |style| style = style.downcase base.class_eval <<-END undef :#{style} if method_defined? :#{style} def #{style} color(:#{style}) end END end end base.class_eval do undef :color if method_defined? :color undef :foreground if method_defined? :foreground def color(*args) self.class.new(HighLine.color(self, *args)) end alias_method :foreground, :color undef :on if method_defined? :on def on(arg) color(('on_' + arg.to_s).to_sym) end undef :uncolor if method_defined? :uncolor def uncolor self.class.new(HighLine.uncolor(self)) end undef :rgb if method_defined? :rgb def rgb(*colors) color_code = colors.map{|color| color.is_a?(Numeric) ? '%02x'%color : color.to_s}.join raise "Bad RGB color #{colors.inspect}" unless color_code =~ /^[a-fA-F0-9]{6}/ color("rgb_#{color_code}".to_sym) end undef :on_rgb if method_defined? :on_rgb def on_rgb(*colors) color_code = colors.map{|color| color.is_a?(Numeric) ? '%02x'%color : color.to_s}.join raise "Bad RGB color #{colors.inspect}" unless color_code =~ /^[a-fA-F0-9]{6}/ color("on_rgb_#{color_code}".to_sym) end # TODO Chain existing method_missing undef :method_missing if method_defined? :method_missing def method_missing(method, *args, &blk) if method.to_s =~ /^(on_)?rgb_([0-9a-fA-F]{6})$/ color(method) else raise NoMethodError, "undefined method `#{method}' for #<#{self.class}:#{'%#x'%self.object_id}>" end end end end end class HighLine::String < ::String include StringExtensions end def self.colorize_strings ::String.send(:include, StringExtensions) end end