EasyLogger 0.1.1

data/lib/EasyLogger_version.rb

@@ -0,0 +1,3 @@
+module EasyLogger
+  VERSION = '0.1.1'
+end

data/lib/easy_logger.rb

@@ -0,0 +1 @@
+require 'easy_logger/easy_logger'

data/lib/easy_logger/easy_logger.rb

@@ -0,0 +1,116 @@
+require 'file/tail'
+# @author Sylvain Desbureaux
+module EasyLogger
+  # = Class EasyLogger which will do all the job of matching the lines and showing it
+  # @author Sylvain Desbureaux
+  # 
+  # == Attributes
+  # @attr_reader [String]     log    the log file/stream that we'll look into
+  # @attr_reader [Array]   classes   the classes to match in the log
+  # @attr_reader [Array]   methods   the methods to match in the log
+  # @attr_reader [Boolean] verbose   the verbosity of the output
+  # @attr_reader [String]  separator the separator of the values in the log. it's "|" per default
+  # 
+  # == Use
+  # There's two methods to use the class: file() and tail().
+  # Both of them use the same parameters (the attributes of the class).
+  # The log file need to be correctly formatted. the parser assumes that the log file has this format (with '|' as separator in the example):
+  #     |some tag (example: the date and time)|some tag|...|class|method| free text
+  # The Separator could be at the end of the free text but never in the middle so choose it carefully!
+  # @see Logging a working logger example
+  # 
+  # === File
+  # File will open the stream, parse and output the matching line and exit
+  #
+  # === Tail
+  # Tail will open the end of the stream and parse and output the matching line and exit
+  
+  class EasyLogger
+    
+    # Display the relevant line of the log matching the classes/methods
+    #
+    # @param [String]  log       the log file/stream that we'll look into
+    # @param [String]   classes   the classes to match in the log
+    # @param [String]   methods   the methods to match in the log
+    # @param [Boolean] verbose   the verbosity of the output
+    # @param [String]  separator the separator of the values in the log. it's "|" per default
+    def file(log, classes, methods, verbose, separator='|')
+      result = String.new
+      puts "Looking in #{log} I/O for line matching #{classes} classe(s) and #{methods} method(s) with separator '#{separator}'" if verbose && !classes.nil? && !methods.nil?
+      puts "Looking in #{log} I/O for line #{methods} method(s) with separator '#{separator}'" if verbose && classes.nil? && !methods.nil?
+      puts "Looking in #{log} I/O for line matching #{classes} classe(s) with separator '#{separator}'" if verbose && !classes.nil? && methods.nil?
+      puts "Looking in #{log} I/O for all lines" if verbose && classes.nil? && methods.nil?
+      classes =classes.split(',') unless classes.nil?
+      methods =methods.split(',') unless methods.nil?
+      classes.map!{|c| c.downcase} unless classes.nil?
+      methods.map!{|m| m.downcase} unless methods.nil?
+      line_number = 0
+      line_match = 0
+      IO.foreach(log) do |line| 
+        line_number += 1
+        if match(line,classes,methods, separator)
+          puts line 
+          line_match += 1
+        end
+        
+      end
+      puts "#{line_match} lines matched on the #{line_number} lines in the log" if verbose
+    end
+    
+    # Display the relevant <u>new</u> lines of the log matching the classes/methods
+    #
+    # @param (see EasyLogger#file)
+    def tail(log, classes, methods, verbose, separator='|')
+      result = String.new
+      puts "Tailing in #{log} I/O for line matching #{classes} classe(s) and #{methods} method(s) with separator '#{separator}'" if verbose && !classes.nil? && !methods.nil?
+      puts "Tailing in #{log} I/O for line #{methods} method(s) with separator '#{separator}'" if verbose && classes.nil? && !methods.nil?
+      puts "Tailing in #{log} I/O for line matching #{classes} classe(s) with separator '#{separator}'" if verbose && !classes.nil? && methods.nil?
+      puts "Tailing in #{log} I/O for all lines" if verbose && classes.nil? && methods.nil?
+      classes =classes.split(',') unless classes.nil?
+      methods =methods.split(',') unless methods.nil?
+      classes.map!{|c| c.downcase} unless classes.nil?
+      methods.map!{|m| m.downcase} unless methods.nil?
+      @line_number = 0
+      @line_match = 0
+      #      interrupted = false
+      trap("INT") do
+        puts "#{@line_match} lines matched on the #{@line_number} lines in the log" if verbose 
+        break
+      end
+      begin
+        File::Tail::Logfile.tail(log) do |line|
+          @line_number += 1
+          if match(line,classes,methods, separator)
+            puts line 
+            @line_match += 1
+          end
+          #        if interrupted
+          #          break
+          #        end
+        end
+      rescue
+        nil
+      end
+    end
+    
+    # Verify if a line match the classes/method
+    #
+    # @private
+    # @param [String] line the line to match the regexp
+    # @param classes (see EasyLogger#file)
+    # @param methods (see EasyLogger#file)
+    # @param separator (see EasyLogger#file)
+    # @return [Boolean] True if the line is matched, false if not 
+    @private 
+    def match(line,classes,methods,separator)
+      unless line[0..-2].split(separator).length < 3
+        methode = line[0..-2].split(separator)[-2].strip.downcase
+        classe = line[0..-2].split(separator)[-3].strip.downcase
+      
+        (classes.nil? || classes.include?(classe)) && (methods.nil? || methods.include?(methode))
+      else
+        false
+      end
+    end
+  end
+end

