color_echo 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 120d4b59dd2fd42500f5936e8d0a48ecaa022640
-  data.tar.gz: 121a6a958155b520f09fb50ed975e77776f3c3dd
+  metadata.gz: 0200fec858bea1e367e23aa75a6fc4fff1f81df5
+  data.tar.gz: 6a7e5cecc4aa224c739287eacbb4ce26211bc6b2
 SHA512:
-  metadata.gz: 5382227d1dbdc744c494ec55d4d20b760e44dfac856e68878f5a780b7bc86bb39aa14a120ae8a2e0cb35ffcb6841ce9fe16d56106278d956993e575a38e6ed56
-  data.tar.gz: 5679f4b1a3e012ed0860509e959bbe8c72a160e9b139d33b60888039e1de4c88b9cd423e985ffe448478a03d3f0aaf767ec1971e6690ec3f9cfa61cd1d806afc
+  metadata.gz: 53ed7b16d9c2a4ab792eaaa8df91d7886eed13079d501f94f4dc1a588163cd31b78726949bf093fb233517fb9d67f0e17d95852344737aa947d5faeca517b80c
+  data.tar.gz: d1ca2fccfd254044ffa771404fea3b85ea8082c6601a0c8174361f4a0223a313a00af0139da7e36e260d81446e27ca025038d3ef848790efb3e6a6ae97d5465c

data/README.md

@@ -1,9 +1,9 @@
 # color_echo
-Decorate the command line output with ANSI escape sequence.    
-This Library will extend the Kernel module's functions(#print, #puts, #p).   
-Required StringIO.   
+Decorate the command line output with ANSI escape sequence.     
+String that is output by "print, puts, p" method is decorated.    
+It is also can to decorate only your specified words!   
 
-Version: 0.6.0   
+Version: 0.7.0   
 Compliant Rubys Version: 1.9.3, 2.0.0, 2.1.0 (for Linux)  
 License: MIT  
 Gems repository: http://rubygems.org/gems/color_echo
@@ -18,13 +18,36 @@ Or install it yourself as:
 
     $ gem install color_echo
 
-## Usage
 
-### module functions
+## Can to select 256 colors!    
+Please install color_echo and do `color_echo -l`.   
+ex.) CE.ch :index197, :index230    
+![screen shot](/images/color_index.png)
+![screen shot](/images/color_index2.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>
+
+## module functions
 #### CE.ch_fg :symbol
 Change the foreground color to the your specified color.    
- - Alias -> fg (available in v0.2.0 on and after)     
- - Parameter -> Symbol    
+ - Alias -> fg    
+ - Parameter -> symbol    
  - Return -> self    
 
 * symbol list:    
@@ -36,8 +59,6 @@ Change the foreground color to the your specified color.
     * magenta  
     * cyan  
     * white   
-    
-    available in v0.3.0 on and after.    
     * gray   
     * h_red   
     * h_green   
@@ -46,8 +67,6 @@ Change the foreground color to the your specified color.
     * h_magenta   
     * h_cyan   
     * h_white   
-
-    available in v0.4.0 on and after.   
     * index[1-256]   
 
 ex.) CE.ch_fg :red #=> foreground color will be changed red  
@@ -57,8 +76,8 @@ ex.) CE.ch_fg :red #=> foreground color will be changed red
 
 #### CE.ch_bg :symbol   
 Change the background color to the your specified color.     
- - Alias -> bg (available in v0.2.0 on and after)     
- - Parameter -> Symbol    
+ - Alias -> bg   
+ - Parameter -> symbol    
  - Return -> self    
 
 * symbol list:    
@@ -70,8 +89,6 @@ Change the background color to the your specified color.
     * magenta  
     * cyan  
     * white  
-    
-    available in v0.3.0 on and after.    
     * gray   
     * h_red   
     * h_green   
@@ -80,8 +97,6 @@ Change the background color to the your specified color.
     * h_magenta   
     * h_cyan   
     * h_white   
-
-    available in v0.4.0 on and after.   
     * index[1-256]   
 
 ex.) CE.ch_bg :white #=> background color will be changed white  
@@ -90,8 +105,8 @@ ex.) CE.ch_bg :white #=> background color will be changed white
 
 #### CE.ch_tx :symbol   
 Change the text attribute to the your specified decoration.     
- - Alias -> tx (available in v0.2.0 on and after)     
- - Parameter -> Symbol    
+ - Alias -> tx   
+ - Parameter -> symbol    
  - Return -> self    
 
 * symbol list:    
@@ -106,34 +121,32 @@ ex.) CE.ch_tx :blink #=> text blink on
 
 #### CE.ch foreground [,background [,text_attribute]]   
 Change collectively.     
