color_echo 1.3.0 → 2.0.0

data/bin/lib/display.rb

@@ -1,15 +1,26 @@
-@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_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"
-@explain_n = "Do not output the trailing newline."
-@explain_e = "Enable interpretation of line feed."
-@explain_h = "Show this message."
-@explain_stripe  = "Decorate on every other line. pickup option is ignored."
+@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)
+@explain_n      = %(Do not output the trailing newline.)
+@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
+@explain_usage  = @padding * 2 + %(colorecho [options] message) + $/
+@explain_usage += @padding * 2 + %(colorecho [options] < /path/to/file) + $/
+@explain_usage += @padding * 2 + %(echo "message" | colorecho [options]) + $/
+@explain_usage += @padding * 2 + %(colorecho -v) + $/
+@explain_usage += @padding * 2 + %(colorecho -s) + $/
+@explain_usage += @padding * 2 + %(colorecho -l) + $/
+@explain_usage += @padding * 2 + %(colorecho -h)
 
 def version
     require_color_echo
@@ -23,140 +34,151 @@ def usage
 
     CE.once.ch :yellow
     puts <<-EOS
-
     #{CE::LIBS_NAME} - #{CE::SUMMARY}
     VERSION: #{CE::VERSION}
     README: #{CE::DOCS_PAGE}
 
     EOS
 
-    padding    = " " * 4
     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:", "-n:", "-e:", "-h:"
+                    "-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:"
     ]
     CE.pickup(headers, :h_green)
     CE.pickup(headers_op, :cyan)
 
-    puts padding + "* Usage"
+    puts @padding + "* Usage"
 
     CE.ch :h_blue
-    puts padding * 2 + "color_echo [options] text"
-    puts padding * 2 + "color_echo [options] < /path/to/file"
-    puts padding * 2 + "echo text | color_echo [options]"
-    puts padding * 2 + "color_echo -v"
-    puts padding * 2 + "color_echo -s"
-    puts padding * 2 + "color_echo -l"
-    puts padding * 2 + "color_echo -h" + $/ + $/
+    puts @explain_usage + $/ + $/
     CE.off :fg
 
-    puts padding + "* Options"
-
-    puts padding * 2 + "-v:"
-    puts padding * 3 + @explain_v + $/ + $/
+    puts @padding + "* Options"
 
-    puts padding * 2 + "--symbol-list:"
-    puts padding * 3 + @explain_s
-    puts padding * 3 + "short option is -s." + $/ + $/ 
+    puts @padding * 2 + "--symbol-list:"
+    puts @padding * 3 + @explain_s
+    puts @padding * 3 + "short option is -s." + $/ + $/ 
     
-    puts padding * 2 + "--index-list:"
-    puts padding * 3 + @explain_l
-    puts padding * 3 + "short option is -l." + $/ + $/ 
+    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 + "--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 + "--tx text_attribute[,...]:"
+    puts @padding * 3 + @explain_t
+    puts @padding * 3 + "short option is -t." + $/ + $/ 
 
-    puts padding * 2 + "--fg color_name:"
-    puts padding * 3 + @explain_f
-    puts padding * 3 + "short option is -f." + $/ + $/ 
+    puts @padding * 2 + "--watch:"
+    puts @padding * 3 + @explain_w
+    puts @padding * 3 + "short option is -w." + $/ + $/
 
-    puts padding * 2 + "--bg color_name:"
-    puts padding * 3 + @explain_b
-    puts padding * 3 + "short option is -b." + $/ + $/ 
+    puts @padding * 2 + "--stripe:"
+    puts @padding * 3 + @explain_stripe + $/ + $/
 
-    puts padding * 2 + "--tx text_attribute[,...]:"
-    puts padding * 3 + @explain_t
-    puts padding * 3 + "short option is -t." + $/ + $/ 
+    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 + "--watch:"
-    puts padding * 3 + @explain_w
-    puts padding * 3 + "short option is -w." + $/ + $/
+    puts @padding * 2 + "--refresh:"
+    puts @padding * 3 + @explain_R
+    puts @padding * 3 + "short option is -R." + $/ + $/
 
-    puts padding * 2 + "--stripe:"
-    puts padding * 3 + @explain_stripe + $/ + $/
+    puts @padding * 2 + "-n:"
+    puts @padding * 3 + @explain_n + $/ + $/ 
 
-    puts padding * 2 + "-n:"
-    puts padding * 3 + @explain_n + $/ + $/ 
+    puts @padding * 2 + "-e:"
+    puts @padding * 3 + @explain_e + $/ + $/ 
 
-    puts padding * 2 + "-e:"
-    puts padding * 3 + @explain_e + $/ + $/ 
+    puts @padding * 2 + "-v:"
+    puts @padding * 3 + @explain_v + $/ + $/
 
