yummi 0.0.1 → 0.0.2

data/examples/list_files.rb

@@ -28,13 +28,11 @@ opt = OptionParser::new
 @basedir = ENV['HOME']
 
 @table = Yummi::Table::new
-# setting the header sets the aliases automaically
+# setting the header sets the aliases automatically
 @table.header = ['Name', 'Size']
 @table.aliases << :directory
 # sets the title
 @table.title = 'Files in home folder'
-# aligns the first column to the left
-@table.align :name, :left
 # formats size for easily reading
 @table.format :size, :using => Yummi::Formatter.bytes
 

data/examples/logger.rb

@@ -25,11 +25,13 @@ require_relative '../lib/yummi'
 
 logger = Logger::new STDOUT
 logger.level = Logger::DEBUG
-logger.formatter = Yummi::Formatter::LogFormatter.new
+logger.formatter = Yummi::Formatter::LogFormatter.new do |severity, time, program_name, message|
+  message << $/
+end
 
-logger.debug "File: #{__FILE__}"
+logger.debug __FILE__
 logger.info "Example started"
-logger.warn "Remember to read the examples for better use of Yummi!"
+logger.warn "Warning message"
 logger.error "An error has occurred"
 logger.fatal "A fatal exception has occurred"
 logger.unknown "Unknown severity message"

data/examples/monitor_table.rb

@@ -0,0 +1,86 @@
+#                         The MIT License
+#
+# Copyright (c) 2012 Marcelo Guimarães <ataxexe@gmail.com>
+#
+# 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.
+
+require 'optparse'
+require_relative '../lib/yummi'
+
+opt = OptionParser::new
+
+@table = Yummi::Table::new
+# setting the header sets the aliases automatically
+@table.header = ['Server Name', 'Max Memory', 'Free Memory', "Max\nThreads", "In Use\nThreads"]
+# sets the title
+@table.title = 'Server Runtime Info'
+# formats memory info for easily reading
+@table.format :max_memory, :using => Yummi::Formatter.bytes
+@table.format :free_memory, :using => Yummi::Formatter.bytes
+
+# colorizer for memory
+memory_colorizer = Yummi::Colorizer.by_eval do |free_memory, max_memory|
+  free_memory.to_f / max_memory
+end
+memory_colorizer.use(:red) { |value| value > 0.1 and value < 0.3 }
+memory_colorizer.use(:intense_red) { |value| value <= 0.1 }
+
+# colorizer for threads
+thread_colorizer = Yummi::Colorizer.by_eval do |max_threads, in_use_threads|
+  in_use_threads.to_f / max_threads
+end
+thread_colorizer.use(:brown) { |value| value > 0.7 and value < 0.9 }
+thread_colorizer.use(:intense_cyan) { |value| value >= 0.9 }
+
+opt.on '--color TYPE', 'Specify the color type (zebra,row,cell,none)' do |type|
+  case type
+    when 'zebra'
+      @table.row_colorizer Yummi::IndexedDataColorizer.odd :with => :brown
+      @table.row_colorizer Yummi::IndexedDataColorizer.even :with => :purple
+    when 'row'
+      @table.row_colorizer memory_colorizer
+      @table.row_colorizer thread_colorizer
+    when 'cell'
+      @table.using_row.colorize :free_memory, :using => memory_colorizer
+      @table.using_row.colorize :in_use_threads, :using => thread_colorizer
+    when 'none'
+      @table.no_colors
+    else
+  end
+end
+opt.on '--help', 'Prints this message' do
+  puts opt
+  exit 0
+end
+
+opt.parse ARGV
+
+# sets the table data
+@table.data = [
+  ['Server 1', 1_000_000, 750_000, 200, 170],
+  ['Server 2', 1_000_000, 700_000, 200, 180],
+  ['Server 3', 1_000_000, 50_000, 200, 50],
+  ['Server 4', 1_000_000, 200_000, 200, 50],
+  ['Server 5', 1_000_000, 5_000, 200, 50],
+  ['Server 6', 1_000_000, 750_000, 200, 50],
+  ['Server 6', 1_000_000, 200_000, 200, 170],
+  ['Server 6', 1_000_000, 5_000, 200, 180],
+]
+
+@table.print

