Class: TaskJuggler::JournalEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/taskjuggler/Journal.rb

Overview

A JournalEntry stores some RichText strings to describe a status or a property of the project at a certain point in time. Additionally, the entry can contain a reference to a Resource as author and an alert level. The text is structured in 3 different elements, a headline, a short summary and a longer text segment. The headline is mandatory, the summary and details sections are optional.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(journal, date, headline, property, sourceFileInfo = nil) ⇒ JournalEntry

Create a new JournalEntry object.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/taskjuggler/Journal.rb', line 31

def initialize(journal, date, headline, property, sourceFileInfo = nil)
  # A reference to the Journal object this entry belongs to.
  @journal = journal
  # The date of the entry.
  @date = date
  # A very short description. Should not be longer than about 40
  # characters.
  @headline = headline
  # A reference to a PropertyTreeNode object.
  @property = property
  # Source file location of this entry of type SourceFileInfo
  @sourceFileInfo = sourceFileInfo
  # A reference to a Resource.
  @author = nil
  # A list of Resource objects that have moderated this entry.
  @moderators = []
  # An introductory or summarizing RichText paragraph.
  @summary = nil
  # A RichText of arbitrary length.
  @details = nil
  # The alert level.
  @alertLevel = 0
  # A list of flags.
  @flags = []
  # A reference to a time sheet record that was used to create this
  # JournalEntry object.
  @timeSheetRecord = nil

  # Add the new entry to the journal.
  @journal.addEntry(self)
end

Instance Attribute Details

#alertLevel ⇒ Object

Returns the value of attribute alertLevel.



27
28
29
 
# File 'lib/taskjuggler/Journal.rb', line 27

def alertLevel
  @alertLevel
end

#author ⇒ Object

Returns the value of attribute author.



27
28
29
 
# File 'lib/taskjuggler/Journal.rb', line 27

def author
  @author
end

#date ⇒ Object (readonly)

Returns the value of attribute date.



26
27
28
 
# File 'lib/taskjuggler/Journal.rb', line 26

def date
  @date
end

#details ⇒ Object

Returns the value of attribute details.



27
28
29
 
# File 'lib/taskjuggler/Journal.rb', line 27

def details
  @details
end

#flags ⇒ Object

Returns the value of attribute flags.



27
28
29
 
# File 'lib/taskjuggler/Journal.rb', line 27

def flags
  @flags
end

#headline ⇒ Object (readonly)

Returns the value of attribute headline.



26
27
28
 
# File 'lib/taskjuggler/Journal.rb', line 26

def headline
  @headline
end

#moderators ⇒ Object

Returns the value of attribute moderators.



27
28
29
 
# File 'lib/taskjuggler/Journal.rb', line 27

def moderators
  @moderators
end

#property ⇒ Object (readonly)

Returns the value of attribute property.



26
27
28
 
# File 'lib/taskjuggler/Journal.rb', line 26

def property
  @property
end

#sourceFileInfo ⇒ Object (readonly)

Returns the value of attribute sourceFileInfo.



26
27
28
 
# File 'lib/taskjuggler/Journal.rb', line 26

def sourceFileInfo
  @sourceFileInfo
end

#summary ⇒ Object

Returns the value of attribute summary.



27
28
29
 
# File 'lib/taskjuggler/Journal.rb', line 27

def summary
  @summary
end

#timeSheetRecord ⇒ Object

Returns the value of attribute timeSheetRecord.



27
28
29
 
# File 'lib/taskjuggler/Journal.rb', line 27

def timeSheetRecord
  @timeSheetRecord
end

Instance Method Details

#to_rText(query) ⇒ Object

Convert the entry into a RichText string. The formatting is controlled by the Query parameters.



65
66
67
68
69
70
71
72
73
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
108
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
135
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/taskjuggler/Journal.rb', line 65