-This method is available in v0.1.0 on and after.   
- - Parameter foreground -> Symbol     
- - Parameter background -> Symbol     
- - Parameter text_attribute -> Symbol     
+ - Parameter foreground -> Symbol or nil    
+ - Parameter background -> Symbol or nil     
+ - Parameter text_attribute -> Symbol
  - Return -> self    
 
 ex.) CE.ch :white, :green   
+ex.) CE.ch :h_red, nil, :blink   
 
-
-#### CE.reset([target={:fg|:bg]})  
+#### CE.reset([target={:fg|:bg|:pickup]})  
 Reset to set the escape sequence.   
- - Alias -> off, disable (available in v0.1.0 on and after)    
- - Parameter target -> Symbol (available in v0.3.0 on and after)     
+ - Alias -> off, disable    
+ - Parameter target -> symbol   
  - Return -> self    
 
-ex.) CE.reset :fg #=> foreground color will be reset.    
-ex.) CE.reset :bg #=> background color will be reset.    
-ex.) CE.reset     #=> All reset the set escape sequence.    
+ex.) CE.reset :fg      #=> foreground color will be reset.    
+ex.) CE.reset :bg      #=> background color will be reset.    
+ex.) CE.reset :pickup  #=> pickup text will be reset.    
+ex.) CE.reset          #=> All reset the set escape sequence.    
 
 
 #### CE.once     
 Reset automatically after once output.     
-This method is available in v0.5.0 on and after.   
  - Return -> self    
 
 #### CE.times(cnt)
 Reset automatically after cnt times output.     
-This method is available in v0.5.0 on and after.   
  - Parameter cnt -> Integer    
  - Return -> self    
 
@@ -154,40 +167,35 @@ puts "switch off"
 
 #### CE.unuse
 Force ignore the function of this library.    
-This method is available in v0.1.0 on and after.   
 
 
 #### CE.rainbow
 Text color will change to rainbow color.   
-~~String Object only. Non-string object is excluded.~~    
--> Can v0.2.4 on and after be able to specify a non-string when rainbow mode.   
-This method is available in v0.2.0 on and after.   
 
 
-### Can to select 256 colors!    
-Please install color_echo and do `color_echo -l`.   
-ex.) CE.ch :index197, :index230    
-![screen shot](/images/color_index.png)
-![screen shot](/images/color_index2.png)
+## You can to decorate your specified words!   
 
-### You can run on the command line
-<pre>
-    * Usage
-        color_echo [options]
-
-    * Options
-        -v:
-            Display version of color_echo.
+#### CE.pickup(target, foreground=:red, backgruond=nil, *textattr)    
+To decorate the words that specfied in the String or Regexp or Array of them.    
+If state of enable rainbow mode, This feature is disabled.    
+ - Parameter target -> String|Regexp|Array
+ - Parameter foreground -> Symbol or nil
+ - Parameter background -> Symbol or nil
+ - Parameter text_attribute -> Symbol
+ - Return -> self
 
-        --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`.
-This is available in v0.6.0 on and after.
-</pre>
+```ruby
+CE.fg(:h_cyan).pickup("color_echo", :h_white, :red, :underscore).pickup("COLOR_ECHO", :h_yellow)
+
+puts <<EOS
+xxxxxxxxxxxxxxxxxcolor_echoxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxcolor_echoxxxxxxxCOLOR_ECHOxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxcolor_echoxxxxxxxxxxcolor_echoxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+EOS
+```
+![screen shot](/images/pickup1.png)
 
 ### Example
 ```ruby
@@ -275,6 +283,10 @@ puts "Disable rainbow mode."
 ![screen shot](/images/screenshot.png)
 
 ## Release Note
+* 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)
+
 * v0.6.0, 2014-01-05
     * Added command line tool.
 
@@ -295,3 +307,11 @@ puts "Disable rainbow mode."
 
 * v0.2.3, 2014-12-02
     * Fixed small bugs.
+
+* v0.2.0
+    * Added new method -> rainbow
+    * Added some method alias.
+
+* v0.1.0
+    * Added new method -> ch, unuse
+    * Added some method alias.

data/lib/color_echo/const.rb

@@ -1,11 +1,11 @@
 module CE
     LIBS_NAME = "color_echo"
-    VERSION   = "0.6.0"
+    VERSION   = "0.7.0"
     SUMMARY   = "Decorate the command line output with ANSI escape sequence."
     DOCS_PAGE = "https://github.com/khotta/color_echo"
     DESCRIPTION = <<EOS
 #{SUMMARY}
-This Library will extend the Kernel module's functions(#print, #puts, #p).
-Required StringIO.
+String that is output by "print, puts, p" method is decorated.
+It is also can to decorate only your specified words!
 EOS
 end

