Class: TaskJuggler::ChargeSet

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

Overview

A charge set describes how a given amount is distributed over a set of accounts. It stores the percentage share for each account. The accumulated percentages must always be 100% for a valid charge set. For consistency reasons, accounts must always be leaf accounts of the same top-level account. Percentage values must range from 0.0 to 1.0.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ChargeSet

Create a new ChargeSet object.



28
29
30
31
 
# File 'lib/taskjuggler/ChargeSet.rb', line 28

def initialize
  @set = {}
  @master = nil
end

Instance Attribute Details

#master ⇒ Object (readonly)

Returns the value of attribute master.



25
26
27
 
# File 'lib/taskjuggler/ChargeSet.rb', line 25

def master
  @master
end

Instance Method Details

#addAccount(account, share) ⇒ Object

Add a new account to the set. Accounts and share rates must meet a number of requirements. This method does some error checking and raises a TjException in case of problems. It cannot check everything. Accounts can later be turned into group accounts or the total share sum may not be 100%. This needs to be checked at a later stage. Accounts may have a share of nil. This will be set in ChargeSet#complete later.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/taskjuggler/ChargeSet.rb', line 39

def addAccount(, share)
  unless .leaf?
    raise TjException.new,
      "Account #{.fullId} is a group account and cannot be used " +
      "in a chargeset."
  end
  if @set.include?()
    raise TjException.new,
      "Account #{.fullId} is already a member of the charge set."
  end
  if @master.nil?
    @master = .root
  elsif @master != .root
    raise TjException.new,
      "All members of this charge set must belong to the " +
      "#{@master.fullId} account. #{.fullId} belongs to " +
      "#{.root.fullId}."
  end
  if .container?
    raise TjException.new,
      "#{.fullId} is a group account. Only leaf accounts are " +
      "allowed for a charge set."
  end
  if share && (share < 0.0 || share > 1.0)
    raise TjException.new, "Charge set shares must be between 0 and 100%"
  end
  @set[] = share
end

#complete ⇒ Object

Check for accounts that don’t have a share yet and distribute the remainder to 100% evenly accross them.



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/taskjuggler/ChargeSet.rb', line 76

def complete
  # Calculate the current total share.
  totalPercent = 0.0
  undefined = 0
  @set.each_value do |share|
    if share
      totalPercent += share
    else
      undefined += 1
    end
  end
  # Must be less than 100%.
  if totalPercent > 1.0
    raise TjException.new,
      "Total share of this set (#{totalPercent * 100}%) excedes 100%."
  end
  if undefined > 0
    commonShare = (1.0 - totalPercent) / undefined
    if commonShare <= 0
      raise TjException.new,
        "Total share is 100% but #{undefined} account(s) still exist."
    end
    @set.each do |, share|
      if share.nil?
        @set[] = commonShare
      end
    end
  elsif totalPercent != 1.0
    raise TjException.new,
      "Total share of this set is #{totalPercent * 100} instead of 100%."
  end
end

#each ⇒ Object 



68
69
70
71
72
 
# File 'lib/taskjuggler/ChargeSet.rb', line 68

def each
  @set.each do |, share|
    yield , share
  end
end

#share(account) ⇒ Object

Return the share percentage for a given Account account.



110
111
112
 
# File 'lib/taskjuggler/ChargeSet.rb', line 110

def share()
  @set[]
end

#to_s ⇒ Object

Return the set as comma separated list of account ID + share pairs.



115
116
117
118
119
120
121
122
 
# File 'lib/taskjuggler/ChargeSet.rb', line 115

def to_s
  str = '('
  @set.each do |, share|
    str += ', ' unless str == '('
    str += "#{.fullId} #{share * 100}%"
  end
  str += ')'
end