Skip to content

Commit

Permalink
ENGCOM-6389: Removes hardcoded references to country selector component
Browse files Browse the repository at this point in the history 
#25541
  • Loading branch information
@VladimirZaets
VladimirZaets committed Dec 5, 2019
2 parents 814eaa5 + a411e2e commit 6ae26fd
Show file tree
Hide file tree
Showing 6 changed files with 237 additions and 100 deletions.
9 changes: 5 additions & 4 deletions app/code/Magento/Checkout/view/frontend/web/js/view/shipping.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,10 @@ define([
template: 'Magento_Checkout/shipping',
shippingFormTemplate: 'Magento_Checkout/shipping-address/form',
shippingMethodListTemplate: 'Magento_Checkout/shipping-address/shipping-method-list',
shippingMethodItemTemplate: 'Magento_Checkout/shipping-address/shipping-method-item'
shippingMethodItemTemplate: 'Magento_Checkout/shipping-address/shipping-method-item',
imports: {
countryOptions: '${ $.parentName }.shippingAddress.shipping-address-fieldset.country_id:indexedOptions'
}
},
visible: ko.observable(!quote.isVirtual()),
errorValidationMessage: ko.observable(false),
Expand Down Expand Up @@ -276,9 +279,7 @@ define([
loginFormSelector = 'form[data-role=email-with-possible-login]',
emailValidationResult = customer.isLoggedIn(),
field,
country = registry.get(this.parentName + '.shippingAddress.shipping-address-fieldset.country_id'),
countryIndexedOptions = country.indexedOptions,
option = countryIndexedOptions[quote.shippingAddress().countryId],
option = _.isObject(this.countryOptions) && this.countryOptions[quote.shippingAddress().countryId],
messageContainer = registry.get('checkout.errors').messageContainer;

if (!quote.shippingMethod()) {
Expand Down
25 changes: 13 additions & 12 deletions app/code/Magento/Ui/view/base/web/js/form/element/post-code.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
*/
define([
'underscore',
'uiRegistry',
'./abstract'
], function (_, registry, Abstract) {
], function (_, Abstract) {
'use strict';

return Abstract.extend({
defaults: {
imports: {
countryOptions: '${ $.parentName }.country_id:indexedOptions',
update: '${ $.parentName }.country_id:value'
}
},
Expand All @@ -41,31 +41,32 @@ define([
},

/**
* @param {String} value
* Method called every time country selector's value gets changed.
* Updates all validations and requirements for certain country.
* @param {String} value - Selected country ID.
*/
update: function (value) {
var country = registry.get(this.parentName + '.' + 'country_id'),
options = country.indexedOptions,
option = null;
var isZipCodeOptional,
option;

if (!value) {
return;
}

option = options[value];
option = _.isObject(this.countryOptions) && this.countryOptions[value];

if (!option) {
return;
}

if (option['is_zipcode_optional']) {
isZipCodeOptional = !!option['is_zipcode_optional'];

if (isZipCodeOptional) {
this.error(false);
this.validation = _.omit(this.validation, 'required-entry');
} else {
this.validation['required-entry'] = true;
}

this.required(!option['is_zipcode_optional']);
this.validation['required-entry'] = !isZipCodeOptional;
this.required(!isZipCodeOptional);
}
});
});
73 changes: 23 additions & 50 deletions app/code/Magento/Ui/view/base/web/js/form/element/region.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,81 +18,54 @@ define([
defaults: {
skipValidation: false,
imports: {
countryOptions: '${ $.parentName }.country_id:indexedOptions',
update: '${ $.parentName }.country_id:value'
}
},

/**
* @param {String} value
* Method called every time country selector's value gets changed.
* Updates all validations and requirements for certain country.
* @param {String} value - Selected country ID.
*/
update: function (value) {
var country = registry.get(this.parentName + '.' + 'country_id'),
options = country.indexedOptions,
isRegionRequired,
var isRegionRequired,
option;

if (!value) {
return;
}
option = options[value];

if (typeof option === 'undefined') {
option = _.isObject(this.countryOptions) && this.countryOptions[value];

if (!option) {
return;
}

defaultPostCodeResolver.setUseDefaultPostCode(!option['is_zipcode_optional']);

if (this.skipValidation) {
this.validation['required-entry'] = false;
this.required(false);
} else {
if (option && !option['is_region_required']) {
this.error(false);
this.validation = _.omit(this.validation, 'required-entry');
registry.get(this.customName, function (input) {
input.validation['required-entry'] = false;
input.required(false);
});
} else {
this.validation['required-entry'] = true;
}
if (option['is_region_visible'] === false) {
// Hide select and corresponding text input field if region must not be shown for selected country.
this.setVisible(false);

if (option && !this.options().length) {
registry.get(this.customName, function (input) {
isRegionRequired = !!option['is_region_required'];
input.validation['required-entry'] = isRegionRequired;
input.validation['validate-not-number-first'] = true;
input.required(isRegionRequired);
});
if (this.customEntry) { // eslint-disable-line max-depth
this.toggleInput(false);
}

this.required(!!option['is_region_required']);
}
},

/**
* Filters 'initialOptions' property by 'field' and 'value' passed,
* calls 'setOptions' passing the result to it
*
* @param {*} value
* @param {String} field
*/
filter: function (value, field) {
var superFn = this._super;

registry.get(this.parentName + '.' + 'country_id', function (country) {
var option = country.indexedOptions[value];
isRegionRequired = !this.skipValidation && !!option['is_region_required'];

superFn.call(this, value, field);
if (!isRegionRequired) {
this.error(false);
}

if (option && option['is_region_visible'] === false) {
// hide select and corresponding text input field if region must not be shown for selected country
this.setVisible(false);
this.required(isRegionRequired);
this.validation['required-entry'] = isRegionRequired;

if (this.customEntry) {// eslint-disable-line max-depth
this.toggleInput(false);
}
}
registry.get(this.customName, function (input) {
input.required(isRegionRequired);
input.validation['required-entry'] = isRegionRequired;
input.validation['validate-not-number-first'] = !this.options().length;
}.bind(this));
}
});
Expand Down
24 changes: 16 additions & 8 deletions dev/tests/js/jasmine/tests/app/code/Magento/Checkout/frontend/js/view/shipping.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,16 +174,13 @@ define(['squire', 'ko', 'jquery', 'uiRegistry', 'jquery/validate'], function (Sq

describe('"validateShippingInformation" method', function () {
it('Check method call on negative cases.', function () {
/* jscs:disable */
var country = {
'indexedOptions': {
'AD':
{
label: 'Andorra',
labeltitle: 'Andorra',
value: 'AD'
}
}
on: function () {},
get: function () {},
set: function () {}
};
/* jscs:enable */

registry.set('test.shippingAddress.shipping-address-fieldset.country_id', country);
registry.set('checkout.errors', {});
Expand All @@ -202,9 +199,20 @@ define(['squire', 'ko', 'jquery', 'uiRegistry', 'jquery/validate'], function (Sq
expect(obj.validateShippingInformation()).toBeFalsy();
});
it('Check method call on positive case.', function () {
/* jscs:disable */
var country = {
on: function () {},
get: function () {},
set: function () {}
};
/* jscs:enable */

$('body').append('<form data-role="email-with-possible-login">' +
'<input type="text" name="username" />' +
'</form>');

registry.set('test.shippingAddress.shipping-address-fieldset.country_id', country);
registry.set('checkout.errors', {});
obj.source = {
get: jasmine.createSpy().and.returnValue(true),
set: jasmine.createSpy(),
Expand Down
75 changes: 62 additions & 13 deletions dev/tests/js/jasmine/tests/app/code/Magento/Ui/base/js/form/element/post-code.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,71 @@ define([
});

describe('update method', function () {
it('check for default', function () {
var value = 'Value',
country = {
indexedOptions: {
'Value': {
'is_zipcode_optional': true
}
}
};

spyOn(mocks['Magento_Ui/js/lib/registry/registry'], 'get').and.returnValue(country);
it('makes field optional when there is no corresponding country', function () {
var value = 'Value';

model.countryOptions = {};

model.update(value);

expect(model.required()).toEqual(false);
});

it('makes field optional when post code is optional for certain country', function () {
var value = 'Value';

model.countryOptions = {
'Value': {
'is_zipcode_optional': true
}
};

model.update(value);
expect(mocks['Magento_Ui/js/lib/registry/registry'].get).toHaveBeenCalled();
expect(model.error()).toEqual(false);

expect(model.required()).toEqual(false);
});

it('removes field required validation when post code is optional for certain country', function () {
var value = 'Value';

model.countryOptions = {
'Value': {
'is_zipcode_optional': true
}
};

model.update(value);

expect(model.validation['required-entry']).toBeFalsy();
});

it('makes field required when post code is required for certain country', function () {
var value = 'Value';

model.countryOptions = {
'Value': {
'is_zipcode_optional': false
}
};

model.update(value);

expect(model.required()).toEqual(true);
});

it('sets field required validation when post code is required for certain country', function () {
var value = 'Value';

model.countryOptions = {
'Value': {
'is_zipcode_optional': false
}
};

model.update(value);

expect(model.validation['required-entry']).toEqual(true);
});
});
});
});
Loading

0 comments on commit 6ae26fd

Please sign in to comment.