data/lib/color_echo/module_functions.rb

@@ -1,38 +1,47 @@
 module CE
+    # is allow to use?
     # @return bool
-    def available?
-        return @@enable && isset?
+    def enable?
+        return @@enable
     end
 
+    # is allow to use? and is set code?
     # @return bool
-    def isset?
-        return get_start_code != "" || @@rainbow
+    def available?
+        return @@enable && isset?
     end
 
+    # is set code?
     # @return bool
-    def enable?
-        return @@enable
+    def isset?
+        return get_start_code != "" || @@pickup_list.size > 0 || @@rainbow
     end
 
+    # do not allow to use
     # @return void
     def unuse
         @@enable = false
     end
 
+    # reset code
     # @return self
     def reset(target=nil)
-        if (target == :fg)
+        if target == :fg
             @@code_fg_color = ""
 
-        elsif (target == :bg)
+        elsif target == :bg
             @@code_bg_color = ""
 
+        elsif target == :pickup
+            @@pickup_list    = {}
+
         else
             @@code_bg_color  = ""
             @@code_fg_color  = ""
             @@code_text_attr = ""
             @@code_rainbow   = ""
             @@rainbow        = false
+            @@pickup_list    = {}
         end
 
         return self
@@ -50,54 +59,105 @@ module CE
         times(1)
     end
 
-    # @param Symbol name
+    # @param symbol name
     # @return self
     def ch_fg(name)
         return nil if !name.instance_of?(Symbol)
+
         @@rainbow = false if @@rainbow
         @@code_fg_color = convert_to_code("ForeGround", name)
 
         return self
     end
 
-    # @param Symbol name
+    # @param symbol name
     # @return self
     def ch_bg(name)
         return nil if !name.instance_of?(Symbol)
+
         @@rainbow = false if @@rainbow
         @@code_bg_color = convert_to_code("BackGround", name)
 
         return self
     end
 
-    # @param array name - array of Symbols
+    # @param array name : Array of Symbols
     # @return self
     def ch_tx(*names)
         @@rainbow = false    if @@rainbow
         names     = names[0] if names[0].instance_of?(Array)
 
         names.each do |name|
-            return nil if !name.instance_of?(Symbol)
+            next if !name.instance_of?(Symbol)
             @@code_text_attr += convert_to_code("TextAttr", name)
         end
 
         return self
     end
 
-    # @param Symbol fg
-    # @param Symbol bg
-    # @param array  txs
+    # @param symbol fg
+    # @param symbol bg
+    # @param symbol|array txs
     # @return self
     def ch(fg, bg=nil, txs=nil)
         ch_fg(fg)
         ch_bg(bg)
-        ch_tx(*txs)
+        ch_tx(*txs)  # passing expand
 
         return self
     end
 
-    # return start color sequence code
-    # @return String
+    # to decorate only the specified target
+    # @param string|regexp|array target
+    # @param symbol fg
+    # @param symbol bg
+    # @param symbol tx
+    # @return self
+    def pickup(target, fg=:red, bg=nil, *txs)
+        key = target.object_id.to_s
+        @@pickup_list[key] = {}
+
+        if target.is_a?(Array)
+            @@pickup_list[key][:patterns] = target
+        else
+            @@pickup_list[key][:patterns] = [target]
+        end
+
+        if fg.instance_of?(Symbol)
+            code_fg = convert_to_code("ForeGround", fg)
+        else
+            code_fg = ""
+        end
+
+        if bg.instance_of?(Symbol)
+            code_bg = convert_to_code("BackGround", bg)
+        else
+            code_bg = ""
+        end
+
+        code_tx = ""
+        if txs.size > 0
+            txs = txs[0] if txs[0].instance_of?(Array)
+            txs.each do |name|
+                next if !name.instance_of?(Symbol)
+                code_tx += convert_to_code("TextAttr", name)
+            end
+        end
+
+        @@pickup_list[key][:code] = code_fg + code_bg + code_tx
+
+        return self
+    end
+
+    # change mode to rainbow
+    # @return void
+    def rainbow
+        @@rainbow      = true
+        @@code_rainbow = @@code_bg_color + @@code_text_attr
+    end
+
+    # return start escape sequence code
+    # @return string
     def get_start_code
         if @@rainbow
             return @@code_rainbow
@@ -112,23 +172,16 @@ module CE
     end
 
     # add reset & start code to line feed code
-    # @param String input
+    # @param string input
     def add_reset_line_feed(input)
         input.gsub!(/#{$/}/, CE::get_reset_code + $/ + CE::get_start_code)
         input += CE::get_reset_code
         return input
     end
 
-    # change mode to rainbow
-    # @return void
-    def rainbow
-        @@rainbow      = true
-        @@code_rainbow = @@code_bg_color + @@code_text_attr
-    end
-
     # add code to be a rainbow color
-    # @param String text
-    # @return String
+    # @param string text
+    # @return string
     def add_rainbow(text)
         cnt    = 0
         output = get_start_code
@@ -164,11 +217,44 @@ module CE
         return output
     end
 
+    # add pickup code
+    # @param string text
+    # @return string
+    def add_pickup_code(text)
+        @@pickup_list.each_pair do |key, hash|
+            patterns = hash[:patterns]
+            code     = hash[:code]
+
+            # repeat to each specified pickup pattern
+            patterns.each do |pattern|
+                # pattern is Regexp
+                if pattern.is_a?(Regexp)
+                    after_text = ""
+                    # global match
+                    (text.scan(pattern)).size.times do
+                        pattern =~ text
+                        after_text += $` + code + $& + get_reset_code + get_start_code
+                        text = $'
+                    end
+                    text = after_text + text
+
+                # pattern is String
+                else
+                    text.gsub!(pattern, code + pattern + get_reset_code + get_start_code)
+                end
+            end
+        end
+
+        return text
+    end
+
     # get sequence code by symbol
-    # @param String module_name
-    # @param Symbol name
-    # @return String
+    # @param string module_name
+    # @param symbol name
+    # @return string
     def convert_to_code(module_name, name)
+        return "" if (name == nil || name == "")
+
         begin
             cname = name.to_s.swapcase
 
@@ -185,12 +271,17 @@ module CE
         return code
     end
 
-    # @return Proc
+    # @return proc
     def task
         return @@task
     end
 
-    require_relative "alias_method.rb"
+    # method alias
+    alias_method :off,     :reset
+    alias_method :disable, :reset
+    alias_method :fg,      :ch_fg
+    alias_method :bg,      :ch_bg
+    alias_method :tx,      :ch_tx
 
     module_function :available?,
                     :isset?,
@@ -208,11 +299,13 @@ module CE
                     :ch_tx,
                     :tx,
                     :ch,
+                    :pickup,
+                    :rainbow,
                     :get_start_code,
                     :get_reset_code,
                     :add_reset_line_feed,
                     :add_rainbow,
-                    :rainbow,
+                    :add_pickup_code,
                     :convert_to_code,
                     :task
 end

data/lib/color_echo/variables.rb

@@ -6,6 +6,7 @@ module CE
     @@code_text_attr = ""
     @@code_rainbow   = ""
     @@rainbow        = false
+    @@pickup_list    = {}
     @@cnt_limit      = 0
 
     @@print = method :print
@@ -18,9 +19,6 @@ module CE
             strio   = StringIO.new
             $stdout = strio
 
-            # output color sequence
-            $stdout.print get_start_code if !@@rainbow
-
             # call original method
             eval("@@#{caller_locations(2).first.label}").call(*arg)
 
@@ -29,11 +27,24 @@ module CE
 
             # output to STDOUT
             if @@rainbow
-                $stdout.print add_rainbow(strio.string)
+                output = add_rainbow(strio.string)
             else
-                $stdout.print add_reset_line_feed(strio.string)
+                output = strio.string
+
+                # decorate pickup
+                if @@pickup_list.size > 0
+                    output = add_pickup_code(output)
+                end
+
+                # add start code in haed
+                output = get_start_code + output
+
+                # add reset code in front of line feed
+                output = add_reset_line_feed(output)
             end
 
+            $stdout.print output
+
             # auto off
             if @@cnt_limit > 0
                 @@cnt_limit -= 1

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: color_echo
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - khotta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies: []
 description: |
   Decorate the command line output with ANSI escape sequence.
-  This Library will extend the Kernel module's functions(#print, #puts, #p).
-  Required StringIO.
+  String that is output by "print, puts, p" method is decorated.
+  It is also can to decorate only your specified words!
 email: 
 executables:
 - color_echo
@@ -24,7 +24,6 @@ files:
 - README.md
 - bin/color_echo
 - lib/color_echo.rb
-- lib/color_echo/alias_method.rb
 - lib/color_echo/const.rb
 - lib/color_echo/module/background.rb
 - lib/color_echo/module/foreground.rb

data/lib/color_echo/alias_method.rb

@@ -1,7 +0,0 @@
-module CE
-    alias_method :off,     :reset
-    alias_method :disable, :reset
-    alias_method :fg,      :ch_fg
-    alias_method :bg,      :ch_bg
-    alias_method :tx,      :ch_tx
-end