@barchart/portfolio-api-common 1.0.17 → 1.0.21

package/test/specs/data/PositionSummaryFrameSpec.js

@@ -0,0 +1,228 @@
+const Day = require('@barchart/common-js/lang/Day'),
+	Decimal = require('@barchart/common-js/lang/Decimal');
+
+const PositionSummaryFrame = require('./../../../lib/data/PositionSummaryFrame');
+
+describe('After the PositionSummaryFrame enumeration is initialized', () => {
+	'use strict';
+
+	describe('and yearly position summary ranges are processed for a transaction set that does not close', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2015, 10, 20)
+				},
+				{
+					date: new Day(2016, 11, 21),
+					snapshot: {
+						open: new Decimal(1)
+					}
+				}
+			];
+
+			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
+		});
+
+		it('should have three ranges (assuming the current year is 2018)', () => {
+			expect(ranges.length).toEqual(3);
+		});
+
+		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
+			expect(ranges[0].start.format()).toEqual('2014-12-31');
+			expect(ranges[0].end.format()).toEqual('2015-12-31');
+		});
+
+		it('the second range should be from 12-31-2015 to 12-31-2016', () => {
+			expect(ranges[1].start.format()).toEqual('2015-12-31');
+			expect(ranges[1].end.format()).toEqual('2016-12-31');
+		});
+
+		it('the third range should be from 12-31-2016 to 12-31-2017', () => {
+			expect(ranges[2].start.format()).toEqual('2016-12-31');
+			expect(ranges[2].end.format()).toEqual('2017-12-31');
+		});
+	});
+
+	describe('and yearly position summary ranges are processed for a transaction set closes the same year', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2015, 10, 20)
+				},
+				{
+					date: new Day(2015, 11, 21),
+					snapshot: {
+						open: new Decimal(0)
+					}
+				}
+			];
+
+			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
+		});
+
+		it('should have one range', () => {
+			expect(ranges.length).toEqual(1);
+		});
+
+		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
+			expect(ranges[0].start.format()).toEqual('2014-12-31');
+			expect(ranges[0].end.format()).toEqual('2015-12-31');
+		});
+	});
+
+	describe('and yearly position summary ranges are processed for a transaction set closes the next year', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2015, 10, 20)
+				},
+				{
+					date: new Day(2016, 11, 21),
+					snapshot: {
+						open: new Decimal(0)
+					}
+				}
+			];
+
+			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
+		});
+
+		it('should have two ranges', () => {
+			expect(ranges.length).toEqual(2);
+		});
+
+		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
+			expect(ranges[0].start.format()).toEqual('2014-12-31');
+			expect(ranges[0].end.format()).toEqual('2015-12-31');
+		});
+
+		it('the second range should be from 12-31-2015 to 12-31-2016', () => {
+			expect(ranges[1].start.format()).toEqual('2015-12-31');
+			expect(ranges[1].end.format()).toEqual('2016-12-31');
+		});
+	});
+
+	describe('and yearly position summary ranges are processed for a transaction set closes in the current next year -- assuming its 2018', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2015, 10, 20)
+				},
+				{
+					date: new Day(2017, 11, 21),
+					snapshot: {
+						open: new Decimal(0)
+					}
+				}
+			];
+
+			ranges = PositionSummaryFrame.YEARLY.getRanges(transactions);
+		});
+
+		it('should have two ranges', () => {
+			expect(ranges.length).toEqual(3);
+		});
+
+		it('the first range should be from 12-31-2014 to 12-31-2015', () => {
+			expect(ranges[0].start.format()).toEqual('2014-12-31');
+			expect(ranges[0].end.format()).toEqual('2015-12-31');
+		});
+
+		it('the second range should be from 12-31-2015 to 12-31-2016', () => {
+			expect(ranges[1].start.format()).toEqual('2015-12-31');
+			expect(ranges[1].end.format()).toEqual('2016-12-31');
+		});
+
+		it('the third range should be from 12-31-2015 to 12-31-2016', () => {
+			expect(ranges[2].start.format()).toEqual('2016-12-31');
+			expect(ranges[2].end.format()).toEqual('2017-12-31');
+		});
+	});
+
+	describe('and a year-to-date position summary ranges are processed for a transaction set that closed last year', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2017, 1, 1)
+				},
+				{
+					date: new Day(2017, 1, 2),
+					snapshot: {
+						open: new Decimal(0)
+					}
+				}
+			];
+
+			ranges = PositionSummaryFrame.YTD.getRanges(transactions);
+		});
+
+		it('should have no ranges', () => {
+			expect(ranges.length).toEqual(0);
+		});
+	});
+
+	describe('and a year-to-date position summary ranges are processed for a transaction set that opened this year and has not yet closed', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2018, 1, 1),
+					snapshot: {
+						open: new Decimal(0)
+					}
+				}
+			];
+
+			ranges = PositionSummaryFrame.YTD.getRanges(transactions);
+		});
+
+		it('should have one range', () => {
+			expect(ranges.length).toEqual(1);
+		});
+
+		it('the first range should be from 12-31-2017 to 12-31-2015', () => {
+			expect(ranges[0].start.format()).toEqual('2017-12-31');
+			expect(ranges[0].end.format()).toEqual('2018-12-31');
+		});
+	});
+
+	describe('and a year-to-date position summary ranges are processed for a transaction set that opened and closed this year', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2018, 1, 1)
+				},
+				{
+					date: new Day(2018, 1, 2),
+					snapshot: {
+						open: new Decimal(0)
+					}
+				}
+			];
+
+			ranges = PositionSummaryFrame.YTD.getRanges(transactions);
+		});
+
+		it('should have one range', () => {
+			expect(ranges.length).toEqual(1);
+		});
+
+		it('the first range should be from 12-31-2017 to 12-31-2015', () => {
+			expect(ranges[0].start.format()).toEqual('2017-12-31');
+			expect(ranges[0].end.format()).toEqual('2018-12-31');
+		});
+	});
+});