Feat/add tuple

[codefriar]

Summary by CodeRabbit

• New Feature: Introduced a new Tuple class to provide key-value pair functionality similar to Map, enhancing support for various primitive data types.
• Refactor: Updated method signatures across multiple classes for explicit type declarations, improving code clarity and maintainability.
• Chore: Modified GitHub Actions workflow file inputs and conditions for better CI/CD process control.
• Style: Improved documentation by updating return types and descriptions of several methods.
• Chore: Updated .gitignore and security rules in pmd/ruleset.xml for better repository management.

[github-actions]

CodeRabbit

Walkthrough

This pull request introduces a new Tuple class to provide key-value pair functionality in Apex, updates GitHub Actions workflow file, enhances code clarity by updating method return types across multiple classes, removes a file from the repository, and adds security rule exclusions in an XML file.

Changes

Files	Summary
Tuple.cls, Tuple.cls-meta.xml, docs/Tuple.md, docs/home.md	Introduced a new Tuple class that acts as a polyfill for the Map<String, Object> data type in Apex. It provides constructors, fields, and methods to work with various primitive data types.
.github/workflows/ci-pr.yml	Updated the GitHub Actions workflow file by modifying inputs for the openai-review-action step and commenting out the Create prerelease scratch org step.
Various docs/*.md files	Updated return types and descriptions of several methods across multiple classes for improved code clarity and maintainability.
.gitignore	Removed the "pmd/pmd.csv" file from the repository.
pmd/ruleset.xml	Added three exclude patterns related to security rules for Apex, preventing specific directories from being analyzed by the security rules.

🐇💻

Code changes here, code changes there,

A Tuple class appears, with much flair.

Workflow tweaks, and types made clear,

Security rules, have no fear.

Celebrate the changes, far and near,

For better code, we all cheer! 🎉🥳

---

Uplevel your code reviews with CodeRabbit Pro

CodeRabbit Pro

If you like this project, please support us by purchasing the Pro version. The Pro version has advanced context, superior noise reduction and several proprietary improvements compared to the open source version. Moreover, CodeRabbit Pro is free for open source projects.

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[github-actions]

CodeRabbit

Commits

Files that changed from the base of the PR and between 8c3b9aa and c00518b commits.

Files selected (4)

• docs/Tuple.md (1)
• docs/home.md (1)
• force-app/main/default/classes/Data Structures/Tuple.cls (1)
• force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml (1)

Files skipped from review due to trivial changes (2)

• docs/home.md
• force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml

Review comments generated (18)

• Review: 18
• LGTM: 0

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
• Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

• The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
• You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

• Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

[github-actions]

CodeRabbit

Commits

Files that changed from the base of the PR and between c00518b and 96372af commits.

Files selected (2)

• docs/Tuple.md (1)
• force-app/main/default/classes/Data Structures/Tuple.cls (1)

Files skipped from review due to trivial changes (1)

• docs/Tuple.md

Review comments generated (1)

• Review: 1
• LGTM: 0

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
• Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

• The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
• You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

• Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

[github-actions]

CodeRabbit

Commits

Files that changed from the base of the PR and between 96372af and 83a3a29 commits.

Files selected (2)

• docs/Tuple.md (1)
• force-app/main/default/classes/Data Structures/Tuple.cls (1)

Review comments generated (12)

• Review: 12
• LGTM: 0

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
• Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

• The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
• You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

• Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

[dschach]

I'm fascinated by this class. Seems you've accounted for every data type.
I added a comment for List.

[github-actions]

CodeRabbit

Commits

Files that changed from the base of the PR and between 83a3a29 and 19f70e5 commits.

Files selected (1)

• .github/workflows/ci-pr.yml (2)

Files skipped from review due to trivial changes (1)

• .github/workflows/ci-pr.yml

Review comments generated (0)

• Review: 0
• LGTM: 0

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
• Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

• The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
• You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

• Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

[github-actions]

CodeRabbit

Commits

Files that changed from the base of the PR and between 8c3b9aa and 19f70e5 commits.

Files selected (5)

• .github/workflows/ci-pr.yml (2)
• docs/Tuple.md (1)
• docs/home.md (1)
• force-app/main/default/classes/Data Structures/Tuple.cls (1)
• force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml (1)

Files skipped from review due to trivial changes (4)

• docs/Tuple.md
• docs/home.md
• force-app/main/default/classes/Data Structures/Tuple.cls
• force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml

Review comments generated (2)

• Review: 2
• LGTM: 0

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
• Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

• The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
• You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

• Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

[github-actions]

CodeRabbit

Commits

Files that changed from the base of the PR and between 19f70e5 and b140af0 commits.

Files selected (50)

• .github/workflows/ci-pr.yml (1)
• docs/BulkCallable.md (2)
• docs/CanTheUser.md (24)
• docs/CanTheUserTests.md (1)
• docs/CustomInvocable.md (5)
• docs/ExampleQueueableProcessSteps.md (1)
• docs/FF.md (3)
• docs/FailsafeExceptionHandler.md (1)
• docs/FeatureFlag.md (6)
• docs/FeatureFlagCommonTests.md (4)
• docs/FeatureFlagDataProvider.md (5)
• docs/HttpCalloutMockFactory.md (2)
• docs/IdFactory.md (6)
• docs/Log.md (1)
• docs/LogMessage.md (1)
• docs/LogTriggerHandler.md (3)
• docs/MetadataTriggerFramework.md (3)
• docs/MetadataTriggerQueryService.md (3)
• docs/MethodSignature.md (8)
• docs/MockedMethod.md (16)
• docs/OrgShape.md (5)
• docs/Ouroboros.md (2)
• docs/OuroborosFinalizer.md (1)
• docs/OuroborosTests.md (1)
• docs/Polyfills.md (10)
• docs/Query.md (1)
• docs/QueueableProcess.md (3)
• docs/QueueableProcessDataProvider.md (1)
• docs/QueueableProcessTests.md (1)
• docs/QuiddityGuard.md (2)
• docs/RestClient.md (1)
• docs/RestClientLib.md (13)
• docs/RestLib.md (1)
• docs/RestLibApiCall.md (1)
• docs/SOQL.md (1)
• docs/SOQLAgregate.md (1)
• docs/SOSL.md (1)
• docs/Safely.md (12)
• docs/SampleHandler.md (3)
• docs/Stub.md (9)
• docs/StubUtilities.md (2)
• docs/TestFactory.md (16)
• docs/TriggerContext.md (1)
• docs/TriggerFramework.md (3)
• docs/TriggerFrameworkLoopCount.md (1)
• docs/UFInvocable.md (7)
• docs/ULID.md (3)
• docs/UniversalBulkInvocable.md (2)
• docs/UniversalFlowInputOutput.md (1)
• docs/UniversalInvocable.md (2)

Files not summarized due to errors (1)

• docs/CanTheUser.md (diff tokens exceeds limit)

Files not reviewed due to errors (16)

• docs/FeatureFlagCommonTests.md (no response)
• docs/CanTheUser.md (no response)
• docs/FeatureFlagDataProvider.md (no response)
• docs/LogTriggerHandler.md (no response)
• docs/MetadataTriggerFramework.md (no response)
• docs/MethodSignature.md (no response)
• docs/OrgShape.md (no response)
• docs/MockedMethod.md (no response)
• docs/Ouroboros.md (no response)
• docs/QuiddityGuard.md (no response)
• docs/SOQL.md (no response)
• docs/Safely.md (no response)
• docs/Stub.md (no response)
• docs/TestFactory.md (no response)
• docs/UniversalBulkInvocable.md (no response)
• docs/UniversalFlowInputOutput.md (no response)

Files skipped from review due to trivial changes (28)

• .github/workflows/ci-pr.yml
• docs/CanTheUserTests.md
• docs/ExampleQueueableProcessSteps.md
• docs/FF.md
• docs/FailsafeExceptionHandler.md
• docs/FeatureFlag.md
• docs/IdFactory.md
• docs/Log.md
• docs/LogMessage.md
• docs/MetadataTriggerQueryService.md
• docs/OuroborosFinalizer.md
• docs/OuroborosTests.md
• docs/Polyfills.md
• docs/Query.md
• docs/QueueableProcess.md
• docs/QueueableProcessTests.md
• docs/RestClient.md
• docs/RestClientLib.md
• docs/RestLib.md
• docs/RestLibApiCall.md
• docs/SOQLAgregate.md
• docs/SampleHandler.md
• docs/StubUtilities.md
• docs/TriggerContext.md
• docs/TriggerFramework.md
• docs/TriggerFrameworkLoopCount.md
• docs/UFInvocable.md
• docs/ULID.md

Review comments generated (16)

• Review: 6
• LGTM: 10

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
• Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

• The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
• You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

• Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (671272e) 95.00% compared to head (56bec3a) 95.00%.
Report is 42 commits behind head on main.

❗ Current head 56bec3a differs from pull request most recent head b8a13cd. Consider uploading reports for the commit b8a13cd to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #122   +/-   ##
=======================================
  Coverage   95.00%   95.00%           
=======================================
  Files          32       32           
  Lines        2002     2002           
=======================================
  Hits         1902     1902           
  Misses        100      100           

Flag	Coverage Δ
Apex	95.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

CodeRabbit

Commits

Files that changed from the base of the PR and between 83a3a29 and b8a13cd commits.

Files selected (5)

• .github/workflows/ci-pr.yml (1)
• .gitignore (1)
• force-app/main/default/classes/dataStructures/Tuple.cls (1)
• force-app/main/default/classes/dataStructures/Tuple.cls-meta.xml (1)
• pmd/ruleset.xml (1)

Files ignored due to filter (1)

• config/project-scratch-def.json

Files skipped from review due to trivial changes (4)

• .github/workflows/ci-pr.yml
• .gitignore
• force-app/main/default/classes/dataStructures/Tuple.cls-meta.xml
• pmd/ruleset.xml

Review comments generated (1)

• Review: 1
• LGTM: 0

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
• Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

• The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
• You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

• Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

[github-actions]

CodeRabbit

The Tuple class seems to be well implemented. It provides a way to store different types of data in a single object, which can be useful in certain scenarios where the type of data is not known beforehand or can vary. The use of AuraEnabled and InvocableVariable annotations makes this class usable in Salesforce's Lightning Web Components and Flows respectively.

However, there are some potential improvements that could be made:

1. Error Handling: In the constructor public Tuple(String key, Object value), you're throwing exceptions if either the key or value is null. While it's good to validate inputs, consider if this is the best approach for your use case. If null values are expected or acceptable in some scenarios, this could lead to unnecessary exceptions being thrown.

2. Maintainability: The determineTypeAndSetCastedValue(Object value) method has a high cyclomatic complexity due to the many conditional branches. This could make the code harder to maintain and test. Consider refactoring this into smaller methods or using a design pattern such as the Strategy pattern to handle different types.

3. Performance: Each time a new Tuple object is created, the determineTypeAndSetCastedValue(Object value) method runs through a series of if statements until it finds the correct type. This could potentially impact performance if a large number of Tuple objects are being created. Consider optimizing this logic.

4. Security: The Tuple class includes fields for storing SObject and List<SObject> types. Be aware that exposing SObjects directly can potentially expose sensitive data or allow for DML operations that bypass the usual security checks. Ensure that any usage of these fields respects the user's permissions and sharing rules.

5. Consistency: The class uses both singular and plural field names (e.g., booleanValue and booleans). This could potentially cause confusion. Consider adopting a consistent naming convention.

Here's an example of how you might refactor the determineTypeAndSetCastedValue(Object value) method to reduce its complexity:

private void determineTypeAndSetCastedValue(Object value) {
    if (value instanceof Boolean) {
        setBooleanValue(value);
    } else if (value instanceof List<Boolean>) {
        setBooleansValue(value);
    } else if (value instanceof Datetime) {
        setDatetimeValue(value);
    } // ... continue for each type
}

private void setBooleanValue(Object value) {
    this.booleanValue = (Boolean) value;
}

private void setBooleansValue(Object value) {
    this.booleans = (List<Boolean>) value;
}

private void setDatetimeValue(Object value) {
    this.dateTimeValue = (Datetime) value;
}

// ... continue for each type

This approach breaks down the large method into smaller, more manageable methods, each responsible for setting a specific type of value. It also makes it easier to add or remove support for types in the future.