sproutcore 0.9.1 → 0.9.2

data/frameworks/sproutcore/mixins/selection_support.js

@@ -0,0 +1,148 @@
+// ========================================================================
+// SproutCore
+// copyright 2006-2008 Sprout Systems, Inc.
+// ========================================================================
+
+/**
+  @namespace 
+  
+  Implements common selection management properties for controllers.
+
+  Selection can be managed by any controller in your applications.  This
+  mixin provides some common management features you might want such as
+  disabling selection, or restricting empty or multiple selections.
+
+  To use this mixin, simply add it to any controller you want to manage 
+  selection and call updateSelectionAfterContentChange()
+  whenever your source content changes.  You can also override the properties
+  defined below to configure how the selection management will treat your 
+  content.
+  
+  This mixin assumes the arrangedObjects property will return the array of 
+  content you want the selection to reflect.
+  
+  Add this mixin to any controller you want to manage selection.  It is 
+  already applied to the CollectionController and ArrayController.
+
+*/
+SC.SelectionSupport = {
+  
+  /** 
+    Call this method whenever  your source content changes to ensure the 
+    selection always remains up-to-date and valid.
+  */
+  updateSelectionAfterContentChange: function() {
+    var objects = Array.from(this.get('arrangedObjects')) ;
+    var currentSelection = Array.from(this.get('selection')) ;
+    var sel = [] ;
+
+    // the new selection is the current selection that exists in 
+    // arrangedObjects or an empty selection if selection is not allowed.
+    var max = currentSelection.get('length') ;
+    if (this.get('allowsSelection')) {
+      for(var idx=0;idx<max;idx++) {
+        var obj = currentSelection.objectAt(idx) ;
+        if (objects.indexOf(obj) >= 0) sel.push(obj) ;
+      }
+    }
+
+    // if the new selection is a multiple selection, then get the first
+    // object.
+    var selectionLength = sel.get('length') ;
+    if ((selectionLength > 1) && !this.get('allowsMultipleSelection')) {
+      sel = [sel.objectAt(0)] ;
+    }
+
+    // if the selection is empty, select the first item.
+    if ((selectionLength == 0) && !this.get('allowsEmptySelection')) {
+      if (objects.get('length') > 0) sel = [objects.objectAt(0)];
+    }
+
+    // update the selection.
+    this.set('selection',sel) ;
+  },
+  
+  /**
+    @field {Array} arrangedObjects
+    
+    Returns the set of content objects the selection should be a part of.
+    Selections in general may contain objects outside of this content, but
+    this set will be used when enforcing items such as no empty selection.
+    
+    The default version of this property returns the receiver.
+  */
+  arrangedObjects: function() {
+    return this;
+  }.property(),
+  
+  /**  
+    @field {Array} selection 
+
+    This is the current selection.  You can make this selection and another
+    controller's selection work in concert by binding them together. You
+    generally have a master selection that relays changes TO all the others.
+  */
+  selection: function(key,value)
+  {
+    if (value !== undefined) {
+      
+      // always force to an array
+      value = Array.from(value) ;
+    
+      var allowsSelection         = this.get('allowsSelection');
+      var allowsEmptySelection    = this.get('allowsEmptySelection');
+      var allowsMultipleSelection = this.get('allowsMultipleSelection');
+    
+      // are we even allowing selection at all?
+      // if not, then bail out.
+      if ( !allowsSelection ) return this._selection;
+    
+      // ok, new decide if the *type* of seleciton is allowed...
+      switch ( value.get('length') )
+      {
+        case 0:
+          // check to see if we're attemting to set an empty array
+          // if that's not allowed, set to the first available item in 
+          // arrangedObjects
+          if (!allowsEmptySelection) {
+            var objects = this.get('arrangedObjects') ;
+            if (objects.get('length') > 0) value = [objects.objectAt(0)];
+          }
+          this._selection = value ;
+          break;
+        case 1:
+          this._selection = value;
+          break;
+        default:
+          // fall through for >= 2 items...
+          // only allow if configured for multi-select
+          this._selection = allowsMultipleSelection ? value : this._selection;
+          break;
+      }
+    }
+  
+    return this._selection;
+  }.property(),
+
+  /**
+    If true, selection is allowed.
+
+    @type bool
+  */
+  allowsSelection: true,
+
+  /**
+    If true, multiple selection is allowed.
+
+    @type bool
+  */
+  allowsMultipleSelection: true,
+
+  /**
+    If true, allow empty selection
+
+    @type bool
+  */
+  allowsEmptySelection: true
+};
+

data/frameworks/sproutcore/mixins/validatable.js

