color_echo 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0200fec858bea1e367e23aa75a6fc4fff1f81df5
-  data.tar.gz: 6a7e5cecc4aa224c739287eacbb4ce26211bc6b2
+  metadata.gz: 51b73486f80605fc2b29e9a87129e3f528222599
+  data.tar.gz: a1fcdaa02b03ee665075e7768fa05931f5a9216f
 SHA512:
-  metadata.gz: 53ed7b16d9c2a4ab792eaaa8df91d7886eed13079d501f94f4dc1a588163cd31b78726949bf093fb233517fb9d67f0e17d95852344737aa947d5faeca517b80c
-  data.tar.gz: d1ca2fccfd254044ffa771404fea3b85ea8082c6601a0c8174361f4a0223a313a00af0139da7e36e260d81446e27ca025038d3ef848790efb3e6a6ae97d5465c
+  metadata.gz: 3640bb11d8f5477ab2cc93b809e9f691e42ff28d9d174a7d2dab546d96cad801aacecb33e18b3faf668d29b9c4f93ca658896d0d5fb223527db30c205585928c
+  data.tar.gz: b180b3d77e7df8420c8ad493768407b6031161722c8af5efb60d50ea43e4eb9a2fe6600f104701ad98396c0c3d09103f88a4db07a7ccbd469cbc6876db6973b3

data/README.md

@@ -3,7 +3,7 @@ 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.7.0   
+Version: 0.8.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
@@ -25,7 +25,23 @@ ex.) CE.ch :index197, :index230
 ![screen shot](/images/color_index.png)
 ![screen shot](/images/color_index2.png)
 
-### You can run on the command line
+## You can to decorate your specified words!   
+
+```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)
+
+
+## You can run on the command line
 <pre>
     * Usage
         color_echo [options]
@@ -43,14 +59,26 @@ ex.) CE.ch :index197, :index230
 If your server using the rbenv, You have to do `rbenv rehash`.
 </pre>
 
+
 ## module functions
-#### CE.ch_fg :symbol
+
+#### CE.pickup(target, foreground=:red, backgruond=nil, text_attribute)    
+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 or array of them
+ - Parameter foreground -> symbol|nil
+ - Parameter background -> symbol|nil
+ - Parameter text_attribute -> symbol or array of them
+ - Return -> self
+
+
+#### CE.ch_fg(foreground)
 Change the foreground color to the your specified color.    
  - Alias -> fg    
- - Parameter -> symbol    
+ - Parameter foreground -> symbol    
  - Return -> self    
 
-* symbol list:    
+* symbol list of foreground:    
     * black  
     * red   
     * green   
@@ -74,13 +102,13 @@ ex.) CE.ch_fg :red #=> foreground color will be changed red
 
 
 
-#### CE.ch_bg :symbol   
+#### CE.ch_bg(background)   
 Change the background color to the your specified color.     
  - Alias -> bg   
- - Parameter -> symbol    
+ - Parameter background -> symbol    
  - Return -> self    
 
-* symbol list:    
+* symbol list of background:    
     * black  
     * red   
     * green   
@@ -103,13 +131,13 @@ ex.) CE.ch_bg :white #=> background color will be changed white
 
 
 
-#### CE.ch_tx :symbol   
+#### CE.ch_tx(text_attribute)        
 Change the text attribute to the your specified decoration.     
  - Alias -> tx   
- - Parameter -> symbol    
+ - Parameter attribute -> symbol or array of them   
  - Return -> self    
 
-* symbol list:    
+* symbol list of text attribute:    
     * bold  
     * underscore  
     * blink    
@@ -121,35 +149,41 @@ ex.) CE.ch_tx :blink #=> text blink on
 
 #### CE.ch foreground [,background [,text_attribute]]   
 Change collectively.     
- - Parameter foreground -> Symbol or nil    
- - Parameter background -> Symbol or nil     
- - Parameter text_attribute -> Symbol
+ - Parameter foreground -> symbol|nil    
+ - Parameter background -> symbol|nil     
+ - Parameter text_attribute -> symbol or array of them
  - Return -> self    
 
 ex.) CE.ch :white, :green   
 ex.) CE.ch :h_red, nil, :blink   
 
-#### CE.reset([target={:fg|:bg|:pickup]})  
+
+#### CE.reset(scope=:all)
 Reset to set the escape sequence.   
  - Alias -> off, disable    
- - Parameter target -> symbol   
+ - Parameter scope -> symbol or array of them
  - Return -> self    
 
-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.    
+ex.) CE.reset            #=> reset all of 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 :tx        #=> text attribute will be reset.    
+ex.) CE.reset :pickup    #=> pickup text will be reset.    
+ex.) CE.reset :rainbow   #=> rainbow mode will be reset and swich off.    
+ex.) CE.reset [:fg. :tx] #=> foreground color and ext attribute will be reset.     
 
 
 #### CE.once     
 Reset automatically after once output.     
  - Return -> self    
 
+
 #### CE.times(cnt)
 Reset automatically after cnt times output.     
  - Parameter cnt -> Integer    
  - Return -> self    
 
+
 ```ruby   
 CE.once.ch :h_yellow, :h_red, :underscore
 puts "decorated"
