[ASTraitCollection] Add missing properties to ASTraitCollection (TextureGroup#625)

* [ASTraitCollection] Add missing properties to ASTraitCollection

* ASTraitCollection now completely reflects UITraitCollection

* Add ASContentSizeCategory enum that corresponds to
  UIContentSizeCategory and can be used inside a struct.

* * Remove enum ASContentSizeCategory.
* Use __unsafe_unretained UIContentSizeCategory instead of the enum.

* Added ASPrimitiveTraitCollection lifetime test

* Changes requested at code review:
* Restore one of the ASTraitCollection constructors with a deprecation notice.
* Clean up API by the separation of tvOS-specific interfaces.
* Use [NSString -isEqualToString:] for ASPrimitiveContentSizeCategory equality tests for better readability.
* Encapsulate fallback logic for UIContentSizeCategoryUnspecified.

* Fix failing test

Author: ypogribnyi

AsyncDisplayKit.xcodeproj/project.pbxproj

@@ -99,6 +99,7 @@
 		3917EBD41E9C2FC400D04A01 /* _ASCollectionReusableView.h in Headers */ = {isa = PBXBuildFile; fileRef = 3917EBD21E9C2FC400D04A01 /* _ASCollectionReusableView.h */; settings = {ATTRIBUTES = (Private, ); }; };
 		3917EBD51E9C2FC400D04A01 /* _ASCollectionReusableView.m in Sources */ = {isa = PBXBuildFile; fileRef = 3917EBD31E9C2FC400D04A01 /* _ASCollectionReusableView.m */; };
 		3C9C128519E616EF00E942A0 /* ASTableViewTests.mm in Sources */ = {isa = PBXBuildFile; fileRef = 3C9C128419E616EF00E942A0 /* ASTableViewTests.mm */; };
+		4496D0731FA9EA6B001CC8D5 /* ASTraitCollectionTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 4496D0721FA9EA6B001CC8D5 /* ASTraitCollectionTests.m */; };
 		4E9127691F64157600499623 /* ASRunLoopQueueTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 4E9127681F64157600499623 /* ASRunLoopQueueTests.m */; };
 		509E68601B3AED8E009B9150 /* ASScrollDirection.m in Sources */ = {isa = PBXBuildFile; fileRef = 205F0E111B371BD7007741D0 /* ASScrollDirection.m */; };
 		509E68611B3AEDA0009B9150 /* ASAbstractLayoutController.h in Headers */ = {isa = PBXBuildFile; fileRef = 205F0E171B37339C007741D0 /* ASAbstractLayoutController.h */; };
@@ -634,6 +635,7 @@
 		3917EBD21E9C2FC400D04A01 /* _ASCollectionReusableView.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = _ASCollectionReusableView.h; sourceTree = "<group>"; };
 		3917EBD31E9C2FC400D04A01 /* _ASCollectionReusableView.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = _ASCollectionReusableView.m; sourceTree = "<group>"; };
 		3C9C128419E616EF00E942A0 /* ASTableViewTests.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; lineEnding = 0; path = ASTableViewTests.mm; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.objc; };
+		4496D0721FA9EA6B001CC8D5 /* ASTraitCollectionTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ASTraitCollectionTests.m; sourceTree = "<group>"; };
 		464052191A3F83C40061C0BA /* ASDataController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; lineEnding = 0; path = ASDataController.h; sourceTree = "<group>"; };
 		4640521A1A3F83C40061C0BA /* ASDataController.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; lineEnding = 0; path = ASDataController.mm; sourceTree = "<group>"; };
 		4640521B1A3F83C40061C0BA /* ASTableLayoutController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASTableLayoutController.h; sourceTree = "<group>"; };
@@ -1256,6 +1258,7 @@
 				695BE2541DC1245C008E6EA5 /* ASWrapperSpecSnapshotTests.mm */,
 				699B83501E3C1BA500433FA4 /* ASLayoutSpecTests.m */,
 				4E9127681F64157600499623 /* ASRunLoopQueueTests.m */,
+				4496D0721FA9EA6B001CC8D5 /* ASTraitCollectionTests.m */,
 			);
 			path = Tests;
 			sourceTree = "<group>";
