yummi 0.4.2 → 0.4.3

data/.gitignore

@@ -16,6 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 *~
-*.iml
-*.ipr
 *.iws
+*.sublime-project
+*.sublime-workspace

data/bin/colorize

@@ -25,10 +25,15 @@
 require_relative '../lib/yummi'
 require 'optparse'
 
+@params = []
+
 opt = OptionParser::new
 opt.on '-c COLOR', '--color=COLOR', 'Colorize using the given color' do |color|
   @color = color
 end
+opt.on '-p PATTERN', '--pattern=PATTERN', 'Sets a pattern to colorize each line' do |pattern|
+  @colorizer = Yummi::Colorizers.line pattern
+end
 opt.on '-t TEXT', '--text=TEXT', 'Colorize the given text' do |text|
   @text = text
 end
@@ -38,14 +43,26 @@ opt.on '-h', '--help', 'Display this help message' do
 end
 opt.parse! ARGV
 
-if @color
+def print_out text
+  if @color
+    puts Yummi::colorize text, @color
+  elsif @colorizer
+    puts @colorizer.colorize text
+  end
+end
+
+if @color or @colorizer
   if @text
-    puts Yummi::colorize @text, @color
+    print_out @text
   else
-    ARGF.each_line do |line|
-      puts Yummi::colorize line.chomp, @color
+    begin
+      ARGF.each_line do |line|
+        print_out line.chomp
+      end
+    rescue Interrupt
+      #Do nothing
     end
   end
 else
-  abort 'Please give a color.'
+  abort 'Please give a color or choose a pattern.'
 end

data/examples/cash_flow_table.rb

@@ -57,7 +57,7 @@ def full_colors
   # colorize the values based on comparison
   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 }
+  brown_to_zero = lambda { |value| :yellow if value == 0 }
   @table.colorize [:value, :total], :using => Yummi::Colorizers.join(
     red_to_negative, green_to_positive, brown_to_zero
   )
@@ -69,7 +69,7 @@ def full_colors
 end
 
 def zebra_colors
-  @table.row_colorizer Yummi::Colorizers.stripe :brown, :purple
+  @table.row_colorizer Yummi::Colorizers.stripe :yellow, :purple
 end
 
 def no_colors

data/examples/license_box.rb

@@ -44,7 +44,7 @@ end
 
 opt.parse! ARGV
 
-@box.add 'The MIT License', :color => :yellow, :align => :center
+@box.add 'The MIT License', :color => :intense_yellow, :align => :center
 @box.line_break
 @box.add 'Copyright (c) 2012 Marcelo Guimaraes <ataxexe@gmail.com>', :color => :green, :align => :center
 @box.separator

data/examples/logcat_colorizer.rb

@@ -0,0 +1,55 @@
+#                         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_relative '../lib/yummi'
+
+params = {
+  :prefix => /\[/,
+  :suffix => /\]/,
+  :patterns => {
+    'ERROR' => :red,
+    'FATAL' => :intense_red,
+    'WARN'  => :yellow,
+    'INFO'  => :green,
+    'DEBUG' => :gray
+  }
+}
+
+log = <<LOG
+[INFO] Starting
+[WARN] Example output
+[DEGUB] Connecting to server
+[ERROR] Error while connecting
+caused by: ConnectionException
+            at Connection.connect
+              at Startup
+[INFO] Could not connect to server
+[FATAL] A fatal error
+[WARN] Application shutdown
+[DEBUG] Shutdown command executed
+LOG
+
+colorizer = Yummi::Colorizers.line(params)
+
+log.each_line do |line|
+  puts colorizer.colorize(line.chomp)
+end

data/lib/yummi/colorizers.rb