def to_rText(query)
  # We use the alert level a sortable and numerical result.
  if query.journalAttributes.include?('alert')
    levelRecord = query.project['alertLevels'][alertLevel]
    if query.selfContained
      alertName = "<nowiki>[</nowiki><fcol:#{levelRecord.color}><nowiki>" +
                  "#{levelRecord.name}</nowiki></fcol><nowiki>]</nowiki>"
    else
      alertName = "[[File:icons/flag-#{levelRecord.id}.png|" +
      "alt=[#{levelRecord.name}]|text-bottom]] "
    end
  else
    alertName = ''
  end

  # The String that will hold the result as RichText markup.
  rText = ''

  # Markup to use for headlines.
  hlMark = '==='

  if query.journalAttributes.include?('property') && @property
    if @property.is_a?(Task)
      # Include the alert level, task name and ID.
      rText += "#{hlMark} #{alertName} <nowiki>#{@property.name}</nowiki>"
      if query.journalAttributes.include?('propertyid')
        rText += " (ID: #{@property.fullId})"
      end
      rText += " #{hlMark}\n\n"

      if query.journalAttributes.include?('timesheet') && @timeSheetRecord
        # Include the reported time sheet data for this task.
        rText += "'''Work:''' #{@timeSheetRecord.actualWorkPercent.to_i}% "
        if @timeSheetRecord.actualWorkPercent !=
           @timeSheetRecord.planWorkPercent
          rText += "(#{@timeSheetRecord.planWorkPercent.to_i}%) "
        end
        if @timeSheetRecord.remaining
          rText += "'''Remaining:''' #{@timeSheetRecord.actualRemaining}d "
          if @timeSheetRecord.actualRemaining !=
             @timeSheetRecord.planRemaining
            rText += "(#{@timeSheetRecord.planRemaining}d) "
          end
        else
          rText += "'''End:''' " +
            "#{@timeSheetRecord.actualEnd.to_s(query.timeFormat)} "
          if @timeSheetRecord.actualEnd != @timeSheetRecord.planEnd
            rText += "(#{@timeSheetRecord.planEnd.to_s(query.timeFormat)}) "
          end
        end
        rText += "\n\n"
      end
    elsif !(@timeSheetRecord = @timeSheetRecord).nil? &&
          @timeSheetRecord.task.is_a?(String)
      # There is only an entry in the timesheet, but we don't have a
      # corresponding Task in the Project. This must be a new task created
      # by the timesheet submitter.
      rText += "#{hlMark} #{alertName} <nowiki>[New Task] " +
               "#{@timeSheetRecord.name}</nowiki>"
      if query.journalAttributes.include?('propertyid')
        rText += " (ID: #{@timeSheetRecord.task})"
      end
      rText += " #{hlMark}\n\n"

      if query.journalAttributes.include?('timesheet') && @timeSheetRecord
        # We don't have any plan data since it's a new task. Just include
        # the reported time sheet actuals.
        rText += "'''Work:''' #{@timeSheetRecord.actualWorkPercent}% "
        if @timeSheetRecord.remaining
          rText += "'''Remaining:''' #{@timeSheetRecord.actualRemaining}d "
        else
          rText += "'''End:''' " +
                   "#{@timeSheetRecord.actualEnd.to_s(query.timeFormat)} "
        end
        rText += "\n\n"
      end
    else
      # Property must be a Resource
      rText += "#{hlMark} #{alertName} Personal Notes #{hlMark}\n\n"
    end

    # We've shown the alert now. Don't show it again with the headline.
    alertName = ''
    # Increase level for subsequent headlines.
    hlMark += '='
  end

  if query.journalAttributes.include?('headline')
    rText += "#{hlMark} #{alertName}<nowiki>" + @headline +
             "</nowiki> #{hlMark}\n\n"
  end

  showDate = query.journalAttributes.include?('date')
  showAuthor = query.journalAttributes.include?('author') && @author
  if showDate || showAuthor
    rText += "''Reported "
  end
  if showDate
    rText += "on #{@date.to_s(query.timeFormat)} "
  end
  if showAuthor
    rText += "by <nowiki>#{@author.name}</nowiki>"
  end
  rText += "''\n\n" if showDate || showAuthor

  if query.journalAttributes.include?('flags') && !@flags.empty?
    rText += "''Flags:'' #{@flags.join(', ')}\n\n"
  end

  if query.journalAttributes.include?('summary') && @summary
    rText += @summary.richText.inputText + "\n\n"
  end
  if query.journalAttributes.include?('details') && @details
    rText += @details.richText.inputText + "\n\n"
  end
  rText
end

#to_s ⇒ Object

Just for debugging



184
185
186
 
# File 'lib/taskjuggler/Journal.rb', line 184

def to_s # :nodoc:
  "Headline: #{@headline}\nProperty: #{@property.class}: #{@property.fullId}"
end