color_echo 2.0.4 → 3.0.0

data/bin/lib/display.rb

@@ -1,19 +1,36 @@
-@explain_v      = %(Show version of color_echo.)
-@explain_s      = %(Show symbol list that can to specify.)
-@explain_l      = %(Show color index list that can to specify.)
-@explain_p      = %(Decorate your specified wrods. You can use this option any number of times.)
-@explain_H      = %(Highlight the match lines by -p options word. format -H "fg_color, bg_color, text_attribute[,...]")
-@explain_f      = %(Specify the foreground color.)
-@explain_b      = %(Specify the background color.)
-@explain_t      = %(Specify the text attributes.)
-@explain_w      = %(Interactive mode. Break word is -> exit, quit, bye; Or Ctl + c)
+@padding        = " " * 4
+@header_s       = %(-s, --symbol-list)
+@explain_s      = %(Shows symbol list that can to specify in foreground_color, background_color, text_attr.)
+@header_l       = %(-l, --index-list)
+@explain_l      = %(Shows color index list that can to specify in foreground_color, background_color.)
+@header_p       = %(-p, --pickup "pattern[,foreground_color[,background_color[,text_attribute]]]")
+@explain_p      = %(Decorates your specified pattern. You can use this option many times.)
+@header_H       = %(-H, --hightlight "foreground_color[,background_color[,text_attribute]]")
+@explain_H      = %(Highlight lines that match pattern which is specified by -p option.)
+@header_f       = %(-f, --fg color_name)
+@explain_f      = %(Specifies foreground color.)
+@header_b       = %(-b, --bg color_name)
+@explain_b      = %(Specifies background color.)
+@header_t       = %(-t, --tx text_attribute[,...])
+@explain_t      = %(Specifies background color.)
+@header_w       = %(-w, --watch)
+@explain_w      = %(Keeps wait for standard input.)
+@header_stripe  = %(--stripe)
+@explain_stripe = %(Decorates on every other line.)
+@header_r       = %(-r, --refresh-match)
+@explain_r      = %(Tries to delete sequence code from input that matches -p option’s pattern)
+@header_R       = %(-R, --refresh)
+@explain_R      = %(Tries to delete sequence code from input.)
+@header_c       = %(-c file_name,...)
+@explain_c      = %(Reads options from your specify file. You can specify many files as -c foo,bar,baz.)
+@header_n       = %(-n)
 @explain_n      = %(Do not output the trailing newline.)
+@header_e       = %(-e)
 @explain_e      = %(Enable interpretation of line feed.)
-@explain_h      = %(Show help message with example.)
-@explain_r      = %(Try to remove the sequence code from the given before matching pickups.)
-@explain_R      = %(Try to remove the sequence code from the given.)
-@explain_stripe = %(Decorate on every other line. pickup option is ignored.)
-@padding        = " " * 4
+@header_v       = %(-v)
+@explain_v      = %(Shows version of color_echo.)
+@header_h       = %(-h, --help)
+@explain_h      = %(Shows help message.)
 @explain_usage  = @padding * 2 + %(colorecho [options] message) + $/
 @explain_usage += @padding * 2 + %(colorecho [options] < /path/to/file) + $/
 @explain_usage += @padding * 2 + %(echo "message" | colorecho [options]) + $/
@@ -40,119 +57,104 @@ def usage
 
     EOS
 
-    headers    = ["* Usage", "* Options", "* Example"]
-    headers_op = [
-                    "-v:", "--symbol-list:", "--index-list:", "--pickup word [--pickup word ...]:", "--fg color_name:", "--bg color_name:",
-                    "--tx text_attribute[,...]:", "--watch:", "--stripe:", %(--hightlight "foreground_color[,background_color[,text_attribute]]:"),
-                    "--refresh:", "--refresh-pre-match:", "--help:", "-n:", "-e:"
-    ]
+    headers = ["* Usage", "* Options", "* Example"]
     CE.pickup(headers, :h_green)
-    CE.pickup(headers_op, :cyan)
 
     puts @padding + "* Usage"
 
     CE.ch :h_blue
-    puts @explain_usage + $/ + $/
+    puts @explain_usage + $/ * 2
     CE.off :fg
 
+    headers_op = [
+        @header_l,
+        @header_p,
+        @header_H,
+        @header_f,
+        @header_b,
+        @header_t,
+        @header_w,
+        @header_n,
+        @header_e,
+        @header_h,
+        @header_stripe,
+        @header_r,
+        @header_R,
+        @header_c,
+        @header_v,
+        @header_s
+    ]
+    CE.pickup(headers_op, :cyan)
+
     puts @padding + "* Options"
 
