features development

Author: ysoftware

README.md

@@ -11,44 +11,64 @@ Install with Cocoapods:
 pod 'appendAttributedString'
 ```
 
+Breaking changes in 1.2:
+
+*Removed:*
+```swift
+AttributesBuilder().paragraph(style: _)
+```
+
+*Added:*
+```swift
+AttributesBuilder().paragraphStyle(_)
+```
+
 Here's an example:
 
 ```swift
-let textView = UITextView()
+let label = UILabel()
+label.numberOfLines = 0
+view.backgroundColor = .darkGray
+
 let string = NSMutableAttributedString()
 
-// dynamic fonts
-string.appendHeadline("Life can rise,\n")
+.appendHeadline("Life can rise,\n")
 
-    // call chaining
-    .appendFootnote("it can fall.\n\n")
+// call chaining
+.appendFootnote("it can fall.\n\n")
 
-    // color, underline, strike through, superscript and others
-    .append("But in the end\nit's just carried ", color: .white)
-    .append("with the wind\n", 
+// color, underline, strike through, superscript and others
+.append("But in the end\nit's just carried ", color: .white)
+.append("with the wind\n",
         color: .yellow,
         font: .dynamic(.systemFont(ofSize: 10)),
         baselineOffset: 5)
-    .append("and one day everything you do will simply cease to be…\n\n",
-        color: .green, 
-        underlineStyle: .styleDouble)
-    .append("Like a child's ", color: .white)
-
-    // and even images
-    .append(image: UIImage(named: "balloon")!,
-        height: UIFontMetrics.default.scaledValue(for: 20)) // (the image will not auto-adjust its height)
-
-    // In specal cases use AttributesBuilder class for easier attributes set up
-    .append("\n\nwhen it's lost, it's a tragic affair\n",
-        withAttributes: AttributesBuilder()
-                        .color(.white)
-                        .shadow(offset: CGSize(width: 7, height: -5),
-                                               blurRadius: 5, color: .yellow)
-                        .outline(width: -2, color: .red)
-                        .build())
-
-    .append("- but it is quickly forgotten.", withAttributes:
-        AttributesBuilder().strikeThrough(.styleSingle, color: .white).build())
+.append("and one day everything you do will simply cease to be…\n\n",
+        color: .green,
+        underlineStyle: .double)
+.append("Like a child's ", color: .white)
+
+// even images
+.append(image: UIImage(named: "balloon")!,
+        // (the image will not auto-adjust its height)
+        height: UIFontMetrics.default.scaledValue(for: 20))
+
+.append("\n\n")
+
+// In specal cases use AttributesBuilder class for easier attributes set up
+.append("when it's lost,\nit's a tragic affair\n",
+        with: AttributesBuilder()
+            .color(.white)
+            .shadow(offset: CGSize(width: -7, height: 3),
+                    blurRadius: 5, color: .yellow)
+            .outline(width: -2, color: .red)
+            .lineSpacing(30)
+            .align(.center))
+
+.append("- but it is quickly forgotten.", with:
+    AttributesBuilder()
+        .strikeThrough(.double, color: .white)
+        .align(.right))
 
 textView.attributedText = string
 ```

appendAttributedString/appendAttributedString.xcodeproj/project.pbxproj

@@ -7,17 +7,23 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		718A261723A3E424000F7074 /* ParagraphStyle.swift in Sources */ = {isa = PBXBuildFile; fileRef = 718A261623A3E424000F7074 /* ParagraphStyle.swift */; };
+		718A261923A3E4BE000F7074 /* StringExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 718A261823A3E4BE000F7074 /* StringExtension.swift */; };
 		71B0E73E210C5C800058E7E0 /* appendAttributedString.h in Headers */ = {isa = PBXBuildFile; fileRef = 71B0E730210C5C800058E7E0 /* appendAttributedString.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		71B0E751210C5DAA0058E7E0 /* appendAttributedString.swift in Sources */ = {isa = PBXBuildFile; fileRef = 71B0E74F210C5DAA0058E7E0 /* appendAttributedString.swift */; };
 		71B0E752210C5DAA0058E7E0 /* AttributesBuilder.swift in Sources */ = {isa = PBXBuildFile; fileRef = 71B0E750210C5DAA0058E7E0 /* AttributesBuilder.swift */; };
+		71CC92F123A3F3D900D9102F /* DynamicFonts.swift in Sources */ = {isa = PBXBuildFile; fileRef = 71CC92F023A3F3D900D9102F /* DynamicFonts.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
+		718A261623A3E424000F7074 /* ParagraphStyle.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ParagraphStyle.swift; sourceTree = "<group>"; };
+		718A261823A3E4BE000F7074 /* StringExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StringExtension.swift; sourceTree = "<group>"; };
 		71B0E72D210C5C800058E7E0 /* appendAttributedString.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = appendAttributedString.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		71B0E730210C5C800058E7E0 /* appendAttributedString.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = appendAttributedString.h; sourceTree = "<group>"; };
 		71B0E731210C5C800058E7E0 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		71B0E74F210C5DAA0058E7E0 /* appendAttributedString.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = appendAttributedString.swift; sourceTree = "<group>"; };
 		71B0E750210C5DAA0058E7E0 /* AttributesBuilder.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AttributesBuilder.swift; sourceTree = "<group>"; };
+		71CC92F023A3F3D900D9102F /* DynamicFonts.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DynamicFonts.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -52,6 +58,9 @@
 			children = (
 				71B0E74F210C5DAA0058E7E0 /* appendAttributedString.swift */,
 				71B0E750210C5DAA0058E7E0 /* AttributesBuilder.swift */,
+				718A261623A3E424000F7074 /* ParagraphStyle.swift */,
+				718A261823A3E4BE000F7074 /* StringExtension.swift */,
+				71CC92F023A3F3D900D9102F /* DynamicFonts.swift */,
 				71B0E730210C5C800058E7E0 /* appendAttributedString.h */,
 				71B0E731210C5C800058E7E0 /* Info.plist */,
 			);
@@ -139,7 +148,10 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				71CC92F123A3F3D900D9102F /* DynamicFonts.swift in Sources */,
 				71B0E752210C5DAA0058E7E0 /* AttributesBuilder.swift in Sources */,
+				718A261723A3E424000F7074 /* ParagraphStyle.swift in Sources */,
+				718A261923A3E4BE000F7074 /* StringExtension.swift in Sources */,
 				71B0E751210C5DAA0058E7E0 /* appendAttributedString.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

appendAttributedString/appendAttributedString/AttributesBuilder.swift

@@ -8,27 +8,27 @@
 
 import UIKit
 
-/// Helper class for creation of attributes for an NSAttributedString.
+/// Helper class for creation of attributes for an `NSAttributedString`.
 /// Use `build()` or `value` to get the result.
 public class AttributesBuilder {
 
-	/// The dictionary to use with NSAttributedString.
+	/// The dictionary to use with `NSAttributedString`.
 	public var value: [NSAttributedString.Key : Any]
 
-	/// Returns the dictionary to use with NSAttributedString.
+	/// Returns the dictionary to use with `NSAttributedString`.
 	public func build() -> [NSAttributedString.Key : Any] {
 		return value
 	}
 
-	/// Initialize a new clean instance of AttributesBuilder.
+	/// Initialize a new clean instance of `AttributesBuilder`.
 	public init(_ attributes: [NSAttributedString.Key : Any] = [:]) {
 		value = attributes
 	}
 
 	// MARK: - Methods
 
 	/// Returns the current font you've set with
-	/// either dynamic(_:maximumPointSize:scaleAs:compatibleWith:) or font(_:)
+	/// either `dynamic(_:maximumPointSize:scaleAs:compatibleWith:)` or `font(_:)`
 	@available(iOS 11, *)
 	public var font: UIFont? {
 		return value[.font] as? UIFont
@@ -97,7 +97,7 @@ public class AttributesBuilder {
 	}
 
 	/// Set paragraph style.
-	public func paragraph(style: NSParagraphStyle?) -> Self {
+	public func paragraphStyle(_ style: NSMutableParagraphStyle?) -> Self {
 		value[.paragraphStyle] = style
 		return self
 	}

appendAttributedString/appendAttributedString/DynamicFonts.swift

@@ -0,0 +1,104 @@
+//
+//  DynamicFonts.swift
+//  https://github.com/ysoftware
+//
+//  Created by Yaroslav Erohin on 13.12.2019.
+//  Copyright © 2015 Yaroslav Erohin. All rights reserved.
+//
+
+import Foundation
+
+public extension NSMutableAttributedString {
+	
+	/// Adds a string with a dynamic font of style Title1.
+	@available(iOS 9.0, *) @discardableResult
+	func appendTitle1(_ string:String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .title1))
+	}
+
+	/// Adds a string with a dynamic font of style Title2
+	@available(iOS 9.0, *) @discardableResult
+	func appendTitle2(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .title2))
+	}
+
+	/// Adds a string with a dynamic font of style Title3
+	@available(iOS 9.0, *) @discardableResult
+	func appendTitle3(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .title3))
+	}
+
+	/// Adds a string with a dynamic font of style Callout
+	@available(iOS 9.0, *) @discardableResult
+	func appendCallout(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .callout))
+	}
+
+	/// Adds a string with a dynamic font of style Subheadline
+	@discardableResult
+	func appendSubheadline(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .subheadline))
+	}
+
+	/// Adds a string with a dynamic font of style Caption1
+	@discardableResult
+	func appendCaption1(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .caption1))
+	}
+
+	/// Adds a string with a dynamic font of style Caption2
+	@discardableResult
+	func appendCaption2(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .caption2))
+	}
+
+	/// Adds a string with a dynamic font of style Headline
+	@discardableResult
+	func appendHeadline(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .headline))
+	}
+
+	/// Adds a string with a dynamic font of style Footnote
+	@discardableResult
+	func appendFootnote(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .footnote))
+	}
+
+	/// Adds a string with a dynamic font of style Body
+	@discardableResult
+	func appendBody(_ string: String) -> Self {
+		return append(string, font: .preferredFont(forTextStyle: .body))
+	}
+
+	/// Adds a string with a dynamic font of style Title1 or uses the fallback option if not available
+	@discardableResult
+	func appendTitle1(_ string: String,
+					  fallbackToStyle fallback: UIFont.TextStyle? = nil) -> Self {
+		if #available(iOS 9.0, *) { return appendTitle1(string) }
+		else { return append(string, style: fallback) }
+	}
+
+	/// Adds a string with a dynamic font of style Title2 or uses the fallback option if not available
+	@discardableResult
+	func appendTitle2(_ string: String,
+					  fallbackToStyle fallback: UIFont.TextStyle? = nil) -> Self {
+		if #available(iOS 9.0, *) { return appendTitle2(string) }
+		else { return append(string, style: fallback) }
+	}
+
+	/// Adds a string with a dynamic font of style Title3 or uses the fallback option if not available
+	@discardableResult
+	func appendTitle3(_ string: String,
+					  fallbackToStyle fallback: UIFont.TextStyle? = nil) -> Self {
+		if #available(iOS 9.0, *) { return appendTitle3(string) }
+		else { return append(string, style: fallback) }
+	}
+
+	/// Adds a string with a dynamic font of style Callout
+	@discardableResult
+	func appendCallout(_ string: String,
+					   fallbackToStyle fallback: UIFont.TextStyle? = nil) -> Self {
+		if #available(iOS 9.0, *) { return appendCallout(string) }
+		else { return append(string, style: fallback) }
+	}
+}

appendAttributedString/appendAttributedString/ParagraphStyle.swift

@@ -0,0 +1,57 @@
+//
+//  ParagraphStyle.swift
+//  https://github.com/ysoftware
+//
+//  Created by Ярослав Ерохин on 13.12.2019.
+//  Copyright © 2017 Yaroslav Erohin. All rights reserved.
+//
+
+import Foundation
+
+public extension AttributesBuilder {
+
+	private var paragraphStyle: NSMutableParagraphStyle {
+		if value[.paragraphStyle] == nil {
+			value[.paragraphStyle] = NSMutableParagraphStyle()
+		}
+		return value[.paragraphStyle]! as! NSMutableParagraphStyle
+	}
+
+	/// Sets both min and max line heights for the attributed string's paragraph style.
+	func lineHeight(_ lineHeight: CGFloat) -> Self {
+		paragraphStyle.maximumLineHeight = lineHeight
+		paragraphStyle.minimumLineHeight = lineHeight
+		return self
+	}
+
+	/// Sets both minimum line height for the attributed string's paragraph style.
+	func minLineHeight(_ lineHeight: CGFloat) -> Self {
+		paragraphStyle.minimumLineHeight = lineHeight
+		return self
+	}
+
+	/// Sets both maximum line height for the attributed string's paragraph style.
+	func maxLineHeight(_ lineHeight: CGFloat) -> Self {
+		paragraphStyle.maximumLineHeight = lineHeight
+		return self
+	}
+
+	/// Sets text alignment of the attributed string's paragraph style.
+	func align(_ alignment: NSTextAlignment) -> Self {
+		paragraphStyle.alignment = alignment
+		return self
+	}
+
+	/// Sets the mode that should be used to break lines in the attributed string's paragraph style.
+	func lineBreak(_ mode: NSLineBreakMode) -> Self {
+		paragraphStyle.lineBreakMode = mode
+		return self
+	}
+
+	/// Sets the distance in points between the bottom of one line fragment and the top of the next.
+	/// This value is compensated to always be nonnegative.
+	func lineSpacing(_ spacing: CGFloat) -> Self {
+		paragraphStyle.lineSpacing = max(0, spacing)
+		return self
+	}
+}

appendAttributedString/appendAttributedString/StringExtension.swift

@@ -0,0 +1,28 @@
+//
+//  StringExtension.swift
+//  https://github.com/ysoftware
+//
+//  Created by Ярослав Ерохин on 13.12.2019.
+//  Copyright © 2017 Yaroslav Erohin. All rights reserved.
+//
+
+import Foundation
+
+public extension String {
+
+	/// Creates a new instance of `NSMutableAttributedString`
+	/// with given attributes from this `string`.
+	func withAttributes(
+		_ attributes: [NSAttributedString.Key : Any] = [:]) -> NSMutableAttributedString {
+
+		return NSMutableAttributedString().append(self, withAttributes: attributes)
+	}
+
+	/// Creates a new instance of `NSMutableAttributedString` from this `string`
+	/// with attributes passed in an `AttributesBuilder` instance.
+	func withAttributes(
+		_ builder: AttributesBuilder = .init()) -> NSMutableAttributedString {
+
+		return NSMutableAttributedString().append(self, with: builder)
+	}
+}