Merge pull request #3 from SomeRandomiOSDev/1.0.2

Release 1.0.2

Author: SomeRandomiOSDev

KeyValueObservation.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                = "KeyValueObservation"
-  s.version             = "1.0.1"
+  s.version             = "1.0.2"
   s.summary             = "A small KVO helper library"
   s.description         = <<-DESC
                           A small KVO helper library that provides a NSObject and a NSArray category for observing key value changes using blocks
@@ -18,7 +18,7 @@ Pod::Spec.new do |s|
 
   s.source              = { :git => "https://github.com/SomeRandomiOSDev/KeyValueObservation.git", :tag => s.version.to_s }
 
-  s.public_header_files = 'KeyValueObservation/NSObject+KeyValueObservation.h', 'KeyValueObservation/NSArray+KeyValueObservation.h', 'KeyValueObservation/SRDKeyValueObservation.h', 'KeyValueObservation/SRDKeyValueObservedChange.h'
+  s.public_header_files = 'KeyValueObservation/NSObject+KeyValueObservation.h', 'KeyValueObservation/NSArray+KeyValueObservation.h', 'KeyValueObservation/SRDKeyValueObservation.h', 'KeyValueObservation/SRDKeyValueObservedChange.h', 'KeyValueObservation/SRDKVOInfo.h'
   s.source_files        = 'KeyValueObservation/**/*.{h,m}'
   s.frameworks          = 'Foundation'
   s.requires_arc        = true

KeyValueObservation.xcodeproj/project.pbxproj

@@ -51,6 +51,14 @@
 		DDF7571622AA8688002E11D4 /* SRDKeyValueObservedChange.m in Sources */ = {isa = PBXBuildFile; fileRef = DDF7569122AA77B1002E11D4 /* SRDKeyValueObservedChange.m */; };
 		DDF7571722AA8693002E11D4 /* KeyValueObservationTests.m in Sources */ = {isa = PBXBuildFile; fileRef = DDF7568122AA773D002E11D4 /* KeyValueObservationTests.m */; };
 		DDF7571822AA8694002E11D4 /* KeyValueObservationTests.m in Sources */ = {isa = PBXBuildFile; fileRef = DDF7568122AA773D002E11D4 /* KeyValueObservationTests.m */; };
