log_facade.rb

module Autumn

  # This class is a facade for Ruby's `Logger` that adds additional information
  # to log entries. LogFacade will pass any method calls onto a Logger instance,
  # but reformat log entries to include an Autumn object's type and name.
  #
  # For example, if you wanted a LogFacade for a Leaf named "Scorekeeper", you
  # could instantiate one:
  #
  # ```` ruby
  # facade = LogFacade.new(logger, 'Leaf', 'Scorekeeper')
  # ````
  #
  # And a call such as:
  #
  # ```` ruby
  # facade.info "Starting up"
  # ````
  #
  # Would be reformatted as "Scorekeeper (Leaf): Starting up".
  #
  # In addition, this class will log messages to `STDOUT` if the `debug` global
  # option is set. Instantiation of this class is handled by {Genesis} and
  # should not normally be done by the user.

  class LogFacade
    # @return [String] The Autumn object type (typically "Stem" or "Leaf").
    attr :type
    # @return [String] The name of the Autumn object.
    attr :name

    # Creates a new facade for `logger` that prepends type and name information
    # to each log message.
    #
    # @param [Logger] logger A logger instance.
    # @param [String] type The Autumn object type (e.g., "Stem" or "Leaf").
    # @param [String] name The Autumn object name (leaf or stem name).

    def initialize(logger, type, name)
      @type   = type
      @name   = name
      @logger = logger
      @stdout = Speciator.instance.season(:logging) == 'debug'
    end

    # @private
    def method_missing(meth, *args)
      if args.size == 1 && args.only.kind_of?(String)
        args = ["#{name} (#{type}): #{args.only}"]
      end
      @logger.send meth, *args
      puts (args.first.kind_of?(Exception) ? (args.first.to_s + "\n" + args.first.backtrace.join("\n")) : args.first) if @stdout
    end
  end
end