data/examples/table_cash_flow.rb

@@ -26,26 +26,23 @@ require_relative '../lib/yummi'
 opt = OptionParser::new
 
 @table = Yummi::Table::new
-# setting the header sets the aliases automaically
-@table.header = ['Description', 'Value', 'Total', 'Eletronic']
+# setting the header sets the aliases automatically
+@table.header = ['Description', 'Value', 'Total', 'Eletronic', "Authentication\nCode"]
 # sets the title
 @table.title = 'Cash Flow'
-# aligns the first column to the left
-@table.align :description, :left
-# colorize all values from the Description column to purple
 # formats booleans using Yes or No
 @table.format :eletronic, :using => Yummi::Formatter.yes_or_no
 # shows values without minus signal and rounded
 @table.format :value, :using => lambda { |value| "%.2f" % value.abs }
 # shows totals rounded
-@table.format :total, :with => "%.2f"
+@table.format :total, :using => Yummi::Formatter.round(2)
 # table data
 @table.data = [['Initial', 0, 0, false],
-               ['Deposit', 100, 100, true],
-               ['Withdraw', -50, 50, true],
-               ['Withdraw', -100, -50, true],
-               ['Deposit', 50, 0, false],
-               ['Deposit', 600, 600, false]]
+               ['Deposit', 100.58, 100.58, true, "QAWSEDRFTGH535"],
+               ['Withdraw', -50.23, 50.35, true, "34ERDTF6GYU"],
+               ['Withdraw', -100, -49.65, true, "2344EDRFT5"],
+               ['Deposit', 50, 0.35, false],
+               ['Deposit', 600, 600.35, false]]
 
 opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
   case type
@@ -53,22 +50,22 @@ opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
       @table.row_colorizer Yummi::IndexedDataColorizer.odd :with => :brown
       @table.row_colorizer Yummi::IndexedDataColorizer.even :with => :purple
     when 'full'
+      # colorize all values from the Description column to purple
       @table.colorize :description, :with => :purple
+      # Authentication Code will be highlighted
+      @table.colorize :authentication_code, :with => :highlight_gray
       # colorize booleans based on their values
       @table.colorize :eletronic do |b|
         b ? :blue : :cyan
       end
       # colorize the values based on comparison
-      colorizer = lambda do |value|
-        if value < 0 then
-          :red
-        else
-          value > 0 ? :green : :brown
-        end
-      end
+      red_to_negative = lambda { |value| :red if value < 0 }
+      green_to_positive = lambda { |value| :green if value > 0 }
+      brown_to_zero = lambda { |value| :brown if value == 0 }
+      colorizer = Yummi::Colorizer.join(red_to_negative, green_to_positive, brown_to_zero)
       @table.colorize :value, :using => colorizer
       @table.colorize :total, :using => colorizer
-      # colorize rows that Value is greather than Total
+      # colorize rows that Value is greater than Total
       @table.row_colorizer do |i, data|
         :white if data[:value] > data[:total]
       end

data/lib/yummi/logger.rb

@@ -26,19 +26,45 @@ module Yummi
 
   module Formatter
 
+    #
+    # A colorful log formatter
+    #
     class LogFormatter < Logger::Formatter
 
+      #
+      # Colors for each severity:
+      #
+      # * :debug
+      # * :info
+      # * :warn
+      # * :error
+      # * :fatal
+      # * :any
+      #
       attr_accessor :colors
 
-      def initialize
+      #
+      # Creates a new formatter with the colors (assuming Linux default terminal colors):
+      #
+      # * +DEBUG+: no color
+      # * +INFO+: green
+      # * +WARN+: brown
+      # * +ERROR+: red
+      # * +FATAL+: red (intense)
+      # * +ANY+: gray (intense)
+      #
+      # If a block is passed, it will be used to format the message
+      #
+      def initialize &block
         @colors = {
           :debug => nil,
           :info => :green,
-          :warn => :yellow,
+          :warn => :brown,
           :error => :red,
           :fatal => :intense_red,
           :any => :intense_gray
         }
+        @format_block = block
       end
 
       alias_method :super_call, :call
@@ -48,7 +74,9 @@ module Yummi
         Yummi::Color.colorize output(severity, time, program_name, message), color
       end
 
