my_stuff-logger 0.0.1

data/COPYING

@@ -0,0 +1,13 @@
+Copyright (c) 2011-present, Fred Emmott <copyright@fredemmott.co.uk>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/lib/my_stuff/logger/levels.rb

@@ -0,0 +1,14 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+module MyStuff
+  module Logger
+    LEVELS = {
+      :debug   => 0,
+      :info    => 1,
+      :warn    => 2,
+      :error   => 3,
+      :fatal   => 4,
+      :disable => 0xffffff
+    }
+  end
+end

data/lib/my_stuff/logger/reader.rb

@@ -0,0 +1,46 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+require 'my_stuff/logger/levels'
+require 'my_stuff/logger/reader_filters'
+
+module MyStuff::Logger
+  class Reader
+    attr_accessor :filters
+    attr_reader :output
+    def colorize?; @colorize; end
+
+    def initialize options = {}
+      @output = options[:device] || STDOUT
+      if options.include? :colorize
+        @colorize = options[:colorize]
+      else
+        @colorize = @output.tty?
+      end
+
+      @filters = (options[:filters] || [
+        :PriorityColors,
+      ]).map{ |filter| ReaderFilters.get(filter) }
+    end
+
+    # Read lines from IO, and pretty-print them.
+    def format_io input
+      input.each_line do |line|
+        output.write format_log_line(line)
+      end
+    end
+
+    def format_log_line x
+      filters.each do |filter|
+        x.replace(filter.call(x, :colorize => colorize?))
+      end
+      x
+    end
+
+    # Do a *really* poor job of emulating an IO device :p
+    def write x
+      x.each_line do |line|
+        output.write format_log_line(line)
+      end
+    end
+  end
+end

data/lib/my_stuff/logger/reader_filter.rb

@@ -0,0 +1,13 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+module MyStuff::Logger
+  class ReaderFilter
+    def filter_line line, options = {}
+      raise NotImplementedError.new
+    end
+
+    def self.to_proc
+      lambda { |*args| self.new.filter_line *args }
+    end
+  end
+end

data/lib/my_stuff/logger/reader_filters/multidb_unmangle.rb

@@ -0,0 +1,30 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+require 'my_stuff/multidb'
+
+module MyStuff::Logger::ReaderFilters
+  # For use with MyStuff::MultiDB.
+  #
+  # Your backtrace will include something like:
+  #  Foo::MYSTUFF_MULTIDB_DB_load_of_hex::Bar
+  # And give you:
+  #  Foo::<host:port/database>::Bar
+  class MultiDBUnmangle < MyStuff::Logger::ReaderFilter
+    def filter_line line, options = {}
+      line.gsub(/MYSTUFF_MULTIDB_DB_[a-z0-9]+/) do |mangled|
+        data = MyStuff::MultiDB.unmangle(mangled)
+        unmangled = "<%s:%d/%s>" % [
+          data[:host],
+          data[:port],
+          data[:database],
+        ]
+        if options[:colorize]
+          # Make it cyan
+          "\e[36m%s\e[0m" % unmangled
+        else
+          unmangled
+        end
+      end
+    end
+  end
+end

data/lib/my_stuff/logger/reader_filters/priority_colors.rb

