mikowitz-color 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,9 @@
+*.sw?
+.DS_Store
+.yardoc
+*.gem
+*.gemspec
+doc
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Berkowitz
+
+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,32 @@
+= color
+
+=== current version : 0.1.1
+
+http://github.com/mikowitz/color
+
+== Description
+
+A simple, flexible gem that provides an open-ended API to print colored and styled output in a terminal.
+
+== Usage examples
+
+The following are all methods that <code>Color</code> understands, and should give you an idea of what is possible.
+
+  Color.blue("this will be printed as blue text")
+  Color.on_red("this will be printed on a red background")
+  Color.bold("this will be bold")
+  Color.underline_blue_on_yellow("this will be underlined blue text on a yellow background")
+
+The order of elements in the method name is also unimportant. For example
+
+  Color.bold_underline_blue_on_yellow("This should be formatted the same as the line below")
+
+will look the same as
+
+  Color.on_yellow_bold_blue_underline("This should be formatted the same as the line above")
+
+Check out <code>"spec/term_test.rb"</code> and <code>`rake proof`</code> if you don't believe me.
+
+== Copyright
+
+Copyright (c) 2009 Michael Berkowitz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mikowitz-color"
+    gem.summary = %Q{A small gem to provide colored/styled output in the terminal.}
+    gem.description = %Q{A simple, flexible gem that provides an open-ended API to print colored and styled output in a terminal.}
+    gem.email = "michael.berkowitz@gmail.com"
+    gem.homepage = "http://github.com/mikowitz/color"
+    gem.authors = ["Michael Berkowitz"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "yard"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+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']
+  spec.spec_opts = ["-cfs"]
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+desc "'Proof is the bottom line for everyone' -- Paul Simon"
+task :proof do
+  system "ruby spec/term_test.rb"
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/color.rb

@@ -0,0 +1,66 @@
+module Color
+  COLORS = {
+    "black" => 0,
+    "red" => 1,
+    "green" => 2,
+    "yellow" => 3,
+    "blue" => 4,
+    "magenta" => 5,
+    "cyan" => 6,
+    "white" => 7
+  }
+  COLORS.default = 0
+
+  FORMATS = {
+    "bold" => 1,
+    "underline" => 4
+  }
+  FORMATS.default = 0
+  
+  def self.io; $stderr; end
+  
+  def self.method_missing(method, string, newline=true)
+    io.write prepare_string(string, *parse_method_name(method))
+    io.flush
+    puts if newline
+  end
+  
+  def self.prepare_string(string, foreground=nil, background=nil, formatting=[])
+    [ prepare_foreground_color(foreground),
+      prepare_background_color(background),
+      prepare_formatting(*formatting),
+      string,
+      "\e[0m"
+    ].join("")
+  end
+  
+  def self.parse_method_name(name)
+    name = name.to_s.split("_")
+    if x = name.index("on")
+      name.delete("on")
+      background = name.delete_at(x)
+    end
+    foreground = name.find{|b| COLORS.keys.include?(b) }
+    formatting = name.reject{|b| COLORS.keys.include?(b) }
+    [foreground, background, formatting]
+  end
+  
+  private
+    def self.prepare_foreground_color(color=nil)
+      handle_color(3, color)
+    end
+    
+    def self.prepare_background_color(color=nil)
+      handle_color(4, color)
+    end
+    
+    def self.prepare_formatting(*formats)
+      return "" if formats.empty?
+      formats.map{|f| "\e[#{FORMATS[f]}m"}.join("")
+    end
+    
+    def self.handle_color(lead, color=nil)
+      return "" unless color
+      "\e[#{lead}#{COLORS[color]}m"
+    end
+end

data/spec/color_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Color" do
+  describe "parse_method_name" do
+    it "should correctly parse a single color" do
+      Color.parse_method_name(:cyan).should == ["cyan", nil, []]
+    end
+    
+    it "should correctly parse a single background color" do
+      Color.parse_method_name(:on_red).should == [nil, "red", []]
+    end
+    
+    it "should correctly parse a single formatting option" do
+      Color.parse_method_name(:bold).should == [nil, nil, ["bold"]]
+    end
+    
+    it "should correctly parse a foreground color and background color" do
+      Color.parse_method_name(:blue_on_green).should == ["blue", "green", []]
+      Color.parse_method_name(:on_magenta_yellow).should == ["yellow", "magenta", []]
+    end
+    
+    it "should correctly parse a foreground color and single formatting option" do
+      Color.parse_method_name(:red_bold).should == ["red", nil, ["bold"]]
+      Color.parse_method_name(:underline_green).should == ["green", nil, ["underline"]]
+    end
+    
+    it "should correctly parse a background color and two formatting options" do
+      Color.parse_method_name(:on_red_bold_underline).should == [nil, "red", ["bold", "underline"]]
+      Color.parse_method_name(:underline_on_red_bold).should == [nil, "red", ["underline", "bold"]]
+    end
+    
+    it "should correctly parse a foreground color, background color and formatting option" do
+      Color.parse_method_name(:blue_on_cyan_bold).should == ["blue", "cyan", ["bold"]]
+      Color.parse_method_name(:underline_red_on_green).should == ["red", "green", ["underline"]]
+      Color.parse_method_name(:on_magenta_bold_black).should == ["black", "magenta", ["bold"]]
+    end
+  end
+  
+  describe "prepare_foreground_color" do
+    it "should correctly convert 'blue' into terminal output" do
+      Color.send(:prepare_foreground_color, "blue").should == "\e[34m"
+    end
+    
+    it "should correctly handle a nil value" do
+      Color.send(:prepare_foreground_color, nil).should == ""
+    end
+    
+    it "should correctly handle a non-existent color" do
+      Color.send(:prepare_foreground_color, "turquoise").should == "\e[30m"
+    end
+  end
+  
+  describe "prepare_background_color" do
+    it "should correctly convert 'magenta' into terminal output" do
+      Color.send(:prepare_background_color, "magenta").should == "\e[45m"
+    end
+    
+    it "should correctly handle a nil value" do
+      Color.send(:prepare_background_color, nil).should == ""
+    end
+
+    it "should correctly handle a non-existent color" do
+      Color.send(:prepare_background_color, "pink").should == "\e[40m"
+    end
+  end
+  
+  describe "prepare_formatting" do
+    it "should correctly convert ['bold'] into terminal output" do
+      Color.send(:prepare_formatting, "bold").should == "\e[1m"
+    end
+
+    it "should correctly convert ['bold', 'underline'] into terminal output" do
+      Color.send(:prepare_formatting, "bold", "underline").should == "\e[1m\e[4m"
+    end
+
+    it "should correctly convert [] into terminal output" do
+      Color.send(:prepare_formatting, *[]).should == ""
+    end
+
+    it "should correctly handle ['fake_formatting_option']" do
+      Color.send(:prepare_formatting, "fake_formatting_option").should == "\e[0m"
+    end
+  end
+  
+  describe "prepare_string" do
+    it "should return the correct value for the parameter set ('hello', 'blue', nil, [])" do
+      Color.prepare_string("hello", "blue", nil, []).should == "\e[34mhello\e[0m"
+    end
+    
+    it "should return the correct value for the parameter set ('hello', nil, 'red, [])" do
+      Color.prepare_string("hello", nil, "red", []).should == "\e[41mhello\e[0m"
+    end
+
+    it "should return the correct value for the parameter set ('hello', 'green', 'red, ['bold])" do
+      Color.prepare_string("hello", "green", "red", ["bold"]).should == "\e[32m\e[41m\e[1mhello\e[0m"
+    end      
+
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'color'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/term_test.rb

@@ -0,0 +1,8 @@
+## EXPERIMENTATION
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'color'
+
+Color.bold_underline_blue_on_yellow("This should be formatted the same as the line below")
+Color.on_yellow_bold_blue_underline("This should be formatted the same as the line above")

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: mikowitz-color
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Michael Berkowitz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A simple, flexible gem that provides an open-ended API to print colored and styled output in a terminal.
+email: michael.berkowitz@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/color.rb
+- spec/color_spec.rb
+- spec/spec_helper.rb
+- spec/term_test.rb
+has_rdoc: true
+homepage: http://github.com/mikowitz/color
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A small gem to provide colored/styled output in the terminal.
+test_files: 
+- spec/color_spec.rb
+- spec/spec_helper.rb
+- spec/term_test.rb