bond_calculator 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +17 -0
  3. data/.ruby-version +1 -0
  4. data/CHANGELOG.md +5 -0
  5. data/Gemfile +6 -0
  6. data/LICENSE.txt +7 -0
  7. data/README.md +78 -0
  8. data/Rakefile +13 -0
  9. data/bin/console +10 -0
  10. data/bond_calculator.gemspec +30 -0
  11. data/doc/BondCalculator.html +140 -0
  12. data/doc/BondCalculator/BaseCalculator.html +480 -0
  13. data/doc/BondCalculator/Bond.html +693 -0
  14. data/doc/BondCalculator/SpreadToBenchmark.html +567 -0
  15. data/doc/BondCalculator/SpreadToCurve.html +475 -0
  16. data/doc/_index.html +143 -0
  17. data/doc/class_list.html +51 -0
  18. data/doc/css/common.css +1 -0
  19. data/doc/css/full_list.css +58 -0
  20. data/doc/css/style.css +492 -0
  21. data/doc/file.README.html +133 -0
  22. data/doc/file_list.html +56 -0
  23. data/doc/frames.html +17 -0
  24. data/doc/index.html +133 -0
  25. data/doc/js/app.js +248 -0
  26. data/doc/js/full_list.js +216 -0
  27. data/doc/js/jquery.js +4 -0
  28. data/doc/method_list.html +155 -0
  29. data/doc/top-level-namespace.html +110 -0
  30. data/lib/bond_calculator.rb +7 -0
  31. data/lib/bond_calculator/base_calculator.rb +37 -0
  32. data/lib/bond_calculator/bond.rb +48 -0
  33. data/lib/bond_calculator/spread_to_benchmark.rb +77 -0
  34. data/lib/bond_calculator/spread_to_curve.rb +64 -0
  35. data/lib/bond_calculator/version.rb +5 -0
  36. data/test/bond_calculator/base_calculator_test.rb +31 -0
  37. data/test/bond_calculator/bond_calculator_test.rb +9 -0
  38. data/test/bond_calculator/bond_test.rb +24 -0
  39. data/test/bond_calculator/spread_to_benchmark_test.rb +33 -0
  40. data/test/bond_calculator/spread_to_curve_test.rb +37 -0
  41. data/test/fixtures/c1.csv +4 -0
  42. data/test/fixtures/c2.csv +14 -0
  43. data/test/test_helper.rb +7 -0
  44. metadata +191 -0
