yummi 0.5.2 → 0.6.0

data/README.md

@@ -24,14 +24,14 @@ the examples dir to see how to use Yummi features.
 
 ## Command Line Tools
 
-Yummi exposes a 'colorize' program that you can use to colorize texts and apply
+Yummi exposes a 'yummi' program that you can use to colorize texts and apply
 patterns to colorize lines (usefull to tail logs).
 
 Examples:
 
-    colorize -c intense_red -m "some text"
-    echo "some text" | colorize -c intense_red
-    tail -f $JBOSS_HOME/standalone/log/server.log | colorize -p path-to-your-jboss7-mapping.yaml
+    yummi -c intense_red -m "some text"
+    echo "some text" | yummi -c intense_red
+    tail -f $JBOSS_HOME/standalone/log/server.log | yummi -p path-to-your-jboss7-mapping.yaml
 
 Line patterns are configured with an yaml file containing:
 
@@ -54,7 +54,7 @@ Yummi provides a set of mappings that you, check yummi/mappings dir.
 
 Mappings provided by yummi can be passed with the file name, example:
 
-    tail -f $JBOSS_HOME/standalone/log/server.log | colorize -p jboss7
+    tail -f $JBOSS_HOME/standalone/log/server.log | yummi -p jboss7
 
 Mappings in ~/.yummi dir may also used only with the file name.
 

data/bin/{colorize → yummi}

@@ -46,7 +46,7 @@ end
 opt.on '--data-type', 'Defines the data type to parse the values' do |data_type|
   @data_type = data_type
 end
-opt.on '-e FILES', '--eval=FILES', Array, 'Sets a file to eval for extending components' do |files|
+opt.on '-e FILES', '--eval=FILES', Array, 'Include the files for extending components' do |files|
   files.each do |file|
     load File.expand_path(file)
   end

data/examples/cash_flow_table.rb

@@ -30,7 +30,7 @@ tablebuilder = Yummi::TableBuilder::new('cash_flow_table.yaml')
 
 @table = tablebuilder.defaults.build_table
 
