yummi 0.6.1 → 0.7.0

data/README.md

@@ -35,8 +35,9 @@ Examples:
 
 Line patterns are configured with an yaml file containing:
 
-  * prefix (optional): prefix for pattern
-  * suffix (optional): suffix for pattern
+  * prefix  (optional): prefix for pattern
+  * suffix  (optional): suffix for pattern
+  * options (optional): option flags to use
   * patterns: a pattern => color map
 
 Example:
@@ -50,13 +51,13 @@ Example:
       ERROR : red
       FATAL : intense_red
 
-Yummi provides a set of mappings that you, check yummi/mappings dir.
+Yummi provides a set of patterns, check yummi/patterns dir.
 
-Mappings provided by yummi can be passed with the file name, example:
 
-    tail -f $JBOSS_HOME/standalone/log/server.log | yummi -p jboss7
+    tail -f $JBOSS_HOME/standalone/log/server.log | yummi -p jboss
 
-Mappings in ~/.yummi dir may also used only with the file name.
+Patterns in ~/.yummi/patterns and provided by yummi may also be used by passing
+only the file name without extension
 
 ## Contributing
 

data/bin/yummi

@@ -31,8 +31,11 @@ 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
+opt.on '-p PATTERNS', '--pattern=PATTERNS', Array, 'Sets a pattern to colorize each line' do |patterns|
+  @colorizer = Yummi::Colorizers.pattern(patterns)
+end
+opt.on '--log', 'Uses the default log pattern to colorize each line' do 
+  @colorizer = Yummi::Colorizers.pattern :log
 end
 opt.on '-m message', '--message=MESSAGE', 'Colorize the given message' do |message|
   @message = message
@@ -46,7 +49,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, 'Include the files for extending components' do |files|
+opt.on '-l FILES', '--load=FILES', Array, 'Include the files for extending components' do |files|
   files.each do |file|
     load File.expand_path(file)
   end
@@ -77,12 +80,9 @@ elsif @table_builder
   abort "Please give the data to print" unless @data
   table = @table_builder.build_table
   extension = File::extname(@data)[1..-1]
-  table.data = case (@data_type or extension)
-  when "yaml"
-    YAML::load_file(@data)
-  when "csv"
-    require 'csv'
-    CSV::parse(File.read(@data), :converters => :all)
+  type = (@data_type or extension).to_sym
+  if Yummi::DataParser.respond_to? type
+    table.data = Yummi::DataParser.send(type, File.read(@data))
   else
     abort "Unsupported extension #{extension}"
   end
@@ -93,6 +93,6 @@ else
       print_out line.chomp
     end
   rescue Interrupt
-    #Do nothing
+    puts Yummi::colorize("Aborted!", :red)
   end
 end

data/examples/logcat_colorizer.rb

@@ -22,22 +22,10 @@
 
 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
+[DEBUG] Connecting to server
 [ERROR] Error while connecting
 caused by: ConnectionException
             at Connection.connect
@@ -48,8 +36,16 @@ caused by: ConnectionException
 [DEBUG] Shutdown command executed
 LOG
 
-colorizer = Yummi::Colorizers.line(params)
+colorizer = Yummi::Colorizers.pattern :prefix => /\[/,
+  :suffix => /\]/,
+  :patterns => {
+    'ERROR' => :red,
+    'FATAL' => :intense_red,
+    'WARN'  => :yellow,
+    'INFO'  => :green,
+    'DEBUG' => :gray
+  }
 
 log.each_line do |line|
   puts colorizer.colorize(line.chomp)
-end
+end

data/lib/yummi/colorizers.rb

@@ -84,9 +84,9 @@ module Yummi
       StripeColorizer::new(*colors)
     end
 
-    # Returns a new instance of #LineColorizer
-    def self.line mappings
-      LineColorizer::new mappings
+    # Returns a new instance of #PatternColorizer
+    def self.pattern mappings
+      PatternColorizer::new mappings
     end
 
     #