@@ -0,0 +1,152 @@
+// ========================================================================
+// SproutCore
+// copyright 2006-2008 Sprout Systems, Inc.
+// ========================================================================
+
+/**
+  @namespace
+
+  Views that include the Validatable mixin can be used with validators to 
+  ensure their values are valid.  
+  
+*/
+SC.Validatable = {
+  
+  initMixin: function() {
+    this._validatorObserver() ;
+  },
+  
+  /**
+    The validator for this field.  
+  
+    Set to a validator class or instance.  If this points to a class, it will 
+    be instantiated when the validator is first used.
+  */
+  validator: null,
+
+  /**
+    This property must return the human readable name you want used when 
+    describing an error condition.  For example, if set this property to
+    "Your Email", then the returned error string might be something like
+    "Your Email is not valid".
+    
+    You can return a loc string here if you like.  It will be localized when
+    it is placed into the error string.
+  */
+  errorLabel: null,
+
+  /**
+    YES if the receiver is currently valid.
+    
+    This property watches the value property by default.  You can override
+    this property if you want to use some other method to calculate the
+    current valid state.
+    
+    @field
+  */
+  isValid: function() { 
+    return $type(this.get('value')) != T_ERROR; 
+  }.property('value'),
+  
+  /**
+    The form that the view belongs to.  May be null if the view does not 
+    belong to a form.  This property is usually set automatically by an 
+    owner form view.
+  */
+  ownerForm: null,
+  
+  /**
+    Attempts to validate the receiver. 
+    
+    Runs the validator and returns SC.Validator.OK, SC.Validator.NO_CHANGE,
+    or an error object.  If no validator is installed, this method will
+    always return SC.Validator.OK.
+
+    @param {Boolean} partialChange YES if this is a partial edit.
+    @returns SC.Validator.OK, error, or SC.Validator.NO_CHANGE
+  */
+  performValidate: function(partialChange) {
+    var ret = SC.Validator.OK ;
+
+    if (this._validator) {
+      var form = this.get('ownerForm') ;
+      if (partialChange) {
+        ret = this._validator.validatePartial(form,this) ;
+
+        // if the partial returned NO_CHANGE, then check to see if the 
+        // field is valid anyway.  If it is not valid, then don't update the
+        // value.  This way the user can have partially constructed values 
+        // without the validator trying to convert it to an object.
+        if ((ret == SC.Validator.NO_CHANGE) && (this._validator.validateChange(form, this) == SC.Validator.OK)) {
+          ret = SC.Validator.OK; 
+        }
+      } else ret = this._validator.validateChange(form, this) ;
+    }
+    return ret ;
+  },
+
+  /**
+    Runs validateSubmit.  You should use this in your implementation of 
+    validateSubmit.  If no validator is installed, this always returns
+    SC.Validator.OK
+  */
+  performValidateSubmit: function() {
+    return (this._validator) ? this._validator.validateSubmit(this.get('ownerForm'), this) : SC.Validator.OK;
+  },
+  
+  /**
+    Invoked by the owner form just before submission.  Override with your 
+    own method to commit any final changes after you perform validation. 
+    
+    The default implementation simply calls performValidateSubmit() and 
+    returns that value.
+  */
+  validateSubmit: function() { return this.performValidateSubmit(); },
+  
+  /**
+    Convert the field value string into an object.
+    
+    This method will call the validators objectForFieldValue if it exists.
+    
+    @param fieldValue the raw value from the field.
+    @returns converted object
+  */
+  objectForFieldValue: function(fieldValue) {
+    return (this._validator) ? this._validator.objectForFieldValue(fieldValue, this.get('ownerForm'), this) : fieldValue ;
+  },
+  
+  /**
+    Convert the object into a field value.
+    
+    This method will call the validator's fieldValueForObject if it exists.
+    
+    @param object the objec to convert
+    @returns converted field value
+  */
+  fieldValueForObject: function(object) {
+    return (this._validator) ? this._validator.fieldValueForObject(object, this.get('ownerForm'), this) : object ;
+  },
+  
+  /**
+    Default observer for isValid property.
+    
+    The default implementation will add/remove a valid class name to the
+    root element of your view.
+  */
+  isValidObserver: function() {
+    var invalid = !this.get('isValid') ;
+    this.setClassName('invalid', invalid) ;
+  }.observes('isValid'),
+  
+  // invoked whenever the attached validator changes.
+  _validatorObserver: function() {
+    var form = this.get('ownerForm') ;
+    var val = SC.Validator.findFor(form, this, this.get('validator')) ;
+    if (val != this._validator) {
+      if (this._validator) this._validator.detachFrom(form, this) ;
+      this._validator = val;
+      if (this._validator) this._validator.attachTo(form, this) ;
+    }  
+  }.observes('validator', 'ownerForm')
+      
+};