@@ -0,0 +1,260 @@
+#                         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 'yaml'
+
+module Yummi
+  #
+  # 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)
+      Yummi.colorize args.first.to_s, color_for(args)
+    end
+
+    #
+    # Returns the color for the given value
+    #
+    # === 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 color_for (*args)
+      call *args
+    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.extend Colorizer
+    end
+
+    # Returns a new instance of #DataEvalColorizer
+    def self.by_data_eval &block
+      DataEvalColorizer::new(&block)
+    end
+
+    # Returns a new instance of #EvalColorizer
+    def self.by_eval &block
+      EvalColorizer::new(&block)
+    end
+
+    # Returns a new instance of #StripeColorizer
+    def self.stripe *colors
+      StripeColorizer::new(*colors)
+    end
+
+    # Returns a new instance of #LineColorizer
+    def self.line mappings
+      LineColorizer::new mappings
+    end
+
+    #
+    # A colorizer for lines that follows a pattern. This colorizer is usefull
+    # for log files.
+    #
+    class LineColorizer
+      include Yummi::Colorizer
+
+      #
+      # Creates a new instance using the parameters.
+      #
+      # === Args
+      #
+      # A hash containing the following keys:
+      #
+      #   * prefix: a pattern prefix
+      #   * suffix: a pattern suffix
+      #   * patterns: a pattern => color hash
+      #
+      # If a string is passed, a file containing a YAML configuration
+      # will be loaded. If the string doesn't represent a file, the
+      # following patterns will be used to find it:
+      # 
+      #   * $HOME/.yummi/PATTERN.yaml
+      #   * $YUMMI_GEM/yummy/mappings/PATTERN.yaml
+      #
+      def initialize params
+        unless params.is_a? Hash
+          file = File.expand_path params.to_s
+          if File.exist? file
+            params = YAML::load_file file
+          else
+            ['~/.yummi', File.join(File.dirname(__FILE__), 'mappings')].each do |path|
+              file = File.join(path, "#{params}.yaml")
+              if File.exist? file
+                params = YAML::load_file file
+                break
+              end
+            end
+          end
+        end
+        patterns = (params[:patterns] or params['patterns'])
+        prefix = (params[:prefix] or params['prefix'])
+        suffix = (params[:suffix] or params['suffix'])
+        @patterns = Hash[*(patterns.collect do |pattern, color|
+          [/#{prefix}#{pattern.to_s}#{suffix}/, color]
+        end).flatten]
+
+        @last_color = nil
+      end
+
+      def call *args
+        line = args.first.to_s
+        @patterns.each do |regex, color|
+          if regex.match(line)
+            @last_color = color
+            return color
+          end
+        end
+        @last_color
+      end
+
+    end
+
+    # 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)
+        @colors = colors
+        @count = -1
+      end
+
+      def call *args
+        @count += 1
+        @colors[@count % @colors.size]
+      end
+
+    end
+
+    #
+    # A colorizer that evaluates a main block and returns a color based on other blocks.
+    #
+    # The main block must be compatible with the colorizing type (receiving a column
+    # value in case of a table column colorizer or the row index and row value in case
+    # of a table row colorizer).
+    #
+    # === Example
+    #
+    #   # assuming that the table has :max and :current aliases
+    #   colorizer = DataEvalColorizer::new { |index, data| data[:current] / data[:max] }
+    #   # the result of the expression above will be passed to this block
+    #   colorizer.use(:red) { |value| value >= 0.9 }
+    #
+    #   table.using_row.colorize :current, :using => colorizer
+    #
+    class EvalColorizer
+      include Yummi::Colorizer
+
+      def initialize (&block)
+        @block = block
+        @colors = []
+        @eval_blocks = []
+      end
+
+      #
+      # Uses the given color if the given block returns something when evaluated with the
+      # result of main block.
+      #
+      # An objtect that responds to :call may also be used.
+      #
+      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)
+        @block.call *args
+      end
+
+      def call (*args)
+        value = resolve_value *args
+        @eval_blocks.each_index do |i|
+          return @colors[i] if @eval_blocks[i].call(value)
+        end
+        nil
+      end
+
+    end
+
+    #
+    # A colorizer that evaluates a main block and returns a color based on other blocks.
+    #
+    # The main block can receive any parameters and the names must be aliases the current
+    # evaluated data.
+    #
+    # === Example
+    #
+    #   # assuming that the table has :max and :current aliases
+    #   colorizer = DataEvalColorizer::new { |max, current| current / max }
+    #   # the result of the expression above will be passed to this block
+    #   colorizer.use(:red) { |value| value >= 0.9 }
+    #
+    #   table.using_row.colorize :current, :using => colorizer
+    #
+    class DataEvalColorizer < EvalColorizer
+      include Yummi::BlockHandler, Yummi::Colorizer
+
+      def resolve_value (*args)
+        block_call args.first, &@block # by convention, the first arg is data
+      end
+
+    end
+
+  end
+
+end

data/lib/yummi/mappings/jboss5.yaml

@@ -0,0 +1,8 @@
+prefix: '\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2},\d{3}\s'
+patterns:
+  TRACE : cyan
+  DEBUG : blue
+  INFO  : gray
+  WARN  : yellow
+  ERROR : red
+  FATAL : intense_red

data/lib/yummi/mappings/jboss7.yaml

