riel 1.1.16 → 1.1.17

data/README.md

@@ -3,8 +3,8 @@ 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.
+RIEL is a library that extends core Ruby libraries, and adds a logging
+framework and an option processor.
 
 ## CLASSES
 
@@ -22,47 +22,12 @@ array.
 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 wraps strings in ANSI colors. For example:
-
-    "foo".blue
-    "bar".bold.blue.on_white
-
-It also handles RGB values (on a 0-5 scale, not 0-255):
-
-    "foo".rgb(3, 1, 5)
-    "bar".on_rgb(1, 0, 4)
-
-Colors and attributes can be chained:
-
-    "hey!".rgb(0, 3, 5).on_rgb(5, 2, 1).bold.underline
- 
-Aliases (names) for colors can be defined:
-
-    Text::ANSIHighlighter.instance.add_alias :teal, 1, 4, 4
-    puts "hello, word".teal
- 
-Background aliases are supported:
-
-    Text::ANSIHighlighter.instance.add_alias :on_slate, 0, 1, 1
-    puts "hello, word".teal
  
 ### 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.
-
-### RGBPalette
-
-This class prints the set of RGB (extended ANSI) colors as foregrounds,
-backgrounds and combinations.
-
 ### ANSIITable
 
 This class prints a spreadsheet-like table of data.

data/lib/riel/log/log.rb

@@ -9,9 +9,10 @@
 # Documentation:: Author
 #
 
-require 'riel/ansicolor'
 require 'riel/log/logger'
 require 'riel/log/severity'
+require 'rubygems'
+require 'rainbow'
 
 #
 # == Log
@@ -53,6 +54,10 @@ require 'riel/log/severity'
 module RIEL
   class Log
     $LOGGING_LEVEL = nil
+
+    DEFAULT_FILENAME_WIDTH = -25
+    DEFAULT_LINENUM_WIDTH = 4
+    DEFAULT_FUNCTION_WIDTH = -20
     
     include Log::Severity
 
@@ -67,48 +72,36 @@ module RIEL
     end
 
     def self.method_missing meth, *args, &blk
-      if code = ANSIColor::ATTRIBUTES[meth.to_s]
-        add_color_method meth.to_s, code
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      # only handling foregrounds, not backgrounds
+      if code = validcolors[meth]
+        add_color_method meth.to_s, code + 30
         send meth, *args, &blk
       else
         super
       end
     end
 
+    def self.respond_to? meth
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      validcolors.include?(meth) || super
+    end
+
     def self.add_color_method color, code
       instmeth = Array.new
-      instmeth << "def #{color} msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk"
+      instmeth << "def #{color} msg = \"\", lvl = Log::DEBUG, depth = 1, cname = nil, &blk"
       instmeth << "  log(\"\\e[#{code}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
       instmeth << "end"
       instance_eval instmeth.join("\n")
 
       clsmeth = Array.new
-      clsmeth << "def #{color} msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk"
+      clsmeth << "def #{color} msg = \"\", lvl = Log::DEBUG, depth = 1, cname = nil, &blk"
       clsmeth << "  logger.#{color}(\"\\e[#{code}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
       clsmeth << "end"
 
       class_eval clsmeth.join("\n")
     end
 
-    if false
-      ANSIColor::ATTRIBUTES.sort.each do |attr|
-        methname = attr[0]
-
-        instmeth = Array.new
-        instmeth << "def #{methname}(msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk)"
-        instmeth << "  log(\"\\e[#{attr[1]}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
-        instmeth << "end"
-        instance_eval instmeth.join("\n")
-
-        clsmeth = Array.new
-        clsmeth << "def #{methname}(msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk)"
-        clsmeth << "  logger.#{methname}(\"\\e[#{attr[1]}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
-        clsmeth << "end"
-
-        class_eval clsmeth.join("\n")
-      end
-    end
-
     def self.set_default_widths
       logger.set_default_widths
     end

data/lib/riel/log/loggable.rb

@@ -10,6 +10,8 @@
 #
 
 require 'riel/log/log'