-@table.data = [['Initial', 0, 0, false, nil],
+@table.data = [['Initial', nil, 0, nil, nil],
                ['Deposit', 100.58, 100.58, true, "QAWSEDRFTGH535"],
                ['Withdraw', -50.23, 50.35, true, "34ERDTF6GYU"],
                ['Withdraw', -100, -49.65, true, "2344EDRFT5"],
@@ -44,6 +44,10 @@ end
 
 opt.on '--box', 'Prints the table inside a box' do
   @box = Yummi::TextBox::new
+  @box.style.top_left = '/'
+  @box.style.bottom_left = '\\'
+  @box.style.top_right = '\\'
+  @box.style.bottom_right = '/'
 end
 opt.on '--help', 'Prints this message' do
   puts opt

data/examples/cash_flow_table.yaml

@@ -35,7 +35,7 @@ color:
 row_color:
   blessed_income: yellow
 
-contexts:
+top:
   - format:
       total:
         numeric:
@@ -43,4 +43,13 @@ contexts:
           zero: "%.2f"
           negative: "%.2f"
     row_color:
-      with: white
+      with: bold_white
+bottom:
+  - format:
+      total:
+        numeric:
+          positive: "%.2f"
+          zero: "%.2f"
+          negative: "%.2f"
+    row_color:
+      with: bold_white

data/examples/cash_flow_table_data.csv

@@ -1,4 +1,4 @@
-Initial, 0, 0, false
+Initial, , 0, false
 Deposit, 100.58, 100.58, true, QAWSEDRFTGH535
 Withdraw, -50.23, 50.35, true, 34ERDTF6GYU
 Withdraw, -100, -49.65, true, 2344EDRFT5

data/examples/cash_flow_table_data.yaml

@@ -1,5 +1,5 @@
 - - Initial
-  - 0
+  - 
   - 0
   - false
   - 

data/examples/cash_flow_table_extensions.rb

@@ -1,8 +1,8 @@
 module Yummi
   module Colorizers
     def self.blessed_income color
-      Yummi::to_colorize do |data| # or |data, index| if you need the index
-        color if data[:value] > data[:total]
+      Yummi::to_colorize do |ctx|
+        color if ctx[:value] > ctx[:total]
       end
     end
   end

data/examples/license_box.rb

@@ -25,17 +25,48 @@ require_relative '../lib/yummi'
 
 @box = Yummi::TextBox.new
 
-@box.width = 70
-@box.default_align = :justify
-@box.default_separator[:color] = :yellow
+@box.style.width = 70
+@box.style.align = :justify
+@box.style.separator[:color] = :purple
+@box.style.border[:color] = :intense_purple
 
 opt = OptionParser::new
 
 opt.on '--align ALIGN', 'Sets the default alignment to use' do |align|
-  @box.default_align = align.to_sym
+  @box.style.align = align.to_sym
 end
 opt.on '--width WIDTH', Integer, 'Sets the text box width' do |width|
-  @box.width = width
+  @box.style.border[:width] = width
+end
+opt.on '--left PATTERN', 'Sets the left line pattern' do |pattern|
+  @box.style.border[:left] = pattern
+end
+opt.on '--right PATTERN', 'Sets the right line pattern' do |pattern|
+  @box.style.border[:right] = pattern
+end
+opt.on '--top-left PATTERN', 'Sets the top left corner pattern' do |pattern|
+  @box.style.border[:top_left] = pattern
+end
+opt.on '--top-right PATTERN', 'Sets the top right corner pattern' do |pattern|
+  @box.style.border[:top_right] = pattern
+end
+opt.on '--bottom-left PATTERN', 'Sets the bottom left corner pattern' do |pattern|
+  @box.style.border[:bottom_left] = pattern
+end
+opt.on '--bottom-right PATTERN', 'Sets the bottom right corner pattern' do |pattern|
+  @box.style.border[:bottom_right] = pattern
+end
+opt.on '--top PATTERN', 'Sets the top line pattern' do |pattern|
+  @box.style.border[:top] = pattern
+end
+opt.on '--bottom PATTERN', 'Sets the bottom line pattern' do |pattern|
+  @box.style.border[:bottom] = pattern
+end
+opt.on '--border COLOR', 'Sets the border color' do |color|
+  @box.style.border[:color] = color
+end
+opt.on '--no-border', 'Hide the text box borders' do
+  @box.no_border
 end
 opt.on '--help', 'Prints this message' do
   puts opt
@@ -56,12 +87,12 @@ opt.parse! ARGV
 @box.line_break
 @box.add 'The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.'
-@box.separator :width => @box.width / 3, :align => :center
+@box.separator :width => @box.style.width / 3, :align => :center
 @box.add '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.',
-         :color => :red
+         :color => :yellow
 @box.print

data/examples/list_files.rb

@@ -40,7 +40,7 @@ opt.on '--color TYPE', 'Specify the color type (zebra,file,none)' do |type|
   case type
     when 'zebra'
       @table.colorize_row :using => Yummi::Colorizers.stripe(:intense_gray, :intense_white)
-      @table.context do 
+      @table.bottom do 
         @table.colorize_row :with => :intense_blue
         @table.format :size, :using => Yummi::Formatters.byte
       end
@@ -48,7 +48,7 @@ opt.on '--color TYPE', 'Specify the color type (zebra,file,none)' do |type|
       @table.colorize_row do |data| # or |data, index| if you need the index
         data[:directory] ? :intense_gray : :intense_white
       end
-      @table.context do 
+      @table.bottom do 
         @table.colorize_row :with => :intense_blue
         @table.format :size, :using => Yummi::Formatters.byte
       end

data/examples/monitor_table.rb

@@ -33,32 +33,45 @@ opt = OptionParser::new
 # formats memory info for easily reading
 @table.format [:max_memory, :free_memory], :using => Yummi::Formatters.byte
 
-@table.context do
+@table.bottom do
   @table.format [:max_memory, :free_memory], :using => Yummi::Formatters.byte
-  @table.colorize_row :with => :white
+  @table.colorize_row :with => :intense_white
 end
 
 # colorizer for memory
-memory_colorizer = Yummi::Colorizers.percentage :max => :max_memory, :free => :free_memory
+@memory_colorizer = Yummi::Colorizers.percentage :max => :max_memory, :free => :free_memory
 
 # colorizer for threads
-thread_colorizer = Yummi::Colorizers.percentage :max => :max_threads,
-                                                :using => :in_use_threads,
-                                                :threshold => {
-                                                  :warn => 0.9,
-                                                  :bad => 0.7
-                                                }
-
-opt.on '--color TYPE', 'Specify the color type (zebra,cell,none)' do |type|
+@thread_colorizer = Yummi::Colorizers.percentage :max => :max_threads,
+                                                 :using => :in_use_threads,
+                                                 :colors => {
+                                                    :omg => :intense_red
+                                                  },
+                                                 :threshold => {
+                                                   :warn => 0.9,
+                                                   :bad => 0.5,
+                                                   :omg => 0.3
+                                                 }
+
+def zebra_colors
+  @table.colorize_row :using => Yummi::Colorizers.stripe(:yellow, :purple)
+end
+
+def full_colors
+  @table.colorize :server_name, :with => :purple
+  @table.colorize :free_memory, :using => @memory_colorizer
+  @table.colorize :in_use_threads, :using => @thread_colorizer
+  @table.colorize [:max_memory, :max_threads], :with => :gray
+end
+
+full_colors
+
+opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
   case type
     when 'zebra'
-      @table.colorize_row :using => Yummi::Colorizers.stripe(:yellow, :purple)
-    when 'cell'
-      @table.colorize :server_name, :with => :purple
-      @table.using_row do
-        @table.colorize :free_memory, :using => memory_colorizer
-        @table.colorize :in_use_threads, :using => thread_colorizer
-      end
+      zebra_colors
+    when 'full'
+      full_colors
     when 'none'
       @table.no_colors
     else
@@ -88,7 +101,7 @@ opt.parse ARGV
   ['Server 1', 1_000_000_000, 750_000_000, 200, 170],
   ['Server 2', 1_000_000_000, 700_000_000, 200, 180],
   ['Server 3', 1_000_000_000, 50_000_000, 200, 50],
-  ['Server 4', 1_000_000_000, 200_000_000, 200, 50],
+  ['Server 4', 1_000_000_000, 200_000_000, 200, 100],
   ['Server 5', 1_000_000_000, 5_000_000, 200, 50],
   ['Server 6', 1_000_000_000, 750_000_000, 200, 50],
 ]
@@ -99,11 +112,25 @@ opt.parse ARGV
           :max_threads => 200,
           :in_use_threads => 170
 
-@table.add :server_name => 'Server 8',
-          :max_memory => 1_000_000_000,
-          :free_memory => 5_000_000,
-          :max_threads => 200,
-          :in_use_threads => 180
+class ServerStatus
+  attr_reader :server_name, :max_memory, :free_memory, :max_threads, :in_use_threads
+
+  def initialize server_name, max_memory, free_memory, max_threads, in_use_threads
+    @server_name = server_name
+    @max_memory = max_memory
+    @free_memory = free_memory
+    @max_threads = max_threads
+    @in_use_threads = in_use_threads
+  end
+end
+
+@table.add ServerStatus::new(
+    'Server 8',
+    1_000_000_000,
+    5_000_000,
+    200,
+    180
+  )
 
 @table.add :server_name => 'Total',
           :max_memory => @table.column(:max_memory).inject(:+),

data/lib/yummi.rb

@@ -28,20 +28,19 @@ module Yummi
 
     # The Color Schema Definition
     module Schema
-      # Normal Linux Terminal Colors, used by default in normal, underscore, blink and
-      # highlight color types
+      # Normal Linux Terminal Colors, used by default in normal color types
       NORMAL_COLORS = {
-        :colors => [:black, :red, :green, :yellow, :blue, :purple, :cyan, :gray],
+        :colors => [:black, :red, :green, :yellow, :blue, :purple, :cyan, [:gray, :white]],
         :default => :gray
       }
-      # Intense Linux Terminal Colors, used by default in intense and strong color types
+      # Intense Linux Terminal Colors, used by default in bold color types
       ALTERNATE_COLORS = {
         :colors => [:gray, :red, :green, :yellow, :blue, :purple, :cyan, :white],
         :default => :gray
       }
     end
 
-    # Colors from default linux terminal scheme
+    # Color mappings
     COLORS = {}
 
     #
@@ -72,30 +71,34 @@ module Yummi
     #  (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]
+      mappings.each do |types, config|
+        [*types].each do |type|
+          schema = config[:schema]
+          schema[:colors].each_with_index do |colors, key_code|
+            [*colors].each do |color|
+              # maps the default color for a type
+              COLORS[type] = "#{config[:key_code]}#{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]}#{key_code}"
+              # maps the color using color key code
+              key = "#{prefix}#{key_code + 1}"
+              COLORS[key.to_sym] = "#{config[:key_code]}#{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]}#{key_code}" unless COLORS[color]
+            end
+          end
         end
       end
     end
 
     # Escape the given text with the given color code
     def self.escape key
-      return key unless key and COLORS[key.to_sym]
-      "\e[#{COLORS[key.to_sym]}m"
+      return key unless key and COLORS[key.to_s.to_sym]
+      "\e[#{COLORS[key.to_s.to_sym]}m"
     end
 
     # Colorize the given text with the given color
@@ -111,37 +114,26 @@ module Yummi
 
   end
 
+  # 
+  # Colorizes the text using the given color.
+  # 
+  # This method also checks if the color mode is in chain (like in "underline_bold_green").
+  # 
   # see #Color#colorize
-  def self.colorize string, color
-    Color.colorize string, color
-  end
-
-  #
-  # A module to handle blocks by dynamically resolving parameters
-  #
-  # see #DataEvalColorizer
   #
-  module BlockHandler
-
-    #
-    # Calls the block resolving the parameters by getting the parameter name from the
-    # given context.
-    #
-    # === Example
-    #
-    #   context = :max => 10, :curr => 5, ratio => 0.15
-    #   percentage = BlockHandler.call_block(context) { |max,curr| curr.to_f / max }
-    #
-    def block_call (context, &block)
-      args = []
-      block.parameters.each do |parameter|
-        args << context[parameter[1]]
+  def self.colorize string, color
+    #check if there is more than one color classifier
+    modes = color.to_s.split(/_/)
+    if modes.size >= 3
+      color = modes.last
+      modes.delete_at(-1)
+      modes.each do |mode|
+        string = Color.colorize(string, "#{mode}_#{color}")
       end
-      block.call(*args)
+      string
+    else
+      Color.colorize string, color
     end
-
-    module_function :block_call
-
   end
 
   # A module to align texts based on a reference width
@@ -191,7 +183,9 @@ module Yummi
       extra_spaces = width - text.size
       return text unless extra_spaces > 0
       words = text.split ' '
+      # do not justify only one word
       return text if words.size == 1
+      # do not justify few words
       return text if extra_spaces / (words.size - 1) > 2
       until extra_spaces == 0
         words.each_index do |i|
@@ -206,6 +200,46 @@ module Yummi
 
   end
 
+  #
+  # A module to handle blocks by dynamically resolving parameters
+  #
+  # see #DataEvalColorizer
+  #
+  module BlockHandler
+
+    #
+    # Calls the block resolving the parameters by getting the parameter name from the
+    # given context.
+    #
+    # === Example
+    #
+    #   context = :max => 10, :curr => 5, ratio => 0.15
+    #   percentage = BlockHandler.call_block(context) { |max,curr| curr.to_f / max }
+    #
+    def block_call (context, &block)
+      args = []
+      block.parameters.each do |parameter|
+        args << context[parameter[1]]
+      end
+      block.call(*args)
+    end
+
+    module_function :block_call
+
+  end
+
+  class Context
+    attr_reader :value, :obj
+
+    def initialize (value)
+      @value = value
+    end
+
+    def [] (index)
+      obj[index]
+    end
+  end
+
   # A class to expose indexed data by numeric indexes and aliases.
   class IndexedData