search

JhumanJ / OpnForm

Beautiful Open-Source Form Builder
https://opnform.com
GNU Affero General Public License v3.0
2.26k stars 303 forks source link

variables and mentions #590

Closed madassdev closed 1 month ago

madassdev commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces multiple changes across various classes and components. Key modifications include updates to validation rules in the SubmissionConfirmationIntegration class, enhancements to the SubmissionConfirmationMail class for improved data handling, and the creation of a new MentionParser class for parsing mentions. Additionally, new components such as MentionInput, FormSubmissionFormatter, and MentionDropdown have been added to support mention functionality in the user interface. The configuration for HTMLPurifier has been updated, and several existing components have been modified to incorporate these new features.

Changes

File Path Change Summary
api/app/Integrations/Handlers/SubmissionConfirmationIntegration.php Updated validation rules for confirmation_reply_to, enhanced formatData method for data purification. Added validateEmail method.
api/app/Mail/Forms/SubmissionConfirmationMail.php Added $formattedData property, modified constructor and build method, introduced getSubject and getNotificationBody methods.
api/app/Open/MentionParser.php Introduced MentionParser class with methods for parsing and replacing mentions.
api/app/Service/HtmlPurifier/OpenFormsHtmlDefinition.php Added OpenFormsHtmlDefinition class with custom attributes for mentions.
api/config/purify.php Updated configuration to use OpenFormsHtmlDefinition instead of Html5Definition.
client/components/forms/MentionInput.vue Added MentionInput component for mention functionality with various exposed methods.
client/components/forms/RichTextAreaInput.client.vue Updated to integrate mention functionality with new props and conditional rendering of MentionDropdown.
client/components/forms/components/FormSubmissionFormatter.js Introduced FormSubmissionFormatter class for formatting submission data.
client/components/forms/components/MentionDropdown.vue Added MentionDropdown component for selecting mentions.
client/components/open/forms/OpenCompleteForm.vue Updated to manage submitted data and utilize TextBlock for rendering.
client/components/open/forms/components/FirstSubmissionModal.vue Updated backdrop-blur property type from string to boolean.
client/components/open/forms/components/form-components/FormSubmissionSettings.vue Added enable-mentions property for mention functionality in success page text.
client/data/blocks_types.json Added is_input property for input types and marked non-input types accordingly.
client/lib/quill/quillMentionExtension.js Introduced custom Quill editor extension for handling mentions with MentionBlot and MentionModule.
api/tests/Unit/Service/Forms/MentionParserTest.php Added unit tests for the MentionParser class to validate parsing functionality.
client/components/forms/TextBlock.vue Introduced a new component to render HTML content dynamically based on provided props.

Possibly related PRs

Suggested reviewers

Poem

Hop, hop, hooray, what a sight to see,
Mentioning friends, as happy as can be!
With fields now refined and data so neat,
Our forms come alive, oh, what a treat!
So let’s celebrate this change with cheer,
For every mention brings us near! 🐇✨

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 4c19d6632c14029f53d7a3d32305a0c4ceca6041 and 5ffec25000d2fe76b3b4b496857f7f1412502cb0.
📒 Files selected for processing (1) * api/app/Open/MentionParser.php (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * api/app/Open/MentionParser.php
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
JhumanJ commented 1 month ago

Closing in favor of https://github.com/JhumanJ/OpnForm/pull/595