-
Notifications
You must be signed in to change notification settings - Fork 76
/
CurrencyAmount.cs
427 lines (387 loc) · 14.4 KB
/
CurrencyAmount.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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
62
63
64
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
using System;
using System.Diagnostics;
using System.Diagnostics.Contracts;
using System.Globalization;
using System.Runtime.Serialization;
namespace E016_value_objects
{
public enum CurrencyType
{
None,
Eur,
Usd,
Aud,
Cad,
Chf,
Gbp,
Jpy,
Rub,
Mxn,
}
/// <summary>
/// This is the CurrencyAmount Value Object that was mentioned by Rinat in BTW Episode 16.
/// Value Objects can often be the "nouns" (in contrast to message "verbs") in the sentences of our ubiquitous language.
/// The nouns are not actions, they are something that is part of the language.
/// It is a decimal that also has a currency type assotiated with it. It is used
/// for enforcing logical consistency within the billing system.
///
/// We use a Value Objedct here to reduce the chances of messing up by mixing different
/// currencies together.
/// </summary>
[DataContract(Namespace = "Lokad.Core")]
public struct CurrencyAmount : IEquatable<CurrencyAmount>, IFormattable
{
/// <summary>
/// Default empty currency amount with undefined currency type
/// </summary>
public static readonly CurrencyAmount Zero = default(CurrencyAmount);
/// <summary>Currency type</summary>
[DataMember(Order = 1)]
public readonly CurrencyType Currency;
/// <summary>
/// Value in the given currency
/// </summary>
[DataMember(Order = 2)]
public readonly decimal Value;
/// <summary>
/// Initializes a new instance of the
/// <see cref="CurrencyAmount" />
/// struct.
/// </summary>
/// <param name="currency">The currency.</param>
/// <param name="value">The value.</param>
public CurrencyAmount(CurrencyType currency, decimal value)
{
Currency = currency;
Value = value;
}
public static CurrencyAmount Parse(string source)
{
// required for JSON conversion back
var items = source.Split(' ');
var type = CurrencyType.None;
var @decimal = decimal.Parse(items[0], CultureInfo.InvariantCulture);
if (items.Length > 1)
{
type = (CurrencyType)Enum.Parse(typeof(CurrencyType), items[1], true);
}
return @decimal.In(type);
}
/// <summary>
/// Indicates whether the current object is equal to another object of the same type.
/// </summary>
/// <param name="other">
/// An object to compare with this object.
/// </param>
/// <returns>
/// true if the current object is equal to the
/// <paramref name="other" />
/// parameter; otherwise, false.
/// </returns>
public bool Equals(CurrencyAmount other)
{
return Equals(other.Currency, Currency) && other.Value == Value;
}
/// <summary>
/// Determines whether the specified
/// <see cref="System.Object" />
/// is equal to this instance.
/// </summary>
/// <param name="obj">
/// The
/// <see cref="System.Object" />
/// to compare with this instance.
/// </param>
/// <returns>
/// <c>true</c>
/// if the specified
/// <see cref="System.Object" />
/// is equal to this instance; otherwise,
/// <c>false</c>
/// .
/// </returns>
/// <exception cref="T:System.NullReferenceException">
/// The
/// <paramref name="obj" />
/// parameter is null.
/// </exception>
public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (obj.GetType() != typeof(CurrencyAmount)) return false;
return Equals((CurrencyAmount)obj);
}
/// <summary>
/// Returns a hash code for this instance.
/// </summary>
/// <returns>
/// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
/// </returns>
public override int GetHashCode()
{
unchecked
{
return (Currency.GetHashCode() * 397) ^ Value.GetHashCode();
}
}
/// <summary>
/// Returns a
/// <see cref="System.String" />
/// that represents this instance, using the
/// provided format options to pass to the
/// <see cref="decimal.ToString(string,System.IFormatProvider)" />
/// </summary>
/// <param name="format">The format.</param>
/// <param name="formatProvider">The format provider.</param>
/// <returns>
/// A
/// <see cref="System.String" />
/// that represents this instance.
/// </returns>
[Pure]
public string ToString(string format, IFormatProvider formatProvider)
{
var amount = Value.ToString(format, formatProvider);
if (Currency == CurrencyType.None)
return amount;
return string.Format("{0} {1}", amount, Currency.ToString().ToUpperInvariant());
}
[Pure]
public string ToString(string format)
{
return ToString(format, CultureInfo.InvariantCulture);
}
/// <summary>
/// Returns a
/// <see cref="System.String" />
/// that represents this instance.
/// </summary>
/// <returns>
/// A
/// <see cref="System.String" />
/// that represents this instance.
/// </returns>
[Pure]
public override string ToString()
{
var amount = Value.ToString(CultureInfo.InvariantCulture);
if (Currency != CurrencyType.None)
amount += " " + Currency.ToString().ToUpperInvariant();
return amount;
}
// extensions
/// <summary>
/// Rounds the specified amount to the specified amount of decimals.
/// </summary>
/// <param name="decimals">The decimals.</param>
/// <returns>rounded instance</returns>
[Pure]
public CurrencyAmount Round(int decimals)
{
return new CurrencyAmount(Currency, Math.Round(Value, decimals));
}
/// <summary>
/// Converts this currency amount by applying the specified
/// transformation function to the amount and returning new result instance.
/// </summary>
/// <param name="conversion">The conversion.</param>
/// <returns>new result instance</returns>
[Pure]
public CurrencyAmount Convert(Func<decimal, decimal> conversion)
{
return new CurrencyAmount(Currency, conversion(Value));
}
/// <summary>
/// Implements the operator /.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="value">The value.</param>
/// <returns>
/// The result of the operator.
/// </returns>
public static CurrencyAmount operator /(CurrencyAmount originalValue, decimal value)
{
return new CurrencyAmount(originalValue.Currency, originalValue.Value / value);
}
public static decimal operator /(CurrencyAmount left, CurrencyAmount right)
{
ThrowIfMismatch(left, right, "/");
return left.Value / right.Value;
}
/// <summary>
/// Implements the operator *.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="value">The value.</param>
/// <returns>
/// The result of the operator.
/// </returns>
public static CurrencyAmount operator *(CurrencyAmount originalValue, decimal value)
{
return new CurrencyAmount(originalValue.Currency, originalValue.Value * value);
}
/// <summary>
/// Implements the operator +.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="value">The value.</param>
/// <returns>
/// The result of the operator.
/// </returns>
public static CurrencyAmount operator +(CurrencyAmount originalValue, decimal value)
{
return new CurrencyAmount(originalValue.Currency, originalValue.Value + value);
}
/// <summary>
/// Implements the operator +.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="amount">The amount to add.</param>
/// <returns>
/// The result of the operator.
/// </returns>
/// ///
/// <exception cref="InvalidOperationException">
/// If currency types do not match
/// </exception>
public static CurrencyAmount operator +(CurrencyAmount originalValue, CurrencyAmount amount)
{
ThrowIfMismatch(originalValue, amount, "+");
return new CurrencyAmount(originalValue.Currency, originalValue.Value + amount.Value);
}
/// <summary>
/// Implements the operator -.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="amount">
/// The amount to subtract.
/// </param>
/// <returns>
/// The result of the operator.
/// </returns>
/// <exception cref="InvalidOperationException">
/// If currency types do not match
/// </exception>
public static CurrencyAmount operator -(CurrencyAmount originalValue, CurrencyAmount amount)
{
ThrowIfMismatch(originalValue, amount, "-");
return new CurrencyAmount(originalValue.Currency, originalValue.Value - amount.Value);
}
/// <summary>
/// Implements the operator >.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="amount">
/// The amount to compare with.
/// </param>
/// <returns>
/// The result of the operator.
/// </returns>
/// <exception cref="InvalidOperationException">
/// If currency types do not match
/// </exception>
public static bool operator >(CurrencyAmount originalValue, CurrencyAmount amount)
{
ThrowIfMismatch(originalValue, amount, ">");
return originalValue.Value > amount.Value;
}
/// <summary>
/// Implements the operator >=.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="amount">
/// The amount to compare with.
/// </param>
/// <returns>
/// The result of the operator.
/// </returns>
/// <exception cref="InvalidOperationException">
/// If currency types do not match
/// </exception>
public static bool operator >=(CurrencyAmount originalValue, CurrencyAmount amount)
{
ThrowIfMismatch(originalValue, amount, ">=");
return originalValue.Value >= amount.Value;
}
/// <summary>
/// Implements the operator <=.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="amount">
/// The amount to compare with.
/// </param>
/// <returns>
/// The result of the operator.
/// </returns>
/// <exception cref="InvalidOperationException">
/// If currency types do not match
/// </exception>
public static bool operator <=(CurrencyAmount originalValue, CurrencyAmount amount)
{
ThrowIfMismatch(originalValue, amount, "<=");
return originalValue.Value <= amount.Value;
}
/// <summary>
/// Implements the operator <.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="amount">
/// The amount to subtract.
/// </param>
/// <returns>
/// The result of the operator.
/// </returns>
/// <exception cref="InvalidOperationException">
/// If currency types do not match
/// </exception>
public static bool operator <(CurrencyAmount originalValue, CurrencyAmount amount)
{
ThrowIfMismatch(originalValue, amount, "<");
return originalValue.Value < amount.Value;
}
/// <summary>
/// Implements the operator ==.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="amount">The amount.</param>
/// <returns>
/// The result of the operator.
/// </returns>
public static bool operator ==(CurrencyAmount originalValue, CurrencyAmount amount)
{
return originalValue.Equals(amount);
}
/// <summary>
/// Implements the operator !=.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <param name="amount">The amount.</param>
/// <returns>
/// The result of the operator.
/// </returns>
public static bool operator !=(CurrencyAmount originalValue, CurrencyAmount amount)
{
return !(originalValue == amount);
}
/// <summary>
/// Implements the operator -.
/// </summary>
/// <param name="originalValue">The original value.</param>
/// <returns>
/// The result of the operator.
/// </returns>
public static CurrencyAmount operator -(CurrencyAmount originalValue)
{
return new CurrencyAmount(originalValue.Currency, -originalValue.Value);
}
[DebuggerNonUserCode]
static void ThrowIfMismatch(CurrencyAmount originalValue, CurrencyAmount amount, string operationName)
{
if (originalValue.Currency == amount.Currency)
return;
var txt = string.Format("Can't apply the '{0}' operation to mismatching currencies '{1}' and '{2}'",
operationName, originalValue.Currency, amount.Currency);
throw new InvalidOperationException(txt);
}
}
}