deprecate: deprecate ImageCrop(Image) constructor

[javier-godoy]

Close #24

Summary by CodeRabbit

• Chores

  • Updated project version to 1.2.0-SNAPSHOT.

• Deprecations

  • Marked the constructor that accepts an Image object as deprecated and updated its documentation to recommend using the constructor that accepts a String instead.

[coderabbitai]

Walkthrough

The project version in pom.xml was updated from 1.1.3-SNAPSHOT to 1.2.0-SNAPSHOT. In ImageCrop.java, the constructor ImageCrop(Image image) was marked as deprecated, both with an annotation and an updated Javadoc comment recommending use of the alternative constructor.

Changes

Cohort / File(s)	Change Summary
Version Update pom.xml	Project version incremented from 1.1.3-SNAPSHOT to 1.2.0-SNAPSHOT.
Deprecate Constructor .../ImageCrop.java	Marked ImageCrop(Image image) constructor as deprecated with annotation and Javadoc update.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Deprecate ImageCrop(Image) constructor (#24)	✅

Suggested reviewers

• mlopezFC

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 82ad661 and ee07d74.

📒 Files selected for processing (1)

• src/main/java/com/flowingcode/vaadin/addons/imagecrop/ImageCrop.java (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/main/java/com/flowingcode/vaadin/addons/imagecrop/ImageCrop.java

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch deprecate-24

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests 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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8fcf058 and 82ad661.

📒 Files selected for processing (2)

• pom.xml (1 hunks)
• src/main/java/com/flowingcode/vaadin/addons/imagecrop/ImageCrop.java (1 hunks)

🔇 Additional comments (2)

pom.xml (1)

7-7: LGTM! Appropriate version increment for deprecation.

The minor version bump from 1.1.3-SNAPSHOT to 1.2.0-SNAPSHOT correctly follows semantic versioning practices when introducing deprecations while maintaining backward compatibility.

src/main/java/com/flowingcode/vaadin/addons/imagecrop/ImageCrop.java (1)

74-78: LGTM! Proper deprecation implementation.

The deprecation annotation correctly specifies forRemoval = true and since = "1.2.0", aligning with the version update in pom.xml. The constructor implementation remains unchanged, preserving backward compatibility while clearly signaling the deprecation to developers.

[paodb]

LGTM