@@ -173,29 +207,6 @@ Force ignore the function of this library.
 Text color will change to rainbow color.   
 
 
-## You can to decorate your specified words!   
-
-#### 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
-
-```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
@@ -283,6 +294,10 @@ puts "Disable rainbow mode."
 ![screen shot](/images/screenshot.png)
 
 ## Release Note
+* v0.8.0, 2014-01-14
+    * Changed for the specified arguments of reset method.
+    * Fixed 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)

data/bin/color_echo

@@ -3,59 +3,35 @@ require "color_echo"
 #require_relative "../lib/color_echo.rb"
 
 def usage
-    CE.ch :yellow
-    puts <<EOS
+    CE.once.ch :yellow
+    puts <<-EOS
     #{CE::LIBS_NAME} - #{CE::SUMMARY}
     VERSION: #{CE::VERSION}
     README: #{CE::DOCS_PAGE}
 
-EOS
+    EOS
 
-    CE.once.ch :cyan
-    puts <<EOS
-    * 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)
 
-    CE.once.ch :h_blue
-    puts <<EOS
-        color_echo [-h] [options]
-
-EOS
-
-    CE.once.ch :cyan
-    puts <<EOS
-    * Options
-EOS
-
-    CE.once.ch :h_green
-    puts <<EOS
-        -v:
-EOS
-
-    puts <<EOS
-            Display version of color_echo.
-
-EOS
-
-    CE.once.ch :h_green
-    puts <<EOS
-        --symbol_list, -s
-EOS
-
-    puts <<EOS
-            Display symbol list that can to specify.
-EOS
+    puts padding + "* Usage"
 
-    CE.once.ch :h_green
-    puts <<EOS
+    CE.once.ch :h_blue
+    puts padding * 2 + "color_echo [-h] [options]" + $/ + $/
 
-        --index_list, -l
-EOS
+    puts padding + "* Options"
 
-    puts <<EOS
-            Display color index list that can to specify.
+    puts padding + "-v:"
+    puts padding * 2 + "Display version of color_echo." + $/ + $/
 
-EOS
+    puts padding + "--symbol_list, -s"
+    puts padding * 2 + "Display symbol list that can to specify." + $/ + $/ 
+    
+    puts padding + "--index_list, -l"
+    puts padding * 2 + "Display color index list that can to specify." + $/ + $/
 
     exit
 end
@@ -88,7 +64,7 @@ def display_color_index
 end
 
 def display_symbol_list
-    symbols = [
+    symbols_color = [
         :black,
         :gray,
         :red,
@@ -104,10 +80,17 @@ def display_symbol_list
         :cyan,
         :h_cyan,
         :white,
-        :h_white,
+        :h_white
+    ]
+    symbols_text_attr = [
+        :bold,
+        :underscore,
+        :blink,
+        :reverse_video,
+        :concealed
     ]
 
-    CE.rainbow
+    CE.times(3).rainbow
     cnt     = 60
     padding = " " * 2
     mes     = "OK, Let me check color name list... :)"
@@ -115,14 +98,27 @@ def display_symbol_list
     puts padding + " " * ((cnt - mes.size)/2) + mes
     puts padding + "-" * cnt
 
-    symbols.each do |color_name|
+    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
+    symbols_color.each do |color_name|
         CE.off(:bg).fg color_name
-        print "#{padding}:#{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
 
-    CE.off
+    CE.off [:bg, :fg]
+    print $/ + $/
+
+    puts padding + header_text_attrs
+    symbols_text_attr.each do |tx_name|
+        CE.off(:tx).tx tx_name
+        puts "#{padding*2}:#{tx_name}" + " " * (30 - tx_name.to_s.size)
+    end
+
     print $/
 end
 

data/lib/color_echo/const.rb

@@ -1,6 +1,6 @@
 module CE
     LIBS_NAME = "color_echo"
-    VERSION   = "0.7.0"
+    VERSION   = "0.8.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/module_functions.rb

@@ -24,26 +24,83 @@ module CE
     end
 
     # reset code
+    # @param scope symbol|array
     # @return self
-    def reset(target=nil)
-        if target == :fg
-            @@code_fg_color = ""
+    def reset(scope=:all)
+        if scope.is_a?(Array)
+            scopes = scope
+        else
+            scopes = [scope]
+        end
 
-        elsif target == :bg
-            @@code_bg_color = ""
+        scopes.each do |scope|
+            case scope
+            when :all
+                reset_fg
+                reset_bg
+                reset_tx
+                reset_pickup
+                reset_rainbow
+            when :fg
+                reset_fg
+            when :bg
+                reset_bg
+            when :tx
+                reset_tx
+            when :pickup
+                reset_pickup
+            when :rainbow
+                reset_rainbow
+            end
+        end
 
-        elsif target == :pickup
-            @@pickup_list    = {}
+        return self
+    end
 
-        else
-            @@code_bg_color  = ""
-            @@code_fg_color  = ""
-            @@code_text_attr = ""
-            @@code_rainbow   = ""
-            @@rainbow        = false
-            @@pickup_list    = {}
-        end
+    # reset foreground code
+    # @return self
+    def reset_fg
+        @@code_fg_color = ""
+        return self
+    end
+
+    # reset background code
+    # @return self
+    def reset_bg
+        @@code_bg_color = ""
+        return self
+    end
+
+    # reset text attr code
+    # @return self
+    def reset_tx
+        @@code_text_attr = ""
+        return self
+    end
+
+    # reset pickup code
+    # @return self
+    def reset_pickup
+        @@pickup_list = {}
+        return self
+    end
 
+    # reset and off raubow mode
+    # @return self
+    def reset_rainbow
+        @@code_rainbow = ""
+        @@rainbow      = false
+        return self
+    end
+
+    # reset all state of code
+    # @return self
+    def reset_all
+        reset_fg
+        reset_bg
+        reset_tx
+        reset_pickup
+        reset_rainbow
         return self
     end
 
@@ -288,6 +345,12 @@ module CE
                     :enable?,
                     :unuse,
                     :reset,
+                    :reset_fg,
+                    :reset_bg,
+                    :reset_tx,
+                    :reset_pickup,
+                    :reset_rainbow,
+                    :reset_all,
                     :off,
                     :disable,
                     :times,

data/lib/color_echo/variables.rb

@@ -25,6 +25,8 @@ module CE
             # change output destination to STDOUT
             $stdout = STDOUT
 
+            #is_hit_pickup = false
+
             # output to STDOUT
             if @@rainbow
                 output = add_rainbow(strio.string)
@@ -33,7 +35,9 @@ module CE
 
                 # decorate pickup
                 if @@pickup_list.size > 0
+                    #before_output = String.new(output)
                     output = add_pickup_code(output)
+                    #is_hit_pickup = before_output != output
                 end
 
                 # add start code in haed
@@ -48,7 +52,10 @@ module CE
             # auto off
             if @@cnt_limit > 0
                 @@cnt_limit -= 1
-                reset if @@cnt_limit == 0
+                # to reset
+                if @@cnt_limit == 0
+                    reset [:fg, :bg, :tx, :rainbow]
+                end
             end
 
         # no available "color echo"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: color_echo
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - khotta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies: []
 description: |
   Decorate the command line output with ANSI escape sequence.
@@ -36,8 +36,11 @@ homepage: https://github.com/khotta/color_echo
 licenses:
 - MIT
 metadata: {}
-post_install_message: "\n\e[5mThank you for installing! (^-^)\e[0m\nSee also \e[31m\e[47m
-  \e[4mhttps://github.com/khotta/color_echo \e[0m\n\n"
+post_install_message: |2+
+
+  Thank you for installing! =(^x^=
+  See also https://github.com/khotta/color_echo
+
 rdoc_options: []
 require_paths:
 - lib