feat: add allow_extra attribute to DataQualityAttribute struct and adjust method visibility in derive.rs

[miseyu]

Summary by CodeRabbit

• New Features
  • Enhanced DataQualityAttribute struct to allow additional fields in serialized output.
• Improvements
  • Updated method signature for into_object in the CityGmlElement trait, improving code readability while maintaining functionality.

[coderabbitai]

Walkthrough

The pull request introduces two minor modifications across different files in the Nusamai CityGML project. In the derive.rs macro file, there's a subtle update to the method signature for into_object, primarily involving indentation. In the common.rs model file, a new #[citygml(allow_extra)] attribute is added to the DataQualityAttribute struct, enabling more flexible data handling by allowing additional fields during serialization.

Changes

File	Change Summary
nusamai-citygml/macros/src/derive.rs	Updated method signature for into_object with indentation modification
nusamai-plateau/src/models/iur/uro/common.rs	Added #[citygml(allow_extra)] attribute to DataQualityAttribute struct

Poem

🐰 A macro's dance, a struct's new grace,
Indentation shifts with subtle trace,
Extra fields now welcome to stay,
In CityGML's flexible way,
Rabbit code hops with playful might! 🌟

---

📜 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 1eac330 and 23199ad.

📒 Files selected for processing (2)

• nusamai-citygml/macros/src/derive.rs (1 hunks)
• nusamai-plateau/src/models/iur/uro/common.rs (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• nusamai-citygml/macros/src/derive.rs

🔇 Additional comments (1)

nusamai-plateau/src/models/iur/uro/common.rs (1)

4-4: New allow_extra attribute successfully broadens flexibility.

This addition appears consistent with the macros in derive.rs and should allow for more robust handling of extra, unstructured data. However, confirm that this relaxed schema does not inadvertently accept unintended fields in other parts of the CityGML pipeline.

You can run this script to scan for references to DataQualityAttribute and confirm the usage aligns with the new allow_extra attribute:

✅ Verification successful

Let me analyze the search results for DataQualityAttribute usage across the codebase. The results show:

1. The DataQualityAttribute struct in common.rs is widely used across different modules as an optional field
2. It's consistently used with the Option<> wrapper, indicating it's already designed to handle missing data
3. The test data shows XML examples with quality attributes being properly parsed
4. The attribute is used in various contexts (buildings, zones, transportation, etc.) with specific path mappings

Let me verify one more aspect about the schema handling:

---

allow_extra attribute is safely applied and consistent with existing usage

The allow_extra attribute is already used in several core data structures (Address, AddressDetail, Country, ParameterizedTexture) that need to handle flexible schemas. Adding it to DataQualityAttribute follows the same pattern and is safe because:

1. It's used on an optional field (Option<DataQualityAttribute>) across all implementations
2. The attribute is consistently applied to container-like structures that may need to accommodate schema variations
3. The test data demonstrates proper XML parsing with the quality attributes

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify usage of `DataQualityAttribute` across the codebase and check if there's any assumption of a strictly defined schema.
# We'll look for relevant lines around usages to ensure there's no conflict.

rg 'DataQualityAttribute' -A 5

Length of output: 92152

---

Script:

#!/bin/bash
# Check how allow_extra is used in other structs and if there's any schema validation logic
rg "#\[citygml\(allow_extra" -A 2

Length of output: 1068

---

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>, 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.