+require 'rubygems'
+require 'rainbow'
 
 #
 # == Loggable
@@ -73,31 +75,27 @@ module RIEL
     end
 
     def method_missing meth, *args, &blk
-      if ANSIColor::ATTRIBUTES[meth.to_s]
-        add_color_method meth.to_s
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      # only handling foregrounds, not backgrounds
+      if code = validcolors[meth]
+        add_color_method meth.to_s, code + 30
         send meth, *args, &blk
       else
         super
       end
     end
 
-    def add_color_method color
+    def respond_to? meth
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      validcolors.include?(meth) || super
+    end
+
+    def add_color_method color, code
       meth = Array.new
-      meth << "def #{color} msg = \"\", lvl = Log::DEBUG, depth = 1, &blk"
+      meth << "def #{color}(msg = \"\", lvl = Log::DEBUG, depth = 1, cname = nil, &blk)"
       meth << "  Log.#{color} msg, lvl, depth + 1, self.class.to_s, &blk"
       meth << "end"
       self.class.module_eval meth.join("\n")
     end
-
-    if false
-      ANSIColor::ATTRIBUTES.sort.each do |attr|
-        methname = attr[0]
-        meth = Array.new
-        meth << "def #{methname} msg = \"\", lvl = Log::DEBUG, depth = 1, &blk"
-        meth << "  Log.#{methname} msg, lvl, depth + 1, self.class.to_s, &blk"
-        meth << "end"
-        module_eval meth.join("\n")
-      end
-    end
   end
 end

data/lib/riel/log/logger.rb

@@ -9,8 +9,10 @@
 # Documentation:: Author
 #
 
-require 'riel/ansicolor'
+require 'rubygems'
+require 'rainbow'
 require 'riel/log/severity'
+require 'riel/log/format'
 
 #
 # == Logger
@@ -71,7 +73,7 @@ module RIEL
     end
 
     def set_default_widths
-      set_widths(-25, 4, -20)
+      set_widths Log::DEFAULT_FILENAME_WIDTH, Log::DEFAULT_LINENUM_WIDTH, Log::DEFAULT_FUNCTION_WIDTH
     end
 
     def verbose
@@ -88,8 +90,8 @@ module RIEL
     # lines with zeros (e.g., "00317") the line_width argument must be a string,
     # not an integer.
     def set_widths file_width, line_width, func_width
-      @file_width     = file_width
-      @line_width     = line_width
+      @file_width = file_width
+      @line_width = line_width
       @function_width = func_width
       
       @format = "[%#{file_width}s:%#{line_width}d] {%#{func_width}s}"
@@ -174,6 +176,11 @@ module RIEL
       file, line, func = md[1], md[2], (md[3] || "")
       # file.sub!(/.*\//, "")
 
+      # Ruby 1.9 expands the file name, but 1.8 doesn't:
+      pn = Pathname.new(file).expand_path
+      
+      file = pn.to_s
+
       if cname
         func = cname + "#" + func
       end
@@ -185,42 +192,12 @@ module RIEL
       end
     end
 
-    def trim_left str, maxlen
-      str[0 ... maxlen.to_i.abs]
-    end
-
-    def trim_right str, maxlen
-      mxln = maxlen.abs
-
-      # magic number 3 for the ellipses ...
-
-      if str.length > mxln
-        path = str.split('/')
-        newstr = "..."
-        path.reverse.each do |element|
-          if newstr.length + element.length > mxln
-            while newstr.length < mxln
-              newstr.insert 0, " "
-            end
-            return newstr
-          else
-            if newstr.length > 3
-              newstr.insert 3, "/"
-            end
-            newstr.insert 3, element
-          end
-        end
-        newstr
-      else
-        str
-      end
-    end
-
     def print_formatted file, line, func, msg, lvl, &blk
       if trim
-        file = trim_right file, @file_width
-        line = trim_left  line, @line_width
-        func = trim_left  func, @function_width
+        fmt = Format.new
+        file = fmt.trim_right file, @file_width
+        line = fmt.trim_left  line, @line_width
+        func = fmt.trim_left  func, @function_width
       end
 
       hdr = sprintf @format, file, line, func
