ansi 1.4.3 → 1.5.0

data/demo/10_bbcode.md

@@ -0,0 +1,24 @@
+# ANSI::BBCode
+
+The BBCode module provides methods for converting between
+BBCodes, basic HTML and ANSI codes.
+
+    require 'ansi/bbcode'
+
+BBCodes are color and style codes in square brackets, quite
+popular with on line forums.
+
+    bbcode = "this is [COLOR=red]red[/COLOR], this is [B]bold[/B]"
+
+We can convert this to ANSI code simply enough:
+
+    ansi = ANSI::BBCode.bbcode_to_ansi(bbcode)
+
+    ansi.assert == "this is \e[0;31mred\e[0m, this is \e[1mbold\e[0m\n"
+
+In addition the BBCode module supports conversion to simple HTML.
+
+    html = ANSI::BBCode.bbcode_to_html(bbcode)
+
+    html.assert == "this is <font color=\"red\">red</font>, this is <strong>bold</strong><br />\n"
+

data/demo/11_terminal.md

@@ -0,0 +1,8 @@
+# ANSI::Terminal
+
+We should be ables to get the terminal width via the `terminal_width` method.
+
+    width = ANSI::Terminal.terminal_width
+
+    Fixnum.assert === width
+

data/lib/ansi.yml

@@ -1,63 +1,77 @@
 ---
-source:
-- var
+revision: 2013
+type: ruby
+sources:
+- INDEX.yml
 authors:
 - name: Thomas Sawyer
   email: transfire@gmail.com
 - name: Florian Frank
-copyrights:
-- holder: Rubyworks
-  year: '2009'
+organizations: []
 requirements:
-- name: detroit
-  groups:
+- groups:
   - build
   development: true
-- name: qed
-  groups:
+  name: mast
+- groups:
+  - build
+  development: true
+  name: indexer
+- groups:
+  - build
+  development: true
+  name: ergo
+- groups:
   - test
   development: true
-- name: lemon
-  groups:
+  name: qed
+- groups:
   - test
   development: true
-dependencies: []
-alternatives: []
+  name: ae
+- groups:
+  - test
+  development: true
+  name: lemon
 conflicts: []
-repositories:
-- uri: git://github.com/rubyworks/ansi.git
-  scm: git
-  name: upstream
+alternatives: []
 resources:
-- uri: http://rubyworks.github.com/ansi
-  label: Website
-  type: home
-- uri: http://github.com/rubyworks/ansi
-  label: Source Code
-  type: code
-- uri: http://rubydoc.info/gems/ansi/frames
+- type: home
+  uri: http://rubyworks.github.com/ansi
+  label: Homepage
+- type: docs
+  uri: http://rubydoc.info/gems/ansi/frames
   label: Documentation
-  type: docs
-- uri: http://groups.google.com/group/rubyworks-mailinglist
+- type: code
+  uri: http://github.com/rubyworks/ansi
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/ansi/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/group/rubyworks-mailinglist
   label: Mailing List
-  type: mail
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/ansi.git
 categories: []
-extra: {}
-load_path:
-- lib
-revision: 0
+copyrights:
+- holder: Rubyworks
+  year: '2009'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
 name: ansi
 title: ANSI
-created: '2009-08-01'
+version: 1.5.0
 summary: ANSI at your fingertips!
-description: ! 'The ANSI project is a superlative collection of ANSI escape code related
-  libraries
-
-  enabling ANSI colorization and stylization of console output. Byte for byte
-
-  ANSI is the best ANSI code library available for the Ruby programming
-
-  language.'
-organization: Rubyworks
-version: 1.4.3
-date: '2012-06-28'
+description: The ANSI project is a superlative collection of ANSI escape code related
+  libraries eabling ANSI colorization and stylization of console output. Byte for
+  byte ANSI is the best ANSI code library available for the Ruby programming language.
+orgranizations:
+- Rubyworks
+created: '2009-08-01'
+date: '2015-01-16'

data/lib/ansi/chart.rb

@@ -1,7 +1,5 @@
 module ANSI
 
-  require 'ansi/version'
-
   # Table of codes used throughout the system.
   #
   # @see http://en.wikipedia.org/wiki/ANSI_escape_code
@@ -9,7 +7,7 @@ module ANSI
     :clear            => 0,
     :reset            => 0,
     :bright           => 1,
-    :bold             => 1, 
+    :bold             => 1,
     :faint            => 2,
     :dark             => 2,
     :italic           => 3,
@@ -23,7 +21,6 @@ module ANSI
     :inverse          => 7,
     :reverse          => 7,
     :negative         => 7,
-    :concealed        => 8,
     :swap             => 7,
     :conceal          => 8,
     :concealed        => 8,
