color_echo 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71656796cab59b1ebe1d27d680e2ce4c30b7b604
-  data.tar.gz: 2406fffc8c2a85628cfc797da963bc8bf373e705
+  metadata.gz: b057ff2dcd468a18b71e8997da18992987c6749c
+  data.tar.gz: 02fe38f9973436d2793057c603b7bd4421b37e41
 SHA512:
-  metadata.gz: 9c955163de5d79d247474036f1a53608376e9e9383322bbc5b672ec8dada2618c32ed444f514c186f18fe4caed9f503780dae04cef29b66c342a8b1a0d3fa46c
-  data.tar.gz: 4ae8cca7ff900843822a143ab41b9d8dc38321dd948d011514010144afa9bd138366516995ffe5ea129ba5ec0c2003fc601526e0349bc27bc8a8489a560cc687
+  metadata.gz: e8da10993a717801bb3d13e1579cb13f7471a30ef1ec0457a9491a8d277647a2f5ed72862aa4f6f1b3f048dca3c66ddf2ae14b8e3d72ed4d23db208e94789a7e
+  data.tar.gz: 9dab57abc01d2bc31a4fa97ce28e4abf51b05a4cdf249631bd9f6326d56eff0dec3e3346302bf6c46f7060b217806648089c8e47d9e16a0e22275a10c1e857b9

data/README.md

@@ -1,9 +1,9 @@
 # color_echo
 Decorate the command line output with ANSI escape sequence.     
-String that is output by "print, puts, p" method is decorated.    
+Text that is output by "print, puts, p" method is decorated.    
 It is also can to decorate only your specified words!   
 
-Version: 0.9.0   
+Version: 1.0.0
 Compliant Rubys Version: 2.0.0, 2.1.0 (for Linux)  
 License: MIT  
 Gems repository: http://rubygems.org/gems/color_echo
@@ -61,23 +61,10 @@ puts "output is -> " + output
 ![screen shot](/images/get1.png)
 
 
-## You can run on the command line
-<pre>
-    * Usage
-        color_echo [options]
-
-    * Options
-        -v:
-            Display version of color_echo.
-
-        --symbol_list, -s
-            Display symbol list that can to specify.
-
-        --index_list, -l
-            Display color index list that can to specify.
-
-If your server using the rbenv, You have to do `rbenv rehash`.
-</pre>
+## Command Line Interface
+You can use color_echo on command line!   
+![screen shot](/images/cli1.png)
+![screen shot](/images/cli2.png)
 
 
 ## module functions
@@ -321,37 +308,40 @@ puts "Disable rainbow mode."
 ![screen shot](/images/screenshot.png)
 
 ## Release Note
+* v1.0.0, 
+    * Add command line interface.
+
 * v0.9.0, 2014-01-19
-    * Added a mode to receive as the words with ANSI escape sequence; without output to display.
+    * Add a mode to receive as the words with ANSI escape sequence; without output to display.
 
 * v0.8.0, 2014-01-14
-    * Changed for the specified arguments of reset method.
-    * Fixed small bugs.
+    * Change for the specified arguments of reset method.
+    * Fix small bugs.
 
 * v0.7.0, 2014-01-08
-    * Added new method -> pickup
-    * Added new symbol that can to specify in reset method of first parameter -> CE.reset(:pickup)
+    * Add new method -> pickup
+    * Add new symbol that can to specify in reset method of first parameter -> CE.reset(:pickup)
 
 * v0.6.0, 2014-01-05
-    * Added command line tool.
+    * Add command line tool.
 
 * v0.5.0, 2014-12-16
-    * Added a new method -> \#once, \#times
+    * Add a new method -> \#once, \#times
 
 * v0.4.0, 2014-12-11
-    * Can to select 256 colors.   
+    * Add 256 colors.
 
 * v0.3.0, 2014-12-08
-    * High color can now be selected.    
-    * Multiple text attribute can now be selected.   
-    * Added parameter to the #reset method.   
+    * Add high colors.
+    * Can to select multi value in ch_tx method.
+    * Add parameter to the #reset method.   
 
 * v0.2.4, 2014-12-04
-    * Can now be able to specify a non-string when rainbow mode.
-    * Cab now be able to take over the setting of other types of sequence when rainbow mode.
+    * Can to specify a non-string when rainbow mode.
+    * Cab take over the setting of other types of sequence when rainbow mode.
 
 * v0.2.3, 2014-12-02
-    * Fixed small bugs.
+    * Fix small bugs.
 
 * v0.2.0
     * Added new method -> rainbow

data/bin/color_echo

@@ -1,10 +1,28 @@
 #!/usr/bin/env ruby
