Skip to content

refactor: do not alias this to self #748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erisu merged 1 commit into from
Dec 24, 2019
Merged

refactor: do not alias this to self #748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 29 additions & 39 deletions bin/templates/scripts/cordova/Api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,6 @@ Api.prototype.prepare = function (cordovaProject) {
*/
Api.prototype.addPlugin = function (plugin, installOptions) {
const xcodeproj = projectFile.parse(this.locations);
const self = this;

installOptions = installOptions || {};
installOptions.variables = installOptions.variables || {};
Expand All @@ -243,15 +242,15 @@ Api.prototype.addPlugin = function (plugin, installOptions) {
installOptions.variables.PACKAGE_NAME = xcodeproj.getPackageName();
}

return PluginManager.get(self.platform, self.locations, xcodeproj)
return PluginManager.get(this.platform, this.locations, xcodeproj)
.addPlugin(plugin, installOptions)
.then(() => {
if (plugin != null) {
const headerTags = plugin.getHeaderFiles(self.platform);
const headerTags = plugin.getHeaderFiles(this.platform);
const bridgingHeaders = headerTags.filter(obj => obj.type === 'BridgingHeader');
if (bridgingHeaders.length > 0) {
const project_dir = self.locations.root;
const project_name = self.locations.xcodeCordovaProj.split('/').pop();
const project_dir = this.locations.root;
const project_name = this.locations.xcodeCordovaProj.split('/').pop();
const BridgingHeader = require('./lib/BridgingHeader').BridgingHeader;
const bridgingHeaderFile = new BridgingHeader(path.join(project_dir, project_name, 'Bridging-Header.h'));
events.emit('verbose', 'Adding Bridging-Headers since the plugin contained <header-file> with type="BridgingHeader"');
Expand All @@ -265,10 +264,10 @@ Api.prototype.addPlugin = function (plugin, installOptions) {
})
.then(() => {
if (plugin != null) {
const podSpecs = plugin.getPodSpecs ? plugin.getPodSpecs(self.platform) : [];
const frameworkTags = plugin.getFrameworks(self.platform);
const podSpecs = plugin.getPodSpecs ? plugin.getPodSpecs(this.platform) : [];
const frameworkTags = plugin.getFrameworks(this.platform);
const frameworkPods = frameworkTags.filter(obj => obj.type === 'podspec');
return self.addPodSpecs(plugin, podSpecs, frameworkPods, installOptions);
return this.addPodSpecs(plugin, podSpecs, frameworkPods, installOptions);
}
})
// CB-11022 return non-falsy value to indicate
Expand All @@ -291,17 +290,16 @@ Api.prototype.addPlugin = function (plugin, installOptions) {
*/
Api.prototype.removePlugin = function (plugin, uninstallOptions) {
const xcodeproj = projectFile.parse(this.locations);
const self = this;

return PluginManager.get(self.platform, self.locations, xcodeproj)
return PluginManager.get(this.platform, this.locations, xcodeproj)
.removePlugin(plugin, uninstallOptions)
.then(() => {
if (plugin != null) {
const headerTags = plugin.getHeaderFiles(self.platform);
const headerTags = plugin.getHeaderFiles(this.platform);
const bridgingHeaders = headerTags.filter(obj => obj.type === 'BridgingHeader');
if (bridgingHeaders.length > 0) {
const project_dir = self.locations.root;
const project_name = self.locations.xcodeCordovaProj.split('/').pop();
const project_dir = this.locations.root;
const project_name = this.locations.xcodeCordovaProj.split('/').pop();
const BridgingHeader = require('./lib/BridgingHeader').BridgingHeader;
const bridgingHeaderFile = new BridgingHeader(path.join(project_dir, project_name, 'Bridging-Header.h'));
events.emit('verbose', 'Removing Bridging-Headers since the plugin contained <header-file> with type="BridgingHeader"');
Expand All @@ -315,10 +313,10 @@ Api.prototype.removePlugin = function (plugin, uninstallOptions) {
})
.then(() => {
if (plugin != null) {
const podSpecs = plugin.getPodSpecs ? plugin.getPodSpecs(self.platform) : [];
const frameworkTags = plugin.getFrameworks(self.platform);
const podSpecs = plugin.getPodSpecs ? plugin.getPodSpecs(this.platform) : [];
const frameworkTags = plugin.getFrameworks(this.platform);
const frameworkPods = frameworkTags.filter(obj => obj.type === 'podspec');
return self.removePodSpecs(plugin, podSpecs, frameworkPods, uninstallOptions);
return this.removePodSpecs(plugin, podSpecs, frameworkPods, uninstallOptions);
}
})
// CB-11022 return non-falsy value to indicate
Expand All @@ -331,17 +329,15 @@ Api.prototype.removePlugin = function (plugin, uninstallOptions) {
*
* @param {PluginInfo} plugin A PluginInfo instance that represents plugin
* that will be installed.
* @param {Object} podSpecs: the return value of plugin.getPodSpecs(self.platform)
* @param {Object} podSpecs: the return value of plugin.getPodSpecs(this.platform)
* @param {Object} frameworkPods: framework tags object with type === 'podspec'
* @return {Promise} Return a promise
*/

Api.prototype.addPodSpecs = function (plugin, podSpecs, frameworkPods, installOptions) {
const self = this;

const project_dir = self.locations.root;
const project_name = self.locations.xcodeCordovaProj.split('/').pop();
const minDeploymentTarget = self.getPlatformInfo().projectConfig.getPreference('deployment-target', 'ios');
const project_dir = this.locations.root;
const project_name = this.locations.xcodeCordovaProj.split('/').pop();
const minDeploymentTarget = this.getPlatformInfo().projectConfig.getPreference('deployment-target', 'ios');

const Podfile = require('./lib/Podfile').Podfile;
const PodsJson = require('./lib/PodsJson').PodsJson;
Expand Down Expand Up @@ -436,10 +432,10 @@ Api.prototype.addPodSpecs = function (plugin, podSpecs, frameworkPods, installOp
if (podfileFile.isDirty()) {
podfileFile.write();
events.emit('verbose', 'Running `pod install` (to install plugins)');
projectFile.purgeProjectFileCache(self.locations.root);
projectFile.purgeProjectFileCache(this.locations.root);

return podfileFile.install(check_reqs.check_cocoapods)
.then(() => self.setSwiftVersionForCocoaPodsLibraries(podsjsonFile));
.then(() => this.setSwiftVersionForCocoaPodsLibraries(podsjsonFile));
} else {
events.emit('verbose', 'Podfile unchanged, skipping `pod install`');
}
Expand All @@ -452,16 +448,14 @@ Api.prototype.addPodSpecs = function (plugin, podSpecs, frameworkPods, installOp
*
* @param {PluginInfo} plugin A PluginInfo instance that represents plugin
* that will be installed.
* @param {Object} podSpecs: the return value of plugin.getPodSpecs(self.platform)
* @param {Object} podSpecs: the return value of plugin.getPodSpecs(this.platform)
* @param {Object} frameworkPods: framework tags object with type === 'podspec'
* @return {Promise} Return a promise
*/

Api.prototype.removePodSpecs = function (plugin, podSpecs, frameworkPods, uninstallOptions) {
const self = this;

const project_dir = self.locations.root;
const project_name = self.locations.xcodeCordovaProj.split('/').pop();
const project_dir = this.locations.root;
const project_name = this.locations.xcodeCordovaProj.split('/').pop();

const Podfile = require('./lib/Podfile').Podfile;
const PodsJson = require('./lib/PodsJson').PodsJson;
Expand Down Expand Up @@ -559,7 +553,7 @@ Api.prototype.removePodSpecs = function (plugin, podSpecs, frameworkPods, uninst
events.emit('verbose', 'Running `pod install` (to uninstall pods)');

return podfileFile.install(check_reqs.check_cocoapods)
.then(() => self.setSwiftVersionForCocoaPodsLibraries(podsjsonFile));
.then(() => this.setSwiftVersionForCocoaPodsLibraries(podsjsonFile));
} else {
events.emit('verbose', 'Podfile unchanged, skipping `pod install`');
}
Expand All @@ -574,13 +568,12 @@ Api.prototype.removePodSpecs = function (plugin, podSpecs, frameworkPods, uninst
*/

Api.prototype.setSwiftVersionForCocoaPodsLibraries = function (podsjsonFile) {
const self = this;
let __dirty = false;
return check_reqs.check_cocoapods().then(toolOptions => {
if (toolOptions.ignore) {
events.emit('verbose', '=== skip Swift Version Settings For Cocoapods Libraries');
} else {
const podPbxPath = path.join(self.root, 'Pods', 'Pods.xcodeproj', 'project.pbxproj');
const podPbxPath = path.join(this.root, 'Pods', 'Pods.xcodeproj', 'project.pbxproj');
const podXcodeproj = xcode.project(podPbxPath);
podXcodeproj.parseSync();
const podTargets = podXcodeproj.pbxNativeTargetSection();
Expand Down Expand Up @@ -647,9 +640,8 @@ Api.prototype.setSwiftVersionForCocoaPodsLibraries = function (podsjsonFile) {
* CordovaError instance.
*/
Api.prototype.build = function (buildOptions) {
const self = this;
return check_reqs.run()
.then(() => require('./lib/build').run.call(self, buildOptions));
.then(() => require('./lib/build').run.call(this, buildOptions));
};

/**
Expand All @@ -665,9 +657,8 @@ Api.prototype.build = function (buildOptions) {
* successfully, or rejected with CordovaError.
*/
Api.prototype.run = function (runOptions) {
const self = this;
return check_reqs.run()
.then(() => require('./lib/run').run.call(self, runOptions));
.then(() => require('./lib/run').run.call(this, runOptions));
};

/**
Expand All @@ -677,10 +668,9 @@ Api.prototype.run = function (runOptions) {
* CordovaError.
*/
Api.prototype.clean = function (cleanOptions) {
const self = this;
return check_reqs.run()
.then(() => require('./lib/clean').run.call(self, cleanOptions))
.then(() => require('./lib/prepare').clean.call(self, cleanOptions));
.then(() => require('./lib/clean').run.call(this, cleanOptions))
.then(() => require('./lib/prepare').clean.call(this, cleanOptions));
};

/**
Expand Down
10 changes: 4 additions & 6 deletions bin/templates/scripts/cordova/lib/Podfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,12 +289,11 @@ Podfile.prototype.destroy = function () {

Podfile.prototype.write = function () {
let text = this.getTemplate();
const self = this;

const podsString =
Object.keys(this.pods).map(key => {
const name = key;
const json = self.pods[key];
const json = this.pods[key];

if (typeof json === 'string') { // compatibility for using framework tag.
const spec = json;
Expand Down Expand Up @@ -334,13 +333,13 @@ Podfile.prototype.write = function () {

const sourcesString =
Object.keys(this.sources).map(key => {
const source = self.sources[key];
const source = this.sources[key];
return util.format('source \'%s\'', source);
}).join('\n');

const declarationString =
Object.keys(this.declarations).map(key => {
const declaration = self.declarations[key];
const declaration = this.declarations[key];
return declaration;
}).join('\n');

Expand Down Expand Up @@ -384,14 +383,13 @@ Podfile.prototype.install = function (requirementsCheckerFunction) {
opts.stdio = 'pipe';
opts.printCommand = true;
let first = true;
const self = this;

if (!requirementsCheckerFunction) {
requirementsCheckerFunction = Q();
}

return requirementsCheckerFunction()
.then(toolOptions => self.before_install(toolOptions))
.then(toolOptions => this.before_install(toolOptions))
.then(toolOptions => {
if (toolOptions.ignore) {
events.emit('verbose', '==== pod install start ====\n');
Expand Down
23 changes: 10 additions & 13 deletions bin/templates/scripts/cordova/lib/prepare.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ const IMAGESET_COMPACT_SIZE_CLASS = 'compact';
const CDV_ANY_SIZE_CLASS = 'any';

module.exports.prepare = function (cordovaProject, options) {
const self = this;

const platformJson = PlatformJson.load(this.locations.root, 'ios');
const munger = new PlatformMunger('ios', this.locations.root, platformJson, new PluginInfoProvider());

Expand All @@ -55,12 +53,12 @@ module.exports.prepare = function (cordovaProject, options) {
// Update own www dir with project's www assets and plugins' assets and js-files
return Q.when(updateWww(cordovaProject, this.locations))
// update project according to config.xml changes.
.then(() => updateProject(self._config, self.locations))
.then(() => updateProject(this._config, this.locations))
.then(() => {
updateIcons(cordovaProject, self.locations);
updateSplashScreens(cordovaProject, self.locations);
updateLaunchStoryboardImages(cordovaProject, self.locations);
updateFileResources(cordovaProject, self.locations);
updateIcons(cordovaProject, this.locations);
updateSplashScreens(cordovaProject, this.locations);
updateLaunchStoryboardImages(cordovaProject, this.locations);
updateFileResources(cordovaProject, this.locations);
})
.then(() => {
events.emit('verbose', 'Prepared iOS project successfully');
Expand All @@ -81,13 +79,12 @@ module.exports.clean = function (options) {

const projectConfig = new ConfigParser(this.locations.configXml);

const self = this;
return Q().then(() => {
cleanWww(projectRoot, self.locations);
cleanIcons(projectRoot, projectConfig, self.locations);
cleanSplashScreens(projectRoot, projectConfig, self.locations);
cleanLaunchStoryboardImages(projectRoot, projectConfig, self.locations);
cleanFileResources(projectRoot, projectConfig, self.locations);
cleanWww(projectRoot, this.locations);
cleanIcons(projectRoot, projectConfig, this.locations);
cleanSplashScreens(projectRoot, projectConfig, this.locations);
cleanLaunchStoryboardImages(projectRoot, projectConfig, this.locations);
cleanFileResources(projectRoot, projectConfig, this.locations);
});
};

Expand Down