iron-term-ansicolor 0.0.1

data/README.rdoc

@@ -0,0 +1,16 @@
+= iron-term-ansicolor
+
+iron-term-console is a library for IronRuby that makes use of the .Net framework
+System.Console and related classes to provide colored output for ANSI formatted
+strings.
+
+For the Ruby OneClick installer, a package called win32console exists to provide
+this functionality. It makes calls to the Win32 API, including bit twiddling,
+to provide colored console output for that Ruby distribution. In IronRuby, we
+have direct access to the .Net Base Class Library. Rather than writing C# code 
+to create an IronRuby module to interact with a C++ API, this library directly
+uses the .Net BCL, and write the code directly in Ruby.
+
+== Copyright
+
+Copyright (c) 2009 Will Green, Ivan Porto Carrero, David Blackmon. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,226 @@
+require 'rubygems'
+require 'rake'
+require 'fileutils'
+require 'rake/rdoctask'
+require 'lib/iron-term-ansicolor'
+begin
+ require 'jeweler'
+ Jeweler::Tasks.new do |gem|
+   gem.name = "iron-term-ansicolor"
+   gem.summary = %Q{TODO}
+   gem.email = "will@hotgazpacho.org"
+   gem.homepage = "http://github.com/hotgazpacho/iron-term-ansicolor"
+   gem.authors = ["hotgazpacho","casualjim"]
+   # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+ end
+
+rescue LoadError
+ puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+
+##############################################################################
+# OPTIONS
+##############################################################################
+
+PKG_NAME      = 'iron-term-ansicolor'
+PKG_VERSION   = if File.exist?('VERSION.yml')
+  config = YAML.load(File.read('VERSION.yml'))
+  version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+else
+  version = IronTermAnsiColor::Version::STRING
+end
+AUTHORS       = ['Will Green', 'David Blackmon', 'Ivan Porto Carrero']
+EMAIL         = "will@hotgazpacho.org"
+HOMEPAGE      = "http://github.com/hotgazpacho/iron-term-ansicolor"
+SUMMARY       = "iron-term-ansicolor brings color output for RSpec and the likes to IronRuby."
+
+# These are the common rdoc options that are shared between generation of
+# rdoc files using BOTH 'rake rdoc' and the installation by users of a
+# RubyGem version which builds rdoc's along with its installation.  Any
+# rdoc options that are ONLY for developers running 'rake rdoc' should be
+# added in the 'Rake::RDocTask' block below.
+RDOC_OPTIONS  = [
+                "--quiet",
+                "--title", SUMMARY,
+                "--main", "README.rdoc",
+                "--line-numbers",
+                "--format","darkfish"
+                ]
+
+# Extra files outside of the lib dir that should be included with the rdocs.
+RDOC_FILES    = (%w( README.rdoc)).sort
+
+# The full file list used for rdocs, tarballs, gems, and for generating the xmpp4r.gemspec.
+PKG_FILES     = (%w( Rakefile iron-term-ansicolor.gemspec ) + RDOC_FILES + Dir["{lib,spec}/**/*"]).sort
+
+# RDOC
+#######
+Rake::RDocTask.new do |rd|
+
+  # which dir should rdoc files be installed in?
+  rd.rdoc_dir = 'rdoc'
+  rd.title = "iron-term-ansicolor #{PKG_VERSION}"
+  
+  # the full list of files to be included
+  rd.rdoc_files.include('README*')
+  rd.rdoc_files.include(RDOC_FILES, "lib/**/*.rb")
+
+  # the full list of options that are common between gem build
+  # and 'rake rdoc' build of docs.
+  rd.options = RDOC_OPTIONS
+
+  # Devs Only : Uncomment to also document private methods in the rdocs
+  # Please don't check this change in to the source repo.
+  #rd.options << '--all'
+
+  # Devs Only : Uncomment to generate dot (graphviz) diagrams along with rdocs.
+  # This requires that graphiz (dot) be installed as a local binary and on your path.
+  # See : http://www.graphviz.org/
+  # Please don't check this change in to the source repo as it introduces a binary dependency.
+  #rd.options << '--diagram'
+  #rd.options << '--fileboxes'
+
+end
+
+##############################################################################
+# PACKAGING & INSTALLATION
+##############################################################################
+
+# What files/dirs should 'rake clean' remove?
+#CLEAN.include ["*.gem", "pkg", "rdoc", "coverage"]
+
+begin
+  require 'rake/gempackagetask'
+
+  spec = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.authors = AUTHORS
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.rubyforge_project = PKG_NAME
+    s.summary = SUMMARY
+    s.description = s.summary
+    s.platform = Gem::Platform::RUBY
+    s.require_path = 'lib'
+    s.executables = []
+    s.files = PKG_FILES
+    s.test_files = []
+    s.has_rdoc = true
+    s.extra_rdoc_files = RDOC_FILES
+    s.rdoc_options = RDOC_OPTIONS
+    s.required_ruby_version = ">= 1.8.6"  
+    s.add_dependency 'term-ansicolor', ">= 1.0.4"
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.gem_spec = spec
+    pkg.need_tar = true
+    pkg.need_zip = true
+  end
+
+  namespace :gem do
+
+    desc "Run :package and install the .gem locally"
+    task :install => [:update_gemspec, :package] do
+      sh %{sudo gem install --local pkg/#{PKG_NAME}-#{PKG_VERSION}.gem}
+    end
+
+    desc "Like gem:install but without ri or rdocs"
+    task :install_fast => [:update_gemspec, :package] do
+      sh %{sudo gem install --local pkg/#{PKG_NAME}-#{PKG_VERSION}.gem --no-rdoc --no-ri}
+    end
+
+    desc "Run :clean and uninstall the .gem"
+    task :uninstall => :clean do
+      sh %{sudo gem uninstall #{PKG_NAME}}
+    end
+
+    # Thanks to the Merb project for this code.
+    desc "Update Github Gemspec"
+    task :update_gemspec do
+      skip_fields = %w(new_platform original_platform date)
+
+      result = "# WARNING : RAKE AUTO-GENERATED FILE.  DO NOT MANUALLY EDIT!\n"
+      result << "# RUN : 'rake gem:update_gemspec'\n\n"
+      result << "Gem::Specification.new do |s|\n"
+      spec.instance_variables.sort.each do |ivar|
+        value = spec.instance_variable_get(ivar)
+        name  = ivar.to_s.split("@").last
+        next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
+        if name == "dependencies"
+          value.each do |d|
+            dep, *ver = d.to_s.split(" ")
+            result <<  "  s.add_dependency #{dep.inspect}, #{ver.join(" ").inspect.gsub(/[()]/, "")}\n"
+          end
+        else
+          case value
+          when Array
+            value =  name != "files" ? value.inspect : value.sort.uniq.inspect.split(",").join(",\n")
+          when String, Fixnum, true, false
+            value = value.inspect
+          else
+            value = value.to_s.inspect
+          end
+          result << "  s.#{name} = #{value}\n"
+        end
+      end
+      result << "end"
+      File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
+    end
+
+  end # namespace :gem
+
+  # also keep the gemspec up to date each time we package a tarball or gem
+  task :package => ['gem:update_gemspec']
+  task :gem => ['gem:update_gemspec']
+
+rescue LoadError
+  puts <<EOF
+###
+  Packaging Warning : RubyGems is apparently not installed on this
+  system and any file add/remove/rename will not
+  be auto-updated in the 'iron-term-ansicolor.gemspec' when you run any
+  package tasks.  All such file changes are recommended
+  to be packaged on a system with RubyGems installed
+  if you intend to push commits to the Git repo so the
+  gemspec will also stay in sync for others.
+###
+EOF
+end
+
+# we are apparently on a system that does not have RubyGems installed.
+# Lets try to provide only the basic tarball package tasks as a fallback.
+unless defined? Gem
+  begin
+    require 'rake/packagetask'
+    Rake::PackageTask.new(PKG_NAME, PKG_VERSION) do |p|
+      p.package_files = PKG_FILES
+      p.need_tar = true
+      p.need_zip = true
+    end
+  rescue LoadError
+    puts <<EOF
+###
+  Warning : Unable to require the 'rake/packagetask'. Is Rake installed?
+###
+EOF
+  end
+end
+

data/iron-term-ansicolor.gemspec

@@ -0,0 +1,32 @@
+# WARNING : RAKE AUTO-GENERATED FILE.  DO NOT MANUALLY EDIT!
+# RUN : 'rake gem:update_gemspec'
+
+Gem::Specification.new do |s|
+  s.authors = ["Will Green", "David Blackmon", "Ivan Porto Carrero"]
+  s.bindir = "bin"
+  s.add_dependency "term-ansicolor", ">= 1.0.4"
+  s.description = "iron-term-ansicolor brings color output for RSpec and the likes to IronRuby."
+  s.email = "will@hotgazpacho.org"
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["README.rdoc",
+ "Rakefile",
+ "iron-term-ansicolor.gemspec",
+ "lib/iron-term-ansicolor.rb",
+ "spec/iron-term-ansicolor_simple_background_spec.rb",
+ "spec/iron-term-ansicolor_simple_foreground_spec.rb",
+ "spec/spec_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = "http://github.com/hotgazpacho/iron-term-ansicolor"
+  s.loaded = false
+  s.name = "iron-term-ansicolor"
+  s.platform = "ruby"
+  s.rdoc_options = ["--quiet", "--title", "iron-term-ansicolor brings color output for RSpec and the likes to IronRuby.", "--main", "README.rdoc", "--line-numbers", "--format", "darkfish"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = ">= 1.8.6"
+  s.required_rubygems_version = ">= 0"
+  s.rubyforge_project = "iron-term-ansicolor"
+  s.rubygems_version = "1.3.5"
+  s.specification_version = 3
+  s.summary = "iron-term-ansicolor brings color output for RSpec and the likes to IronRuby."
+  s.version = "0.0.1"
+end

data/lib/iron-term-ansicolor.rb

@@ -0,0 +1,73 @@
+require 'mscorlib'
+require 'term/ansicolor'
+
+## add the trailing m  because some of the rspec output spans multiple lines
+ANSI_REGEXP = /\e\[(.+?)m(.+?)(?=(\e\[0m|\z))/m
+SsC=System::ConsoleColor
+SC = System::Console
+
+class String
+  include Term::ANSIColor
+end
+
+module IronTermAnsiColor
+  module Version
+    MAJOR=0
+    MINOR=0
+    PATCH=1
+    STRING="#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end
+
+class IO
+  alias_method :original_write, :write
+  alias_method :original_puts, :puts
+  
+  def puts(*args)
+    rewrite(*args) { |text| original_puts text }
+    nil
+  end
+
+  def write(*args)
+    rewrite(*args) { |text| original_write text }
+  end
+
+  private
+    def extract_ansi_data(clr, txt)
+      fg_color_map =    Hash[30,SsC.black,31,SsC.red,32,SsC.dark_green,33,SsC.dark_yellow,34,SsC.dark_blue,35,SsC.dark_magenta,
+        36,SsC.dark_cyan,37,SsC.gray]
+      bg_color_map = Hash[40,SsC.black,41,SsC.dark_red,42,SsC.dark_green,43,SsC.dark_yellow,44,SsC.dark_blue,45,SsC.dark_magenta,
+        46,SsC.dark_cyan,47,SsC.gray]
+    
+      #matches = ANSI_REGEXP.match(arg)
+    
+      fg_color = fg_color_map[clr] || SC.foreground_color
+      bg_color = bg_color_map[clr] || SC.background_color
+    
+      { :foreground => fg_color, :background => bg_color,:text => txt}
+    end
+  
+    def rewrite(*args, &b)
+      raise ArgumentError, "needs a block" unless b
+      result=0
+      args.each do |arg|
+        fg_color = SC.foreground_color
+        bg_color = SC.background_color
+
+        ##dkb
+        data =  if ANSI_REGEXP =~ arg
+                  extract_ansi_data($1.to_i, $2)
+                else
+                  {:text => arg}
+                end  
+
+        SC.foreground_color = data[:foreground] || fg_color
+        SC.background_color = data[:background] || bg_color
+        result = b.call data[:text]
+        SC.background_color = bg_color
+        SC.foreground_color = fg_color
+      end
+      result
+    end
+
+end

data/spec/iron-term-ansicolor_simple_background_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "IronTermANSIColor", "when given a string with ANSI background color control characters" do
+  
+  before(:all) do
+    @original_bgcolor = System::ConsoleColor.Gray
+  end
+  
+  it "should set the background color to black when doing a puts of a string with only black background ANSI control code and reset the background color after" do
+    string = "Black".on_black
+    System::Console.should_receive(:background_color).at_least(:once).and_return(@original_bgcolor)
+    System::Console.should_receive(:background_color=).once.with(System::ConsoleColor.Black)
+    System::Console.should_receive(:background_color=).at_least(:once).with(@original_bgcolor)
+    puts string
+  end
+  
+  it "should set the background color to dark red when doing a puts of a string with only red background ANSI control code and reset the background color after" do
+    string = "Red".on_red
+    System::Console.should_receive(:background_color).at_least(:once).and_return(@original_bgcolor)
+    System::Console.should_receive(:background_color=).once.with(System::ConsoleColor.DarkRed)
+    System::Console.should_receive(:background_color=).at_least(:once).with(@original_bgcolor)
+    puts string
+  end
+  
+  it "should set the background color to dark green when doing a puts of a string with only green background ANSI control code and reset the background color after" do
+    string = "Green".on_green
+    System::Console.should_receive(:background_color).at_least(:once).and_return(@original_bgcolor)
+    System::Console.should_receive(:background_color=).once.with(System::ConsoleColor.DarkGreen)
+    System::Console.should_receive(:background_color=).at_least(:once).with(@original_bgcolor)
+    puts string
+  end
+  
+  it "should set the background color to dark yellow when doing a puts of a string with only yellow background ANSI control code and reset the background color after" do
+    string = "Yellow".on_yellow
+    System::Console.should_receive(:background_color).at_least(:once).and_return(@original_bgcolor)
+    System::Console.should_receive(:background_color=).once.with(System::ConsoleColor.DarkYellow)
+    System::Console.should_receive(:background_color=).at_least(:once).with(@original_bgcolor)
+    puts string
+  end
+  
+  it "should set the background color to dark blue when doing a puts of a string with only blue background ANSI control code and reset the background color after" do
+    string = "Blue".on_blue
+    System::Console.should_receive(:background_color).at_least(:once).and_return(@original_bgcolor)
+    System::Console.should_receive(:background_color=).once.with(System::ConsoleColor.DarkBlue)
+    System::Console.should_receive(:background_color=).at_least(:once).with(@original_bgcolor)
+    puts string
+  end
+  
+  it "should set the background color to dark magenta when doing a puts of a string with only magenta background ANSI control code and reset the background color after" do
+    string = "Magenta".on_magenta
+    System::Console.should_receive(:background_color).at_least(:once).and_return(@original_bgcolor)
+    System::Console.should_receive(:background_color=).once.with(System::ConsoleColor.DarkMagenta)
+    System::Console.should_receive(:background_color=).at_least(:once).with(@original_bgcolor)
+    puts string
+  end
+  
+  it "should set the background color to dark cyan when doing a puts of a string with only cyan background ANSI control code and reset the background color after" do
+    string = "Cyan".on_cyan
+    System::Console.should_receive(:background_color).at_least(:once).and_return(@original_bgcolor)
+    System::Console.should_receive(:background_color=).once.with(System::ConsoleColor.DarkCyan)
+    System::Console.should_receive(:background_color=).at_least(:once).with(@original_bgcolor)
+    puts string
+  end
+  
+  it "should set the background color to gray when doing a puts of a string with only white background ANSI control code and reset the background color after" do
+    string = "Gray".on_white
+    System::Console.should_receive(:background_color).at_least(:once).and_return(@original_bgcolor)
+    System::Console.should_receive(:background_color=).exactly(3).times.with(System::ConsoleColor.Gray)
+    System::Console.should_receive(:background_color=).at_least(:once).with(@original_bgcolor)
+    puts string
+  end
+end
+

data/spec/iron-term-ansicolor_simple_foreground_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "IronTermANSIColor", "when given a string with ANSI foreground color control characters" do
+  
+  before(:all) do
+    @original_fgcolor = System::ConsoleColor.Gray
+  end
+  
+  it "should set the foreground color to black when doing a puts of a string with only blackforeground ANSI control code and reset the foreground color after" do
+    string = "Black".black
+    System::Console.should_receive(:foreground_color).twice.and_return(@original_fgcolor)
+    System::Console.should_receive(:foreground_color=).once.with(System::ConsoleColor.black)
+    System::Console.should_receive(:foreground_color=).at_least(3).times.with(@original_fgcolor)
+    puts string
+  end
+  
+  it "should set the foreground color to dark red when doing a puts of a string with only redforeground ANSI control code and reset the foreground color after" do
+    string = "Red".red
+    System::Console.should_receive(:foreground_color).at_least(:once).and_return(@original_fgcolor)
+    System::Console.should_receive(:foreground_color=).once.with(System::ConsoleColor.red)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(@original_fgcolor)
+    puts string
+  end
+  
+  it "should set the foreground color to dark green when doing a puts of a string with only greenforeground ANSI control code and reset the foreground color after" do
+    string = "Green".green
+    System::Console.should_receive(:foreground_color).at_least(:once).and_return(@original_fgcolor)
+    System::Console.should_receive(:foreground_color=).once.with(System::ConsoleColor.dark_green)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(@original_fgcolor)
+    puts string
+  end
+  
+  it "should set the foreground color to dark yellow when doing a puts of a string with only yellowforeground ANSI control code and reset the foreground color after" do
+    string = "Yellow".yellow
+    System::Console.should_receive(:foreground_color).at_least(:once).and_return(@original_fgcolor)
+    System::Console.should_receive(:foreground_color=).once.with(System::ConsoleColor.DarkYellow)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(@original_fgcolor)
+    puts string
+  end
+  
+  it "should set the foreground color to dark blue when doing a puts of a string with only blueforeground ANSI control code and reset the foreground color after" do
+    string = "Blue".blue
+    System::Console.should_receive(:foreground_color).at_least(:once).and_return(@original_fgcolor)
+    System::Console.should_receive(:foreground_color=).once.with(System::ConsoleColor.DarkBlue)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(@original_fgcolor)
+    puts string
+  end
+  
+  it "should set the foreground color to dark magenta when doing a puts of a string with only magentaforeground ANSI control code and reset the foreground color after" do
+    string = "Magenta".magenta
+    System::Console.should_receive(:foreground_color).at_least(:once).and_return(@original_fgcolor)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(System::ConsoleColor.DarkMagenta)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(@original_fgcolor)
+    puts string
+  end
+  
+  it "should set the foreground color to dark cyan when doing a puts of a string with only cyanforeground ANSI control code and reset the foreground color after" do
+    string = "Cyan".cyan
+    System::Console.should_receive(:foreground_color).at_least(:once).and_return(@original_fgcolor)
+    System::Console.should_receive(:foreground_color=).once.with(System::ConsoleColor.DarkCyan)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(@original_fgcolor)
+    puts string
+  end
+  
+  it "should set the foreground color to gray when doing a puts of a string with only whiteforeground ANSI control code and reset the foreground color after" do
+    string = "Gray".white
+    System::Console.should_receive(:foreground_color).at_least(:once).and_return(@original_fgcolor)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(System::ConsoleColor.Gray)
+    System::Console.should_receive(:foreground_color=).at_least(:once).with(@original_fgcolor)
+    puts string
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'iron-term-ansicolor'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: iron-term-ansicolor
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Will Green
+- David Blackmon
+- Ivan Porto Carrero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2009-10-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - '>='
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+description: iron-term-ansicolor brings color output for RSpec and the likes to IronRuby.
+email: will@hotgazpacho.org
+executables: []
+extensions: []
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- iron-term-ansicolor.gemspec
+- lib/iron-term-ansicolor.rb
+- spec/iron-term-ansicolor_simple_background_spec.rb
+- spec/iron-term-ansicolor_simple_foreground_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hotgazpacho/iron-term-ansicolor
+licenses: []
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- iron-term-ansicolor brings color output for RSpec and the likes to IronRuby.
+- --main
+- README.rdoc
+- --line-numbers
+- --format
+- darkfish
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: !str 0
+  version: 
+requirements: []
+rubyforge_project: iron-term-ansicolor
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: iron-term-ansicolor brings color output for RSpec and the likes to IronRuby.
+test_files: []