riel 1.1.12 → 1.1.13

data/README.md

@@ -0,0 +1,41 @@
+RIEL - Extensions to core Ruby libraries
+============================================================
+
+## DESCRIPTION
+
+RIEL is a library that extends core Ruby libraries. It includes a logging
+framework, an option processor, highlighting of strings.
+
+## CLASSES
+
+### Array
+
+The core Array class is extended for better output of `to_s`, to output strings
+in the format: [ "this", "is", "a", "test" ], instead of the default,
+"thisisatest".
+
+The `rand` method, equivalent to Array#sample, returns a random element from an
+array.
+
+### Command
+
+The method `run` runs a command, returning the lines of output, and optionally
+calling a block with each line, and the line number, if the block takes two
+arguments.
+
+### ANSIHighlighter
+
+This class processes strings, wrapping them in ANSI colors. For example:
+
+    "foo".blue
+    "bar".bold.blue.on_white
+
+### SetDiff
+
+This class compares enumerables as sets, A fully including B, B fully including
+A, or A and B having common elements.
+
+### AnsiPalette
+
+This class prints the set of ANSI colors as foregrounds and backgrounds.
+

data/lib/riel/array.rb

@@ -2,7 +2,6 @@
 # -*- ruby -*-
 
 class Array 
-
   $-w = false
 
   # Wraps the array with brackets, and inserts a comma and a space between
@@ -17,5 +16,4 @@ class Array
   def rand
     return self[Kernel.rand length]
   end
-  
 end

data/lib/riel/command.rb

@@ -3,11 +3,9 @@
 #!ruby -w
 
 class Command
-
   # Runs the given command and arguments, returning the lines of output. If a
   # block is provided, then it will be called with each line of output. If the
   # block takes two arguments, then the line number is also passed to the block.
-
   def self.run(cmd, *args, &blk)
     lines = Array.new
     
@@ -26,5 +24,4 @@ class Command
     
     lines
   end
-
 end

data/lib/riel/date.rb

@@ -4,13 +4,9 @@
 
 require 'date'
 
-
 class Date
-
   # Returns the number of days in the given month.
-  
   def self.days_in_month year, month
     (Date.new(year, 12, 31) << (12 - month)).day
   end
-
 end

data/lib/riel/file.rb

@@ -206,5 +206,4 @@ class File
     end
     tgt
   end
-  
 end

data/lib/riel/pathname.rb

@@ -6,7 +6,6 @@ require 'riel/string'
 require 'fileutils'
 
 class Pathname
-
   # a compliment to the +dirname+, +basename+, and +extname+ family, this returns
   # the basename without the extension, e.g. "foo" from "/usr/share/lib/foo.bar".
   def rootname
@@ -24,5 +23,4 @@ class Pathname
   def mkdirs
     File.makedirs to_s
   end
-
 end

data/lib/riel/setdiff.rb

@@ -5,10 +5,12 @@
 # identical, A contains B, B contains A, or A and B contain common elements.
 
 class SetDiff
-  def SetDiff.new a, b
+  def self.new a, b
     allitems = a | b
 
-    a_and_b    = Array.new
+    diff_type = :identical
+
+    a_and_b = Array.new
     a_not_in_b = Array.new
     b_not_in_a = Array.new
 
@@ -30,7 +32,7 @@ class SetDiff
   attr_reader :a_and_b, :a_not_in_b, :b_not_in_a
 
   def initialize a_and_b, a_not_in_b, b_not_in_a
-    @a_and_b    = a_and_b
+    @a_and_b = a_and_b
     @a_not_in_b = a_not_in_b
     @b_not_in_a = b_not_in_a
   end

data/lib/riel/string.rb

@@ -13,7 +13,6 @@ require 'riel/text'
 #
 
 class String
-
   #
   # Returns whether the string ends with the given substring.
   #
@@ -74,17 +73,17 @@ class String
   #    "1-".to_ranges :min => 0, :max => 8               # [ 1 .. 8 ]
   # 
   def to_ranges args = Hash.new
