jcf-ansi_color 0.3.2 → 0.4.1

data/README.md

@@ -0,0 +1,56 @@
+# ansi_color
+
+Add some simple methods that allow you to colourise and style your Strings with lovely Ruby syntactic sugar.
+
+## Contributors
+
+[Kacper Cieśla][comboy] improved print and puts loads with this [commit](http://github.com/comboy/ansi_color/commit/a66e3baf47aef2d3d60495c65a6a83153e7fa688). Thanks for your contributions [Kacper][comboy]!
+
+## Examples
+
+	require 'rubygems'
+	require 'ansi_color'
+	
+	AnsiColor.print('plain string')
+	# => "plain string"
+	
+	AnsiColor.puts('plain string')
+	# => "plain string\n"
+	
+	AnsiColor.print('coloured string', :color => :red,
+		:background => :black,
+		:effects => [:blink, :bold])
+	# => "\e[31;40;5;1mcoloured string\e[0m"
+	
+	AnsiColor.puts('coloured string', :color => :red,
+		:background => :black,
+		:effects => [:blink, :bold])
+	# => "\e[31;40;5;1mcoloured string\e[0m\n"
+	
+	AnsiColor.red
+	# => 31
+	
+	AnsiColor.red_background
+	# => 41
+	
+	AnsiColor.blink
+	# => 5
+
+## Adding colour methods to String
+
+### This doesn't work properly!
+
+Chaining methods works but isn't particularly ingenious.
+
+	require 'rubygems'
+	require 'ansi_color'
+	
+	class String
+		include AnsiColor::String
+	end
+	
+	'coloured string'.red.bold.blink
+	# => "\e[5m\e[1m\e[31mcoloured string\e[0m\e[0m\e[0m"
+
+[jcf]: http://github.com/jcf
+[comboy]: http://github.com/comboy

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 3
-:patch: 2
+:minor: 4
+:patch: 1

data/lib/ansi_color.rb

@@ -17,7 +17,7 @@ module AnsiColor
     :blink      => 5,
     :inverse    => 7
   }
