color_echo 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ec85d1bace70cdff14ecc1ce007aa998ce2c3c6
-  data.tar.gz: f0f58f7f2b30dfc534071597787ba1fc243ff1aa
+  metadata.gz: 222c2ae72f62a588fc6e1f25a214bda6103e69f8
+  data.tar.gz: 0170867e3a2ac9f705226f2a3d86656bf1b0fcd1
 SHA512:
-  metadata.gz: 613d899d95e99406f59b89508cacc0666c52ba7a44daef6967c16ecc2c14beae2c1f16c266fb9969af6a659f1f01509a835b68af82e6e927978c832d46b3d8c6
-  data.tar.gz: 6fbe68a495bd36b09461ceecefe60e73d66652e55564fce43b3000fc7d3d8546b796802195eea08ddd80c9bd768badc8cc13a379feb894af6e8049946ddb4f79
+  metadata.gz: bea7e278f6e1a131970bcb82d647e571610f5d8e33630a76d8f727305af5a63c3408dc1161d3aa32a83a98724e5a02fbb571f7ec3cbba83c6db51fd5e62cbaef
+  data.tar.gz: 5c64c7aefdf1aa03972a5ee8daeca71afe958ddeb63a64c451c0aa428115583ed1a28a77579e4f46959ab863afc78399b587b7b6a93e817c589f1929013f4d10

data/README.md

@@ -1,9 +1,9 @@
 # color_echo
-To add color to the command line output.  
+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.   
+Required StringIO.   
 
-Version: 0.2.4   
+Version: 0.3.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,6 +25,7 @@ Or install it yourself as:
 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.   
 
 * symbol list:    
     * black  
@@ -34,7 +35,17 @@ This method alias is available in version 0.2.0 on and after.
     * blue   
     * magenta  
     * cyan  
-    * white  
+    * white   
+    
+    available in version 0.3.0 on and after.    
+    * gray   
+    * h_red   
+    * h_green   
+    * h_yellow   
+    * h_blue   
+    * h_magenta   
+    * h_cyan   
+    * h_white   
 
 ex.) CE.ch_fg :red #=> foreground color will be changed red  
 
@@ -42,6 +53,7 @@ ex.) CE.ch_fg :red #=> foreground color will be changed red
 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.   
 
 
 * symbol list:    
@@ -53,9 +65,21 @@ This method alias is available in version 0.2.0 on and after.
     * magenta  
     * cyan  
     * white  
+    
+    available in version 0.3.0 on and after.    
+    * gray   
+    * h_red   
+    * h_green   
+    * h_yellow   
+    * h_blue   
+    * h_magenta   
+    * h_cyan   
+    * h_white   
 
 ex.) CE.ch_bg :white #=> background color will be changed white  
 
+
+
 #### CE.ch_tx :symbol   
 Change the text attribute to the your specified decoration. 
 
@@ -66,28 +90,40 @@ Change the text attribute to the your specified decoration.
     * reverse_video 
     * concealed   
 
-ex.) CE.ch_tx :blink #=> text blink on
 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]]  
+#### CE.ch foreground [,background [,text_attribute]]   
 Change collectively.  
-This method is available in version 0.1.0 on and after.   
 ex.) CE.ch :white, :green   
+This method is available in version 0.1.0 on and after.   
+return self.   
 
-#### CE.reset
-Reset to set the color sequence.   
+
+#### 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.   
+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.unuse
 Force ignore the function of this library.    
 This method is available in version 0.1.0 on and after.   
 
+
 #### CE.rainbow
 Text color will change to rainbow color.   
-~~String Object only. Non-string object is excluded.~~ ->
-Be able to specify a non-string when rainbow mode at version 0.2.4 on and after.    
+~~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.   
 
 ### Example
@@ -95,7 +131,7 @@ This method is available in version 0.2.0 on and after.
 #
 # Example Code
 #
-require "color_echo"
+#require "color_echo"
 
 # force ignore the function of this library
 #CE.unuse
@@ -129,7 +165,7 @@ print ary
 CE.tx :underscore
 p ary
 
-CE.ch :black, :white, :blink
+CE.fg(:black).bg(:white).tx(:blink)
 puts <<EOM
 Lorem ipsum dolor sit amet,
 consectetur adipisicing elit,
@@ -137,6 +173,7 @@ sed do eiusmod tempor incididunt
 ut labore et dolore magna aliqua.
 EOM
 
+CE.off
 CE.rainbow
 puts "fooooooooo"
 puts "baaaaaaaar"
@@ -160,8 +197,7 @@ sed do eiusmod tempor incididunt
 ut labore et dolore magna aliqua.
 EOM
 
-CE.tx :underscore
-CE.bg :black
+CE.tx(:underscore).bg(:black)
 CE.rainbow
 hash = {:foo => [111, 222, 333], :bar => {:str => String}}
 p hash
@@ -175,11 +211,15 @@ puts "Disable rainbow mode."
 
 ![screen shot](/images/screenshot.png)
 
-
 ## Release Note