data/lib/easy_logger/logging_example.rb

@@ -0,0 +1,46 @@
+require 'logger'
+# @author Sylvain Desbureaux
+# Most of work grabbed from nuby on rails Hodel 3000 logger 
+# http://nubyonrails.com/articles/a-hodel-3000-compliant-logger-for-the-rest-of-us.
+# 
+# I've added the way to retrieve the method which sent the log and the class via caller method.
+# 
+# I've also taken care to take the next one in caller if the methode is lik each, block,...
+# 
+# In your environmment file(s) (development.rb, test.rb,...) you'll need to add that in order to use this logger:
+# @example
+#   require File.dirname(__FILE__) + "/../../app/models/logging"
+#   config.logger = Logging.new(config.paths.log.first )
+# 
+# And you'll need to put this file (renammed logging.rb here) in app/models folder
+class Logging < Logger
+  def format_message(severity, timestamp, progname, msg)
+    i = 2
+    methode = caller[i].split('`')[1].split("'")[0]
+    each_true = false
+    puts methode if methode == "each"
+    each_true = true if methode == ""
+    while methode == "debug" || methode == "info" || methode == "error" || methode.split(' ')[0] == "each"
+      i += 1
+      methode = caller[i].split('`')[1].split("'")[0]
+      puts methode if each_true
+    end
+    methode = methode.split(' ')[0] == "block" ? methode.split(' ')[-1].center(17) : methode.center(17)
+    objecte = caller[i].split(':')[0].split('/')[-1].split('.')[0].camelize.center(16)
+    "#{timestamp.strftime("%d %b %H:%M:%S")}|rails[#{$PID}]|#{severity.center(8)}|#{objecte}|#{methode}| #{msg2str(msg).gsub(/\n/, '').lstrip}\n"
+  end
+  
+
+  def msg2str(msg)
+    case msg
+    when ::String
+      msg
+    when ::Exception
+      "#{ msg.message } (#{ msg.class }): " <<
+      (msg.backtrace || []).join(" | ")
+    else
+      msg.inspect
+    end
+  end
+  
+end

