ssoroka-ansi 1.0.0

data/README.rdoc

@@ -0,0 +1,36 @@
+= ANSI
+
+== DESCRIPTION
+
+Use ANSI codes in printed output, including colors and controlling the cursor, clearing the line, and clearing the screen.
+
+== INSTALLATION
+
+as a gem:
+  sudo gem install ssoroka-ruby
+
+as a plugin:
+  script/plugin install git://github.com/ssoroka/ansi.git
+  
+== USAGE
+
+1) Simply control the cursor:
+>> puts "HELLO" + ANSI.right(30) + "THERE!"
+HELLO                              THERE!
+
+2) use colors:
+
+>> puts ANSI.color(:red) { "hello there" }
+>> puts ANSI.color(:green) + "Everything is green now" + ANSI.no_color
+
+3) loops:
+
+printf ANSI.clear_screen
+puts "Processing users..."
+max = User.count
+User.all.each_with_index {|user, index|
+  user.update_something!
+  printf ANSI.left(50) + "Processed #{index}/#{max} users..."
+}
+puts " done!"
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('ansi', '1.0.0') do |p|
+  p.description = 'Use ANSI codes in printed output, including colors and controlling the cursor, clearing the line, and clearing the screen.'
+  p.url = 'http://github.com/ssoroka/ansi'
+  p.author = 'Steven Soroka'
+  p.email = 'ssoroka78@gmail.com'
+  p.ignore_pattern = ["tmp/*", 'script/**']
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each{|f| load f }