-    puts padding * 2 + "-h:"
-    puts padding * 3 + @explain_h + $/ + $/ 
+    puts @padding * 2 + "--help:"
+    puts @padding * 3 + @explain_h
+    puts @padding * 3 + "short option is -h." + $/ + $/
 
-    puts padding + "* Example"
+    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 | color_echo -w -p "127.0.0.1" -t bold)
-    puts padding * 3 + %(tailf /var/log/php/php_error.log | color_echo -w -p "foo.php" -p "Fatal error:" -f h_blue) + $/ + $/
+    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 | color_echo -p "Sun Jan 18" -f h_cyan -t underscore | less)
-    puts padding * 3 + %(color_echo -p "Sun Jan 18" -f h_cyan -t underscore < /var/log/httpd/access_log | less)
-    puts padding * 3 + %((color_echo -f cyan -p /\\\\s2..\\\\s/ | color_echo -f h_red -p /\\\\s5..\\\\s/ | less) < /var/log/httpd/access_log)
-    puts padding * 3 + %(sed -n 1,1000p /var/log/httpd/access_log | color_echo -f cyan -p /\\\\s2..\\\\s/ | color_echo -f h_red -p /\\\\s5..\\\\s/ | less) + $/ + $/
+    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 + %(color_echo Hello\\!\\! -f h_white -b index199)
-    puts padding * 3 + %(color_echo Hello\\!\\! -t blink,bold -f 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 | color_echo -t reverse_video)
-    puts padding * 3 + %(echo FooFoOfOO | color_echo -f index130 -p /foo$/i | color_echo -f index180 -p /^foo/i)
-    puts padding * 3 + %(netstat -na | color_echo -p ":80" | color_echo -p "127.0.0.1" -f h_cyan) + $/ + $/
+    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 + %(color_echo -f gray -t bold --stripe < /path/to/file)
-    puts padding * 3 + %(tailf /var/log/httpd/access_log | color_echo -w -f black -b index150 -t bold --stripe) + $/ + $/
+    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) + $/ + $/
+
+    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) + $/ + $/
 
     exit 0
 end
 
+# TODO need pager like 'less'?
 def display_color_index
-    require_color_echo
+    require_color_echo_get
 
     CE.rainbow
-    cnt     = 134
-    padding = " " * 2
-    mes     = "OK, Let me check color index list... :)"
-    puts padding + "-" * cnt
-    puts padding + " " * ((cnt - mes.size)/2) + mes
-    puts padding + "-" * cnt
-
-    print padding
+    cnt      = 134
+    @padding = " " * 2
+
+    header = "OK, Let me check color index list... :)"
+    mes    = CE.rainbow.get(@padding + "-" * cnt) + $/
+    mes   += @padding + " " * ((cnt - header.size)/2) + CE.rainbow.get(header) + $/
+    mes   += CE.rainbow.get(@padding + "-" * cnt) + $/
+
+    mes += @padding
     256.times do |i|
         num = i + 1
-        CE.fg "index#{num}".intern
-        print "index#{num}" + " " * (4 - num.to_s.size)
-        CE.bg "index#{num}".intern
-        print " " * 5
-        CE.off
-        print " " * 3
+        mes += CE.fg("index#{num}".intern).get("index#{num}" + " " * (4 - num.to_s.size))
+        mes += CE.bg("index#{num}".intern).get(" " * 5)
+        mes += " " * 3
 
         if num % 8 == 0
-            print $/ + $/
-            print padding if num != 256
+            mes += $/ + $/
+            mes += @padding if num != 256
         end
     end
-    CE.off
+    print mes   
 
     exit 0
 end
@@ -192,20 +214,20 @@ def display_symbol_list
 
     CE.times(3).rainbow
     cnt     = 60
-    padding = " " * 2
+    @padding = " " * 2
     mes     = "OK, Let me check color name list... :)"
-    puts padding + "-" * cnt
-    puts padding + " " * ((cnt - mes.size)/2) + mes
-    puts padding + "-" * cnt
+    puts @padding + "-" * cnt
+    puts @padding + " " * ((cnt - mes.size)/2) + mes
+    puts @padding + "-" * cnt
 
     header_colors     = "* foreground or background colors"
     header_text_attrs = "* text attributes"
     CE.pickup([header_colors, header_text_attrs], :cyan, nil, [:underscore, :bold])
 
-    puts padding + header_colors
+    puts @padding + header_colors
     symbols_color.each do |color_name|
         CE.off(:bg).fg color_name
-        print "#{padding*2}:#{color_name}" + " " * (11 - color_name.to_s.size)
+        print "#{@padding*2}:#{color_name}" + " " * (11 - color_name.to_s.size)
         CE.bg color_name
         puts color_name.to_s + " " * (30 - color_name.to_s.size)
     end
@@ -213,15 +235,14 @@ def display_symbol_list
     CE.off [:bg, :fg]
     print $/ + $/
 
