Mac: Animate the bookmark bar showing/hiding.

chrome/browser/cocoa/bookmark_bar_controller_unittest.mm

 // Copyright (c) 2009 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import <Cocoa/Cocoa.h>
 
 #include "base/basictypes.h"
 #include "base/scoped_nsobject.h"
 #include "base/sys_string_conversions.h"
 #import "chrome/browser/cocoa/bookmark_bar_constants.h"
 #import "chrome/browser/cocoa/bookmark_bar_controller.h"
 #import "chrome/browser/cocoa/bookmark_bar_view.h"
 #include "chrome/browser/cocoa/browser_test_helper.h"
 #import "chrome/browser/cocoa/cocoa_test_helper.h"
-#import "chrome/browser/cocoa/toolbar_compressable.h"
 #include "chrome/browser/cocoa/test_event_utils.h"
 #import "chrome/browser/cocoa/view_resizer_pong.h"
 #include "chrome/common/pref_names.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "testing/platform_test.h"
 
 // Just like a BookmarkBarController but openURL: is stubbed out.
 @interface BookmarkBarControllerNoOpen : BookmarkBarController {
  @public
   std::vector<GURL> urls_;
@@ skipping 46 matching lines @@
 @implementation BookmarkBarControllerTogglePong
 
 @synthesize toggles = toggles_;
 
 - (void)frameDidChange {
   toggles_++;
 }
 
 @end
 
-// A BookmarkBarController that always beleives that it's on the new tab page.
-@interface AlwaysNewTabPageBookmarkBarController : BookmarkBarControllerNoOpen {
-}
-@end
-
-@implementation AlwaysNewTabPageBookmarkBarController
--(BOOL)isNewTabPage {
-  return YES;
-}
-@end
-
-@interface CompressablePong : NSObject<ToolbarCompressable> {
-@private
-  BOOL compressed_;
-}
-@property (readonly) BOOL compressed;
-@end
-
-@implementation CompressablePong
-
-@synthesize compressed = compressed_;
-
-- (void)setShouldBeCompressed:(BOOL)compressed {
-  compressed_ = compressed;
-}
-
-@end
-
 namespace {
 
 static const int kContentAreaHeight = 500;
 static const int kInfoBarViewHeight = 30;
 
 class BookmarkBarControllerTest : public PlatformTest {
  public:
   BookmarkBarControllerTest() {
     resizeDelegate_.reset([[ViewResizerPong alloc] init]);
-    compressDelegate_.reset([[CompressablePong alloc] init]);
     NSRect parent_frame = NSMakeRect(0, 0, 800, 50);
     parent_view_.reset([[NSView alloc] initWithFrame:parent_frame]);
     [parent_view_ setHidden:YES];
     bar_.reset(
       [[BookmarkBarControllerNoOpen alloc]
           initWithBrowser:helper_.browser()
              initialWidth:NSWidth(parent_frame)
-         compressDelegate:compressDelegate_.get()
+                 delegate:nil
            resizeDelegate:resizeDelegate_.get()]);
 
     InstallAndToggleBar(bar_.get());
 
     // Create a menu/item to act like a sender
     menu_.reset([[NSMenu alloc] initWithTitle:@"I_dont_care"]);
     menu_item_.reset([[NSMenuItem alloc]
                        initWithTitle:@"still_dont_care"
                               action:NULL
                        keyEquivalent:@""]);
     cell_.reset([[NSButtonCell alloc] init]);
     [menu_item_ setMenu:menu_.get()];
     [menu_ setDelegate:cell_.get()];
   }
 
   void InstallAndToggleBar(BookmarkBarController* bar) {
     // Force loading of the nib.
     [bar view];
     // Awkwardness to look like we've been installed.
     [parent_view_ addSubview:[bar view]];
     NSRect frame = [[[bar view] superview] frame];
     frame.origin.y = 100;
     [[[bar view] superview] setFrame:frame];
 
-    // make sure it's open so certain things aren't no-ops
-    helper_.profile()->GetPrefs()->SetBoolean(prefs::kShowBookmarkBar, true);
+    // Make sure it's open so certain things aren't no-ops.
+    [bar updateAndShowNormalBar:YES
+                showDetachedBar:NO
+                  withAnimation:NO];
+  }
+
+  // Update the state of the bookmark bar.
+  void UpdateBookmarkBar() {
+    [bar_ updateAndShowNormalBar:[bar_ isShownAsToolbar]
+                 showDetachedBar:[bar_ isShownAsDetachedBar]
+                   withAnimation:NO];
   }
 
   // Return a menu item that points to the right URL.
   NSMenuItem* ItemForBookmarkBarMenu(GURL& gurl) {
     node_.reset(new BookmarkNode(gurl));
     [cell_ setRepresentedObject:[NSValue valueWithPointer:node_.get()]];
     return menu_item_;
   }
 
   // Does NOT take ownership of node.
   NSMenuItem* ItemForBookmarkBarMenu(const BookmarkNode* node) {
     [cell_ setRepresentedObject:[NSValue valueWithPointer:node]];
     return menu_item_;
   }
 
-
   CocoaTestHelper cocoa_helper_;  // Inits Cocoa, creates window, etc...
   scoped_nsobject<NSView> parent_view_;
   BrowserTestHelper helper_;
   scoped_nsobject<ViewResizerPong> resizeDelegate_;
-  scoped_nsobject<CompressablePong> compressDelegate_;
   scoped_nsobject<BookmarkBarControllerNoOpen> bar_;
   scoped_nsobject<NSMenu> menu_;
   scoped_nsobject<NSMenuItem> menu_item_;
   scoped_nsobject<NSButtonCell> cell_;
   scoped_ptr<BookmarkNode> node_;
 };
 
 TEST_F(BookmarkBarControllerTest, ShowWhenShowBookmarkBarTrue) {
-  helper_.profile()->GetPrefs()->SetBoolean(prefs::kShowBookmarkBar, true);
-  [bar_ updateVisibility];
-
+  [bar_ updateAndShowNormalBar:YES
+               showDetachedBar:NO
+                 withAnimation:NO];
+  EXPECT_TRUE([bar_ isShownAsToolbar]);
+  EXPECT_FALSE([bar_ isShownAsDetachedBar]);
   EXPECT_TRUE([bar_ isVisible]);
   EXPECT_FALSE([[bar_ view] isHidden]);
   EXPECT_GT([resizeDelegate_ height], 0);
   EXPECT_GT([[bar_ view] frame].size.height, 0);
 }
 
 TEST_F(BookmarkBarControllerTest, HideWhenShowBookmarkBarFalse) {
-  helper_.profile()->GetPrefs()->SetBoolean(prefs::kShowBookmarkBar, false);
-  [bar_ updateVisibility];
-
+  [bar_ updateAndShowNormalBar:NO
+               showDetachedBar:NO
+                 withAnimation:NO];
+  EXPECT_FALSE([bar_ isShownAsToolbar]);
+  EXPECT_FALSE([bar_ isShownAsDetachedBar]);
   EXPECT_FALSE([bar_ isVisible]);
   EXPECT_TRUE([[bar_ view] isHidden]);
   EXPECT_EQ(0, [resizeDelegate_ height]);
   EXPECT_EQ(0, [[bar_ view] frame].size.height);
 }
 
 TEST_F(BookmarkBarControllerTest, HideWhenShowBookmarkBarTrueButDisabled) {
-  helper_.profile()->GetPrefs()->SetBoolean(prefs::kShowBookmarkBar, true);
   [bar_ setBookmarkBarEnabled:NO];
-  [bar_ updateVisibility];
-
+  [bar_ updateAndShowNormalBar:YES
+               showDetachedBar:NO
+                 withAnimation:NO];
+  EXPECT_TRUE([bar_ isShownAsToolbar]);
+  EXPECT_FALSE([bar_ isShownAsDetachedBar]);
   EXPECT_FALSE([bar_ isVisible]);
   EXPECT_TRUE([[bar_ view] isHidden]);
   EXPECT_EQ(0, [resizeDelegate_ height]);
   EXPECT_EQ(0, [[bar_ view] frame].size.height);
 }
 
 TEST_F(BookmarkBarControllerTest, ShowOnNewTabPage) {
-  helper_.profile()->GetPrefs()->SetBoolean(prefs::kShowBookmarkBar, false);
-
-  scoped_nsobject<BookmarkBarControllerTogglePong> bar;
-  bar.reset(
-      [[AlwaysNewTabPageBookmarkBarController alloc]
-          initWithBrowser:helper_.browser()
-             initialWidth:800  // arbitrary
-         compressDelegate:compressDelegate_.get()
-           resizeDelegate:resizeDelegate_.get()]);
-  InstallAndToggleBar(bar.get());
-
-  [bar setBookmarkBarEnabled:NO];
-  [bar updateVisibility];
-
-  EXPECT_TRUE([bar isVisible]);
-  EXPECT_FALSE([[bar view] isHidden]);
-  EXPECT_GT([resizeDelegate_ height], 0);
-  EXPECT_GT([[bar view] frame].size.height, 0);
+  [bar_ updateAndShowNormalBar:NO
+               showDetachedBar:YES
+                 withAnimation:NO];
+  EXPECT_FALSE([bar_ isShownAsToolbar]);
+  EXPECT_TRUE([bar_ isShownAsDetachedBar]);
+  EXPECT_TRUE([bar_ isVisible]);
+  EXPECT_FALSE([[bar_ view] isHidden]);
+  ;EXPECT_GT([resizeDelegate_ height], 0);
+  EXPECT_GT([[bar_ view] frame].size.height, 0);
 
   // Make sure no buttons fall off the bar, either now or when resized
   // bigger or smaller.
   CGFloat sizes[] = { 300.0, -100.0, 200.0, -420.0 };
   CGFloat previousX = 0.0;
   for (unsigned x = 0; x < arraysize(sizes); x++) {
     // Confirm the buttons moved from the last check (which may be
     // init but that's fine).
-    CGFloat newX = [[bar offTheSideButton] frame].origin.x;
+    CGFloat newX = [[bar_ offTheSideButton] frame].origin.x;
     EXPECT_NE(previousX, newX);
     previousX = newX;
 
-    // Confirm the buttons have a reasonable bounds.
-    EXPECT_TRUE(NSContainsRect([[bar buttonView] frame],
-                               [[bar offTheSideButton] frame]));
-    EXPECT_TRUE(NSContainsRect([[bar buttonView] frame],
-                               [[bar otherBookmarksButton] frame]));
+    // Confirm the buttons have a reasonable bounds. Recall that |-frame|
+    // returns rectangles in the superview's coordinates.
+    NSRect buttonViewFrame =
+        [[bar_ buttonView] convertRect:[[bar_ buttonView] frame]
+                              fromView:[[bar_ buttonView] superview]];
+    EXPECT_EQ([bar_ buttonView], [[bar_ offTheSideButton] superview]);
+    EXPECT_TRUE(NSContainsRect(buttonViewFrame,
+                               [[bar_ offTheSideButton] frame]));
+    EXPECT_EQ([bar_ buttonView], [[bar_ otherBookmarksButton] superview]);
+    EXPECT_TRUE(NSContainsRect(buttonViewFrame,
+                               [[bar_ otherBookmarksButton] frame]));
 
     // Now move them implicitly.
     // We confirm FrameChangeNotification works in the next unit test;
     // we simply assume it works here to resize or reposition the
     // buttons above.
-    NSRect frame = [[bar view] frame];
+    NSRect frame = [[bar_ view] frame];
     frame.size.width += sizes[x];
-    [[bar view] setFrame:frame];
+    [[bar_ view] setFrame:frame];
   }
 }
 
 // Make sure we're watching for frame change notifications.
 TEST_F(BookmarkBarControllerTest, FrameChangeNotification) {
   scoped_nsobject<BookmarkBarControllerTogglePong> bar;
   bar.reset(
     [[BookmarkBarControllerTogglePong alloc]
           initWithBrowser:helper_.browser()
              initialWidth:100  // arbitrary
-         compressDelegate:compressDelegate_.get()
+                 delegate:nil
            resizeDelegate:resizeDelegate_.get()]);
   InstallAndToggleBar(bar.get());
 
   // Send a frame did change notification for the pong's view.
   [[NSNotificationCenter defaultCenter]
     postNotificationName:NSViewFrameDidChangeNotification
                   object:[bar view]];
 
   EXPECT_GT([bar toggles], 0);
 }
@@ skipping 130 matching lines @@
   NSView* buttonView = [bar_ buttonView];
   EXPECT_EQ(0U, [[bar_ buttons] count]);
   unsigned int initial_subview_count = [[buttonView subviews] count];
 
   // Make sure a redundant call doesn't choke
   [bar_ clearBookmarkBar];
   EXPECT_EQ(0U, [[bar_ buttons] count]);
   EXPECT_EQ(initial_subview_count, [[buttonView subviews] count]);
 
   GURL gurl1("http://superfriends.hall-of-justice.edu");
-  std::wstring title1(L"Protectors of the Universe");
+  // Short titles increase the chances of this test succeeding if the view is
+  // narrow.
+  // TODO(viettrungluu): make the test independent of window/view size, font
+  // metrics, button size and spacing, and everything else.
+  std::wstring title1(L"x");
   model->SetURLStarred(gurl1, title1, true);
   EXPECT_EQ(1U, [[bar_ buttons] count]);
   EXPECT_EQ(1+initial_subview_count, [[buttonView subviews] count]);
 
   GURL gurl2("http://legion-of-doom.gov");
-  std::wstring title2(L"Bad doodz");
+  std::wstring title2(L"y");
   model->SetURLStarred(gurl2, title2, true);
   EXPECT_EQ(2U, [[bar_ buttons] count]);
   EXPECT_EQ(2+initial_subview_count, [[buttonView subviews] count]);
 
   for (int i = 0; i < 3; i++) {
     // is_starred=false --> remove the bookmark
     model->SetURLStarred(gurl2, title2, false);
     EXPECT_EQ(1U, [[bar_ buttons] count]);
     EXPECT_EQ(1+initial_subview_count, [[buttonView subviews] count]);
 
@@ skipping 266 matching lines @@
   const BookmarkNode* parent = model->GetBookmarkBarNode();
   [bar_ addURLs:nsurls withTitles:nstitles at:NSZeroPoint];
   EXPECT_EQ(3, parent->GetChildCount());
   for (int i = 0; i < parent->GetChildCount(); ++i) {
     EXPECT_EQ(parent->GetChild(i)->GetURL(), GURL(urls[i]));
     EXPECT_EQ(parent->GetChild(i)->GetTitle(), titles[i]);
   }
 }
 
 }  // namespace