@@ -0,0 +1,8 @@
+prefix: '\d{2}:\d{2}:\d{2},\d{3}\s'
+patterns:
+  TRACE : cyan
+  DEBUG : blue
+  INFO  : gray
+  WARN  : yellow
+  ERROR : red
+  FATAL : intense_red

data/lib/yummi/mappings/weblogic11g.yaml

@@ -0,0 +1,12 @@
+prefix: '####<[^>]+>\s<'
+suffix: '>'
+patterns:
+  Trace     : purple
+  Debug     : blue
+  Info      : gray
+  Notice    : cyan
+  Warning   : yellow
+  Error     : red
+  Critical  : intense_red
+  Alert     : highlight_red
+  Emergency : blink_red

data/lib/yummi/version.rb

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

data/lib/yummi.rb

@@ -31,7 +31,7 @@ module Yummi
       # 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],
+        :colors => [:black, :red, :green, :yellow, :blue, :purple, :cyan, :gray],
         :default => :gray
       }
       # Intense Linux Terminal Colors, used by default in intense and strong color types
@@ -137,7 +137,7 @@ module Yummi
       block.parameters.each do |parameter|
         args << context[parameter[1]]
       end
-      block.call *args
+      block.call(*args)
     end
 
     module_function :block_call
@@ -202,172 +202,6 @@ module Yummi
 
   end
 
-  #
-  # 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)
-      Yummi.colorize args.first.to_s, color_for(args)
-    end
-
-    #
-    # Returns the color for the given value
-    #
-    # === 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 color_for (*args)
-      call *args
-    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.extend Colorizer
-    end
-
-    # Returns a new instance of #DataEvalColorizer
-    def self.by_data_eval &block
-      DataEvalColorizer::new &block
-    end
-
-    # Returns a new instance of #EvalColorizer
-    def self.by_eval &block
-      EvalColorizer::new &block
-    end
-
-    # Returns a new instance of #StripeColorizer
-    def self.stripe *colors
-      StripeColorizer::new *colors
-    end
-
-    # 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)
-        @colors = colors
-        @count = -1
-      end
-
-      def call *args
-        @count += 1
-        @colors[@count % @colors.size]
-      end
-
-    end
-
-    #
-    # A colorizer that evaluates a main block and returns a color based on other blocks.
-    #
-    # The main block must be compatible with the colorizing type (receiving a column
-    # value in case of a table column colorizer or the row index and row value in case
-    # of a table row colorizer).
-    #
-    # === Example
-    #
-    #   # assuming that the table has :max and :current aliases
-    #   colorizer = DataEvalColorizer::new { |index, data| data[:current] / data[:max] }
-    #   # the result of the expression above will be passed to this block
-    #   colorizer.use(:red) { |value| value >= 0.9 }
-    #
-    #   table.using_row.colorize :current, :using => colorizer
-    #
-    class EvalColorizer
-      include Yummi::Colorizer
-
-      def initialize (&block)
-        @block = block
-        @colors = []
-        @eval_blocks = []
-      end
-
-      #
-      # Uses the given color if the given block returns something when evaluated with the
-      # result of main block.
-      #
-      # An objtect that responds to :call may also be used.
-      #
-      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)
-        @block.call *args
-      end
-
-      def call (*args)
-        value = resolve_value *args
-        @eval_blocks.each_index do |i|
-          return @colors[i] if @eval_blocks[i].call(value)
-        end
-        nil
-      end
-
-    end
-
-    #
-    # A colorizer that evaluates a main block and returns a color based on other blocks.
-    #
-    # The main block can receive any parameters and the names must be aliases the current
-    # evaluated data.
-    #
-    # === Example
-    #
-    #   # assuming that the table has :max and :current aliases
-    #   colorizer = DataEvalColorizer::new { |max, current| current / max }
-    #   # the result of the expression above will be passed to this block
-    #   colorizer.use(:red) { |value| value >= 0.9 }
-    #
-    #   table.using_row.colorize :current, :using => colorizer
-    #
-    class DataEvalColorizer < EvalColorizer
-      include Yummi::BlockHandler, Yummi::Colorizer
-
-      def resolve_value (*args)
-        block_call args.first, &@block # by convention, the first arg is data
-      end
-
-    end
-
-  end
-
   # A module used to create an alias method in a formatter block
   module FormatterBlock
 
@@ -503,6 +337,7 @@ end
 
 require_relative 'yummi/no_colors' if RUBY_PLATFORM['mingw'] #Windows
 
+require_relative "yummi/colorizers"
 require_relative 'yummi/color_mapping'
 require_relative 'yummi/table'
 require_relative 'yummi/text_box'