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 SWXMLHash class to XMLHash #246

Merged
merged 4 commits into from
Sep 29, 2021
Merged

Conversation

drmohundro
Copy link
Owner

@drmohundro drmohundro commented Feb 13, 2021

Related to #242, see comment specifically at #242 (comment).

When creating an XCFramework and the .swiftinterface file is created, there are name conflicts. The expectation is that classes within a module wouldn't share the name with the module. Other OSS libraries like this (e.g. Alamofire) have introduced a new name like AF.

Of course, the hardest part here is naming... in this case, I just went with XMLHash by taking the SW prefix off.

I'm still open to other names for the actual type, though.

Things I want to understand prior to merging:

  • How the module name works when using in SPM vs CocoaPods vs Carthage, etc. I want to ensure that the docs are accurate across various dependency distributions.

@codecov
Copy link

codecov bot commented Feb 13, 2021

Codecov Report

Merging #246 (c61b98f) into main (8fe82e1) will not change coverage.
The diff coverage is 97.14%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #246   +/-   ##
=======================================
  Coverage   74.34%   74.34%           
=======================================
  Files          14       14           
  Lines        1910     1910           
=======================================
  Hits         1420     1420           
  Misses        490      490           
Impacted Files Coverage Δ
Source/XMLIndexer+XMLIndexerDeserializable.swift 68.94% <ø> (ø)
Tests/SWXMLHashTests/XMLHashConfigTests.swift 63.63% <50.00%> (ø)
Source/XMLHash.swift 83.41% <100.00%> (ø)
...ests/SWXMLHashTests/LazyTypesConversionTests.swift 70.96% <100.00%> (ø)
...ts/SWXMLHashTests/LazyWhiteSpaceParsingTests.swift 75.00% <100.00%> (ø)
Tests/SWXMLHashTests/LazyXMLParsingTests.swift 75.34% <100.00%> (ø)
...SWXMLHashTests/MixedTextWithXMLElementsTests.swift 60.00% <100.00%> (ø)
.../TypeConversionArrayOfNonPrimitiveTypesTests.swift 71.11% <100.00%> (ø)
...SWXMLHashTests/TypeConversionBasicTypesTests.swift 68.50% <100.00%> (ø)
...XMLHashTests/TypeConversionComplexTypesTests.swift 73.52% <100.00%> (ø)
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8fe82e1...c61b98f. Read the comment docs.

@drmohundro drmohundro mentioned this pull request Feb 13, 2021
@drmohundro drmohundro changed the title feat: rename SWXMLHash class to XMLHash WIP: rename SWXMLHash class to XMLHash Feb 19, 2021
@fgarciaDev
Copy link

In Texas and just getting power and everything back to "normal". Will try this out as soon as I can.

@drmohundro
Copy link
Owner Author

@fgarciaDev no worries, totally understand, I've got family in Texas. Stay safe and warm!

@fgarciaDev
Copy link

Tested by specifying this branch in my Swift.Package manifest file. Rebuilt my XCFramework and was able to integrate into new projects without the need to manually edit the generated *.swiftinterface files for this library. Appreciate the work!

@drmohundro
Copy link
Owner Author

Sounds great! I'd like to at least think about making some possible enhancements as this will be a major version bump. Not at all required, though, but that's my thought process. Sounds like you're good with referring to the branch still, correct? I don't want to cause any blockers for you, though, if I do that.

@fgarciaDev
Copy link

yes, pointing to your dev branch is fine for now. appreciate it!

@drmohundro drmohundro force-pushed the fix/rename-to-avoid-conflict branch from b40f525 to 70c4edf Compare September 28, 2021 01:41
@drmohundro drmohundro force-pushed the fix/rename-to-avoid-conflict branch from 70c4edf to 784f861 Compare September 28, 2021 01:55
@drmohundro drmohundro marked this pull request as ready for review September 29, 2021 01:32
@drmohundro drmohundro changed the title WIP: rename SWXMLHash class to XMLHash Rename SWXMLHash class to XMLHash Sep 29, 2021
@drmohundro drmohundro self-assigned this Sep 29, 2021
@drmohundro drmohundro merged commit 19219b4 into main Sep 29, 2021
@drmohundro drmohundro deleted the fix/rename-to-avoid-conflict branch September 29, 2021 01:34
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.

2 participants