@barchart/portfolio-api-common 1.2.113 → 1.2.114

package/lib/data/PositionSummaryFrame.js

@@ -241,7 +241,32 @@ module.exports = (() => {
 	}
 
 	function getMonthlyRanges(transactions) {
-		return [ ];
+    const ranges = [ ];
+    
+    if (!transactions.length) {
+    	return ranges;
+		}
+
+		const first = array.first(transactions);
+		const last = array.last(transactions);
+
+		const firstDate = first.date;
+		let lastDate;
+
+		lastDate = last.snapshot.open.getIsZero()
+			? new Day(last.date.year, last.date.month, last.date.day).addMonths(1)
+			: Day.getToday();
+		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));
+		}
+    
+    return ranges;
 	}
 
 	function getYearToDateRanges(transactions) {
@@ -278,7 +303,11 @@ module.exports = (() => {
 	}
 
 	function getMonthlyStartDate(periods, date) {
-		return null;
+    const today = date || Day.getToday();
+    
+		return today
+			.subtractMonths(periods)
+			.subtractDays(today.day);
 	}
 
 	function getYearToDateStartDate(periods, date) {

package/package.json

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

package/test/SpecRunner.js

@@ -632,7 +632,32 @@ module.exports = (() => {
 	}
 
 	function getMonthlyRanges(transactions) {
-		return [ ];
+    const ranges = [ ];
+    
+    if (!transactions.length) {
+    	return ranges;
+		}
+
+		const first = array.first(transactions);
+		const last = array.last(transactions);
+
+		const firstDate = first.date;
+		let lastDate;
+
+		lastDate = last.snapshot.open.getIsZero()
+			? new Day(last.date.year, last.date.month, last.date.day).addMonths(1)
+			: Day.getToday();
+		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));
+		}
+    
+    return ranges;
 	}
 
 	function getYearToDateRanges(transactions) {
@@ -669,7 +694,11 @@ module.exports = (() => {
 	}
 
 	function getMonthlyStartDate(periods, date) {
-		return null;
+    const today = date || Day.getToday();
+    
+		return today
+			.subtractMonths(periods)
+			.subtractDays(today.day);
 	}
 
 	function getYearToDateStartDate(periods, date) {
@@ -6311,6 +6340,19 @@ module.exports = function () {
 				return this.addYears(years, true);
 			}
 
+			/**
+    * Returns a new Day instance for the end of the month of the current instance.
+    *
+    * @public
+    * @returns {Day}
+    */
+
+		}, {
+			key: 'getEndOfMonth',
+			value: function getEndOfMonth() {
+				return new Day(this.year, this.month, Day.getDaysInMonth(this.year, this.month));
+			}
+
 			/**
     * Indicates if another {@link Day} occurs before the current instance.
     *
@@ -10103,7 +10145,7 @@ module.exports = function () {
    * the schema.
    *
    * @public
-   * @param {data} data
+   * @param {Object} data
    * @returns {Object}
    */
 
@@ -10185,7 +10227,13 @@ module.exports = function () {
 				};
 
 				return function (key, value) {
-					return advance(key).reviver(value);
+					var item = advance(key);
+
+					if (key === '') {
+						return value;
+					} else {
+						return item.reviver(value);
+					}
 				};
 			}
 
@@ -17827,6 +17875,53 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
+
+
+	/////
+
+	describe('and month position summary ranges are processed for a transaction set that does not close', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2018, 10, 20),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				},
+				{
+					date: new Day(2018, 11, 21),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				}
+			];
+
+			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
+		});
+
+		it('should have 2 ranges (assuming the current year is 2018 and the current month is November)', () => {
+			expect(ranges.length).toEqual(2);
+		});
+
+		it('the first range should be from 2018-09-30 to 2018-10-31', () => {
+			expect(ranges[0].start.format()).toEqual('2018-09-30');
+			expect(ranges[0].end.format()).toEqual('2018-10-31');
+		});
+
+		it('the second range should be from 2018-10-31 to 2018-11-30', () => {
+      expect(ranges[1].start.format()).toEqual('2018-10-31');
+      expect(ranges[1].end.format()).toEqual('2018-11-30');
+		});
+	});
+
+	///////
+
+
+
 	describe('and getting the start date for yearly frames', () => {
 		describe('for one year ago', function() {
 			let start;
@@ -17869,6 +17964,55 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
+
+
+
+	////
+
+	describe('and getting the start date for monthly frames', () => {
+		describe('for one month ago', function () {
+			let start;
+
+			beforeEach(() => {
+				start = PositionSummaryFrame.MONTHLY.getStartDate(1);
+			});
+
+			it('should be on the last day of month', () => {
+				const today = Day.getToday();
+				
+				expect(start.day).toEqual(Day.getDaysInMonth(today.year, today.month - 2));
+			});
+
+			it('should be month ago', () => {
+				expect(start.month).toEqual(Day.getToday().month - 2);
+			});
+		});
+    
+    describe('for three months ago', function () {
+      let start;
+      
+      beforeEach(() => {
+        start = PositionSummaryFrame.MONTHLY.getStartDate(3);
+      });
+      
+      it('should be on the last day of month', () => {
+        const today = Day.getToday();
+        
+        expect(start.day).toEqual(Day.getDaysInMonth(today.year, today.month - 4));
+      });
+      
+      it('should be 3 month ago', () => {
+        expect(start.month).toEqual(Day.getToday().month - 4);
+      });
+    });
+	});
+
+	////
+
+
+
+
+
 	describe('and recent ranges are calculated', () => {
 		let todayYear;
 		let todayMonth;

package/test/specs/data/PositionSummaryFrameSpec.js

@@ -311,6 +311,53 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
+
+
+	/////
+
+	describe('and month position summary ranges are processed for a transaction set that does not close', () => {
+		let ranges;
+
+		beforeEach(() => {
+			const transactions = [
+				{
+					date: new Day(2018, 10, 20),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				},
+				{
+					date: new Day(2018, 11, 21),
+					snapshot: {
+						open: new Decimal(1)
+					},
+					type: TransactionType.BUY
+				}
+			];
+
+			ranges = PositionSummaryFrame.MONTHLY.getRanges(transactions);
+		});
+
+		it('should have 2 ranges (assuming the current year is 2018 and the current month is November)', () => {
+			expect(ranges.length).toEqual(2);
+		});
+
+		it('the first range should be from 2018-09-30 to 2018-10-31', () => {
+			expect(ranges[0].start.format()).toEqual('2018-09-30');
+			expect(ranges[0].end.format()).toEqual('2018-10-31');
+		});
+
+		it('the second range should be from 2018-10-31 to 2018-11-30', () => {
+      expect(ranges[1].start.format()).toEqual('2018-10-31');
+      expect(ranges[1].end.format()).toEqual('2018-11-30');
+		});
+	});
+
+	///////
+
+
+
 	describe('and getting the start date for yearly frames', () => {
 		describe('for one year ago', function() {
 			let start;
@@ -353,6 +400,55 @@ describe('After the PositionSummaryFrame enumeration is initialized', () => {
 		});
 	});
 
+
+
+
+	////
+
+	describe('and getting the start date for monthly frames', () => {
+		describe('for one month ago', function () {
+			let start;
+
+			beforeEach(() => {
+				start = PositionSummaryFrame.MONTHLY.getStartDate(1);
+			});
+
+			it('should be on the last day of month', () => {
+				const today = Day.getToday();
+				
+				expect(start.day).toEqual(Day.getDaysInMonth(today.year, today.month - 2));
+			});
+
+			it('should be month ago', () => {
+				expect(start.month).toEqual(Day.getToday().month - 2);
+			});
+		});
+    
+    describe('for three months ago', function () {
+      let start;
+      
+      beforeEach(() => {
+        start = PositionSummaryFrame.MONTHLY.getStartDate(3);
+      });
+      
+      it('should be on the last day of month', () => {
+        const today = Day.getToday();
+        
+        expect(start.day).toEqual(Day.getDaysInMonth(today.year, today.month - 4));
+      });
+      
+      it('should be 3 month ago', () => {
+        expect(start.month).toEqual(Day.getToday().month - 4);
+      });
+    });
+	});
+
+	////
+
+
+
+
+
 	describe('and recent ranges are calculated', () => {
 		let todayYear;
 		let todayMonth;