Class: Latinum::Collection

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/latinum/collection.rb

Overview

Aggregates a set of resources, typically used for summing values.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(names = Set.new) ⇒ Collection

Initialize the collection with a given set of resource names.



30
31
32
33
 
# File 'lib/latinum/collection.rb', line 30

def initialize(names = Set.new)
	@names = names
	@resources = Hash.new {|hash, key| @names << key; BigDecimal("0")}
end

Instance Attribute Details

#names ⇒ Object (readonly)

All resource names which have been added to the collection, e.g. ‘[’NZD’, ‘USD’]‘.



36
37
38
 
# File 'lib/latinum/collection.rb', line 36

def names
  @names
end

#resources ⇒ Object (readonly)

A map of ‘name` => `total` for all added resources. Totals are stored as BigDecimal instances.



39
40
41
 
# File 'lib/latinum/collection.rb', line 39

def resources
  @resources
end

Instance Method Details

#-(other) ⇒ Object

Subtract something from this collection.



64
65
66
 
# File 'lib/latinum/collection.rb', line 64

def - other
	self << -other
end

#-@ ⇒ Object

Allow negation of all values within the collection:



69
70
71
72
73
74
75
76
77
 
# File 'lib/latinum/collection.rb', line 69

def -@
	collection = self.class.new
	
	@resources.each do |key, value|
		collection.resources[key] = -value
	end
	
	return collection
end

#<<(object) ⇒ Object Also known as: +

Add a resource, an array of resources, or another collection into this one.



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/latinum/collection.rb', line 47

def << object
	case object
	when Resource
		add(object)
	when Array
		object.each { |resource| add(resource) }
	when Collection
		object.resources.each { |name, amount| @resources[name] += amount }
	end
	
	return self
end

#[](key) ⇒ Object

Get a ‘Resource` for the given name:



80
81
82
 
# File 'lib/latinum/collection.rb', line 80

def [] key
	Resource.new(@resources[key], key)
end

#[]=(key, amount) ⇒ Object

Set a ‘BigDecimal` value for the given name:



85
86
87
 
# File 'lib/latinum/collection.rb', line 85

def []= key, amount
	@resources[key] = amount
end

#add(resource) ⇒ Object

Add a resource into the totals.



42
43
44
 
# File 'lib/latinum/collection.rb', line 42

def add resource
	@resources[resource.name] += resource.amount
end

#compact ⇒ Object

Generate a new collection but ignore zero values.



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/latinum/collection.rb', line 106

def compact
	collection = self.class.new
	
	@resources.each do |key, value|
		unless value.zero?
			collection.resources[key] = value
		end
	end
	
	return collection
end

#each ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/latinum/collection.rb', line 89

def each
	return to_enum(:each) unless block_given?
	
	@resources.each do |key, value|
		yield Resource.new(value, key)
	end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/latinum/collection.rb', line 97

def empty?
	@resources.empty?
end

#include?(key) ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/latinum/collection.rb', line 101

def include?(key)
	@resources.include?(key)
end

#to_s ⇒ Object 



118
119
120
 
# File 'lib/latinum/collection.rb', line 118

def to_s
	@resources.map{|name, amount| "#{amount.to_s('F')} #{name}"}.join("; ")
end