color_echo 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39af711706bd8e500fc5673edc8df5a5fb03d607
-  data.tar.gz: 15a50d0d65ebcedaf5d3ea50e20963278aacbddb
+  metadata.gz: 7565b0674d6e694fb86b29c669f8e9580bcba009
+  data.tar.gz: a7af71f546e59d6f34cb474a9c62e64689c5966a
 SHA512:
-  metadata.gz: 2d0c3bb3813a90203a0d99f1dbc4519ea9991ad15310d5496284602bdcb26c62b6c58bd6e08d01688bcaccef7adb66470924f4689c17a2a993d6208185d90ed3
-  data.tar.gz: a37cb37999324b77806bf25ef69781f8e8091355231d0534b1fa2ab3ec7edbacbbf63746aea89045782b636f8ef2b9e594d8addd3826d6ad1d613fd1248e91e8
+  metadata.gz: ed1abf84de39e9b85d2ca6354a3ed6889f2c9489039eebd1737f6cb3d0ec580cf8720ab60c64693c9c58e10e4885ed90e87f44a4ddbab0a8423a589b62f4e8c1
+  data.tar.gz: 8b37bcab33978dbddc0d3e397ecc01f47db1e40227ebeb0ff73e812ded1d83b9f2c3e7c6231a279da742ed811f21c48bb5920e979a4afb824bdbce553a2d1b63

data/README.md

@@ -3,7 +3,7 @@ Using the ANSI escape sequence and give it a color on the command line output.
 This Library will extend the Kernel module's functions(#print, #puts, #p).   
 Required StringIO.   
 
-Version: 0.4.0   
+Version: 0.5.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
@@ -22,10 +22,10 @@ Or install it yourself as:
 
 ### module functions
 #### CE.ch_fg :symbol
-Change the foreground color to the your specified color.  
-Alias is, fg   
-This method alias is available in version 0.2.0 on and after.   
-return self.   
+Change the foreground color to the your specified color.    
+ - Alias -> fg (available in v0.2.0 on and after)     
+ - Parameter -> Symbol    
+ - Return -> self    
 
 * symbol list:    
     * black  
@@ -37,7 +37,7 @@ return self.
     * cyan  
     * white   
     
-    available in version 0.3.0 on and after.    
+    available in v0.3.0 on and after.    
     * gray   
     * h_red   
     * h_green   
@@ -47,18 +47,20 @@ return self.
     * h_cyan   
     * h_white   
 
-    available in version 0.4.0 on and after.   
+    available in v0.4.0 on and after.   
     * index[1-256]   
 
 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 is, bg   
-This method alias is available in version 0.2.0 on and after.   
-return self.   
 
 
+
+#### 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    
+ - Return -> self    
+
 * symbol list:    
     * black  
     * red   
@@ -69,7 +71,7 @@ return self.
     * cyan  
     * white  
     
-    available in version 0.3.0 on and after.    
+    available in v0.3.0 on and after.    
     * gray   
     * h_red   
     * h_green   
@@ -79,7 +81,7 @@ return self.
     * h_cyan   
     * h_white   
 
-    available in version 0.4.0 on and after.   
+    available in v0.4.0 on and after.   
     * index[1-256]   
 
 ex.) CE.ch_bg :white #=> background color will be changed white  
@@ -87,7 +89,10 @@ ex.) CE.ch_bg :white #=> background color will be changed white
 
 
 #### CE.ch_tx :symbol   
-Change the text attribute to the your specified decoration. 
+Change the text attribute to the your specified decoration.     
+ - Alias -> tx (available in v0.2.0 on and after)     
+ - Parameter -> Symbol    
+ - Return -> self    
 
 * symbol list:    
     * bold  
@@ -96,46 +101,74 @@ Change the text attribute to the your specified decoration.
     * reverse_video 
     * concealed   
 
-Alias is, tx   
-This method alias is available in version 0.2.0 on and after.   
-return self.   
 ex.) CE.ch_tx :blink #=> text blink on   
 
 
