terminal_color 0.0.1

data/README.txt

@@ -0,0 +1,83 @@
+= Terminal Color
+Terminal Color is a tiny Ruby library for colorizing, or colourising, string output to the terminal.
+
+== Examples
+  require 'terminal_color/ansi'
+  
+  puts Terminal::Color::ANSI.color("Hello world!", :green)
+
+This isn't limited to strings
+
+  puts Terminal::Color::ANSI.color(Time.now, :yellow)
+
+Typing that chain of modules is going to get boring pretty quick
+
+  class String; include Terminal::Color::ANSI; end
+  puts "Warning".color(:black, :yellow_background)
+
+That's not limited to strings either
+
+  class Time; include Terminal::Color::ANSI; end
+  puts Time.now.color(:bold, :white, :black_background)
+
+We're not fussy about how you want to spell colour
+
+  puts Terminal::Colour::ANSI.colour("Tally Ho!", :red, :white_background)
+  puts "pip pip".colour(:blue)
+
+You can make colours run on
+
+  puts "this is red".color(:red, false)
+  puts "so is this!"
+  puts "lets put a stop to it now".style(:reset)
+
+style is just an alias to color, it's there because "foo".color(:bold) looks strange
+
+There are a few colours to choose from
+  black
+  red
+  green
+  yellow
+  blue
+  magenta
+  cyan
+  white
+  
+You can get them as a background by appending _background or _bg, and on some platforms a brighter version by prepending bright_. These work together so you can have bright_yellow_background for example.
+
+  puts "Warning".color(:black, :bright_yellow_background)
+
+There are some other not-strictly-colour options
+  reset
+  reset_forground (or reset_fg)
+  reset_background (or reset_bg)
+  negative (or inverse, or reverse)
+  bold
+  underline
+
+You can use raw ANSI codes too
+  puts Terminal::Color::ANSI.color("Italic, maybe", 3)
+
+== Licence
+
+The MIT License
+
+Copyright (c) 2009 Matthew Sadler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/terminal_color/ansi.rb

@@ -0,0 +1,94 @@
+module Terminal # :nodoc:
+  module Color # :nodoc:
+    module ANSI
+      BLACK = BLACK_FOREGROUND = 30
+      RED = RED_FOREGROUND = 31
+      GREEN = GREEN_FOREGROUND = 32
+      YELLOW = YELLOW_FOREGROUND = 33
+      BLUE = BLUE_FOREGROUND = 34
+      MAGENTA = MAGENTA_FOREGROUND = 35
+      CYAN = CYAN_FOREGROUND = 36
+      WHITE = WHITE_FOREGROUND = 37
+      
+      BRIGHT_BLACK = BRIGHT_BLACK_FOREGROUND = 90
+      BRIGHT_RED = BRIGHT_RED_FOREGROUND = 91
+      BRIGHT_GREEN = BRIGHT_GREEN_FOREGROUND = 92
+      BRIGHT_YELLOW = BRIGHT_YELLOW_FOREGROUND = 93
+      BRIGHT_BLUE = BRIGHT_BLUE_FOREGROUND = 94
+      BRIGHT_MAGENTA = BRIGHT_MAGENTA_FOREGROUND = 95
+      BRIGHT_CYAN = BRIGHT_CYAN_FOREGROUND = 96
+      BRIGHT_WHITE = BRIGHT_WHITE_FOREGROUND = 97
+      
+      BLACK_BACKGROUND = 40
+      RED_BACKGROUND = 41
+      GREEN_BACKGROUND = 42
+      YELLOW_BACKGROUND = 43
+      BLUE_BACKGROUND = 44
+      MAGENTA_BACKGROUND = 45
+      CYAN_BACKGROUND = 46
+      WHITE_BACKGROUND = 47
+      
+      BRIGHT_BLACK_BACKGROUND = 100
+      BRIGHT_RED_BACKGROUND = 101
+      BRIGHT_GREEN_BACKGROUND = 102
+      BRIGHT_YELLOW_BACKGROUND = 103
+      BRIGHT_BLUE_BACKGROUND = 104
+      BRIGHT_MAGENTA_BACKGROUND = 105
+      BRIGHT_CYAN_BACKGROUND = 106
+      BRIGHT_WHITE_BACKGROUND = 107
+      
+      RESET = 0
+      RESET_FOREGROUND = 39
+      RESET_BACKGROUND = 49
+      
+      BOLD = 1
+      NEGATIVE = INVERSE = REVERSE = 7
+      UNDERLINE = 4
+      
+      def self.escape(*args) # :nodoc:
+        args = [0] if args.empty?
+        "\e[#{args.join(";")}m"
+      end
+      
+      # :call-seq: ANSI.color(string, color, ...) -> colored_string
+      # 
+      # Returns a colored version of +string+
+      #  puts Terminal::Color::ANSI.color("Hello world!", :green)
+      #  puts Terminal::Color::ANSI.color("Warning", :black, :yellow_background)
+      # 
+      def self.color(string, *args)
+        reset = if args.last then true else args.pop end
+        args.map! {|arg| parse_color(arg)}
+        
+        "#{escape(*args)}#{string}#{escape(RESET) if reset}"
+      end
+      class << self
+        alias colour color
+        alias style color
+      end
+      
+      # :call-seq: obj.color(color, ...) -> colored_string
+      # 
+      # Returns a colored string representation of +obj+
+      #  puts "Hello world!".color(:green)
+      #  puts "Warning".color(:black, :yellow_background)
+      # 
+      def color(*args)
+        Terminal::Color::ANSI.color(self.to_s, *args)
+      end
+      alias colour color
+      alias style color
+      
+      private
+      def self.parse_color(string)
+        return string if string.is_a?(Integer)
+        
+        string = string.to_s.upcase
+        string.sub!(/_BG$/, "_BACKGROUND")
+        string.sub!(/_FG$/, "_FOREGROUND")
+        const_get(string)
+      end
+    end
+  end
+  Colour = Color
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: terminal_color
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matthew Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-15 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: A tiny Ruby library for colorizing terminal output.
+email: mat@sourcetagsandcodes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/terminal_color/ansi.rb
+- README.txt
+has_rdoc: true
+homepage: http://github.com/matsadler/terminal_color
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Terminal colors.
+test_files: []
+