yummi 0.2.2 → 0.3.0

data/examples/cash_flow_table.rb

@@ -31,11 +31,11 @@ opt = OptionParser::new
 # sets the title
 @table.title = 'Cash Flow'
 # formats booleans using Yes or No
-@table.format :eletronic, :using => Yummi::Formatter.yes_or_no
+@table.format :eletronic, :using => Yummi::Formatters.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, :using => Yummi::Formatter.round(2)
+@table.format :total, :using => Yummi::Formatters.round(2)
 # table data
 @table.data = [['Initial', 0, 0, false],
                ['Deposit', 100.58, 100.58, true, "QAWSEDRFTGH535"],
@@ -47,7 +47,7 @@ opt = OptionParser::new
 opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
   case type
     when 'zebra'
-      @table.row_colorizer Yummi::Colorizer.stripe :brown, :purple
+      @table.row_colorizer Yummi::Colorizers.stripe :brown, :purple
     when 'full'
       # colorize all values from the Description column to purple
       @table.colorize :description, :with => :purple
@@ -61,11 +61,11 @@ opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
       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)
+      colorizer = Yummi::Colorizers.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 greater than Total
-      @table.row_colorizer do |i, data|
+      @table.row_colorizer do |data| # or |data, index| if you need the index
         :white if data[:value] > data[:total]
       end
     when 'none'

data/examples/list_files.rb

@@ -34,14 +34,14 @@ opt = OptionParser::new
 # sets the title
 @table.title = 'File List'
 # formats size for easily reading
-@table.format :size, :using => Yummi::Formatter.unit(:byte)
+@table.format :size, :using => Yummi::Formatters.byte
 
 opt.on '--color TYPE', 'Specify the color type (zebra,file,none)' do |type|
   case type
     when 'zebra'
-      @table.row_colorizer Yummi::Colorizer.stripe :intense_gray, :intense_white
+      @table.row_colorizer Yummi::Colorizers.stripe :intense_gray, :intense_white
     when 'file'
-      @table.row_colorizer do |i, data|
+      @table.row_colorizer do |data| # or |data, index| if you need the index
         data[:directory] ? :intense_gray : :intense_white
       end
     when 'none'

data/examples/logger.rb

@@ -25,8 +25,8 @@ require_relative '../lib/yummi'
 
 logger = Logger::new STDOUT
 logger.level = Logger::DEBUG
-logger.formatter = Yummi::Formatter::LogFormatter.new do |severity, time, program_name, message|
-  message << $/
+logger.formatter = Yummi::Formatter::LogFormatter.new do |severity, message|
+  "[#{Yummi::Aligner.left severity, 5}] #{message}"
 end
 
 logger.debug __FILE__

data/examples/monitor_table.rb

@@ -31,18 +31,18 @@ opt = OptionParser::new
 # sets the title
 @table.title = 'Server Runtime Info'
 # formats memory info for easily reading
-@table.format :max_memory, :using => Yummi::Formatter.unit(:byte)
-@table.format :free_memory, :using => Yummi::Formatter.unit(:byte)
+@table.format :max_memory, :using => Yummi::Formatters.byte
+@table.format :free_memory, :using => Yummi::Formatters.byte
 
 # colorizer for memory
-memory_colorizer = Yummi::Colorizer.by_data_eval do |free_memory, max_memory|
+memory_colorizer = Yummi::Colorizers.by_data_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_data_eval do |max_threads, in_use_threads|
+thread_colorizer = Yummi::Colorizers.by_data_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 }
@@ -51,7 +51,7 @@ 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::Colorizer.stripe :brown, :purple
+      @table.row_colorizer Yummi::Colorizers.stripe :brown, :purple
     when 'row'
       @table.row_colorizer memory_colorizer
       @table.row_colorizer thread_colorizer

data/lib/yummi.rb

@@ -21,9 +21,6 @@
 # THE SOFTWARE.
 
 require_relative "yummi/version"
-require_relative "yummi/table"
-require_relative "yummi/text_box"
-require_relative "yummi/logger"
 
 module Yummi
   # Base for colorizing
@@ -205,14 +202,50 @@ module Yummi
 
   end
 
-  # A module with useful colorizers
+  #
+  # A module that defines a colorizer capable component.
+  #
+  # Include this module in any component that returns a color in response for :call:.
+  #
   module Colorizer
 
+    #
+    # Colorizes a string by passing the arguments to the :call: method to get the proper
+    # color.
+    #
+    # === Args
+    #
+    # An array of arguments that will be passed to :call: method to get the color. By
+    # 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
+      color = call *args
+      Yummi.colorize args.first.to_s, color
+    end
+
+  end
+
+  #
+  # Adds the #Colorizer module to the given block, so you can use it to colorize texts.
+  #
+  # === Example
+  #
+  #   colorizer = Yummi.to_colorize { |value| value % 2 == 0 ? :green : :blue }
+  #   10.times { |n| puts colorizer.colorize n }
+  #
+  def self.to_colorize &block
+    block.extend Colorizer
+  end
+
+  # A module with useful colorizers
+  module Colorizers
+
     # Joins the given colorizers to work as one
     def self.join *colorizers
       join = Yummi::GroupedComponent::new
       colorizers.each { |c| join << c }
-      join
+      join.extend Colorizer
     end
 
     # Returns a new instance of #DataEvalColorizer
@@ -232,6 +265,7 @@ module Yummi
 
     # A colorizer that cycles through colors to create a striped effect
     class StripeColorizer
+      include Yummi::Colorizer
 
       # Creates a new colorizer using the given colors
       def initialize *colors
