Class: TaskJuggler::Log

Inherits:
Monitor
  • Object
show all
Includes:
Singleton
Defined in:
lib/taskjuggler/Log.rb

Overview

The Log class implements a filter for segmented execution traces. The trace messages are filtered based on their segment name and the nesting level of the segments. The class is a Singleton, so there is only one instance in the program.

Constant Summary collapse

@@level = 
0
@@stack = 
[]
@@segments = 
[]
@@silent = 
true
@@progress = 
0
@@progressMeter = 
''

Class Method Summary collapse

Class Method Details

.activity ⇒ Object

This function may only be called when Log#startProgressMeter has been called before. It updates the progress indicator to the next symbol to visualize ongoing activity.



144
145
146
147
148
149
150
 
# File 'lib/taskjuggler/Log.rb', line 144

def Log.activity
  return if @@silent

  indicator = %w( - \\ | / )
  @@progress = (@@progress.to_i + 1) % indicator.length
  $stdout.print("#{@@progressMeter} [#{indicator[@@progress]}]\r")
end

.enter(segment, message) ⇒ Object

This function is used to open a new segment. segment is the name of the segment and message is a description of it.



61
62
63
64
65
66
 
# File 'lib/taskjuggler/Log.rb', line 61

def Log.enter(segment, message)
  return if @@level == 0

  @@stack << segment
  Log.msg { ">> [#{segment}] #{message}" }
end

.exit(segment, message = nil) ⇒ Object

This function is used to close an open segment. To make this mechanism a bit more robust, it will search the stack of open segments for a segment with that name and will close all nested segments as well.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/taskjuggler/Log.rb', line 71

def Log.exit(segment, message = nil)
  return if @@level == 0

  Log.msg { "<< [#{segment}] #{message}" } if message
  if @@stack.include?(segment)
    loop do
      m = @@stack.pop
      break if m == segment
    end
  end
end

.level=(l) ⇒ Object

Set the maximum nesting level that should be shown. Segments with a nesting level greater than l will be silently dropped.



37
38
39
 
# File 'lib/taskjuggler/Log.rb', line 37

def Log.level=(l)
  @@level = l
end

.msg(&block) ⇒ Object

Use this function to show a log message within the currently active segment. The message is the result of the passed block. The block will only be evaluated if the message will actually be shown.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/taskjuggler/Log.rb', line 86

def Log.msg(&block)
  return if @@level == 0

  offset = 0
  unless @@segments.empty?
    showMessage = false
    @@stack.each do |segment|
      # If a segment list is used to filter the output, we look for the
      # first listed segments on the stack. This and all nested segments
      # will be shown.
      if @@segments.include?(segment)
        offset = @@stack.index(segment)
        showMessage = true
        break
      end
    end
    return unless showMessage
  end
  if @@stack.length - offset < @@level
    $stderr.puts ' ' * (@@stack.length - offset) + yield(block)
  end
end

.progress(percent) ⇒ Object

This function may only be called when Log#startProgressMeter has been called before. It updates the progress bar to the given percent completion value. The value should be between 0.0 and 1.0.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/taskjuggler/Log.rb', line 155

def Log.progress(percent)
  return if @@silent

  percent = 0.0 if percent < 0.0
  percent = 1.0 if percent > 1.0
  @@progress = percent

  length = 16
  full = (length * percent).to_i
  bar = '=' * full + ' ' * (length - full)
  label = (percent * 100.0).to_i.to_s + '%'
  bar[length / 2 - label.length / 2, label.length] = label
  $stdout.print("#{@@progressMeter} [" +
                Term::ANSIColor.green("#{bar}") + "]\r")
end

.segments=(s) ⇒ Object

The trace output can be limited to a list of segments. Messages not in these segments will be ignored. Messages from segments that are nested into the shown segments will be shown for the next @@level nested segments.



45
46
47
 
# File 'lib/taskjuggler/Log.rb', line 45

def Log.segments=(s)
  @@segments = s
end

.silent ⇒ Object

Return the @@silent value.



55
56
57
 
# File 'lib/taskjuggler/Log.rb', line 55

def Log.silent
  @@silent
end

.silent=(s) ⇒ Object

if s is true, progress information will not be shown.



50
51
52
 
# File 'lib/taskjuggler/Log.rb', line 50

def Log.silent=(s)
  @@silent = s
end

.startProgressMeter(text) ⇒ Object

The progress meter can be a textual progress bar or some animated character sequence that informs the user about ongoing activities. Call this function to start the progress meter display or to change the info text. The the meter is active the text cursor is always returned to the start of the same line. Consequent output will overwrite the last meter text.



122
123
124
125
126
127
128
129
130
 
# File 'lib/taskjuggler/Log.rb', line 122

def Log.startProgressMeter(text)
  return if @@silent

  maxlen = 60
  text = text.ljust(maxlen)
  text = text[0..maxlen - 1] if text.length_utf8 > maxlen
  @@progressMeter = text
  $stdout.print("#{@@progressMeter} ...\r")
end

.status(message) ⇒ Object

Print out a status message unless we are in silent mode.



110
111
112
113
114
 
# File 'lib/taskjuggler/Log.rb', line 110

def Log.status(message)
  return if @@silent

  $stdout.puts message
end

.stopProgressMeter ⇒ Object

This sets the progress meter status to “done” and puts the cursor into the next line again.



134
135
136
137
138
139
 
# File 'lib/taskjuggler/Log.rb', line 134

def Log.stopProgressMeter
  return if @@silent

  $stdout.print("#{@@progressMeter} [      " +
                Term::ANSIColor.green("Done") + "      ]\n")
end