jbe-termite 1.1.1

data/README.textile

@@ -0,0 +1,103 @@
+h1. Termite
+
+h2. ANSI and VT100 output escape wrapper in Ruby.
+
+h3. Installation
+
+@gem sources -a http://gems.github.com@
+
+@sudo gem install jbe-termite@
+
+h3. Features
+
+* Colored terminal output
+* Other ANSI decorations
+* Redraw lines
+* Simple output "animation"
+* Progress bars
+* Sensible syntax
+
+h3. Requires
+
+* 16 color terminal
+* *nix. Windows is *not* supported.
+
+h2. Examples
+
+<pre>
+<code>
+require 'rubygems'
+require 'termite'
+
+include Termite::Palette
+
+puts "Add some ' + green('color') + '!'
+
+puts 'And also some ' + red('contrasting background!', :green)
+
+
+                        puts red(  'The pentagram thy peace doth mar?' )
+
+              puts black(:yellow,  'To me, thou son of hell, explain,' )
+
+     puts blue(:underscore, cyan,
+                 :blink, :bright,  'How earnest thou in, if this thine exit bar?' )
+
+                puts white(:bold,  'Could such a spirit aught ensnare?')
+</code>
+</pre>
+
+Parameter order is irrelevant. Multiple strings will be joined.
+
+<pre>
+<code>
+
+    print 'Redrawing... '
+    redraw do |i|
+      if i < 11
+        sleep 0.05
+        i.to_s
+      elsif i == 11
+        'OK'
+      else
+        false
+      end
+    end
+
+
+    print 'Animating progress bar..'
+    pb = Termite::Progress.new 'Loading', 35, :red
+    animated_redraw(50, 25) do |f|
+      pb.report f.to_f / 50
+    end
+
+</code>
+</pre>
+
+See also the examples in './test'.
+
+
+h3. LICENSE
+
+(MIT License)
+
+Copyright (c) 2009 Jostein Berre Eliassen
+
+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/lib/termite.rb

@@ -0,0 +1,159 @@
+#       ,_     _,
+#         '._.'
+#    '-,   (_)   ,-'      TERMITE
+#      '._ .:. _.'
+#       _ '|Y|' _         A basic ANSI / VT100 library
+#     ,` `>\ /<` `,
+#    ` ,-`  I  `-, `
+#      |   /=\   |
+#    ,-'   |=|   '-,
+#          )-(            jostein.be/code
+#          \_/
+
+
+
+module Termite
+
+  Colors  = [ :black, :red, :green, :yellow,
+              :blue, :purple, :cyan, :white  ]
+
+  Modifiers = {
+    :reset            =>  'c'    ,
+
+    :enable_wrap      =>  '[7h'  ,
+    :disable_wrap     =>  '[7l'  ,
+
+    :home             =>  '[H'   ,
+    :save_cursor      =>  '[s'   ,
+    :restore_cursor   =>  '[u'   ,
+
+    :erase_front      =>  '[K'   ,
+    :erase_back       =>  '[1K'  ,
+    :erase_line       =>  '[2K'  ,
+    :erase_down       =>  '[J'   ,
+    :erase_up         =>  '[1J'  ,
+    :erase_screen     =>  '[2J'  ,
+
+    :text_reset       =>  '[0m'  ,
+    :bright           =>  '[1m'  ,
+    :dim              =>  '[2m'  ,
+    :underscore       =>  '[4m'  ,
+    :blink            =>  '[5m'  ,
+    :reverse          =>  '[7m'  ,
+    :hide             =>  '[8m'  ,
+  }
+  for n in 0..Colors.size
+    Modifiers[:"fg_#{Colors[n]}"] = "[#{n+30}m"
+    Modifiers[:"bg_#{Colors[n]}"] = "[#{n+40}m"
+  end
+
+  def self.escape( *args)
+    (args & Termite::Modifiers.keys).map do |m|
+      "\e" + Modifiers[m]
+    end.join ''
+  end
+
+  def self.decorate( *args )
+    text = args.select {|arg| arg.is_a? String }.join
+
+    self.escape( *args ) +
+    text +
+    self.escape( :text_reset )
+  end
+
+  def self.colorize( fg, *args )
+    args << :"fg_#{fg}"
+
+    unless (bg = args & Colors).empty?
+      args << :"bg_#{bg[0]}"
+    end
+    self.decorate( *args )
+  end
+
+  def self.rewrite( str )
+    self.escape(:erase_front) +
+    self.escape(:save_cursor) +
+    str + "\n" +
+    self.escape(:restore_cursor)
+  end
+end
+
+class Termite::Progress
+
+  @state = 0.0
+
+  attr_accessor :width, :state, :desc, :decorations
+
+  def initialize( desc, width = 35, color = false, *deco )
+    @desc = desc
+    @width = width
+    @decorations = deco
+    @decorations << :"fg_#{color}" if color
+  end
+
+  def reset
+    @state = 0.0
+  end
+
+  def report( s = false )
+    @state = s if s
+    bar
+  end
+
+  def bar
+    completed = (@state * @width).to_i
+    remaining = @width - completed
+    make_bar_string
+    Termite.decorate(@bs[0..(completed)],
+                     :reverse, *@decorations) +
+    Termite.decorate(@bs[(completed+1)..@width],
+                     *@decorations)
+  end
+
+  private
+
+    def make_bar_string
+      @bs = @desc
+      @bs = @bs[0..(@width-2)] + '..' if @bs.length > @width
+      @bs << (' ' * (width - @bs.length)) if @bs.length < @width
+    end
+end
+
+
+
+# Mixin:
+
+module Termite::Palette
+  Termite::Colors.each do |color|
+    define_method color do |*args|
+      Termite.colorize( color, *args )
+    end
+  end
+
+  [ :bright, :dim, :underscore, :blink,
+    :reverse, :hide ].each do |mod|
+    define_method mod do |*args|
+      Termite.decorate(mod, *args)
+    end
+  end
+
+  def redraw
+    i = 0
+    while (x = yield(i))
+      print Termite.rewrite x
+      i = i + 1
+    end
+    puts
+  end
+
+  def animated_redraw(frames, fps)
+    spf = 1.0 / fps
+    redraw do |i|
+      if i < frames
+        sleep spf
+        yield(i)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: jbe-termite
+version: !ruby/object:Gem::Version 
+  version: 1.1.1
+platform: ruby
+authors: 
+- Jostein Berre Eliassen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Termite is a basic ANSI and VT100 Ruby library.
+email: post@jostein.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- lib/termite.rb
+has_rdoc: false
+homepage: http://github.com/jbe/termite
+post_install_message: 
+rdoc_options: []
+
+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: Termite is a basic ANSI and VT100 Ruby library.
+test_files: []
+