Fixed Speedgrader file outline on unconventional tar files

[coder6583]

Description

• Changed it so the filename of a path is the last element instead of the 2nd element

Motivation and Context

The filenames in tar files made using .. are weird, like tartraversal2.tar.zip made with tar -cf tartraversal2.tar ../../Desktop/MossTest/autograde-Makefile ../../Desktop/MossTest/dave.c ../../Desktop/MossTest/hello.c. See screenshot below:

See issue #2111.

How Has This Been Tested?

After:

• Tested with tartraversal2.tar.zip ↑
• Tested with tar files made with both bsdtar and gnutar: bsdtars made on mac specifically have metadata that also appear in the file outline
  • I could not find a way to fix this, so one way to fix this might be to limit the tar command to be gnutar
• Tested with tar files with various directory levels

Types of changes

• Bug fix (non-breaking change which fixes an issue)

Checklist:

• I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting

Other issues / help required

Do you think this is enough, or should I try to hide the metadata in the tar files?

[coderabbitai]

Walkthrough

Walkthrough

The changes in lib/archive.rb involve refining the loop structures for better iteration over files and paths. The code now utilizes Ruby's each method for looping through files and introduces a different approach to iterating and handling paths in the sanitize_directories method.

Changes

File	Changes Summary
lib/archive.rb	- Switched from for loops to `files.each do

Possibly related issues

• autolab/Autolab#2111: The modifications to the sanitize_directories method could potentially address the issue with file outline errors in Speedgrader when unconventional archive structures are used. This suggests that the changes might improve the handling of such cases.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c83a7f0 and 3a2aa67.

Files selected for processing (1)

• lib/archive.rb (3 hunks)

Additional comments not posted (5)

lib/archive.rb (5)

74-74: Ensure File.cleanpath usage correctly handles edge cases in path normalization.

Please verify that File.cleanpath with rel_root = true correctly handles all edge cases, especially with paths containing multiple relative components like ././../.

---

48-48: Refactor to improve clarity and maintainability of nested file hierarchy recovery.

Consider refactoring the recoverHierarchy method to improve clarity. The nested loop and conditional logic can be simplified or broken down into smaller methods to enhance readability and maintainability.

---

Line range hint 15-15: Review the handling of special macOS files in get_files.

Ensure that the handling of special macOS files like __MACOSX, .DS_Store, and .metadata is consistent and correctly filters out these files from processing where necessary.

---

Line range hint 15-15: Check directory detection logic in get_files.

Verify that the looks_like_directory? method accurately identifies directories, especially in edge cases where non-directory paths might end with a slash due to formatting or errors.

---

Line range hint 15-15: Ensure correct handling of file indices in get_nth_file.

Confirm that the method get_nth_file correctly handles file indices, especially in cases where special files are skipped, which might affect the index count.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

[coderabbitai]

Actionable comments posted: 1

[damianhxy]

LGTM