@@ -87,12 +84,17 @@ module ANSI
 
   #
   SPECIAL_CHART = {
-    :save             => "\e[s",   # Save current cursor positon.
-    :restore          => "\e[u",   # Restore saved cursor positon.
-    :clear_line       => "\e[K",   # Clear to the end of the current line.
-    :clr              => "\e[K",   # Clear to the end of the current line.
-    :clear_screen     => "\e[2J",  # Clear the screen and move cursor to home.
-    :cls              => "\e[2J",  # Clear the screen and move cursor to home.
+    :save             => "\e[s",     # Save current cursor positon.
+    :restore          => "\e[u",     # Restore saved cursor positon.
+    :clear_eol        => "\e[K",     # Clear to the end of the current line.
+    :clr              => "\e[K",     # Clear to the end of the current line.
+    :clear_right      => "\e[0K",    # Clear to the end of the current line.
+    :clear_left       => "\e[1K",    # Clear to the start of the current line.
+    :clear_line       => "\e[2K",    # Clear the entire current line.
+    :clear_screen     => "\e[2J",    # Clear the screen and move cursor to home.
+    :cls              => "\e[2J",    # Clear the screen and move cursor to home.
+    :cursor_hide      => "\e[?25l",  # Hide the cursor.
+    :cursor_show      => "\e[?25h"   # Show the cursor.
   }
 
 end

data/lib/ansi/code.rb

@@ -1,5 +1,11 @@
 module ANSI
 
+  # Global variable can be used to prevent ANSI codes
+  # from being used in ANSI's methods that do so to string.
+  #
+  # NOTE: This has no effect on methods that return ANSI codes.
+  $ansi = true
+
   if RUBY_PLATFORM =~ /(win32|w32)/
     begin
       require 'Win32/Console/ANSI'
@@ -11,18 +17,12 @@ module ANSI
 
   require 'ansi/constants'
 
-  # Global variialbe can be used to prevent ANSI codes
-  # from being used in ANSI's methods that do so to string.
-  #
-  # NOTE: This has no effect of methods that return ANSI codes.
-  $ansi = true
-
   # TODO: up, down, right, left, etc could have yielding methods too?
 
   # ANSI Codes
   #
   # Ansi::Code module makes it very easy to use ANSI codes.
-  # These are esspecially nice for beautifying shell output.
+  # These are especially nice for beautifying shell output.
   #
   #   Ansi::Code.red + "Hello" + Ansi::Code.blue + "World"
   #   => "\e[31mHello\e[34mWorld"
@@ -32,7 +32,7 @@ module ANSI
   #
   # IMPORTANT! Do not mixin Ansi::Code, instead use {ANSI::Mixin}.
   #
-  # See {ANSI::Code::CHART} for list of all supported codes.
+  # See {ANSI::CHART} for list of all supported codes.
   #
   module Code
     extend self
@@ -56,59 +56,6 @@ module ANSI
       %w{black red green yellow blue magenta cyan white}
     end
 
-=begin
-    styles.each do |style|
-      module_eval <<-END, __FILE__, __LINE__
-        def #{style}(string=nil)
-          if string
-            return string unless $ansi
-            #warn "use ANSI block notation for future versions"
-            return "\#{#{style.upcase}}\#{string}\#{ENDCODE}"
-          end
-          if block_given?
-            return yield unless $ansi
-            return "\#{#{style.upcase}}\#{yield}\#{ENDCODE}"
-          end
-          #{style.upcase}
-        end
-      END
-    end
-=end
-
-=begin
-    # Dynamically create color methods.
-
-    colors.each do |color|
-      module_eval <<-END, __FILE__, __LINE__
-        def #{color}(string=nil)
-          if string
-            return string unless $ansi
-            #warn "use ANSI block notation for future versions"
-            return "\#{#{color.upcase}}\#{string}\#{ENDCODE}"
-          end
-          if block_given?
-            return yield unless $ansi
-            return "\#{#{color.upcase}}\#{yield}\#{ENDCODE}"
-          end
-          #{color.upcase}
-        end
-
-        def on_#{color}(string=nil)
-          if string
-            return string unless $ansi
-            #warn "use ANSI block notation for future versions"
-            return "\#{ON_#{color.upcase}}\#{string}\#{ENDCODE}"
-          end
-          if block_given?
-            return yield unless $ansi
-            return "\#{ON_#{color.upcase}}\#{yield}\#{ENDCODE}"
-          end
-          ON_#{color.upcase}
-        end
-      END
-    end
-=end
-
     # Return ANSI code given a list of symbolic names.
     def [](*codes)
       code(*codes)
@@ -165,10 +112,10 @@ module ANSI
     end
 
     # TODO: How to deal with position codes when $ansi is false?
-    # Should we reaise an error or just not push the codes?
+    # Should we raise an error or just not push the codes?
     # For now, we will leave this it as is.
 
-    # Like +move+ but returns to original positon after
+    # Like +move+ but returns to original position after
     # yielding the block.
     def display(line, column=0) #:yield:
       result = "\e[s"
@@ -188,25 +135,27 @@ module ANSI
       "\e[#{line.to_i};#{column.to_i}H"
     end
 