+      # Formats the message, override this method instead of #call
       def output severity, time, program_name, message
+        return @format_block.call severity, time, program_name, message if @format_block
         super_call severity, time, program_name, message
       end
 

data/lib/yummi/table.rb

@@ -21,11 +21,35 @@
 # THE SOFTWARE.
 
 module Yummi
-
+  # A Table that supports colorizing title, header, values and also formatting the values.
   class Table
+    # The table data. It holds a two dimensional array.
+    attr_accessor :data
+    # The table title
+    attr_accessor :title
+    # Default align. #Yummi#Aligner should respond to it.
+    attr_accessor :default_align
+    # Aliases that can be used by formatters and colorizers instead of numeric indexes.
+    # The aliases are directed mapped to their respective index in this array
+    attr_accessor :aliases
+    # The table colspan
+    attr_accessor :colspan
+    # The table colors. This Map should have colors for the following elements:
+    #
+    # * Title: using :title key
+    # * Header: using :header key
+    # * Values: using :value key
+    #
+    # The colors must be supported by #Yummi#Color#parse or defined in #Yummi#Color#COLORS
+    attr_accessor :colors
 
-    attr_accessor :data, :header, :title, :default_align, :aliases, :colspan, :colors
-
+    # Creates a new table with the default attributes:
+    #
+    # * Title color: intense_yellow
+    # * Header color: intense_blue
+    # * Values color: none
+    # * Colspan: 2
+    # * Default Align: right and first element to left
     def initialize
       @data = []
       @header = []
@@ -40,7 +64,7 @@ module Yummi
 
       @aliases = []
 
-      @align = []
+      @align = [:left]
       @formatters = []
       @colorizers = []
       @row_colorizer = nil
@@ -48,6 +72,7 @@ module Yummi
       @default_align = :right
     end
 