@@ -213,14 +213,19 @@ module Yummi
     end
 
     #
-    # A colorizer for lines that follows a pattern. This colorizer is usefull
+    # A colorizer for strings that follows a pattern. This colorizer is usefull
     # for log files.
     #
-    class LineColorizer
+    class PatternColorizer
       include Yummi::Colorizer
 
+      def initialize mappings = nil
+        @patterns = []
+        map mappings if mappings
+      end
+
       #
-      # Creates a new instance using the parameters.
+      # Maps a set of patterns to colors.
       #
       # === Args
       #
@@ -228,49 +233,88 @@ module Yummi
       #
       #   * prefix: a pattern prefix
       #   * suffix: a pattern suffix
+      #   * options: option flags to use
+      #   * mode: the mode to use:
+      #       - all  : colorize the entire text
+      #       - grep : colorize only the matched text
       #   * 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:
+      # If a string is passed instead of a hash, 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
+      #   * $HOME/.yummi/patterns/PATTERN.yaml
+      #   * $YUMMI_GEM/yummy/patterns/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
+      def map params
+        if params.is_a? Array
+          params.each { |p| map p }
+        elsif params.is_a? String or params.is_a? Symbol
+          map Yummi::Helpers::load_resource params, :from => :patterns
+        else
+          config params
+        end
+      end
+
+      def call ctx
+        ctx = Yummi::Context::new(ctx) unless ctx.is_a? Context
+        text = ctx.value.to_s
+        @patterns.each do |config|
+          config[:patterns].each do |regex, color|
+            if regex.match(text)
+              return match(text, config)
             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]
+        return text.colorize(@last_color) if @last_color
+        text
+      end
+
+      alias :colorize :call
+
+      private 
+
+      def config params
+        Yummi::Helpers.symbolize_keys(params)
+        prefix  = params[:prefix]
+        suffix  = params[:suffix]
+        options = params[:options]
+        mode    = (params[:mode] or :all)
+
+        patterns = Hash[*(params[:patterns].collect do |pattern, color|
+          [
+            Regexp::new("#{prefix}#{pattern.to_s}#{suffix}",options),
+            color
+          ]
         end).flatten]
 
-        @last_color = nil
+        @patterns << {
+          :mode => mode,
+          :patterns => patterns
+        }
       end
 
-      def call ctx
-        line = ctx.value.to_s
-        @patterns.each do |regex, color|
-          if regex.match(line)
+      def match(text, config)
+        send "colorize_#{config[:mode]}", text, config
+      end
+
+      def colorize_all(text, match)
+        match[:patterns].each do |regex, color|
+          if regex.match(text)
             @last_color = color
-            return color
+            return text.colorize(color)
           end
         end
-        @last_color
+        text
+      end
+
+      def colorize_grep(text, match)
+        return text unless match
+        @last_color = nil
+        match[:patterns].each do |regex, color|
+          text = text.colorize regex => color
+        end
+        text
       end
 
     end

data/lib/yummi/data_parser.rb

@@ -0,0 +1,37 @@
+#                         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.
+
+module Yummi
+
+  module DataParser
+
+    def self.yaml(input)
+      YAML::load(input)
+    end
+
+    def self.csv(input)
+      require 'csv' #autoload will be dead, using require instead
+      CSV::parse(input, :converters => :all)
+    end
+
+  end
+end

data/lib/yummi/extensions.rb

@@ -0,0 +1,40 @@
+#                         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.
+
+class String
+
+  def uncolorize
+    Yummi::uncolorize self
+  end
+
+  def colorize params
+    if params.is_a? Hash
+      text = self
+      params.each do |regexp, color|
+        text = text.gsub(regexp, "\\0".colorize(color))
+      end
+      return text
+    end
+    Yummi::colorize self, params
+  end
+
+end

data/lib/yummi/logger.rb

