Merge pull request #51 from Raizlabs/develop

Release 0.3.0

Author: mgorbach

Classes/RZDebugMenu.h

@@ -6,8 +6,6 @@
 //  Copyright (c) 2014 Raizlabs. All rights reserved.
 //
 
-#import "RZDebugMenuClearViewController.h"
-
 /**
  *  Observer notification name constant. Notification with this name sent on a change in the Debug Menu. The userInfo on the Notification sent contains the setting's key:value pair that was changed.
  */
@@ -36,12 +34,25 @@ OBJC_EXTERN NSString* const kRZDebugMenuSettingChangedNotification;
 + (instancetype)sharedDebugMenu;
 
 /**
- *  Configure automatic show / hide of the debug menu button with a 5-tap gesture on the selected window.
+ *  Configure presentation of the debug menu button with a 3-finger, 3-tap gesture on the specified view.
+ *
+ *  @param view   The view on which to set up the presentation gesture.
+ */
+- (void)registerDebugMenuPresentationGestureOnView:(UIView *)view;
 
- *  @param window   The window to set up for automatic show / hide of the debug menu button.
+/**
+ *  Manually present the debug menu on the root view controller of the presentation's main window, or the deepest presented view controller if a presentation is already active.
  */
-- (void)configureAutomaticShowHideOnWindow:(UIWindow *)window;
+- (void)presentDebugMenu;
 
-@property (assign, nonatomic, readwrite) BOOL showDebugMenuButton;
+/**
+ *  Manually dismiss the debug menu, if it is currently presented.
+ */
+- (void)dismissDebugMenu;
+
+/**
+ *  The top-level view controller for the debug menu to present (in case you want to present it manually yourself).
+ */
+@property (strong, nonatomic, readonly) UIViewController *debugMenuViewControllerToPresent;
 
 @end

Classes/RZDebugMenu.m

@@ -8,8 +8,6 @@
 
 #import "RZDebugMenu.h"
 
-#import "RZDebugMenuWindow.h"
-
 #import "RZDebugMenuSettings.h"
 #import "RZDebugMenuSettingsForm.h"
 #import "RZDebugMenuSettingsParser.h"
@@ -20,6 +18,7 @@
 #import "RZDebugMenuSettings_Private.h"
 #import "RZDebugMenuVersionItem.h"
 #import "RZDebugMenuGroupItem.h"
+#import "UIViewController+RZDebugMenuPresentationAdditions.h"
 
 #import "RZDebugLogMenuDefines.h"
 
@@ -29,12 +28,12 @@
 
 NSString* const kRZDebugMenuSettingChangedNotification = @"RZDebugMenuSettingChanged";
 
-static NSUInteger kRZNumberOfTapsToHide = 4;
+static NSUInteger kRZNumberOfTapsToShow = 3;
+static NSUInteger kRZNumberOfTouchesToShow = 2;
 
-@interface RZDebugMenu () <RZDebugMenuClearViewControllerDelegate>
+@interface RZDebugMenu () <RZDebugMenuFormViewControllerDelegate>
 
-@property (strong, nonatomic) RZDebugMenuWindow *topWindow;
-@property (strong, nonatomic) RZDebugMenuClearViewController *clearRootViewController;
+@property (strong, nonatomic, readwrite) UIViewController *debugMenuViewControllerToPresent;
 
 @property (strong, nonatomic, readwrite) NSArray *settingsMenuItems;
 
@@ -73,60 +72,30 @@ - (RZDebugMenu *)init_internal
 {
     self = [super init];
     if ( self ) {
-        [[NSNotificationCenter defaultCenter] addObserver:self
-                                                 selector:@selector(applicationDidFinishLaunching:)
-                                                     name:UIApplicationDidFinishLaunchingNotification
-                                                   object:nil];
-
-        self.showDebugMenuButton = NO;
+        [self configureDebugMenu];
     }
 
     return self;
 }
 
-# pragma mark - Configuration
-
-- (void)configureTopWindowIfNeeded
-{
-    if ( self.clearRootViewController == nil ) {
-        self.clearRootViewController = [[RZDebugMenuClearViewController alloc] initWithDelegate:self];
-
-        UIScreen *mainScreen = [UIScreen mainScreen];
-        self.topWindow = [[RZDebugMenuWindow alloc] initWithFrame:mainScreen.bounds];
-        self.topWindow.windowLevel = UIWindowLevelStatusBar - 1.f;
-        self.topWindow.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
-        self.topWindow.rootViewController = self.clearRootViewController;
-        self.topWindow.hidden = NO;
-    }
-}
-
-#pragma mark - UX
+#pragma mark - Configuration
 
