cli-colorize 1.0.0 → 1.1.0

data/lib/cli-colorize.rb

@@ -99,6 +99,31 @@ module CLIColorize
     STDOUT.print CLIColorize.colorize(text, color)
   end
 
+  # Call STDOUT.puts with the colorized text if STDOUT is a tty device.
+  # (If STDOUT has been redirected to a file, it will be a block device,
+  # not a tty device, and we wouldn't want the ANSI codes inserted.
+  def CLIColorize.puts_colorized_if_tty(text, color=nil)
+    STDOUT.puts(STDOUT.isatty ? CLIColorize.colorize(text, color) : text)
+  end
+
+  # instance method delegating to class method, see CLIColorize.puts_if_tty
+  def puts_colorized_if_tty(text, color=nil)
+    CLIColorize.puts_colorized_if_tty(text, color)
+  end
+
+  # Call STDOUT.print with the colorized text if STDOUT is a tty device.
+  # (If STDOUT has been redirected to a file, it will be a block device,
+  # not a tty device, and we wouldn't want the ANSI codes inserted.
+  def CLIColorize.print_colorized_if_tty(text, color=nil)
+    STDOUT.puts(STDOUT.isatty ? CLIColorize.colorize(text, color) : text)
+  end
+
+  # instance method delegating to class method, see CLIColorize.print_if_tty
+  def print_colorized_if_tty(text, color=nil)
+    CLIColorize.print_colorized_if_tty(text, color)
+  end
+
+
   # Use safe_colorize in conjunction with CLIColorize.off and CLIColorize.on to conditionally
   # determine whether or not output will be given the control characters for colorization.
   # This is designed to work with a command-line switch to the script that uses this module.
@@ -116,11 +141,13 @@ module CLIColorize
   def safe_colorize_active
     CLIColorize.on
   end
+  alias safe_colorize_activate safe_colorize_active
 
   # Makes the safe_colorize method return text without colorization control codes.
   def safe_colorize_deactive
     CLIColorize.off
   end
+  alias safe_colorize_deactivate safe_colorize_deactive
 
   # Call STDOUT.puts with the colorized text.
   def CLIColorize.safe_puts(text, color=nil)
@@ -151,9 +178,14 @@ module CLIColorize
     CLIColorize.default_color=(color)
   end
 
+  def CLIColorize.on?
+    ! @@off
+  end
+
   private
   # Call CLIColorize.off to turn off colorizing (for instance to make the output safe
   # for evaluation or for output sometimes not headed to the terminal).
-  def CLIColorize.off;  @@off = true;   end
-  def CLIColorize.on;   @@off = false;  end
+  def CLIColorize.off;  @@off = true;  nil; end
+  def CLIColorize.on;   @@off = false; nil; end
+
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: cli-colorize
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - Chris St. John
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-05 00:00:00 -05:00
+date: 2011-05-31 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -42,23 +38,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: command-line interface colorization library
+summary: A command-line interface colorization library.
 test_files: []