stay 0.1.2 → 0.1.3

data/README.md

@@ -0,0 +1,119 @@
+# Stay
+**Stay** is a RESTful ajax inplace-editor helper based on jQuery and Unobustorsive javascript.
+Similar and inspired by [best_in_place](https://github.com/bernat/best_in_place), with extra
+enchancement. Support [TinyMCE](http://tinymce.moxiecode.com/) as its editor.
+
+## Installation
+Installation **stay** is simple. In Rails > 3.0 just add **stay** in your Gemfile:
+
+```ruby
+  gem "stay"
+```
+    
+Then include the following Javascript include into your assets/javascript.js.
+
+```ruby
+  //= require jquery
+  //= require tinymce-jquery
+  //= require stay
+```
+ 
+Then add javascript calling in your Javascript file
+
+```javascript
+  $(document).ready(function(){
+      jQuery(".stay").stay();
+  });
+```
+
+or if you're using CoffeScript use
+
+```   
+  jQuery ->
+      jQuery(".stay").stay()
+```
+     
+## Usage
+
+### call this in your view
+
+```
+  stay object, field, OPTIONS{}
+```
+
+Call this helper in your view to build **Stay**
+
+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
+
+Example:
+
+```ruby
+  stay [@user, @article], :title, type: :text_area
+```
+    
+You can use TinyMCE as text editor, just pass :tiny_mce to **type**
+
+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"]
+```    
+
+When called, by default **Stay** triggered by clicking the displayed text on HTML page.
+**Stay** accept external trigger and submit button:
+
+To use, just passed **activator:** followed by id of HTML element id
+
+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
+
+```ruby
+  stay [@user, @article], :body, type: [:tiny_mce, "advanced"], activator: "#id_of_activator", submitter: "#id_of_submit_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" %>
+```
+    
+### call this in your controller
+
+    stay_response object
+    
+Example of complete use:
+
+```ruby
+  def update
+      user = User.find(params[:user_id])
+      article = user.articles.find(params[:id])
+      respond_to do |format|
+          if article.update_attributes(params[:article])
+              format.json { stay_response(article) }
+          else
+              format.json { stay_response(article) }
+          end
+      end
+  end
+```

data/Rakefile

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

@@ -64,7 +64,6 @@ Stay.prototype = {
     console.info("Stay successfully initialized");
   },
   
-  
   bindTrigger: function(){
     var self = this;
 
@@ -78,17 +77,19 @@ Stay.prototype = {
         self.stayTinyMCE.tinymce().focus();
       }else{
         self.stayFormInput.focus();
-
-        var ev = (typeof self.submitter_id === "undefined") ? "blur" : "click";
-        console.log("Submitter event: " + ev + ", on:");
-        console.log(self.submitter);
-        
-        self.submitter.bind(ev, function(){
-          self.stayFormForm.submit();
-          self.stayFormInput.disable();
-        });
       }
     });
+    
+    if(!self.tinyMCEUsed){
+      var ev = (typeof self.submitter_id === "undefined") ? "blur" : "click";
+      console.log("Submitter event: " + ev + ", on:");
+      console.log(self.submitter);
+      
+      self.submitter.bind(ev, function(){
+        self.stayFormForm.submit();
+        self.stayFormInput.disable();
+      });
+    }
   },
   
   bindCallback: function(){

data/lib/stay/helper.rb

@@ -18,7 +18,7 @@ module Stay
       html = "<span class='stay' "
       html << "data-activator='#{ opts[:activator] }' " if opts[:activator]
       html << "data-submitter='#{ opts[:submitter] }' " if opts[:submitter]
-      html << "data-tinymce-theme='#{ opts[:type] }' " if opts[:type] == :tiny_mce
+      html << "data-tinymce-theme='simple' " if opts[:type] == :tiny_mce
       html << "data-tinymce-theme='#{ opts[:type][1] }' " if opts[:type].is_a?(Array)
       html << ">"
         html << "<span class='stay-object'>"

data/stay.gemspec

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