data/ansi.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = %q{ansi}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steven Soroka"]
+  s.date = %q{2008-11-12}
+  s.description = %q{Use ANSI codes in printed output, including colors and controlling the cursor, clearing the line, and clearing the screen.}
+  s.email = %q{ssoroka78@gmail.com}
+  s.extra_rdoc_files = ["lib/ansi.rb", "README.rdoc"]
+  s.files = ["ansi.gemspec", "init.rb", "lib/ansi.rb", "Manifest", "Rakefile", "README.rdoc", "test/ansi_test.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ssoroka/ansi}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ansi", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ansi}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Use ANSI codes in printed output, including colors and controlling the cursor, clearing the line, and clearing the screen.}
+  s.test_files = ["test/ansi_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end

data/lib/ansi.rb

@@ -0,0 +1,98 @@
+# based on http://en.wikipedia.org/wiki/ANSI_escape_code
+# Written by Steven Soroka
+module ANSI
+  class <<self
+    COLORS = {:black => 0, :red => 1, :green => 2, :yellow => 3, :blue => 4, :magenta => 5, :purple => 5,
+      :cyan => 6, :light_blue => 6, :lt_blue => 6, :white => 7}
+
+    # Some of these are not widely supported, like italics, underline, blink_fast, etc.
+    COLOR_OPTIONS = {:normal => 0, :bold => 1, :faint => 2, :italics => 3, :underline => 4, :blink => 5,
+      :blink_slow => 5, :blink_fast => 6, :double_underline => 21, :no_underline => 24, :no_blink => 25}
+
+    def back(count = 79)
+      esc_code("#{count}D")
+    end
+    alias_method :left, :back
+
+    def forward(count = 1)
+      esc_code("#{count}C")
+    end
+    alias_method :right, :forward
+
+    def up(count = 1)
+      esc_code("#{count}A")
+    end
+
+    def down(count = 1)
+      esc_code("#{count}B")
+    end
+
+    def color(color, options = {}, &block)
+      r = set_color(color, options.merge(:base => options[:bright] ? 90 : 30))
+      if block_given?
+        r += yield
+        r += no_color
+      end
+      r
+    end
+
+    def bg_color(color, options = {}, &block)
+      r = set_color(color, options.merge(:base => options[:bright] ? 100 : 40))
+      if block_given?
+        r += yield
+        r += no_color
+      end
+      r
+    end
+
+    def no_color
+      esc_code('m')
+    end
+
+    def clear_line(left_right_or_all = :right)
+      opt = {:left => 1, :right => 0, :line => 2, :all => 2}[left_right_or_all]
+      esc_code("#{opt}K")
+    end
+    alias_method :clear, :clear_line # maybe clear should be its own method that can clear the screen, too.
+
+    def hide_cursor(&blk)
+      out = esc_code("?25l")
+      out << (yield + show_cursor) if block_given?
+      out
+    end
+
+    def show_cursor
+      esc_code("?25h")
+    end
+
+    def save_position
+      esc_code("s")
+    end
+
+    def restore_position
+      esc_code("u")
+    end
+
+    def clear_screen(top_or_bottom_or_all = :all)
+      opt = {:top => 1, :bottom => 0, :all => 2}[top_or_bottom_or_all]
+      esc_code("#{opt}J")
+    end
+    private
+      def set_color(color, options)
+        raise Exception.new("Invalid color") unless COLORS.keys.include?(color)
+        opts = [COLORS[color] + options[:base]]
+        COLOR_OPTIONS.each{|k,v|
+          opts << v if options[k]
+        }
+        esc_code("#{opts.join(';')}m")
+      end
+
+      def esc_code(s)
+        "#{esc}#{s}" #.wrap('\[', '\]') # this wrap was supposed to avoid messing up wrapping long lines. maybe not needed.
+      end
+
+      def esc
+        "\033["
+      end
+  end
+end

data/test/ansi_test.rb

@@ -0,0 +1,68 @@
+require 'test/unit'
+require File.dirname(__FILE__)+'/../lib/ansi'
+
+class Ansi < Test::Unit::TestCase
+  def test_ansi_should_know_how_to_move_left
+    assert_equal ANSI.left(3), "\033[3D"
+  end
+
+  def test_ansi_should_know_how_to_move_right
+    assert_equal ANSI.right(3), "\033[3C"
+  end
+
+  def test_ansi_should_know_how_to_move_up
+    assert_equal ANSI.up(3), "\033[3A"
+  end
+
+  def test_ansi_should_know_how_to_move_down
+    assert_equal ANSI.down(3), "\033[3B"
+  end
+
+  def test_ansi_should_know_how_to_turn_color_off
+    assert_equal ANSI.no_color, "\033[m"
+  end
+
+  def test_ansi_should_clear_text_to_the_right
+    assert_equal ANSI.clear(:right), "\033[0K"
+  end
+
+  def test_ansi_should_clear_text_to_the_left
+    assert_equal ANSI.clear(:left), "\033[1K"
+  end
+
+  def test_ansi_should_clear_the_line
+    assert_equal ANSI.clear(:line), "\033[2K"
+  end
+
+  def test_ansi_should_hide_cursor
+    assert_equal ANSI.hide_cursor, "\033[?25l"
+  end
+
+  def test_ansi_should_show_cursor
+    assert_equal ANSI.show_cursor, "\033[?25h"
+  end
+
+  def test_ansi_color_should_display_blue
+    assert_equal ANSI.color(:blue), "\033[34m"
+  end
+
+  def test_ansi_color_should_blink
+    assert_equal ANSI.color(:black, :blink => true), "\033[30;5m"
+  end
+
+  def test_ansi_color_should_display_background_color
+    assert_equal ANSI.bg_color(:blue), "\033[44m"
+  end
+
+  def test_ansi_color_should_clear_the_screen
+    assert_equal ANSI.clear_screen(:all), "\033[2J"
+  end
+
+  def test_ansi_color_should_save_cursor_position
+    assert_equal ANSI.save_position, "\033[s"
+  end
+
+  def test_ansi_color_should_restore_cursor_position
+    assert_equal ANSI.restore_position, "\033[u"
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: ssoroka-ansi
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Steven Soroka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-12 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Use ANSI codes in printed output, including colors and controlling the cursor, clearing the line, and clearing the screen.
+email: ssoroka78@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/ansi.rb
+- README.rdoc
+files: 
+- ansi.gemspec
+- init.rb
+- lib/ansi.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- test/ansi_test.rb
+has_rdoc: true
+homepage: http://github.com/ssoroka/ansi
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Ansi
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: ansi
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Use ANSI codes in printed output, including colors and controlling the cursor, clearing the line, and clearing the screen.
+test_files: 
+- test/ansi_test.rb