test(railfence): document 26-char convention and add unambiguous test…

[Atharv094]

Description

Added documentation and additional test vectors to the Rail Fence cipher
to resolve ambiguity around the commonly cited WEAREDISCOVEREDFLEEAATONCE example.

---

Related Issue

Closes #867

---

Type of Change

• Bug Fix
• New Feature
• Documentation
• Documentation
• UI/UX Improvement
• Refactoring
• Performance Improvement
• Accessibility

---

Changes Made

• Added comment above existing vector documenting the 26-character input convention and the 25-character ambiguity from some sources
• Added HELLOWORLD/2-rail vector (trivially hand-verifiable)
• Added ATTACKATDAWN/3-rail vector (trivially hand-verifiable)

---

Testing

• Tested locally
• No console errors
• Existing functionality works as expected

---

Screenshots

N/A — no UI changes.

---

Checklist

• My code follows the project guidelines.
• I have tested my changes.
• I have updated the documentation if required.
• My changes address the related issue.
• This PR focuses on a single issue.

---

Additional Notes

All three test vectors confirmed via encryptFast. Encrypt→decrypt round-trips pass for all vectors.

Summary by CodeRabbit

• Tests
  • Added verified Rail Fence cipher test cases for two-rail and three-rail encryption examples.
  • Expanded explanatory comments for the existing 26-character example.

[vercel]

@Atharv094 is attempting to deploy a commit to the csxark's projects Team on Vercel.

A member of the Team first needs to authorize it.

[github-actions]

🎉 Thank You for Your Contribution

Hello @Atharv094,

Thank you for submitting a Pull Request to CryptoViz. We appreciate the time and effort you've invested in contributing to the project.

Your Pull Request has been received successfully and will be reviewed by the maintainers as soon as possible.

📋 Pull Request Checklist

• ✅ Linked the related issue
• ✅ No merge conflicts
• ✅ Synced with the latest main branch
• ✅ Build passes successfully
• ✅ All tests pass

Ensuring these requirements are met helps streamline the review process and enables maintainers to review your contribution more efficiently.

❤️ Support CryptoViz

If you find CryptoViz helpful, consider supporting the project by:

• ⭐ Starring the repository
• 🍴 Forking the repository
• 👤 Following Ark on GitHub
• 💼 Connecting on LinkedIn
• 🌐 Visiting the Portfolio

Your support helps increase the project's visibility and encourages continued development. Thank you for being a part of the CryptoViz community!

Thank you once again for contributing to CryptoViz. We appreciate your support and look forward to reviewing your contribution.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: eac14dcb-59e0-48bf-b96d-9f65888faef9

📥 Commits

Reviewing files that changed from the base of the PR and between 42227fa and 937af0a.

📒 Files selected for processing (1)

• lib/cipher/classical/railfence.ts

---

📝 Walkthrough

Walkthrough

The Rail Fence test vectors now document the existing 26-character example and include additional encryption vectors for HELLOWORLD with 2 rails and ATTACKATDAWN with 3 rails.

Changes

Rail Fence test vector updates

Layer / File(s)	Summary
Documented and expanded vectors lib/cipher/classical/railfence.ts	The existing 26-character vector now includes explanatory documentation. The vector set adds encryption cases for HELLOWORLD with 2 rails and ATTACKATDAWN with 3 rails.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested labels: good-pr, ECSoC26-L1

Suggested reviewers: csxark

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the Rail Fence documentation update and addition of an unambiguous test vector.
Linked Issues check	✅ Passed	The changes satisfy issue #867 by documenting the convention and adding verified unambiguous vectors with round-trip validation.
Out of Scope Changes check	✅ Passed	All changes are limited to Rail Fence test-vector documentation and coverage requested by issue #867.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

_{Comment @coderabbitai help to get the list of available commands.}

[Atharv094]

@csxark The CI failures are pre-existing and unrelated to this PR. All failures are in skipjack.test.ts, rainbowTable.test.ts, benchmark.test.ts, and other files not touched by this PR. This PR only modifies lib/cipher/classical/railfence.ts (+23 lines of comments and test vectors). The railfence tests themselves pass.

[github-actions]

🎉 Pull Request Merged

Hello @Atharv094,

Thank you for your contribution to CryptoViz. Your Pull Request has been reviewed and successfully merged into the project.

We sincerely appreciate the time and effort you invested in improving the project. Contributions like yours help make CryptoViz better for the entire community.

We look forward to your future contributions and hope to collaborate with you again.

❤️ Support CryptoViz

If you find CryptoViz helpful, consider supporting the project by:

• ⭐ Starring the repository
• 🍴 Forking the repository
• 👤 Following Ark on GitHub
• 💼 Connecting on LinkedIn
• 🌐 Visiting the Portfolio

Your support helps increase the project's visibility and encourages continued development. Thank you for being a part of the CryptoViz community!