-    puts @padding * 2 + "--symbol-list:"
-    puts @padding * 3 + @explain_s
-    puts @padding * 3 + "short option is -s." + $/ + $/ 
+    puts @padding * 2 + @header_s
+    puts @padding * 3 + @explain_s + $/ * 2
     
-    puts @padding * 2 + "--index-list:"
-    puts @padding * 3 + @explain_l
-    puts @padding * 3 + "short option is -l." + $/ + $/ 
-
-    puts @padding * 2 + "--pickup word [--pickup word ...]:"
-    puts @padding * 3 + @explain_p
-    puts @padding * 3 + "Regular expressions can be used; like that -> /^foo/i"
-    puts @padding * 3 + "short option is -p." + $/ + $/ 
-
-    puts @padding * 2 + %(--hightlight "foreground_color[,background_color[,text_attribute]]:")
-    puts @padding * 3 + @explain_H
-    puts @padding * 3 + %(example -> echo "some message" | colorecho -H "nil,gray" -p /some patturn/ -f h_yellow)
-    puts @padding * 3 + "short option is -H." + $/ + $/
-
-    puts @padding * 2 + "--fg color_name:"
-    puts @padding * 3 + @explain_f
-    puts @padding * 3 + "short option is -f." + $/ + $/ 
-
-    puts @padding * 2 + "--bg color_name:"
-    puts @padding * 3 + @explain_b
-    puts @padding * 3 + "short option is -b." + $/ + $/ 
-
-    puts @padding * 2 + "--tx text_attribute[,...]:"
-    puts @padding * 3 + @explain_t
-    puts @padding * 3 + "short option is -t." + $/ + $/ 
-
-    puts @padding * 2 + "--watch:"
-    puts @padding * 3 + @explain_w
-    puts @padding * 3 + "short option is -w." + $/ + $/
-
-    puts @padding * 2 + "--stripe:"
-    puts @padding * 3 + @explain_stripe + $/ + $/
-
-    puts @padding * 2 + "--refresh-pre-match:"
-    puts @padding * 3 + @explain_r
-    puts @padding * 3 + "If it matches, Try to remove sequence code from it."
-    puts @padding * 3 + "short option is -r." + $/ + $/
-
-    puts @padding * 2 + "--refresh:"
-    puts @padding * 3 + @explain_R
-    puts @padding * 3 + "short option is -R." + $/ + $/
-
-    puts @padding * 2 + "-n:"
-    puts @padding * 3 + @explain_n + $/ + $/ 
-
-    puts @padding * 2 + "-e:"
-    puts @padding * 3 + @explain_e + $/ + $/ 
-
-    puts @padding * 2 + "-v:"
-    puts @padding * 3 + @explain_v + $/ + $/
-
-    puts @padding * 2 + "--help:"
-    puts @padding * 3 + @explain_h
-    puts @padding * 3 + "short option is -h." + $/ + $/
-
-    puts @padding + "* Example"
-
-    CE.once.ch :h_magenta
-    puts @padding * 2 + %(* color_echo can to highlight even when you following the log file by tailf, tail -f.)
-    puts @padding * 3 + %(tailf /var/log/httpd/access_log | colorecho -w -p "127.0.0.1" -t bold)
-    puts @padding * 3 + %(tailf /var/log/php/php_error.log | colorecho -w -p "foo.php" -p "Fatal error:" -f h_blue) + $/ + $/
-
-    CE.once.ch :h_magenta
-    puts @padding * 2 + %(* color_echo is useful to read the access log, etc.)
-    puts @padding * 3 + %(cat /var/log/httpd/access_log | colorecho -p "Sun Jan 18" -f h_cyan -t underscore | less -R)
-    puts @padding * 3 + %(colorecho -p "Sun Jan 18" -f h_cyan -t underscore < /var/log/httpd/access_log | less -R)
-    puts @padding * 3 + %((colorecho -f cyan -p /\\\\s2..\\\\s/ | colorecho -f h_red -p /\\\\s5..\\\\s/ | less -R) < /var/log/httpd/access_log)
-    puts @padding * 3 + %(sed -n 1,1000p /var/log/httpd/access_log | colorecho -f cyan -p /\\\\s2..\\\\s/ | colorecho -f h_red -p /\\\\s5..\\\\s/ | less -R) + $/ + $/
-
-    CE.once.ch :h_magenta
-    puts @padding * 2 + %(* It is a simple to use.)
-    puts @padding * 3 + %(colorecho Hello\\!\\! -f h_white -b index199)
-    puts @padding * 3 + %(colorecho Hello\\!\\! -t blink,bold -f magenta) + $/ + $/
-
-    CE.once.ch :h_magenta
-    puts @padding * 2 + %(* color_echo can to receive the standard input.)
-    puts @padding * 3 + %(echo FooFoOfOO | colorecho -t reverse_video)
-    puts @padding * 3 + %(echo FooFoOfOO | colorecho -f index130 -p /foo$/i | colorecho -f index180 -p /^foo/i)
-    puts @padding * 3 + %(netstat -na | colorecho -p ":80" | colorecho -p "127.0.0.1" -f h_cyan) + $/ + $/
-
-    CE.once.ch :h_magenta
-    puts @padding * 2 + %(* color_echo can to decorate on every other line.)
-    puts @padding * 3 + %(colorecho -f gray -t bold --stripe < /path/to/file)
-    puts @padding * 3 + %(tailf /var/log/httpd/access_log | colorecho -w -f black -b index150 -t bold --stripe) + $/ + $/
+    puts @padding * 2 + @header_l
+    puts @padding * 3 + @explain_l + $/ * 2
 
