Parse Constants

[Zintixx]

Summary by CodeRabbit

• New Features
  • Added support to parse and expose server table constants, enabling access to constant keys from constants data.
• Tests
  • Added test coverage for constants parsing.
• Chores
  • Bumped package version to 2.3.3.

[coderabbitai]

Walkthrough

Adds constants parsing to ServerTableParser via a new XmlSerializer and ParseConstants() method, updates tests to cover it, and bumps the package version in the project file.

Changes

Cohort / File(s)	Summary
Versioning Maple2.File.Parser/Maple2.File.Parser.csproj	Incremented NuGet PackageVersion from 2.3.2 to 2.3.3.
Parser Core Maple2.File.Parser/ServerTableParser.cs	Added a private XmlSerializer field for Constants, initialized in constructor; introduced public ParseConstants() yielding (string Key, Constants.Key key) from constants.xml.
Tests Maple2.File.Tests/ServerTableParserTest.cs	Added using for Maple2.File.Parser.Xml.Table and new TestConstants() to exercise ParseConstants().

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant ServerTableParser
  participant FS as constants.xml
  participant XS as XmlSerializer(Constants)

  Client->>ServerTableParser: ParseConstants()
  ServerTableParser->>FS: Open/read constants.xml
  ServerTableParser->>XS: Deserialize(stream)
  XS-->>ServerTableParser: Constants data
  loop for each entry in data.v
    ServerTableParser-->>Client: yield (Key, Constants.Key)
  end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Parse Server Item Options Tables #38 — Also modifies ServerTableParser to add a new XmlSerializer and Parse* method (ItemOption tables), touching the same component and pattern.

Suggested reviewers

• AngeloTadeucci

Poem

A nibble of constants, a hop through the xml,
I twitch my whiskers—new keys start to swell.
Serializer warmed, the tuples align,
Tests thump approval in rhythmic time.
Version hopped forward, 2.3.3’s tune—
Carrots for all, we’ll parse by the moon! 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title “Parse Constants” directly reflects the primary change introduced by the pull request, namely the addition of a new ParseConstants method and constants parsing logic. It is concise and specific, allowing a reviewer to immediately grasp the main feature without extraneous detail. The title avoids vague wording and focuses on the core functionality added. It captures the essence of the change in a single clear phrase.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 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 ba88efa and cd815b4.

📒 Files selected for processing (3)

• Maple2.File.Parser/Maple2.File.Parser.csproj (1 hunks)
• Maple2.File.Parser/ServerTableParser.cs (4 hunks)
• Maple2.File.Tests/ServerTableParserTest.cs (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2024-10-09T04:13:28.776Z

Learnt from: AngeloTadeucci
PR: AngeloTadeucci/Maple2.File#36
File: Maple2.File.Tests/TableParserTest.cs:777-783
Timestamp: 2024-10-09T04:13:28.776Z
Learning: In the 'Maple2.File' project, tests are designed to ensure methods can be called without errors; do not suggest adding assertions or validations in test methods.

Applied to files:

• Maple2.File.Tests/ServerTableParserTest.cs

🧬 Code graph analysis (2)

Maple2.File.Tests/ServerTableParserTest.cs (2)

Maple2.File.Parser/ServerTableParser.cs (2)

• ServerTableParser (21-705)
• ServerTableParser (63-112)

Maple2.File.Tests/TestUtils.cs (2)

• TestUtils (11-52)
• TestUtils (19-43)

Maple2.File.Parser/ServerTableParser.cs (3)

Maple2.File.Parser/TableParser.cs (16)

• IEnumerable (214-222)
• IEnumerable (224-232)
• IEnumerable (234-242)
• IEnumerable (244-252)
• IEnumerable (254-264)
• IEnumerable (266-278)
• IEnumerable (280-288)
• IEnumerable (290-298)
• IEnumerable (300-308)
• IEnumerable (310-318)
• IEnumerable (320-328)
• IEnumerable (330-338)
• IEnumerable (340-348)
• IEnumerable (350-364)
• IEnumerable (366-374)
• IEnumerable (376-384)

Maple2.File.Parser/Tools/Sanitizer.cs (2)

• Sanitizer (5-105)
• RemoveEmpty (85-87)

Maple2.File.IO/M2dReader.cs (2)

• GetString (64-67)
• XmlReader (43-45)

🔇 Additional comments (3)

Maple2.File.Parser/Maple2.File.Parser.csproj (1)

16-16: Version bump aligns with new parser surface.

Incrementing to 2.3.3 keeps the package version in step with the new public ParseConstants() entry point.

Maple2.File.Parser/ServerTableParser.cs (1)

695-704: ParseConstants mirrors existing parsing patterns.

Using the shared sanitizer + XmlSerializer pipeline keeps the constants reader consistent with other table parsers, and exposing both key text and the raw model provides flexibility downstream.

Maple2.File.Tests/ServerTableParserTest.cs (1)

440-447: New constant smoke test matches our existing pattern.

Iterating ParseConstants() without extra assertions follows the project’s convention for verifying parser coverage. Based on learnings.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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 and usage tips.}