diff --git a/.all-contributorsrc b/.all-contributorsrc
index b592af0..64806ba 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -37,6 +37,24 @@
"code",
"doc"
]
+ },
+ {
+ "login": "senpl",
+ "name": "Michał Urbanek",
+ "avatar_url": "https://avatars.githubusercontent.com/u/5415941?v=4",
+ "profile": "https://github.com/senpl",
+ "contributions": [
+ "bug"
+ ]
+ },
+ {
+ "login": "willemlarsen",
+ "name": "Willem Larsen",
+ "avatar_url": "https://avatars.githubusercontent.com/u/3875136?v=4",
+ "profile": "http://thermodynamicsofemotion.com/",
+ "contributions": [
+ "doc"
+ ]
}
],
"contributorsPerLine": 7,
diff --git a/.reset-files/3_third-form.js b/.reset-files/3_third-form.js
index 0aa7f65..637bee4 100644
--- a/.reset-files/3_third-form.js
+++ b/.reset-files/3_third-form.js
@@ -1,3 +1,4 @@
+// eslint-disable-next-line
const jsforms = (function () {
'use strict';
diff --git a/.reset-files/4_test-dummy-form.test.js b/.reset-files/4_test-dummy-form.test.js
index 4b09fce..beb48e9 100644
--- a/.reset-files/4_test-dummy-form.test.js
+++ b/.reset-files/4_test-dummy-form.test.js
@@ -29,22 +29,22 @@ describe('Test Dummy Form - Costume Shop Sales', function () {
let salesReporter;
beforeEach(function () {
- pointOfSaleDataUtilsFactory = pointOfSaleDataUtilsFactoryBuilder();
+ pointOfSaleDataUtilsFactory = pointOfSaleDataUtilityFactoryBuilder();
});
describe('Point of Sale Data Utilities', function () {
- describe('get product count by sale', function () {
-
- let pointOfSaleDataUtilities;
- let transactionStatuses;
- let testData;
-
- beforeEach(function(){
- testData = buildSimpleTestData();
- transactionStatuses = buildTransactionStatuses();
- pointOfSaleDataUtilities = pointOfSaleDataUtilsFactory(transactionStatuses);
- });
+ // File being tested can be found here:
+ // ../jsforms-source/4_test-dummy-form/pos-transaction-services/pointOfSaleDataUtilsFactory.js
+
+ let pointOfSaleDataUtilities;
+ let transactionStatuses;
+
+ beforeEach(function () {
+ transactionStatuses = buildTransactionStatuses();
+ pointOfSaleDataUtilities = pointOfSaleDataUtilsFactory(transactionStatuses);
+ });
+ describe('get product count by sale', function () {
it('returns an empty object for sale counts if no sale data exists');
it('returns an object with a single count of 1 when only one item, quantity 1 was purchased');
@@ -64,22 +64,24 @@ describe('Test Dummy Form - Costume Shop Sales', function () {
});
});
- describe('sales report', function () {
+ describe('get report', function () {
+ // files being tested are:
+ // ../jsforms-source/4_test-dummy-form/sales-reporter/salesReporterFactory.js
+ // ../jsforms-source/4_test-dummy-form/pos-transaction-services/reportDataBuilder.js
describe('get sales report', function () {
- it('returns a sales report with no sales');
+ it('returns a report of sales with no sales');
- it('returns a sales report with one sale');
+ it('returns a report of sales with one sale');
- it('returns a sales report with two sales of different products');
+ it('returns a report of sales with two sales of different products');
- it('returns a sales report with two sales of the same product');
+ it('returns a report of sales with two sales of the same product');
- it('returns a sales report with no "returns" data');
+ it('returns a report of sales excluding any return transactions');
});
- });
- describe('returns report', function () {
- it('returns a "returns" report with no "sales" data');
+ describe('get returns report', function () {
+ it('returns a report of return transactions that excludes sales transactions');
+ });
});
-
});
diff --git a/.reset-files/6_async-test-dummy-form.test.js b/.reset-files/6_async-test-dummy-form.test.js
index a2ea074..9968543 100644
--- a/.reset-files/6_async-test-dummy-form.test.js
+++ b/.reset-files/6_async-test-dummy-form.test.js
@@ -1,17 +1,27 @@
-/* global httpService, pluginApi, asyncContacts */
+/*
+global
+
+asyncContacts,
+chai,
+httpService,
+pluginApi
+*/
'use strict';
-describe('Test Dummy Form', function () {
+describe('Async Test Dummy Form', function () {
let contactService;
+ let responseData;
beforeEach(function () {
+ responseData = {};
+
const httpInstance = httpService();
const contactServiceInstance = contactService(httpInstance);
const pluginApiInstance = pluginApi();
-
- return asyncContacts(contactServiceInstance, pluginApiInstance);
+
+ asyncContacts(contactServiceInstance, pluginApiInstance);
});
// For this first suite of tests, we are going to work with comparing strings
@@ -23,7 +33,7 @@ describe('Test Dummy Form', function () {
it('should return 0 when two values are equal');
// Equality checking is one of the most common ways to test
- // the results of code, so it's important to get comnfortable with it
+ // the results of code, so it's important to get comfortable with it
it('should return -1 when name1 comes before name2 alphabetically');
// It's important to test all cases. The function, compareNames, has
@@ -31,7 +41,6 @@ describe('Test Dummy Form', function () {
// is to test until you're bored. Ideally, being bored will come at
// about the same time you've tested all cases.
it('should return 1 when name1 comes after name2 alphabetically');
-
});
// Our second suite of tests will validate the behavior of a record comparison
@@ -60,7 +69,6 @@ describe('Test Dummy Form', function () {
// We could use the same record from the previous test to run this test case as well
// If this generates duplicate code, how would we resolve that?
it('should return 1 when last names are equal and record1.firstName comes after record3.firstName alphabetically');
-
});
describe('sortByContactName', function () {
@@ -75,7 +83,6 @@ describe('Test Dummy Form', function () {
// sortByContactName always returns an array, so a calling function
// doesn't fail on a type error
it('should return an empty array if passed argument is not an array');
-
});
describe('getContactNames', function () {
@@ -83,7 +90,7 @@ describe('Test Dummy Form', function () {
// To fix this issue you will need to understand how the Mockery
// library works. The beforeEach at the very top of this test will
// give you a place to start.
- // Assert has a method "doesNothThrow." This would be quite useful here
+ // Assert has a method "doesNotThrow." This would be quite useful here
it('should not throw error immediately when called');
// Sinon is a library built for handling cases where you want to get a view
diff --git a/FORMS.md b/FORMS.md
index 8900c60..b33100b 100644
--- a/FORMS.md
+++ b/FORMS.md
@@ -13,8 +13,9 @@
1. [First Form](./docs/FIRST-FORM.md)
2. [Second Form](./docs/SECOND-FORM.md)
3. [Third Form](./docs/THIRD-FORM.md)
-3. [Test Dummy Form](./docs/TEST-DUMMY-FORM.md)
-
+4. [Test Dummy Form](./docs/TEST-DUMMY-FORM.md)
+5. Async Form _TBD_
+6. Async Test Dummy Form _TBD_
diff --git a/README.md b/README.md
index d25d55d..a6cf0c5 100644
--- a/README.md
+++ b/README.md
@@ -79,15 +79,15 @@ For a video walkthrough of the setup process, check out the following video:
### Solving Each Form ###
-1. [Documentation For all Forms](https://github.com/jason-kerney/jsLearnerForms/blob/documentation/FORMS.md)
+1. [Documentation For all Forms](https://github.com/cmstead/jsLearnerForms/blob/documentation/FORMS.md)
2. First Form -- Write code to pass each test
- 1. [First Form Documentation](https://github.com/jason-kerney/jsLearnerForms/blob/documentation/docs/FIRST-FORM.md)
+ 1. [First Form Documentation](https://github.com/cmstead/jsLearnerForms/blob/documentation/docs/FIRST-FORM.md)
3. Second Form -- Update code to pass new tests, keep old tests green
- 1. [Second Form Documentation](https://github.com/jason-kerney/jsLearnerForms/blob/documentation/docs/SECOND-FORM.md)
+ 1. [Second Form Documentation](https://github.com/cmstead/jsLearnerForms/blob/documentation/docs/SECOND-FORM.md)
4. Third Form -- Update code to pass new tests, keep tests old green
- 1. [Third Form Documentation](https://github.com/jason-kerney/jsLearnerForms/blob/documentation/docs/THIRD-FORM.md)
+ 1. [Third Form Documentation](https://github.com/cmstead/jsLearnerForms/blob/documentation/docs/THIRD-FORM.md)
5. Test Dummy Form (Fourth Form) -- Write tests matching each description and get all of the code under test (modify ONLY the test code)
- 1. [Test Dummy Form Documentation](https://github.com/jason-kerney/jsLearnerForms/blob/documentation/docs/TEST-DUMMY-FORM.md) **Incomplete**
+ 1. [Test Dummy Form Documentation](https://github.com/cmstead/jsLearnerForms/blob/documentation/docs/TEST-DUMMY-FORM.md)
6. Async Form -- Write code to pass each test; don't forget the refactoring steps!
1. Documentation TBD
7. Async Test Dummy Form (Sixth Form) -- Write tests matching each description and get all of the code under test (modify ONLY the test code)
@@ -174,6 +174,8 @@ This section will be updated as forms are completed and ready for use.
hunterinderstries
💵 |
EDF Renewables
💵 |
Jason Kerney
💻 📖 |
+ 
Michał Urbanek
🐛 |
+ 
Willem Larsen
📖 |
diff --git a/docs-source/forms-source/form1-doc/_main.md b/docs-source/forms-source/form1-doc/_main.md
index 676a4d1..5765090 100644
--- a/docs-source/forms-source/form1-doc/_main.md
+++ b/docs-source/forms-source/form1-doc/_main.md
@@ -9,16 +9,15 @@
You can also look at [JS Learner Forms documentation](../FORMS.md) for other forms.
You will be working in then [jsforms-source/1_first-form.js](..\jsforms-source\1_first-form.js) file.
-
\ No newline at end of file
diff --git a/docs-source/forms-source/form1-doc/arrays/_main.md b/docs-source/forms-source/form1-doc/arrays/_main.md
new file mode 100644
index 0000000..36d35d7
--- /dev/null
+++ b/docs-source/forms-source/form1-doc/arrays/_main.md
@@ -0,0 +1,11 @@
+
+
+You will use functions to work with arrays and loops.
+
\ No newline at end of file
diff --git a/docs-source/forms-source/form1-doc/arrays/square.md b/docs-source/forms-source/form1-doc/arrays/square.md
new file mode 100644
index 0000000..c1ba9d3
--- /dev/null
+++ b/docs-source/forms-source/form1-doc/arrays/square.md
@@ -0,0 +1,69 @@
+
+
+Create a function that squares each number in an array.
+
+The steps you will take to building the `squareAll` function are:
+
+1. Add a `squareAll` function that returns a constant value.
+2. Chang the `squareAll` function to perform square computation on array value
+
+#### It should square all numbers in a single-value array ####
+
+Create a function called `squareAll` that takes an array and returns the square of the first element.
+
+Hints
+
+Create a function that only squares the first value of an array and returns that value as an array.
+
+Code
+
+**Example**
+
+```javascript
+ function squareAll (values) {
+ let result = square(_array_[_number_]);
+ return [_something_];
+ }
+
+ return {
+ squareAll,
+ };
+```
+
+Hints
+
+Add logic to square all numbers in array (How did you solve sum?)
+
+Code
+
+**Example**
+
+```javascript
+ function squareAll (values) {
+ for(let index = _number_; _number_ < _number_; index += 1) {
+ result[index] = square(_something_[index]);
+ }
+
+ return ?;
+ }
+
+ return {
+ squareAll,
+ };
+```
+
+Hints
-
-Create a function that only squares the first value of an array and returns that value as an array.
-
-Code
-
-**Example**
-
-```javascript
- function squareAll (values) {
- let result = square(_array_[_number_]);
- return [_something_];
- }
-
- return {
- squareAll,
- };
-```
-
-Hints
-
-Add logic to square all numbers in array (How did you solve sum?)
-
-Code
-
-**Example**
-
-```javascript
- function squareAll (values) {
- for(let index = _number_; _number_ < _number_; index += 1) {
- result[index] = square(_something_[index]);
- }
-
- return ?;
- }
-
- return {
- squareAll,
- };
-```
-
-Hints
-
-Functions start with the keyword `function` followed by the name of the function and then a set of parenthesis `()`. All the logic of a function is contained an open curly brace `{` and a closed curly brace `}`. What the function returns follows the key word `return`.
-
-Code
-
-**Example**
-
-```javascript
- function greet() {
- return _string_;
- }
-
- return {
- greet,
- };
-```
-
-Hints
-
-Add condition to greet to handle custom greeting case.
-(Try using an "if/else" structure. "If" is a control structure)
-
-Code
-
-**Example**
-
-```javascript
- function greet (greeting) {
- if (_something_ === undefined) {
- return _string_;
- } else {
- return _something_ + '!';
- }
- }
-
- return {
- greet,
- };
-```
-
-Hints
+
+Functions start with the keyword `function` followed by the name of the function and then a set of parenthesis `()`. All the logic of a function is contained an open curly brace `{` and a closed curly brace `}`. What the function returns follows the key word `return`.
+
+Code
+
+**Example**
+
+```javascript
+ function greet() {
+ return _string_;
+ }
+
+ return {
+ greet,
+ };
+```
+
+Hints
+
+Add condition to greet to handle custom greeting case.
+(Try using an "if/else" structure. "If" is a control structure)
+
+Code
+
+**Example**
+
+```javascript
+ function greet (greeting) {
+ if (_something_ === undefined) {
+ return _string_;
+ } else {
+ return _something_ + '!';
+ }
+ }
+
+ return {
+ greet,
+ };
+```
+
+Hints
-
-Be sure you use "var" or "let" to declare your variable
-
-Code
-
-**Example 1**
-
-```javascript
-const jsforms = (function () {
- 'use strict';
- let ?;
-
- return {
- };
-})();
-```
-
-**Example 2**
-
-```javascript
-const jsforms = (function () {
- 'use strict';
- var ?;
-
- return {
- };
-})();
-```
-
-Hints
-
-Initialize a variable with equals: `var a = ...`
-
-Code
-
-**Example 1**
-
-```javascript
-const jsforms = (function () {
- 'use strict';
- let a = ?;
-
- return {
- };
-})();
-```
-
-**Example 2**
-
-```javascript
-const jsforms = (function () {
- 'use strict';
- var a = ?;
-
- return {
- };
-})();
-```
-
-Hints
-
-Add two numbers using the plus (+) operator
-
-Code
-
-**Example 1**
-
-```javascript
- let a = 5;
- a = ? + ?;
-
- return {
- };
-```
-
-**Example 2**
-
-```javascript
- var a = 5;
- a = ? + ?;
-
- return {
- };
-```
-
-Hints
-
-Initialize a variable with equals: `var b = ...`
-
-Code
-
-**Example 1**
-
-```javascript
- let b = ?;
-
- return {
- };
-```
-
-**Example 2**
-
-```javascript
- var b = ?;
-
- return {
- };
-```
-
-Hints
-
-Console.log might be just the ticket...
-
-Code
-
-**Example 1**
-
-```javascript
- console.log(?);
-
- return {
- };
-```
-
-**Example 2**
-
-```javascript
- console.log(?);
-
- return {
- };
-```
-
-Hints
-
-Find `return {};` add a "b" -> `return {b};`
-
-Code
-
-**Example**
-
-```javascript
- return {
- ?,
- };
-```
-
-Hints
+
+Add two numbers using the plus (+) operator
+
+Code
+
+**Example 1**
+
+```javascript
+ let a = 5;
+ a = ? + ?;
+
+ return {
+ };
+```
+
+**Example 2**
+
+```javascript
+ var a = 5;
+ a = ? + ?;
+
+ return {
+ };
+```
+
+Hints
+
+Initialize a variable with equals: `var b = ...`
+
+Code
+
+**Example 1**
+
+```javascript
+ let b = ?;
+
+ return {
+ };
+```
+
+**Example 2**
+
+```javascript
+ var b = ?;
+
+ return {
+ };
+```
+
+Hints
+
+Be sure you use "var" or "let" to declare your variable
+
+Code
+
+**Example 1**
+
+```javascript
+const jsforms = (function () {
+ 'use strict';
+ let ?;
+
+ return {
+ };
+})();
+```
+
+**Example 2**
+
+```javascript
+const jsforms = (function () {
+ 'use strict';
+ var ?;
+
+ return {
+ };
+})();
+```
+
+Hints
+
+Initialize a variable with equals: `var a = ...`
+
+Code
+
+**Example 1**
+
+```javascript
+const jsforms = (function () {
+ 'use strict';
+ let a = ?;
+
+ return {
+ };
+})();
+```
+
+**Example 2**
+
+```javascript
+const jsforms = (function () {
+ 'use strict';
+ var a = ?;
+
+ return {
+ };
+})();
+```
+
+Hints
+
+Find `return {};` add a "b" -> `return {b};`
+
+Code
+
+**Example**
+
+```javascript
+ return {
+ ?,
+ };
+```
+
+Hints
+
+Console.log might be just the ticket...
+
+Code
+
+**Example 1**
+
+```javascript
+ console.log(?);
+
+ return {
+ };
+```
+
+**Example 2**
+
+```javascript
+ console.log(?);
+
+ return {
+ };
+```
+
+Hints
+
+This will look very much like the last test but the transaction statuses are swapped.
+
+Code
+
+**Example**
+
+```javascript
+describe('get returns report', function () {
+ it('returns a report of return transactions that excludes sales transactions', () => {
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Return, ?));
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?)); // This is the record that is not going to be counted
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Return, ?));
+
+ let result = reportBuilder(transactionStatuses.Return);
+
+ assert.deepEqual(result, [
+ {
+ productName: ?, // The name that maps to the first product ID
+ quantity: ?, // The quantity of the first transaction record
+ total: ? // the price from the first product multiplied by te quantity
+ },
+ {
+ productName: ?, // The name that maps to the third product ID
+ quantity: ?, // The quantity of the third transaction record
+ total: ? // the price from the third product multiplied by the quantity
+ },
+ ]);
+
+ });
+});
+```
+
+Data Loader Hints
+
+The `dataLoader` has 3 functions and the following structure:
+
+```javascript
+{
+ getProductData,
+ getTransactionData,
+ getTransactionStatuses
+}
+```
+
+The `getProductData` will be set to the `buildProductData` helper function. The `getTransactionStatuses` will be set to the `buildTransactionStatuses` helper function.
+
+The real odd ball here is the `getTransactionData` which is expected to return an array of transaction records. You will have to create this function, and have it return an empty array.
+
+Code
+
+**Example**
+
+```javascript
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => [],
+ getTransactionStatuses: buildTransactionStatuses
+ };
+```
+
+Hints
+
+You just have to pass the values to the function, and capture the returned function. You will then have to call that function with a "Sale" transactionStatus.
+
+Code
+
+```javascript
+it('returns an empty object for sale counts if no sale data exists', () => {
+ // Arrange
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => [],
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } = salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ // Act
+ let result = getReport(transactionStatuses.Sale);
+
+ // Assert
+ assert.deepEqual(result, []);
+});
+```
+
+Arrange Hints
+
+You are going to setup the `dataLoader` the same way as you did before. But again the odd item out is the `getTransactionData` function because this needs to return an array with a single transaction record for a sale.
+
+The key here is that the transaction record `productId` needs to match one of the products returned from `getProductData`. The `transactionStatus` needs to match the `Sale` property on the `transactionStatuses` object. You will need to use the `buildTransactionRecord` function to create this record.
+
+Code
+
+**Example**
+
+```javascript
+// Arrange
+let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => [
+ buildTransactionRecord(?, transactionStatuses.Sale, 1)
+ ],
+ getTransactionStatuses: buildTransactionStatuses
+};
+
+let { getReport } = salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+```
+
+Hints
+
+Once you have the `dataLoader` created, you will need to only change the Assert part of the code. Remember the `total` in the result is the product's `price`.
+
+Code
+
+**Example**
+
+```javascript
+it('returns a report of sales with one sale', () => {
+ // Arrange
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => [
+ buildTransactionRecord(?, transactionStatuses.Sale, 1)
+ ],
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } = salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ // Act
+ let result = getReport(transactionStatuses.Sale);
+
+ // Assert
+ assert.deepEqual(result, [{
+ productName: ?,
+ quantity: ?,
+ total: ?
+ }]);
+});
+```
+
+WARNING
**
+>
+> You must be careful when using a test suite scoped variables as you can accidentally cause one test to effect another. To prevent this, you must reset all such variables to an initial value in the beforeEach.
+
+##### Refactor Sales Report Tests Create the Before Each #####
+
+You need to create the `getReport` function in the `beforeEach` section. However, in order for this to work you will also need to create and assign a variable to hold the transaction records. This way you can add an item to it in the second test.
+
+Hints
+
+You will need to create two variables before the "get sales report" section. One to hold the `getReport` function and the other to hold the transaction records.
+
+Bellow those, but still before the "get sales report" section, you will need to create the `beforeEach` section.
+
+Code
+
+**Example**
+
+```javascript
+ describe('get report', function () {
+ // files being tested are:
+ // ../jsforms-source/4_test-dummy-form/sales-reporter/salesReporterFactory.js
+ // ../jsforms-source/4_test-dummy-form/pos-transaction-services/reportDataBuilder.js
+
+ let reportBuilder;
+ let transactionRecords;
+
+ beforeEach(() => {
+ transactionRecords = [];
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => transactionRecords,
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } =
+ salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ reportBuilder = getReport;
+ });
+
+ describe('get sales report', function () {
+```
+
+Hints
+
+The whole arrange is now being done in the `beforeEach`. So delete that and use the variable that is holding the `getReport` function.
+
+Code
+
+**Example**
+
+```javascript
+ describe('get report', function () {
+ // files being tested are:
+ // ../jsforms-source/4_test-dummy-form/sales-reporter/salesReporterFactory.js
+ // ../jsforms-source/4_test-dummy-form/pos-transaction-services/reportDataBuilder.js
+
+ let reportBuilder;
+ let transactionRecords;
+
+ beforeEach(() => {
+ transactionRecords = [];
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => transactionRecords,
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } =
+ salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ reportBuilder = getReport;
+ });
+
+ describe('get sales report', function () {
+ it('returns an empty object for sale counts if no sale data exists', () => {
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, []);
+ });
+```
+
+Hints
+
+Most of the arrange in this test can be deleted. You will just need to add the sales transaction record to the array before calling the `getReport` function.
+
+Code
+
+**Example**
+
+```javascript
+ let reportBuilder;
+ let transactionRecords;
+
+ beforeEach(() => {
+ transactionRecords = [];
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => transactionRecords,
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } =
+ salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ reportBuilder = getReport;
+ });
+
+ describe('get sales report', function () {
+
+ // ...
+
+ it('returns a report of sales with one sale', () => {
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, 1));
+
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, [{
+ productName: ?,
+ quantity: ?,
+ total: ?
+ }]);
+ });
+```
+
+Hints
+
+Add the two different products to the transaction records. Make sure that the `productId` of each maps to a product that is returned by the `buildProductData` function. You will also want each product to have a different non-one `quantity` value.
+
+You will also have two objects in the result to test for.
+
+Code
+
+**Example**
+
+```javascript
+it('returns a report of sales with two sales of different products', () => {
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?));
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?));
+
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, [
+ {
+ productName: ?, // The name that maps to the first product ID
+ quantity: ?, // The quantity of the first transaction record
+ total: ? // the price from the first product multiplied by te quantity
+ },
+ {
+ productName: ?, // The name that maps to the second product ID
+ quantity: ?, // The quantity of the second transaction record
+ total: ? // the price from the second product multiplied by the quantity
+ },
+ ]);
+});
+```
+
+Hints
+
+This test will look very similar to the above with the difference that the two transaction records will share the same `productId`.
+
+There will only be a single object in the result.
+
+Code
+
+**Example**
+
+```javascript
+it('returns a report of sales with two sales of the same product', () => {
+ let productId = ?;
+ transactionRecords.push(buildTransactionRecord(productId, transactionStatuses.Sale, ?));
+ transactionRecords.push(buildTransactionRecord(productId, transactionStatuses.Sale, ?));
+
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, [
+ {
+ productName: ?, // The name that maps to the product ID
+ quantity: ?, // The total quantity of the transaction records
+ total: ? // the price from the product multiplied by the total quantity
+ },
+ ]);
+});
+```
+
+Hints
+
+You are going to create the test very similarly to two tests ago, but you will add a new transaction record that has the `transactionStatus` equal to Return.
+
+Code
+
+**Example**
+
+```javascript
+it('returns a report of sales excluding any return transactions', () => {
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?));
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Return, ?)); // This is the record that is not going to be counted
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?));
+
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, [
+ {
+ productName: ?, // The name that maps to the first product ID
+ quantity: ?, // The quantity of the first transaction record
+ total: ? // the price from the first product multiplied by te quantity
+ },
+ {
+ productName: ?, // The name that maps to the third product ID
+ quantity: ?, // The quantity of the third transaction record
+ total: ? // the price from the third product multiplied by the quantity
+ },
+ ]);
+});
+```
+
+Hints
-
-The `it` already exists on line 51, all you need to do is add the arrow function expression. The description is the name of the parent section without then "It":
-
-> returns an empty object for sale counts if no sale data exists
-
-Code
-
-**Example**
-
-```javascript
- it('returns an empty object for sale counts if no sale data exists', () => {});
-```
-
-Hints
-
-You will need to add two line brakes to the arrow function expression between the curly braces.
-
-Code
-
-**Example**
-
-```javascript
- it('returns an empty object for sale counts if no sale data exists', () => {
- // Act
- // Assert
- });
-```
-
-Hints
-
-You need to make a call the the `getProductCountBySale` method with an empty array and set a variable to that result.
-
-Code
-
-**Example**
-
-```javascript
- it('returns an empty object for sale counts if no sale data exists', () => {
- // Act
- let result = pointOfSaleDataUtilities.getProductCountBySale([]);
- // Assert
- });
-```
-
-Hints
-
-The expected result is `{}`.
-
-Code
-
-**Example**
-
-```javascript
- it('returns an empty object for sale counts if no sale data exists', () => {
- // Act
- let ? = pointOfSaleDataUtilities.getProductCountBySale([]);
- // Assert
- assert.deepEqual(?, {});
- });
-```
-
-Hints
-
-Delete the comment lines
-
-Code
-
-**Example 1 (`let`)**
-
-```javascript
- it('returns an empty object for sale counts if no sale data exists', () => {
- let ? = pointOfSaleDataUtilities.getProductCountBySale([]);
-
- assert.deepEqual(?, {});
- });
-```
-
-**Example 2 (`var`)**
-
-```javascript
- it('returns an empty object for sale counts if no sale data exists', () => {
- var ? = pointOfSaleDataUtilities.getProductCountBySale([]);
-
- assert.deepEqual(?, {});
- });
-```
-
-Hints
-
-You did this once already in the last test.
-
-The `it` already exists just below the last test, all you need to do is add the arrow function expression. The description is the name of the parent section without then "It":
-
-> returns an object with a single count of 1 when only one item, quantity 1 was purchased
-
-Code
-
-**Example**
-
-```javascript
- it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {});
-```
-
-Hints
-
-You will need to add two line brakes to the arrow function expression between the curly braces.
-
-Code
-
-**Example**
-
-```javascript
- it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
- // Arrange
- // Act
- // Assert
- });
-```
-
-Hints
-
-You will create a variable and assign it to the value returned from the `buildTransactionRecord` function call.
-
-Code
-
-**Example 1 (`let`)**
-
-```javascript
- it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
- // Arrange
- let ? = buildTransactionRecord(?, transactionStatuses.Sale, 1);
- // Act
- // Assert
- });
-```
-
-**Example 2 (`var`)**
-
-```javascript
- it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
- // Arrange
- var ? = buildTransactionRecord(?, transactionStatuses.Sale, 1);
- // Act
- // Assert
- });
-```
-
-Hints
-
-You need to make a call the the `getProductCountBySale` method with an empty array and set a variable to that result.
-
-Code
-
-**Example 1 (`let`)**
-
-```javascript
- it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
- // Arrange
- let ? = buildTransactionRecord(?, transactionStatuses.Sale, 1);
-
- // Act
- let result = getProductCountBySale([?]);
- // Assert
- });
-```
-
-**Example 2 (`var`)**
-
-```javascript
- it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
- // Arrange
- var ? = buildTransactionRecord(?, transactionStatuses.Sale, 1);
-
- // Act
- var result = getProductCountBySale([?]);
- // Assert
- });
-```
-
-Hints
-
-You can just copy the provided object above into the assert for the expected value, and replace `productId` with the correct number.
-
-Code
-
-**Example 1 (`let`)**
-
-```javascript
- it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
- // Arrange
- let transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 1);
-
- // Act
- let result = getProductCountBySale([transactionRecord]);
-
- // Assert
- assert.deepEqual(result, {
- [?]: 1
- });
- });
-```
-
-**Example 2 (`var`)**
-
-```javascript
- it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
- // Arrange
- var transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 1);
-
- // Act
- var result = getProductCountBySale([transactionRecord]);
-
- // Assert
- assert.deepEqual(result, {
- [?]: 1
- });
- });
-```
-
-Hints
-
-Just delete them.
-
-Code
-
-Hints
+
+In the "Arrange" you will be creating 3 different transaction reports. Two will be returns and the third will be for a sale. You can choose, if you want any of these to share IDs.
+
+Code
+
+**Example (explicit, diff ids)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let saleTransaction = buildTransactionRecord(?, transactionStatuses.Sale, ?);
+ let return1 = buildTransactionRecord(?, transactionStatuses.Return, ?);
+ let return2 = buildTransactionRecord(?, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ return1,
+ saleTransaction,
+ return2,
+ ]);
+
+ assert.deepEqual(result, {
+ [?]: ?,
+ [?]: ?,
+ });
+ });
+```
+
+**Example (explicit, returns share ID)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let returnProduct = ?;
+ let saleTransaction = buildTransactionRecord(?, transactionStatuses.Sale, ?);
+ let return1 = buildTransactionRecord(returnProduct, transactionStatuses.Return, ?);
+ let return2 = buildTransactionRecord(returnProduct, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ return1,
+ saleTransaction,
+ return2,
+ ]);
+
+ assert.deepEqual(result, {
+ [returnProduct]: ?,
+ });
+ });
+```
+
+**Example (explict, all share ID)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let productId = ?;
+ let saleTransaction = buildTransactionRecord(productId, transactionStatuses.Sale, ?);
+ let return1 = buildTransactionRecord(productId, transactionStatuses.Return, ?);
+ let return2 = buildTransactionRecord(productId, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ return1,
+ saleTransaction,
+ return2,
+ ]);
+
+ assert.deepEqual(result, {
+ [productId]: ?,
+ });
+ });
+```
+
+**Example (implicit, diff ids)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let transactions = [
+ buildTransactionRecord(?, transactionStatuses.Return, ?),
+ buildTransactionRecord(?, transactionStatuses.Sale, ?),
+ buildTransactionRecord(?, transactionStatuses.Return, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ assert.deepEqual(result, {
+ [?]: ?,
+ [?]: ?,
+ });
+ });
+```
+
+**Example (implicit, returns share ID)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let returnProduct = ?;
+ let transactions = [
+ buildTransactionRecord(returnProduct, transactionStatuses.Return, ?),
+ buildTransactionRecord(?, transactionStatuses.Sale, ?),
+ buildTransactionRecord(returnProduct, transactionStatuses.Return, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ assert.deepEqual(result, {
+ [returnProduct]: ?,
+ });
+ });
+```
+
+**Example (implicit, all share ID)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let productId = ?;
+ let transactions = [
+ buildTransactionRecord(productId, transactionStatuses.Return, ?),
+ buildTransactionRecord(productId, transactionStatuses.Sale, ?),
+ buildTransactionRecord(productId, transactionStatuses.Return, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ return1,
+ saleTransaction,
+ return2,
+ ]);
+
+ assert.deepEqual(result, {
+ [productId]: ?,
+ });
+ });
+```
+
+Hints
+
+The `it` already exists on line 51, all you need to do is add the arrow function expression. The description is the name of the parent section without then "It":
+
+> returns an empty object for sale counts if no sale data exists
+
+Code
+
+**Example**
+
+```javascript
+ it('returns an empty object for sale counts if no sale data exists', () => {});
+```
+
+Hints
+
+You will need to add two line brakes to the arrow function expression between the curly braces.
+
+Code
+
+**Example**
+
+```javascript
+ it('returns an empty object for sale counts if no sale data exists', () => {
+ // Act
+ // Assert
+ });
+```
+
+Hints
+
+You need to make a call the the `getProductCountBySale` method with an empty array and set a variable to that result.
+
+Code
+
+**Example**
+
+```javascript
+ it('returns an empty object for sale counts if no sale data exists', () => {
+ // Act
+ let result = pointOfSaleDataUtilities.getProductCountBySale([]);
+ // Assert
+ });
+```
+
+Hints
+
+The expected result is `{}`.
+
+Code
+
+**Example**
+
+```javascript
+ it('returns an empty object for sale counts if no sale data exists', () => {
+ // Act
+ let ? = pointOfSaleDataUtilities.getProductCountBySale([]);
+ // Assert
+ assert.deepEqual(?, {});
+ });
+```
+
+Hints
+
+Delete the comment lines
+
+Code
+
+**Example 1 (`let`)**
+
+```javascript
+ it('returns an empty object for sale counts if no sale data exists', () => {
+ let ? = pointOfSaleDataUtilities.getProductCountBySale([]);
+
+ assert.deepEqual(?, {});
+ });
+```
+
+**Example 2 (`var`)**
+
+```javascript
+ it('returns an empty object for sale counts if no sale data exists', () => {
+ var ? = pointOfSaleDataUtilities.getProductCountBySale([]);
+
+ assert.deepEqual(?, {});
+ });
+```
+
+Hints
+
+You did this once already in the last test.
+
+The `it` already exists just below the last test, all you need to do is add the arrow function expression. The description is the name of the parent section without then "It":
+
+> returns an object with a single count of 1 when only one item, quantity 1 was purchased
+
+Code
+
+**Example**
+
+```javascript
+ it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {});
+```
+
+Hints
+
+You will need to add two line brakes to the arrow function expression between the curly braces.
+
+Code
+
+**Example**
+
+```javascript
+ it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
+ // Arrange
+ // Act
+ // Assert
+ });
+```
+
+Hints
+
+You will create a variable and assign it to the value returned from the `buildTransactionRecord` function call.
+
+Code
+
+**Example 1 (`let`)**
+
+```javascript
+ it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
+ // Arrange
+ let ? = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+ // Act
+ // Assert
+ });
+```
+
+**Example 2 (`var`)**
+
+```javascript
+ it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
+ // Arrange
+ var ? = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+ // Act
+ // Assert
+ });
+```
+
+Hints
+
+You need to make a call the the `getProductCountBySale` method with an empty array and set a variable to that result.
+
+Code
+
+**Example 1 (`let`)**
+
+```javascript
+ it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
+ // Arrange
+ let ? = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+
+ // Act
+ let result = pointOfSaleDataUtilities.getProductCountBySale([?]);
+ // Assert
+ });
+```
+
+**Example 2 (`var`)**
+
+```javascript
+ it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
+ // Arrange
+ var ? = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+
+ // Act
+ var result = pointOfSaleDataUtilities.getProductCountBySale([?]);
+ // Assert
+ });
+```
+
+Hints
+
+You can just copy the provided object above into the assert for the expected value, and replace `productId` with the correct number.
+
+Code
+
+**Example 1 (`let`)**
+
+```javascript
+ it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
+ // Arrange
+ let transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+
+ // Act
+ let result = pointOfSaleDataUtilities.getProductCountBySale([transactionRecord]);
+
+ // Assert
+ assert.deepEqual(result, {
+ [?]: 1
+ });
+ });
+```
+
+**Example 2 (`var`)**
+
+```javascript
+ it('returns an object with a single count of 1 when only one item, quantity 1 was purchased', () => {
+ // Arrange
+ var transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+
+ // Act
+ var result = pointOfSaleDataUtilities.getProductCountBySale([transactionRecord]);
+
+ // Assert
+ assert.deepEqual(result, {
+ [?]: 1
+ });
+ });
+```
+
+Hints
+
+Just delete them.
+
+Code
+
+Hints
+
+Remember then signature for the `buildTransactionRecord` is `buildTransactionRecord(productId, transactionStatus, quantity)`.
+
+You will simply capture the result as a variable.
+
+Code
+
+**Example 1 (`let`)**
+
+```javascript
+ it('returns an object with a single count of 2 when only one item, quantity 2 was purchased', () => {
+ // Arrange
+ let transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 2);
+
+ // Act
+ // Assert
+ });
+```
+
+**Example 2 (`var`)**
+
+```javascript
+ it('returns an object with a single count of 2 when only one item, quantity 2 was purchased', () => {
+ // Arrange
+ var transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 2);
+
+ // Act
+ // Assert
+ });
+```
+
+Hints
+
+The last two lines of this test should look almost exactly like the test above except with a `2` instead of a 1 for the object value.
+
+Code
+
+```javascript
+ it('returns an object with a single count of 2 when only one item, quantity 2 was purchased', () => {
+ let transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 2);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([transactionRecord]);
+
+ assert.deepEqual(result, {
+ [?]: 2
+ });
+ });
+```
+
+**Example 2 (`var`)**
+
+```javascript
+ it('returns an object with a single count of 2 when only one item, quantity 2 was purchased', () => {
+ var transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 2);
+
+ var result = pointOfSaleDataUtilities.getProductCountBySale([transactionRecord]);
+
+ assert.deepEqual(result, {
+ [?]: 2
+ });
+ });
+```
+
+Hints
+
+All three parts of the test that change. In the "Arrange" you will want to create the two transactions records.
+
+In the "Act" you will pass both of the transaction records to the `getProductCountBySale` method.
+
+In the "Assert" you want to ensure the resulting object has those record quantities.
+
+Code
+
+**Example 1 (explicit variables)**
+
+```javascript
+ it('returns an object with a two counts of 1 when two transactions of 1 qty each are passed', () => {
+ let transactionP1 = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+ let transactionP2 = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ transactionP1,
+ transactionP2
+ ]);
+
+ assert.deepEqual(result, {
+ [?]: 1
+ [?]: 1
+ });
+ });
+```
+
+**Example 2 (implicit variables)**
+
+```javascript
+ it('returns an object with a two counts of 1 when two transactions of 1 qty each are passed', () => {
+ let transactions = [
+ buildTransactionRecord(?, transactionStatuses.Sale, 1)
+ buildTransactionRecord(?, transactionStatuses.Sale, 1)
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ assert.deepEqual(result, {
+ [?]: 1
+ [?]: 1
+ });
+ });
+```
+
+Hints
+
+Again all the portions of the test have changed.
+
+In the "Arrange" you will need to create four different transaction records across two different product IDs. You will need to ensure that the totals of the `quantities` across the products are different.
+
+In the "Act", you will be passing all four transaction records to the `getProductCountBySale` method.
+
+In the "Assert" you will verify that then resulting object has only the two product IDs passed and it has the correct summation of their quantities.
+
+Code
+
+**Example 1 (explicit variables)**
+
+```javascript
+ it('returns an object with a two counts when 4 transactions of two different items are passed', () => {
+ let product1 = ?; // ID for product 1
+ let product2 = ?; // ID for product 2
+
+ let transaction1A = buildTransactionRecord(product1, transactionStatuses.Sale, ?);
+ let transaction1B = buildTransactionRecord(product1, transactionStatuses.Sale, ?);
+ let transaction2A = buildTransactionRecord(product2, transactionStatuses.Sale, ?);
+ let transaction2B = buildTransactionRecord(product2, transactionStatuses.Sale, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ transaction1A,
+ transaction2A,
+ transaction1B,
+ transaction2B
+ ]);
+
+ expect.deepEqual(result, {
+ [product1]: ?
+ [product2]: ?
+ });
+ });
+```
+
+**Example 1 (implicit variables)**
+
+```javascript
+ it('returns an object with a two counts when 4 transactions of two different items are passed', () => {
+ let product1 = ?; // ID for product 1
+ let product2 = ?; // ID for product 2
+
+ let transactions = [
+ buildTransactionRecord(product1, transactionStatuses.Sale, ?),
+ buildTransactionRecord(product2, transactionStatuses.Sale, ?),
+ buildTransactionRecord(product1, transactionStatuses.Sale, ?),
+ buildTransactionRecord(product2, transactionStatuses.Sale, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ expect.deepEqual(result, {
+ [product1]: ?
+ [product2]: ?
+ });
+ });
+```
+
+Hints
+
+In the "Arrange" you will need to create both a Sale and a Return.
+
+Code
+
+**Example 1 (explicit, diff IDs)**
+
+```javascript
+ it('returns counts only for sales, ignoring returns', () => {
+ let saleTransaction = buildTransactionRecord(?, transactionStatuses.Sale, ?);
+ let returnTransaction = buildTransactionRecord(?, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([returnTransaction, saleTransaction]);
+
+ assert.deepEqual(result, {
+ [?]: ?
+ });
+ });
+```
+
+**Example 2 (explicit, same IDs)**
+
+```javascript
+ it('returns counts only for sales, ignoring returns', () => {
+ let productId = ?;
+ let saleTransaction = buildTransactionRecord(productId, transactionStatuses.Sale, ?);
+ let returnTransaction = buildTransactionRecord(productId, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([returnTransaction, saleTransaction]);
+
+ assert.deepEqual(result, {
+ [productId]: ?
+ });
+ });
+```
+
+**Example 3 (implicit, diff IDs)**
+
+```javascript
+ it('returns counts only for sales, ignoring returns', () => {
+ let transactions = [
+ buildTransactionRecord(?, transactionStatuses.Return, ?),
+ buildTransactionRecord(?, transactionStatuses.Sale, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ assert.deepEqual(result, {
+ [?]: ?
+ });
+ });
+```
+
+**Example 4 (implicit, same IDs)**
+
+```javascript
+ it('returns counts only for sales, ignoring returns', () => {
+ let productId = ?;
+ let transactions = [
+ buildTransactionRecord(productId, transactionStatuses.Return, ?),
+ buildTransactionRecord(productId, transactionStatuses.Sale, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([returnTransaction, saleTransaction]);
+
+ assert.deepEqual(result, {
+ [productId]: ?
+ });
+ });
+```
+
+
hunterinderstries
💵 |
EDF Renewables
💵 |
Jason Kerney
💻 📖 |
+
Michał Urbanek
🐛 |
+
Willem Larsen
📖 |
diff --git a/docs/FIRST-FORM.md b/docs/FIRST-FORM.md
index b090956..c1159bb 100644
--- a/docs/FIRST-FORM.md
+++ b/docs/FIRST-FORM.md
@@ -7,26 +7,26 @@ You can also look at [JS Learner Forms documentation](../FORMS.md) for other for
You will be working in then [jsforms-source/1_first-form.js](..\jsforms-source\1_first-form.js) file.
-
## Table Of Contents ##
- [Section 1: Variables and Operations](#user-content-variables-and-operations)
-- [Section 2: Function Creation](#user-content-function-creation)
+- [Section 2: Function Creation, Function Declaration, and the Return Statement](#user-content-function-creation,-function-declaration,-and-the-return-statement)
- [Section 3: Arrays, Loops, and Function Calls](#user-content-arrays,-loops,-and-function-calls)
- [Section 4: Combining Complex Functions](#user-content-combining-complex-functions)
-- [Section 5: Copying Arrays](#user-content-copying-arrays)
+- [Section 5: Copying Arrays Using `Array.slice`](#user-content-copying-arrays-using-`array.slice`)
- [Section 6: Combining existing code to solve new problems](#user-content-combining-existing-code-to-solve-new-problems)
- [Section 7: Looping and inequality comparison](#user-content-looping-and-inequality-comparison)
- [Section 8: The Other JS Learner Forms](#user-content-the-other-js-learner-forms)
## Variables and Operations ##
+
You will explore the creation and use of variables.
-### declaration and initialization
+### Declaration and Initialization ###
Here you will declare and initialize variables.
-#### It should have a variable called "a"
+#### It should have a variable called `a` ####
Create a variable at the top of the block called "a". You will need to use `let` or `var`.
@@ -64,7 +64,7 @@ const jsforms = (function () {
-#### It should initialize "a" with the value 5
+#### It should initialize `a` with the value 5 ####
Set the initial value of a to 5.
@@ -101,12 +101,13 @@ const jsforms = (function () {
+
-### assignment and operators
+### Assignment and Operators ###
Now that you have a variable you will assign it a value different then what it was initialized with.
-#### It should assign the sum of 3 and 7 (3 + 7) to "a"
+#### It should assign the sum of 3 and 7 (3 + 7) to `a` ####
Now assign variable `a` with the value of `3 + 7`.
@@ -140,9 +141,9 @@ Add two numbers using the plus (+) operator
-#### It should have a variable "b" initialized to "Hello, World!"
+#### It should have a variable `b` initialized to `Hello, World!` ####
-Create a variable called `b` and initialize it with the value `"Hello, World!"
+Create a variable called `b` and initialize it with the value `"Hello, World!"`
Hints
@@ -171,12 +172,12 @@ Initialize a variable with equals: `var b = ...`
Hints
+
+Remember then signature for the `buildTransactionRecord` is `buildTransactionRecord(productId, transactionStatus, quantity)`.
+
+You will simply capture the result as a variable.
+
+Code
+
+**Example 1 (`let`)**
+
+```javascript
+ it('returns an object with a single count of 2 when only one item, quantity 2 was purchased', () => {
+ // Arrange
+ let transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 2);
+
+ // Act
+ // Assert
+ });
+```
+
+**Example 2 (`var`)**
+
+```javascript
+ it('returns an object with a single count of 2 when only one item, quantity 2 was purchased', () => {
+ // Arrange
+ var transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 2);
+
+ // Act
+ // Assert
+ });
+```
+
+Hints
+
+The last two lines of this test should look almost exactly like the test above except with a `2` instead of a 1 for the object value.
+
+Code
+
+```javascript
+ it('returns an object with a single count of 2 when only one item, quantity 2 was purchased', () => {
+ let transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 2);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([transactionRecord]);
+
+ assert.deepEqual(result, {
+ [?]: 2
+ });
+ });
+```
+
+**Example 2 (`var`)**
+
+```javascript
+ it('returns an object with a single count of 2 when only one item, quantity 2 was purchased', () => {
+ var transactionRecord = buildTransactionRecord(?, transactionStatuses.Sale, 2);
+
+ var result = pointOfSaleDataUtilities.getProductCountBySale([transactionRecord]);
+
+ assert.deepEqual(result, {
+ [?]: 2
+ });
+ });
+```
+
+Hints
+
+All three parts of the test that change. In the "Arrange" you will want to create the two transactions records.
+
+In the "Act" you will pass both of the transaction records to the `getProductCountBySale` method.
+
+In the "Assert" you want to ensure the resulting object has those record quantities.
+
+Code
+
+**Example 1 (explicit variables)**
+
+```javascript
+ it('returns an object with a two counts of 1 when two transactions of 1 qty each are passed', () => {
+ let transactionP1 = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+ let transactionP2 = buildTransactionRecord(?, transactionStatuses.Sale, 1);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ transactionP1,
+ transactionP2
+ ]);
+
+ assert.deepEqual(result, {
+ [?]: 1
+ [?]: 1
+ });
+ });
+```
+
+**Example 2 (implicit variables)**
+
+```javascript
+ it('returns an object with a two counts of 1 when two transactions of 1 qty each are passed', () => {
+ let transactions = [
+ buildTransactionRecord(?, transactionStatuses.Sale, 1)
+ buildTransactionRecord(?, transactionStatuses.Sale, 1)
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
assert.deepEqual(result, {
[?]: 1
+ [?]: 1
});
});
```
Hints
+
+Again all the portions of the test have changed.
+
+In the "Arrange" you will need to create four different transaction records across two different product IDs. You will need to ensure that the totals of the `quantities` across the products are different.
+
+In the "Act", you will be passing all four transaction records to the `getProductCountBySale` method.
+
+In the "Assert" you will verify that then resulting object has only the two product IDs passed and it has the correct summation of their quantities.
+
+Code
+
+**Example 1 (explicit variables)**
+
+```javascript
+ it('returns an object with a two counts when 4 transactions of two different items are passed', () => {
+ let product1 = ?; // ID for product 1
+ let product2 = ?; // ID for product 2
+
+ let transaction1A = buildTransactionRecord(product1, transactionStatuses.Sale, ?);
+ let transaction1B = buildTransactionRecord(product1, transactionStatuses.Sale, ?);
+ let transaction2A = buildTransactionRecord(product2, transactionStatuses.Sale, ?);
+ let transaction2B = buildTransactionRecord(product2, transactionStatuses.Sale, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ transaction1A,
+ transaction2A,
+ transaction1B,
+ transaction2B
+ ]);
+
+ expect.deepEqual(result, {
+ [product1]: ?
+ [product2]: ?
+ });
+ });
+```
+
+**Example 1 (implicit variables)**
+
+```javascript
+ it('returns an object with a two counts when 4 transactions of two different items are passed', () => {
+ let product1 = ?; // ID for product 1
+ let product2 = ?; // ID for product 2
+
+ let transactions = [
+ buildTransactionRecord(product1, transactionStatuses.Sale, ?),
+ buildTransactionRecord(product2, transactionStatuses.Sale, ?),
+ buildTransactionRecord(product1, transactionStatuses.Sale, ?),
+ buildTransactionRecord(product2, transactionStatuses.Sale, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ expect.deepEqual(result, {
+ [product1]: ?
+ [product2]: ?
+ });
+ });
+```
+
+Hints
+
+In the "Arrange" you will need to create both a Sale and a Return.
+
+Code
+
+**Example 1 (explicit, diff IDs)**
+
+```javascript
+ it('returns counts only for sales, ignoring returns', () => {
+ let saleTransaction = buildTransactionRecord(?, transactionStatuses.Sale, ?);
+ let returnTransaction = buildTransactionRecord(?, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([returnTransaction, saleTransaction]);
+
+ assert.deepEqual(result, {
+ [?]: ?
+ });
+ });
+```
+
+**Example 2 (explicit, same IDs)**
+
+```javascript
+ it('returns counts only for sales, ignoring returns', () => {
+ let productId = ?;
+ let saleTransaction = buildTransactionRecord(productId, transactionStatuses.Sale, ?);
+ let returnTransaction = buildTransactionRecord(productId, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([returnTransaction, saleTransaction]);
+
+ assert.deepEqual(result, {
+ [productId]: ?
+ });
+ });
+```
+
+**Example 3 (implicit, diff IDs)**
+
+```javascript
+ it('returns counts only for sales, ignoring returns', () => {
+ let transactions = [
+ buildTransactionRecord(?, transactionStatuses.Return, ?),
+ buildTransactionRecord(?, transactionStatuses.Sale, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ assert.deepEqual(result, {
+ [?]: ?
+ });
+ });
+```
+
+**Example 4 (implicit, same IDs)**
+
+```javascript
+ it('returns counts only for sales, ignoring returns', () => {
+ let productId = ?;
+ let transactions = [
+ buildTransactionRecord(productId, transactionStatuses.Return, ?),
+ buildTransactionRecord(productId, transactionStatuses.Sale, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([returnTransaction, saleTransaction]);
+
+ assert.deepEqual(result, {
+ [productId]: ?
+ });
+ });
+```
+
+Hints
+
+In the "Arrange" you will be creating 3 different transaction reports. Two will be returns and the third will be for a sale. You can choose, if you want any of these to share IDs.
+
+Code
+
+**Example (explicit, diff ids)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let saleTransaction = buildTransactionRecord(?, transactionStatuses.Sale, ?);
+ let return1 = buildTransactionRecord(?, transactionStatuses.Return, ?);
+ let return2 = buildTransactionRecord(?, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ return1,
+ saleTransaction,
+ return2,
+ ]);
+
+ assert.deepEqual(result, {
+ [?]: ?,
+ [?]: ?,
+ });
+ });
+```
+
+**Example (explicit, returns share ID)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let returnProduct = ?;
+ let saleTransaction = buildTransactionRecord(?, transactionStatuses.Sale, ?);
+ let return1 = buildTransactionRecord(returnProduct, transactionStatuses.Return, ?);
+ let return2 = buildTransactionRecord(returnProduct, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ return1,
+ saleTransaction,
+ return2,
+ ]);
+
+ assert.deepEqual(result, {
+ [returnProduct]: ?,
+ });
+ });
+```
+
+**Example (explict, all share ID)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let productId = ?;
+ let saleTransaction = buildTransactionRecord(productId, transactionStatuses.Sale, ?);
+ let return1 = buildTransactionRecord(productId, transactionStatuses.Return, ?);
+ let return2 = buildTransactionRecord(productId, transactionStatuses.Return, ?);
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ return1,
+ saleTransaction,
+ return2,
+ ]);
+
+ assert.deepEqual(result, {
+ [productId]: ?,
+ });
+ });
+```
+
+**Example (implicit, diff ids)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let transactions = [
+ buildTransactionRecord(?, transactionStatuses.Return, ?),
+ buildTransactionRecord(?, transactionStatuses.Sale, ?),
+ buildTransactionRecord(?, transactionStatuses.Return, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ assert.deepEqual(result, {
+ [?]: ?,
+ [?]: ?,
+ });
+ });
+```
+
+**Example (implicit, returns share ID)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let returnProduct = ?;
+ let transactions = [
+ buildTransactionRecord(returnProduct, transactionStatuses.Return, ?),
+ buildTransactionRecord(?, transactionStatuses.Sale, ?),
+ buildTransactionRecord(returnProduct, transactionStatuses.Return, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale(transactions);
+
+ assert.deepEqual(result, {
+ [returnProduct]: ?,
+ });
+ });
+```
+
+**Example (implicit, all share ID)**
+
+```javascript
+ it('returns with counts only for return transactions', () => {
+ let productId = ?;
+ let transactions = [
+ buildTransactionRecord(productId, transactionStatuses.Return, ?),
+ buildTransactionRecord(productId, transactionStatuses.Sale, ?),
+ buildTransactionRecord(productId, transactionStatuses.Return, ?),
+ ];
+
+ let result = pointOfSaleDataUtilities.getProductCountBySale([
+ return1,
+ saleTransaction,
+ return2,
+ ]);
+
+ assert.deepEqual(result, {
+ [productId]: ?,
+ });
+ });
+```
+
+Data Loader Hints
+
+The `dataLoader` has 3 functions and the following structure:
+
+```javascript
+{
+ getProductData,
+ getTransactionData,
+ getTransactionStatuses
+}
+```
+
+The `getProductData` will be set to the `buildProductData` helper function. The `getTransactionStatuses` will be set to the `buildTransactionStatuses` helper function.
+
+The real odd ball here is the `getTransactionData` which is expected to return an array of transaction records. You will have to create this function, and have it return an empty array.
+
+Code
+
+**Example**
+
+```javascript
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => [],
+ getTransactionStatuses: buildTransactionStatuses
+ };
+```
+
+Hints
+
+You just have to pass the values to the function, and capture the returned function. You will then have to call that function with a "Sale" transactionStatus.
+
+Code
+
+```javascript
+it('returns an empty object for sale counts if no sale data exists', () => {
+ // Arrange
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => [],
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } = salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ // Act
+ let result = getReport(transactionStatuses.Sale);
+
+ // Assert
+ assert.deepEqual(result, []);
+});
+```
+
+Arrange Hints
+
+You are going to setup the `dataLoader` the same way as you did before. But again the odd item out is the `getTransactionData` function because this needs to return an array with a single transaction record for a sale.
+
+The key here is that the transaction record `productId` needs to match one of the products returned from `getProductData`. The `transactionStatus` needs to match the `Sale` property on the `transactionStatuses` object. You will need to use the `buildTransactionRecord` function to create this record.
+
+Code
+
+**Example**
+
+```javascript
+// Arrange
+let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => [
+ buildTransactionRecord(?, transactionStatuses.Sale, 1)
+ ],
+ getTransactionStatuses: buildTransactionStatuses
+};
+
+let { getReport } = salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+```
+
+Hints
+
+Once you have the `dataLoader` created, you will need to only change the Assert part of the code. Remember the `total` in the result is the product's `price`.
+
+Code
+
+**Example**
+
+```javascript
+it('returns a report of sales with one sale', () => {
+ // Arrange
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => [
+ buildTransactionRecord(?, transactionStatuses.Sale, 1)
+ ],
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } = salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ // Act
+ let result = getReport(transactionStatuses.Sale);
+
+ // Assert
+ assert.deepEqual(result, [{
+ productName: ?,
+ quantity: ?,
+ total: ?
+ }]);
+});
+```
+
+WARNING
**
+>
+> You must be careful when using a test suite scoped variables as you can accidentally cause one test to effect another. To prevent this, you must reset all such variables to an initial value in the beforeEach.
+
+##### Refactor Sales Report Tests Create the Before Each #####
+
+You need to create the `getReport` function in the `beforeEach` section. However, in order for this to work you will also need to create and assign a variable to hold the transaction records. This way you can add an item to it in the second test.
+
+Hints
+
+You will need to create two variables before the "get sales report" section. One to hold the `getReport` function and the other to hold the transaction records.
+
+Bellow those, but still before the "get sales report" section, you will need to create the `beforeEach` section.
+
+Code
+
+**Example**
+
+```javascript
+ describe('get report', function () {
+ // files being tested are:
+ // ../jsforms-source/4_test-dummy-form/sales-reporter/salesReporterFactory.js
+ // ../jsforms-source/4_test-dummy-form/pos-transaction-services/reportDataBuilder.js
+
+ let reportBuilder;
+ let transactionRecords;
+
+ beforeEach(() => {
+ transactionRecords = [];
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => transactionRecords,
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } =
+ salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ reportBuilder = getReport;
+ });
+
+ describe('get sales report', function () {
+```
+
+Hints
+
+The whole arrange is now being done in the `beforeEach`. So delete that and use the variable that is holding the `getReport` function.
+
+Code
+
+**Example**
+
+```javascript
+ describe('get report', function () {
+ // files being tested are:
+ // ../jsforms-source/4_test-dummy-form/sales-reporter/salesReporterFactory.js
+ // ../jsforms-source/4_test-dummy-form/pos-transaction-services/reportDataBuilder.js
+
+ let reportBuilder;
+ let transactionRecords;
+
+ beforeEach(() => {
+ transactionRecords = [];
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => transactionRecords,
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } =
+ salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ reportBuilder = getReport;
+ });
+
+ describe('get sales report', function () {
+ it('returns an empty object for sale counts if no sale data exists', () => {
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, []);
+ });
+```
+
+Hints
+
+Most of the arrange in this test can be deleted. You will just need to add the sales transaction record to the array before calling the `getReport` function.
+
+Code
+
+**Example**
+
+```javascript
+ let reportBuilder;
+ let transactionRecords;
+
+ beforeEach(() => {
+ transactionRecords = [];
+ let dataLoader = {
+ getProductData: buildProductData,
+ getTransactionData: () => transactionRecords,
+ getTransactionStatuses: buildTransactionStatuses
+ };
+
+ let { getReport } =
+ salesReporterFactory(dataLoader, pointOfSaleDataUtilsFactory, reportDataBuilderFactory);
+
+ reportBuilder = getReport;
+ });
+
+ describe('get sales report', function () {
+
+ // ...
+
+ it('returns a report of sales with one sale', () => {
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, 1));
+
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, [{
+ productName: ?,
+ quantity: ?,
+ total: ?
+ }]);
+ });
+```
+
+Hints
+
+Add the two different products to the transaction records. Make sure that the `productId` of each maps to a product that is returned by the `buildProductData` function. You will also want each product to have a different non-one `quantity` value.
+
+You will also have two objects in the result to test for.
+
+Code
+
+**Example**
+
+```javascript
+it('returns a report of sales with two sales of different products', () => {
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?));
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?));
+
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, [
+ {
+ productName: ?, // The name that maps to the first product ID
+ quantity: ?, // The quantity of the first transaction record
+ total: ? // the price from the first product multiplied by te quantity
+ },
+ {
+ productName: ?, // The name that maps to the second product ID
+ quantity: ?, // The quantity of the second transaction record
+ total: ? // the price from the second product multiplied by the quantity
+ },
+ ]);
+});
+```
+
+Hints
+
+This test will look very similar to the above with the difference that the two transaction records will share the same `productId`.
+
+There will only be a single object in the result.
+
+Code
+
+**Example**
+
+```javascript
+it('returns a report of sales with two sales of the same product', () => {
+ let productId = ?;
+ transactionRecords.push(buildTransactionRecord(productId, transactionStatuses.Sale, ?));
+ transactionRecords.push(buildTransactionRecord(productId, transactionStatuses.Sale, ?));
+
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, [
+ {
+ productName: ?, // The name that maps to the product ID
+ quantity: ?, // The total quantity of the transaction records
+ total: ? // the price from the product multiplied by the total quantity
+ },
+ ]);
+});
+```
+
+Hints
+
+You are going to create the test very similarly to two tests ago, but you will add a new transaction record that has the `transactionStatus` equal to Return.
+
+Code
+
+**Example**
+
+```javascript
+it('returns a report of sales excluding any return transactions', () => {
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?));
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Return, ?)); // This is the record that is not going to be counted
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?));
+
+ let result = reportBuilder(transactionStatuses.Sale);
+
+ assert.deepEqual(result, [
+ {
+ productName: ?, // The name that maps to the first product ID
+ quantity: ?, // The quantity of the first transaction record
+ total: ? // the price from the first product multiplied by te quantity
+ },
+ {
+ productName: ?, // The name that maps to the third product ID
+ quantity: ?, // The quantity of the third transaction record
+ total: ? // the price from the third product multiplied by the quantity
+ },
+ ]);
+});
+```
+
+Hints
+
+This will look very much like the last test but the transaction statuses are swapped.
+
+Code
+
+**Example**
+
+```javascript
+describe('get returns report', function () {
+ it('returns a report of return transactions that excludes sales transactions', () => {
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Return, ?));
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Sale, ?)); // This is the record that is not going to be counted
+ transactionRecords.push(buildTransactionRecord(?, transactionStatuses.Return, ?));
+
+ let result = reportBuilder(transactionStatuses.Return);
+
+ assert.deepEqual(result, [
+ {
+ productName: ?, // The name that maps to the first product ID
+ quantity: ?, // The quantity of the first transaction record
+ total: ? // the price from the first product multiplied by te quantity
+ },
+ {
+ productName: ?, // The name that maps to the third product ID
+ quantity: ?, // The quantity of the third transaction record
+ total: ? // the price from the third product multiplied by the quantity
+ },
+ ]);
+
+ });
+});
+```
+
+