paint 0.8.1 → 0.8.2

data/CHANGELOG.rdoc

@@ -1,4 +1,8 @@
-=== 0.8.1 ==
+=== 0.8.2
+* Paint.[] with only a single string argument does not colorize the string anymore, but returns the plain string
+* New pseudo color :random - returns a random ansi color
+
+=== 0.8.1
 * Improve rgb function with better gray scale values
 * Add Paint.mode:
   * Set to false to deactivate colorizing
@@ -7,5 +11,5 @@
   * Tries to automatically detect your terminal's features
 * Minor changes
 
-=== 0.8.0 ===
+=== 0.8.0
 * Initial release

data/README.rdoc

@@ -10,8 +10,8 @@ Paint manages terminal colors and effects for you. It combines the strengths of
 * Custom shortcuts can be defined and flexibly mixed in
 * Fall-back modes for non-256-color terminals (Paint.mode), supported modes:
   * 256 colors
-  * 8 colors (ansi default)
-  * 16 colors (ansi default with bright effect)
+  * 8 colors (only ansi colors)
+  * 16 colors (only ansi colors, combined with bright effect)
 
 == Setup
 
@@ -39,24 +39,15 @@ The first argument given to Paint.[] is the string to colorize (if the object is
   Paint['Ruby', "gold", "snow"] # Paint supports rgb.txt color names, note that the arguments are strings (:yellow != "yellow")!
   Paint['Ruby', "#123456"]      # html like definitions are possible.
   Paint['Ruby', "fff"]          # another html hex definition
-  Paint['Ruby']                 # don't pass any argument to get one of eight random ansi foreground colors
+  Paint['Ruby', :random]        # pass :random to get one of eight random ansi foreground colors
   Paint['Ruby', :inverse]       # swaps fore- and background
   Paint['Ruby', :italic, :encircle, :rapid_blink, :overline] # probably not supported effects
+  Paint['Ruby']                 # don't pass any argument and the string will not be changed
 
 If you pass multiple colors, the first one is taken as foreground color and the second one defines the background color (all others will be ignored). To only change the background color, you have to pass a <tt>nil</tt> first. Effects can be passed in any order.
 
 To see more examples, checkout the specs.
 
-== Paint.mode
-
-You can choose between three ways to use <tt>Paint.[]</tt> by setting <tt>Paint.mode</tt> to one of the following:
-* 256:   full support
-* 16:    don't use 256 colors, but the ansi 8 ones (combined with bright effect)
-* 8:     don't use 256 colors, but the ansi 8 ones (combined without bright effect)
-* false: don't colorize at all
-
-Paint tries to detect automatically the proper value, but this is still experimental. Please open an issue if <tt>Paint.detect_mode</tt> yields a wrong value.
-
 == More details about terminal colors and effects
 
 Terminal colors/effects are set by {ansi escape sequences}[http://en.wikipedia.org/wiki/ANSI_escape_code]. These are strings that look like this: <tt>\e[X;X;X;X;X]m</tt> where X are integers with some meaning. For example, 0 means reset, 31 means red foreground and 41 red background. When you tell Paint to use one of the eight ansi base colors as foreground color, it just inserts a number between 30 and 37 in the sequence. The following colors are available:
@@ -105,6 +96,16 @@ Also see {en.wikipedia.org/wiki/ANSI_escape_code}[http://en.wikipedia.org/wiki/A
   54) :frame_off, :encircle_off
   55) :overline_off
 
+== Paint.mode
+
+You can choose between three ways to use <tt>Paint.[]</tt> by setting <tt>Paint.mode</tt> to one of the following:
+* 256:   full support
+* 16:    don't use 256 colors, but the ansi eight ones (combined with bright effect)
+* 8:     don't use 256 colors, but the ansi eight ones
+* false: don't colorize at all
+
+Paint tries to detect automatically the proper value, but this is still experimental. Please open an issue if <tt>Paint.detect_mode</tt> yields a wrong value for you.
+
 == Shortcuts
 
 Now for the fancy part: Color shortcuts for your gems and scripts! Note: You don't have to use them (and only stick to <tt>Paint.[]</tt>) ;)

data/lib/paint.rb

@@ -58,7 +58,7 @@ module Paint
     # Takes a string and color options and colorizes the string
     # See README.rdoc for details
     def [](string, *args)
-      if mode
+      if mode && !args.empty?
         color(*args) + string.to_s + NOTHING
       else
         string.to_s
@@ -68,56 +68,55 @@ module Paint
     # Sometimes, you only need the color
     # Used by []
     def color(*options)
-      return '' unless mode
+      return '' if !mode || options.empty?
       mix = []
       color_seen = false
 
-      if options.empty?
-        mix << random(false) # random foreground color
-      else
-        options.each{ |option|
-          case option
-          when Symbol
-            if ANSI_EFFECTS.keys.include?(option)
-              mix << effect(option)
-            elsif ANSI_COLORS.keys.include?(option)
-              mix  << simple(option, color_seen)
-              color_seen = true
-            else
-              raise ArgumentError, "Unknown color or effect: #{ option }"
-            end
-
-          when Array
-            if option.size == 3 && option.all?{ |n| n.is_a? Numeric }
-              mix << rgb(*(option + [color_seen])) # 1.8 workaround
-              color_seen = true
-            else
-              raise ArgumentError, "Array argument must contain 3 numerals"
-            end
-
-          when ::String
-            if option =~ /^#?(?:[0-9a-f]{3}){1,2}$/
-              mix << hex(option, color_seen)
-              color_seen = true
-            else
-              mix << rgb_name(option, color_seen)
-              color_seen = true
-            end
-
-          when Numeric
-            integer = option.to_i
-            color_seen = true if (30..49).include?(integer)
-            mix << integer
-
-          when nil
+      options.each{ |option|
+        case option
+        when Symbol
+          if option == :random
+            mix << random(color_seen)
+            color_seen = true
+          elsif ANSI_EFFECTS.keys.include?(option)
+            mix << effect(option)
+          elsif ANSI_COLORS.keys.include?(option)
+            mix  << simple(option, color_seen)
             color_seen = true
-          
           else
-            raise ArgumentError, "Invalid argument: #{ option.inspect }"
+            raise ArgumentError, "Unknown color or effect: #{ option }"
+          end
 
+        when Array
+          if option.size == 3 && option.all?{ |n| n.is_a? Numeric }
+            mix << rgb(*(option + [color_seen])) # 1.8 workaround
+            color_seen = true
+          else
+            raise ArgumentError, "Array argument must contain 3 numerals"
           end
-        }
-      end
+
+        when ::String
+          if option =~ /^#?(?:[0-9a-f]{3}){1,2}$/
+            mix << hex(option, color_seen)
+            color_seen = true
+          else
+            mix << rgb_name(option, color_seen)
+            color_seen = true
+          end
+
+        when Numeric
+          integer = option.to_i
+          color_seen = true if (30..49).include?(integer)
+          mix << integer
+
+        when nil
+          color_seen = true
+        
+        else
+          raise ArgumentError, "Invalid argument: #{ option.inspect }"
+
+        end
+      }
 
       wrap(*mix)
     end
@@ -127,8 +126,8 @@ module Paint
     # * 256    - 256 colors
     # * 16     - only ansi colors
     # * false  - no colorization!
-    def mode()     @mode.nil? ? detect_mode : @mode end
-    def mode=(val) @mode = val                      end
+    def mode() ( !defined?(@mode) || @mode.nil? ) ? detect_mode : @mode end
+    def mode=(val) @mode = val end
 
     # Adds ansi sequence
     def wrap(*ansi_codes)

data/lib/paint/shortcuts.rb

@@ -40,7 +40,7 @@ module Paint
             if args.empty? then color_code else color_code + Array(args).join + NOTHING end
           end
         }