-- (void)displayDebugMenu
+- (void)configureDebugMenu
 {
     if ( self.settingsMenuItems.count > 0 ) {
         RZDebugMenuSettingsForm *settingsForm = [[RZDebugMenuSettingsForm alloc] initWithSettingsMenuItems:self.settingsMenuItems];
 
-        FXFormViewController *settingsMenuViewController = [[RZDebugMenuFormViewController alloc] init];
+        RZDebugMenuFormViewController *settingsMenuViewController = [[RZDebugMenuFormViewController alloc] init];
+        settingsMenuViewController.delegate = self;
+        
+        settingsForm.delegate = settingsMenuViewController;
+
         settingsMenuViewController.formController.form = settingsForm;
 
         UINavigationController *modalNavigationController = [[UINavigationController alloc] initWithRootViewController:settingsMenuViewController];
-        [self.clearRootViewController presentViewController:modalNavigationController animated:YES completion:nil];
-    }
-}
-
-#pragma mark - RZDebugMenuClearViewControllerDelegate
-
-- (void)clearViewControllerDebugMenuButtonPressed:(RZDebugMenuClearViewController *)clearViewController
-{
-    [self displayDebugMenu];
-}
-
-#pragma mark - Notifications
 
-- (void)applicationDidFinishLaunching:(NSNotification *)note
-{
-    [self configureTopWindowIfNeeded];
+        self.debugMenuViewControllerToPresent = modalNavigationController;
+    }
 }
 
 #pragma mark - Settings Menu
@@ -156,44 +125,58 @@ - (void)loadSettingsMenuFromPlistName:(NSString *)plistName
     }
 
     self.settingsMenuItems = settingsMenuItems;
+
+    [self configureDebugMenu];
 }
 
-# pragma mark - Show / Hide
+# pragma mark - Presentation
 
-- (void)configureAutomaticShowHideOnWindow:(UIWindow *)window
+- (void)registerDebugMenuPresentationGestureOnView:(UIView *)view
 {
-    NSAssert(window != nil, @"");
-
-    UIViewController *rootViewController = window.rootViewController;
-    NSAssert(rootViewController != nil, @"");
-
-    UIView *view = rootViewController.view;
     NSAssert(view != nil, @"");
 
-    UITapGestureRecognizer *manyTapGestureRecognizer = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(manyTapGestureRecognizerFired:)];
-    manyTapGestureRecognizer.numberOfTapsRequired = kRZNumberOfTapsToHide;
+    UITapGestureRecognizer *manyTapGestureRecognizer = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(debugMenuActivationGestureRecognizerFired:)];
+    manyTapGestureRecognizer.numberOfTapsRequired = kRZNumberOfTapsToShow;
+    manyTapGestureRecognizer.numberOfTouchesRequired = kRZNumberOfTouchesToShow;
 
     [view addGestureRecognizer:manyTapGestureRecognizer];
 }
 
-- (void)manyTapGestureRecognizerFired:(id)sender
+- (void)presentDebugMenu
 {
-    [self showHideDebugMenuButton];
+    if ( self.debugMenuViewControllerToPresent.presentingViewController != nil ) {
+        NSLog(@"Not presenting debug menu. It is already active.");
+        return;
+    }
+
+    if ( self.debugMenuViewControllerToPresent == nil ) {
+        NSLog(@"No debug menu enabled. Not presenting.");
+        return;
+    }
+
+    UIViewController *viewControllerToPresentOn = [UIApplication sharedApplication].keyWindow.rootViewController;
+    viewControllerToPresentOn = viewControllerToPresentOn.rzDebugMenu_deepestViewControllerForPresentation;
+
+    [viewControllerToPresentOn presentViewController:self.debugMenuViewControllerToPresent animated:YES completion:nil];
 }
 
-- (void)showHideDebugMenuButton
+- (void)debugMenuActivationGestureRecognizerFired:(id)sender
 {
-    self.clearRootViewController.showDebugMenuButton = (!self.clearRootViewController.showDebugMenuButton);
+    [self presentDebugMenu];
 }
 
