jcf-ansi_color 0.3.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Conroy-Finn
+
+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/README.rdoc

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

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ansi_color"
+    gem.summary = %Q{TODO}
+    gem.email = "james@logi.cl"
+    gem.homepage = "http://github.com/jcf/ansi_color"
+    gem.authors = ["James Conroy-Finn"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ansi_color #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/lib/ansi_color/effects.rb

@@ -0,0 +1,12 @@
+module AnsiColor
+  class Effects < Array
+    def initialize(array)
+      # This should probably be validated
+      valid_effects = array.select { |effect| EFFECTS.include?(effect) }
+      super(valid_effects)
+    end
+    def to_codes!
+      self.map! { |code| EFFECTS[code] }.join(';')
+    end
+  end
+end

data/lib/ansi_color/helpers.rb

@@ -0,0 +1,59 @@
+module AnsiColor
+  class Helpers
+    def self.code_from_name(name)
+      FOREGROUND_COLOURS[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")
+    end
+
+    def self.code_from_background_name(name)
+      BACKGROUND_COLOURS[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")
+    end
+
+    def self.build_open_tag(args={})
+      # X;FG;BG;Bm
+      return if args.size == 0
+      options = {
+        :color => nil,
+        :background => nil,
+        :effects => nil
+      }
+
+      args.each do |k, v|
+        unless options.keys.include?(k)
+          valid_options = options.keys.join(', ')
+          raise ArgumentError, "#{k} is not a valid argument. Valid options are #{valid_options}"
+        end
+      end
+
+      options.merge!(args)
+
+      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?
+          effects = Effects.new(effects).to_codes!
+        else
+          raise InvalidEffect, "The only valid effects are #{EFFECTS.keys.join(', ')}"
+        end
+      end
+
+      tag = [fg || 0, bg, effects].compact.join(';')
+      "#{E + tag}m"
+    end
+
+    def self.reset
+      RESET
+    end
+  end
+end

data/lib/ansi_color/rainbow.rb

@@ -0,0 +1,30 @@
+module AnsiColor
+  class Rainbow
+    def initialize
+      puts "\n\n== build_open_tag FOREGROUND"
+      FOREGROUND_COLOURS.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|
+        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|
+          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|
+            open = Helpers::build_open_tag(:color => fg_name, :background => bg_name, :effects => effect_name)
+            print "#{open}#{fg_name} #{bg_name} #{effect_name}#{Helpers::reset}\n"
+          end
+          print "\n"
+        end
+      end
+    end
+  end
+end

data/lib/ansi_color.rb

@@ -0,0 +1,54 @@
+$:.push File.dirname(__FILE__)
+require "ansi_color/helpers"
+require "ansi_color/effects"
+require "ansi_color/rainbow"
+
+module AnsiColor
+  class InvalidColorName < StandardError; end
+  class InvalidColorCode < StandardError; end
+  class InvalidEffect < StandardError; end
+
+  E = "\033["
+  RESET = "#{E}0m"
+  EFFECTS = {
+    :normal     => 0,
+    :bold       => 1,
+    :underscore => 4,
+    :blink      => 5,
+    :inverse    => 7
+  }
+  FOREGROUND_COLOURS = {
+    :black   => 30,
+    :red     => 31,
+    :green   => 32,
+    :yellow  => 33,
+    :blue    => 34,
+    :magenta => 35,
+    :cyan    => 36,
+    :white   => 37
+  }
+  BACKGROUND_COLOURS = {
+    :black   => 40,
+    :red     => 41,
+    :green   => 42,
+    :yellow  => 43,
+    :blue    => 44,
+    :magenta => 45,
+    :cyan    => 46,
+    :white   => 47
+  }
+
+  FOREGROUND_COLOURS.each do |name, code|
+    define_method(name) { code }
+  end
+
+  BACKGROUND_COLOURS.each do |name, code|
+    define_method("#{name}_background") { code }
+  end
+
+  def ansi_tag(string, options={})
+    return string if options.empty?
+    open_tag = Helpers::build_open_tag(options)
+    open_tag + string + Helpers::reset
+  end
+end

data/spec/ansi_color/effects_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Effects do
+
+  it "ignores invalid effects on initialize" do
+    effects = [:bold, :blink, :does_not_exist]
+    effects = Effects.new(effects)
+    effects.should == [:bold, :blink]
+  end
+
+  it "converts an array of effects to codes" do
+    effects = [:bold, :blink]
+    effects = Effects.new(effects)
+    effects.to_codes!.should == "#{EFFECTS[:bold]};#{EFFECTS[:blink]}"
+  end
+
+end

data/spec/ansi_color/helpers_spec.rb

@@ -0,0 +1,142 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Helpers do
+
+  describe "handling arguments" do
+    it "shouldn't accept invalid options" do
+      lambda {
+        Helpers.build_open_tag(:invalid_key => 'something')
+      }.should raise_error(ArgumentError)
+      # raise ArgumentError, "#{k} is not a valid argument. Valid options are #{valid_options}"
+    end
+
+    it "shouldn't error with valid options" do
+      lambda {
+        Helpers.build_open_tag(:color => 'color',
+          :background => 'background',
+          :effects => 'effects')
+      }.should_not raise_error(ArgumentError)
+    end
+
+    it "returns when build_open_tag is called with no args" do
+      Helpers.build_open_tag.should be_nil
+    end
+
+    it "raises an InvalidEffect when effect is invalid" do
+      lambda {
+        Helpers.build_open_tag(:effects => :rubbish)
+      }.should raise_error(InvalidEffect)
+    end
+
+    it "raises an InvalidColorName when effect is invalid" do
+      lambda {
+        Helpers.build_open_tag(:color => 'invalid')
+      }.should raise_error(InvalidColorName)
+    end
+  end
+
+  describe "informative errors" do
+    it "should raise an InvalidColorCode when color name does not exist" do
+      lambda {
+        Helpers.name_from_code('invalid')
+      }.should raise_error(InvalidColorCode)
+    end
+
+    it "should raise an InvalidColorCode when background color name does not exist" do
+      lambda {
+        Helpers.name_from_background_code('invalid')
+      }.should raise_error(InvalidColorCode)
+    end
+
+    it "should raise an InvalidColorName when color name does not exist" do
+      lambda {
+        Helpers.code_from_name('invalid')
+      }.should raise_error(InvalidColorName)
+    end
+
+    it "should raise an InvalidColorName when color name does not exist" do
+      lambda {
+        Helpers.code_from_background_name('invalid')
+      }.should raise_error(InvalidColorName)
+    end
+
+    it "should raise an ArgumentError when an effect isn't a symbol or an array" do
+      lambda {
+        Helpers.build_open_tag(:effects => 'invalid')
+      }.should raise_error(InvalidEffect)
+    end
+  end
+
+  describe "should build tags" do
+    it "color" do
+      Helpers::FOREGROUND_COLOURS.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.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.build_open_tag(:color => fg_name, :background => bg_name).should == "\e[#{fg_code};#{bg_code}m"
+        end
+      end
+    end
+
+    it "takes a symbol as an effect" do
+      Helpers.build_open_tag(:effects => :bold).should == "#{Helpers::E}0;1m"
+    end
+
+    it "takes an array of effects" do
+      Helpers.build_open_tag(:effects => [:bold, :blink]).should == "#{Helpers::E}0;1;5m"
+    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|
+      it "code_from_name(:#{name}) returns #{code}" do
+        Helpers.code_from_name(name).should == code
+      end
+    end
+
+    Helpers::BACKGROUND_COLOURS.each do |name, code|
+      it "code_from_background_name(:#{name}) returns #{code}" do
+        Helpers.code_from_background_name(name).should == code
+      end
+    end
+  end
+
+  describe "finds colour codes from names" do
+    Helpers::FOREGROUND_COLOURS.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|
+      it "name_from_background_code(#{code}) returns #{name}" do
+        Helpers.name_from_background_code(code).should == name
+      end
+    end
+  end
+
+end

data/spec/ansi_color/rainbow_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Rainbow do
+end

data/spec/ansi_color_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe AnsiColor do
+  describe "wrapping strings" do
+
+    it "returns the original string with no options" do
+      tag = ansi_tag('james')
+      tag.should == 'james'
+    end
+
+    it "red and bold" do
+      tag = ansi_tag('james', :color => :red, :effects => :bold)
+      tag.should == "#{Helpers::E}31;1mjames#{Helpers::E}0m"
+    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"
+    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.opts

@@ -0,0 +1 @@
+--color

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 'ansi_color'
+include AnsiColor
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: jcf-ansi_color
+version: !ruby/object:Gem::Version 
+  version: 0.3.2
+platform: ruby
+authors: 
+- James Conroy-Finn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-18 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: james@logi.cl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/ansi_color.rb
+- lib/ansi_color/effects.rb
+- lib/ansi_color/helpers.rb
+- lib/ansi_color/rainbow.rb
+- spec/ansi_color/effects_spec.rb
+- spec/ansi_color/helpers_spec.rb
+- spec/ansi_color/rainbow_spec.rb
+- spec/ansi_color_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jcf/ansi_color
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- spec/ansi_color/effects_spec.rb
+- spec/ansi_color/helpers_spec.rb
+- spec/ansi_color/rainbow_spec.rb
+- spec/ansi_color_spec.rb
+- spec/spec_helper.rb