Class: ProtonBot::LogWrapper

Inherits:
Object
  • Object
show all
Defined in:
lib/protonbot/log_wrapper.rb

Overview

Log wrapper

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(log, name) ⇒ LogWrapper

Returns a new instance of LogWrapper.

Parameters:

  • log (Log)
  • name (String) 


11
12
13
14
 
# File 'lib/protonbot/log_wrapper.rb', line 11

def initialize(log, name)
  @log  = log
  @name = name
end

Instance Attribute Details

#log ⇒ Log (readonly)

Returns Log.

Returns:

  • (Log) —

    Log



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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/protonbot/log_wrapper.rb', line 6

class ProtonBot::LogWrapper
  attr_reader :log, :name

  # @param log [Log]
  # @param name [String]
  def initialize(log, name)
    @log  = log
    @name = name
  end

  # @param msg [String]
  # @return [LogWrapper] self
  def info(msg)
    @log.info(msg, @name)
  end

  # @param msg [String]
  # @return [LogWrapper] self
  def debug(msg)
    @log.debug(msg, @name)
  end

  # @param msg [String]
  # @return [LogWrapper] self
  def warn(msg)
    @log.warn(msg, @name)
  end

  # @param msg [String]
  # @return [LogWrapper] self
  def error(msg)
    @log.error(msg, @name)
  end

  # @param msg [String]
  # @return [LogWrapper] self
  # @return [Integer] code
  def crash(msg, code)
    @log.crash(msg, code, @name)
  end

  # @return [String] Output
  def inspect
    %(<#ProtonBot::LogWrapper:#{object_id.to_s(16)} @name='#{@name}') +
      %( @log=#{@log}>)
  end
end

#name ⇒ String (readonly)

Returns name.

Returns:

  • (String) —

    name



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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/protonbot/log_wrapper.rb', line 6

class ProtonBot::LogWrapper
  attr_reader :log, :name

  # @param log [Log]
  # @param name [String]
  def initialize(log, name)
    @log  = log
    @name = name
  end

  # @param msg [String]
  # @return [LogWrapper] self
  def info(msg)
    @log.info(msg, @name)
  end

  # @param msg [String]
  # @return [LogWrapper] self
  def debug(msg)
    @log.debug(msg, @name)
  end

  # @param msg [String]
  # @return [LogWrapper] self
  def warn(msg)
    @log.warn(msg, @name)
  end

  # @param msg [String]
  # @return [LogWrapper] self
  def error(msg)
    @log.error(msg, @name)
  end

  # @param msg [String]
  # @return [LogWrapper] self
  # @return [Integer] code
  def crash(msg, code)
    @log.crash(msg, code, @name)
  end

  # @return [String] Output
  def inspect
    %(<#ProtonBot::LogWrapper:#{object_id.to_s(16)} @name='#{@name}') +
      %( @log=#{@log}>)
  end
end

Instance Method Details

#crash(msg, code) ⇒ LogWrapper, Integer

Parameters:

  • msg (String)

Returns:



43
44
45
 
# File 'lib/protonbot/log_wrapper.rb', line 43

def crash(msg, code)
  @log.crash(msg, code, @name)
end

#debug(msg) ⇒ LogWrapper

Returns self.

Parameters:

  • msg (String)

Returns:



24
25
26
 
# File 'lib/protonbot/log_wrapper.rb', line 24

def debug(msg)
  @log.debug(msg, @name)
end

#error(msg) ⇒ LogWrapper

Returns self.

Parameters:

  • msg (String)

Returns:



36
37
38
 
# File 'lib/protonbot/log_wrapper.rb', line 36

def error(msg)
  @log.error(msg, @name)
end

#info(msg) ⇒ LogWrapper

Returns self.

Parameters:

  • msg (String)

Returns:



18
19
20
 
# File 'lib/protonbot/log_wrapper.rb', line 18

def info(msg)
  @log.info(msg, @name)
end

#inspect ⇒ String

Returns Output.

Returns:

  • (String) —

    Output



48
49
50
51
 
# File 'lib/protonbot/log_wrapper.rb', line 48

def inspect
  %(<#ProtonBot::LogWrapper:#{object_id.to_s(16)} @name='#{@name}') +
    %( @log=#{@log}>)
end

#warn(msg) ⇒ LogWrapper

Returns self.

Parameters:

  • msg (String)

Returns:



30
31
32
 
# File 'lib/protonbot/log_wrapper.rb', line 30

def warn(msg)
  @log.warn(msg, @name)
end