yummi 0.3.2 → 0.4.0

data/examples/cash_flow_table.rb

@@ -36,13 +36,14 @@ opt = OptionParser::new
 @table.format :value, :using => lambda { |value| "%.2f" % value.abs }
 # shows totals rounded
 @table.format :total, :using => Yummi::Formatters.round(2)
+@table.format_null :with => 'none'
 # table data
-@table.data = [['Initial', 0, 0, false],
+@table.data = [['Initial', 0, 0, false, nil],
                ['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]]
+               ['Deposit', 50, 0.35, false, nil],
+               ['Deposit', 600, 600.35, false, nil]]
 
 opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
   case type
@@ -68,6 +69,7 @@ opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
       @table.row_colorizer do |data| # or |data, index| if you need the index
         :white if data[:value] > data[:total]
       end
+      @table.colorize_null :with => :red
     when 'none'
       @table.no_colors
     else

data/examples/monitor_table.rb

@@ -67,7 +67,7 @@ opt.on '--color TYPE', 'Specify the color type (zebra,row,cell,none)' do |type|
 end
 opt.on '--layout LAYOUT', 'Defines the table layout (horizontal or vertical)' do |layout|
   case layout
-    when 'horizonta'
+    when 'horizontal'
       @table.layout = :horizontal
     when 'vertical'
       @table.layout = :vertical

data/lib/yummi.rb

@@ -25,82 +25,82 @@ require_relative "yummi/version"
 module Yummi
   # Base for colorizing
   module Color
+
+    # The Color Schema Definition
+    module Schema
+      # Normal Linux Terminal Colors, used by default in normal, underscore, blink and
+      # highlight color types
+      NORMAL_COLORS = {
+        :colors => [:black, :red, :green, :brown, :blue, :purple, :cyan, :gray],
+        :default => :gray
+      }
+      # Intense Linux Terminal Colors, used by default in intense and strong color types
+      ALTERNATE_COLORS = {
+        :colors => [:gray, :red, :green, :yellow, :blue, :purple, :cyan, :white],
+        :default => :gray
+      }
+    end
+
     # Colors from default linux terminal scheme
-    COLORS = {
-      :black => '0;30',
-      :red => '0;31',
-      :green => '0;32',
-      :brown => '0;33',
-      :blue => '0;34',
-      :purple => '0;35',
-      :cyan => '0;36',
-      :gray => '0;37',
-
-      :black_underscored => '4;30',
-      :red_underscored => '4;31',
-      :green_underscored => '4;32',
-      :brown_underscored => '4;33',
-      :blue_underscored => '4;34',
-      :purple_underscored => '4;35',
-      :cyan_underscored => '4;36',
-      :gray_underscored => '4;37',
-
-      :blink_black => '5;30',
-      :blink_red => '5;31',
-      :blink_green => '5;32',
-      :blink_brown => '5;33',
-      :blink_blue => '5;34',
-      :blink_purple => '5;35',
-      :blink_cyan => '5;36',
-      :blink_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',
-      :intense_green => '1;32',
-      :intense_yellow => '1;33',
-      :yellow => '1;33',
-      :intense_blue => '1;34',
-      :intense_purple => '1;35',
-      :intense_cyan => '1;36',
-      :intense_white => '1;37',
-      :white => '1;37'
-    }
-    # Types of color
-    TYPES = {
-      :normal => 0,
-      :intense => 1,
-      :underscored => 4,
-      :blink => 5,
-      :highlight => 7
-    }
-    # Parses the key
-    def self.parse key
-      keys = key.to_s.split '_'
-      type = keys[0].to_sym
-      color = keys[1].to_i
-      "#{TYPES[type]};3#{color - 1}"
+    COLORS = {}
+
+    #
+    # Clears all color mappings and add this ones
+    #
+    # see #add_color_map
+    #
+    def self.load_color_map mappings
+      COLORS.clear
+      add_color_map mappings
+    end
+
+    #
+    # Adds the given color mappings, overriding the already defined.
+    #
+    # Colors are printed using a "[#{type_key_code}:3#{color_key_code}m" prefix.
+    #
+    # === Args
+    #
+    # The mappings is a Hash of Hashes, each parent hash must define a type key and the
+    # child hash must contain the following keys:
+    #
+    # +key_code+::
+    #   The key code to map this type. If the type name is :default, the mapping will not
+    #   use the name "default" (:normal_red will become only :red)
+    # +schema+::
+    #   An array with the color names. Each name will be mapped and their positions
+    #  (1 based) too. (:intense_red and :intense_2, for example)
+    #
+    def self.add_color_map mappings
+      mappings.each do |type, config|
+        schema = config[:schema]
+        schema[:colors].each_with_index do |color, key_code|
+          # maps the default color for a type
+          COLORS[type] = "#{config[:key_code]};3#{key_code}" if color == schema[:default]
+          # do not use prefix if schema is default
+          prefix = (type == :default ? '' : "#{type}_")
+          # maps the color using color name
+          key = "#{prefix}#{color}"
+          COLORS[key.to_sym] = "#{config[:key_code]};3#{key_code}"
+          # maps the color using color key code
+          key = "#{prefix}#{key_code + 1}"
+          COLORS[key.to_sym] = "#{config[:key_code]};3#{key_code}"
+          # maps the color using color name if default schema does not defines it
+          # example: yellow and white are present only in strong/intense schema
+          COLORS[color.to_sym] = "#{config[:key_code]};3#{key_code}" unless COLORS[color]
+        end
+      end
     end
 
     # Escape the given text with the given color code
     def self.escape key
-      return key unless key
-      color = (COLORS[key.to_sym] or key)
-      color ||= parse(key)
-      "\033[#{color}m"
+      return key unless key and COLORS[key.to_sym]
+      "\033[#{COLORS[key.to_sym]}m"
     end
 
     # Colorize the given text with the given color
     def self.colorize string, color
-      color, end_color = [color, '0;0'].map { |key| Color.escape(key) }
+      color, end_color = [color, "\033[0;0m"].map { |key| Color.escape(key) }
       color ? "#{color}#{string}#{end_color}" : string
     end
 
@@ -132,7 +132,7 @@ module Yummi
     #   context = :max => 10, :curr => 5, ratio => 0.15
     #   percentage = BlockHandler.call_block(context) { |max,curr| curr.to_f / max }
     #
-    def block_call context, &block
+    def block_call (context, &block)
       args = []
       block.parameters.each do |parameter|
         args << context[parameter[1]]
@@ -219,7 +219,7 @@ module Yummi
     # convention, the first argument must be the object to colorize (to_s is called on it
     # for getting the text to colorize).
     #
-    def colorize *args
+    def colorize (*args)
       color = call *args
       Yummi.colorize args.first.to_s, color
     end
@@ -268,7 +268,7 @@ module Yummi
       include Yummi::Colorizer
 
       # Creates a new colorizer using the given colors
-      def initialize *colors
+      def initialize (*colors)
         @colors = colors
         @count = -1
       end
@@ -299,7 +299,7 @@ module Yummi
     class EvalColorizer
       include Yummi::Colorizer
 
-      def initialize &block
+      def initialize (&block)
         @block = block
         @colors = []
         @eval_blocks = []
@@ -311,17 +311,17 @@ module Yummi
       #
       # An objtect that responds to :call may also be used.
       #
-      def use color, component = nil, &eval_block
+      def use (color, component = nil, &eval_block)
         @colors << color
         @eval_blocks << (component or eval_block)
       end
 
       # Resolves the value using the main block and given arguments
-      def resolve_value *args
+      def resolve_value (*args)
         @block.call *args
       end
 
-      def call *args
+      def call (*args)
         value = resolve_value *args
         @eval_blocks.each_index do |i|
           return @colors[i] if @eval_blocks[i].call(value)
@@ -349,7 +349,7 @@ module Yummi
     class DataEvalColorizer < EvalColorizer
       include Yummi::BlockHandler, Yummi::Colorizer
 
-      def resolve_value *args
+      def resolve_value (*args)
         block_call args.first, &@block # by convention, the first arg is data
       end
 
@@ -361,7 +361,7 @@ module Yummi
   module FormatterBlock
 
     # Calls the :call: method
-    def format value
+    def format (value)
       call value
     end
 
@@ -434,12 +434,12 @@ module Yummi
   # A class to expose indexed data by numeric indexes and aliases.
   class IndexedData
 
-    def initialize aliases, data
+    def initialize (aliases, data)
       @aliases = aliases
       @data = data
     end
 
-    def [] value
+    def [](value)
       if value.is_a? Fixnum
         @data[value]
       else
@@ -463,21 +463,21 @@ module Yummi
     #     should be ignored
     #     - message: the message to send. Defaults to :call
     #
-    def initialize params = {}
+    def initialize (params = {})
       @components = []
       @call_all = params[:call_all]
       @message = (params[:message] or :call)
     end
 
     # Adds a new component
-    def << component = nil, &block
+    def << (component = nil, &block)
       @components << (component or block)
     end
 
     #
     # Calls the added components by sending the configured message and the given args.
     #
-    def call *args
+    def call (*args)
       result = nil
       @components.each do |component|
         break if result and not @call_all
@@ -492,6 +492,7 @@ end
 
 require_relative 'yummi/no_colors' if RUBY_PLATFORM['mingw'] #Windows
 
+require_relative 'yummi/color_mapping'
 require_relative 'yummi/table'
 require_relative 'yummi/text_box'
 require_relative 'yummi/logger'

data/lib/yummi/color_mapping.rb

@@ -0,0 +1,60 @@
+#                         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.
+
+Yummi::Color::load_color_map(
+  :default => {
+    :key_code => 0,
+    :schema => Yummi::Color::Schema::NORMAL_COLORS
+  },
+  :intense => {
+    :key_code => 1,
+    :schema => Yummi::Color::Schema::ALTERNATE_COLORS
+  },
+  :strong => {
+    :key_code => 1,
+    :schema => Yummi::Color::Schema::ALTERNATE_COLORS
+  },
+  :underscore => {
+    :key_code => 4,
+    :schema => Yummi::Color::Schema::NORMAL_COLORS
+  },
+  :underscored => {
+    :key_code => 4,
+    :schema => Yummi::Color::Schema::NORMAL_COLORS
+  },
+  :blink => {
+    :key_code => 5,
+    :schema => Yummi::Color::Schema::NORMAL_COLORS
+  },
+  :blinking => {
+    :key_code => 5,
+    :schema => Yummi::Color::Schema::NORMAL_COLORS
+  },
+  :highlight => {
+    :key_code => 7,
+    :schema => Yummi::Color::Schema::NORMAL_COLORS
+  },
+  :highlighted => {
+    :key_code => 7,
+    :schema => Yummi::Color::Schema::NORMAL_COLORS
+  }
+)

data/lib/yummi/table.rb

@@ -43,7 +43,7 @@ module Yummi
     # The colors must be supported by #Yummi#Color#parse or defined in #Yummi#Color#COLORS
     attr_accessor :colors
     # The table layout (horizontal or vertical)
-    attr_accessor :layout
+    attr_reader :layout
 
     # Creates a new table with the default attributes:
     #
@@ -64,6 +64,7 @@ module Yummi
 
       @colspan = 2
       @layout = :horizontal
+      @default_align = :right
       @aliases = []
 
       @align = [:left]
@@ -71,7 +72,8 @@ module Yummi
       @colorizers = []
       @row_colorizer = nil
 
-      @default_align = :right
+      @predicated_formatters = nil
+      @predicated_colorizers = nil
     end
 
     # Indicates that the table should not use colors.
@@ -84,6 +86,18 @@ module Yummi
       @no_colors = true
     end
 
+    def layout=(layout)
+      @layout = layout
+      case layout
+        when :horizontal
+          @default_align = :right
+        when :vertical
+          @default_align = :left
+        else
+          raise 'Unsupported layout'
+      end
+    end
+
     #
     # 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.
@@ -102,20 +116,9 @@ module Yummi
     #
     # This will create the following aliases: :name, :email, :work_phone and :home_phone
     #
-    def header= header
+    def header= (header)
       header = [header] unless header.respond_to? :each
-      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
+      @header = normalize(header)
       @aliases = header.map { |n| n.downcase.gsub(' ', '_').gsub("\n", '_').to_sym } if @aliases.empty?
     end
 
@@ -134,7 +137,7 @@ module Yummi
     #   table.align :description, :left
     #   table.align :value, :right
     #
-    def align index, type
+    def align (index, type)
       index = parse_index(index)
       @align[index] = type
     end
@@ -150,7 +153,7 @@ module Yummi
     #
     #   table.row_colorizer { |i, row| :red if row[:value] < 0 }
     #
-    def row_colorizer colorizer = nil, &block
+    def row_colorizer (colorizer = nil, &block)
       @row_colorizer ||= Yummi::GroupedComponent::new
       @row_colorizer << (colorizer or block)
     end
@@ -195,13 +198,30 @@ module Yummi
     #   table.colorize :description, :with => :purple
     #   table.colorize(:value) { |value| :red if value < 0 }
     #
-    def colorize index, params = {}, &block
+    def colorize (index, params = {}, &block)
       index = parse_index(index)
       @colorizers[index] ||= []
       obj = (params[:using] or block or (proc { |v| params[:with] }))
       @colorizers[index] << {:use_row => @using_row, :component => obj}
     end
 
+    #
+    # Defines a colorizer to null values.
+    #
+    # === Args
+    #
+    # +params+::
+    #   A hash with params in case a block is not given:
+    #     - :using defines the component to use
+    #     - :with defines the format to use
+    #
+    def colorize_null (params = {}, &block)
+      @null_colorizer = (params[:using] or block)
+      @null_colorizer ||= proc do |value|
+        params[:with]
+      end
+    end
+
     #
     # Sets a component to format a column.
     #
@@ -222,7 +242,7 @@ module Yummi
     #
     #   table.format :value, :with => '%.2f'
     #
-    def format index, params = {}, &block
+    def format (index, params = {}, &block)
       index = parse_index(index)
       @formatters[index] = (params[:using] or block)
       @formatters[index] ||= proc do |value|
@@ -230,10 +250,27 @@ module Yummi
       end
     end
 
+    #
+    # Defines a formatter to null values.
+    #
+    # === Args
+    #
+    # +params+::
+    #   A hash with params in case a block is not given:
+    #     - :using defines the component to use
+    #     - :with defines the format to use
+    #
+    def format_null (params = {}, &block)
+      @null_formatter = (params[:using] or block)
+      @null_formatter ||= proc do |value|
+        params[:with] % value
+      end
+    end
+
     #
     # Prints the #to_s into the given object.
     #
-    def print to = $stdout
+    def print (to = $stdout)
       to.print to_s
     end
 
@@ -241,35 +278,33 @@ module Yummi
     # Return a colorized and formatted table.
     #
     def to_s
-      header_color_map, header_output = build_header_output
-      data_color_map, data_output = build_data_output
+      header_output = build_header_output
+      data_output = build_data_output
 
       string = ""
       string << Color.colorize(@title, @colors[:title]) << $/ if @title
-      color_map = header_color_map + data_color_map
       table_data = header_output + data_output
       if @layout == :vertical
         # don't use array transpose because the data may differ in each line size
-        color_map = rotate color_map
         table_data = rotate table_data
       end
-      string << content(color_map, table_data)
+      string << content(table_data)
     end
 
     #
     # Gets the content string for the given color map and content
     #
-    def content color_map, data
+    def content (data)
       string = ""
       data.each_index do |i|
         row = data[i]
         row.each_index do |j|
           column = row[j]
+          column ||= {:value => nil, :color => nil}
           width = max_width data, j
           alignment = (@align[j] or @default_align)
-          color = color_map[i][j]
-          value = Aligner.align alignment, column.to_s, width
-          value = Color.colorize value, color unless @no_colors
+          value = Aligner.align alignment, column[:value].to_s, width
+          value = Color.colorize value, column[:color] unless @no_colors
           string << value
           string << (' ' * @colspan)
         end
@@ -284,20 +319,16 @@ module Yummi
     # Returns the color map and the header.
     #
     def build_header_output
-      color_map = []
       output = []
 
       @header.each do |line|
-        _colors = []
         _data = []
         line.each do |h|
-          _colors << @colors[:header]
-          _data << h
+          _data << {:value => h, :color => @colors[:header]}
         end
-        color_map << _colors
         output << _data
       end
-      [color_map, output]
+      output
     end
 
     #
@@ -306,61 +337,99 @@ module Yummi
     # 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]
-        _colors = []
-        _data = []
+        _row_data = []
         row = row.to_a if row.is_a? Range
         row.each_index do |col_index|
           next if not @header.empty? and @header[0].size < col_index + 1
+          color = nil
+          value = nil
           column = row[col_index]
           colorizers = @colorizers[col_index]
-          if colorizers
+          if @null_colorizer and column.nil?
+            color = @null_colorizer.call(column)
+          elsif colorizers
             colorizers.each do |colorizer|
               arg = colorizer[:use_row] ? IndexedData::new(@aliases, row) : column
               c = colorizer[:component].call(arg)
               if c
-                _colors << c
+                color = c
                 break
               end
             end
           else
-            _colors << @colors[:value]
+            color = @colors[:value]
           end
           formatter = @formatters[col_index]
-          _data << (formatter ? formatter.call(column) : column)
+          formatter = @null_formatter if column.nil? and @null_formatter
+          value = (formatter ? formatter.call(column) : column)
+
+          _row_data << {:value => value, :color => color}
         end
         if @row_colorizer
           row_data = IndexedData::new @aliases, row
           row_color = @row_colorizer.call row_data, row_index
-          _colors.collect! { row_color } if row_color
+          _row_data.collect! { |data| data[:color] = row_color; data } if row_color
         end
-        color_map << _colors
-        output << _data
-      end
 
-      [color_map, output]
+        _row_data = normalize(_row_data,
+                              :extract => proc do |data|
+                                data[:value].to_s
+                              end,
+                              :new => proc do |value, data|
+                                {:value => value, :color => data[:color]}
+                              end
+        )
+        _row_data.each do |_row|
+          output << _row
+        end
+      end
+      output
     end
 
     private
 
+    def normalize(row, params = {})
+      params[:extract] ||= proc do |value|
+        value.to_s
+      end
+      params[:new] ||= proc do |extracted, value|
+        extracted
+      end
+      max = 0
+      row.each_index do |i|
+        max = [max, params[:extract].call(row[i]).split("\n").size].max
+      end
+      result = []
+      max.times { result << [] }
+      row.each_index do |i|
+        names = params[:extract].call(row[i]).split("\n")
+        names.each_index do |j|
+          result[j][i] = params[:new].call(names[j], row[i])
+        end
+      end
+      result
+    end
+
     def parse_index(value)
       return @aliases.index(value) unless value.is_a? Fixnum
       value
     end
 
-    def max_width data, column
+    def max_width(data, column)
       max = 0
       data.each do |row|
-        max = [row[column].to_s.length, max].max
+        var = row[column]
+        var ||= {}
+        max = [var[:value].to_s.length, max].max
       end
       max
     end
 
-    def rotate data
+    def rotate(data)
       new_data = []
       data.each_index do |i|
         data[i].each_index do |j|

data/lib/yummi/text_box.rb

@@ -58,7 +58,7 @@ module Yummi
     #            If the #width is set, this will override the box width for this lines.
     #     align: the text alignment (see #Yummi#Aligner)
     #
-    def add text, params = {}
+    def add (text, params = {})
       params = {
         :width => @width,
         :align => @default_align
@@ -87,7 +87,7 @@ module Yummi
     end
 
     # Adds the given object as it
-    def << object
+    def << (object)
       text = object.to_s
       text.each_line do |line|
         add line
@@ -107,7 +107,7 @@ module Yummi
     #     width: the separator width (#self#width will be used if unset)
     #     align: the separator alignment (see #Yummi#Aligner)
     #
-    def separator pattern = @default_separator[:pattern], params = {}
+    def separator (pattern = @default_separator[:pattern], params = {})
       unless pattern.is_a? String
         params = pattern
         pattern = @default_separator[:pattern]
@@ -127,7 +127,7 @@ module Yummi
     end
 
     # Prints the #to_s into the given object.
-    def print to = $stdout
+    def print (to = $stdout)
       to.print to_s
     end
 
@@ -155,7 +155,7 @@ module Yummi
 
     private
 
-    def _add_ text, params
+    def _add_ (text, params)
       if params[:align] and params[:width]
         text = Yummi::Aligner.align params[:align], text, params[:width]
       end

data/lib/yummi/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummi
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-07 00:00:00.000000000 Z
+date: 2012-07-13 00:00:00.000000000 Z
 dependencies: []
 description: A tool to colorize your console application.
 email:
@@ -32,6 +32,7 @@ files:
 - examples/logger.rb
 - examples/monitor_table.rb
 - lib/yummi.rb
+- lib/yummi/color_mapping.rb
 - lib/yummi/logger.rb
 - lib/yummi/no_colors.rb
 - lib/yummi/table.rb