colorful 0.0.2 → 0.0.3

data/README.markdown

@@ -0,0 +1,93 @@
+Colorful is a gem that provides color and effect support to native Ruby Strings when printed in an ANSI color supporting terminal.
+
+The following code will print "Test" in red using the terminal's color scheme:
+
+    puts "Test".red
+
+Background colors are also supported:
+
+    puts "Test".blue_background
+
+You can combine the two:
+
+    puts "Test".red.blue_background
+
+or:
+
+    puts "Test".red_on_blue
+
+Add some effects:
+
+    puts "Test".red_on_blue.blink.underline
+
+And then remove some:
+
+    puts "Test".red_on_blue.blink.underline.no_blink
+
+The supported terminal colors are:
+
+*  black
+*  red
+*  green
+*  yellow
+*  blue
+*  magenta
+*  cyan
+*  white
+*  default
+
+The supported effects are:
+*  reset
+*  bright/bold
+*  italic
+*  underline
+*  blink
+*  inverse
+*  hide
+
+Note that not all of these formats may not be supported in all environments.  Using an unsupported effect will not cause any display issues, other than the style not being applied.
+
+Additionally, Colorful supports full rgb256 or HTML color values
+
+To use rgb256 true red as the foreground:
+
+    puts "Test".color(255, 0, 0)
+
+For the HTML version:
+
+    puts "Test".color("F00")
+
+or:
+
+    puts "Test".color("#ff0000")
+
+or:
+
+    puts "Test".color(:_ff0000)
+
+These methods handle standard or shortened HTML codes, case insensitive, with or without # or _
+
+Note that these methods require xterm 256 color support, and colors will be translated to the nearest possible valid color.
+
+Lastly, some methods have been added that allow for cursor movement.  The supported movement operations include:
+*  and_go_up(n)
+*  and_go_down(n)
+*  and_go_left(n)
+*  and_go_right(n)
+*  and_go_to(n)
+
+To return to the beginning of the line:
+
+    10.times do |n|
+      print n.to_s.and_go_to 0
+    end
+
+or:
+
+    10.times do |n|
+      puts n.to_s.and_go_up 1
+    end
+
+Note that some methods work better with puts, and others with print.  Puts will implicitly add a new line to the end of the string it is printing, moving the cursor.
+
+This is a work in progress but is stable.  Let me know if you would like a feature added to the project.

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+
+task(:default).clear
+task :default => [:spec]

data/lib/colorful.rb

@@ -19,6 +19,12 @@ module Colorful
               :blink     => 5,
               :inverse   => 7,
               :hide      => 8 }
+
+  MOVEMENT = { :up    => 'F',
+               :down  => 'E',
+               :left  => 'D',
+               :right => 'C',
+               :to    => 'G' }
 end
 
 class String
@@ -27,15 +33,16 @@ class String
       inject_ansi_code 30 + code
     end
 
-    define_method "#{color}_background" do
-      inject_ansi_code 40 + code
-    end
-
     Colorful::COLORS.each do |bg_color, bg_code|
       define_method "#{color}_on_#{bg_color}" do
         inject_ansi_code 30 + code, 40 + bg_code
       end
     end
+
+    define_method "#{color}_background" do
+      inject_ansi_code 40 + code
+    end
+
   end
 
   Colorful::EFFECTS.each do |effect, code|
@@ -48,6 +55,13 @@ class String
     end
   end
 
+  Colorful::MOVEMENT.each do |move, code|
+    define_method "and_go_#{move}" do |num|
+      result = self
+      result += "\e[#{num}#{code}"
+    end
+  end
+
   def foreground(*args)
     code = ansi_color_code *args
     inject_ansi_code 38, 5, code

data/lib/colorful/version.rb

@@ -1,3 +1,3 @@
 module Colorful
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: colorful
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-14 00:00:00.000000000 -05:00
+date: 2011-12-09 00:00:00.000000000 -06:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157578920 !ruby/object:Gem::Requirement
+  requirement: &2156837840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157578920
+  version_requirements: *2156837840
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &2157578500 !ruby/object:Gem::Requirement
+  requirement: &2156837420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157578500
+  version_requirements: *2156837420
 description: Provides string extensions for terminal color output
 email:
 - randland@gmail.com
@@ -45,6 +45,7 @@ files:
 - .rspec
 - .rvmrc
 - Gemfile
+- README.markdown
 - Rakefile
 - colorful.gemspec
 - lib/colorful.rb