-    min      = args[:min] || -Infinity
-    max      = args[:max] || Infinity
+    min = args[:min] || -Infinity
+    max = args[:max] || Infinity
     collapse = args[:collapse]
     
     ranges = Array.new
     self.split(%r{\s*,\s*}).each do |section|
-      md   = section.match(RANGE_REGEXP)
+      md = section.match(RANGE_REGEXP)
       next unless md
       
       from = String._matchdata_to_number md, 1, min
-      to   = String._has_matchdata?(md, 2) ? String._matchdata_to_number(md, 3, max) : from
+      to = String._has_matchdata?(md, 2) ? String._matchdata_to_number(md, 3, max) : from
 
       prevrange = ranges[-1]
 
@@ -98,20 +97,6 @@ class String
     ranges
   end
 
-  # :stopdoc:
-  HIGHLIGHTER = ::Text::ANSIHighlighter.new
-  # :startdoc:
-  
-  # 
-  # Returns a highlighted (colored) version of the string, applying the regular
-  # expressions in the array, which are paired with the desired color.
-  #
-  def highlight re, color
-    gsub(re) do |match|
-      HIGHLIGHTER.color color, match
-    end
-  end
-
   # :stopdoc:
   def self._has_matchdata? md, idx
     md && md[idx] && !md[idx].empty?
@@ -121,5 +106,4 @@ class String
     _has_matchdata?(md, idx) ? md[idx].to_i : default
   end
   # :startdoc:
-
 end

data/lib/riel/text/ansi/ansi_color.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/color'
+
+module Text
+  # An ANSI color uses only the basic 8 colors.
+  class AnsiColor < Color
+    def initialize value
+      super value, nil
+    end
+
+    def to_s
+      "\e[#{value}m"
+    end
+
+    def print_fg
+      print fg
+      print "#{@value}/."
+      print reset
+      print ' '
+    end    
+
+    def print_bg
+      print bg
+      print "./#{@value}"
+      print reset
+      print ' '
+    end    
+  end
+end

data/lib/riel/text/ansi/ansi_colors.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/ansi_list'
+
+module Text
+  class Colors < ANSIList
+    COLORS = [ :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white ]
+
+    def initialize colors, start
+      color_to_code = Hash.new
+      colors.each_with_index { |color, idx| color_to_code[color.to_s] = start + idx }
+      super color_to_code
+    end
+  end
+end

