Class: URBANopt::Reporting::DefaultReports::ConstructionCost

Inherits:
Object
  • Object
show all
Defined in:
lib/urbanopt/reporting/default_reports/construction_cost.rb

Overview

ConstructionCost include construction cost information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash = {}) ⇒ ConstructionCost

ConstructionCost class initialize all construction_cost attributes: :category , :item_name , :unit_cost , :cost_units , :item_quantity , :total_cost

parameters:

hash - Hash - A hash which may contain a deserialized construction_cost.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 26

def initialize(hash = {})
  hash.delete_if { |k, v| v.nil? }
  hash = defaults.merge(hash)

  @category = hash[:category]
  @item_name = hash[:item_name]
  @unit_cost = hash[:unit_cost]
  @cost_units = hash[:cost_units]
  @item_quantity = hash[:item_quantity]
  @total_cost = hash[:total_cost]

  # initialize class variables @@validator and @@schema
  @@validator ||= Validator.new
  @@schema ||= @@validator.schema
end

Instance Attribute Details

#category ⇒ Object

:nodoc:



17
18
19
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 17

def category
  @category
end

#cost_units ⇒ Object

:nodoc:



17
18
19
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 17

def cost_units
  @cost_units
end

#item_name ⇒ Object

:nodoc:



17
18
19
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 17

def item_name
  @item_name
end

#item_quantity ⇒ Object

:nodoc:



17
18
19
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 17

def item_quantity
  @item_quantity
end

#total_cost ⇒ Object

:nodoc:



17
18
19
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 17

def total_cost
  @total_cost
end

#unit_cost ⇒ Object

:nodoc:



17
18
19
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 17

def unit_cost
  @unit_cost
end

Class Method Details

.merge_construction_cost(existing_cost, new_cost) ⇒ Object

Merges an existing_cost with a new_cost:

  • modify the existing_cost by summing the :total_cost and :item_quantity of new_cost and existing_cost.

  • raise an error if :category , :cost_units and :unit_cost are not identical

Parameters:

existing_cost - ConstructionCost - An object of ConstructionCost class.

new_cost - ConstructionCost - An object of ConstructionCost class.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 90

def self.merge_construction_cost(existing_cost, new_cost)
  # modify the existing_cost by adding the :total_cost and :item_quantity
  existing_cost.total_cost += new_cost.total_cost
  existing_cost.item_quantity += new_cost.item_quantity

  if existing_cost.category != new_cost.category
    raise "Cannot merge existing cost of category \"#{existing_cost.category}\" with new cost of category \"#{new_cost.category}\"."
  end

  if existing_cost.cost_units != new_cost.cost_units
    raise "Cannot merge existing cost with cost units \"#{existing_cost.cost_units}\" with new cost with cost units \"#{new_cost.cost_units}\". "
  end

  if existing_cost.unit_cost != new_cost.unit_cost
    raise "Cannot merge existing cost with unit cost \"#{existing_cost.unit_cost}\" with new cost with unit cost \"#{new_cost.unit_cost}\"; identical items should have identical unit cost."
  end

  return existing_cost
end

.merge_construction_costs(existing_costs, new_costs) ⇒ Object

Merges multiple construction costs together.

  • loops over the new_costs and find the index of the cost with identical :item_name.

  • if item_name is identical then modify the existing_cost array by summing the :total_cost and :item_quantity. Else add the new_cost to existing_costs array.

Parameters:

existing_costs - Array - An array of ConstructionCost objects.

new_costs - Array - An array of ConstructionCost objects.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 119

def self.merge_construction_costs(existing_costs, new_costs)
  item_name_list = []
  item_name_list = existing_costs.collect(&:item_name)

  new_costs.each do |x_new|
    if item_name_list.include?(x_new.item_name)

      # when looping over the new_cost item_names find the index of the item_name_list with the same item name
      id = item_name_list.find_index(x_new.item_name) # the order of the item_name_list is the same as the order of the existing_cost hash-array

      # modify the existing_cost array by adding the :total_cost and :item_quantity when looping over costs
      existing_costs[id] = merge_construction_cost(existing_costs[id], x_new)

    else

      # insert the new hash in to the array
      existing_costs << x_new

    end
  end

  return existing_costs
end

Instance Method Details

#defaults ⇒ Object

Assigns default values if attribute values do not exist.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 45

def defaults
  hash = {}
  hash[:category] = nil
  hash[:item_name] = nil
  hash[:unit_cost] = nil
  hash[:cost_units] = nil
  hash[:item_quantity] = nil
  hash[:total_cost] = nil

  return hash
end

#to_hash ⇒ Object

Converts to a Hash equivalent for JSON serialization.

  • Exclude attributes with nil values.

  • Validate construct_cost hash properties against schema.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/urbanopt/reporting/default_reports/construction_cost.rb', line 63

def to_hash
  result = {}
  result[:category] = @category if @category
  result[:item_name] = @item_name if @item_name
  result[:unit_cost] = @unit_cost if @unit_cost
  result[:cost_units] = @cost_units if @cost_units
  result[:item_quantity] = @item_quantity if @item_quantity
  result[:total_cost] = @total_cost if @total_cost

  # validate construct_cost properties against schema
  if @@validator.validate(@@schema[:definitions][:ConstructionCost][:properties], result).any?
    raise "construction_cost properties does not match schema: #{@@validator.validate(@@schema[:definitions][:ConstructionCost][:properties], result)}"
  end

  return result
end