simple-logger 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jakub Šťastný aka Botanicus
+
+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.

data/lib/simple-logger.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require_relative "simple-logger/logger"

data/lib/simple-logger/logger.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require_relative "plain"
+
+module SimpleLogger
+  class Logger < Plain
+    @@colors = {
+      fatal:  :red,
+      error:  :red,
+      warn:   :yellow,
+      info:   :white,
+      debug:  :cyan,
+      custom: :magenta
+    }
+
+    @@color_values = {
+      black:   30,
+      red:     31,
+      green:   32,
+      yellow:  33,
+      blue:    34,
+      magenta: 35,
+      cyan:    36,
+      white:   37
+    }
+    
+    # Generate the logging methods for SimpleLogger.logger for each log level.
+    self::Levels.each_pair do |name, number|
+      color = @@color_values[@@colors[name]]
+      class_eval <<-RUBY, __FILE__, __LINE__
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}(message = nil)
+        self << "\033[0;\#{#{color}}m%s\033[0m" % message
+        self
+      end
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger. The bang! version of the method also auto
+      # flushes the log buffer to disk.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}!(message = nil)
+        self << "\033[0;\#{#{color}}m%s\033[0m" % message
+        flush if #{number} >= level
+        self
+      end
+
+      # ==== Returns
+      # Boolean:: True if this level will be logged by this logger.
+      def #{name}?
+        #{number} >= level
+      end
+      RUBY
+    end
+  end
+end

data/lib/simple-logger/plain.rb

@@ -0,0 +1,200 @@
+# encoding: utf-8
+
+require "time" # httpdate
+
+# ==== Public SimpleLogger Logger API
+#
+# To replace an existing logger with a new one:
+#  SimpleLogger::Plain.set_log(log{String, IO},level{Symbol, String})
+#
+# Available logging levels are
+#   SimpleLogger::Plain::{ Fatal, Error, Warn, Info, Debug }
+#
+# Logging via:
+#   SimpleLogger.logger.fatal(message<String>,&block)
+#   SimpleLogger.logger.error(message<String>,&block)
+#   SimpleLogger.logger.warn(message<String>,&block)
+#   SimpleLogger.logger.info(message<String>,&block)
+#   SimpleLogger.logger.debug(message<String>,&block)
+#
+# Logging with autoflush:
+#   SimpleLogger.logger.fatal!(message<String>,&block)
+#   SimpleLogger.logger.error!(message<String>,&block)
+#   SimpleLogger.logger.warn!(message<String>,&block)
+#   SimpleLogger.logger.info!(message<String>,&block)
+#   SimpleLogger.logger.debug!(message<String>,&block)
+#
+# Flush the buffer to
+#   SimpleLogger.logger.flush
+#
+# Remove the current log object
+#   SimpleLogger.logger.close
+#
+# ==== Private SimpleLogger Logger API
+#
+# To initialize the logger you create a new object, proxies to set_log.
+#   SimpleLogger::Plain.new(log{String, IO},level{Symbol, String})
+module SimpleLogger
+
+  class << self
+    attr_accessor :logger
+  end
+
+  class Plain
+
+    attr_accessor :level
+    attr_accessor :delimiter
+    attr_accessor :auto_flush
+    attr_reader   :buffer
+    attr_reader   :log
+    attr_reader   :init_args
+
+    # ==== Notes
+    # Ruby (standard) logger levels:
+    # :fatal:: An unhandleable error that results in a program crash
+    # :error:: A handleable error condition
+    # :warn:: A warning
+    # :info:: generic (useful) information about system operation
+    # :debug:: low-level information for developers
+    Levels =
+    {
+      :fatal => 7,
+      :error => 6,
+      :warn  => 4,
+      :info  => 3,
+      :debug => 0
+    }
+
+    private
+
+    # Readies a log for writing.
+    #
+    # ==== Parameters
+    # log<IO, String>:: Either an IO object or a name of a logfile.
+    def initialize_log(log)
+      close if @log # be sure that we don't leave open files laying around.
+
+      if log.respond_to?(:write)
+        @log = log
+      elsif File.exist?(log)
+        @log = open(log, (File::WRONLY | File::APPEND))
+        @log.sync = true
+      else
+        FileUtils.mkdir_p(File.dirname(log)) unless File.directory?(File.dirname(log))
+        @log = open(log, (File::WRONLY | File::APPEND | File::CREAT))
+        @log.sync = true
+        @log.write("#{Time.now.httpdate} #{delimiter} info #{delimiter} Logfile created\n")
+      end
+    end
+
+    public
+
+    # To initialize the logger you create a new object, proxies to set_log.
+    #
+    # ==== Parameters
+    # *args:: Arguments to create the log from. See set_logs for specifics.
+    def initialize(*args)
+      @init_args = args
+      set_log(*args)
+    end
+
+    # Replaces an existing logger with a new one.
+    #
+    # ==== Parameters
+    # log<IO, String>:: Either an IO object or a name of a logfile.
+    # log_level<~to_sym>::
+    #   The log level from, e.g. :fatal or :info. Defaults to :error in the
+    #   production environment and :debug otherwise.
+    # delimiter<String>::
+    #   Delimiter to use between message sections. Defaults to " ~ ".
+    # auto_flush<Boolean>::
+    #   Whether the log should automatically flush after new messages are
+    #   added. Defaults to false.
+    def set_log(log, log_level = nil, delimiter = " ~ ", auto_flush = false)
+      if log_level && Levels[log_level.to_sym]
+        @level = Levels[log_level.to_sym]
+      else
+        @level = Levels[:debug]
+      end
+      @buffer     = []
+      @delimiter  = delimiter
+      @auto_flush = auto_flush
+
+      initialize_log(log)
+    end
+
+    # Flush the entire buffer to the log object.
+    def flush
+      return unless @buffer.size > 0
+      @log.write(@buffer.slice!(0..-1).join)
+    end
+
+    # Close and remove the current log object.
+    def close
+      flush
+      @log.close if @log.respond_to?(:close) && !@log.tty?
+      @log = nil
+    end
+
+    # Appends a message to the log. The methods yield to an optional block and
+    # the output of this block will be appended to the message.
+    #
+    # ==== Parameters
+    # string<String>:: The message to be logged. Defaults to nil.
+    #
+    # ==== Returns
+    # String:: The resulting message added to the log file.
+    def <<(string = nil)
+      message = ""
+      message << delimiter
+      message << string if string
+      message << "\n" unless message[-1] == ?\n
+      @buffer << message
+      flush if @auto_flush
+
+      message
+    end
+    alias :push :<<
+
+    # Generate the logging methods for SimpleLogger.logger for each log level.
+    Levels.each_pair do |name, number|
+      class_eval <<-LEVELMETHODS, __FILE__, __LINE__
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}(message = nil)
+        self << message if #{number} >= level
+        self
+      end
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger. The bang! version of the method also auto
+      # flushes the log buffer to disk.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}!(message = nil)
+        self << message if #{number} >= level
+        flush if #{number} >= level
+        self
+      end
+
+      # ==== Returns
+      # Boolean:: True if this level will be logged by this logger.
+      def #{name}?
+        #{number} >= level
+      end
+      LEVELMETHODS
+    end
+
+  end
+end