data/frameworks/sproutcore/models/collection.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('models/record') ;
@@ -178,7 +178,7 @@ SC.Collection = SC.Object.extend({
   _flushChangedRecords: function() {
     if (!this._changedRecords) return ; // nothing to do.
 
-    if (this.dataSource != SC.Store) throw "non-local data source is not supported"
+    if (this.dataSource != SC.Store) throw "non-local data source is not supported" ;
 
     var current = this._store || [] ;
     var order = this.get('orderBy') || [this.recordType.primaryKey()] ;
@@ -321,8 +321,8 @@ SC.Collection = SC.Object.extend({
     }
     
     //if (refresh && !this._refreshing) {
-    //  this._refreshing = true ; var that = this ;
-    //  setTimeout(function() { that.refresh(); },1) ;
+    //  this._refreshing = true ;
+    //  this.invokeLater(this.refresh, 1) ;
     //}
   },
   
@@ -363,7 +363,7 @@ SC.Collection = SC.Object.extend({
       this._refreshing = true ;
       this._cacheCode = null ;
       this.set('isLoading',true) ; 
-      setTimeout(this.refresh.bind(this),1);
+      this.invokeLater(this.refresh) ;
     }
   },
   

data/frameworks/sproutcore/models/record.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('foundation/object') ;

data/frameworks/sproutcore/models/store.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('foundation/object') ;

data/frameworks/sproutcore/panes/dialog.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('panes/overlay') ;

data/frameworks/sproutcore/panes/manager.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('views/view') ;

data/frameworks/sproutcore/panes/menu.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('panes/overlay') ;

data/frameworks/sproutcore/panes/overlay.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('panes/pane') ;
@@ -190,7 +190,7 @@ SC.OverlayPaneView = SC.PaneView.extend({
         content.resizeWithOldParentSize(this.get('size')) ;
         
         // compute padding we need to add.
-        var padding = this.get('size').width - this.get('innerSize').width;
+        var padding = this.get('size').width - this.get('innerFrame').width;
         this.set('size', { width: (content.get('size').width + padding) });
         this.owner.positionPane() ;
         this.owner.setStyle({ visibility: 'visible' }) ;

data/frameworks/sproutcore/panes/panel.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('panes/overlay') ;

data/frameworks/sproutcore/panes/picker.js

@@ -1,6 +1,6 @@
 // ========================================================================
 // SproutCore
-// copyright 2006-2007 Sprout Systems, Inc.
+// copyright 2006-2008 Sprout Systems, Inc.
 // ========================================================================
 
 require('panes/overlay') ;

data/frameworks/sproutcore/tests/controllers/array.rhtml

@@ -10,7 +10,7 @@ Test.context("SC.ArrayController", {
     for (var i=0, n=items.length; i < n; i++)
     {
       this.c.set('content', items[i]);
-      this.c.get('content').isEqual([]).shouldEqual(true);
+      this.c.isEqual([]).shouldEqual(true);
       this.c.get('length').shouldEqual(0);
       (this.c.objectAt(0) == undefined).shouldEqual(true);
     }
@@ -29,12 +29,13 @@ Test.context("SC.ArrayController", {
   {
     // note that we're not directly requesting the public 'contentClone' property, because
     // doing so would cause the clone to be created.
-    (this.c._contentClone == undefined).shouldEqual(true);
+    (this.c.get('contentClone') == undefined).shouldEqual(true);
     this.c.set('content', this.multiple_a );
-    (this.c._contentClone == undefined).shouldEqual(true);
+    (this.c.get('contentClone') == undefined).shouldEqual(true);
     this.c.popObject();
-    (this.c._contentClone == undefined).shouldEqual(false);
+    (this.c.get('contentClone') == undefined).shouldEqual(false);
   },
+  
   "Should modify it's managed content when making changes": function()
   {
     this.c.set('content', this.multiple_a );
@@ -43,6 +44,24 @@ Test.context("SC.ArrayController", {
     this.c.get('content').get('length').shouldEqual(2);
     this.c.get('contentClone').get('length').shouldEqual(1);
   },
+  
+  "Should not modify managed content until commitChanges() if commitChangesImmediately is disabled": function() 
+  {
+    this.c.set('commitChangesImmediately', false) ;
+    
+    var content = this.multiple_a ;
+    this.c.set('content', content );
+    content.get('length').shouldEqual(2);
+
+    this.c.popObject();
+    content.get('length').shouldEqual(2) ;
+    this.c.get('length').shouldEqual(1) ;
+    
+    this.c.commitChanges() ;
+    content.get('length').shouldEqual(1) ;
+    this.c.get('length').shouldEqual(1) ;
+  },
+  
   "Should flag itself as dirty when adding an item to the array": function()
   {
     this.c.set('content', this.multiple_a );
@@ -51,6 +70,27 @@ Test.context("SC.ArrayController", {
     this.c.get('hasChanges').shouldEqual(true);
   },
   
+  "Should not delete object on removal only if destroyOnRemoval = true": function() {
+    var content = this.multiple_a ;
+
+    this.c.set('content', content) ;
+    this.c.set('destroyOnRemoval', true) ;
+
+    var didDestroy = false ;
+    content[0].destroy = function() { didDestroy = true; } ;
+    content[1].destroy = function() { didDestroy = true; } ;
+    
+    this.c.removeAt(1);
+    this.c.commitChanges() ; // force this to happen immediately.  It may be queued otherwise
+    didDestroy.shouldEqual(true) ;
+    
+    didDestroy = false ;
+    this.c.set('destroyOnRemoval', false) ;
+    this.c.removeAt(0) ;
+    this.c.commitChanges() ; 
+    didDestroy.shouldEqual(false) ;
+  },
+  
   setup: function()
   {
     this.c = SC.ArrayController.create();