data/lib/riel/text/ansi/ansi_highlight.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/highlight'
+require 'riel/text/ansi/ansi_color'
+require 'riel/text/ansi/ansi_colors'
+require 'riel/text/ansi/attributes'
+require 'riel/text/ansi/foregrounds'
+require 'riel/text/ansi/backgrounds'
+require 'riel/text/ansi/grey'
+require 'riel/text/ansi/rgb_color'
+require 'singleton'
+
+module Text
+  # Highlights using ANSI escape sequences.
+  class ANSIHighlighter < Highlighter
+    include Singleton
+    
+    DEFAULT_COLORS = [
+                      "black on yellow",
+                      "black on green",
+                      "black on magenta",
+                      "yellow on black",
+                      "magenta on black",
+                      "green on black",
+                      "cyan on black",
+                      "blue on yellow",
+                      "blue on magenta",
+                      "blue on green",
+                      "blue on cyan",
+                      "yellow on blue",
+                      "magenta on blue",
+                      "green on blue",
+                      "cyan on blue",
+                     ]
+    
+    ATTRIBUTES = Hash.new
+    [ Attributes, Foregrounds, Backgrounds ].each { |cls| ATTRIBUTES.merge! cls.new.colors }
+
+    def initialize 
+      @aliases = Hash.new
+    end
+    
+    def codes names
+      names.collect { |name| ATTRIBUTES[name] }.compact
+    end
+
+    # Returns the escape sequence for the given names.
+    def names_to_code names
+      names = [ names ] unless names.kind_of? Array
+      names.collect { |name| ATTRIBUTES[name].to_s }.join ''
+    end
+
+    def to_rgb str, red, green, blue, meth
+      color = RGBColor.new red, green, blue
+      color.send(meth) + str + color.reset
+    end
+
+    def rgb str, red, green, blue
+      to_rgb str, red, green, blue, :fg
+    end
+
+    def on_rgb str, red, green, blue
+      to_rgb str, red, green, blue, :bg
+    end
+
+    def to_grey str, value, meth
+      color = Grey.new 232 + value
+      color.send(meth) + str + color.reset
+    end
+
+    def grey str, value
+      to_grey str, value, :fg
+    end
+
+    def on_grey str, value
+      to_grey str, value, :bg
+    end
+
+    alias_method :gray, :grey
+    alias_method :on_gray, :on_grey
+
+    def add_alias name, red, green, blue
+      type = name.to_s[0 .. 2] == 'on_' ? :bg : :fg
+      color = RGBColor.new red, green, blue, type
+      @aliases[name] = color
+    end
+
+    def has_alias? name
+      @aliases.include? name
+    end
+
+    def respond_to? meth
+      has_alias? meth
+    end
+
+    def method_missing(meth, *args, &blk)
+      if has_alias? meth
+        methdecl = Array.new
+        methdecl << "def #{meth}(str, &blk);"
+        methdecl << "  color = @aliases[:#{meth}];"
+        methdecl << "  color.to_s + str + color.reset;"
+        methdecl << "end"
+        self.class.class_eval methdecl.join("\n")
+        send meth, *args, &blk
+      else
+        super
+      end
+    end
+  end
+end

data/lib/riel/text/ansi/ansi_list.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/ansi_color'
+
+module Text
+  class ANSIList
+    attr_reader :colors
+
+    def initialize colors
+      @colors = Hash.new
+      colors.each do |name, code|
+        @colors[name] = AnsiColor.new code
+      end
+    end
+  end
+end

data/lib/riel/text/ansi/ansi_palette.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/ansi_color'
+require 'riel/text/ansi/palette'
+require 'singleton'
+
+module Text
+  class AnsiPalette < Palette
+    include Singleton
+
+    ANSI_RG = (0 .. 7)
+
+    def each &blk
+      ANSI_RG.each do |bg|
+        color = AnsiColor.new bg
+        blk.call color
+      end
+    end
+    
+    def print_foregrounds
+      puts "ansi foregrounds"
+      write_foregrounds
+      puts
+      puts
+    end
+
+    def print_backgrounds
+      puts "ansi backgrounds"
+      write_backgrounds
+      puts
+      puts
+    end
+
+    def print_combinations
+      puts "ansi combinations"
+      each do |bgcolor|
+        puts "bg: #{bgcolor.to_str}"
+        each do |fgcolor|
+          print bgcolor.bg
+          fgcolor.print_fg
+        end
+        puts
+        puts
+      end
+    end
+  end
+end

data/lib/riel/text/ansi/attributes.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/ansi_list'
+
+module Text
+  class Attributes < ANSIList
+    def initialize 
+      super Hash[
+                 'none'       => '0', 
+                 'reset'      => '0',
+                 'bold'       => '1',
+                 'underscore' => '4',
+                 'underline'  => '4',
+                 'blink'      => '5',
+                 'negative'   => '7',
+                 'concealed'  => '8',
+                ]
+    end
+  end
+end

data/lib/riel/text/ansi/backgrounds.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/ansi_colors'
+
+module Text
+  class Backgrounds < Colors
+    def initialize 
+      on_colors = COLORS.collect { |color| "on_#{color}" }
+      super on_colors, 40
+    end
+  end
+end