-    CE.once.rainbow
-    puts @padding * 2 + %(* Enjoy colors!!)
-    puts @padding * 3 + %(tailf /var/log/httpd/access_log | colorecho -w -f index235 -r | colorecho -w -p "pattern1" -f index3 -t underscore,bold -H index85 -r | colorecho -w -p "pattern2" -f index28,nil -t underscore,bold -H index46 -r | colorecho -w -p "pattern3" -t bold,underscore -f index198 -H index178 -r) + $/ + $/
+    puts @padding * 2 + @header_p
+    puts @padding * 3 + @explain_p + $/ * 2
+
+    puts @padding * 2 + @header_H
+    puts @padding * 3 + @explain_H + $/ * 2
+
+    puts @padding * 2 + @header_f
+    puts @padding * 3 + @explain_f + $/ * 2
+
+    puts @padding * 2 + @header_b
+    puts @padding * 3 + @explain_b + $/ * 2
+
+    puts @padding * 2 + @header_t
+    puts @padding * 3 + @explain_t + $/ * 2
+
+    puts @padding * 2 + @header_w
+    puts @padding * 3 + @explain_w + $/ * 2
 
+    puts @padding * 2 + @header_stripe
+    puts @padding * 3 + @explain_stripe + $/ * 2
+
+    puts @padding * 2 + @header_r
+    puts @padding * 3 + @explain_r + $/ * 2
+
+    puts @padding * 2 + @header_R
+    puts @padding * 3 + @explain_R + $/ * 2
+
+    puts @padding * 2 + @header_c
+    puts @padding * 3 + @explain_c + $/ * 2
+
+    puts @padding * 2 + @header_n
+    puts @padding * 3 + @explain_n + $/ * 2 
+
+    puts @padding * 2 + @header_e
+    puts @padding * 3 + @explain_e + $/ * 2 
+
+    puts @padding * 2 + @header_v
+    puts @padding * 3 + @explain_v + $/ * 2
+
+    puts @padding * 2 + @header_h
+    puts @padding * 3 + @explain_h + $/ * 2
+
+    CE.once.rainbow
+    puts @padding * 2 + %(Let's enjoy colors!!) + $/ * 2
     exit 0
 end
 
+def warn_display(msg, header="Runtime")
+    warn(%(#{header} Warning:))
+    warn(" " * 4 + msg + $/ * 2)
+end
+
+def error_display(msg, header="Runtime")
+    msgls = msg.is_a?(Array) ? msg : [msg]
+    warn(%(#{header} Error:))
+    msgls.each do |msg|
+        warn(" " * 4 + msg + $/)
+    end
+    exit 1
+end
+
 # TODO need pager like 'less'?
 def display_color_index
     require_color_echo_get
@@ -174,7 +176,7 @@ def display_color_index
         mes += " " * 3
 
         if num % 8 == 0
-            mes += $/ + $/
+            mes += $/ * 2
             mes += @padding if num != 256
         end
     end
@@ -206,7 +208,7 @@ def display_symbol_list
     ]
     symbols_text_attr = [
         :bold,
-        :underscore,
+        :underline,
         :blink,
         :reverse_video,
         :concealed
@@ -222,7 +224,7 @@ def display_symbol_list
 
     header_colors     = "* foreground or background colors"
     header_text_attrs = "* text attributes"
-    CE.pickup([header_colors, header_text_attrs], :cyan, nil, [:underscore, :bold])
+    CE.pickup([header_colors, header_text_attrs], :cyan, nil, [:underline, :bold])
 
     puts @padding + header_colors
     symbols_color.each do |color_name|
@@ -233,7 +235,7 @@ def display_symbol_list
     end
 
     CE.off [:bg, :fg]
-    print $/ + $/
+    print $/ * 2
 
     puts @padding + header_text_attrs
     symbols_text_attr.each do |tx_name|

data/lib/color_echo/const.rb

@@ -1,8 +1,8 @@
 module CE
     LIBS_NAME   = "color_echo"
-    VERSION     = "2.0.4"
-    SUMMARY     = "Decorate the command line output with ANSI escape sequence."
-    DOCS_PAGE   = "https://github.com/khotta/color_echo"
+    VERSION     = "3.0.0"
+    SUMMARY     = "Decorates command line output with ANSI escape sequence."
+    HOMEPAGE    = "http://colorecho.net"
     DESCRIPTION = <<EOS
 #{SUMMARY}
 Text that output by "print, puts, p" method is decorated.

data/lib/color_echo/functions.rb

@@ -22,7 +22,7 @@ module CE
                 reset_bg
                 reset_tx
                 reset_pickup
-                reset_hitline
+                reset_highlight
                 reset_rainbow
             when :fg
                 reset_fg
@@ -32,8 +32,8 @@ module CE
                 reset_tx
             when :pickup
                 reset_pickup
-            when :hitline
-                reset_hitline
+            when :highlight
+                reset_highlight
             when :rainbow
                 reset_rainbow
             end
@@ -108,7 +108,7 @@ module CE
     # @param symbol bg
     # @param symbol tx
     # @return self
-    def pickup(target, fg=:red, bg=nil, *txs)
+    def pickup(target, fg=:cyan, bg=nil, *txs)
         key = target.object_id.to_s
         @@pickup_list[key] = {}
 
@@ -139,7 +139,9 @@ module CE
             end
         end
 
-        @@pickup_list[key][:code] = code_fg + code_bg + code_tx
+        @@pickup_list[key][:code]  = code_fg + code_bg + code_tx
+        @@pickup_list[key][:index] = @@cnt_pickups
+        @@cnt_pickups += 1
 
         return self
     end
@@ -155,49 +157,39 @@ module CE
 
     # change hit lines decoration
     # @return void
-    def hitline(fg=nil, bg=nil, *txs)
-        if fg.instance_of?(Symbol)
-            @@code_hitline_fg_color = convert_to_code("ForeGround", fg)
-        else
-            @@code_hitline_fg_color = ""
-        end
-
-        if bg.instance_of?(Symbol)
-            @@code_hitline_bg_color = convert_to_code("BackGround", bg)
-        else
-            @@code_hitline_bg_color = ""
-        end
+    def highlight(fg=nil, bg=nil, *txs)
+        fg = convert_to_code("ForeGround", fg)
+        bg = convert_to_code("BackGround", bg)
+        tx = ""
 
         if txs.size > 0
+            # if text attribute has input as array
             txs = txs[0] if txs[0].instance_of?(Array)
+
             txs.each do |name|
                 next if !name.is_a?(Symbol)
-                @@code_hitline_text_attr += convert_to_code("TextAttr", name)
+                tx += convert_to_code("TextAttr", name)
             end
         end
+        @@code_highlights << fg + bg + tx
 
         return self
     end
 
-    # get escape sequence code of that hit record line
-    # @return string
-    def get_hitline_code
-        return @@code_hitline_fg_color + @@code_hitline_bg_color + @@code_hitline_text_attr
-    end
-
     # get decorated text
     # require "color_echo/get"
     # @param string text
     def get(text)
         if @@allow_output
-            warn (%([WARNING] CE.get; If you want to use this module function; You have to require "color_echo/get" only!))
+            caller()[0] =~ /(.*?):(\d+)/
+            warn (%([WARNING] #{$1} #{$2}: You can't call CE.get. You must to read like -> require 'color_echo/get' ))
             return text
         end
 
         if !text.is_a?(String)
             text = text.to_s
         end
-        
+
         @@task.call(text)
     end
 
@@ -221,6 +213,19 @@ module CE
         return self
     end
 
+    # CE.get will be stateful
+    # @return self
+    def stateful
+        @@stateful_getter = true
+        return self
+    end
+
+    # CE.get will be stateless
+    def stateless
+        @@stateful_getter = false
+        return self
+    end
+
     # method alias
     alias_method :off,     :reset
     alias_method :disable, :reset

data/lib/color_echo/get.rb

@@ -1,7 +1,8 @@
 begin
     require "stringio"
 rescue LoadError
-    warn "color_echo required 'stringio'."
+    warn "'stringio' is required for color_echo."
+    exit 1
 end
 
 require_relative "const"

data/lib/color_echo/internal.rb

@@ -42,15 +42,14 @@ module CE
     # @return self
     def reset_pickup
         @@pickup_list = {}
+        @@cnt_pickups = 0
         return self
     end
 
-    # reset hitline code
+    # reset highlight code
     # @return self
-    def reset_hitline
-        @@code_hitline_bg_color  = ""
-        @@code_hitline_fg_color  = ""
-        @@code_hitline_text_attr = ""
+    def reset_highlight
+        @@code_highlights = []
         return self
     end
 
@@ -75,16 +74,31 @@ module CE
 
     # return start escape sequence code
     # @return string
-    def get_start_code(type=nil)
+    def get_start_code
         if @@rainbow
             return @@code_rainbow
-        elsif type == :hitline
-            return @@code_hitline_fg_color + @@code_hitline_bg_color + @@code_hitline_text_attr
         else
             return @@code_fg_color + @@code_bg_color + @@code_text_attr
         end
     end
 
+    # return start escape sequence code
+    # @param int index
+    # @return string
+    def get_highlight_code(index=0)
+        if @@code_highlights[index] == nil
+            code = @@code_highlights[0]
+            if code == nil
+                # e.g. no specify any -H option
+                return ""
+            else
+                return code
+            end
+        end
+
+        return @@code_highlights[index]
+    end
+
     # @return String
     def get_reset_code
         return self::Off::ALL
@@ -148,37 +162,64 @@ module CE
             text    = cleanup_text(text)
         end
 
-        is_match = false
+        match_pattern_keys = []
+        # repeat as called pickup method
         @@pickup_list.each_pair do |key, hash|
             patterns    = hash[:patterns]
             code_pickup = hash[:code]
+            index       = hash[:index]
 
-            # repeat to each specified pickup pattern
+            # repeat as patterns
             patterns.each do |pattern|
-                # pattern is Regexp
                 if pattern.is_a?(Regexp)
-                    after_text = ""
+                    # pattern is Regexp
+                    if (pattern =~ text && !match_pattern_keys.index(index))
+                        match_pattern_keys << index
+                    end
+
+                    if match_pattern_keys.size > 1
+                        code_highlight = get_highlight_code(0)
+                    else
+                        code_highlight = get_highlight_code(index)
+                    end
+
                     # global match
+                    after_text = ""
                     (text.scan(pattern)).size.times do
                         pattern =~ text
-                        after_text += $` + get_reset_code + code_pickup + $& + get_reset_code + get_start_code + get_start_code(:hitline)
+                        after_text += $` + get_reset_code + code_pickup + $& + get_reset_code + get_start_code + code_highlight
                         text = $'
                     end
-                    text     = after_text + text
-                    is_match = ($& != nil) if (!is_match)
+                    text = after_text + text
 
-                # pattern is String
                 else
-                    res      = text.gsub!(pattern, get_reset_code + code_pickup + pattern + get_reset_code + get_start_code + get_start_code(:hitline))
-                    is_match = (res != nil) if (!is_match)
+                    # pattern is String
+                    if (text.index(pattern) != nil && !match_pattern_keys.index(index))
+                        match_pattern_keys << index
+                    end
+
+                    if match_pattern_keys.size > 1
+                        code_highlight = get_highlight_code(0)
+                    else
+                        code_highlight = get_highlight_code(index)
+                    end
+
+                    text.gsub!(pattern, get_reset_code + code_pickup + pattern + get_reset_code + get_start_code + code_highlight)
                 end
             end
         end
 
-        if is_match
-            text = get_start_code(:hitline) + text + get_reset_code
-        elsif @@refresh_pre_match
-            text = orgtext
+        if match_pattern_keys.size == 0
+            # not match
+            text = orgtext if @@refresh_pre_match
+            return text
+        end
+
+        if match_pattern_keys.size == 1
+            text = get_highlight_code(match_pattern_keys[0]) + text + get_reset_code
+        else
+            # many pattern matched, use first -H option
+            text = get_highlight_code(0) + text + get_reset_code
         end
 
         return text
@@ -189,7 +230,7 @@ module CE
     # @param symbol name
     # @return string
     def convert_to_code(module_name, name)
-        return "" if (name == nil || name == "")
+        return "" if (!name.is_a?(Symbol) || name == :nil)
 
         begin
             cname = name.to_s.swapcase