Attribute-oriented programming in Objective-C

Describes problems that can be resolved with @op and ways how you can implement it in obj-c
https://github.com/epam/lib-obj-c-attr

Transcript

1. Attribute-oriented programming in Objective-C Yury Taustahuzau,
 EPAM Systems, Inc. MOConf 2014
2. Problems
3. Problems • Technical code is tangled with business code
 
 !
4. Problems • Technical code is tangled with business code • Scattered code

5. Problems • Technical code is tangled with business code • Scattered code • No context for code
6. What is it? @WebResult(name=“Echo") RF_ATTRIBUTE(NSObject) [Help("http://localhost/MyClassInfo")] __attribute__((const))
7. Java, C# and other languages
8. Results • Simplification of code
9. Results • Simplification of code • More readable programs
10. Results • Simplification of code • More readable programs • Easy maintainable code
11. Objective-C
12. We have attributes in Obj-C and Swift too
13. There’s open-source solution for that!
14. Current solutions • ROAnnotation • lib-obj-c-attr • libExtObjC (experimental branch) Yes, that’s all, only three:(
15. ROAnnotation //@classAnnotationInHeader( source = simpleValue, output = "value with spaces") //@testAnnotate @interface Person : NSObject { NSString *name; } ! //@PropertyAnnotationInHeader(key1=value1) //@CustomizedAnnotation(attribute1 = 123, attribute2 = 456, attribute3 = 759) @property (nonatomic, retain) NSString *name; //@PropertyAnnotationInHeader(attributeHavingOnlyValue) @property (nonatomic, retain) NSString *testProperty; ! //@MethodAnotationInHeader(a=589) - (void) canDoSomethingAwesomeWith:(NSString *)aName 
 andAThing:(id)thing; - (void) reallyLongMethodName:(CGPoint)withWrappedParameters 
 andAnother:(NSString *)one; ! @end
16. ROAnnotation //@classAnnotationInHeader( source = simpleValue, output = "value with spaces") //@testAnnotate @interface Person : NSObject { NSString *name; } ! //@PropertyAnnotationInHeader(key1=value1) //@CustomizedAnnotation(attribute1 = 123, attribute2 = 456, attribute3 = 759) @property (nonatomic, retain) NSString *name; //@PropertyAnnotationInHeader(attributeHavingOnlyValue) @property (nonatomic, retain) NSString *testProperty; ! //@MethodAnotationInHeader(a=589) - (void) canDoSomethingAwesomeWith:(NSString *)aName 
 andAThing:(id)thing; - (void) reallyLongMethodName:(CGPoint)withWrappedParameters 
 andAnother:(NSString *)one; ! @end
17. ROAnnotation //@classAnnotationInHeader( source = simpleValue, output = "value with spaces") //@testAnnotate @interface Person : NSObject { NSString *name; } ! //@PropertyAnnotationInHeader(key1=value1) //@CustomizedAnnotation(attribute1 = 123, attribute2 = 456, attribute3 = 759) @property (nonatomic, retain) NSString *name; //@PropertyAnnotationInHeader(attributeHavingOnlyValue) @property (nonatomic, retain) NSString *testProperty; ! //@MethodAnotationInHeader(a=589) - (void) canDoSomethingAwesomeWith:(NSString *)aName 
 andAThing:(id)thing; - (void) reallyLongMethodName:(CGPoint)withWrappedParameters 
 andAnother:(NSString *)one; ! @end
18. libExtObjC @annotateClass(AnnotatedClass, @"version": @"1.1") @interface AnnotatedClass : NSObject ! @annotate(AnnotatedClass, @"APIKey": @"full_name", @"other_info": @5) @property (nonatomic, copy) NSString *name; ! @end
19. libExtObjC @annotateClass(AnnotatedClass, @"version": @"1.1") @interface AnnotatedClass : NSObject ! @annotate(AnnotatedClass, @"APIKey": @"full_name", @"other_info": @5) @property (nonatomic, copy) NSString *name; ! @end
20. libExtObjC @annotateClass(AnnotatedClass, @"version": @"1.1") @interface AnnotatedClass : NSObject ! @annotate(AnnotatedClass, @"APIKey": @"full_name", @"other_info": @5) @property (nonatomic, copy) NSString *name; ! @end
21. libExtObjC @annotateClass(AnnotatedClass, @"version": @"1.1") @interface AnnotatedClass : NSObject ! @annotate(AnnotatedClass, @"APIKey": @"full_name", @"other_info": @5) @property (nonatomic, copy) NSString *name; ! @end
22. libObjCAttr RF_ATTRIBUTE(MyAttribute, stringProperty = @"Hello world") @interface AnnotatedClass : NSObject { ! RF_ATTRIBUTE(MyAttribute, numericProperty = @9000) NSObject * _someField; } ! RF_ATTRIBUTE(MyAttribute, blockProperty = ^(int value) { return value; }) - (void)foo; ! RF_ATTRIBUTE(MyAttribute, objectProperty = [NSObject new]) @property NSString *name; ! @end
23. libObjCAttr RF_ATTRIBUTE(MyAttribute, stringProperty = @"Hello world") @interface AnnotatedClass : NSObject { ! RF_ATTRIBUTE(MyAttribute, numericProperty = @9000) NSObject * _someField; } ! RF_ATTRIBUTE(MyAttribute, blockProperty = ^(int value) { return value; }) - (void)foo; ! RF_ATTRIBUTE(MyAttribute, objectProperty = [NSObject new]) @property NSString *name; ! @end
24. libObjCAttr RF_ATTRIBUTE(MyAttribute, stringProperty = @"Hello world") @interface AnnotatedClass : NSObject { ! RF_ATTRIBUTE(MyAttribute, numericProperty = @9000) NSObject * _someField; } ! RF_ATTRIBUTE(MyAttribute, blockProperty = ^(int value) { return value; }) - (void)foo; ! RF_ATTRIBUTE(MyAttribute, objectProperty = [NSObject new]) @property NSString *name; ! @end
25. libObjCAttr RF_ATTRIBUTE(MyAttribute, stringProperty = @"Hello world") @interface AnnotatedClass : NSObject { ! RF_ATTRIBUTE(MyAttribute, numericProperty = @9000) NSObject * _someField; } ! RF_ATTRIBUTE(MyAttribute, blockProperty = ^(int value) { return value; }) - (void)foo; ! RF_ATTRIBUTE(MyAttribute, objectProperty = [NSObject new]) @property NSString *name; ! @end
26. libObjCAttr RF_ATTRIBUTE(MyAttribute, stringProperty = @"Hello world") @interface AnnotatedClass : NSObject { ! RF_ATTRIBUTE(MyAttribute, numericProperty = @9000) NSObject * _someField; } ! RF_ATTRIBUTE(MyAttribute, blockProperty = ^(int value) { return value; }) - (void)foo; ! RF_ATTRIBUTE(MyAttribute, objectProperty = [NSObject new]) @property NSString *name; ! @end
27. Comparison
28. Comparison libExtObjC libObjCAttr ROAnnotation
29. Comparison libExtObjC libObjCAttr ROAnnotation
30. ROAnnotation libExtObjC libObjCAttr Comparison
31. Comparison libExtObjC libObjCAttr ROAnnotation
32. Comparison libExtObjC libObjCAttr ROAnnotation
33. Comparison libExtObjC libObjCAttr ROAnnotation
34. Comparison ROAnnotation libExtObjC libObjCAttr Supports OS X and iOS + + + Class attributes + + + Property attributes + + + Method attributes + – + IVar attributes – – + Supports object values – + + Support primitive types – – + Error tracing – – + Cocoapods installation – – + Syntax highlighting – + + Autocompletion – + + Perfomance leader – – + Total 4 6 12
35. Use case - Serialization ! @interface Person : NSObject ! @property (nonatomic, copy) NSString *personId; @property (nonatomic, copy) NSString *firstName; @property (nonatomic, copy) NSString *lastName; @property (nonatomic, readonly) NSString *name; @property (nonatomic, strong) NSDate *birthday; @property (nonatomic, strong) Person *spouse; @property (nonatomic, strong) NSArray *children; ! @end
36. Use case - Serialization RF_ATTRIBUTE(RFSerializable) @interface Person : NSObject ! @property (nonatomic, copy) NSString *personId; @property (nonatomic, copy) NSString *firstName; @property (nonatomic, copy) NSString *lastName; @property (nonatomic, readonly) NSString *name; @property (nonatomic, strong) NSDate *birthday; @property (nonatomic, strong) Person *spouse; @property (nonatomic, strong) NSArray *children; ! @end
37. Use case - Serialization RF_ATTRIBUTE(RFSerializable) @interface Person : NSObject ! RF_ATTRIBUTE(RFSerializable, serializationKey = @"id") @property (nonatomic, copy) NSString *personId; RF_ATTRIBUTE(RFSerializable, serializationKey = @"first_name") @property (nonatomic, copy) NSString *firstName; RF_ATTRIBUTE(RFSerializable, serializationKey = @"last_name") @property (nonatomic, copy) NSString *lastName; @property (nonatomic, readonly) NSString *name; RF_ATTRIBUTE(RFSerializable, serializationKey = @"birthday") @property (nonatomic, strong) NSDate *birthday; RF_ATTRIBUTE(RFSerializable, serializationKey = @"spouse") @property (nonatomic, strong) Person *spouse; RF_ATTRIBUTE(RFSerializable, serializationKey = @"children") @property (nonatomic, strong) NSArray *children; ! @end
38. Use case - Serialization RF_ATTRIBUTE(RFSerializable) @interface Person : NSObject ! RF_ATTRIBUTE(RFSerializable, serializationKey = @"id") @property (nonatomic, copy) NSString *personId; RF_ATTRIBUTE(RFSerializable, serializationKey = @"first_name") @property (nonatomic, copy) NSString *firstName; RF_ATTRIBUTE(RFSerializable, serializationKey = @"last_name") @property (nonatomic, copy) NSString *lastName; RF_ATTRIBUTE(RFDerived) @property (nonatomic, readonly) NSString *name; RF_ATTRIBUTE(RFSerializable, serializationKey = @"birthday") @property (nonatomic, strong) NSDate *birthday; RF_ATTRIBUTE(RFSerializable, serializationKey = @"spouse") @property (nonatomic, strong) Person *spouse; RF_ATTRIBUTE(RFSerializable, serializationKey = @"children") @property (nonatomic, strong) NSArray *children; ! @end
39. Use case - Serialization RF_ATTRIBUTE(RFSerializable) @interface Person : NSObject ! RF_ATTRIBUTE(RFSerializable, serializationKey = @"id") @property (nonatomic, copy) NSString *personId; RF_ATTRIBUTE(RFSerializable, serializationKey = @"first_name") @property (nonatomic, copy) NSString *firstName; RF_ATTRIBUTE(RFSerializable, serializationKey = @"last_name") @property (nonatomic, copy) NSString *lastName; RF_ATTRIBUTE(RFDerived) @property (nonatomic, readonly) NSString *name; RF_ATTRIBUTE(RFSerializable, serializationKey = @"birthday") RF_ATTRIBUTE(RFSerializableDate, format = @"yyyy-MM-dd'T'HH:mm:ss'Z'") @property (nonatomic, strong) NSDate *birthday; RF_ATTRIBUTE(RFSerializable, serializationKey = @"spouse") @property (nonatomic, strong) Person *spouse; RF_ATTRIBUTE(RFSerializable, serializationKey = @"children") @property (nonatomic, strong) NSArray *children; ! @end
40. Use case - Serialization RF_ATTRIBUTE(RFSerializable) @interface Person : NSObject ! RF_ATTRIBUTE(RFSerializable, serializationKey = @"id") @property (nonatomic, copy) NSString *personId; RF_ATTRIBUTE(RFSerializable, serializationKey = @"first_name") @property (nonatomic, copy) NSString *firstName; RF_ATTRIBUTE(RFSerializable, serializationKey = @"last_name") @property (nonatomic, copy) NSString *lastName; RF_ATTRIBUTE(RFDerived) @property (nonatomic, readonly) NSString *name; RF_ATTRIBUTE(RFSerializable, serializationKey = @"birthday") RF_ATTRIBUTE(RFSerializableDate, format = @"yyyy-MM-dd'T'HH:mm:ss'Z'") @property (nonatomic, strong) NSDate *birthday; RF_ATTRIBUTE(RFSerializable, serializationKey = @"spouse") @property (nonatomic, strong) Person *spouse; RF_ATTRIBUTE(RFSerializable, serializationKey = @"children") RF_ATTRIBUTE(RFSerializableCollection, collectionClass = [Person class]) @property (nonatomic, strong) NSArray *children; ! @end
42. Use cases Dependency injection Aspect-oriented programming Validation Logic configuration Web service mapping Serialization mapping Mocking Logging Documenting Service locating Carrying meta data Entity mapping Form generation
43. • ObjCAttr
 github.com/epam/lib-obj-c-attr ! • ROAD
 github.com/epam/road-ios-framework ! • Send me your question and ideas to
 yuru_taustahuzau@epam.com
 Or send DM via twitter to
 @imossir