@@ -46,9 +46,9 @@ module Yummi
       #
       # Creates a new formatter with the colors (assuming Linux default terminal colors):
       #
-      # * +DEBUG+: no color
-      # * +INFO+: green
-      # * +WARN+: brown
+      # * +DEBUG+: blue
+      # * +INFO+: white
+      # * +WARN+: yellow
       # * +ERROR+: red
       # * +FATAL+: red (intense)
       # * +ANY+: gray (intense)
@@ -58,8 +58,8 @@ module Yummi
       #
       def initialize &block
         @colors = {
-          :debug => nil,
-          :info => :green,
+          :debug => :blue,
+          :info => :white,
           :warn => :yellow,
           :error => :red,
           :fatal => :intense_red,

data/lib/yummi/{mappings/jboss5.yaml → patterns/jboss.yaml}

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

data/lib/yummi/patterns/log.yaml

@@ -0,0 +1,9 @@
+prefix: '.*'
+options: i
+patterns:
+  TRACE  : cyan
+  DEBUG  : blue
+  INFO   : white
+  WARN   : yellow
+  ERROR  : red
+  FATAL  : intense_red

data/lib/yummi/{mappings/weblogic11g.yaml → patterns/weblogic.yaml}

@@ -3,10 +3,10 @@ suffix: '>'
 patterns:
   Trace     : purple
   Debug     : blue
-  Info      : gray
+  Info      : white
   Notice    : cyan
   Warning   : yellow
   Error     : red
   Critical  : intense_red
-  Alert     : intense_underline_red
-  Emergency : highlight_red
+  Alert     : intense_red
+  Emergency : intense_red

data/lib/yummi/table.rb

@@ -41,7 +41,7 @@ module Yummi
     # * Values: using :value key
     #
     # The colors must be supported by #Yummi#Color#parse or defined in #Yummi#Color#COLORS
-    attr_accessor :colors
+    attr_accessor :style
     # The table layout (horizontal or vertical)
     attr_reader :layout
     # The table header
@@ -59,7 +59,7 @@ module Yummi
       @header = []
       @title = nil
       @description = nil
-      @colors = {
+      @style = {
         :title => :intense_yellow,
         :description => :intense_gray,
         :header => :intense_blue,
@@ -80,7 +80,7 @@ module Yummi
 
     # Indicates that the table should not use colors.
     def no_colors
-      @colors = {
+      @style = {
         :title => nil,
         :header => nil,
         :value => nil
@@ -355,8 +355,8 @@ module Yummi
       data_output = build_data_output
 
       string = ""
-      string << Color.colorize(@title, @colors[:title]) << $/ if @title
-      string << Color.colorize(@description, @colors[:description]) << $/ if @description
+      string << Color.colorize(@title, @style[:title]) << $/ if @title
+      string << Color.colorize(@description, @style[:description]) << $/ if @description
       table_data = header_output + data_output
       if @layout == :vertical
         # don't use array transpose because the data may differ in each line size
@@ -430,7 +430,7 @@ module Yummi
       @header.each do |line|
         _data = []
         line.each do |h|
-          _data << {:value => h, :color => @colors[:header]}
+          _data << {:value => h, :color => @style[:header]}
         end
         output << _data
       end
@@ -485,7 +485,7 @@ module Yummi
           elsif colorizer
             color = colorizer.call(column)
           else
-            color = @colors[:value]
+            color = @style[:value]
           end
           formatter = component[:formatters][col_index]
           formatter = component[:null_formatter] if column.nil? and @null_formatter

data/lib/yummi/text_box.rb

@@ -151,7 +151,7 @@ module Yummi
       width = 0
       sizes = [] # the real size of each line
       content.each do |line|
-        size = (Yummi::Color::raw line.chomp).size
+        size = line.chomp.uncolorize.size
         sizes << size
         width = [width, size].max
       end

data/lib/yummi/version.rb

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

data/lib/yummi.rb

@@ -30,8 +30,8 @@ module Yummi
     module Schema
       # Normal Linux Terminal Colors, used by default in normal color types
       NORMAL_COLORS = {
-        :colors => [:black, :red, :green, :yellow, :blue, :purple, :cyan, [:gray, :white]],
-        :default => :gray
+        :colors => [:black, :red, :green, [:yellow, :orange], :blue, :purple, :cyan, [:gray, :white]],
+        :default => :white
       }
       # Intense Linux Terminal Colors, used by default in bold color types
       ALTERNATE_COLORS = {
@@ -97,21 +97,17 @@ module Yummi
 
     # Escape the given text with the given color code
     def self.escape key
-      return key unless key and COLORS[key.to_s.to_sym]
-      "\e[#{COLORS[key.to_s.to_sym]}m"
+      return key unless key and COLORS[key.to_sym]
+      "\e[#{COLORS[key.to_sym]}m"
     end
 
     # Colorize the given text with the given color
     def self.colorize string, color
+      return string if color.to_s == 'none'
       color, end_color = [color, "\e[0;0m"].map { |key| Color.escape(key) }
       color ? "#{color}#{string}#{end_color}" : string
     end
 
-    # Extracts the text from a colorized string
-    def self.raw string
-      string.gsub(/\e\[\d;\d{2}m/, '').gsub(/\e\[0;0m/, '')
-    end
-
   end
 
   # 
@@ -136,6 +132,13 @@ module Yummi
     end
   end
 
+  #
+  # Extracts the text from a colorized string
+  #
+  def self.uncolorize string
+    string.gsub(/\e\[\d;\d{2}m/, '').gsub(/\e\[0;0m/, '')
+  end
+
   # A module to align texts based on a reference width
   module Aligner
 
@@ -301,6 +304,23 @@ module Yummi
 
   module Helpers
 
+    def self.load_resource name, params = {:from => ''}
+      file = File.expand_path name.to_s
+      if File.exist? file
+        return YAML::load_file(file)
+      else
+        from = params[:from].to_s
+        [
+          File.join(File.expand_path('~/.yummi'), from),
+          File.join(File.dirname(__FILE__), 'yummi', from)
+        ].each do |path|
+          file = File.join(path, "#{name}.yaml")
+          return YAML::load_file(file) if File.exist?(file)
+        end
+      end
+      raise Exception::new("Unable to load #{name}")
+    end
+
     def self.symbolize_keys hash
       hash.replace(hash.inject({}) do |h, (k, v)|
         v = symbolize_keys(v) if v.is_a? Hash
@@ -322,6 +342,8 @@ end
 
 require_relative 'yummi/no_colors' if RUBY_PLATFORM['mingw'] #Windows
 
+require_relative 'yummi/extensions'
+require_relative 'yummi/data_parser'
 require_relative "yummi/colorizers"
 require_relative "yummi/formatters"
 require_relative 'yummi/color_mapping'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummi
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
+date: 2012-12-01 00:00:00.000000000 Z
 dependencies: []
 description: A tool to colorize your console application.
 email:
@@ -39,12 +39,14 @@ files:
 - lib/yummi.rb
 - lib/yummi/color_mapping.rb
 - lib/yummi/colorizers.rb
+- lib/yummi/data_parser.rb
+- lib/yummi/extensions.rb
 - lib/yummi/formatters.rb
 - lib/yummi/logger.rb
-- lib/yummi/mappings/jboss5.yaml
-- lib/yummi/mappings/jboss7.yaml
-- lib/yummi/mappings/weblogic11g.yaml
 - lib/yummi/no_colors.rb
+- lib/yummi/patterns/jboss.yaml
+- lib/yummi/patterns/log.yaml
+- lib/yummi/patterns/weblogic.yaml
 - lib/yummi/table.rb
 - lib/yummi/table_builder.rb
 - lib/yummi/text_box.rb

data/lib/yummi/mappings/jboss7.yaml

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