Skip to content

Deprecate xml simple config #256

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ehuelsmann
Copy link
Member

Description

Deprecate XML: Warn when used and replace documentation with YAML instead of XML

Closes #125

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project, please see the contribution guidelines.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@ehuelsmann ehuelsmann requested review from jonasbn and oliwel February 1, 2025 19:57
- name: filesize_cap
class: MyApp::Validator::FileSizeCap
param:
- name: max_size
Copy link
Member Author

Choose a reason for hiding this comment

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

Would have been nice to have had a hash instead of an array. Are we too far on the 2.x release line?

   param:
     max_size: 20M

Thinking about the options: maybe we can support both arrays (of hashes with the name/value keys) and plain hashes?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sound like a path if we do as you suggest, then we could phase out plain hashes with 3.0, but allow for both in 2.X - if I understand your comment correctly

@coveralls
Copy link

Pull Request Test Coverage Report for Build 13091927006

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.006%) to 92.173%

Totals Coverage Status
Change from base Build 13089997065: 0.006%
Covered Lines: 1366
Relevant Lines: 1482

💛 - Coveralls

action:
- name: CreateUser
class: MyApp::Action::CreateUser
field:
Copy link
Member Author

Choose a reason for hiding this comment

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

Same comment as with the validator parameters above. Would have been much nicer to have;

   username:
      is_required: yes
   email:
     is_required: yes

@ehuelsmann
Copy link
Member Author

@jonasbn I think this is the documentation you were referring to?

Copy link
Collaborator

@jonasbn jonasbn left a comment

Choose a reason for hiding this comment

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

Hi @ehuelsmann

This is approved

@jonasbn
Copy link
Collaborator

jonasbn commented Jun 2, 2025

@ehuelsmann let me know if you have any additional questions or comments

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.

Evaluate option to deprecate use of XML for YAML
3 participants