+    # Indicates that the table should not use colors.
     def no_colors
       @colors = {
         :title => nil,
@@ -57,29 +82,157 @@ module Yummi
       @no_colors = true
     end
 
+    #
+    # === Description
+    #
+    # Sets the table header. If no aliases are defined, they will be defined as the texts
+    # in lowercase with line breaks and spaces replaced by underscores.
+    #
+    # Defining headers also limits the printed column to only columns that has a header
+    # (even if it is empty).
+    #
+    # === Args
+    #
+    # +header+::
+    #   Array containing the texts for displaying the header. Line breaks are supported
+    #
+    # === Examples
+    #
+    #   table.header = ['Name', 'Email', 'Work Phone', "Home\nPhone"]
+    #
+    # This will create the following aliases: :name, :email, :work_phone and :home_phone
+    #
     def header= header
-      @aliases = header.map { |n| n.downcase.gsub(' ', '_').to_sym } if @aliases.empty?
-      @header = header
+      max = 0
+      header.each_index do |i|
+        max = [max, header[i].split("\n").size].max
+      end
+      @header = []
+      max.times { @header << [] }
+      header.each_index do |i|
+        names = header[i].split("\n")
+        names.each_index do |j|
+          @header[j][i] = names[j]
+        end
+      end
+      @aliases = header.map { |n| n.downcase.gsub(' ', '_').gsub("\n", '_').to_sym } if @aliases.empty?
     end
 
+    #
+    # === Description
+    #
+    # Sets the align for a column in the table. #Yummi#Aligner should respond to it.
+    #
+    # === Args
+    #
+    # +index+::
+    #   The column index or its alias
+    # +type+::
+    #   The alignment type
+    #
+    # === Example
+    #
+    #   table.align :description, :left
+    #   table.align :value, :right
+    #
     def align index, type
       index = parse_index(index)
       @align[index] = type
     end
 
+    #
+    # === Description
+    #
+    # Adds a component to colorize the entire row (overrides column color).
+    # The component must respond to +call+ with the index and the row as the arguments and
+    # return a color or +nil+ if default color should be used. A block can also be used.
+    #
+    # You can add as much colorizers as you want. The first color returned will be used.
+    #
+    # === Example
+    #
+    #   table.row_colorizer { |i, row| :red if row[:value] < 0 }
+    #
     def row_colorizer colorizer = nil, &block
       @row_colorizer ||= Yummi::LinkedBlocks::new
       @row_colorizer << (colorizer or block)
     end
 
+    #
+    # === Description
+    #
+    # Indicates that the column colorizer (#colorize) should receive the entire row as the
+    # argument instead of just the column value.
+    #
+    # === Return
+    #
+    # +self+
+    #
+    # === Example
+    #
+    #   table.using_row.colorize(:value) { |row| :red if row[:value] < row[:average] }
+    #
+    #
+    def using_row
+      @using_row = true
+      self
+    end
+
+    #
+    # === Description
+    #
+    # Sets a component to colorize a column.
+    #
+    # The component must respond to +call+ with the column value (or row if used with
+    # #using_row) as the arguments and return a color or +nil+ if default color should be
+    # used. A block can also be used.
+    #
+    # You can add as much colorizers as you want. The first color returned will be used.
+    #
+    # === Args
+    #
+    # +index+::
+    #   The column index or its alias
+    # +params+::
+    #   A hash with params in case a block is not given:
+    #     - :using defines the component to use
+    #     - :with defines the color to use (to use the same color for all columns)
+    #
+    # === Example
+    #
+    #   table.colorize :description, :with => :purple
+    #   table.colorize(:value) { |value| :red if value < 0 }
+    #
     def colorize index, params = {}, &block
       index = parse_index(index)
-      @colorizers[index] = (params[:using] or block)
-      @colorizers[index] ||= proc do |value|
-        params[:with]
-      end
+      @colorizers[index] ||= []
+      obj = (params[:using] or block or (proc { |v| params[:with] }))
+      @colorizers[index] << {:use_row => @using_row, :component => obj}
+      @using_row = false
     end
 
+    #
+    # === Description
+    #
+    # Sets a component to format a column.
+    #
+    # The component must respond to +call+ with the column value
+    # as the arguments and return a color or +nil+ if default color should be used.
+    # A block can also be used.
+    #
+    # === Args
+    #
+    # +index+::
+    #   The column index or its alias
+    # +params+::
+    #   A hash with params in case a block is not given:
+    #     - :using defines the component to use
+    #     - :with defines the format to use (to use the same format for all columns)
+    #
+    # === Example
+    #
+    #   table.format :value, :with => '%.2f'
+    #
     def format index, params = {}, &block
       index = parse_index(index)
       @formatters[index] = (params[:using] or block)
@@ -88,12 +241,23 @@ module Yummi
       end
     end
 
+    #
+    # Prints the #to_s into the given object.
+    #
     def print to = $stdout
       to.print to_s
     end
 
+    #
+    # Return a colorized and formatted table.
+    #
     def to_s
-      color_map, output = build_output
+      header_color_map, header_output = build_header_output
+      data_color_map, data_output = build_data_output
+
+      color_map = header_color_map + data_color_map
+      output = header_output + data_output
+
       string = ""
       string << Color.colorize(@title, @colors[:title]) << $/ if @title
       output.each_index do |i|
@@ -106,28 +270,43 @@ module Yummi
           value = Aligner.send align, column.to_s, width
           value = Color.colorize value, color unless @no_colors
           string << value
-          string << (" " * @colspan)
+          string << (' ' * @colspan)
         end
         string.strip! << $/
       end
       string
     end
 
-    private
-
-    def build_output
+    #
+    # Builds the header output for this table.
+    #
+    # Returns the color map and the header.
+    #
+    def build_header_output
       color_map = []
       output = []
 
-      _colors = []
-      _data = []
-
-      @header.each do |h|
-        _colors << @colors[:header]
-        _data << h
+      @header.each do |line|
+        _colors = []
+        _data = []
+        line.each do |h|
+          _colors << @colors[:header]
+          _data << h
+        end
+        color_map << _colors
+        output << _data
       end
-      color_map << _colors
-      output << _data
+      [color_map, output]
+    end
+
+    #
+    # Builds the data output for this table.
+    #
+    # Returns the color map and the formatted data.
+    #
+    def build_data_output
+      color_map = []
+      output = []
 
       @data.each_index do |row_index|
         row = @data[row_index]
@@ -135,11 +314,21 @@ module Yummi
         _data = []
 
         row.each_index do |col_index|
-          next if @header and not @header[col_index]
+          next if @header and @header[0].size < col_index + 1
           column = row[col_index]
-          colorizer = @colorizers[col_index]
-          _colors << (colorizer ? colorizer.call(column) : @colors[:value])
-
+          colorizers = @colorizers[col_index]
+          if colorizers
+            colorizers.each do |colorizer|
+              arg = colorizer[:use_row] ? IndexedData::new(@aliases, row) : column
+              c = colorizer[:component].call(arg)
+              if c
+                _colors << c
+                break
+              end
+            end
+          else
+            _colors << @colors[:value]
+          end
           formatter = @formatters[col_index]
           _data << (formatter ? formatter.call(column) : column)
         end
@@ -155,6 +344,8 @@ module Yummi
       [color_map, output]
     end
 
+    private
+
     def parse_index(value)
       return @aliases.index(value) unless value.is_a? Fixnum
       value

data/lib/yummi/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Yummi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/yummi.rb

@@ -25,7 +25,7 @@ require_relative "yummi/table"
 require_relative "yummi/logger"
 
 module Yummi
-
+  # Base for colorizing
   module Color
     # Colors from default linux terminal scheme
     COLORS = {
@@ -58,14 +58,14 @@ module Yummi
       :blink_cyan => '5;36',
       :blink_gray => '5;37',
 
-      :highlight_black => '5;30',
-      :highlight_red => '5;31',
-      :highlight_green => '5;32',
-      :highlight_brown => '5;33',
-      :highlight_blue => '5;34',
-      :highlight_purple => '5;35',
-      :highlight_cyan => '5;36',
-      :highlight_gray => '5;37',
+      :highlight_black => '7;30',
+      :highlight_red => '7;31',
+      :highlight_green => '7;32',
+      :highlight_brown => '7;33',
+      :highlight_blue => '7;34',
+      :highlight_purple => '7;35',
+      :highlight_cyan => '7;36',
+      :highlight_gray => '7;37',
 
       :intense_gray => '1;30',
       :intense_red => '1;31',
@@ -107,7 +107,6 @@ module Yummi
       col, nocol = [color, :nothing].map { |key| Color.escape(key) }
       col ? "#{col}#{str}#{nocol}" : str
     end
-
   end
 
   module Aligner
@@ -138,6 +137,43 @@ module Yummi
 
   end
 
+  module Colorizer
+
+    def self.join *colorizers
+      join = Yummi::LinkedBlocks::new
+      colorizers.each { |c| join << c }
+      join
+    end
+
+    def self.by_eval &block
+      EvalColorizer::new &block
+    end
+
+    class EvalColorizer
+
+      def initialize &block
+        @block = block
+        @colors = []
+        @eval_blocks = []
+      end
+
+      def use color, &eval_block
+        @colors << color
+        @eval_blocks << eval_block
+      end
+
+      def call *args
+        value = Yummi.call_block args.last, &@block # by convention, the last arg is data
+        @eval_blocks.each_index do |i|
+          return @colors[i] if @eval_blocks[i].call(value)
+        end
+        nil
+      end
+
+    end
+
+  end
+
   module Formatter
 
     def self.yes_or_no
@@ -146,6 +182,12 @@ module Yummi
       end
     end
 
+    def self.round precision
+      lambda do |value|
+        "%.#{precision}f" % value
+      end
+    end
+
     def self.unit params
       lambda do |value|
         result = value
@@ -203,6 +245,14 @@ module Yummi
 
   end
 
+  def self.call_block params, &block
+    args = []
+    block.parameters.each do |parameter|
+      args << params[parameter[1]]
+    end
+    block.call *args
+  end
+
 end
 
 require_relative 'yummi/no_colors' if RUBY_PLATFORM['mingw'] #Windows

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-08 00:00:00.000000000Z
+date: 2012-04-10 00:00:00.000000000Z
 dependencies: []
 description: A tool to colorize your console application.
 email:
@@ -26,6 +26,7 @@ files:
 - Rakefile
 - examples/list_files.rb
 - examples/logger.rb
+- examples/monitor_table.rb
 - examples/table_cash_flow.rb
 - lib/yummi.rb
 - lib/yummi/logger.rb