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.

Sign up for GitHub

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

Jump to bottom

refactor!: change key format from camel case or snake case to lower hyphen #398

Merged
merged 19 commits into from
Mar 14, 2023
Merged

refactor!: change key format from camel case or snake case to lower hyphen #398

merged 19 commits into from
Mar 14, 2023

Conversation

matthiasschaub
Copy link
Collaborator

@matthiasschaub matthiasschaub commented Jul 19, 2022 •
edited

Description

Make indicator and report keys as well as API parameters consistent by changing the format from camel case or snake case to lower hyphen.

Throughout the code base indicator and report keys where changed from camel case (MappingSaturation) to lower hyphen (mapping-saturation).

API parameter and variable names where changed from lower camel case (layerKey) to lower hyphen (layer-key) in the case of API paramter or snake-case (layer_key) in the case of variable names.

Layer keys have not been changed from snake case to hyphen case.

Corresponding issue

Related issues: #485 #50

Checklist

  • I have updated my branch to main (e.g. through git rebase main)
  • My code follows the style guide and was checked with pre-commit before committing
  • I have added sufficient unit and integration tests
  • I have updated the CHANGELOG.md
  • fix tests
  • remove unused helper functions
  • update website

@matthiasschaub matthiasschaub mentioned this pull request Jul 19, 2022
Closed
6 tasks
@matthiasschaub matthiasschaub changed the title Lower hyphen keys Change key format from camel case or snake case to lower hyphen #386 Jul 19, 2022
@matthiasschaub matthiasschaub marked this pull request as draft July 19, 2022 17:28
@matthiasschaub matthiasschaub added code quality Related to our standards for 'good' code breaking This will break previous versions. Documentation and Changelog update compulsory api labels Jul 22, 2022
@matthiasschaub matthiasschaub force-pushed the lower-hyphen-keys branch 2 times, most recently from e3efb19 to 88ef479 Compare March 7, 2023 16:03
@matthiasschaub matthiasschaub changed the title Change key format from camel case or snake case to lower hyphen #386 refactor!: change key format from camel case or snake case to lower hyphen #386 Mar 7, 2023
@matthiasschaub matthiasschaub changed the title refactor!: change key format from camel case or snake case to lower hyphen #386 refactor!: change key format from camel case or snake case to lower hyphen Mar 7, 2023
@matthiasschaub matthiasschaub marked this pull request as ready for review March 7, 2023 16:59
@matthiasschaub matthiasschaub self-assigned this Mar 13, 2023
joker234
joker234 requested changes Mar 14, 2023
View reviewed changes
workers/tests/integrationtests/test_api_report.py Show resolved Hide resolved
workers/tests/integrationtests/test_api_report.py Show resolved Hide resolved
workers/tests/integrationtests/test_api_report_geojson_io.py Show resolved Hide resolved
workers/tests/unittests/test_helper.py Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
joker234
joker234 previously approved these changes Mar 14, 2023
View reviewed changes
@matthiasschaub
refactor: do not use from_dict to create instance
db53cf2 
Do not use dacite.from_dict to create instance of Metadata class.
@matthiasschaub
refactor: convert snake-case keys to lower hyphen
f3b0f5c 
indicator and report keys are now lower hyphen instead of snake-case
@matthiasschaub
feat(helper): add snake_to_hyphen function
a02954f
@matthiasschaub
refactor!(api): change param alias to hyphen case
dc1a972 
and allow population of pydantic model by field name
@matthiasschaub
feat(helper): add funcs to convert hyphen strings
274d409
@matthiasschaub
test: rename layerKey to layer_key
6da2c23 
grep -rl layerKey | xargs sed -i 's/layerKey/layer_key/g'
@matthiasschaub
refactor: rename featureId to feature_id
c018c0b 
grep -rl featureId | xargs sed -i 's/featureId/feature_id/g'
@matthiasschaub
refactor: rename caps indicator key to hyphen case
865420e
@matthiasschaub
test: use hyphen case for parameters
ba83b8e
@matthiasschaub
fix: spell fix parameter name of API example
9e10117
@matthiasschaub
chore: update changelog
267cd40
@matthiasschaub
fix(api): change wrong layer key in examples
d568217
@matthiasschaub matthiasschaub merged commit 3741077 into main Mar 14, 2023
@matthiasschaub matthiasschaub deleted the lower-hyphen-keys branch March 14, 2023 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joker234 joker234 joker234 approved these changes

Assignees

@matthiasschaub matthiasschaub

Labels
api breaking This will break previous versions. Documentation and Changelog update compulsory code quality Related to our standards for 'good' code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@matthiasschaub @joker234