data/lib/riel/text/ansi/color.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module Text
+  class Color
+    BOLD = "\e[1m"
+    RESET = "\x1b[0m"
+
+    # \e1 == \x1b
+
+    attr_reader :value
+
+    def initialize value, type
+      @value = value
+      @type = type
+    end
+
+    def to_s
+      @type == :fg ? fg : bg
+    end
+    
+    def fg
+      str 38
+    end
+
+    def bg
+      str 48
+    end
+
+    def str num
+      "\x1b[#{num};5;#{value}m"
+    end
+
+    def bold
+      BOLD
+    end
+    
+    def reset
+      RESET
+    end
+
+    def print_fg
+      write fg
+    end
+
+    def print_bg
+      write bg
+    end
+
+    def to_str
+      sprintf "%03d", @value
+    end
+    
+    private
+    def write fgbg
+      print fgbg
+      print to_str
+      print reset
+      print ' '
+    end
+  end
+end

data/lib/riel/text/ansi/foregrounds.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/ansi_colors'
+
+module Text
+  class Foregrounds < Colors
+    def initialize 
+      super COLORS, 30
+    end
+  end
+end

data/lib/riel/text/ansi/grey.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/color'
+
+module Text
+  class Grey < Color
+    def initialize value
+      super value, nil
+    end
+
+    def to_s
+      "\e[#{value}m"
+    end
+
+    def print_fg
+      print fg
+      print to_str
+      print reset
+      print ' '
+    end    
+
+    def print_bg
+      print bg
+      print to_str
+      print reset
+      print ' '
+    end    
+  end
+end

data/lib/riel/text/ansi/grey_palette.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/grey'
+require 'riel/text/ansi/palette'
+require 'singleton'
+
+module Text
+  class GreyPalette < Palette
+    include Singleton
+
+    GREY_RG = (0 .. 23)
+    
+    def each &blk
+      count = 0
+      GREY_RG.each do |grey|
+        code = 232 + grey
+        color = Grey.new code
+        blk.call color
+        count += 1
+        puts if count > 0 && (count % 6) == 0
+      end
+      puts
+    end
+
+    def print_foregrounds
+      puts "grey foreground colors"
+      write_foregrounds
+    end
+
+    def print_backgrounds
+      puts "grey background colors"
+      write_backgrounds
+    end
+  end
+end

data/lib/riel/text/ansi/palette.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module Text
+  class Palette
+    def write_foregrounds
+      each do |color|
+        color.print_fg
+      end
+    end
+
+    def write_backgrounds
+      each do |color|
+        color.print_bg
+      end
+    end
+  end
+end

data/lib/riel/text/ansi/rgb_color.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/color'
+
+module Text
+  class RGBColor < Color
+    attr_reader :red
+    attr_reader :green
+    attr_reader :blue
+    
+    def initialize red, green, blue, type = :fg
+      super((red * 36) + (green * 6) + blue + 16, type)
+      
+      @red = red
+      @green = green
+      @blue = blue
+    end
+
+    def to_str
+      sprintf "%d%d%d", @red, @green, @blue
+    end
+
+    def value
+      (@red * 36) + (@green * 6) + @blue + 16
+    end
+  end
+end

data/lib/riel/text/ansi/rgb_palette.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/ansi/rgb_color'
+require 'riel/text/ansi/palette'
+require 'singleton'
+
+module Text
+  class RGBPalette < Palette
+    include Singleton
+
+    def each &blk
+      rgbrg = (0 .. 5)
+
+      count = 0
+      rgbrg.each do |red|
+        rgbrg.each do |green|
+          rgbrg.each do |blue|
+            blk.call RGBColor.new(red, green, blue)
+            count += 1
+            puts if count > 0 && (count % 6) == 0
+          end
+        end
+        puts
+      end
+    end
+    
+    def print_foregrounds
+      puts "rgb foreground colors"
+      write_foregrounds
+    end
+
+    def print_backgrounds
+      puts "rgb background colors"
+      write_backgrounds
+    end
+
+    def print_combinations
+      puts "all combinations"
+      each do |rgbbg|
+        puts "bg: #{rgbbg.to_str}"
+        each do |rgbfg|
+          print rgbbg.bg
+          rgbfg.print_fg
+        end
+      end
+    end
+  end
+end