Contents

# encoding: utf-8

module TTY
  # A class providing logging system
  class Logger
    include TTY::Equatable

    ALL       = 0
    INFO      = 1
    DEBUG     = 2
    WARN      = 3
    ERROR     = 4
    FATAL     = 5
    OFF       = 6

    MAX_LEVELS = 7

    attr_reader :namespace

    attr_reader :level

    attr_reader :output

    attr_reader :timestamp_format

    # Initialize a Logger
    #
    # @param [String] name
    #
    # @param [Hash] options
    #
    # @option options [String] :output
    #
    # @api public
    def initialize(options = {})
      @namespace = options.fetch(:namespace) do
        fail ArgumentError, 'Logger must have namespace', caller
      end
      @output = options.fetch(:output) { $stderr }
      @level  = options.fetch(:level) { ALL }
      @timestamp_format = options.fetch(:timestamp_format) { '%Y-%m-%d %T' }
    end

    def level=(level)
      validate_level(level)
      @level = level
    end

    # Create a timestamp
    #
    # @return [Time]
    #
    # @api public
    def timestamp
      Time.now.strftime(timestamp_format)
    end

    def validate_level(level)
      return if valid_level?(level)
      fail ArgumentError, "Log level must be 0..#{MAX_LEVELS}", caller
    end

    # Verify valid level
    #
    # @param [Number] level
    #   the level of this logger
    #
    # @return [Boolean]
    #
    # @api public
    def self.valid_level?(level)
      !level.nil? && level.is_a?(Numeric) && level >= ALL && level <= OFF
    end

    # Print formatted log to output
    #
    # @param [String] message
    #   the message to print to output
    #
    # @api public
    def log(message)
      output.print timestamp + ' - ' + message
    end
  end # Logger
end # TTY

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
tty-0.1.0	lib/tty/logger.rb