@@ -0,0 +1,567 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: BondCalculator::SpreadToBenchmark
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "BondCalculator::SpreadToBenchmark";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../BondCalculator.html" title="BondCalculator (module)">BondCalculator</a></span></span>
41
+ &raquo;
42
+ <span class="title">SpreadToBenchmark</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: BondCalculator::SpreadToBenchmark
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="BaseCalculator.html" title="BondCalculator::BaseCalculator (class)">BaseCalculator</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="BaseCalculator.html" title="BondCalculator::BaseCalculator (class)">BaseCalculator</a></span></li>
78
+
79
+ <li class="next">BondCalculator::SpreadToBenchmark</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/bond_calculator/spread_to_benchmark.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>Class that handle the calculation of the spread to benchmark Calculate the
108
+ yield spread (return) between a corporate bond and its government bond
109
+ benchmark.</p>
110
+
111
+ <p>A government bond is a good benchmark if it is as close as possible to the
112
+ corporate bond in terms of years to maturity (term).</p>
113
+
114
+
115
+ </div>
116
+ </div>
117
+ <div class="tags">
118
+
119
+ <p class="tag_title">Author:</p>
120
+ <ul class="author">
121
+
122
+ <li>
123
+
124
+
125
+
126
+
127
+
128
+ <div class='inline'>
129
+ <p>Lucas Sant&#39; Anna</p>
130
+ </div>
131
+
132
+ </li>
133
+
134
+ </ul>
135
+ <p class="tag_title">Since:</p>
136
+ <ul class="since">
137
+
138
+ <li>
139
+
140
+
141
+
142
+
143
+
144
+ <div class='inline'>
145
+ <p>0.0.1</p>
146
+ </div>
147
+
148
+ </li>
149
+
150
+ </ul>
151
+
152
+ </div>
153
+
154
+
155
+
156
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
157
+ <ul class="summary">
158
+
159
+ <li class="public ">
160
+ <span class="summary_signature">
161
+
162
+ <a href="#bonds-instance_method" title="#bonds (instance method)">#<strong>bonds</strong> &#x21d2; Object </a>
163
+
164
+
165
+
166
+ </span>
167
+
168
+
169
+
170
+
171
+ <span class="note title readonly">readonly</span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <span class="summary_desc"><div class='inline'></div></span>
182
+
183
+ </li>
184
+
185
+
186
+ </ul>
187
+
188
+
189
+
190
+
191
+
192
+ <h2>
193
+ Instance Method Summary
194
+ <small><a href="#" class="summary_toggle">collapse</a></small>
195
+ </h2>
196
+
197
+ <ul class="summary">
198
+
199
+ <li class="public ">
200
+ <span class="summary_signature">
201
+
202
+ <a href="#calculate-instance_method" title="#calculate (instance method)">#<strong>calculate</strong> &#x21d2; Hash </a>
203
+
204
+
205
+
206
+ </span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <span class="summary_desc"><div class='inline'>
217
+ <p>Execute the bussines rule to calculate the spread to Benchmark.</p>
218
+ </div></span>
219
+
220
+ </li>
221
+
222
+
223
+ <li class="public ">
224
+ <span class="summary_signature">
225
+
226
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(bond_file_path) &#x21d2; &lt;void&gt; </a>
227
+
228
+
229
+
230
+ </span>
231
+
232
+
233
+ <span class="note title constructor">constructor</span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+ <span class="summary_desc"><div class='inline'></div></span>
243
+
244
+ </li>
245
+
246
+
247
+ </ul>
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseCalculator.html" title="BondCalculator::BaseCalculator (class)">BaseCalculator</a></span></h3>
260
+ <p class="inherited"><span class='object_link'><a href="BaseCalculator.html#bonds_by_type-instance_method" title="BondCalculator::BaseCalculator#bonds_by_type (method)">#bonds_by_type</a></span>, <span class='object_link'><a href="BaseCalculator.html#csv_to_bonds-instance_method" title="BondCalculator::BaseCalculator#csv_to_bonds (method)">#csv_to_bonds</a></span></p>
261
+ <div id="constructor_details" class="method_details_list">
262
+ <h2>Constructor Details</h2>
263
+
264
+ <div class="method_details first">
265
+ <h3 class="signature first" id="initialize-instance_method">
266
+
267
+ #<strong>initialize</strong>(bond_file_path) &#x21d2; <tt>&lt;void&gt;</tt>
268
+
269
+
270
+
271
+
272
+
273
+ </h3><div class="docstring">
274
+ <div class="discussion">
275
+
276
+
277
+ </div>
278
+ </div>
279
+ <div class="tags">
280
+ <p class="tag_title">Parameters:</p>
281
+ <ul class="param">
282
+
283
+ <li>
284
+
285
+ <span class='name'>bond_file_path</span>
286
+
287
+
288
+ <span class='type'>(<tt>File</tt>)</span>
289
+
290
+
291
+
292
+ &mdash;
293
+ <div class='inline'>
294
+ <p>Csv benchmark file path</p>
295
+ </div>
296
+
297
+ </li>
298
+
299
+ </ul>
300
+
301
+ <p class="tag_title">Since:</p>
302
+ <ul class="since">
303
+
304
+ <li>
305
+
306
+
307
+
308
+
309
+
310
+ <div class='inline'>
311
+ <p>0.0.1</p>
312
+ </div>
313
+
314
+ </li>
315
+
316
+ </ul>
317
+
318
+ </div><table class="source_code">
319
+ <tr>
320
+ <td>
321
+ <pre class="lines">
322
+
323
+
324
+ 21
325
+ 22
326
+ 23</pre>
327
+ </td>
328
+ <td>
329
+ <pre class="code"><span class="info file"># File 'lib/bond_calculator/spread_to_benchmark.rb', line 21</span>
330
+
331
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_bond_file_path'>bond_file_path</span><span class='rparen'>)</span>
332
+ <span class='ivar'>@bonds</span> <span class='op'>=</span> <span class='id identifier rubyid_csv_to_bonds'>csv_to_bonds</span><span class='lparen'>(</span><span class='id identifier rubyid_bond_file_path'>bond_file_path</span><span class='rparen'>)</span>
333
+ <span class='kw'>end</span></pre>
334
+ </td>
335
+ </tr>
336
+ </table>
337
+ </div>
338
+
339
+ </div>
340
+
341
+ <div id="instance_attr_details" class="attr_details">
342
+ <h2>Instance Attribute Details</h2>
343
+
344
+
345
+ <span id=""></span>
346
+ <div class="method_details first">
347
+ <h3 class="signature first" id="bonds-instance_method">
348
+
349
+ #<strong>bonds</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
350
+
351
+
352
+
353
+
354
+
355
+ </h3><div class="docstring">
356
+ <div class="discussion">
357
+
358
+
359
+ </div>
360
+ </div>
361
+ <div class="tags">
362
+
363
+ <p class="tag_title">Since:</p>
364
+ <ul class="since">
365
+
366
+ <li>
367
+
368
+
369
+
370
+
371
+
372
+ <div class='inline'>
373
+ <p>0.0.1</p>
374
+ </div>
375
+
376
+ </li>
377
+
378
+ </ul>
379
+
380
+ </div><table class="source_code">
381
+ <tr>
382
+ <td>
383
+ <pre class="lines">
384
+
385
+
386
+ 16
387
+ 17
388
+ 18</pre>
389
+ </td>
390
+ <td>
391
+ <pre class="code"><span class="info file"># File 'lib/bond_calculator/spread_to_benchmark.rb', line 16</span>
392
+
393
+ <span class='kw'>def</span> <span class='id identifier rubyid_bonds'>bonds</span>
394
+ <span class='ivar'>@bonds</span>
395
+ <span class='kw'>end</span></pre>
396
+ </td>
397
+ </tr>
398
+ </table>
399
+ </div>
400
+
401
+ </div>
402
+
403
+
404
+ <div id="instance_method_details" class="method_details_list">
405
+ <h2>Instance Method Details</h2>
406
+
407
+
408
+ <div class="method_details first">
409
+ <h3 class="signature first" id="calculate-instance_method">
410
+
411
+ #<strong>calculate</strong> &#x21d2; <tt>Hash</tt>
412
+
413
+
414
+
415
+
416
+
417
+ </h3><div class="docstring">
418
+ <div class="discussion">
419
+
420
+ <p>Execute the bussines rule to calculate the spread to Benchmark</p>
421
+
422
+
423
+ </div>
424
+ </div>
425
+ <div class="tags">
426
+
427
+ <p class="tag_title">Returns:</p>
428
+ <ul class="return">
429
+
430
+ <li>
431
+
432
+
433
+ <span class='type'>(<tt>Hash</tt>)</span>
434
+
435
+
436
+
437
+ &mdash;
438
+ <div class='inline'>
439
+ <p>:bond_name</p>
440
+ </div>
441
+
442
+ </li>
443
+
444
+ <li>
445
+
446
+
447
+ <span class='type'>(<tt>Hash</tt>)</span>
448
+
449
+
450
+
451
+ &mdash;
452
+ <div class='inline'>
453
+ <p>:benchmark_name</p>
454
+ </div>
455
+
456
+ </li>
457
+
458
+ <li>
459
+
460
+
461
+ <span class='type'>(<tt>Hash</tt>)</span>
462
+
463
+
464
+
465
+ &mdash;
466
+ <div class='inline'>
467
+ <p>:spread_to_benchmark</p>
468
+ </div>
469
+
470
+ </li>
471
+
472
+ </ul>
473
+ <p class="tag_title">Since:</p>
474
+ <ul class="since">
475
+
476
+ <li>
477
+
478
+
479
+
480
+
481
+
482
+ <div class='inline'>
483
+ <p>0.0.1</p>
484
+ </div>
485
+
486
+ </li>
487
+
488
+ </ul>
489
+
490
+ </div><table class="source_code">
491
+ <tr>
492
+ <td>
493
+ <pre class="lines">
494
+
495
+
496
+ 29
497
+ 30
498
+ 31
499
+ 32
500
+ 33
501
+ 34
502
+ 35
503
+ 36
504
+ 37
505
+ 38
506
+ 39
507
+ 40
508
+ 41
509
+ 42
510
+ 43
511
+ 44
512
+ 45
513
+ 46
514
+ 47
515
+ 48
516
+ 49
517
+ 50
518
+ 51
519
+ 52
520
+ 53</pre>
521
+ </td>
522
+ <td>
523
+ <pre class="code"><span class="info file"># File 'lib/bond_calculator/spread_to_benchmark.rb', line 29</span>
524
+
525
+ <span class='kw'>def</span> <span class='id identifier rubyid_calculate'>calculate</span>
526
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
527
+ <span class='id identifier rubyid_corps'>corps</span> <span class='op'>=</span> <span class='id identifier rubyid_bonds_by_type'>bonds_by_type</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>corporate</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='ivar'>@bonds</span><span class='rparen'>)</span>
528
+ <span class='id identifier rubyid_govs'>govs</span> <span class='op'>=</span> <span class='id identifier rubyid_bonds_by_type'>bonds_by_type</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>government</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='ivar'>@bonds</span><span class='rparen'>)</span>
529
+
530
+ <span class='id identifier rubyid_corps'>corps</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_corp'>corp</span><span class='op'>|</span>
531
+ <span class='id identifier rubyid_benchmark'>benchmark</span> <span class='op'>=</span> <span class='kw'>nil</span>
532
+ <span class='id identifier rubyid_govs'>govs</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_gov'>gov</span><span class='op'>|</span>
533
+ <span class='kw'>if</span> <span class='id identifier rubyid_benchmark'>benchmark</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
534
+ <span class='id identifier rubyid_benchmark'>benchmark</span> <span class='op'>=</span> <span class='id identifier rubyid_best_benchmark'>best_benchmark</span><span class='lparen'>(</span><span class='id identifier rubyid_corp'>corp</span><span class='comma'>,</span> <span class='id identifier rubyid_gov'>gov</span><span class='rparen'>)</span>
535
+ <span class='kw'>next</span>
536
+ <span class='kw'>end</span>
537
+ <span class='kw'>if</span> <span class='id identifier rubyid_benchmark'>benchmark</span><span class='lbracket'>[</span><span class='symbol'>:term_spread</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id identifier rubyid_term_spread'>term_spread</span><span class='lparen'>(</span><span class='id identifier rubyid_corp'>corp</span><span class='comma'>,</span> <span class='id identifier rubyid_gov'>gov</span><span class='rparen'>)</span>
538
+ <span class='id identifier rubyid_benchmark'>benchmark</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_best_benchmark'>best_benchmark</span><span class='lparen'>(</span><span class='id identifier rubyid_corp'>corp</span><span class='comma'>,</span> <span class='id identifier rubyid_gov'>gov</span><span class='rparen'>)</span><span class='rparen'>)</span>
539
+ <span class='kw'>end</span>
540
+ <span class='kw'>end</span>
541
+
542
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>&lt;&lt;</span> <span class='lbrace'>{</span> <span class='label'>bond_name:</span> <span class='id identifier rubyid_corp'>corp</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
543
+ <span class='label'>benchmark_name:</span> <span class='id identifier rubyid_benchmark'>benchmark</span><span class='lbracket'>[</span><span class='symbol'>:candidate</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
544
+ <span class='label'>spread_to_benchmark:</span> <span class='id identifier rubyid_spread_to_benchmark'>spread_to_benchmark</span><span class='lparen'>(</span><span class='id identifier rubyid_benchmark'>benchmark</span><span class='comma'>,</span> <span class='id identifier rubyid_corp'>corp</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
545
+ <span class='kw'>end</span>
546
+ <span class='id identifier rubyid_print'>print</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
547
+
548
+ <span class='id identifier rubyid_response'>response</span>
549
+ <span class='kw'>end</span></pre>
550
+ </td>
551
+ </tr>
552
+ </table>
553
+ </div>
554
+
555
+ </div>
556
+
557
+ </div>
558
+
559
+ <div id="footer">
560
+ Generated on Mon Sep 25 23:31:15 2017 by
561
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
562
+ 0.9.9 (ruby-2.4.0).
563
+ </div>
564
+
565
+ </div>
566
+ </body>
567
+ </html>