@@ -0,0 +1,31 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+module MyStuff::Logger::ReaderFilters
+  # Highlight info/warning/error/fatal in different colors.
+  class PriorityColors < MyStuff::Logger::ReaderFilter
+    def filter_line line, options = {}
+     return line unless options[:colorize]
+
+      line = line.dup
+
+      # Colorize, based on priority
+      line.sub! /^([IWEF]) ([0-9]+ \[[^>]+>)/ do |prefix|
+        # Set the color
+        colors = {
+                         # debug  => meh
+          'I' => '32',   # info   => green
+          'W' => '33',   # warn   => yellow
+          'E' => '31',   # errror => red
+          'F' => '1;31', # fatal  => bold + red
+        }
+        # Reset it once the standard info is done
+        prefix.sub! /^[IWEF]/ do |pri|
+          "\e[%sm%s" % [colors[pri], pri]
+        end
+        prefix.sub! '>', ">\e[0m"
+        prefix
+      end
+      line
+    end
+  end
+end

data/lib/my_stuff/logger/reader_filters/tail_follow_highlight.rb

@@ -0,0 +1,14 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+module MyStuff::Logger::ReaderFilters
+  # If you actually pipe tail -F through this...
+  class TailFollowHighlight < MyStuff::Logger::ReaderFilter
+    def filter_line line, options = {}
+      if options[:colorize]
+        line.sub(/^(tail: .+ new file$)/, "\e[1m\\1\e[0m")
+      else
+        line
+      end
+    end
+  end
+end

data/lib/my_stuff/logger/reader_filters.rb

@@ -0,0 +1,26 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+require 'my_stuff/logger/reader_filter'
+
+module MyStuff::Logger
+  module ReaderFilters
+    SYMBOL_MAP =  {
+      :PriorityColors      => 'priority_colors',
+      :TailFollowHighlight => 'tail_follow_highlight',
+      :MultiDBUnmangle     => 'multidb_unmangle',
+    }
+
+    SYMBOL_MAP.each do |sym, file|
+      autoload sym, "my_stuff/logger/reader_filters/#{file}"
+    end
+
+    def self.get filter
+      case filter
+      when Symbol
+        self.get MyStuff::Logger::ReaderFilters.const_get(filter)
+      when Class
+        filter.to_proc
+      end
+    end
+  end
+end

data/lib/my_stuff/logger/writer.rb

@@ -0,0 +1,85 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+require 'my_stuff/logger/levels'
+
+module MyStuff
+  module Logger
+    class Writer
+      # Configure the logger.
+      #
+      # These can be set:
+      # - globally, via Writer.option = foo
+      # - per-class, via Writer.new(:option => foo)
+      # - per class, via Writer.new.option = foo
+      OVERRIDABLE_OPTIONS = [
+        :backtrace_level,
+        :device,
+        :level,
+        :root_path,
+      ]
+      attr_writer *OVERRIDABLE_OPTIONS
+
+      def initialize options = {}
+        OVERRIDABLE_OPTIONS.each do |opt|
+          if options.include? opt
+            instance_variable_set "@#{opt}", options[opt]
+          end
+        end
+      end
+
+      def raw_log outer_caller, level, args
+
+        unless LEVELS.include? level
+          raw_log outer_caller, :fatal, "%s (unknown level '%s')" % [log_text(*args), level.inspect]
+        end
+
+        return if LEVELS[level] < LEVELS[self.level]
+
+        message  = "%s %s @%s> %s\n" % [
+          level.to_s[0].upcase, # D|I|W|E|F
+          Time.new.strftime("%s [%Y-%m-%d %H:%M:%S %z]"),
+          pretty_caller(outer_caller.first),
+          log_text(*args)
+        ]
+
+        if LEVELS[level] >= LEVELS[self.backtrace_level]
+          # Full backtrace
+          outer_caller.each do |x|
+            message += "  from %s\n" % pretty_caller(x)
+          end
+        end
+
+        device.write message
+      end
+
+      LEVELS.each do |level,i|
+        define_method level do |*args|
+          raw_log caller, level, args
+        end
+      end
+
+      OVERRIDABLE_OPTIONS.each do |opt|
+        define_method opt do
+          instance_variable_get("@#{opt}") || MyStuff::Logger.send(opt)
+        end
+      end
+
+      private
+
+      def log_text *args
+        args.map do |arg|
+          case arg
+          when String
+            arg
+          else
+            arg.inspect
+          end
+        end.join('')
+      end
+
+      def pretty_caller x
+        x.sub(root_path + '/', '').sub(/^.\//, '')
+      end
+    end
+  end
+end

data/lib/my_stuff/logger.rb

@@ -0,0 +1,31 @@
+# Copyright 2011-present Fred Emmott. See COPYING file.
+
+require 'my_stuff/logger/writer'
+
+module MyStuff
+  module Logger
+    class <<self
+      def new *args
+        MyStuff::Logger::Writer.new *args
+      end
+
+      attr_writer :device, :level, :backtrace_level, :root_path
+
+      def device
+        @device ||= STDOUT
+      end
+
+      def level
+        @level ||= :info
+      end
+
+      def backtrace_level
+        @backtrace_level ||= :error
+      end
+
+      def root_path
+        @root_path ||= File.dirname(File.expand_path($0))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: my_stuff-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fred Emmott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-30 00:00:00.000000000Z
+dependencies: []
+description: ''
+email:
+- mail@fredemmott.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING
+- lib/my_stuff/logger/levels.rb
+- lib/my_stuff/logger/reader.rb
+- lib/my_stuff/logger/reader_filter.rb
+- lib/my_stuff/logger/reader_filters/multidb_unmangle.rb
+- lib/my_stuff/logger/reader_filters/priority_colors.rb
+- lib/my_stuff/logger/reader_filters/tail_follow_highlight.rb
+- lib/my_stuff/logger/reader_filters.rb
+- lib/my_stuff/logger/writer.rb
+- lib/my_stuff/logger.rb
+homepage: https://github.com/fredemmott/my_stuff-logger
+licenses:
+- ISC
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Logging class
+test_files: []