-  FOREGROUND_COLOURS = {
+  FOREGROUND_COLORS = {
     :black   => 30,
     :red     => 31,
     :green   => 32,
@@ -27,7 +27,7 @@ module AnsiColor
     :cyan    => 36,
     :white   => 37
   }
-  BACKGROUND_COLOURS = {
+  BACKGROUND_COLORS = {
     :black   => 40,
     :red     => 41,
     :green   => 42,
@@ -38,17 +38,41 @@ module AnsiColor
     :white   => 47
   }
 
-  FOREGROUND_COLOURS.each do |name, code|
-    define_method(name) { code }
+  class << self
+    FOREGROUND_COLORS.each do |name, code|
+      define_method(name) { code }
+    end
+
+    BACKGROUND_COLORS.each do |name, code|
+      define_method("#{name}_background") { code }
+    end
+
+    EFFECTS.each do |name, code|
+      define_method(name) { code }
+    end
   end
 
-  BACKGROUND_COLOURS.each do |name, code|
-    define_method("#{name}_background") { code }
+  def self.print(*args)
+    if args.last.is_a?(Hash)
+       options = args.pop
+       open_tag = Helpers::build_open_tag(options)
+       string = args.map { |arg| arg.to_s }.join
+       super(open_tag + string + Helpers::reset)
+    else
+       super(*args)
+    end
   end
 
-  def ansi_tag(string, options={})
-    return string if options.empty?
-    open_tag = Helpers::build_open_tag(options)
-    open_tag + string + Helpers::reset
+  def self.puts(*args)
+    if args.last.is_a?(Hash)
+       options = args.pop
+       open_tag = Helpers::build_open_tag(options)
+       string = args.map { |arg| arg.to_s }.join("\n")
+       super(open_tag + string + Helpers::reset)
+    else
+       super(*args)
+    end
   end
-end
+end
+
+require "ansi_color/string"

data/lib/ansi_color/helpers.rb

@@ -1,19 +1,19 @@
 module AnsiColor
   class Helpers
     def self.code_from_name(name)
-      FOREGROUND_COLOURS[name] || raise(InvalidColorName, "#{name} is not a colour")
+      FOREGROUND_COLORS[name] || raise(InvalidColorName, "#{name} is not a colour")
     end
 
     def self.name_from_code(code)
-      FOREGROUND_COLOURS.index(code.to_i) || raise(InvalidColorCode, "#{code} is not a colour code")
+      FOREGROUND_COLORS.index(code.to_i) || raise(InvalidColorCode, "#{code} is not a colour code")
     end
 
     def self.code_from_background_name(name)
-      BACKGROUND_COLOURS[name] || raise(InvalidColorName, "#{name} is not a background colour")
+      BACKGROUND_COLORS[name] || raise(InvalidColorName, "#{name} is not a background colour")
     end
 
     def self.name_from_background_code(code)
-      BACKGROUND_COLOURS.index(code.to_i) || raise(InvalidColorCode, "#{code} is not a background colour code")
+      BACKGROUND_COLORS.index(code.to_i) || raise(InvalidColorCode, "#{code} is not a background colour code")
     end
 
     def self.build_open_tag(args={})
@@ -37,8 +37,6 @@ module AnsiColor
       fg = code_from_name(options[:color]) unless options[:color].nil?
       bg = code_from_background_name(options[:background]) unless options[:background].nil?
 
-      # options.reject! { |key, value| key == :color || key == :background }
-
       if effects = options[:effects]
         effects = Array(effects).flatten
         if (effects - EFFECTS.keys).empty?

data/lib/ansi_color/rainbow.rb

@@ -2,20 +2,20 @@ module AnsiColor
   class Rainbow
     def initialize
       puts "\n\n== build_open_tag FOREGROUND"
-      FOREGROUND_COLOURS.each do |fg_name, fg_code|
+      FOREGROUND_COLORS.each do |fg_name, fg_code|
         open = Helpers::build_open_tag(:color => fg_name)
         print "#{open}#{fg_name}#{Helpers::reset}\n"
       end
 
       puts "\n\n== build_open_tag BACKGROUND"
-      BACKGROUND_COLOURS.each do |bg_name, bg_code|
+      BACKGROUND_COLORS.each do |bg_name, bg_code|
         open = Helpers::build_open_tag(:background => bg_name)
         print "#{open}#{bg_name}#{Helpers::reset}\n"
       end
 
       puts "\n\n== build_open_tag FOREGROUND, BACKGROUND & EFFECT"
-      FOREGROUND_COLOURS.each do |fg_name, fg_code|
-        BACKGROUND_COLOURS.each do |bg_name, bg_code|
+      FOREGROUND_COLORS.each do |fg_name, fg_code|
+        BACKGROUND_COLORS.each do |bg_name, bg_code|
           open = Helpers::build_open_tag(:color => fg_name, :background => bg_name)
           print "#{open}#{fg_name} #{bg_name}#{Helpers::reset}\n"
           EFFECTS.each do |effect_name, effect_code|

data/lib/ansi_color/string.rb

@@ -0,0 +1,29 @@
+module AnsiColor
+  module String
+    FOREGROUND_COLORS.each do |name, code|
+      define_method name do
+        "#{E}#{code}m#{self}#{RESET}"
+      end
+    end
+
+    BACKGROUND_COLORS.each do |name, code|
+      define_method "#{name}_background" do
+        "#{E}0;#{code}m#{self}#{RESET}"
+      end
+    end
+
+    FOREGROUND_COLORS.each do |fg_name, fg_code|
+      BACKGROUND_COLORS.each do |bg_name, bg_code|
+        define_method "#{fg_name}_on_#{bg_name}" do
+          "#{E}#{fg_code};#{bg_code}m#{self}#{RESET}"
+        end
+      end
+    end
+
+    EFFECTS.each do |name, code|
+      define_method name do
+        "#{E}#{code}m#{self}#{E}0m"
+      end
+    end
+  end
+end

data/spec/ansi_color/helpers_spec.rb

@@ -69,20 +69,20 @@ describe Helpers do
 
   describe "should build tags" do
     it "color" do
-      Helpers::FOREGROUND_COLOURS.each do |name, code|
+      Helpers::FOREGROUND_COLORS.each do |name, code|
         Helpers.build_open_tag(:color => name).should == "\e[#{code}m"
       end
     end
 
     it "background" do
-      Helpers::BACKGROUND_COLOURS.each do |name, code|
+      Helpers::BACKGROUND_COLORS.each do |name, code|
         Helpers.build_open_tag(:background => name).should == "\e[0;#{code}m"
       end
     end
 
     it "colour and background" do
-      Helpers::FOREGROUND_COLOURS.each do |fg_name, fg_code|
-        Helpers::BACKGROUND_COLOURS.each do |bg_name, bg_code|
+      Helpers::FOREGROUND_COLORS.each do |fg_name, fg_code|
+        Helpers::BACKGROUND_COLORS.each do |bg_name, bg_code|
           Helpers.build_open_tag(:color => fg_name, :background => bg_name).should == "\e[#{fg_code};#{bg_code}m"
         end
       end
@@ -97,28 +97,14 @@ describe Helpers do
     end
   end
 
-  describe "code from name" do
-    Helpers::FOREGROUND_COLOURS.each do |name, code|
-      it "#{name} returns #{code}" do
-        Helpers.send(name).should == code
-      end
-    end
-
-    Helpers::BACKGROUND_COLOURS.each do |name, code|
-      it "#{name}_background returns #{code}" do
-        Helpers.send("#{name}_background").should == code
-      end
-    end
-  end
-
   describe "finds colour codes from names" do
-    Helpers::FOREGROUND_COLOURS.each do |name, code|
+    Helpers::FOREGROUND_COLORS.each do |name, code|
       it "code_from_name(:#{name}) returns #{code}" do
         Helpers.code_from_name(name).should == code
       end
     end
 
-    Helpers::BACKGROUND_COLOURS.each do |name, code|
+    Helpers::BACKGROUND_COLORS.each do |name, code|
       it "code_from_background_name(:#{name}) returns #{code}" do
         Helpers.code_from_background_name(name).should == code
       end
@@ -126,13 +112,13 @@ describe Helpers do
   end
 
   describe "finds colour codes from names" do
-    Helpers::FOREGROUND_COLOURS.each do |name, code|
+    Helpers::FOREGROUND_COLORS.each do |name, code|
       it "name_from_code(#{code}) returns #{name}" do
         Helpers.name_from_code(code).should == name
       end
     end
 
-    Helpers::BACKGROUND_COLOURS.each do |name, code|
+    Helpers::BACKGROUND_COLORS.each do |name, code|
       it "name_from_background_code(#{code}) returns #{name}" do
         Helpers.name_from_background_code(code).should == name
       end

data/spec/ansi_color/string_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class String
+  include AnsiColor::String
+end
+
+describe String do
+  describe "styles" do
+    EFFECTS.each do |name, code|
+      it "#{name}" do
+        "test string".send(name).should == "#{E}#{code}mtest string#{RESET}"
+      end
+    end
+  end
+
+  describe "foreground colors" do
+    FOREGROUND_COLORS.each do |name, code|
+      it "#{name}" do
+        "test string".send(name).should == "#{E}#{code}mtest string#{RESET}"
+      end
+    end
+  end
+
+  describe "background colors" do
+    BACKGROUND_COLORS.each do |name, code|
+      it "#{name}" do
+        "test string".send("#{name}_background").should == "#{E}0;#{code}mtest string#{RESET}"
+      end
+    end
+  end
+
+  describe "color on background" do
+    FOREGROUND_COLORS.each do |fg_name, fg_code|
+      BACKGROUND_COLORS.each do |bg_name, bg_code|
+        it "#{fg_name} on #{bg_name}" do
+          "test string".send("#{fg_name}_on_#{bg_name}").should == "#{E}#{fg_code};#{bg_code}mtest string#{RESET}"
+        end
+      end
+    end
+  end
+end

data/spec/ansi_color_spec.rb

@@ -1,74 +1,108 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe AnsiColor do
-  describe "wrapping strings" do
+  describe "color codes from names" do
+    FOREGROUND_COLORS.each do |name, code|
+      it "#{name} returns #{code}" do
+        AnsiColor.send(name).should == code
+      end
+    end
 
-    it "returns the original string with no options" do
-      tag = ansi_tag('james')
-      tag.should == 'james'
+    BACKGROUND_COLORS.each do |name, code|
+      it "#{name}_background returns #{code}" do
+        AnsiColor.send("#{name}_background").should == code
+      end
     end
 
-    it "red and bold" do
-      tag = ansi_tag('james', :color => :red, :effects => :bold)
-      tag.should == "#{Helpers::E}31;1mjames#{Helpers::E}0m"
+    EFFECTS.each do |name, code|
+      it "#{name} returns #{code}" do
+        AnsiColor.send("#{name}").should == code
+      end
     end
 
-    it "blue on white blinking" do
-      tag = ansi_tag('james', :color => :blue,
-        :background => :white,
-        :effects => :blink)
-      tag.should == "#{Helpers::E}34;47;5mjames#{Helpers::E}0m"
+    describe "print" do
+      it "print the original string with no options" do
+        capture_stdout do |stdout|
+          AnsiColor.print('james')
+          stdout.string.should == 'james'
+        end
+      end
+
+      it "print non string objects with no options" do
+        capture_stdout do |stdout|
+          AnsiColor.print(234)
+          stdout.string.should == '234'
+        end
+      end
+
+      it "red and bold on non string object" do
+        capture_stdout do |stdout|
+          AnsiColor.print(42, :color => :red, :effects => :bold)
+          stdout.string.should == "#{E}31;1m42#{E}0m"
+        end
+      end
+
+      it "print many args with no options" do
+        capture_stdout do |stdout|
+          AnsiColor.print(1, ' string ', 2)
+          stdout.string.should == "1 string 2"
+        end
+      end
+
+      it "print many args in red and bold" do
+        capture_stdout do |stdout|
+          AnsiColor.print(1, ' string ', 2, :color => :red, :effects => :bold)
+          stdout.string.should == "#{E}31;1m1 string 2#{E}0m"
+        end
+      end
+
+      it "red and bold" do
+        capture_stdout do |stdout|
+          AnsiColor.print('james', :color => :red, :effects => :bold)
+          stdout.string.should == "#{E}31;1mjames#{E}0m"
+        end
+      end
+
+      it "blue on white blinking" do
+        capture_stdout do |stdout|
+          AnsiColor.print('james', :color => :blue,
+            :background => :white,
+            :effects => :blink)
+          stdout.string.should == "#{E}34;47;5mjames#{E}0m"
+        end
+      end
     end
 
+    describe "puts" do
+      it "print the original string with no options" do
+        capture_stdout do |stdout|
+          AnsiColor.puts('james')
+          stdout.string.should == "james\n"
+        end
+      end
+
+      it "print some number with no options" do
+        capture_stdout do |stdout|
+          AnsiColor.puts(243)
+          stdout.string.should == "243\n"
+        end
+      end
+
+      it "red and bold" do
+        capture_stdout do |stdout|
+          AnsiColor.puts('james', :color => :red, :effects => :bold)
+          stdout.string.should == "#{E}31;1mjames#{E}0m\n"
+        end
+      end
+
+      it "blue on white blinking" do
+        capture_stdout do |stdout|
+          AnsiColor.puts('james', :color => :blue,
+            :background => :white,
+            :effects => :blink)
+          stdout.string.should == "#{E}34;47;5mjames#{E}0m\n"
+        end
+      end
+    end
   end
 end
-
-# describe String do
-# 
-#   describe "styles" do
-# 
-#     Helpers::EFFECTS.each do |name, code|
-#       it "#{name}" do
-#         "test string".send(name).should == "#{Helpers::E}#{code}mtest string#{Helpers::RESET}"
-#         # puts "#{name}".send(name)
-#       end
-#     end
-# 
-#   end
-# 
-#   describe "foreground colours" do
-# 
-#     Helpers::FOREGROUND_COLOURS.each do |name, code|
-#       it "#{name}" do
-#         "test string".send(name).should == "#{Helpers::E}#{code}mtest string#{Helpers::RESET}"
-#         # puts "#{name}".send(name)
-#       end
-#     end
-# 
-#   end
-# 
-#   describe "background colours" do
-# 
-#     Helpers::BACKGROUND_COLOURS.each do |name, code|
-#       it "#{name}" do
-#         "test string".send("#{name}_background").should == "#{Helpers::E}0;#{code}mtest string#{Helpers::RESET}"
-#         # puts "#{name}_background".send("#{name}_background")
-#       end
-#     end
-# 
-#   end
-# 
-#   describe "colour on background" do
-# 
-#     Helpers::FOREGROUND_COLOURS.each do |fg_name, fg_code|
-#       Helpers::BACKGROUND_COLOURS.each do |bg_name, bg_code|
-#         it "#{fg_name} on #{bg_name}" do
-#           "test string".send("#{fg_name}_on_#{bg_name}").should == "#{Helpers::E}#{fg_code};#{bg_code}mtest string#{Helpers::RESET}"
-#           # puts "#{fg_name}_on_#{bg_name}".send("#{fg_name}_on_#{bg_name}")
-#         end
-#       end
-#     end
-# 
-#   end
-# 
-# end

data/spec/spec_helper.rb

@@ -1,4 +1,12 @@
-require 'spec'
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require 'stringio'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -8,3 +16,13 @@ include AnsiColor
 Spec::Runner.configure do |config|
   
 end
+
+def capture_stdout(&block)
+  begin
+    orig_stream, $stdout = $stdout, StringIO.new
+    block.call($stdout)
+  ensure
+    s, $stdout = $stdout.string, orig_stream
+    s
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jcf-ansi_color
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors: 
 - James Conroy-Finn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-18 00:00:00 -07:00
+date: 2009-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -21,19 +21,21 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION.yml
 - lib/ansi_color.rb
 - lib/ansi_color/effects.rb
 - lib/ansi_color/helpers.rb
 - lib/ansi_color/rainbow.rb
+- lib/ansi_color/string.rb
 - spec/ansi_color/effects_spec.rb
 - spec/ansi_color/helpers_spec.rb
 - spec/ansi_color/rainbow_spec.rb
+- spec/ansi_color/string_spec.rb
 - spec/ansi_color_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -67,5 +69,6 @@ test_files:
 - spec/ansi_color/effects_spec.rb
 - spec/ansi_color/helpers_spec.rb
 - spec/ansi_color/rainbow_spec.rb
+- spec/ansi_color/string_spec.rb
 - spec/ansi_color_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,7 +0,0 @@
-= ansi_color
-
-Description goes here.
-
-== Copyright
-
-Copyright (c) 2009 James Conroy-Finn. See LICENSE for details.