File: tag_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 (31 lines) | stat: -rw-r--r-- 1,155 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
25
26
27
28
29
30
31
# frozen_string_literal: true

module Lumberjack
  # TagFormatter has been renamed to {AttributeFormatter} as part of the transition from
  # "tags" to "attributes" terminology in Lumberjack 2.0. This class exists solely for
  # backward compatibility with the 1.x API and will be removed in a future version.
  #
  # All functionality has been moved to {AttributeFormatter} with no changes to the API.
  # Simply replace +TagFormatter+ with +AttributeFormatter+ in your code.
  #
  # @deprecated Use {Lumberjack::AttributeFormatter} instead.
  # @see Lumberjack::AttributeFormatter
  #
  # @example Migration
  #   # Old code (deprecated)
  #   formatter = Lumberjack::TagFormatter.new
  #
  #   # New code
  #   formatter = Lumberjack::AttributeFormatter.new
  class TagFormatter < AttributeFormatter
    # Create a new TagFormatter instance. Issues a deprecation warning and delegates
    # to {AttributeFormatter}.
    #
    # @deprecated Use {Lumberjack::AttributeFormatter.new} instead.
    def initialize
      Utils.deprecated("Lumberjack::TagFormatter", "Use Lumberjack::AttributeFormatter instead.") do
        super
      end
    end
  end
end