-
 #### CE.ch foreground [,background [,text_attribute]]   
-Change collectively.  
+Change collectively.     
+This method is available in v0.1.0 on and after.   
+ - Parameter foreground -> Symbol     
+ - Parameter background -> Symbol     
+ - Parameter text_attribute -> Symbol     
+ - Return -> self    
+
 ex.) CE.ch :white, :green   
-This method is available in version 0.1.0 on and after.   
-return self.   
 
 
-#### CE.reset([target={:fg|:bg]})     
+#### CE.reset([target={:fg|:bg]})  
 Reset to set the escape sequence.   
-Alias is, off, disable      
-This method alias is available in version 0.1.0 on and after.   
-Parameters can v0.3.0 on and after be specified.   
+ - Alias -> off, disable (available in v0.1.0 on and after)    
+ - Parameter target -> Symbol (available in v0.3.0 on and after)     
+ - 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.    
-return self.   
 
 
+#### 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    
+
+```ruby   
+CE.once.ch :h_yellow, :h_red, :underscore
+puts "decorated"
+puts "switch off"
+
+puts "\n"
+
+CE.times(3).rainbow
+puts "one"
+puts "two"
+puts "three"
+puts "switch off"
+```
+![screen shot](/images/result_off.png)
+
 #### CE.unuse
 Force ignore the function of this library.    
-This method is available in version 0.1.0 on and after.   
+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 version 0.2.0 on and after.   
+This method is available in v0.2.0 on and after.   
 
 
 ### Can to select 256 colors!    
 Please install color_echo and do `ruby test/check_color_index_list.rb`.    
+ex.) CE.ch :index197, :index230    
 ![screen shot](/images/color_index.png)
+![screen shot](/images/color_index2.png)
 
 
 ### Example
@@ -166,7 +199,7 @@ p "AAAAA", "BBBBB", "CCCCC"
 ary = ["Duis", "aute", "irure", "dolor", "in", "reprehenderit", "in", "voluptate"]
 
 CE.off
-puts "turn off all colors and attribute."
+puts "switch off all colors and attribute."
 
 CE.fg :red
 puts ary
@@ -224,6 +257,9 @@ puts "Disable rainbow mode."
 ![screen shot](/images/screenshot.png)
 
 ## Release Note
+* v0.5.0, 2014-12-16
+    * added a new method -> \#once, \#times
+
 * v0.4.0, 2014-12-11
     * Can to select 256 colors.   
 

data/lib/color_echo/module_functions.rb

@@ -38,6 +38,18 @@ module CE
         return self
     end
 
+    # auto off until output set count
+    # @params int cnt
+    # @return self
+    def times(cnt)
+        @@cnt_limit = cnt
+        return self
+    end
+
+    def once
+        times(1)
+    end
+
     # @param Symbol name
     # @return self
     def ch_fg(name)
@@ -187,6 +199,8 @@ module CE
                     :reset,
                     :off,
                     :disable,
+                    :times,
+                    :once,
                     :ch_fg,
                     :fg,
                     :ch_bg,

data/lib/color_echo/variables.rb

@@ -6,6 +6,7 @@ module CE
     @@code_text_attr = ""
     @@code_rainbow   = ""
     @@rainbow        = false
+    @@cnt_limit      = 0
 
     @@print = method :print
     @@p     = method :p
@@ -33,6 +34,12 @@ module CE
                 $stdout.print add_reset_line_feed(strio.string)
             end
 
+            # auto off
+            if @@cnt_limit > 0
+                @@cnt_limit -= 1
+                reset if @@cnt_limit == 0
+            end
+
         # no available "color echo"
         else
             # call original method

data/lib/color_echo/version.rb

@@ -1,3 +1,3 @@
 module CE
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: color_echo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - nyanko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies: []
 description: |
   Using the ANSI escape sequence and give it a color on the command line output.