-    # Move cursor up a specificed number of spaces.
+    # Move cursor up a specified number of spaces.
     def up(spaces=1)
       "\e[#{spaces.to_i}A"
     end
 
-    # Move cursor down a specificed number of spaces.
+    # Move cursor down a specified number of spaces.
     def down(spaces=1)
       "\e[#{spaces.to_i}B"
     end
 
-    # Move cursor left a specificed number of spaces.
+    # Move cursor left a specified number of spaces.
     def left(spaces=1)
       "\e[#{spaces.to_i}D"
     end
+    alias :back :left
 
-    # Move cursor right a specificed number of spaces.
+    # Move cursor right a specified number of spaces.
     def right(spaces=1)
       "\e[#{spaces.to_i}C"
     end
+    alias :forward :right
 
     ##
     #def position
@@ -228,6 +177,7 @@ module ANSI
       if block_given?
         string = yield.to_s
       else
+        # first argument must be the string
         string = codes.shift.to_s
       end
 
@@ -260,7 +210,7 @@ module ANSI
     # Alias for #ansi method.
     #
     # @deprecated
-    #   Here for backward scompatibility.
+    #   Here for backward compatibility.
     alias_method :style, :ansi
 
     # Alias for #unansi method.
@@ -285,7 +235,7 @@ module ANSI
     # Also resolves :random and :on_random.
     #
     # @param codes [Array<Symbol,Integer]
-    #   Symbols or integers to covnert to ANSI code.
+    #   Symbols or integers to convert to ANSI code.
     #
     # @return [String] ANSI code
     def code(*codes)
@@ -296,11 +246,18 @@ module ANSI
           when Integer
             code
           when Array
-            rgb(*code)
-          when :random
+            rgb_code(*code)
+          when :random, 'random'
             random
-          when :on_random
+          when :on_random, 'on_random'
             random(true)
+          when String
+            # TODO: code =~ /\d\d\d\d\d\d/ ?
+            if code.start_with?('#')
+              hex_code(code)
+            else
+              CHART[code.to_sym]
+            end
           else
             CHART[code.to_sym]
           end
@@ -318,30 +275,69 @@ module ANSI
       (background ? 40 : 30) + rand(8)
     end
 
+    # Creates an XTerm 256 color escape code from RGB value(s). The
+    # RGB value can be three arguments red, green and blue respectively
+    # each from 0 to 255, or the RGB value can be a single CSS-style
+    # hex string.
+    #
+    # @param background [Boolean]
+    #   Use `true` for background color, otherwise foreground color.
+    #
+    def rgb(*args)
+      case args.size
+      when 1, 2
+        hex, background = *args
+        esc = "\e[" + hex_code(hex, background) + "m"
+      when 3, 4
+        red, green, blue, background = *args
+        esc = "\e[" + rgb_code(red, green, blue, background) + "m"
+      else
+        raise ArgumentError
+      end
+
+      if block_given?
+        return yield.to_s unless $ansi
+        return "#{esc}#{yield}#{ENDCODE}"
+      else
+        return esc
+      end
+    end
+
+  #private
+
     # Creates an xterm-256 color from rgb value.
     #
     # @param background [Boolean]
     #   Use `true` for background color, otherwise foreground color.
     #
-    def rgb(red, green, blue, background=false)
-      "#{background ? 48 : 38};5;#{rgb_value(red, green, blue)}"
+    def rgb_code(red, green, blue, background=false)
+      "#{background ? 48 : 38};5;#{rgb_256(red, green, blue)}"
     end
 
-    # Creates an xterm-256 color from a CSS-style color string.
-    def hex(string, background=false)
+    # Creates an xterm-256 color code from a CSS-style color string.
+    #
+    # @param string [String]
+    #   Hex string in CSS style, .e.g. `#5FA0C2`.
+    #
+    # @param background [Boolean]
+    #   Use `true` for background color, otherwise foreground color.
+    #
+    def hex_code(string, background=false)
       string.tr!('#','')
       x = (string.size == 6 ? 2 : 1)
       r, g, b = [0,1,2].map{ |i| string[i*x,2].to_i(16) }
-      rgb(r, g, b, background)
+      rgb_code(r, g, b, background)
     end
 
-    private
-
-    # Gets closest xterm-256 color.
+    # Given red, green and blue values between 0 and 255, this method
+    # returns the closest XTerm 256 color value.
+    #
     def rgb_256(r, g, b)
-      r, g, b = [r, g, b].map{ |c| rgb_valid(c); (6 * (c.to_f / 256.0)).to_i }
+      # TODO: what was rgb_valid for?
+      #r, g, b = [r, g, b].map{ |c| rgb_valid(c); (6 * (c.to_f / 256.0)).to_i }
+      r, g, b = [r, g, b].map{ |c| (6 * (c.to_f / 256.0)).to_i }
       v = (r * 36 + g * 6 + b + 16).abs
-      raise ArgumentError, "RGB value outside 0-255 range" if v > 255
+      raise ArgumentError, "RGB value is outside 0-255 range -- #{v}" if v > 255
       v
     end