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 things for Ably #9

Merged
merged 3 commits into from
Oct 28, 2020
Merged

Rename things for Ably #9

merged 3 commits into from
Oct 28, 2020

Conversation

lawrence-forooghian
Copy link
Collaborator

What's new

This is a preparatory step on the road to compiling SocketRocket directly into ably-cocoa, as described in this comment on ably/ably-cocoa#949.

It changes the naming so that things look like Ably code - specifically, replacing the SR namespace with ARTSR.

With this change, an application could in theory use both our SocketRocket fork and its own version of SocketRocket without experiencing any issues.

Notes

Normally, in a fork, a big rename like this would be something to be very careful about because it makes it very difficult to merge further changes from upstream. But the upstream project is well and truly dead, so I don't think we need be concerned.

Questions for reviewers

  • What's the best way to test this? I tried locally changing the Cartfile in ably-cocoa to point to this changed version, and I had 3 failing tests when running the tests inside Xcode 12. But I don't know whether that's to be expected or not. And I also pushed it to a private CocoaPods repository and checked that I was able to compile an app that uses this version of the library.
  • Do we need to bump the library version number now? Should that be part of this PR?

What's next

  • Once this is merged and the version number bumped, open a PR on ably-cocoa to update the SocketRocket dependency version.
  • After that, continue with the plan described in the aforementioned comment on Reduce library dependencies ably/ably-cocoa#949, by compiling this library directly into the SDK.

Using the regexp /(?<!ART)SR(?!unLoop)(?!ange)/.

And then handle the consequent changes that this requires - namely,
renaming files and updating the README.
This in particular affects the framework bundle identifiers, so that
our fork can coexist alongside the Facebook version.
Copy link

@QuintinWillison QuintinWillison left a comment

Choose a reason for hiding this comment

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

Looks good to me, delivering the rename per what was agreed. Thanks. 😁

In terms of your questions:

  • Failing Tests downstream: I can't see those relating to this change so we'll deal with that when we come to bring this in to ably-cocoa.
  • Library Version Number: Elsewhere we tend to create dedicated release PRs - which will run along the lines of what's documented in the ably-cocoa readme. So far in this repository discipline has been low and I can see both @ricardopereira and I have just committed version bumps straight to the main branch. 🙄 - I'm happy for you to either create a subsequent, dedicated release PR (only really needs to change s.version) or simply add a commit to this PR, as you prefer.

@lawrence-forooghian
Copy link
Collaborator Author

Great, thanks @QuintinWillison. I've added a commit to this PR, bumping the version. As discussed in Slack, I'll merge this and push a tag. Once I've been granted CocoaPods trunk access, I'll push a new version of the pod, too.

@lawrence-forooghian lawrence-forooghian merged commit cd89e29 into ably-forks:main Oct 28, 2020
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