Skip to content
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

Rename classes #130

Open
dresslerdemos opened this issue Apr 16, 2024 · 0 comments
Open

Rename classes #130

dresslerdemos opened this issue Apr 16, 2024 · 0 comments
Labels
bc break Solving the issue will most likely break backward compatibility in some way. good first issue Good for newcomers quality improvement Enhancement of existing features
Milestone

Comments

@dresslerdemos
Copy link
Contributor

dresslerdemos commented Apr 16, 2024

  • What was previously named XyzBuilder* should now be named *Config*.
  • What was previously named *XyzConfig* should now be named Xyz (or XyzProperty* in rare cases).
  • The term "Type" should be preferred over "Resource".

Examples:

from to
ResourceConfig Schema
ResourceConfigInterface SchemaInterface
IdentifierConfigBuilder IdentifierConfig
ResourceConfigBuilderFromEntityGenerator TypeConfigGenerator
AbstractResourceConfigBuilder AbstractSchemaConfig
BaseSchemaBuilder BaseSchemaConfig
MagicResourceConfigBuilder MagicSchemaConfig
UnifiedResourceConfigBuilder ArraySchemaConfig
ResourceConfigBuilderInterface SchemaConfigInterface
PropertyConfigBuilderInterface PropertyConfigInterface
PropertyConfigInterface PropertyInterface
PropertyBuilderFactory PropertyConfigFactory

Also consider the future of the contained build* methods. When moving away from implying the builder pattern, it makes sense to at least rename these methods or even use a different approach.


Additional renamings:

from to
FieldsException FieldsetFormatException
ConditionParserInterface (and other "parsers" like its child classes) Something non-"parser", as a real parser has a very specific way of working
@dresslerdemos dresslerdemos added the quality improvement Enhancement of existing features label Apr 16, 2024
@dresslerdemos dresslerdemos added this to the 1.0.0 milestone Apr 16, 2024
@joorei joorei changed the title Rename configuration classes Rename classes Jun 7, 2024
@joorei joorei added good first issue Good for newcomers bc break Solving the issue will most likely break backward compatibility in some way. labels Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bc break Solving the issue will most likely break backward compatibility in some way. good first issue Good for newcomers quality improvement Enhancement of existing features
Projects
None yet
Development

No branches or pull requests

2 participants