@@ -263,6 +297,7 @@ module Yummi
     #   table.using_row.colorize :current, :using => colorizer
     #
     class EvalColorizer
+      include Yummi::Colorizer
 
       def initialize &block
         @block = block
@@ -312,70 +347,85 @@ module Yummi
     #   table.using_row.colorize :current, :using => colorizer
     #
     class DataEvalColorizer < EvalColorizer
-      include Yummi::BlockHandler
+      include Yummi::BlockHandler, Yummi::Colorizer
 
       def resolve_value *args
-        block_call args.last, &@block # by convention, the last arg is data
+        block_call args.first, &@block # by convention, the first arg is data
       end
 
     end
 
   end
 
-  # A module with useful formatters
-  module Formatter
-
-    # A module for formatting units in a way that makes the value easy to read
-    module Unit
-      # Holds the information about the units that are supported in #format
-      UNITS = {
-        :byte => {:range => %w{B KB MB GB TB}, :step => 1024}
-      }
+  # A module used to create an alias method in a formatter block
+  module FormatterBlock
 
-      #
-      # Formats the value using the given unit.
-      #
-      # === Args
-      #
-      # +unit+::
-      #   A unit defined in #UNITS or a definition
-      # +value+::
-      #   The value to format
-      # +params+::
-      #   Additional parameters:
-      #   * precision: the number of fractional digits to display (defaults to 1)
-      #
-      def self.format unit, value, params = {}
-        unit = UNITS[unit] if unit.is_a? Symbol
-        params[:precision] ||= 1
-        result = value
-        units = unit[:range]
-        units.each_index do |i|
-          minimun = (unit[:step] ** i)
-          result = "%.#{params[:precision]}f #{units[i]}" % (value.to_f / minimun) if value >= minimun
-        end
-        result
-      end
+    # Calls the :call: method
+    def format value
+      call value
     end
 
-    # Formats boolean values using 'Yes' or 'No'
+  end
+
+  # Extends the given block with #FormatterBlock
+  def self.to_format &block
+    block.extend FormatterBlock
+  end
+
+  # A module with useful formatters
+  module Formatters
+
+    # A formatter for boolean values that uses 'Yes' or 'No'
     def self.yes_or_no
-      lambda do |value|
+      Yummi::to_format do |value|
         value ? "Yes" : "No"
       end
     end
 
-    # Formats a float value by rounding to the given decinal digits
+    # A formatter to float values that uses the precision to round the value
     def self.round precision
-      lambda do |value|
+      Yummi::to_format do |value|
         "%.#{precision}f" % value
       end
     end
 
-    # see #Unit#format
-    def self.unit unit, params = {}
-      lambda do |value|
-        Unit.format unit, value, params
+    # Defines the modes to format a byte value
+    BYTE_MODES = {
+      :iec => {
+        :range => %w{B KiB MiB GiB TiB PiB EiB ZiB YiB},
+        :step => 1024
+      },
+      :si => {
+        :range => %w{B KB MB GB TB PB EB ZB YB},
+        :step => 1000
+      }
+    }
+
+    #
+    # Formats a byte value to ensure easily reading
+    #
+    # === Hash Args
+    #
+    # +precision+::
+    #   How many decimal digits should be displayed. (Defaults to 1)
+    # +mode+::
+    #   Which mode should be used to display unit symbols. (Defaults to :iec)
+    #
+    # See #BYTE_MODES
+    #
+    def self.byte params = {}
+      Yummi::to_format do |value|
+        value = value.to_i if value.is_a? String
+        mode = (params[:mode] or :iec)
+        range = BYTE_MODES[mode][:range]
+        step = BYTE_MODES[mode][:step]
+        params[:precision] ||= 1
+        result = value
+        range.each_index do |i|
+          minimun = (step ** i)
+          result = "%.#{params[:precision]}f #{range[i]}" % (value.to_f / minimun) if value >= minimun
+        end
+        result
       end
     end
 
@@ -441,3 +491,7 @@ module Yummi
 end
 
 require_relative 'yummi/no_colors' if RUBY_PLATFORM['mingw'] #Windows
+
+require_relative 'yummi/table'
+require_relative 'yummi/text_box'
+require_relative 'yummi/logger'

data/lib/yummi/logger.rb

@@ -30,7 +30,7 @@ module Yummi
     # A colorful log formatter
     #
     class LogFormatter < Logger::Formatter
-
+      include Yummi::BlockHandler
       #
       # Colors for each severity:
       #
@@ -53,7 +53,8 @@ module Yummi
       # * +FATAL+: red (intense)
       # * +ANY+: gray (intense)
       #
-      # If a block is passed, it will be used to format the message
+      # If a block is passed, it will be used to format the message. The block can use
+      # the following variables: severity, time, program_name and message.
       #
       def initialize &block
         @colors = {
@@ -76,8 +77,17 @@ module Yummi
 
       # 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
+        if @format_block
+          context = {
+            :severity => severity,
+            :time => time,
+            :program_name => program_name,
+            :message => message
+          }
+          block_call(context, &@format_block) << $/
+        else
+          super_call severity, time, program_name, message
+        end
       end
 
     end

data/lib/yummi/table.rb

@@ -335,7 +335,7 @@ module Yummi
         end
         if @row_colorizer
           row_data = IndexedData::new @aliases, row
-          row_color = @row_colorizer.call row_index, row_data
+          row_color = @row_colorizer.call row_data, row_index
           _colors.collect! { row_color } if row_color
         end
         color_map << _colors

data/lib/yummi/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummi
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-16 00:00:00.000000000Z
+date: 2012-05-17 00:00:00.000000000Z
 dependencies: []
 description: A tool to colorize your console application.
 email: