File: object_formatter.rb

package info (click to toggle)
ruby-lumberjack 2.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 956 kB
  • sloc: ruby: 7,957; makefile: 2
file content (24 lines) | stat: -rw-r--r-- 821 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# frozen_string_literal: true

module Lumberjack
  class Formatter
    # No-op formatter that returns the object unchanged. This formatter is useful
    # as a default or fallback formatter when you want to preserve the original
    # object without any transformation.
    #
    # The ObjectFormatter is commonly used in scenarios where you want to maintain
    # the original data structure and let downstream components handle the actual
    # formatting, or when you need a placeholder formatter in the formatter chain.
    class ObjectFormatter
      FormatterRegistry.add(:object, self)

      # Return the object unchanged.
      #
      # @param obj [Object] The object to format.
      # @return [Object] The original object without any modifications.
      def call(obj)
        obj
      end
    end
  end
end