gpnf-override-parent-merge-tag-on-submission.php: Added support to rename uploaded files in child entries.

[malayladu]

Context

⛑️ Ticket(s): https://secure.helpscout.net/conversation/2849364535/78123

Related PR: https://github.com/gravitywiz/gp-file-renamer/pull/22

Summary

The customer has a nested form with an Upload field. They are using the {Parent} merge tag in a field, and then using this in GPFR to name the uploaded file, based on a value in the parent form.

However, they want it so if the user changes the value on the parent form before submitting, the uploaded file is renamed.

[github-actions]

	Warnings
⚠️	When ready, don't forget to request reviews on this pull request from your fellow wizards.

Generated by 🚫 dangerJS against c62ed0b

[coderabbitai]

Walkthrough

This change adds a conditional branch to the override_child_entry_input_value method in the GPNF_Override_Parent_Merge_Tags class. The method now checks whether the GP File Renamer plugin is active and has a version greater than 1.0.9. If the conditions are met, it retrieves the updated child entry and calls the rename_uploaded_files method with the force parameter set to true.

Changes

File	Summary
gp-nested-forms/gpnf-override-parent-merge-tag-on-submission.php	Adds a conditional check for the GP File Renamer plugin (active and version >1.0.9). Retrieves the updated child entry and calls rename_uploaded_files(force:true) if conditions are met.

Sequence Diagram(s)

sequenceDiagram
    participant Submission as Submission Data
    participant ParentMergeTags as GPNF_Override_Parent_Merge_Tags
    participant FileRenamer as GP_File_Renamer
    participant ChildEntry as Child Entry

    Submission->>ParentMergeTags: Submit child entry data
    ParentMergeTags->>ParentMergeTags: Check GP File Renamer plugin status and version
    alt Plugin active and version >1.0.9
        ParentMergeTags->>ChildEntry: Retrieve updated child entry
        ParentMergeTags->>FileRenamer: Call rename_uploaded_files(force:true)
    else Plugin inactive or version <=1.0.9
        ParentMergeTags->>Submission: Continue without renaming
    end

Loading

Suggested Reviewers

• veryspry

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

gp-nested-forms/gpnf-override-parent-merge-tag-on-submission.php (1)

125-133: Well-implemented support for file renaming when parent form values change

The implementation correctly addresses the requirement to rename uploaded files in child entries when parent form values change. Good job on including version checking to ensure compatibility with the GP File Renamer plugin, and clearly explaining in the comment why version 1.0.9 specifically is required.

Consider adding a brief explanation of what the "force" parameter does in rename_uploaded_files() to improve future maintainability. For example:

- // Force the renaming of uploaded files if set.
+ // Force the renaming of uploaded files even if they were previously renamed, ensuring they reflect the updated parent form values.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 62668ca and c62ed0b.

📒 Files selected for processing (1)

• gp-nested-forms/gpnf-override-parent-merge-tag-on-submission.php (1 hunks)