Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: copy/paste images into tier list #146

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Selenestica
Copy link
Contributor

@Selenestica Selenestica commented Dec 31, 2024

Fixes: #107

Description

Users can copy an image from the internet and paste it into the tier list, removing the need for users to download images from the internet and then upload them.

Checklist:

  • My changes generate no new warnings or errors
  • I have verified that these changes don't negatively impact performance
  • Also optimized for mobile layouts

Additional context

  • No rhetoric was added to let users know that this is a new feature
  • Pasted image names are always "Pasted Image{unique ID}"
  • If too many images are pasted (seemingly around 40 images or so), the browser's local storage will prevent more images from being added

Summary by CodeRabbit

  • New Features

    • Enhanced drag-and-drop tier list with improved item creation and management functionality
    • Added methods to handle image URL conversion and item resolution
    • Introduced new utility methods for managing tier list assets
  • Improvements

    • Refined code readability and formatting across multiple components
    • Improved handling of item deletions and restorations
    • Enhanced URL and image handling for better compatibility
  • Code Maintenance

    • Standardized code formatting and spacing
    • Updated import statements and method signatures

Copy link

vercel bot commented Dec 31, 2024

@Selenestica is attempting to deploy a commit to the Infinia Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Dec 31, 2024

Walkthrough

This pull request introduces enhancements to the tier list functionality, focusing on improving item management and image handling. The changes span across three files: DragDropTierList.tsx, TierListManager.tsx, and TierCortex.ts. The modifications primarily involve adding new methods for item creation, pasting items, and handling image URLs, along with formatting improvements for better code readability.

Changes

File Change Summary
components/DragDropTierList.tsx - Added onItemsCreate prop to DragDropTierListProps interface
- Implemented onPasteItem function in TierRow component
- Updated onDragEnd and item deletion handling
components/TierListManager.tsx - Reformatted import statements and code structure
- No functional changes
lib/TierCortex.ts - Added methods: getOgSafeImageUrl, getOgSafeItem
- Added resolveItemsFromPackage and getAssetUrl
- Improved code formatting and consistency

Assessment against linked issues

Objective Addressed Explanation
Paste images from clipboard [#107]
Avoid local storage of images

Possibly related PRs

Suggested reviewers

  • infinia-yzl

Poem

🐰 A rabbit's tale of tiers so bright,
Dragging, dropping with pure delight,
Paste an image, watch it fly,
No downloads needed, just catch it on the fly!
Tier list magic, code so clean,
A programmer's dream supreme! 🎨

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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
🪧 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. (Beta)
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
components/DragDropTierList.tsx (2)

119-144: Consider using for...of instead of for...in for clipboard items.
Within the onPasteItem method, for...in iterates over all enumerable properties, which may include unintended keys. Switching to for...of (or using array methods) would be more robust when processing items.

-for (const index in items) {
-    const item = items[index];
+for (const item of items) {

144-144: Possible storage-size constraints.
Storing base64-encoded images in localStorage may cause size limitations if users paste numerous or large images. Consider an alternative storage mechanism (e.g., IndexedDB) or controlling maximum uploads to avoid potential out-of-space issues.

Would you like suggestions for leveraging IndexedDB or an alternative storage strategy?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 92f09d0 and cf36787.

📒 Files selected for processing (3)
  • components/DragDropTierList.tsx (1 hunks)
  • components/TierListManager.tsx (1 hunks)
  • lib/TierCortex.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • components/TierListManager.tsx
🧰 Additional context used
🪛 Biome (1.9.4)
lib/TierCortex.ts

[error] 93-93: Do not access Object.prototype method 'hasOwnProperty' from target object.

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

(lint/suspicious/noPrototypeBuiltins)

🔇 Additional comments (4)
components/DragDropTierList.tsx (2)

20-21: New prop for item creation looks correct.
The addition of onItemsCreate to the props interface is consistent with the rest of the code, enabling callbacks for newly pasted or created items.


309-343: Deletion workflow is well-structured.
The handleDeleteItem and handleUndoDelete functions effectively manage item removal, using toast-based undo actions and a shared deletedItemsRef. This pattern is clear and maintainable.

lib/TierCortex.ts (2)

189-208: New utility methods effectively safeguard URLs.
The getOgSafeImageUrl and getOgSafeItem methods ensure WebP URLs are converted to PNG and that relative paths become absolute. This helps maintain consistent rendering across various environments.


210-217: Package resolution and asset fetching logic is sound.
The resolveItemsFromPackage method properly constructs item IDs, while getAssetUrl defers to getAbsoluteUrl to produce absolute paths. These enhancements promote modular code and reusability.

Also applies to: 220-221

Comment on lines +92 to +93
public isCustomItem(itemId: string): boolean {
return !this.packageItemLookup.hasOwnProperty(itemId);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Avoid hasOwnProperty from the instance directly.
Static analysis warns about using .hasOwnProperty() from an object. It's safer and clearer to use Object.hasOwn() or Object.prototype.hasOwnProperty.call(...).

-public isCustomItem(itemId: string): boolean {
-    return !this.packageItemLookup.hasOwnProperty(itemId);
+public isCustomItem(itemId: string): boolean {
+    return !Object.hasOwn(this.packageItemLookup, itemId);
}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
public isCustomItem(itemId: string): boolean {
return !this.packageItemLookup.hasOwnProperty(itemId);
public isCustomItem(itemId: string): boolean {
return !Object.hasOwn(this.packageItemLookup, itemId);
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 93-93: Do not access Object.prototype method 'hasOwnProperty' from target object.

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

(lint/suspicious/noPrototypeBuiltins)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] option to copy and paste images from internet
1 participant