-require "color_echo"
-#require_relative "../lib/color_echo.rb"
+
+def require_color_echo
+    require "color_echo"
+    #require_relative "../lib/color_echo"
+end
+
+def require_color_echo_get
+    require "color_echo/get"
+    #require_relative "../lib/color_echo/get"
+end
+
+def version
+    require_color_echo
+
+    puts CE::VERSION
+    exit 0 
+end
 
 def usage
+    require_color_echo
+
     CE.once.ch :yellow
     puts <<-EOS
+
     #{CE::LIBS_NAME} - #{CE::SUMMARY}
     VERSION: #{CE::VERSION}
     README: #{CE::DOCS_PAGE}
@@ -12,31 +30,97 @@ def usage
     EOS
 
     padding    = " " * 4
-    headers    = ["* Usage", "* Options"]
-    headers_op = ["-v:", "--symbol_list, -s", "--index_list, -l"]
-    CE.pickup(headers, :cyan)
-    CE.pickup(headers_op, :h_green)
+    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:", "-n:", "-h:"
+    ]
+    CE.pickup(headers, :h_green)
+    CE.pickup(headers_op, :cyan)
 
     puts padding + "* Usage"
 
-    CE.once.ch :h_blue
-    puts padding * 2 + "color_echo [-h] [options]" + $/ + $/
+    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" + $/ + $/
+    CE.off :fg
 
     puts padding + "* Options"
 
-    puts padding + "-v:"
-    puts padding * 2 + "Display version of color_echo." + $/ + $/
+    puts padding * 2 + "-v:"
+    puts padding * 3 + "Display version of color_echo." + $/ + $/
 
-    puts padding + "--symbol_list, -s"
-    puts padding * 2 + "Display symbol list that can to specify." + $/ + $/ 
+    puts padding * 2 + "--symbol_list:"
+    puts padding * 3 + "Display symbol list that can to specify."
+    puts padding * 3 + "short option is -s." + $/ + $/ 
     
-    puts padding + "--index_list, -l"
-    puts padding * 2 + "Display color index list that can to specify." + $/ + $/
+    puts padding * 2 + "--index_list:"
+    puts padding * 3 + "Display color index list that can to specify."
+    puts padding * 3 + "short option is -l." + $/ + $/ 
+
+    puts padding * 2 + "--pickup word [--pickup word ...]:"
+    puts padding * 3 + "Decorate your specified wrods. You can use this option any number of times."
+    puts padding * 3 + "Regular expressions can be used; like that -> /^foo/i"
+    puts padding * 3 + "short option is -p." + $/ + $/ 
+
+    puts padding * 2 + "--fg color_name:"
+    puts padding * 3 + "Decorate the foreground color."
+    puts padding * 3 + "short option is -f." + $/ + $/ 
+
+    puts padding * 2 + "--bg color_name:"
+    puts padding * 3 + "Decorate the background color."
+    puts padding * 3 + "short option is -b." + $/ + $/ 
+
+    puts padding * 2 + "--tx text_attribute[,...]:"
+    puts padding * 3 + "Decorate the text attribute."
+    puts padding * 3 + "short option is -t." + $/ + $/ 
+
+    puts padding * 2 + "--watch:"
+    puts padding * 3 + "Interactive mode. Break word is -> exit, quit, bye; Or Ctl + c"
+    puts padding * 3 + "short option is -w." + $/ + $/
+
+    puts padding * 2 + "-n:"
+    puts padding * 3 + "Do not output the trailing newline." + $/ + $/ 
+
+    puts padding * 2 + "-h:"
+    puts padding * 3 + "Show this message." + $/ + $/ 
+
+    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) + $/ + $/
+
+    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) + $/ + $/
+
+    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) + $/ + $/
+
+    CE.once.ch :h_magenta
+    puts padding * 2 + %(* color_echo can 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) + $/ + $/
 
     exit 0
 end
 
 def display_color_index
+    require_color_echo
+
     CE.rainbow
     cnt     = 134
     padding = " " * 2
@@ -66,6 +150,8 @@ def display_color_index
 end
 
 def display_symbol_list
