Skip to content

Rename extractArrayStyleComponents and update method docs#418

Merged
emdobrin merged 4 commits intoadobe:feature/json-comparison-parityfrom
timkimadobe:feature/json-comparison-parity
Oct 9, 2023
Merged

Rename extractArrayStyleComponents and update method docs#418
emdobrin merged 4 commits intoadobe:feature/json-comparison-parityfrom
timkimadobe:feature/json-comparison-parity

Conversation

@timkimadobe
Copy link
Copy Markdown
Contributor

@timkimadobe timkimadobe commented Oct 6, 2023

Description

This PR renames the extractArrayStyleComponents -to-> extractArrayFormattedComponents to better reflect the intent of the method, and updates the method docs and usages.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

…ents to better reflect actual behavior

Update method documentation to reflect the rename and to better explain the logic
@timkimadobe timkimadobe changed the title Renam extractArrayStyleComponents and update method docs Rename extractArrayStyleComponents and update method docs Oct 6, 2023
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 6, 2023

Codecov Report

Merging #418 (2936230) into feature/json-comparison-parity (215616a) will not change coverage.
The diff coverage is n/a.

@@                       Coverage Diff                       @@
##           feature/json-comparison-parity     #418   +/-   ##
===============================================================
  Coverage                           96.77%   96.77%           
===============================================================
  Files                                  27       27           
  Lines                                1672     1672           
===============================================================
  Hits                                 1618     1618           
  Misses                                 54       54           

@timkimadobe timkimadobe requested a review from cdhoffmann October 6, 2023 17:23
@emdobrin emdobrin merged commit 55ff0ee into adobe:feature/json-comparison-parity Oct 9, 2023
timkimadobe added a commit that referenced this pull request Oct 12, 2023
* JSON comparison parity (utility only) (#401)

* Remove custom helper enums and refactor usages

Update documentation and code logic to match Android implementation

* Apply lint autocorrect

* Revert "Apply lint autocorrect"

This reverts commit 7f38d19.

* Apply lint autocorrect

* Reduce wordiness of file and line param descriptions

* Update documentation null to nil

* Update file and line param descriptions

* Add method documentation to all helper methods

Update param name of extractArrayStyleComponents to be more intuitively descriptive

* JSON comparison parity - test cases (#402)

* Achieves parity with the Android Edge test setup for JSON comparison

Splits coverage into parameterized and special case tests, and update provides more comprehensive systematic coverage

* Add additional test cases to validate type mismatch detection and all boolean cases

Update index helper comments based on changed values

* Update failure cases to check for unintended type casting

* Fix comment typo

* Extract inline actual AnyCodable creation to separate line for clarity

* Refactor wildcard index logic (#416)

* Refactor wildcard index access to flatten logic since different condition and replacement groups are not needed

* Reformat method documentation to bring them all together

* Rename variables to better reflect what each one stores

* Refactor wildcard array index extraction to strictly validate format

Extract wildcard array index extraction logic into separate function
Update usages, test cases, and method documentation

* Update test failure message to include example format

* Rename `extractArrayStyleComponents` and update method docs (#418)

* Rename the extractArrayStyleComponents -> extractArrayFormattedComponents to better reflect actual behavior

Update method documentation to reflect the rename and to better explain the logic

* Update parameter description

* Update method description

* Include information about removing escape character
@timkimadobe timkimadobe deleted the feature/json-comparison-parity branch October 16, 2023 22:29
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.

3 participants