Updated center text and image extension for UIButton

[qchenqizhi]

Checklist

• I checked the Contributing Guidelines before creating this request.
• New extensions are written in Swift 5.0.
• New extensions support iOS 10.0+ / tvOS 9.0+ / macOS 10.10+ / watchOS 2.0+, or use @available if not.
• I have added tests for new extensions, and they passed.
• All extensions have a clear comments explaining their functionality, all parameters and return type in English.
• All extensions are declared as public.
• I have added a changelog entry describing my changes.

[codecov]

Codecov Report

Merging #807 into master will increase coverage by 0.04%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #807      +/-   ##
==========================================
+ Coverage   92.17%   92.21%   +0.04%     
==========================================
  Files          97       97              
  Lines        3463     3482      +19     
==========================================
+ Hits         3192     3211      +19     
  Misses        271      271              

Flag	Coverage Δ
#ios	95.25% <100.00%> (+0.02%)	⬆️
#macos	81.66% <ø> (ø)
#tvos	92.93% <100.00%> (-2.31%)	⬇️

Impacted Files	Coverage Δ
...ources/SwifterSwift/UIKit/UIButtonExtensions.swift	100.00% <100.00%> (ø)

---

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 27808e7...4664aad. Read the comment docs.

[SwifterSwiftBot]

	4 Messages
📖	Thank you for submitting a pull request to SwifterSwift. The team will review your submission as soon as possible.
📖	iOS: Executed 643 tests, with 0 failures (0 unexpected) in 9.728 (11.394) seconds
📖	tvOS: Executed 611 tests, with 0 failures (0 unexpected) in 2.986 (3.989) seconds
📖	macOS: Executed 474 tests, with 0 failures (0 unexpected) in 0.627 (0.849) seconds

Generated by 🚫 Danger

[guykogus]

You're actually centring the image and label horizontally, with the image on top, IIUC? Can you please provide a screenshot to make it clear.

[LucianoPAlmeida]

LGTM!

[qchenqizhi]

You're actually centring the image and label horizontally, with the image on top, IIUC? Can you please provide a screenshot to make it clear.

Yes! look like that:

[LucianoPAlmeida]

cc @guykogus

[guykogus]

The main issue here is the name of the function. You're centring the content horizontally, not vertically. You're also positioning the image above the text. So maybe centerAlignImageAboveText? This is a really tricky one.
Any other suggestions? @LucianoPAlmeida @omaralbeik

[qchenqizhi]

Seems need review again, @guykogus @LucianoPAlmeida please help.

[LucianoPAlmeida]

@qchenqizhi Everything looks good to me, Just a minor typo :)

[guykogus]

Again, you're not aligning them vertically. In fact you're doing the same as the centerTextAndImage except that you're not overlapping them, you're setting the vertical ordering, which is probably what the original function should have done in the first place. So I think use the same name but without default parameter values (at least for imageAboveText), otherwise you can end up with compiler errors

Suggested change

	func alignTextAndImageVertically(imageAboveText: Bool = true, spacing: CGFloat = 6.0) {
	func centerTextAndImage(imageAboveText: Bool, spacing: CGFloat) {

[qchenqizhi]

I named it is shorted from: align image and text along the vertical axis, and omitted axis.
But even if my explanation is OK, I know the name is not a good name because it is easy to misunderstand.

So, how about merge the two centerTextAndImage methods and providing options like this:

enum ImagePosition {
    case aboveText
    case belowText
    case onTheLeftOfText
    case onTheRightOfText
}

func centerTextAndImage(image position: ImagePosition = .onTheLeftOfText, spacing: CGFloat)

[LucianoPAlmeida]

@qchenqizhi The problem with this approach is that specifically for the extensions on this project, we avoid creating new types, just as an overall rule to keep the extensions simpler, easy to just copy-paste ...

[qchenqizhi]

OK, in my case, the most commonly used is image above text and image on the left of text, so as guykogus suggested: use a bool parameter to identify the two types?

func centerTextAndImage(imageAboveText: Bool = false, spacing: CGFloat)

[guykogus]

Create a constant value so that you can reuse it to avoid constantly hard-coding the value (e.g. in the assertions).

Suggested change

	button.alignTextAndImageVertically(imageAboveText: true, spacing: 20)
	let spacing = CGFloat(20)
	button.alignTextAndImageVertically(imageAboveText: true, spacing: spacing)

[qchenqizhi]

Nice