-        private *shortcuts.keys unless shortcuts.empty?
+        private(*shortcuts.keys) unless shortcuts.empty?
       end
 
       # include variations, defined in child modules

data/lib/paint/version.rb

@@ -1,3 +1,3 @@
 module Paint
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

data/spec/paint_spec.rb

@@ -4,8 +4,8 @@ describe 'Paint.[]' do
   end
 
   context '(with no options)' do
-    it 'colorizes using a random ansi foreground color' do
-      Paint['J-_-L'].should =~ /\e\[3\dmJ-_-L\e\[0m/
+    it "doesn't colorize at all" do
+      Paint['J-_-L'].should == "J-_-L"
     end
   end
 
@@ -37,6 +37,10 @@ describe 'Paint.[]' do
     it 'understands a non-hex string as rgb color name (rgb.txt) and use it as foreground color' do
       Paint['J-_-L', "medium purple"].should == "\e[38;5;141mJ-_-L\e[0m"
     end
+
+    it 'colorizes using a random ansi foreground color' do
+      Paint['J-_-L', :random].should =~ /\e\[3\dmJ-_-L\e\[0m/
+    end
   end
   
   context '(with two colors)' do

metadata

@@ -2,7 +2,7 @@
 name: paint
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors: 
 - Jan Lelis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 Z
+date: 2011-07-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec