Module: Log

Extended by:
Log
Included in:
Log
Defined in:
lib/nub/log.rb

Overview

Singleton logger for use with both console and gtk+ apps. Logs to both a file and the console/queue for shell/UI apps. Uses Mutex.synchronize where required to provide thread safety.

Constant Summary collapse

@@_level = 
3
@@_queue = 
nil
@@_stdout = 
true
@@_monitor = 
Monitor.new

Class Attribute Summary collapse

Instance Method Summary collapse

Class Attribute Details

.id ⇒ Object (readonly)

Returns the value of attribute id.



48
49
50
 
# File 'lib/nub/log.rb', line 48

def id
  @id
end

.path ⇒ Object (readonly)

Returns the value of attribute path.



48
49
50
 
# File 'lib/nub/log.rb', line 48

def path
  @path
end

Instance Method Details

#call_details ⇒ Object

Get timestamp and location of call



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/nub/log.rb', line 74

def call_details
  @@_monitor.synchronize{

    # Skip first 3 on stack (i.e. 0 = block in call_details, 1 = synchronize, 2 = call_detail) 
    stack = caller_locations(3, 20)

    # Skip past any calls in 'log.rb' or 'monitor.rb'
    i = -1
    while i += 1 do
      mod = File.basename(stack[i].path, '.rb')
      break if !['log', 'monitor'].include?(mod)
    end

    # Save lineno from original location
    lineno = stack[i].lineno

    # Skip over block type functions to use method.
    # Note: there may not be a non block method e.g. in thread case
    regexps = [Regexp.new('^rescue\s.*in\s'), Regexp.new('^block\s.*in\s'), Regexp.new('^each$')]
    while regexps.any?{|regexp| stack[i].label =~ regexp} do
      break if i + 1 == stack.size
      i += 1
    end

    # Set label, clean up for block case
    label = stack[i].label
    regexps.each{|x| label = label.gsub(label[x], "") if stack[i].label =~ x}
    label = stack[i].label if label.empty?

    # Construct stamp
    location = ":#{File.basename(stack[i].path, '.rb')}:#{label}:#{lineno}"
    return Time.now.utc.iso8601(3), location
  }
end

#debug(*args) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nub/log.rb', line 199

def debug(*args)
  @@_monitor.synchronize{
    if LogLevel.debug <= @@_level
      opts = args.find{|x| x.is_a?(Hash)}
      opts[:type] = 'D' if opts
      args << {:type => 'D'} if !opts
      return self.puts(*args)
    end
    return true
  }
end

#die(msg) ⇒ Object

Log the given message in red and exit

Parameters:

  • msg (String) —

    message to log



213
214
215
216
217
218
 
# File 'lib/nub/log.rb', line 213

def die(msg)
  @@_monitor.synchronize{
    msg += "!" if msg.is_a?(String) && msg[-1] != "!"
    self.puts("Error: #{msg}".colorize(:red), stamp: false) and exit
  }
end

#empty? ⇒ Boolean

Check if the log queue is empty

Returns:

  • (Boolean) 


226
227
228
 
# File 'lib/nub/log.rb', line 226

def empty?
  return @@_queue ? @@_queue.empty? : true
end

#error(*args) ⇒ Object 



165
166
167
168
169
170
171
172
173
 
# File 'lib/nub/log.rb', line 165

def error(*args)
  @@_monitor.synchronize{
    opts = args.find{|x| x.is_a?(Hash)}
    opts[:loc] = true and opts[:type] = 'E' if opts
    args << {:loc => true, :type => 'E'} if !opts

    return self.puts(*args)
  }
end

#info(*args) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/nub/log.rb', line 187

def info(*args)
  @@_monitor.synchronize{
    if LogLevel.info <= @@_level
      opts = args.find{|x| x.is_a?(Hash)}
      opts[:type] = 'I' if opts
      args << {:type => 'I'} if !opts
      return self.puts(*args)
    end
    return true
  }
end

#init(path: nil, level: LogLevel.debug, queue: false, stdout: true) ⇒ Object

Singleton’s init method can be called multiple times to reset.

Parameters:

  • path (String) (defaults to: nil) —

    path to log file

  • queue (Bool) (defaults to: false) —

    use a queue as well

  • stdout (Bool) (defaults to: true) —

    turn on or off stdout

  • level (LogLevel) (defaults to: LogLevel.debug) —

    level at which to log



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/nub/log.rb', line 56

def init(path:nil, level:LogLevel.debug, queue:false, stdout:true)
  @id ||= 'singleton'.object_id

  @path = path ? File.expand_path(path) : nil
  @@_level = level
  @@_queue = queue ? Queue.new : nil
  @@_stdout = stdout
  $stdout.sync = true

  # Open log file creating as needed
  if @path
    FileUtils.mkdir_p(File.dirname(@path)) if !File.exist?(File.dirname(@path))
    @file = File.open(@path, 'a')
    @file.sync = true
  end
end

#pop ⇒ Object

Remove an item from the queue, block until one exists



221
222
223
 
# File 'lib/nub/log.rb', line 221

def pop
  return @@_queue ? @@_queue.pop : nil
end

#print(*args) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nub/log.rb', line 109

def print(*args)
  @@_monitor.synchronize{
    str = !args.first.is_a?(Hash) ? args.first.to_s : ''

    # Format message
    opts = args.find{|x| x.is_a?(Hash)}
    loc = (opts && opts.key?(:loc)) ? opts[:loc] : false
    type = (opts && opts.key?(:type)) ? opts[:type] : ""
    stamp = (opts && opts.key?(:stamp)) ? opts[:stamp] : true
    if stamp or loc
      timestamp, location = self.call_details
      location = loc ? location : ""
      type = ":#{type}" if !type.empty?
      str = "#{timestamp}#{location}#{type}:: #{str}"
    end

    # Handle output
    if !str.empty?
      @file << str.strip_color if @path
      @@_queue << str if @@_queue
      $stdout.print(str) if @@_stdout
    end

    return true
  }
end

#puts(*args) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/nub/log.rb', line 136

def puts(*args)
  @@_monitor.synchronize{
    str = !args.first.is_a?(Hash) ? args.first.to_s : ''

    # Format message
    opts = args.find{|x| x.is_a?(Hash)}
    loc = (opts && opts.key?(:loc)) ? opts[:loc] : false
    type = (opts && opts.key?(:type)) ? opts[:type] : ""
    stamp = (opts && opts.key?(:stamp)) ? opts[:stamp] : true

    str = str.colorize(:red) if type == 'E'
    str = str.colorize(:light_yellow) if type == 'W'

    if stamp or loc
      timestamp, location = self.call_details
      location = loc ? location : ""
      type = ":#{type}" if !type.empty?
      str = "#{timestamp}#{location}#{type}:: #{str}"
    end

    # Handle output
    @file.puts(str.strip_color) if @path
    @@_queue << "#{str}\n" if @@_queue
    $stdout.puts(str) if @@_stdout

    return true
  }
end

#warn(*args) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/nub/log.rb', line 175

def warn(*args)
  @@_monitor.synchronize{
    if LogLevel.warn <= @@_level
      opts = args.find{|x| x.is_a?(Hash)}
      opts[:type] = 'W' if opts
      args << {:type => 'W'} if !opts
      return self.puts(*args)
    end
    return true
  }
end