+		DDF7572622AA8F27002E11D4 /* SRDKVOInfo.h in Headers */ = {isa = PBXBuildFile; fileRef = DDF7572422AA8F27002E11D4 /* SRDKVOInfo.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		DDF7572722AA8F27002E11D4 /* SRDKVOInfo.m in Sources */ = {isa = PBXBuildFile; fileRef = DDF7572522AA8F27002E11D4 /* SRDKVOInfo.m */; };
+		DDF7572822AA8F2B002E11D4 /* SRDKVOInfo.h in Headers */ = {isa = PBXBuildFile; fileRef = DDF7572422AA8F27002E11D4 /* SRDKVOInfo.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		DDF7572922AA8F2D002E11D4 /* SRDKVOInfo.h in Headers */ = {isa = PBXBuildFile; fileRef = DDF7572422AA8F27002E11D4 /* SRDKVOInfo.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		DDF7572A22AA8F2F002E11D4 /* SRDKVOInfo.h in Headers */ = {isa = PBXBuildFile; fileRef = DDF7572422AA8F27002E11D4 /* SRDKVOInfo.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		DDF7572B22AA8F33002E11D4 /* SRDKVOInfo.m in Sources */ = {isa = PBXBuildFile; fileRef = DDF7572522AA8F27002E11D4 /* SRDKVOInfo.m */; };
+		DDF7572C22AA8F34002E11D4 /* SRDKVOInfo.m in Sources */ = {isa = PBXBuildFile; fileRef = DDF7572522AA8F27002E11D4 /* SRDKVOInfo.m */; };
+		DDF7572D22AA8F35002E11D4 /* SRDKVOInfo.m in Sources */ = {isa = PBXBuildFile; fileRef = DDF7572522AA8F27002E11D4 /* SRDKVOInfo.m */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -104,6 +112,8 @@
 		DDF756EC22AA7854002E11D4 /* KeyValueObservation.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = KeyValueObservation.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		DDF756F422AA7B6E002E11D4 /* KeyValueObservation.modulemap */ = {isa = PBXFileReference; lastKnownFileType = "sourcecode.module-map"; path = KeyValueObservation.modulemap; sourceTree = SOURCE_ROOT; };
 		DDF7570422AA7C34002E11D4 /* KeyValueObservation.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = KeyValueObservation.h; sourceTree = "<group>"; };
+		DDF7572422AA8F27002E11D4 /* SRDKVOInfo.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SRDKVOInfo.h; sourceTree = "<group>"; };
+		DDF7572522AA8F27002E11D4 /* SRDKVOInfo.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SRDKVOInfo.m; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -216,6 +226,8 @@
 				DDF7569822AA77B2002E11D4 /* SRDKeyValueObservedChange.h */,
 				DDF7568D22AA77B1002E11D4 /* SRDKeyValueObservedChange+Internal.h */,
 				DDF7569122AA77B1002E11D4 /* SRDKeyValueObservedChange.m */,
+				DDF7572422AA8F27002E11D4 /* SRDKVOInfo.h */,
+				DDF7572522AA8F27002E11D4 /* SRDKVOInfo.m */,
 			);
 			name = Sources;
 			sourceTree = "<group>";
@@ -248,6 +260,7 @@
 				DDF7570522AA7C34002E11D4 /* KeyValueObservation.h in Headers */,
 				DDF7569B22AA77B2002E11D4 /* SRDKeyValueObservation+Internal.h in Headers */,
 				DDF7569922AA77B2002E11D4 /* SRDKeyValueObservedChange+Internal.h in Headers */,
+				DDF7572622AA8F27002E11D4 /* SRDKVOInfo.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -258,6 +271,7 @@
 				DDF756F822AA7BF8002E11D4 /* SRDKeyValueObservedChange.h in Headers */,
 				DDF756F522AA7BF8002E11D4 /* NSArray+KeyValueObservation.h in Headers */,
 				DDF756F622AA7BF8002E11D4 /* NSObject+KeyValueObservation.h in Headers */,
+				DDF7572822AA8F2B002E11D4 /* SRDKVOInfo.h in Headers */,
 				DDF756F722AA7BF8002E11D4 /* SRDKeyValueObservation.h in Headers */,
 				DDF7570622AA7C34002E11D4 /* KeyValueObservation.h in Headers */,
 			);
@@ -270,6 +284,7 @@
 				DDF756FD22AA7BFA002E11D4 /* SRDKeyValueObservedChange.h in Headers */,
 				DDF756FA22AA7BFA002E11D4 /* NSArray+KeyValueObservation.h in Headers */,
 				DDF756FB22AA7BFA002E11D4 /* NSObject+KeyValueObservation.h in Headers */,
+				DDF7572922AA8F2D002E11D4 /* SRDKVOInfo.h in Headers */,
 				DDF756FC22AA7BFA002E11D4 /* SRDKeyValueObservation.h in Headers */,
 				DDF7570722AA7C34002E11D4 /* KeyValueObservation.h in Headers */,
 			);
@@ -282,6 +297,7 @@
 				DDF7570222AA7BFC002E11D4 /* SRDKeyValueObservedChange.h in Headers */,
 				DDF756FF22AA7BFC002E11D4 /* NSArray+KeyValueObservation.h in Headers */,
 				DDF7570022AA7BFC002E11D4 /* NSObject+KeyValueObservation.h in Headers */,
+				DDF7572A22AA8F2F002E11D4 /* SRDKVOInfo.h in Headers */,
 				DDF7570122AA7BFC002E11D4 /* SRDKeyValueObservation.h in Headers */,
 				DDF7570822AA7C34002E11D4 /* KeyValueObservation.h in Headers */,
 			);
@@ -529,6 +545,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				DDF756A322AA77B2002E11D4 /* NSObject+KeyValueObservation.m in Sources */,
+				DDF7572722AA8F27002E11D4 /* SRDKVOInfo.m in Sources */,
 				DDF7569A22AA77B2002E11D4 /* SRDKeyValueObservation.m in Sources */,
 				DDF756A022AA77B2002E11D4 /* NSArray+KeyValueObservation.m in Sources */,
 				DDF7569D22AA77B2002E11D4 /* SRDKeyValueObservedChange.m in Sources */,
@@ -548,6 +565,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				DDF7570D22AA8686002E11D4 /* SRDKeyValueObservation.m in Sources */,
+				DDF7572B22AA8F33002E11D4 /* SRDKVOInfo.m in Sources */,
 				DDF7570E22AA8686002E11D4 /* SRDKeyValueObservedChange.m in Sources */,
 				DDF7570B22AA8686002E11D4 /* NSObject+KeyValueObservation.m in Sources */,
 				DDF7570C22AA8686002E11D4 /* NSArray+KeyValueObservation.m in Sources */,
@@ -567,6 +585,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				DDF7571122AA8687002E11D4 /* SRDKeyValueObservation.m in Sources */,
+				DDF7572C22AA8F34002E11D4 /* SRDKVOInfo.m in Sources */,
 				DDF7571222AA8687002E11D4 /* SRDKeyValueObservedChange.m in Sources */,
 				DDF7570F22AA8687002E11D4 /* NSObject+KeyValueObservation.m in Sources */,
 				DDF7571022AA8687002E11D4 /* NSArray+KeyValueObservation.m in Sources */,
@@ -586,6 +605,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				DDF7571522AA8688002E11D4 /* SRDKeyValueObservation.m in Sources */,
+				DDF7572D22AA8F35002E11D4 /* SRDKVOInfo.m in Sources */,
 				DDF7571622AA8688002E11D4 /* SRDKeyValueObservedChange.m in Sources */,
 				DDF7571322AA8688002E11D4 /* NSObject+KeyValueObservation.m in Sources */,
 				DDF7571422AA8688002E11D4 /* NSArray+KeyValueObservation.m in Sources */,

KeyValueObservation.xcodeproj/xcshareddata/xcschemes/KeyValueObservation macOS Tests.xcscheme

@@ -10,7 +10,18 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES"
       shouldUseLaunchSchemeArgsEnv = "YES">
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "DDF756B322AA782D002E11D4"
+            BuildableName = "KeyValueObservation.framework"
+            BlueprintName = "KeyValueObservation macOS"
+            ReferencedContainer = "container:KeyValueObservation.xcodeproj">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
          <TestableReference
             skipped = "NO">

KeyValueObservation.xcodeproj/xcshareddata/xcschemes/KeyValueObservation tvOS Tests.xcscheme

@@ -10,7 +10,18 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES"
       shouldUseLaunchSchemeArgsEnv = "YES">
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "DDF756CF22AA7841002E11D4"
+            BuildableName = "KeyValueObservation.framework"
+            BlueprintName = "KeyValueObservation tvOS"
+            ReferencedContainer = "container:KeyValueObservation.xcodeproj">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
          <TestableReference
             skipped = "NO">

KeyValueObservation.xcodeproj/xcshareddata/xcschemes/KeyValueObservation watchOS.xcscheme

@@ -26,7 +26,18 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES"
       shouldUseLaunchSchemeArgsEnv = "YES">
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "DDF756EB22AA7854002E11D4"
+            BuildableName = "KeyValueObservation.framework"
+            BlueprintName = "KeyValueObservation watchOS"
+            ReferencedContainer = "container:KeyValueObservation.xcodeproj">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
       </Testables>
       <AdditionalOptions>

KeyValueObservation.xcodeproj/xcshareddata/xcschemes/KeyValueObservationTests.xcscheme

@@ -10,7 +10,18 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES"
       shouldUseLaunchSchemeArgsEnv = "YES">
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "DDF7567222AA773D002E11D4"
+            BuildableName = "KeyValueObservation.framework"
+            BlueprintName = "KeyValueObservation"
+            ReferencedContainer = "container:KeyValueObservation.xcodeproj">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
          <TestableReference
             skipped = "NO">

KeyValueObservation/KeyValueObservation.h

@@ -10,3 +10,4 @@
 #import <KeyValueObservation/NSObject+KeyValueObservation.h>
 #import <KeyValueObservation/SRDKeyValueObservation.h>
 #import <KeyValueObservation/SRDKeyValueObservedChange.h>
+#import <KeyValueObservation/SRDKVOInfo.h>

KeyValueObservation/NSObject+KeyValueObservation.h

@@ -8,6 +8,7 @@
 
 #import <Foundation/Foundation.h>
 
+#import <KeyValueObservation/SRDKVOInfo.h>
 #import <KeyValueObservation/SRDKeyValueObservation.h>
 #import <KeyValueObservation/SRDKeyValueObservedChange.h>
 
@@ -24,6 +25,12 @@ NS_ASSUME_NONNULL_BEGIN
 /// \returns An object that keeps the observation alive. Once this object is deallocated, the block is released no longer receives KVO events.
 - (SRDKeyValueObservation *)observeKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options changeHandler:(void (^)(id, SRDKeyValueObservedChange *))changeHandler OBJC_SWIFT_UNAVAILABLE("use Swift's KeyPath observing instead");
 
+/// Runs a given handler block synchronously while ignoring all Key-Value Observations specified by the @p observations parameter. This has the same effect as unregistering for each observer/keyPath in @p observations, running the block, then re-registering for each observation.
+///
+/// \param observations An array specifying the Key-Value Observations to ignore.
+/// \param handler The block to run.
+- (void)performWhileIgnoringObservations:(NSArray<SRDKVOInfo *> *)observations handler:(void (^NS_NOESCAPE)(void))handler;
+
 @end
 
 NS_ASSUME_NONNULL_END

KeyValueObservation/NSObject+KeyValueObservation.m

@@ -11,6 +11,10 @@
 
 #import "SRDKeyValueObservation+Internal.h"
 
+#pragma mark - Private Function Declarations
+
+static void __observeValueForKeyPath(id self, SEL _cmd, NSString * __nullable, id __nullable, NSDictionary<NSKeyValueChangeKey, id> * __nullable, void * __nullable);
+
 #pragma mark - Class Category | NSObject (KeyValueObservation)
 
 @implementation NSObject (KeyValueObservation)
@@ -26,4 +30,66 @@ - (SRDKeyValueObservation *)observeKeyPath:(NSString *)keyPath options:(NSKeyVal
     return [[SRDKeyValueObservation alloc] initWithObject:self keyPath:keyPath options:options changeHandler:changeHandler];
 }
 
+
+
+- (void)performWhileIgnoringObservations:(NSArray<SRDKVOInfo *> *)observations handler:(void (^NS_NOESCAPE)(void))handler {
+    if (observations.count == 0)
+        return handler();
+
+    observations = [[NSArray alloc] initWithArray:observations copyItems:YES];
+
+    Class const selfclass = object_getClass(self);
+    Class const superclass = class_getSuperclass(selfclass);
+
+    Method const superObserveValueForKeyPath = superclass != Nil ? class_getInstanceMethod(superclass, @selector(observeValueForKeyPath:ofObject:change:context:)) : NULL;
+    Method observeValueForKeyPath = class_getInstanceMethod(selfclass, method_getName(superObserveValueForKeyPath));
+
+    if (superObserveValueForKeyPath != NULL && observeValueForKeyPath == superObserveValueForKeyPath) {
+        // This class doesn't override its superclass' implementation of
+        // -[NSObject observeValueForKeyPath:ofObject:change:context:]. We should add the
+        // method to the current class so as not to replace the superclass' implementation
+        // with ours.
+
+        class_addMethod(selfclass, method_getName(superObserveValueForKeyPath), (IMP)__observeValueForKeyPath, method_getTypeEncoding(superObserveValueForKeyPath));
+        observeValueForKeyPath = class_getInstanceMethod(selfclass, method_getName(superObserveValueForKeyPath));
+    }
+
+    IMP const originalObserveValueForKeyPath = method_getImplementation(observeValueForKeyPath);
+
+    __typeof(self) __unsafe_unretained const unowned = self;
+    void (^ const __observeValueForKeyPath)(id, NSString *, id, NSDictionary *, void *) = ^(id _self, NSString *_keyPath, id _object, NSDictionary *_change, void *_context) {
+        for (SRDKVOInfo *observation in observations) {
+            if (unowned == _self && observation.observed == _object && [observation.keyPath isEqualToString:_keyPath])
+                return; // Ignore
+        }
+
+        // Forward to original implementation
+        ((void (*)(id, SEL, NSString *, id, NSDictionary *, void *))originalObserveValueForKeyPath)(_self, @selector(observeValueForKeyPath:ofObject:change:context:), _keyPath, _object, _change, _context);
+    };
+
+    IMP const replacementObserveValueForKeyPath = imp_implementationWithBlock(__observeValueForKeyPath);
+    method_setImplementation(observeValueForKeyPath, replacementObserveValueForKeyPath);
+
+    @try { handler(); }
+    @finally {
+        // Always set back original implementation and remove block
+        method_setImplementation(observeValueForKeyPath, originalObserveValueForKeyPath);
+        imp_removeBlock(replacementObserveValueForKeyPath);
+    }
+}
+
 @end
+
+#pragma mark - Private Function Definitions
+
+/// Simple implementation of -[NSObject observeValueForKeyPath:ofObject:change:context:] that simply invoke its superclass' implementation
+static void __observeValueForKeyPath(id self, SEL _cmd, NSString * __nullable keyPath, id __nullable object, NSDictionary<NSKeyValueChangeKey, id> * __nullable change, void * __nullable context) {
+    Class const superclass = class_getSuperclass(object_getClass(self));
+
+    struct objc_super super = {
+        .receiver = self,
+        .super_class = superclass
+    };
+
+    ((void (*)(struct objc_super *, SEL, NSString *, id, NSDictionary<NSKeyValueChangeKey, id> *, void *))objc_msgSendSuper)(&super, _cmd, keyPath, object, change, context);
+}

KeyValueObservation/SRDKVOInfo.h

@@ -0,0 +1,36 @@
+//
+//  SRDKVOInfo.h
+//  KeyValueObservation
+//
+//  Created by Joseph Newton on 2/7/19.
+//  Copyright © 2019 Joseph Newton. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - Class (SRDKVOInfo) Interface
+
+@interface SRDKVOInfo : NSObject <NSCopying, NSMutableCopying>
+
+@property (nonatomic, strong, readonly, nullable) __kindof NSObject *observed;
+@property (nonatomic, copy, readonly)             NSString *keyPath;
+
+- (instancetype)initWithObserved:(nullable __kindof NSObject *)observed keyPath:(NSString *)keyPath;
++ (SRDKVOInfo *)infoWithObserved:(nullable __kindof NSObject *)observed keyPath:(NSString *)keyPath OBJC_SWIFT_UNAVAILABLE("use object initializers instead");
+
+@end
+
+#pragma mark - Class (SRDMutableKVOInfo) Interface
+
+@interface SRDMutableKVOInfo : SRDKVOInfo <NSCopying, NSMutableCopying>
+
+@property (nonatomic, strong, nullable) __kindof NSObject *observed;
+@property (nonatomic, copy)             NSString *keyPath;
+
++ (SRDMutableKVOInfo *)infoWithObserved:(nullable __kindof NSObject *)observed keyPath:(NSString *)keyPath OBJC_SWIFT_UNAVAILABLE("use object initializers instead");
+
+@end
+
+NS_ASSUME_NONNULL_END