@barchart/portfolio-api-common 1.2.125 → 1.2.126

package/lib/data/PositionSummaryFrame.js

@@ -243,27 +243,25 @@ module.exports = (() => {
 	function getMonthlyRanges(transactions) {
 		const ranges = [ ];
 
-		if (!transactions.length) {
-			return ranges;
-		}
-
-		const first = array.first(transactions);
-		const last = array.last(transactions);
+		if (transactions.length !== 0) {
+			const first = array.first(transactions);
+			const last = array.last(transactions);
 
-		const firstDate = first.date;
+			const firstDate = first.date;
 
-		let lastDate;
+			let lastDate;
 
-		if (last.snapshot.open.getIsZero()) {
-			lastDate = new Day(last.date.year, last.date.month, last.date.day).addMonths(1);
-		} else {
-			lastDate = Day.getToday();
-		}
+			if (last.snapshot.open.getIsZero()) {
+				lastDate = last.date;
+			} else {
+				lastDate = Day.getToday();
+			}
 
-		lastDate = lastDate.getEndOfMonth();
+			lastDate = lastDate.getEndOfMonth();
 
-		for (let end = firstDate.getEndOfMonth(); end.format() <= lastDate.format(); end = end.addMonths(1).getEndOfMonth()) {
-			ranges.push(getRange(end.subtractMonths(1).getEndOfMonth(), end));
+			for (let end = firstDate.getEndOfMonth(); !end.getIsAfter(lastDate); end = end.addMonths(1).getEndOfMonth()) {
+				ranges.push(getRange(end.subtractMonths(1).getEndOfMonth(), end));
+			}
 		}
 
 		return ranges;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.2.125",
+  "version": "1.2.126",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",

package/test/SpecRunner.js

@@ -634,27 +634,25 @@ module.exports = (() => {
 	function getMonthlyRanges(transactions) {
 		const ranges = [ ];
 
-		if (!transactions.length) {
-			return ranges;
-		}
-
-		const first = array.first(transactions);
-		const last = array.last(transactions);
+		if (transactions.length !== 0) {
+			const first = array.first(transactions);
+			const last = array.last(transactions);
 
-		const firstDate = first.date;
+			const firstDate = first.date;
 
-		let lastDate;
+			let lastDate;
 
-		if (last.snapshot.open.getIsZero()) {
-			lastDate = new Day(last.date.year, last.date.month, last.date.day).addMonths(1);
-		} else {
-			lastDate = Day.getToday();
-		}
+			if (last.snapshot.open.getIsZero()) {
+				lastDate = last.date;
+			} else {
+				lastDate = Day.getToday();
+			}
 
-		lastDate = lastDate.getEndOfMonth();
+			lastDate = lastDate.getEndOfMonth();
 
-		for (let end = firstDate.getEndOfMonth(); end.format() <= lastDate.format(); end = end.addMonths(1).getEndOfMonth()) {
-			ranges.push(getRange(end.subtractMonths(1).getEndOfMonth(), end));
+			for (let end = firstDate.getEndOfMonth(); !end.getIsAfter(lastDate); end = end.addMonths(1).getEndOfMonth()) {
+				ranges.push(getRange(end.subtractMonths(1).getEndOfMonth(), end));
+			}
 		}
 
 		return ranges;
@@ -17860,7 +17858,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and yearly position summary ranges are processed for a transaction set that opens in 2019 and closes in 2016, but has after-the-fact superfluous valuations in 2017 and 2018', () => {
+	describe('and yearly position summary ranges are processed for a transaction set that opens in 2015 and closes in 2016, but has after-the-fact superfluous valuations in 2017 and 2018', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -17913,6 +17911,120 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
+	describe('and monthly position summary ranges are processed for a transaction set that does not close', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2019, 1, 20),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				},
+				{
+					date: new Day(2019, 2, 21),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				}
+			];
+
+			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
+		});
+
+		it('should have at least two ranges', () => {
+			expect(ranges.length > 1).toEqual(true);
+		});
+
+		it('the first range should be from 12-31-2018 to 01-31-2019', () => {
+			expect(ranges[0].start.format()).toEqual('2018-12-31');
+			expect(ranges[0].end.format()).toEqual('2019-01-31');
+		});
+
+		it('the last range should be for the current month', () => {
+			const today = Day.getToday();
+
+			expect(ranges[ranges.length - 1].start.format()).toEqual(today.getEndOfMonth().subtractMonths(1).getEndOfMonth().format());
+			expect(ranges[ranges.length - 1].end.format()).toEqual(today.getEndOfMonth().format());
+		});
+	});
+
+	describe('and monthly position summary ranges are processed for a transaction set closes the same month', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2018, 12, 1),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				},
+				{
+					date: new Day(2018, 12, 31),
+					snapshot: {
+						open: new Decimal(0)
+					},
+					type: TransactionType.SELL
+				}
+			];
+
+			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
+		});
+
+		it('should have one range', () => {
+			expect(ranges.length).toEqual(1);
+		});
+
+		it('the first range should be from 11-30-2018 to 12-31-2018', () => {
+			expect(ranges[0].start.format()).toEqual('2018-11-30');
+			expect(ranges[0].end.format()).toEqual('2018-12-31');
+		});
+	});
+
+	describe('and monthly position summary ranges are processed for a transaction set closes the next month', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2015, 10, 20),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				},
+				{
+					date: new Day(2015, 11, 20),
+					snapshot: {
+						open: new Decimal(0)
+					},
+					type: TransactionType.SELL
+				}
+			];
+
+			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
+		});
+
+		it('should have two ranges', () => {
+			expect(ranges.length).toEqual(2);
+		});
+
+		it('the first range should be from 09-30-2015 to 10-31-2015', () => {
+			expect(ranges[0].start.format()).toEqual('2015-09-30');
+			expect(ranges[0].end.format()).toEqual('2015-10-31');
+		});
+
+		it('the second range should be from 10-31-2015 to 11-30-2015', () => {
+			expect(ranges[1].start.format()).toEqual('2015-10-31');
+			expect(ranges[1].end.format()).toEqual('2015-11-30');
+		});
+	});
+
 	describe('and a year-to-date position summary ranges are processed for a transaction set that closed in 2017', () => {
 		let ranges;
 

package/test/specs/data/PositionSummaryFrameSpec.js

@@ -173,7 +173,7 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
-	describe('and yearly position summary ranges are processed for a transaction set that opens in 2019 and closes in 2016, but has after-the-fact superfluous valuations in 2017 and 2018', () => {
+	describe('and yearly position summary ranges are processed for a transaction set that opens in 2015 and closes in 2016, but has after-the-fact superfluous valuations in 2017 and 2018', () => {
 		let ranges;
 
 		beforeEach(() => {
@@ -226,6 +226,120 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
+	describe('and monthly position summary ranges are processed for a transaction set that does not close', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2019, 1, 20),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				},
+				{
+					date: new Day(2019, 2, 21),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				}
+			];
+
+			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
+		});
+
+		it('should have at least two ranges', () => {
+			expect(ranges.length > 1).toEqual(true);
+		});
+
+		it('the first range should be from 12-31-2018 to 01-31-2019', () => {
+			expect(ranges[0].start.format()).toEqual('2018-12-31');
+			expect(ranges[0].end.format()).toEqual('2019-01-31');
+		});
+
+		it('the last range should be for the current month', () => {
+			const today = Day.getToday();
+
+			expect(ranges[ranges.length - 1].start.format()).toEqual(today.getEndOfMonth().subtractMonths(1).getEndOfMonth().format());
+			expect(ranges[ranges.length - 1].end.format()).toEqual(today.getEndOfMonth().format());
+		});
+	});
+
+	describe('and monthly position summary ranges are processed for a transaction set closes the same month', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2018, 12, 1),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				},
+				{
+					date: new Day(2018, 12, 31),
+					snapshot: {
+						open: new Decimal(0)
+					},
+					type: TransactionType.SELL
+				}
+			];
+
+			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
+		});
+
+		it('should have one range', () => {
+			expect(ranges.length).toEqual(1);
+		});
+
+		it('the first range should be from 11-30-2018 to 12-31-2018', () => {
+			expect(ranges[0].start.format()).toEqual('2018-11-30');
+			expect(ranges[0].end.format()).toEqual('2018-12-31');
+		});
+	});
+
+	describe('and monthly position summary ranges are processed for a transaction set closes the next month', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2015, 10, 20),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				},
+				{
+					date: new Day(2015, 11, 20),
+					snapshot: {
+						open: new Decimal(0)
+					},
+					type: TransactionType.SELL
+				}
+			];
+
+			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
+		});
+
+		it('should have two ranges', () => {
+			expect(ranges.length).toEqual(2);
+		});
+
+		it('the first range should be from 09-30-2015 to 10-31-2015', () => {
+			expect(ranges[0].start.format()).toEqual('2015-09-30');
+			expect(ranges[0].end.format()).toEqual('2015-10-31');
+		});
+
+		it('the second range should be from 10-31-2015 to 11-30-2015', () => {
+			expect(ranges[1].start.format()).toEqual('2015-10-31');
+			expect(ranges[1].end.format()).toEqual('2015-11-30');
+		});
+	});
+
 	describe('and a year-to-date position summary ranges are processed for a transaction set that closed in 2017', () => {
 		let ranges;