-* v0.2.3, 2014-12-02
-    * Fixed small bugs.
+* v0.3.0, 2014-12-08
+    * High color can now be selected.    
+    * Multiple text attribute can now be selected.   
+    * Add parameter to the #reset method.   
 
 * v0.2.4, 2014-12-04
-    * Be able to specify a non-string when rainbow mode.
-    * Be able to take over the setting of other types of sequence when rainbow mode.
+    * 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.
+
+* v0.2.3, 2014-12-02
+    * Fixed small bugs.

data/lib/color_echo.rb

@@ -1,9 +1,9 @@
 # color_echo
 #
-# To add color to the command line output.
+# 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).
-# @autor: Kazuya Hotta (nyanko)
-
+# Required StringIO.
+#
 begin
     require "stringio"
 rescue LoadError
@@ -11,10 +11,10 @@ rescue LoadError
 end
 
 require_relative "color_echo/version.rb"
-require_relative "color_echo/const.rb"
-require_relative "color_echo/variables.rb"
-require_relative "color_echo/background.module.rb"
 require_relative "color_echo/foreground.module.rb"
+require_relative "color_echo/background.module.rb"
 require_relative "color_echo/textattr.module.rb"
+require_relative "color_echo/off.module.rb"
+require_relative "color_echo/variables.rb"
 require_relative "color_echo/module_functions.rb"
 require_relative "color_echo/override.rb"

data/lib/color_echo/background.module.rb

@@ -1,12 +1,20 @@
 module CE
     module BackGround
-        BLACK    = "\e[40m"
-        RED      = "\e[41m"
-        GREEN    = "\e[42m"
-        YELLOW   = "\e[43m"
-        BLUE     = "\e[44m"
-        MAGENTA  = "\e[45m"
-        CYAN     = "\e[46m"
-        WHITE    = "\e[47m"
+        BLACK     = "\033[40m"
+        RED       = "\033[41m"
+        GREEN     = "\033[42m"
+        YELLOW    = "\033[43m"
+        BLUE      = "\033[44m"
+        MAGENTA   = "\033[45m"
+        CYAN      = "\033[46m"
+        WHITE     = "\033[47m"
+        GRAY      = "\033[100m"
+        H_RED     = "\033[101m"
+        H_GREEN   = "\033[102m"
+        H_YELLOW  = "\033[103m"
+        H_BLUE    = "\033[104m"
+        H_MAGENTA = "\033[105m"
+        H_CYAN    = "\033[106m"
+        H_WHITE   = "\033[107m"
     end
 end

data/lib/color_echo/foreground.module.rb

@@ -1,12 +1,20 @@
 module CE
     module ForeGround
-        BLACK   = "\e[30m"
-        RED     = "\e[31m"
-        GREEN   = "\e[32m"
-        YELLOW  = "\e[33m"
-        BLUE    = "\e[34m"
-        MAGENTA = "\e[35m"
-        CYAN    = "\e[36m"
-        WHITE   = "\e[37m"
+        BLACK     = "\033[30m"
+        RED       = "\033[31m"
+        GREEN     = "\033[32m"
+        YELLOW    = "\033[33m"
+        BLUE      = "\033[34m"
+        MAGENTA   = "\033[35m"
+        CYAN      = "\033[36m"
+        WHITE     = "\033[37m"
+        GRAY      = "\033[90m"
+        H_RED     = "\033[91m"
+        H_GREEN   = "\033[92m"
+        H_YELLOW  = "\033[93m"
+        H_BLUE    = "\033[94m"
+        H_MAGENTA = "\033[95m"
+        H_CYAN    = "\033[96m"
+        H_WHITE   = "\033[97m"
     end
 end

data/lib/color_echo/module_functions.rb

@@ -1,12 +1,12 @@
 module CE
     # @return bool
     def available?
-        return @@enable && @@isset
+        return @@enable && isset?
     end
 
     # @return bool
     def isset?
-        return @@isset
+        return get_start_code != "" || @@rainbow
     end
 
     # @return bool
@@ -19,51 +19,69 @@ module CE
         @@enable = false
     end
 
-    # @return void
-    def reset
-        @@isset          = false
-        @@rainbow        = false
-        @@code_bg_color  = ""
-        @@code_fg_color  = ""
-        @@code_text_attr = ""
-        @@code_rainbow   = ""
+    # @return self
+    def reset(target=nil)
+        if (target == :fg)
+            @@code_fg_color = ""
+
+        elsif (target == :bg)
+            @@code_bg_color = ""
+
+        else
+            @@code_bg_color  = ""
+            @@code_fg_color  = ""
+            @@code_text_attr = ""
+            @@code_rainbow   = ""
+            @@rainbow        = false
+        end
+
+        return self
     end
 
     # @param Symbol name
-    # @return void
+    # @return self
     def ch_fg(name)
         return nil if !name.instance_of?(Symbol)
-        @@isset         = true  if !@@isset
-        @@rainbow       = false if @@rainbow
+        @@rainbow = false if @@rainbow
         @@code_fg_color = convert_to_code("ForeGround", name)
+
+        return self
     end
 
     # @param Symbol name
