stay 0.1.3.4.4 → 0.1.3.5

data/README.md

@@ -83,10 +83,10 @@ Example
 
 Remember to put width and height respectively
 
-When called, by default **Stay** triggered by clicking the displayed text on HTML page.
-**Stay** accept external trigger and submit button:
+When called, by default **Stay** triggered by clicking the displayed text on HTML page, submitted by blur, and cancelled by pressing ESC key on your keyboard.
+**Stay** accept external trigger, submit, and cancel button:
 
-To use, just passed **activator:** followed by id of HTML element id
+To use external activator, just passed **activator:** followed by id of HTML element id
 
 Example:
 
@@ -94,20 +94,29 @@ Example:
   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
+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).
 
 ```ruby
   stay [@user, @article], :body, type: [:tiny_mce, "advanced"], activator: "#id_of_activator", submitter: "#id_of_submit_button"
 ```
+
+To use external cancel button, just passed **canceller:** followed by id of HTML element id
+Note that this external cancel button will be hidden by **Stay** and will be visible once **Stay** editor is visible (stay triggered).
+Due to **Stay** default submit event is triggered by blur **Stay** will raise ArgumentError if you specified external canceller without external submitter.
+
+```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
   <%= link_to "Click me to activate", "#", id: "activate_here" %>
   <%= stay [@user, @article], :body, type: :tiny_mce, activator: "#activate_here", submitter: "#submit_here" %>
-  <%= link_to "Click me to submit", "#", id: "submit_here" %>
+  <%= link_to "Click me to submit", "#", id: "submit_here" #this will be hide by Stay %>
 ```
-    
+
 ### call this in your controller
 
     stay_response object
@@ -127,3 +136,11 @@ Example of complete use:
       end
   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.
+
+```javascript
+      cb_data = jQuery.parseJSON(data.responseText);
+      errs    = cb_data.errors; //this contains array of errors   
+```

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('stay', '0.1.3.4.4') do |p|
+Echoe.new('stay', '0.1.3.5') 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

@@ -36,6 +36,11 @@ Stay.prototype = {
     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,
@@ -52,6 +57,17 @@ Stay.prototype = {
                       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();
+                    });
+                  }
                 });
               }
       });
@@ -63,10 +79,12 @@ Stay.prototype = {
   
   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{
@@ -80,6 +98,18 @@ Stay.prototype = {
         self.stayFormForm.submit();
         self.stayFormInput.disable();
       });
+      
+      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();
+        });
+      }
     }
   },
   
@@ -102,6 +132,8 @@ Stay.prototype = {
   
   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();
   }

data/lib/stay/controller_extensions.rb

@@ -14,7 +14,7 @@ module Stay
       def response_error(obj)
         field = params[obj.class.to_s.underscore].keys.first
         value = obj.send("#{field}_was".to_sym)
-        render json: { :display => (value.nil? ? "-" : value.to_html), :input => value, :error => obj.errors }, status: :unprocessable_entity
+        render json: { :display => (value.nil? ? "-" : value.to_html), :input => value, :errors => obj.errors }, status: :unprocessable_entity
       end
   end
 end

data/lib/stay/helper.rb

@@ -22,10 +22,13 @@ module Stay
   ActionView::Helpers::FormHelper.send(:include, FormHelper)
   
   module StayHelpers
-    def stay(record, field, opts = {})
+    def stay(record, field, opts = {})      
+      raise ArgumentError, "Can't have Canceller without Submitter" if opts[:canceller] && opts[:submitter].nil?
+      opts[:type] ||= :text_field
       html = "<span class='stay' "
       html << "data-activator='#{ opts[:activator] }' " if opts[:activator]
       html << "data-submitter='#{ opts[:submitter] }' " if opts[:submitter]
+      html << "data-canceller='#{ opts[:canceller] }' " if opts[:canceller]
       html << "data-tinymce-theme='simple' " if opts[:type] == :tiny_mce
       html << "data-tinymce-theme='#{ opts[:type][1] }' " if opts[:type].is_a?(Array)
       html << ">"

data/stay.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "stay"
-  s.version = "0.1.3.4.4"
+  s.version = "0.1.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Teja Sophista"]
-  s.date = "2012-02-28"
+  s.date = "2012-03-09"
   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.4.4
+  version: 0.1.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-28 00:00:00.000000000Z
+date: 2012-03-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &22993880 !ruby/object:Gem::Requirement
+  requirement: &28148600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22993880
+  version_requirements: *28148600
 - !ruby/object:Gem::Dependency
   name: tinymce-rails
-  requirement: &22993420 !ruby/object:Gem::Requirement
+  requirement: &28148140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22993420
+  version_requirements: *28148140
 description: Form ajax helper with tinymce support
 email: tejanium@yahoo.com
 executables: []