stay 0.1.3.5 → 0.1.4.0

data/README.md

@@ -10,7 +10,7 @@ Installation **stay** is simple. In Rails > 3.0 just add **stay** in your Gemfil
   gem "tinymce-rails"
   gem "stay"
 ```
-    
+
 Then include the following Javascript include into your assets/javascript.js.
 
 ```ruby
@@ -18,7 +18,7 @@ Then include the following Javascript include into your assets/javascript.js.
   //= require tinymce-jquery
   //= require stay
 ```
- 
+
 Then add javascript calling in your Javascript file
 
 ```javascript
@@ -29,14 +29,38 @@ Then add javascript calling in your Javascript file
 
 or if you're using CoffeScript use
 
-```   
+```
   jQuery ->
       jQuery(".stay").stay()
 ```
-     
+
+### Javascript Callback
+**Stay** also accept callback arguments, currently **Stay** only have 3 callback attributes
+- beforeSend
+- onError
+- onSuccess
+
+Below is the examples how to implement **Stay** with callbacks, call this javascript when initalize **Stay**
+
+```javascript
+jQuery(".stay").stay({
+    beforeSend: function() {
+      // Do whatever you want before data is being sent to server, e.g. display the loading bar
+    },
+    onError: function(errs) {
+      // This method takes one argument contains array of errors similar with Obj.errors in Rails
+      return $.each(errs, function(key) {
+        return alert(key + " " + errs[key]);
+      });
+    },
+    onSuccess: function() {
+      // Do whatever you want when server said OK, e.g. hide the loading bar
+    }
+  });
+```
 ## Usage
 
-### call this in your view
+### In your View
 
 ```
   stay object, field, OPTIONS{}
@@ -49,7 +73,7 @@ Example:
 ```ruby
   stay @user, :name, type: :text_field
 ```
-    
+
 As default **type** will take :text_field, *for now* you can only pass :text_field, :text_area, :tiny_mce
 
 **Stay** support sub-resources routes, therefore you can pass array into **object** param
@@ -59,7 +83,7 @@ Example:
 ```ruby
   stay [@user, @article], :title, type: :text_area
 ```
-    
+
 You can use TinyMCE as text editor, just pass :tiny_mce to **type**
 
 Example:
@@ -67,19 +91,19 @@ Example:
 ```ruby
   stay [@user, @article], :body, type: :tiny_mce
 ```
-    
+
 This will use TinyMCE editor with "simple" theme, you can also change this theme by using
 
 ```ruby
   stay [@user, @article], :body, type: [:tiny_mce, "advanced"]
-```    
+```
 Now you can pass width and height of tinyMCE using CSS string format
 
 Example
 
 ```ruby
   stay [@user, @article], :body, type: [:tiny_mce, "advanced", "100%", "200px"]
-```    
+```
 
 Remember to put width and height respectively
 
@@ -93,7 +117,7 @@ Example:
 ```ruby
   stay [@user, @article], :body, type: [:tiny_mce, "advanced"], activator: "#id_of_activator"
 ```
-    
+
 To use external submit button, just passed **submitter:** followed by id of HTML element id.
 Note that this external submit button will be hidden by **Stay** and will be visible once **Stay** editor is visible (stay triggered).
 
@@ -108,7 +132,7 @@ Due to **Stay** default submit event is triggered by blur **Stay** will raise Ar
 ```ruby
   stay [@user, @article], :body, type: [:tiny_mce, "advanced"], activator: "#id_of_activator", submitter: "#id_of_submit_button", canceller: "#id_of_cancel_button"
 ```
-    
+
 Example of complete use:
 
 ```ruby
@@ -117,10 +141,10 @@ Example of complete use:
   <%= link_to "Click me to submit", "#", id: "submit_here" #this will be hide by Stay %>
 ```
 
-### call this in your controller
+### In your Controller
 
     stay_response object
-    
+
 Example of complete use:
 
 ```ruby
@@ -137,10 +161,19 @@ Example of complete use:
   end
 ```
 
-### JSON callback
-When Rails Model refuse to save object due to validation errors, **Stay** will carry this errors in its response text, you can evaluate the error by passing this response text as JSON and call the errors properties. You can do whatever you wish with the errors messages.
+## Changelog
+Just some good releases changelog:
 