@@ -237,31 +214,41 @@ module RIEL
         end
       end
 
-      if @colors[lvl]
+      msg = msg.to_s.chomp
+
+      if lvlcol = @colors[lvl]
         if colorize_line
-          @output.puts @colors[lvl] + hdr + " " + msg.to_s.chomp + ANSIColor.reset
+          line = hdr + " " + msg
+          @output.puts line.color(lvlcol)
         else
-          @output.puts hdr + " " + @colors[lvl] + msg.to_s.chomp + ANSIColor.reset
+          @output.puts hdr + " " + msg.color(lvlcol)
         end
       else
-        @output.puts hdr + " " + msg.to_s.chomp
+        @output.puts hdr + " " + msg
       end      
     end
 
     def set_color lvl, color
-      @colors[lvl] = ANSIColor::code color
+      @colors[lvl] = color
     end
 
-    def self.method_missing(meth, *args, &blk)
-      if code = ANSIColor::ATTRIBUTES[meth.to_s]
-        add_color_method meth.to_s, code
+    def method_missing meth, *args, &blk
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      # only handling foregrounds, not backgrounds
+      if code = validcolors[meth]
+        add_color_method meth.to_s, code + 30
         send meth, *args, &blk
       else
         super
       end
     end
 
-    def self.add_color_method color, code
+    def respond_to? meth
+      validcolors = Sickill::Rainbow::TERM_COLORS
+      validcolors.include?(meth) || super
+    end
+
+    def add_color_method color, code
       instmeth = Array.new
       instmeth << "def #{color}(msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk)"
       instmeth << "  log(\"\\e[#{code}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
@@ -275,24 +262,5 @@ module RIEL
 
       class_eval clsmeth.join("\n")
     end
-
-    if false
-      ANSIColor::ATTRIBUTES.sort.each do |attr|
-        methname = attr[0]
-
-        instmeth = Array.new
-        instmeth << "def #{methname}(msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk)"
-        instmeth << "  log(\"\\e[#{attr[1]}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
-        instmeth << "end"
-        instance_eval instmeth.join("\n")
-
-        clsmeth = Array.new
-        clsmeth << "def #{methname}(msg = \"\", lvl = DEBUG, depth = 1, cname = nil, &blk)"
-        clsmeth << "  logger.#{methname}(\"\\e[#{attr[1]}m\#{msg\}\\e[0m\", lvl, depth + 1, cname, &blk)"
-        clsmeth << "end"
-
-        class_eval clsmeth.join("\n")
-      end
-    end
   end
 end

data/lib/riel/log.rb

@@ -19,66 +19,3 @@ module RIEL
 end
 
 include RIEL
-
-if __FILE__ == $0
-  Log.verbose = true
-  Log.set_widths 15, -5, -35
-  #Log.outfile = "/tmp/log." + $$.to_s
-
-  class Demo
-    include Loggable
-    
-    def initialize
-      # log "hello"
-      Log.set_color Log::DEBUG, "cyan"
-      Log.set_color Log::INFO,  "bold cyan"
-      Log.set_color Log::WARN,  "reverse"
-      Log.set_color Log::ERROR, "bold red"
-      Log.set_color Log::FATAL, "bold white on red"
-    end
-
-    def meth
-      # log
-
-      i = 4
-      # info { "i: #{i}" }
-
-      i /= 3
-      debug { "i: #{i}" }
-
-      i **= 3
-      info "i: #{i}"
-
-      i **= 2
-      warn "i: #{i}"
-
-      i <<= 4
-      error "i: #{i}"
-
-      i <<= 1
-      fatal "i: #{i}"
-    end
-  end
-
-  class Another
-    include Loggable
-    
-    def Another.cmeth
-      # /// "Log" only in instance methods
-      # log "I'm sorry, Dave, I'm afraid I can't do that."
-
-      # But this is legal.
-      Log.log "happy, happy, joy, joy"
-    end
-  end
-  
-  demo = Demo.new
-  demo.meth
-
-  # Log.colorize_line = true
-
-  # demo.meth
-  # Another.cmeth
-
-  # Log.info "we are done."
-end