data/spec/EasyLogger/easy_logger_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "spec_helper")
+require 'easy_logger'
+
+describe EasyLogger do
+  before(:each) do
+    @easy_logger = EasyLogger::EasyLogger.new
+  end
+  
+  it "should return true with match function when methodes and classes are nil" do
+    line = "{test{test{pouet{pouet"
+    @easy_logger.match(line,nil,nil,"{").should be_true
+  end
+
+  it "should return true with match function when the line match a class and methodes is nil" do
+    line = "RtestRtestRclasseRpouetRpouet"
+    line2 = "RtestRtestR   classe   RpouetRpouet"
+    @easy_logger.match(line,["classe","autre_classe"],nil,"R").should be_true
+    @easy_logger.match(line2,["classe","autre_classe"],nil,"R").should be_true
+  end
+  
+  it "should return true with match function when the line match a method and classes is nil" do
+    line = "RtestRtestRclasseRMethodeRpouet"
+    line2 = "RtestRtestRclasseR Methode   Rpouet"
+    @easy_logger.match(line,nil,["methode", "autre_methode"],"R").should be_true
+    @easy_logger.match(line2,nil,["methode", "autre_methode"],"R").should be_true
+  end
+  
+  it "should return true with match function when the line match a class and a method" do
+    line = "RtestRtestRclasseRMethodeRpouet"
+    line2 = "RtestRtestR   classe   R Methode   Rpouet"
+    @easy_logger.match(line,["classe","autre_classe"],["methode", "autre_methode"],"R").should be_true
+    @easy_logger.match(line2,["classe","autre_classe"],["methode", "autre_methode"],"R").should be_true
+  end
+  
+  it "should return true with match function when the line match a class and a method with a separator at the end of the line" do
+    line = "RtestRtestRclasseRMethodeRpouetR"
+    line2 = "RtestRtestR   classe   R Methode   RpouetR"
+    @easy_logger.match(line,["classe","autre_classe"],["methode", "autre_methode"],"R").should be_true
+    @easy_logger.match(line2,["classe","autre_classe"],["methode", "autre_methode"],"R").should be_true
+  end
+  
+  it "should return false with match function when the line match a class but not a method" do
+    line = "RtestRtestRclasseRMethodeRpouetR"
+    line2 = "RtestRtestR   classe   R Methode   RpouetR"
+    @easy_logger.match(line,["classe","autre_classe"],["methodes", "autre_methode"],"R").should be_false
+    @easy_logger.match(line2,["classe","autre_classe"],["methodes", "autre_methode"],"R").should be_false
+  end
+  
+  it "should return false with match function when the line match a method but not a class" do
+    line = "RtestRtestRclasseRMethodeRpouetR"
+    line2 = "RtestRtestR   classe   R Methode   RpouetR"
+    @easy_logger.match(line,["classes","autre_classe"],["methode", "autre_methode"],"R").should be_false
+    @easy_logger.match(line2,["classes","autre_classe"],["methode", "autre_methode"],"R").should be_false
+  end
+  
+  it "should return false if the separator is not found in the line" do
+    line ="13456"
+     @easy_logger.match(line,["classes","autre_classe"],["methode", "autre_methode"],"R").should be_false
+  end
+  
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+#require 'cover_me'
+#require File.join(File.expand_path(File.dirname(__FILE__)), "..", "coverage", "cover_me_config")
+require 'rspec'
+
+Rspec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :r
+  config.expect_with :rspec
+  config.mock_with :rspec
+
+  #config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+  #config.use_transactional_fixtures = false
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: EasyLogger
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Sylvain Desbureaux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-16 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: |-
+  EasyLogger permit to filter in lines in logs, allowing to 
+  view only the inputs you want based on Class or Method
+email: 
+- sylvain@desbureaux.fr
+executables: 
+- EasyLogger
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- EasyLogger.rdoc
+files: 
+- .gitignore
+- EasyLogger.gemspec
+- EasyLogger.rdoc
+- Gemfile
+- README.rdoc
+- Rakefile
+- bin/EasyLogger
+- doc/ArubaOverrides.html
+- doc/EasyLogger.html
+- doc/EasyLogger/EasyLogger.html
+- doc/EasyLogger_rdoc.html
+- doc/File.html
+- doc/Gemfile.html
+- doc/README_rdoc.html
+- doc/Rakefile.html
+- doc/_index.html
+- doc/bin/EasyLogger.html
+- doc/class_list.html
+- doc/created.rid
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/features/support/env_rb.html
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/lib/EasyLogger_version_rb.html
+- doc/lib/easy_logger/easy_logger_rb.html
+- doc/lib/easy_logger_rb.html
+- doc/method_list.html
+- doc/rdoc.css
+- doc/top-level-namespace.html
+- features/class_filtering.feature
+- features/class_method_filtering.feature
+- features/command_line.feature
+- features/method_filtering.feature
+- features/step_definitions/command_line_steps.rb
+- features/support/env.rb
+- html/EasyLogger.html
+- html/EasyLogger/EasyLogger.html
+- html/File.html
+- html/Logging.html
+- html/README_rdoc.html
+- html/bin/EasyLogger.html
+- html/created.rid
+- html/index.html
+- html/lib/EasyLogger_version_rb.html
+- html/lib/easy_logger/easy_logger_rb.html
+- html/lib/easy_logger/logging_example_rb.html
+- html/lib/easy_logger_rb.html
+- html/rdoc.css
+- lib/EasyLogger_version.rb
+- lib/easy_logger.rb
+- lib/easy_logger/easy_logger.rb
+- lib/easy_logger/logging_example.rb
+- spec/EasyLogger/easy_logger_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- EasyLogger
+- --main
+- README.rdoc
+- -ri
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: EasyLogger
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: EasyLogger permit to filter in lines in logs
+test_files: []
+