data/simple-logger.gemspec

@@ -0,0 +1,25 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+# NOTE: we can't use require_relative because when we run gem build, it use eval for executing this file
+Gem::Specification.new do |s|
+  s.name = "simple-logger"
+  s.version = "0.0.1"
+  s.authors = ["Jakub Šťastný aka Botanicus"]
+  s.homepage = "http://github.com/botanicus/simple-logger"
+  s.summary = "Smarter clone of Extlib logger"
+  s.description = "" # TODO: long description
+  s.cert_chain = nil
+  s.email = ["knava.bestvinensis", "gmail.com"].join("@")
+  s.has_rdoc = true
+
+  # files
+  s.files = Dir.glob("{lib,spec}/**/*") + %w[LICENSE Rakefile README.textile simple-logger.gemspec]
+  s.require_paths = ["lib"]
+
+  # Ruby version
+  s.required_ruby_version = ::Gem::Requirement.new("~> 1.9")
+
+  # dependencies
+  s.add_dependency "extlib"
+end

data/spec/simple-logger/logger_spec.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require "spec"
+require "tempfile"
+require_relative "../lib/simple-logger"
+
+describe SimpleLogger::Logger do
+  before(:each) do
+    @stream = Tempfile.new("test.log")
+    @logger = SimpleLogger::Logger.new(@stream)
+  end
+
+  it "should have some specs"
+end

data/spec/simple-logger/plain_spec.rb

@@ -0,0 +1 @@
+# TODO: there aren't specs for the logger in extlib, I'll have to write it myself

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: simple-logger
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Jakub \xC5\xA0\xC5\xA5astn\xC3\xBD aka Botanicus"
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2009-12-24 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: knava.bestvinensis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/simple-logger/logger.rb
+- lib/simple-logger/plain.rb
+- lib/simple-logger.rb
+- spec/simple-logger/logger_spec.rb
+- spec/simple-logger/plain_spec.rb
+- LICENSE
+- Rakefile
+- README.textile
+- simple-logger.gemspec
+has_rdoc: true
+homepage: http://github.com/botanicus/simple-logger
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ~>
+    - !ruby/object:Gem::Version 
+      version: "1.9"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Smarter clone of Extlib logger
+test_files: []
+