-    # @return void
+    # @return self
     def ch_bg(name)
         return nil if !name.instance_of?(Symbol)
-        @@isset         = true if !@@isset
-        @@rainbow       = false if @@rainbow
+        @@rainbow = false if @@rainbow
         @@code_bg_color = convert_to_code("BackGround", name)
+
+        return self
     end
 
-    # @param Symbol name
-    # @return void
-    def ch_tx(name)
-        return nil if !name.instance_of?(Symbol)
-        @@isset          = true if !@@isset
-        @@rainbow        = false if @@rainbow
-        @@code_text_attr = convert_to_code("TextAttr", name)
+    # @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)
+            @@code_text_attr += convert_to_code("TextAttr", name)
+        end
+
+        return self
     end
 
     # @param Symbol fg
     # @param Symbol bg
-    # @param Symbol tx
-    # @return void
-    def ch(fg, bg=nil, tx=nil)
+    # @param array  txs
+    # @return self
+    def ch(fg, bg=nil, txs=nil)
         ch_fg(fg)
         ch_bg(bg)
-        ch_tx(tx)
+        ch_tx(*txs)
+
+        return self
     end
 
     # return start color sequence code
@@ -78,7 +96,7 @@ module CE
 
     # @return String
     def get_reset_code
-        return self::CODE_RESET
+        return self::Off::ALL
     end
 
     # add reset & start code to line feed code
@@ -92,7 +110,6 @@ module CE
     # change mode to rainbow
     # @return void
     def rainbow
-        @@isset        = true if !@@isset
         @@rainbow      = true
         @@code_rainbow = @@code_bg_color + @@code_text_attr
     end
@@ -112,19 +129,19 @@ module CE
 
             case cnt
             when 0
-                output += ForeGround::RED + char + CODE_RESET + get_start_code
+                output += ForeGround::RED + char + Off::ALL + get_start_code
             when 1
-                output += ForeGround::GREEN + char + CODE_RESET + get_start_code
+                output += ForeGround::GREEN + char + Off::ALL + get_start_code
             when 2
-                output += ForeGround::YELLOW + char + CODE_RESET + get_start_code
+                output += ForeGround::YELLOW + char + Off::ALL + get_start_code
             when 3
-                output += ForeGround::BLUE + char + CODE_RESET + get_start_code
+                output += ForeGround::BLUE + char + Off::ALL + get_start_code
             when 4
-                output += ForeGround::MAGENTA + char + CODE_RESET + get_start_code
+                output += ForeGround::MAGENTA + char + Off::ALL + get_start_code
             when 5
-                output += ForeGround::CYAN + char + CODE_RESET + get_start_code
+                output += ForeGround::CYAN + char + Off::ALL + get_start_code
             when 6
-                output += ForeGround::WHITE + char + CODE_RESET + get_start_code
+                output += ForeGround::WHITE + char + Off::ALL + get_start_code
             end
             cnt += 1
             cnt  = 0 if cnt >= 7

data/lib/color_echo/off.module.rb

@@ -0,0 +1,7 @@
+module CE
+    module Off
+        ALL        = "\033[0m"
+        FOREGROUND = "\033[39m"
+        BACKGROUND = "\033[49m"
+    end
+end

data/lib/color_echo/textattr.module.rb

@@ -1,9 +1,9 @@
 module CE
     module TextAttr
-        BOLD          = "\e[1m"
-        UNDERSCORE    = "\e[4m"
-        BLINK         = "\e[5m"
-        REVERSE_VIDEO = "\e[7m"
-        CONCEALED     = "\e[8m"
+        BOLD          = "\033[1m"
+        UNDERSCORE    = "\033[4m"
+        BLINK         = "\033[5m"
+        REVERSE_VIDEO = "\033[7m"
+        CONCEALED     = "\033[8m"
     end
 end

data/lib/color_echo/version.rb

@@ -1,3 +1,3 @@
 module CE
-    VERSION = "0.2.4"
+    VERSION = "0.3.0"
 end

metadata

@@ -1,19 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: color_echo
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - nyanko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies: []
-description: 'To add color to the command line output.This Library will extend the
-  Kernel module''s functions(#print, #puts, #p). required StringIO.'
+description: |
+  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.
 email:
-- nyanko@dammy
+- khotta@users.noreply.github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -23,9 +25,9 @@ files:
 - lib/color_echo.rb
 - lib/color_echo/alias_method.rb
 - lib/color_echo/background.module.rb
-- lib/color_echo/const.rb
 - lib/color_echo/foreground.module.rb
 - lib/color_echo/module_functions.rb
+- lib/color_echo/off.module.rb
 - lib/color_echo/override.rb
 - lib/color_echo/textattr.module.rb
 - lib/color_echo/variables.rb
@@ -54,5 +56,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: To add color to the command line output.
+summary: Using the ANSI escape sequence and give it a color on the command line output.
 test_files: []

data/lib/color_echo/const.rb

@@ -1,3 +0,0 @@
-module CE
-    CODE_RESET = "\e[0m"
-end