-    puts padding + header_text_attrs
+    puts @padding + header_text_attrs
     symbols_text_attr.each do |tx_name|
         CE.off(:tx)
         CE.tx tx_name if tx_name != :concealed
-        puts "#{padding*2}:#{tx_name}" + " " * (30 - tx_name.to_s.size)
+        puts "#{@padding*2}:#{tx_name}" + " " * (30 - tx_name.to_s.size)
     end
 
     print $/
 
     exit 0
 end
-

data/lib/color_echo/const.rb

@@ -1,6 +1,6 @@
 module CE
     LIBS_NAME   = "color_echo"
-    VERSION     = "1.3.0"
+    VERSION     = "2.0.0"
     SUMMARY     = "Decorate the command line output with ANSI escape sequence."
     DOCS_PAGE   = "https://github.com/khotta/color_echo"
     DESCRIPTION = <<EOS

data/lib/color_echo/functions.rb

@@ -22,6 +22,7 @@ module CE
                 reset_bg
                 reset_tx
                 reset_pickup
+                reset_hitline
                 reset_rainbow
             when :fg
                 reset_fg
@@ -31,6 +32,8 @@ module CE
                 reset_tx
             when :pickup
                 reset_pickup
+            when :hitline
+                reset_hitline
             when :rainbow
                 reset_rainbow
             end
@@ -150,6 +153,38 @@ module CE
         return self
     end
 
+    # 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
+
+        if txs.size > 0
+            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)
+            end
+        end
+
+        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
@@ -166,6 +201,26 @@ module CE
         @@task.call(text)
     end
 
+    # Enable refresh flag
+    # @return self
+    def enable_refresh(scope=:all)
+        if scope == :all
+            @@refresh = true
+        elsif scope == :prematch
+            @@refresh_pre_match = true
+        end
+
+        return self
+    end
+
+    # Disable refresh flag
+    # @return self
+    def disable_refresh
+        @@refresh = false
+        @@refresh_pre_match = false
+        return self
+    end
+
     # method alias
     alias_method :off,     :reset
     alias_method :disable, :reset

data/lib/color_echo/internal.rb

@@ -45,6 +45,15 @@ module CE
         return self
     end
 
+    # reset hitline code
+    # @return self
+    def reset_hitline
+        @@code_hitline_bg_color  = ""
+        @@code_hitline_fg_color  = ""
+        @@code_hitline_text_attr = ""
+        return self
+    end
+
     # reset and off raubow mode
     # @return self
     def reset_rainbow
@@ -66,9 +75,11 @@ module CE
 
     # return start escape sequence code
     # @return string
-    def get_start_code
+    def get_start_code(type=nil)
         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
@@ -82,6 +93,7 @@ module CE
     # add reset & start code to line feed code
     # @param string input
     def add_reset_line_feed(input)
+        input = input.unpack("C*").pack("U*") if !input.valid_encoding?
         input.gsub!(/#{$/}/, get_reset_code + $/ + get_start_code)
         input += get_reset_code
         return input
@@ -100,6 +112,7 @@ module CE
                 next
             end
 
+            # TODO This way so lame...
             case cnt
             when 0
                 output += ForeGround::RED + char + Off::ALL + get_start_code
@@ -129,9 +142,16 @@ module CE
     # @param string text
     # @return string
     def add_pickup_code(text)
+        if @@refresh_pre_match
+            # remove sequence code from given If it matches pickups
+            orgtext = text.clone
+            text    = cleanup_text(text)
+        end
+
+        is_match = false
         @@pickup_list.each_pair do |key, hash|
-            patterns = hash[:patterns]
-            code     = hash[:code]
+            patterns    = hash[:patterns]
+            code_pickup = hash[:code]
 
             # repeat to each specified pickup pattern
             patterns.each do |pattern|
@@ -141,18 +161,26 @@ module CE
                     # global match
                     (text.scan(pattern)).size.times do
                         pattern =~ text
-                        after_text += $` + code + $& + get_reset_code + get_start_code
+                        after_text += $` + get_reset_code + code_pickup + $& + get_reset_code + get_start_code + get_start_code(:hitline)
                         text = $'
                     end
-                    text = after_text + text
+                    text     = after_text + text
+                    is_match = ($& != nil) if (!is_match)
 
                 # pattern is String
                 else
-                    text.gsub!(pattern, code + pattern + get_reset_code + get_start_code)
+                    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)
                 end
             end
         end
 
+        if is_match
+            text = get_start_code(:hitline) + text + get_reset_code
+        elsif @@refresh_pre_match
+            text = orgtext
+        end
+
         return text
     end
 
@@ -183,4 +211,12 @@ module CE
     def task
         return @@task
     end
+
+    # try to remove escape sequence code
+    # @param string text
+    # @return texgt
+    def cleanup_text(text)
+        text.gsub!(/\e\[[0-9;]+[mK]/, "")
+        return text
+    end
 end