@@ -2163,6 +2166,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				E51B78BF1F028ABF00E32604 /* ASLayoutFlatteningTests.m in Sources */,
+				4496D0731FA9EA6B001CC8D5 /* ASTraitCollectionTests.m in Sources */,
 				29CDC2E21AAE70D000833CA4 /* ASBasicImageDownloaderContextTests.m in Sources */,
 				CC583AD71EF9BDC100134156 /* NSInvocation+ASTestHelpers.m in Sources */,
 				CC051F1F1D7A286A006434CB /* ASCALayerTests.m in Sources */,

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## master
 * Add your own contributions to the next release on the line below this with your name.
+- [ASTraitCollection] Add new properties of UITraitCollection to ASTraitCollection. [Yevgen Pogribnyi](https://github.com/ypogribnyi)
 - [ASRectMap] Replace implementation of ASRectTable with a simpler one based on unordered_map.[Scott Goodson](https://github.com/appleguy) [#719](https://github.com/TextureGroup/Texture/pull/719)
 - [ASCollectionView] Add missing flags for ASCollectionDelegate [Ilya Zheleznikov](https://github.com/ilyailya) [#718](https://github.com/TextureGroup/Texture/pull/718)
 - [ASNetworkImageNode] Deprecates .URLs in favor of .URL [Garrett Moon](https://github.com/garrettmoon) [#699](https://github.com/TextureGroup/Texture/pull/699)

Source/Details/ASTraitCollection.h

@@ -17,6 +17,7 @@
 
 
 #import <UIKit/UIKit.h>
+
 #import <AsyncDisplayKit/ASBaseDefines.h>
 
 @class ASTraitCollection;
@@ -27,14 +28,51 @@ NS_ASSUME_NONNULL_BEGIN
 
 ASDISPLAYNODE_EXTERN_C_BEGIN
 
+#pragma mark - ASPrimitiveContentSizeCategory
+
+/**
+ * ASPrimitiveContentSizeCategory is a UIContentSizeCategory that can be used inside a struct.
+ *
+ * We need an unretained pointer because ARC can't manage struct memory.
+ *
+ * WARNING: DO NOT cast UIContentSizeCategory values to ASPrimitiveContentSizeCategory directly.
+ *   Use ASPrimitiveContentSizeCategoryMake(UIContentSizeCategory) instead.
+ *   This is because we make some assumptions about the lifetime of the object it points to.
+ *   Also note that cast from ASPrimitiveContentSizeCategory to UIContentSizeCategory is always safe.
+ */
+typedef __unsafe_unretained UIContentSizeCategory ASPrimitiveContentSizeCategory;
+
+/**
+ * Safely casts from UIContentSizeCategory to ASPrimitiveContentSizeCategory.
+ *
+ * The UIKit documentation doesn't specify if we can receive a copy of the UIContentSizeCategory constant. While getting
+ * copies is fine with ARC, usage of unretained pointers requires us to ensure the lifetime of the object it points to.
+ * Manual retain&release of the UIContentSizeCategory object is not an option because it would require us to do that
+ * everywhere ASPrimitiveTraitCollection is used. This is error-prone and can lead to crashes and memory leaks. So, we
+ * explicitly limit possible values of ASPrimitiveContentSizeCategory to the predetermined set of global constants with
+ * known lifetime.
+ *
+ * @return a pointer to one of the UIContentSizeCategory constants.
+ */
+extern ASPrimitiveContentSizeCategory ASPrimitiveContentSizeCategoryMake(UIContentSizeCategory sizeCategory);
+
 #pragma mark - ASPrimitiveTraitCollection
 
 typedef struct ASPrimitiveTraitCollection {
-  CGFloat displayScale;
   UIUserInterfaceSizeClass horizontalSizeClass;
-  UIUserInterfaceIdiom userInterfaceIdiom;
   UIUserInterfaceSizeClass verticalSizeClass;
+
+  CGFloat displayScale;
+  UIDisplayGamut displayGamut;
+
+  UIUserInterfaceIdiom userInterfaceIdiom;
   UIForceTouchCapability forceTouchCapability;
+  UITraitEnvironmentLayoutDirection layoutDirection;
+#if TARGET_OS_TV
+  UIUserInterfaceStyle userInterfaceStyle;
+#endif
+
+  ASPrimitiveContentSizeCategory preferredContentSizeCategory;
 
   CGSize containerSize;
 } ASPrimitiveTraitCollection;
@@ -124,29 +162,69 @@ ASDISPLAYNODE_EXTERN_C_END
 AS_SUBCLASSING_RESTRICTED
 @interface ASTraitCollection : NSObject
 
-@property (nonatomic, assign, readonly) CGFloat displayScale;
 @property (nonatomic, assign, readonly) UIUserInterfaceSizeClass horizontalSizeClass;
-@property (nonatomic, assign, readonly) UIUserInterfaceIdiom userInterfaceIdiom;
 @property (nonatomic, assign, readonly) UIUserInterfaceSizeClass verticalSizeClass;
+
+@property (nonatomic, assign, readonly) CGFloat displayScale;
+@property (nonatomic, assign, readonly) UIDisplayGamut displayGamut;
+
+@property (nonatomic, assign, readonly) UIUserInterfaceIdiom userInterfaceIdiom;
 @property (nonatomic, assign, readonly) UIForceTouchCapability forceTouchCapability;
+@property (nonatomic, assign, readonly) UITraitEnvironmentLayoutDirection layoutDirection;
+#if TARGET_OS_TV
+@property (nonatomic, assign, readonly) UIUserInterfaceStyle userInterfaceStyle;
+#endif
+
+@property (nonatomic, assign, readonly) UIContentSizeCategory preferredContentSizeCategory;
+
 @property (nonatomic, assign, readonly) CGSize containerSize;
 
 + (ASTraitCollection *)traitCollectionWithASPrimitiveTraitCollection:(ASPrimitiveTraitCollection)traits;
 
 + (ASTraitCollection *)traitCollectionWithUITraitCollection:(UITraitCollection *)traitCollection
                                               containerSize:(CGSize)windowSize;
 
++ (ASTraitCollection *)traitCollectionWithUITraitCollection:(UITraitCollection *)traitCollection
+                                              containerSize:(CGSize)windowSize
+                                fallbackContentSizeCategory:(UIContentSizeCategory)fallbackContentSizeCategory;
+
+#if TARGET_OS_TV
++ (ASTraitCollection *)traitCollectionWithHorizontalSizeClass:(UIUserInterfaceSizeClass)horizontalSizeClass
+                                            verticalSizeClass:(UIUserInterfaceSizeClass)verticalSizeClass
+                                                 displayScale:(CGFloat)displayScale
+                                                 displayGamut:(UIDisplayGamut)displayGamut
+                                           userInterfaceIdiom:(UIUserInterfaceIdiom)userInterfaceIdiom
+                                         forceTouchCapability:(UIForceTouchCapability)forceTouchCapability
+                                              layoutDirection:(UITraitEnvironmentLayoutDirection)layoutDirection
+                                           userInterfaceStyle:(UIUserInterfaceStyle)userInterfaceStyle
+                                 preferredContentSizeCategory:(UIContentSizeCategory)preferredContentSizeCategory
+                                                containerSize:(CGSize)windowSize;
+#else
++ (ASTraitCollection *)traitCollectionWithHorizontalSizeClass:(UIUserInterfaceSizeClass)horizontalSizeClass
+                                            verticalSizeClass:(UIUserInterfaceSizeClass)verticalSizeClass
+                                                 displayScale:(CGFloat)displayScale
+                                                 displayGamut:(UIDisplayGamut)displayGamut
+                                           userInterfaceIdiom:(UIUserInterfaceIdiom)userInterfaceIdiom
+                                         forceTouchCapability:(UIForceTouchCapability)forceTouchCapability
+                                              layoutDirection:(UITraitEnvironmentLayoutDirection)layoutDirection
+                                 preferredContentSizeCategory:(UIContentSizeCategory)preferredContentSizeCategory
+                                                containerSize:(CGSize)windowSize;
+#endif
+
+- (ASPrimitiveTraitCollection)primitiveTraitCollection;
+- (BOOL)isEqualToTraitCollection:(ASTraitCollection *)traitCollection;
+
+@end
+
+@interface ASTraitCollection (Deprecated)
 
 + (ASTraitCollection *)traitCollectionWithDisplayScale:(CGFloat)displayScale
                                     userInterfaceIdiom:(UIUserInterfaceIdiom)userInterfaceIdiom
                                    horizontalSizeClass:(UIUserInterfaceSizeClass)horizontalSizeClass
                                      verticalSizeClass:(UIUserInterfaceSizeClass)verticalSizeClass
                                   forceTouchCapability:(UIForceTouchCapability)forceTouchCapability
-                                         containerSize:(CGSize)windowSize;
-
-
-- (ASPrimitiveTraitCollection)primitiveTraitCollection;
-- (BOOL)isEqualToTraitCollection:(ASTraitCollection *)traitCollection;
+                                         containerSize:(CGSize)windowSize
+  ASDISPLAYNODE_DEPRECATED_MSG("Use full version of this method instead.");
 
 @end