rest_in_place 2.0.2 → 2.1

data/README.markdown

@@ -148,6 +148,33 @@ restInPlace() on the jQuery object.
 
     $('.my-custom-class').restInPlace()
 
+Events
+------
+
+A REST in Place instance triggers four different events on the element that
+it's associated with:
+
+- `activate.rest-in-place` when starting the editing of the element.  
+  Triggering the event is the first thing that happens, before any processing
+  and form building takes place. That means uou can use this event to modify
+  the content of the element (for example to remove number/date formatting).
+- `success.rest-in-place` with the data retrieved from the server as an
+  extra parameter after a successful save on the server.  
+  This event is triggered at the very latest moment, after the element has
+  been restored with the data from the server. This means you can use the
+  event handler to further modify the data and overwrite the displayed value
+  (useful for number/date formatting for example).
+- `failure.rest-in-place` after an error occured
+- `update.rest-in-place` immediately before sending the update to the server
+- `abort.rest-in-place` when the user aborts the editing process.
+
+Bind to these events through the jQuery event mechanisms:
+
+    $('#my-editable-element').bind('success.rest-in-place', function(event, data){
+      console.log("Yay it worked! The new value is", data.whatever);
+    });
+    
+
 Example
 =======
 

data/lib/assets/javascripts/rest_in_place/rest_in_place.coffee.erb

@@ -15,6 +15,7 @@ class RestInPlaceEditor
   
   # Toggle the element associated with this editor from normal to a form field  
   activate : ->
+    @$element.trigger('activate.rest-in-place')
     @oldValue = @$element.html()
     @$element.addClass('rip-active')
     @$element.unbind('click', @clickHandler)
@@ -22,6 +23,7 @@ class RestInPlaceEditor
   
   # Restore the element to its default state
   abort : ->
+    @$element.trigger('abort.rest-in-place')
     @$element
       .html(@oldValue)
       .removeClass('rip-active')
@@ -32,12 +34,13 @@ class RestInPlaceEditor
   # parseable answer, a second request is initiated to retrieve the updated
   # value via GET
   update : ->
+    @$element.trigger('update.rest-in-place')
     updateRequest = @ajax
       type : "post"
       data : @requestData()
       
     updateRequest.done (data) =>
-      if data 
+      if data
         @loadSuccessCallback(data)
       else
         @loadViaGET()
@@ -46,6 +49,7 @@ class RestInPlaceEditor
       if (jqXHR.status == 200 && textStatus == "parsererror")
         @loadViaGET()
       else
+        @$element.trigger('failure.rest-in-place')
         @abort()
         
     @$element.html("saving...")
@@ -53,6 +57,7 @@ class RestInPlaceEditor
   loadViaGET : ->
     showRequest = @ajax()
     showRequest.done (data) => @loadSuccessCallback(data)
+    showRequest.fail => @$element.trigger('failure.rest-in-place')
   
   # ## Implementation Methods
   #
@@ -148,6 +153,8 @@ class RestInPlaceEditor
     @$element.html(@extractAttributeFromData(data))
     @$element.click(@clickHandler)
     @$element.removeClass('rip-active')
+    @$element.trigger('success.rest-in-place', data)
+    
   
   # Creates a clickhandler for the current instance of RestInPlaceEditor, that
   # has its this pointer permanently bound to the editor instance.
@@ -217,4 +224,4 @@ $.fn.restInPlace = ->
 
 
 # Run automatically
-$ -> $('.rest-in-place').restInPlace()
+$ -> $('.rest-in-place').restInPlace()

data/lib/rest_in_place/version.rb

@@ -1,3 +1,3 @@
 module RestInPlace
-  VERSION = "2.0.2"
+  VERSION = "2.1"
 end

data/rest_in_place.gemspec

@@ -5,7 +5,7 @@ require "rest_in_place/version"
 Gem::Specification.new do |s|
   s.name        = "rest_in_place"
   s.version     = RestInPlace::VERSION
-  s.date        = '2012-06-07'
+  s.date        = '2012-07-24'
   s.authors     = ["Jan Varwig"]
   s.email       = ["jan@varwig.org"]
   s.homepage    = "http://jan.varwig.org"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest_in_place
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: '2.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-07 00:00:00.000000000 Z
+date: 2012-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70360483506640 !ruby/object:Gem::Requirement
+  requirement: &70251098586200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70360483506640
+  version_requirements: *70251098586200
 description: REST in Place is an AJAX Inplace-Editor that talks to RESTful controllers.
 email:
 - jan@varwig.org
@@ -62,3 +62,4 @@ signing_key:
 specification_version: 3
 summary: An AJAX Inplace-Editor for the Rails 3.1 asset pipeline.
 test_files: []
+has_rdoc: