deprecate: deprecate a public attribute

[javier-godoy]

This should be merged after #143 which already increments the POM version.

Summary by CodeRabbit

• New Features

  • Added documentation to clarify the handling of the totalcells variable in the export process.

• Deprecations

  • Marked the totalcells variable as deprecated, signaling its phased-out usage in future versions.

[coderabbitai]

Walkthrough

The pull request introduces two main changes related to the totalcells variable in the GridExporter class. First, a comment has been added to the fillData method in the DocxStreamResourceWriter class to clarify the purpose of incrementing totalcells. Second, the totalcells variable in the GridExporter class has been marked as deprecated, indicating its limited use during DOCX exports and signaling an intention to phase it out in future versions.

Changes

File	Change Summary
src/main/java/com/flowingcode/vaadin/addons/gridexporter/DocxStreamResourceWriter.java	Added a comment in the fillData method to clarify the purpose of incrementing the totalcells variable.
src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java	Marked the totalcells variable as deprecated, indicating its limited use and future phase-out intention.

Possibly related PRs

• Javadoc fixes #141: The changes in the GridExporter class documentation are related to the main PR as they both involve modifications to the GridExporter class, specifically concerning the totalcells variable and its documentation.

Suggested reviewers

• mlopezFC
• paodb

Poem

🐇 In the code where rabbits play,
A variable's marked, it won't stay.
With comments bright, we clarify,
As totalcells bids goodbye.
Hopping forth, our code will shine,
In future versions, all will be fine! 🌟

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[sonarqubecloud]

Quality Gate failed

Failed conditions
D Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7ac1962 and 31efeb0.

📒 Files selected for processing (2)

• src/main/java/com/flowingcode/vaadin/addons/gridexporter/DocxStreamResourceWriter.java (1 hunks)
• src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/main/java/com/flowingcode/vaadin/addons/gridexporter/DocxStreamResourceWriter.java

[javier-godoy]

Part of #149