data/lib/riel/optproc.rb

@@ -1,10 +1,7 @@
 #!/usr/bin/ruby -w
 # -*- ruby -*-
 
-require 'riel/env'
 require 'riel/log'
-require 'riel/text'
-require 'riel/enumerable'
 
 module OptProc
   class Option

data/lib/riel/string.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/ruby -w
 # -*- ruby -*-
 
-require 'riel/text'
-
 #
 # = string.rb
 #

data/lib/riel.rb

@@ -4,5 +4,5 @@ $:.unshift(riellibdir) unless
   $:.include?(riellibdir) || $:.include?(File.expand_path(riellibdir))
 
 module RIEL
-  VERSION = '1.1.16'
+  VERSION = '1.1.17'
 end

data/test/riel/log/format_test.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pathname'
+require 'test/unit'
+require 'stringio'
+require 'riel/log/format'
+require 'riel/log/loggable'
+
+module RIEL
+  class FormatTestCase < Test::Unit::TestCase
+    include RIEL::Loggable
+
+    def run_trim_left_test expected, length, str = "something"
+      trimmed = Format.new.trim_left(str, length)
+      assert_equal expected, trimmed
+    end
+
+    def test_trim_left_short_positive_number
+      run_trim_left_test "some", 4
+    end
+
+    def test_trim_left_long
+      run_trim_left_test "something", 10
+    end
+
+    def test_trim_left_short_negative_number
+      run_trim_left_test "some", -4
+    end
+
+    def run_trim_right_test expected, length, str = "something"
+      trimmed = Format.new.trim_right(str, length)
+      assert_equal expected, trimmed
+    end
+
+    def test_trim_right_short_positive_number
+      run_trim_right_test "  ...", 5
+    end
+
+    def test_trim_right_long
+      run_trim_right_test "something", 10
+    end
+
+    def test_trim_right_short_negative_number
+      run_trim_right_test "  ...", -5
+    end
+  end
+end

data/test/riel/optproc_test.rb

@@ -12,35 +12,6 @@ class OptProcTestCase < Test::Unit::TestCase
     ENV['HOME'] = '/this/should/not/exist'
   end
 
-  def run_test args, exp, &blk
-    expected = DEFAULTS.merge(exp)
-
-    # ignore what they have in ENV[HOME]    
-    ENV['HOME'] = '/this/should/not/exist'
-
-    origargs = args.dup
-    
-    gopt = GlarkOptions.instance
-    gopt.run args
-    
-    expected.sort { |a, b| a[0].to_s <=> b[0].to_s }.each do |opt, exval|
-      meth = gopt.method(opt)
-      val  = meth.call
-      if val.kind_of? Array
-        assert_equal exval.length, val.length, "#{opt} => #{exval.class}.length #{exval.inspect}; #{val.class}.length #{val.inspect}; #{origargs.inspect}"
-        (0 ... exval.length).each do |idx|
-          assert_equal exval[idx], val[idx], "#{opt}[#{idx}] => #{exval.class}.length #{exval.inspect}; #{val.class}.length #{val.inspect}; #{origargs.inspect}"
-        end
-      else
-        assert_equal exval, val, "#{opt} => #{exval.class} #{exval.inspect}; #{val.class} #{val.inspect}; #{origargs.inspect}"
-      end
-    end
-    
-    blk.call(gopt) if blk
-
-    gopt.reset
-  end
-
   def run_match_tag_test opt, exp, tag
     m = opt.match [ tag ]
     match = nil
@@ -80,7 +51,7 @@ class OptProcTestCase < Test::Unit::TestCase
     end
   end
 
-  def run_match_value_test(opt, exp, val)
+  def run_match_value_test opt, exp, val
     m = opt.match_value val
     assert !!m == !!exp, "match value #{val}; expected: #{exp.inspect}; actual: #{m.inspect}"
   end