fix: Project's Podfile is regenerated incorrectly

[rosen-vladimirov]

In case multiple plugins have Podfile with post_install hook, CLI modifies the hook of each of them by renaming the hook's function and calling it in the single post_install that is allowed for Podfile (placed at the bottom of the project's Podfile). However, when some change in node_modules is detected, CLI processes all Podfiles again and tries to apply them to project's Podfile. The "apply" is check if the plugin's Podfile is already added to project's one and in case not - adding it again. Whenever all Podfiles are processed, the "afterPrepareAllPlugins" method checks the final project's Podfile and replaces the post_install hooks from all plugins with a new functions (by adding index to the name) and calls them inside a newly added post_install function.
This is not working as when CLI checks if a plugin's Podfile is already added to the project's one, it uses the original content of the plugin's Podfile, where the post_install hook is called post_install, while in the project's one it is renamed. So CLI always thinks that plugin's Podfile, which has post_install hook is not added to the project. CLI tries to add it again and messes the whole structure.

In order to fix the issue, apply the following logic:

1. When a plugin has a Podfile, during prepare of the plugin read the content of this file. After that apply modifications over the file by replacing the post_install with a well known name - post_install<plugin_name>_<index>.
2. Check if the replaced content is part of the project's Podfile. In case yes - do nothing.
3. In case the replaced content is not part of the project's Podfile, it means that either we have never added this Podfile or its content has been changed. In order to handle both cases first remove the plugin's Podfile from the project's one - this includes removing the whole content between # Begin Podfile <podfile> and # End Podfile for this Podfile to be removed from the project's one and all post_install hooks with name that would have been used for this plugin to be removed. After that add the replaced content in the project's Podfile and call all post_install replaced functions in the project's Podfile's post_install hook.
4. On afterPrepareAllPlugins do nothing with the Podfile, it is already processed.

This solution ensures the Podfile is correct after processing each plugin. The previous one relyed on the afterPrepareAllPlugins to fix the project's Podfile. Also, by using well known pattern for generating the post_install hooks, we ensure we can remove them from the final Podfile whenever is required.

PR Checklist

• The PR title follows our guidelines: https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages.
• There is an issue for the bug/feature this PR is for. To avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it.
• You have signed the CLA.
• All existing tests are passing: https://github.com/NativeScript/nativescript-cli/blob/master/CONTRIBUTING.md#contribute-to-the-code-base
• Tests for the changes are included.

What is the current behavior?

Applying a change in a plugin's Podfile, when it has postinstall hook, causes the iOS build to fail.

What is the new behavior?

Applying a change in a plugin's Podfile, when it has postinstall hook, removes the old plugin's Podfile from the project and adds the new content.

Fixes #3549

[Fatme]

typo? shouldn't be defaultContentWithoutPostInstallHook?

[Fatme]

Following the concept this should be pluginPodfilePath (lowercase f)

[Fatme]

pluginPodFileContent -> pluginPodfileContent

[Fatme]

Maybe we need to .trim() the content of file

[Fatme]

I'd like to unify the following method names:

getPathToPluginPodfile()
getProjectPodfilePath

We can use

getPathToPluginPodfile
getPathToProjectPodfile

or

getPluginPodfilePath
getProjectPodfilePath

I'm voting for the second option 😸

[Fatme]

Can we use here

const defaultPodfileBeginning  = this.getPodfileHeader(projectData.projectName)

[Fatme]

As we use a similar code here https://github.com/NativeScript/nativescript-cli/pull/3900/files#diff-e3190ab07db971b762e2395051443fc2R57, I'd suggest to extract the common part to separate method:

private getPostInstallHookHeader() {
    return `${CocoaPodsService.PODFILE_POST_INSTALL_SECTION_NAME} do |${CocoaPodsService.INSTALLER_BLOCK_PARAMETER_NAME}|${EOL}`
}

private addPostInstallHook(replacedFunctions: IRubyFunction[], finalPodfileContent: string, pluginPodFileContent: string): string {
    const postInstallHookStart = this.getPostInstallHookHeader();
}

[Fatme]

As we discussed personally we need to change this to:

`${hookName}${pluginName.replace(/[^A-Za-z0-9]/g, "_")}`;

[rosen-vladimirov]

run ci