-- (void)setShowDebugMenuButton:(BOOL)showDebugMenuButton
+- (void)dismissDebugMenu
 {
-    if ( _showDebugMenuButton != showDebugMenuButton ) {
-        _showDebugMenuButton = showDebugMenuButton;
-
-        [self configureTopWindowIfNeeded];
-        self.clearRootViewController.showDebugMenuButton = showDebugMenuButton;
+    if ( self.debugMenuViewControllerToPresent.presentingViewController ) {
+        [self.debugMenuViewControllerToPresent dismissViewControllerAnimated:YES completion:nil];
     }
 }
 
+# pragma mark - RZDebugMenuFormViewControllerDelegate
+
+- (void)debugMenuFormViewControllerShouldDimiss:(RZDebugMenuFormViewController *)debugMenuFormViewController
+{
+    [self dismissDebugMenu];
+}
+
 @end

Classes/RZDebugMenuFormViewController.h

@@ -8,6 +8,18 @@
 
 #import <FXForms/FXForms.h>
 
-@interface RZDebugMenuFormViewController : FXFormViewController
+#import "RZDebugMenuSettingsForm.h"
+
+@class RZDebugMenuFormViewController;
+
+@protocol RZDebugMenuFormViewControllerDelegate <NSObject>
+
+- (void)debugMenuFormViewControllerShouldDimiss:(RZDebugMenuFormViewController *)debugMenuFormViewController;
+
+@end
+
+@interface RZDebugMenuFormViewController : FXFormViewController <RZDebugMenuSettingsFormDelegate>
+
+@property (weak, nonatomic, readwrite) id <RZDebugMenuFormViewControllerDelegate> delegate;
 
 @end

Classes/RZDebugMenuFormViewController.m

@@ -8,6 +8,8 @@
 
 #import "RZDebugMenuFormViewController.h"
 
+#import "RZDebugMenuSettingsForm.h"
+
 static NSString *const kRZNavigationBarTitle = @"Debug Menu";
 
 static NSString *const kRZNavigationBarDoneButtonTitle = @"Done";
@@ -38,8 +40,19 @@ - (NSString *)title
 
 - (void)doneButtonTapped:(id)sender
 {
-    [[NSUserDefaults standardUserDefaults] synchronize];
-    [self dismissViewControllerAnimated:YES completion:nil];
+    [self.delegate debugMenuFormViewControllerShouldDimiss:self];
+}
+
+# pragma mark - RZDebugMenuSettingsFormDelegate
+
+- (UIViewController *)viewControllerForChildPaneItem:(RZDebugMenuLoadedChildPaneItem *)childPaneItem
+{
+    NSAssert(childPaneItem != nil, @"");
+
+    RZDebugMenuFormViewController *formViewController = [[RZDebugMenuFormViewController alloc] initWithNibName:nil bundle:nil];
+    formViewController.delegate = self.delegate;
+
+    return formViewController;
 }
 
 @end

Classes/UI/RZDebugMenuSettingsForm.h

@@ -8,8 +8,18 @@
 
 #import <FXForms/FXForms.h>
 
+@class RZDebugMenuLoadedChildPaneItem;
+
+@protocol RZDebugMenuSettingsFormDelegate <NSObject>
+
+- (UIViewController *)viewControllerForChildPaneItem:(RZDebugMenuLoadedChildPaneItem *)childPaneItem;
+
+@end
+
 @interface RZDebugMenuSettingsForm : NSObject <FXForm>
 
 - (instancetype)initWithSettingsMenuItems:(NSArray *)settingsMenuItems NS_DESIGNATED_INITIALIZER;
 
+@property (weak, nonatomic, readwrite) id <RZDebugMenuSettingsFormDelegate> delegate;
+
 @end

Classes/UI/RZDebugMenuSettingsForm.m

@@ -151,12 +151,19 @@ - (NSArray *)uncachedFields
         else if ( [item isKindOfClass:[RZDebugMenuLoadedChildPaneItem class]] ) {
             formFieldType = FXFormFieldTypeDefault;
 
-            NSArray *settingsMenuItems = ((RZDebugMenuLoadedChildPaneItem *)item).settingsMenuItems;
+            RZDebugMenuLoadedChildPaneItem *childPaneItem = (RZDebugMenuLoadedChildPaneItem *)item;
+            NSArray *settingsMenuItems = childPaneItem.settingsMenuItems;
             RZDebugMenuSettingsForm *childSettingsForm = [[RZDebugMenuSettingsForm alloc] initWithSettingsMenuItems:settingsMenuItems];
+            childSettingsForm.delegate = self.delegate;
+
             defaultValue = childSettingsForm;
 
             mutableFieldDictionary[FXFormFieldClass] = [RZDebugMenuSettingsForm class];
-            mutableFieldDictionary[FXFormFieldViewController] = [[RZDebugMenuFormViewController alloc] init];
+
+            UIViewController *formViewController = [self.delegate viewControllerForChildPaneItem:childPaneItem];
+            NSAssert(formViewController != nil, @"");
+
+            mutableFieldDictionary[FXFormFieldViewController] = formViewController;
         }
         else if ( [item isKindOfClass:[RZDebugMenuTitleItem class]] ) {
             formFieldType = FXFormFieldTypeDefault;