simple_update_field 2.2.0 → 2.3.0

data/README.creole

@@ -8,6 +8,30 @@ simple_update_field is implemented internally with jquery
 == Design Goals
 
 Simple_update_field is designed to extend the browsers behaviour in a un-surprising manner.
+== Callback Guide
+
+ You may wish to be able to change the rules around when to, or when not to do an update.
+
+ A callback named 'before_update' is provided - you can install it when you invoke SimpleUpdateField.
+
+ For example you may wish to have a confirmation dialog:
+
+{{{
+
+var my_confirm_handler = function() {
+  var input = this
+  return confirm("Update the database with " + input.value +" ?")
+}
+
+$(document).ready(function() {
+  SimpleUpdateField('.phrase .text'
+                    ,{ 
+                       before_update:my_confirm_handler
+                    })
+
+})
+
+}}}
 
 == Styling Guide
 
@@ -145,7 +169,7 @@ $(document).ready(function() {
 * error handling of ajax call
 
 == Recent Changes
-
+* before_update callback - return true to continue , false to stop
 * Only commit changed fields to the remote-resource-uri
 * Trim leading and trailng whitespace of entered data or original text data
 * Have it work for any element without modifying structure (ie needs no wrapper)
@@ -168,6 +192,7 @@ Curtis Schofield
 
 Contributors 
 Judy Tuna
+Hollin Wilkins
 
 Copyright (c) 2012 Blazing Cloud. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-2.2.0
+2.3.0

data/simple_update_field.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "simple_update_field"
-  s.version = "2.2.0"
+  s.version = "2.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Curtis Schofield"]
-  s.date = "2012-05-04"
+  s.date = "2012-05-09"
   s.description = "Your resources text attributes will gain inplace update ability with keybindings for quick editing"
   s.email = "curtis@ram9.cc"
   s.extra_rdoc_files = [

data/vendor/assets/javascripts/simple_update_field.js

@@ -1,5 +1,5 @@
 //1
-SimpleUpdateField = function(selector) {
+SimpleUpdateField = function(selector, options) {
   var self = this
   /*
    * This is used internally to track what key has been
@@ -52,7 +52,7 @@ SimpleUpdateField = function(selector) {
     }
     return false
   }
-  var is_blur_tab_redirect = function () {
+  var is_tab_redirect = function () {
     if (self.last_keydown_event) {
       if (self.last_keydown_event.keyCode == SimpleUpdateField.TAB_KEY) {
         return true
@@ -87,45 +87,62 @@ SimpleUpdateField = function(selector) {
     $.ajax({url:uri,data:data,type:'PUT'})
   }
 
-  var commit_if_changed = function(input_node) {
+  self.commit_if_changed = function(input_node) {
     if(input_node.data('original-text') != input_node.val().trim())  {
       commit_to_remote_resource(input_node)
     }
   }
 
-  var editable_restoration = function(element,text_value) {
-    element.text(text_value)
-    install_edit_notions(element)
+  var commit_if_callback_true = function(original_element,finished_input_node) {
+    var continue_commit = true
+    if (options && options.before_update)
+      continue_commit = options.before_update.apply(finished_input_node.get(0))
+    if (continue_commit) {
+      commit_if_changed(finished_input_node)
+    }
+    return continue_commit
   }
 
-  var rollback_edit_event = function(event) {
-    var finished_input_node = $(this)
-    var parent = finished_input_node.parent();
-
-    editable_restoration(parent,finished_input_node.data('original-text')) // the input we create had a memo about it's original text
+  var editable_restoration = function(original_element,text_value) {
+    original_element.text(text_value)
+    install_edit_notions(original_element)
   }
 
-  var complete_edit_event = function(event) {
-
-    var finished_input_node = $(this)
-    var parent = finished_input_node.parent();
-
-    commit_if_changed(finished_input_node)
-
-    editable_restoration(parent,finished_input_node.val())
+  var rollback_edit_event = function(event) {
+    var parent = $(this).parent();
+    rollback_edit(parent, $(this))
+  }
 
+  var rollback_edit = function(original_element, finished_input_node) {
+    editable_restoration(original_element, finished_input_node.data('original-text'))
+  }
+  
+  var complete_edit = function(original_element,finished_input_node) {
+    if(commit_if_callback_true(original_element,finished_input_node) ) {
+      editable_restoration(original_element,finished_input_node.val())
+    }
+    else {
+      editable_restoration(original_element, finished_input_node.data('original-text'))
+    }
     // If tab key was hit during the edit phase
-    // we want to redirect this blur to be a
+    // we want to redirect this  to be a
     // click on the next sibling
-    if(is_blur_tab_redirect()) {
-      move_to_next_sibling(parent)
+    if(is_tab_redirect()) {
+      move_to_next_sibling(original_element)
     }
-
     // Cleanup - cross event state
     // there was no last keydown event
     self.last_keydown_event = undefined;
   }
 
+  var complete_edit_event = function(event) {
+
+    var finished_input_node = $(this)
+    var original_element = finished_input_node.parent();
+
+    complete_edit(original_element,finished_input_node)
+  }
+
   var install_edit_notions = function(selector) {
 
     $(selector).bind('click.editable',begin_edit_event)
@@ -148,8 +165,8 @@ SimpleUpdateField = function(selector) {
 
     $(selector).bind('keydown.editable',function(e) {
       self.last_keydown_event = e
-      if(is_blur_tab_redirect()) {
-        $(this).trigger('blur.editable')
+      if(is_tab_redirect()) {
+        $(this).trigger('complete.editable')
         return false; // manually handle tab - no event propigation
       }
       if(is_rollback_changes()) {
@@ -159,7 +176,7 @@ SimpleUpdateField = function(selector) {
       return true // allow default propigation
     })
 
-    $(selector).bind('blur.editable',complete_edit_event)
+    $(selector).bind('complete.editable',complete_edit_event)
     $(selector).bind('rollback.editable',rollback_edit_event)
   }
   var annotate_editable_with_position = function(selector) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_update_field
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-04 00:00:00.000000000Z
+date: 2012-05-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70198250446640 !ruby/object:Gem::Requirement
+  requirement: &70104163814740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70198250446640
+  version_requirements: *70104163814740
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70198250445360 !ruby/object:Gem::Requirement
+  requirement: &70104163813460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70198250445360
+  version_requirements: *70104163813460
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70198250443680 !ruby/object:Gem::Requirement
+  requirement: &70104163812080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70198250443680
+  version_requirements: *70104163812080
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70198250442160 !ruby/object:Gem::Requirement
+  requirement: &70104163810880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70198250442160
+  version_requirements: *70104163810880
 description: Your resources text attributes will gain inplace update ability with
   keybindings for quick editing
 email: curtis@ram9.cc
@@ -92,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1261042367084871670
+      hash: 4112278823148699834
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: