Merge branch 'release/2.1.0'

Author: malcommac

.swift-version

@@ -16,7 +16,7 @@ class ViewController: UIViewController {
 
 	override func viewDidLoad() {
 		super.viewDidLoad()
-		
+
 		let bodyHTML = try! String(contentsOfFile: Bundle.main.path(forResource: "file", ofType: "txt")!)
 
 		let headerStyle = Style {
@@ -26,6 +26,13 @@ class ViewController: UIViewController {
 		}
 		let boldStyle = Style {
 			$0.font = UIFont.boldSystemFont(ofSize: self.baseFontSize)
+            if #available(iOS 11.0, *) {
+                $0.dynamicText = DynamicText {
+                    $0.style = .body
+                    $0.maximumSize = 35.0
+                    $0.traitCollection = UITraitCollection(userInterfaceIdiom: .phone)
+                }
+            }
 		}
 		let italicStyle = Style {
 			$0.font = UIFont.italicSystemFont(ofSize: self.baseFontSize)
@@ -54,13 +61,8 @@ class ViewController: UIViewController {
 				}])
 
 		self.textView?.attributedText = bodyHTML.set(style: style)
+        if #available(iOS 10.0, *) {
+            self.textView?.adjustsFontForContentSizeCategory = true
+        }
 	}
-
-	override func didReceiveMemoryWarning() {
-		super.didReceiveMemoryWarning()
-		// Dispose of any resources that can be recreated.
-	}
-
-
 }
-

Documentation_Assests/Logo.sketch

@@ -1,19 +1,17 @@
 <p align="center" >
-<img src="https://raw.githubusercontent.com/malcommac/SwiftRichString/master/SwiftRichString.png" width=300px alt="SwiftRichString" title="SwiftRichString">
+<img src="https://raw.githubusercontent.com/malcommac/SwiftRichString/master/swiftrichstring.png" width=450px alt="SwiftRichString" title="SwiftRichString">
 </p>
 
 [![Version](https://img.shields.io/cocoapods/v/SwiftRichString.svg?style=flat)](http://cocoadocs.org/docsets/SwiftRichString) [![License](https://img.shields.io/cocoapods/l/SwiftRichString.svg?style=flat)](http://cocoadocs.org/docsets/SwiftRichString) [![Platform](https://img.shields.io/cocoapods/p/SwiftRichString.svg?style=flat)](http://cocoadocs.org/docsets/SwiftRichString)
 [![CocoaPods Compatible](https://img.shields.io/cocoapods/v/SwiftRichString.svg)](https://img.shields.io/cocoapods/v/SwiftRichString.svg)
 [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 [![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](http://twitter.com/danielemargutti)
 
-<p align="center" >★★ <b>Star me to follow the project! </b> ★★<br>
-Created by <b>Daniele Margutti</b> - <a href="http://www.danielemargutti.com">danielemargutti.com</a>
-</p>
-
 
 SwiftRichString is a lightweight library which allows to create and manipulate attributed strings easily both in iOS, macOS, tvOS and even watchOS.
-It provides convenient way to store styles you can reuse in your app's UI lements, allows complex tag-based strings rendering and also includes integration with Interface Builder.
+It provides convenient way to store styles you can reuse in your app's UI elements, allows complex tag-based strings rendering and also includes integration with Interface Builder.
+
+It even support **iOS 11's Dynamic Type**!
 
 If you manipulate `NSAttributedString` in Swift, SwiftRichString allows you to keep your code manteniable, readable and easy to evolve.
 
@@ -79,24 +77,6 @@ That's the result!
 
 <img src="Documentation_Assests/image_2.png" alt="" style="width: 300px;"/>
 
--- 
-
-## Other Libraries You May Like
-
-I'm also working on several other projects you may like.
-Take a look below:
-
-
-| Library         | Description                                      |
-|-----------------|--------------------------------------------------|
-| [**SwiftDate**](https://github.com/malcommac/SwiftDate)       | The best way to manage date/timezones in Swift   |
-| [**Hydra**](https://github.com/malcommac/Hydra)           | Write better async code: async/await & promises  |
-| [**FlowKit**](https://github.com/malcommac/FlowKit) | A new declarative approach to table/collection managment. Forget datasource & delegates. |
-| [**SwiftRichString**](https://github.com/malcommac/SwiftRichString) | Elegant & Painless NSAttributedString in Swift   |
-| [**SwiftLocation**](https://github.com/malcommac/SwiftLocation)   | Efficient location manager                       |
-| [**SwiftMsgPack**](https://github.com/malcommac/SwiftMsgPack)    | Fast/efficient msgPack encoder/decoder           |
-</p>
-
 --
 
 ## Documentation
@@ -115,6 +95,8 @@ Full changelog is available in [CHANGELOG.md](CHANGELOG.md) file.
 	- [Apply styles to `String` & `Attributed String`](#manualstyling)
 	- [Fonts & Colors in `Style`](#fontscolors)
 	- [Derivating a `Style`](#derivatingstyle)
+	- [Support iOS's `Dynamic Type`](#dynamictype)
+	- [Dynamic Attributes from Tag's Params](#dynamicattributes)
 - [The `StyleManager`](#stylemanager)
 	- [Register globally available styles](#globalregister)
 	- [Defer style creation on demand](#defer)
@@ -359,7 +341,47 @@ let subStyle = bold.byAdding {
 	$0.alignment = center
 	$0.color = UIColor.red
 }
+```
+
+<a name="dynamictype"/>
+
+### Conforming to `Dynamic Type`
+
+To support your fonts/text to dynammically scale based on the users preffered content size, you can implement style's `dynamicText` property. UIFontMetrics properties are wrapped inside `DynamicText` class.
+
+
+```swift
+let style = Style {
+	$0.font = UIFont.boldSystemFont(ofSize: 16.0)
+	$0.dynamicText = DynamicText {
+		$0.style = .body
+		$0.maximumSize = 35.0
+		$0.traitCollection = UITraitCollection(userInterfaceIdiom: .phone)
+    }
+}
 ``` 
+
+<a name="dynamicattributes"/>
+
+### Dynamic Attributes from Tag's Params
+
+SwiftRichString also support some dynamic elements in style applied by reading specific tag parameter's value.
+The following example render the `linkURL` property by reading the value from the source string inside `href` tag (like in real HTML text):
+
+```
+  let normal = Style {
+	$0.color = UIColor.black
+  }
+  let link = Style {
+	  $0.color = UIColor.red
+	  $0.linkURL = URLRepresentable.tagAttribute("href")
+  }
+  let group = StyleGroup.init(base: normal, ["a" : link])
+
+  let bodyHTML = "Go to <a href=\"http://www.apple.com\">Apple</a> web site!"
+  self.textView?.attributedText = bodyHTML.set(style: group)
+```
+
 <a name="stylemanager"/>
 
 ## The `StyleManager`
@@ -619,4 +641,20 @@ SwiftRichString is available under the MIT license. See the LICENSE file for mor
 
 Daniele Margutti: [hello@danielemargutti.com](mailto:hello@danielemargutti.com), [@danielemargutti](https://twitter.com/danielemargutti)
 
+## Other Libraries You May Like
+
+I'm also working on several other projects you may like.
+Take a look below:
+
+
+| Library         | Description                                      |
+|-----------------|--------------------------------------------------|
+| [**SwiftDate**](https://github.com/malcommac/SwiftDate)       | The best way to manage date/timezones in Swift   |
+| [**Hydra**](https://github.com/malcommac/Hydra)           | Write better async code: async/await & promises  |
+| [**FlowKit**](https://github.com/malcommac/FlowKit) | A new declarative approach to table/collection managment. Forget datasource & delegates. |
+| [**SwiftRichString**](https://github.com/malcommac/SwiftRichString) | Elegant & Painless NSAttributedString in Swift   |
+| [**SwiftLocation**](https://github.com/malcommac/SwiftLocation)   | Efficient location manager                       |
+| [**SwiftMsgPack**](https://github.com/malcommac/SwiftMsgPack)    | Fast/efficient msgPack encoder/decoder           |
+</p>
+
 

ExampleiOS/ViewController.swift

@@ -0,0 +1,43 @@
+//
+//  DynamicText.swift
+//  SwiftRichString-iOS
+//
+//  Created by Felipe Lefèvre Marino on 1/17/19.
+//  Copyright © 2019 SwiftRichString. All rights reserved.
+//
+
+#if os(tvOS) || os(watchOS) || os(iOS)
+import UIKit
+
+/// DynamicText encapsulate the attributes for fonts to automatically scale to match the current Dynamic Type settings. It uses UIFontMetrics.
+public class DynamicText {
+    
+    /// Set the dynamic size text style.
+    /// You can pass any `UIFont.TextStyle` value, if nil UIFontMetrics.default will be used,
+    /// which uses the body text style.
+    public var style: UIFont.TextStyle?
+    
+    #if os(OSX) || os(iOS) || os(tvOS)
+    /// The trait collection to use when determining compatibility. The returned
+    /// font is appropriate for use in an interface that adopts the specified traits.
+    public var traitCollection: UITraitCollection?
+    #endif
+    
+    /// Set the maximum size
+    /// allowed for the font/text. Use this value to constrain the font to
+    /// the specified size when your interface cannot accommodate text that is any larger.
+    public var maximumSize: CGFloat?
+    
+    public typealias InitHandler = ((DynamicText) -> (Void))
+    
+    //MARK: - INIT
+    
+    /// Initialize a new dynamic text with optional configuration handler callback.
+    ///
+    /// - Parameter handler: configuration handler callback.
+    public init(_ handler: InitHandler? = nil) {
+        handler?(self)
+    }
+}
+
+#endif

README.md

@@ -21,13 +21,21 @@ internal let WATCHOS_SYSTEMFONT_SIZE: CGFloat = 12.0
 /// User don't interact with this object directly but via `Style`'s properties.
 /// Using the `attributes` property this object return a valid instance of the attributes to describe
 /// required behaviour.
-public class FontData {
+public struct FontData {
 
 	private static var DefaultFont = Font.systemFont(ofSize: 12.0)
 
 	/// Font object
 	var font: FontConvertible? { didSet { self.style?.invalidateCache() } }
-	
+
+	#if os(tvOS) || os(watchOS) || os(iOS)
+    // Dynamic text atributes
+    public var dynamicText: DynamicText? { didSet { self.style?.invalidateCache() } }
+
+    /// Returns if font should adapt to dynamic type
+    private var adpatsToDynamicType: Bool? { return dynamicText != nil }
+	#endif
+
 	/// Size of the font
 	var size: CGFloat? { didSet { self.style?.invalidateCache() } }
 
@@ -101,7 +109,7 @@ public class FontData {
 	/// - Parameter size: ignored. It will be overriden by `fontSize` property.
 	/// - Returns: instance of the font
 	var attributes: [NSAttributedString.Key:Any] {
-		guard !self.explicitFont else {
+		guard self.explicitFont == true else {
 			return [:]
 		}
 		return attributes(currentFont: self.font, size: self.size)
@@ -121,7 +129,7 @@ public class FontData {
 		guard self.explicitFont else {
 			return
 		}
-		
+        
 		/// Enumerate fonts in string and attach the attributes
 		let scanRange = (range ?? NSMakeRange(0, source.length))
 		source.enumerateAttribute(.font, in: scanRange, options: []) { (fontValue, fontRange, shouldStop) in
@@ -183,9 +191,39 @@ public class FontData {
 			finalAttributes[.kern] = tracking.kerning(for: finalFont)
 		}
 		#endif
-		
-		finalAttributes[.font] = finalFont // assign composed font
+
+		#if os(tvOS) || os(watchOS) || os(iOS)
+        // set scalable custom font if adapts to dynamic type
+        if #available(iOS 11.0, watchOS 4.0, tvOS 11.0, *), adpatsToDynamicType == true {
+            finalAttributes[.font] = scalableFont(from: finalFont)
+        } else {
+            finalAttributes[.font] = finalFont
+        }
+		#else
+		finalAttributes[.font] = finalFont
+		#endif
+        
 		return finalAttributes
 	}
+
+	#if os(tvOS) || os(watchOS) || os(iOS)
+    /// Returns a custom scalable font based on the received font
+    ///
+    /// - Parameter font: font in which the custom font will be based
+    /// - Returns: dynamic scalable font
+    @available(iOS 11.0, tvOS 11.0, iOSApplicationExtension 11.0, watchOS 4, *)
+    private func scalableFont(from font: Font) -> Font {
+        var fontMetrics: UIFontMetrics?
+        if let textStyle = dynamicText?.style {
+            fontMetrics = UIFontMetrics(forTextStyle: textStyle)
+        }
+        
+        #if os(OSX) || os(iOS) || os(tvOS)
+        return (fontMetrics ?? UIFontMetrics.default).scaledFont(for: font, maximumPointSize: dynamicText?.maximumSize ?? 0.0, compatibleWith: dynamicText?.traitCollection)
+        #else
+        return (fontMetrics ?? UIFontMetrics.default).scaledFont(for: font, maximumPointSize: dynamicText?.maximumSize ?? 0.0)
+        #endif
+    }
+	#endif
 
 }

Sources/SwiftRichString/Attributes/DynamicText.swift

@@ -0,0 +1,41 @@
+//
+//  URLConvertible.swift
+//  SwiftRichString
+//
+//  Created by dan on 19/01/2019.
+//  Copyright © 2019 SwiftRichString. All rights reserved.
+//
+
+import Foundation
+
+/// Dynamic tag support protocol
+public protocol DynamicTagComposable {
+	func dynamicValueFromTag(_ tag: StyleGroup.TagAttribute?) -> Any?
+}
+
+/// Dynamic value for NSAttributedKey.Link and .linkURL attribute.
+/// If link is wrong and cannot be transformed to `URL` instance style's `link` is not applied.
+///
+/// - url: fixed url value specified by URL instance.
+/// - string: fixed url string specified by a simple string.
+/// - tagAttribute: value of a specified tag in source html-tagged style.
+public enum URLRepresentable: DynamicTagComposable {
+	case url(URL)
+	case string(String)
+	case tagAttribute(String)
+
+	public func dynamicValueFromTag(_ tag: StyleGroup.TagAttribute?) -> Any? {
+		switch self {
+		case .url(let url):
+			return url
+		case .string(let string):
+			return URL(string: string)
+		case .tagAttribute(let tagKey):
+			guard let value = tag?.parameters?[tagKey] else {
+				return nil
+			}
+			return URL(string: value)
+		}
+	}
+
+}

Sources/SwiftRichString/Attributes/FontData.swift

@@ -87,6 +87,16 @@ public class Style: StyleProtocol {
 		}
 	}
 
+	#if os(tvOS) || os(watchOS) || os(iOS)
+    /// Set the dynamic text attributes to adapt the font/text to the current Dynamic Type settings.
+    /// **Note**: in order to be used you must also set the `.font`/`.size` attribute of the style.
+    @available(iOS 11.0, tvOS 11.0, iOSApplicationExtension 11.0, watchOS 4, *)
+    public var dynamicText: DynamicText? {
+        set { self.fontData?.dynamicText = newValue }
+        get { return self.fontData?.dynamicText }
+    }
+	#endif
+
 	/// Set the text color of the style.
 	/// You can pass any `ColorConvertible` conform object, it will be transformed to a valid `UIColor`/`NSColor`
 	/// automatically. Both `UIColor`/`NSColor` and `String` are conform to this protocol.
@@ -424,7 +434,7 @@ public class Style: StyleProtocol {
 
 	/// The value of this attribute is an NSURL object (preferred) or an NSString object.
 	/// The default value of this property is nil, indicating no link.
-	public var linkURL: URL? {
+	public var linkURL: URLRepresentable? {
 		set { self.set(attribute: newValue, forKey: .link) }
 		get { return self.get(attributeForKey: .link) }
 	}
@@ -595,7 +605,9 @@ public class Style: StyleProtocol {
 		return (self.innerAttributes[key] as? T)
 	}
 
-	/// Return all attributes defined by the style.
+	/// Return attributes defined by the style.
+	/// Not all attributes are returned, fonts attributes may be omitted.
+	/// Refer to `attributes` to get the complete list.
 	public var attributes: [NSAttributedString.Key : Any] {
 		if let cachedAttributes = self.cachedAttributes {
 			return cachedAttributes