-```javascript
-      cb_data = jQuery.parseJSON(data.responseText);
-      errs    = cb_data.errors; //this contains array of errors   
-```
+  **v0.1.4.0**
+  - Complete rewrite Javascript, made it modular
+  - Add ability to initialize Stay with callback
+
+  **v0.1.3.5**
+  - Add Canceller
+  - Hide Submitter and Canceller until Stay is activated
+
+  **v0.1.3.4.4**
+  - Add error callback to the JSON
+
+  **v0.1.0.0**
+  - Initial release, February 4th 2012

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('stay', '0.1.3.5') do |p|
+Echoe.new('stay', '0.1.4.0') do |p|
   p.description     = "Form ajax helper with tinymce support"
   p.summary         = "Helper for building ajax form, inspired by best_in_place, with some modifications, support tinymce as editor"
   p.url             = "http://github.com/tejanium/stay"

data/lib/assets/javascripts/stay.js

@@ -1,140 +1,175 @@
-jQuery.fn.stay = function(){
-  this.each(function(){
-    new Stay(this);
+var Stay, isset;
+jQuery.fn.stay = function(args) {
+  return this.each(function() {
+    return new Stay(this, args);
   });
-}
-
-jQuery.fn.disable = function(){
-  this.attr("disabled", "")
-}
-
-jQuery.fn.enable = function(){
-  this.removeAttr("disabled")
-}
-
-function Stay(e){
-  this.init(e);
-}
-
-Stay.prototype = {
-  init: function(e){
-    var self = this;
-    
-    self.stayWrapper    = jQuery(e);
-    self.stayObject     = self.stayWrapper.find(".stay-object");
-    self.stayForm       = self.stayWrapper.find(".stay-form");
-    self.stayFormForm   = self.stayForm.find("form");
-    self.stayTinyMCE    = self.stayForm.find(".stay-input.stay-tiny-mce")
-    self.tinyMCEUsed    = self.stayTinyMCE.length > 0;
-    self.stayFormInput  = self.stayFormForm.find(".stay-input");
-    
-    self.tinyMCETheme   = self.stayWrapper.data("tinymce-theme") || "simple"
-        
-    self.activator_id   = self.stayWrapper.data("activator")
-    self.activator      = (typeof self.activator_id === "undefined") ? self.stayObject : jQuery(self.activator_id)
-
-    self.submitter_id   = this.stayWrapper.data("submitter")
-    self.submitter      = (typeof self.submitter_id === "undefined") ? self.stayFormInput : jQuery(self.submitter_id)
-
-    self.canceller_id   = this.stayWrapper.data("canceller")
-
-    if(typeof self.submitter_id !== "undefined"){jQuery(self.submitter_id).hide()}
-    if(typeof self.canceller_id !== "undefined"){jQuery(self.canceller_id).hide()}
-
-    if(self.tinyMCEUsed){
-      this.stayTinyMCE.tinymce({
-        theme: self.tinyMCETheme,
-        setup : function(ed) {
-                ed.onInit.add(function(ed, evt) {
-                  var dom = ed.dom;
-                  var doc = tinymce.isGecko ? ed.getDoc() : ed.getWin();
-                  if(typeof self.submitter_id === "undefined"){
-                    tinymce.dom.Event.add(doc, 'blur', function(e) {
-                      self.stayFormForm.submit();
-                    });
-                  }else{
-                    self.submitter.click(function(){
-                      self.stayFormForm.submit();
-                    });
-                  }
-                 if(typeof self.canceller_id === "undefined"){
-                    tinymce.dom.Event.add(doc, 'keydown', function(e) {
-                        if (e.keyCode == 27) {
-                            self.reShowObject();
-                        }
-                    });      
-                  }else{
-                    jQuery(self.canceller_id).click(function(){
-                      self.reShowObject();
-                    });
-                  }
-                });
-              }
-      });
+};
+jQuery.fn.disable = function() {
+  return this.attr("disabled", "disabled");
+};
+jQuery.fn.enable = function() {
+  return this.removeAttr("disabled");
+};
+isset = function(o) {
+  return typeof o !== "undefined";
+};
+Stay = (function() {
+  function Stay(e, args) {
+    var activator, canceller, submitter;
+    this.hooks = args || {};
+    this.stayWrapper = jQuery(e);
+    this.stayObjectContainer = this.stayWrapper.find(".stay-object");
+    this.stayFormContainer = this.stayWrapper.find(".stay-form");
+    this.stayActualForm = this.stayFormContainer.find("form");
+    this.stayFormInput = this.stayActualForm.find(".stay-input");
+    this.usingTinyMCE = this.stayFormInput.hasClass("stay-tiny-mce");
+    activator = this.stayWrapper.data("activator");
+    this.usingActivator = isset(activator);
+    this.activator = (this.usingActivator ? jQuery(activator) : this.stayObjectContainer);
+    submitter = this.stayWrapper.data("submitter");
+    if (this.usingSubmitter = isset(submitter)) {
+      this.submitter = jQuery(submitter);
+      this.submitter.hide();
+    } else {
+      this.submitter = this.stayFormInput;
+    }
+    canceller = this.stayWrapper.data("canceller");
+    if (this.usingCanceller = isset(canceller)) {
+      this.canceller = jQuery(canceller);
+      this.canceller.hide();
+    }
+    this.bindActivator();
+    if (this.usingTinyMCE) {
+      this.initTinyMCE();
+    } else {
+      this.initDefault();
     }
-    self.bindTrigger();
-    self.bindCallback();
-
-  },
-  
-  bindTrigger: function(){
-    var self = this;
-    
-    self.activator.click(function(){
-      self.stayObject.hide();
-      self.stayForm.show();
-      if(typeof self.submitter_id !== "undefined"){jQuery(self.submitter_id).show()}
-      if(typeof self.canceller_id !== "undefined"){jQuery(self.canceller_id).show()}
-      if(self.tinyMCEUsed){
-        self.stayTinyMCE.tinymce().focus();
-      }else{
-        self.stayFormInput.focus();
+    this.bindCallback();
+  }
+  Stay.prototype.initTinyMCE = function() {
+    var stay;
+    stay = this;
+    return stay.stayFormInput.tinymce({
+      theme: stay.stayWrapper.data("tinymce-theme") || "simple",
+      setup: function(ed) {
+        return ed.onInit.add(function(ed, ev) {
+          var doc;
+          doc = (tinymce.isGecko ? ed.getDoc() : ed.getWin());
+          stay.bindSubmitter(doc);
+          return stay.bindCanceller(doc);
+        });
+      }
+    });
+  };
+  Stay.prototype.initDefault = function() {
+    this.bindSubmitter();
+    return this.bindCanceller();
+  };
+  Stay.prototype.bindActivator = function() {
+    var stay;
+    stay = this;
+    return stay.activator.click(function() {
+      stay.hideObject();
+      if (stay.usingTinyMCE) {
+        return stay.stayFormInput.tinymce().focus();
+      } else {
+        return stay.stayFormInput.focus();
       }
     });
-    
-    if(!self.tinyMCEUsed){
-      var ev = (typeof self.submitter_id === "undefined") ? "blur" : "click"
-      self.submitter.bind(ev, function(){
-        self.stayFormForm.submit();
-        self.stayFormInput.disable();
+  };
+  Stay.prototype.bindSubmitter = function(doc) {
+    var stay;
+    stay = this;
+    if (stay.usingSubmitter) {
+      return stay.submitter.click(function() {
+        return stay.submitEvent();
       });
-      
-      if(typeof self.canceller_id === "undefined"){
-        self.stayFormInput.keydown(function(e) {
-            if (e.keyCode == 27) {
-                self.reShowObject();
-            }
-        });      
-      }else{
-        jQuery(self.canceller_id).click(function(){
-          self.reShowObject();
+    } else {
+      if (isset(doc)) {
+        return tinymce.dom.Event.add(doc, "blur", function(e) {
+          return stay.submitEvent();
+        });
+      } else {
+        return stay.submitter.blur(function() {
+          return stay.submitEvent();
         });
       }
     }
-  },
-  
-  bindCallback: function(){
-    var self = this;
-    
-    self.stayFormForm.live("ajax:success", function(event, data, status, xhr){
-      self.stayFormInput.val(data.input);
-      self.stayObject.html(data.display);
-      self.reShowObject();
+  };
+  Stay.prototype.bindCanceller = function(doc) {
+    var stay;
+    stay = this;
+    if (stay.usingCanceller) {
+      return stay.canceller.click(function() {
+        return stay.showObject();
+      });
+    } else {
+      if (isset(doc)) {
+        return tinymce.dom.Event.add(doc, "keydown", function(e) {
+          return stay.cancelEvent(e);
+        });
+      } else {
+        return stay.stayFormInput.keydown(function(e) {
+          return stay.cancelEvent(e);
+        });
+      }
+    }
+  };
+  Stay.prototype.bindCallback = function() {
+    var stay;
+    stay = this;
+    stay.stayActualForm.bind("ajax:success", function(e, data) {
+      stay.processCallback(data);
+      if (isset(stay.hooks.onSuccess)) {
+        return stay.hooks.onSuccess();
+      }
     });
-
-    self.stayFormForm.live("ajax:error", function(event, data, status, xhr){
-      var cb = jQuery.parseJSON(data.responseText);
-      self.stayFormInput.val(cb.input || "");
-      self.stayObject.html(cb.display || "");
-      self.reShowObject();
+    return stay.stayActualForm.bind("ajax:error", function(e, data) {
+      var cb;
+      cb = jQuery.parseJSON(data.responseText);
+      stay.processCallback(cb);
+      if (isset(stay.hooks.onError)) {
+        return stay.hooks.onError(cb.errors);
+      }
     });
-  },
-  
-  reShowObject: function(){
-    this.stayForm.hide();
-    if(typeof this.submitter_id !== "undefined"){jQuery(this.submitter_id).hide()}
-    if(typeof this.canceller_id !== "undefined"){jQuery(this.canceller_id).hide()}
-    this.stayObject.show();
-    this.stayFormInput.enable();
-  }
-};
+  };
+  Stay.prototype.processCallback = function(cb) {
+    this.stayFormInput.val(cb.input || "");
+    this.stayObjectContainer.html(cb.display || "");
+    return this.showObject();
+  };
+  Stay.prototype.hideObject = function() {
+    this.stayFormContainer.show();
+    if (this.usingSubmitter) {
+      this.submitter.show();
+    }
+    if (this.usingCanceller) {
+      this.canceller.show();
+    }
+    return this.stayObjectContainer.hide();
+  };
+  Stay.prototype.showObject = function() {
+    this.stayFormContainer.hide();
+    if (this.usingSubmitter) {
+      this.submitter.hide();
+    }
+    if (this.usingCanceller) {
+      this.canceller.hide();
+    }
+    this.stayObjectContainer.show();
+    return this.stayFormInput.enable();
+  };
+  Stay.prototype.cancelEvent = function(e) {
+    if (e.keyCode === 27) {
+      return this.showObject();
+    }
+  };
+  Stay.prototype.submitEvent = function(e) {
+    if (isset(this.hooks.beforeSend)) {
+      this.hooks.beforeSend();
+    }
+    this.stayActualForm.submit();
+    return this.stayFormInput.disable();
+  };
+  return Stay;
+})();

data/stay.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "stay"
-  s.version = "0.1.3.5"
+  s.version = "0.1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Teja Sophista"]
-  s.date = "2012-03-09"
+  s.date = "2012-03-10"
   s.description = "Form ajax helper with tinymce support"
   s.email = "tejanium@yahoo.com"
   s.extra_rdoc_files = ["README.md", "README.rdoc", "lib/assets/javascripts/stay.js", "lib/stay.rb", "lib/stay/controller_extensions.rb", "lib/stay/engine.rb", "lib/stay/helper.rb", "lib/stay/string_extensions.rb"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stay
 version: !ruby/object:Gem::Version
-  version: 0.1.3.5
+  version: 0.1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-09 00:00:00.000000000Z
+date: 2012-03-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &28148600 !ruby/object:Gem::Requirement
+  requirement: &16640280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *28148600
+  version_requirements: *16640280
 - !ruby/object:Gem::Dependency
   name: tinymce-rails
-  requirement: &28148140 !ruby/object:Gem::Requirement
+  requirement: &16639820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *28148140
+  version_requirements: *16639820
 description: Form ajax helper with tinymce support
 email: tejanium@yahoo.com
 executables: []