rainbow 1.1 → 1.1.1

data/README.markdown

@@ -4,7 +4,7 @@ Rainbow
 About
 -----
 
-Rainbow extends ruby String class adding methods to wrap the string with "ANSI escape codes":http://en.wikipedia.org/wiki/ANSI_escape_code. 
+Rainbow extends ruby String class adding methods to wrap the string with [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code).
 
 Features
 --------
@@ -33,12 +33,22 @@ If you have 256-colors capable terminal you can also specify color in RGB which
     "Jolacz".color("#FFC482")
     "Jolacz".color("FFC482")
 
-It also has Windows support (uses win32console gem if installed, otherwise strings are returned unaltered).
+For support on Windows, you should install the following gems:
+
+  gem install windows-pr win32console
+
+If the gems aren't installed strings are simply returned unaltered.
+
+Rainbow can be disabled globally by setting:
+
+    Sickill::Rainbow.enabled = false
+
+It will be disabled by default if it detects that STDOUT is not a TTY.
 
 Installation
 ------------
 
-    gem install rainbow -s http://gemcutter.org
+    gem install rainbow
 
 Usage
 -----
@@ -46,3 +56,11 @@ Usage
     require 'rainbow'
     puts "this is red".foreground(:red) + " and " + "this on yellow bg".background(:yellow) + " and " + "even bright underlined!".underline.bright
 
+Rails Usage
+-----------
+
+You're probably wanting to add colour to your logs. To do so you must explicity enable rainbow because it will detect that STDOUT (ie: the log file) is not a TTY.
+To make things easy, create the file `config/initializers/rainbow.rb` and include the following:
+
+    require 'rainbow'
+    Sickill::Rainbow.enabled = true

data/lib/rainbow.rb

@@ -1,3 +1,5 @@
+require 'rbconfig'
+
 module Sickill
   module Rainbow
     class << self; attr_accessor :enabled; end
@@ -118,8 +120,11 @@ end
 
 String.send(:include, Sickill::Rainbow)
 
-begin
-  require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
-rescue LoadError
-  Sickill::Rainbow.enabled = false
+# On Windows systems, try to load the local ANSI support library
+if Config::CONFIG['host_os'] =~ /mswin|mingw/
+  begin
+    require 'Win32/Console/ANSI'
+  rescue LoadError
+    Sickill::Rainbow.enabled = false
+  end
 end

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  version: "1.1"
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Marcin Kulik
@@ -13,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-07 00:00:00 +02:00
+date: 2011-02-06 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -41,6 +42,7 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -48,6 +50,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -57,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rainbow extends ruby String class enabling coloring text on ANSI terminals