+    require_color_echo
+
     symbols_color = [
         :black,
         :gray,
@@ -117,7 +203,8 @@ def display_symbol_list
 
     puts padding + header_text_attrs
     symbols_text_attr.each do |tx_name|
-        CE.off(:tx).tx tx_name
+        CE.off(:tx)
+        CE.tx tx_name if tx_name != :concealed
         puts "#{padding*2}:#{tx_name}" + " " * (30 - tx_name.to_s.size)
     end
 
@@ -126,26 +213,99 @@ def display_symbol_list
     exit 0
 end
 
-usage if ARGV.size != 1
+def output_interactive
+    exit_words = ["quit", "exit", "bye"]
+    while input = STDIN.gets
+        input.chomp!
+        exit 0 if exit_words.index(input)
+        eval(@code_decorate)
+        puts CE.get(input)
+    end
+end
+
+def output(target)
+    eval(@code_decorate)
+    begin
+        print CE.get(target)
+    rescue Errno::EPIPE
+    end
+end
+
+def parse_options
+    @fg = nil
+    @bg = nil
+    @tx = nil
+    @pickups = []
+    @is_watch = false
+    @last_lb  = true
+
+    require "optparse"
+    opt = OptionParser.new
+
+    opt.on("-h") { usage }
+    opt.on("-v") { version }
+    opt.on("-s", "--symbol_list")    { display_symbol_list }
+    opt.on("-l", "--index_list")     { display_color_index }
+    opt.on("--fg val", "-f val")     { |val| @fg = val }
+    opt.on("--bg val", "-b val")     { |val| @bg = val }
+    opt.on("--tx val", "-t val")     { |val| @tx = val }
+    opt.on("--pickup val", "-p val") { |val| @pickups << val }
+    opt.on("-w", "--watch")          { @is_watch = true }
+    opt.on("-n")                     { @last_lb = false }
+
+    begin
+        opt.parse!(ARGV)
 
-require "optparse"
-opt = OptionParser.new
+    rescue => err
+        warn "Parse Error! Please check usage!" + $/ + $/
+        usage
+    end
+
+    @fg = "yellow" if @fg == nil && @bg == nil && @tx == nil
+    @fg = @fg.intern if @fg != nil
+    @bg = @bg.intern if @bg != nil
+
+    if @tx != nil
+        res = []
+        @tx.split(",").each do |val|
+            res << val.intern
+        end
+        @tx = res
+    end
+
+    # parse pickups
+    if @pickups.size > 0
+        code_pickup = ""
+        @pickups.each_index do |index|
+            if @pickups[index][0] == "/" && (@pickups[index][-1] == "/" || @pickups[index][-2] == "/")
+                @pickups[index] = eval(@pickups[index])
+            end
+
+            code_pickup += %(.pickup(@pickups[#{index}], @fg, @bg, @tx))
+        end
+        @code_decorate = "CE" + code_pickup
+    else
+        @code_decorate = %(CE.ch(@fg, @bg, @tx))
+    end
+end
 
-opt.on("-h") { usage }
-opt.on("-v") { puts CE::VERSION; exit 0 }
-opt.on("-s", "--symbol_list") { display_symbol_list }
-opt.on("-l", "--index_list") { display_color_index }
+has_stdin = select([STDIN], [], [], 0) != nil || FileTest.pipe?(STDIN)
+usage if !has_stdin && ARGV.size == 0
 
-begin
-    opt.parse!(ARGV)
+# parse options and set the decorate code that execute by eval
+parse_options
 
-rescue OptionParser::InvalidOption => err
-    mess = "[OPTION ERROR] Invalid option ->"
-    err.args.each do |op|
-        mess += %( '#{op}')
+require_color_echo_get
+if @is_watch
+    # Interactive mode
+    output_interactive
+else
+    if has_stdin
+        target = STDIN.read
+    else
+        target = ARGV.join(" ")
+        target += $/ if @last_lb
     end
-    mess += " (OptionParser::InvalidOption)"
-    warn mess + $/ + $/
 
-    usage
+    output(target)
 end

data/lib/color_echo.rb

@@ -1,6 +1,6 @@
 # color_echo
 # Decorate the command line output with ANSI escape sequence.
-# String that is output by "print, puts, p" method is decorated.
+# Text that is output by "print, puts, p" method is decorated.
 # It is also can to decorate only your specified words!
 
 require_relative "color_echo/get"

data/lib/color_echo/const.rb

@@ -1,11 +1,11 @@
 module CE
     LIBS_NAME   = "color_echo"
-    VERSION     = "0.9.0"
+    VERSION     = "1.0.0"
     SUMMARY     = "Decorate the command line output with ANSI escape sequence."
     DOCS_PAGE   = "https://github.com/khotta/color_echo"
     DESCRIPTION = <<EOS
 #{SUMMARY}
-String that is output by "print, puts, p" method is decorated.
+Text that is output by "print, puts, p" method is decorated.
 It is also can to decorate only your specified words!
 EOS
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: color_echo
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - khotta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies: []
 description: |
   Decorate the command line output with ANSI escape sequence.
-  String that is output by "print, puts, p" method is decorated.
+  Text that is output by "print, puts, p" method is decorated.
   It is also can to decorate only your specified words!
 email: 
 executables: