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

Rename an API that has the same name as a new API in iOS SDK #1400

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Rename an API that has the same name as a new API in iOS SDK #1400

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2c542cc
Rename an API that has the same name as a new API in iOS SDK
crazytonyli Aug 13, 2024
29eedff
Fix the example app
crazytonyli Aug 13, 2024
81885e5
Use Xcode 15.4 on CI
crazytonyli Aug 13, 2024
a9d8dd1
Use Ruby 3
crazytonyli Aug 13, 2024
fc8861a
Fix Xcode's Fix-It code suggestions
crazytonyli Aug 15, 2024
a187d78
Update rubocop
crazytonyli Aug 15, 2024
e30d1b5
Use iOS 17.5 in unit tests
crazytonyli Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .buildkite/pipeline.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ common_params:
- automattic/a8c-ci-toolkit#3.0.1
# Common environment values to use with the `env` key.
env: &common_env
IMAGE_ID: xcode-15.0.1
IMAGE_ID: xcode-15.4

# This is the default pipeline – it will build and test the app
steps:
Expand Down
2 changes: 1 addition & 1 deletion .ruby-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.7.4
3.2.2
2 changes: 1 addition & 1 deletion ...asses/Converters/ElementsToAttributedString/Implementations/GenericElementConverter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ class GenericElementConverter: ElementConverter {
attachment.rootTagName = element.name
attachment.rawHTML = serializer.serialize(element)

let content = NSMutableAttributedString(attachment: attachment, attributes: attributes)
let content = NSMutableAttributedString(attachment: attachment, attributes: attributes, aztec: ())

if element.needsClosingParagraphSeparatorIncludingDescendants() {
content.append(NSAttributedString(.paragraphSeparator, attributes: attributes))
Expand Down
2 changes: 1 addition & 1 deletion Aztec/Classes/Converters/ElementsToAttributedString/Implementations/HRElementConverter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class HRElementConverter: AttachmentElementConverter {
let attributes = combine(attributes, with: representation)
let attachment = self.attachment(for: element)

let intrinsicRepresentation = NSAttributedString(attachment: attachment, attributes: attributes)
let intrinsicRepresentation = NSAttributedString(attachment: attachment, attributes: attributes, aztec: ())
let serialization = serialize(element, intrinsicRepresentation, attributes, false)

return (attachment, serialization)
Expand Down
2 changes: 1 addition & 1 deletion ...Classes/Converters/ElementsToAttributedString/Implementations/ImageElementConverter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class ImageElementConverter: AttachmentElementConverter {
contentSerializer serialize: ContentSerializer) -> (attachment: ImageAttachment, string: NSAttributedString) {

let attachment = self.attachment(for: element)
let intrinsicRepresentation = NSAttributedString(attachment: attachment, attributes: attributes)
let intrinsicRepresentation = NSAttributedString(attachment: attachment, attributes: attributes, aztec: ())
let serialization = serialize(element, intrinsicRepresentation, attributes, false)

return (attachment, serialization)
Expand Down
2 changes: 1 addition & 1 deletion ...Classes/Converters/ElementsToAttributedString/Implementations/VideoElementConverter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class VideoElementConverter: AttachmentElementConverter {
contentSerializer serialize: ContentSerializer) -> (attachment: VideoAttachment, string: NSAttributedString) {

let attachment = self.attachment(for: element)
let intrinsicRepresentation = NSAttributedString(attachment: attachment, attributes: attributes)
let intrinsicRepresentation = NSAttributedString(attachment: attachment, attributes: attributes, aztec: ())
let serialization = serialize(element, intrinsicRepresentation, attributes, false)

return (attachment, serialization)
Expand Down
12 changes: 10 additions & 2 deletions Aztec/Classes/Extensions/NSAttributedString+Attachments.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,15 @@ extension NSAttributedString
/// Helper Initializer: returns an Attributed String, with the specified attachment, styled with a given
/// collection of attributes.
///
@available(*, deprecated, renamed: "init(attachment:attributes:aztec:)", message: "This function has the same name as a new API in iOS 18")
public convenience init(attachment: NSTextAttachment, attributes: [NSAttributedString.Key: Any]) {
self.init(attachment: attachment, attributes: attributes, aztec: ())
}

/// Helper Initializer: returns an Attributed String, with the specified attachment, styled with a given
/// collection of attributes.
///
public convenience init(attachment: NSTextAttachment, attributes: [NSAttributedString.Key: Any], aztec: Void) {
Copy link

Choose a reason for hiding this comment

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

(nit) I would suggest converting it to a factory method with a prefix: NSAttributedString.aztec_make(attachment:attributes:). Does it need to be public?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This initialiser is available to both NSAttributedString and NSMutableAttributedString. It's not very straightforward to make a static function to return an instance of its receiver.

Does it need to be public?

I'm not sure. But I don't want to change the public API as part of this PR though, which is why I marked the original function as deprecated.

var attributesWithAttachment = attributes
attributesWithAttachment[.attachment] = attachment

Expand All @@ -27,8 +35,8 @@ extension NSAttributedString
let figcaption = Figcaption(defaultFont: UIFont.systemFont(ofSize: 14), storing: nil)

let figureAttributes = attributes.appending(figure)
let finalString = NSMutableAttributedString(attachment: attachment, attributes: figureAttributes)
let finalString = NSMutableAttributedString(attachment: attachment, attributes: figureAttributes, aztec: ())

let mutableCaption = NSMutableAttributedString(attributedString: caption)
mutableCaption.append(paragraphProperty: figure)
mutableCaption.append(paragraphProperty: figcaption)
Expand Down
2 changes: 1 addition & 1 deletion Aztec/Classes/NSAttributedString/Conversions/AttributedStringSerializer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ class AttributedStringSerializer {
let attachment = CommentAttachment()
attachment.text = node.comment

let content = NSMutableAttributedString(attachment: attachment, attributes: attributes)
let content = NSMutableAttributedString(attachment: attachment, attributes: attributes, aztec: ())

guard !node.needsClosingParagraphSeparator() else {
return appendParagraphSeparator(to: content, inheriting: attributes)
Expand Down
2 changes: 1 addition & 1 deletion Aztec/Classes/TextKit/TextView.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1472,7 +1472,7 @@ open class TextView: UITextView {
self?.undoTextReplacement(of: originalText, finalRange: finalRange)
})

let attachmentString = NSAttributedString(attachment: attachment, attributes: typingAttributes)
let attachmentString = NSAttributedString(attachment: attachment, attributes: typingAttributes, aztec: ())
storage.replaceCharacters(in: range, with: attachmentString)
selectedRange = NSMakeRange(range.location + NSAttributedString.lengthOfTextAttachment, 0)
notifyTextViewDidChange()
Expand Down
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ _None._

### New Features

_None._
* Mark `NSAttributedString.init(attachment:attributes:)` as deprecated, since it has the same name as a new API in iOS 18.
* Add a new `NSAttributedString.init(attachment:attributes:aztec:)` function.

### Bug Fixes

Expand Down
2 changes: 1 addition & 1 deletion Example/Example/EditorDemoController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ class EditorDemoController: UIViewController {
rightMargin -= view.safeAreaInsets.right

scrollInsets.right = -rightMargin
editorView.scrollIndicatorInsets = scrollInsets
editorView.horizontalScrollIndicatorInsets = scrollInsets
}

func updateTitleHeight() {
Expand Down
4 changes: 2 additions & 2 deletions Example/Example/UnknownEditorViewController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ class UnknownEditorViewController: UIViewController {
///
fileprivate(set) var saveButton: UIBarButtonItem = {
let saveTitle = NSLocalizedString("Save", comment: "Save Action")
return UIBarButtonItem(title: saveTitle, style: .plain, target: self, action: #selector(saveWasPressed))
return UIBarButtonItem(title: saveTitle, style: .plain, target: UnknownEditorViewController.self, action: #selector(saveWasPressed))
Copy link

Choose a reason for hiding this comment

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

This doesn't seem right 🤔
It's now setting a class as a target.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch! These are Xcode's code suggestions, which I blindly took... Addressed in fc8861a.

}()

/// Cancel Bar Button
///
fileprivate(set) var cancelButton: UIBarButtonItem = {
let cancelTitle = NSLocalizedString("Cancel", comment: "Cancel Action")
return UIBarButtonItem(title: cancelTitle, style: .plain, target: self, action: #selector(cancelWasPressed))
return UIBarButtonItem(title: cancelTitle, style: .plain, target: UnknownEditorViewController.self, action: #selector(cancelWasPressed))
}()

/// HTML Editor
Expand Down
6 changes: 3 additions & 3 deletions WordPressEditor/WordPressEditor.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -787,7 +787,7 @@
DYLIB_INSTALL_NAME_BASE = "@rpath";
INFOPLIST_FILE = WordPressEditor/Info.plist;
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
IPHONEOS_DEPLOYMENT_TARGET = 11.0;
IPHONEOS_DEPLOYMENT_TARGET = 12.0;
LD_RUNPATH_SEARCH_PATHS = (
"$(inherited)",
"@executable_path/Frameworks",
Expand Down Expand Up @@ -962,7 +962,7 @@
DYLIB_INSTALL_NAME_BASE = "@rpath";
INFOPLIST_FILE = WordPressEditor/Info.plist;
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
IPHONEOS_DEPLOYMENT_TARGET = 11.0;
IPHONEOS_DEPLOYMENT_TARGET = 12.0;
LD_RUNPATH_SEARCH_PATHS = (
"$(inherited)",
"@executable_path/Frameworks",
Expand Down Expand Up @@ -990,7 +990,7 @@
DYLIB_INSTALL_NAME_BASE = "@rpath";
INFOPLIST_FILE = WordPressEditor/Info.plist;
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
IPHONEOS_DEPLOYMENT_TARGET = 11.0;
IPHONEOS_DEPLOYMENT_TARGET = 12.0;
LD_RUNPATH_SEARCH_PATHS = (
"$(inherited)",
"@executable_path/Frameworks",
Expand Down