simple_update_field 2.0.0 → 2.1.0

data/README.creole

@@ -5,6 +5,38 @@ to move between each simple_update_field.
 
 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.
+
+== Styling Guide
+
+Use CSS as you normaly would along with the following classes
+
+
+{{{
+.editable-input {
+/* 
+   this is the input that will be created 
+   on click use this class to change it's style
+*/
+}
+}}}
+{{{
+.editable-hover  {
+/* 
+  this is the field that has a mouse-over 
+  use this to tell the user the field is clickable 
+*/
+}
+
+}}}
+
+It is recommended to put a min-width on the element which contains your editable
+text. For example - if you use a span - if you remove all the text the element
+will collapse. Simple Update Field will not take responsiblity for lack of styling
+such an element as you have the power to adjust this via CSS! 
+
 == Installation Guide for Rails 3+
 
 If you are using a version of rails before JQuery became the default - please integrate the gem 'jquery-rails'
@@ -26,7 +58,9 @@ based resource calls.
 <div class='phrase'>
       <span editable-resource-attribute="text"
             editable-resource-model="<%=phrase.class.model_name.downcase%>"
-            editable-resource-uri="<%=url_for(phrase)%>"
+            editable-resource-uri="<%=phrase_path(phrase,
+                                                   :authenticity_token => 
+                                                    form_authenticity_token)%>"
             class="text">
         <%= phrase.text %>
       </span>
@@ -41,12 +75,16 @@ based resource calls.
 *** this will be sent to the server as part of the post-variable ie:  model_name_here[attribute_name_here]=VALUE
 ## editable-resource-uri
 *** this is the destination to send the post-variable that is described by the above.
+**** you will need to encode CRSF into this path if you are using typical rails protect_from_forgery
 ==== Example of all 3 attributes
 * With resources 'Animals' (Model : Animal & Controller : AnimalsController) with the attribute 'name' and an instance of Animal 'animal'
 {{{
       <span editable-resource-attribute="name"
             editable-resource-model="animal"
-            editable-resource-uri="<%=url_for(animal)%>"
+            editable-resource-uri="<%= animal_path(animal,
+                                                   :authenticity_token => 
+                                                    form_authenticity_token)
+                                    %>"
             class="animal-name">
         <%= animal.name %>
       </span>
@@ -103,12 +141,15 @@ $(document).ready(function() {
 
 
 == Roadmap
-* Have it work for any element without modifying structure (ie needs no wrapper)
 * form field helper
 * error handling of ajax call
 
 == Recent Changes
 
+* 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)
+* Reworked internal Design so that it can work without altering the layout done via css
 * Left out test harness https://github.com/blazingcloud/simple_update_field-jasmine-harness
 
 === Contributing to simple_update_field
@@ -122,7 +163,11 @@ $(document).ready(function() {
 # Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 === Copyright
-Authored by Curtis Schofield
+Authored by
+Curtis Schofield
+
+Contributors 
+Judy Tuna
 
 Copyright (c) 2012 Blazing Cloud. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/simple_update_field.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "simple_update_field"
-  s.version = "2.0.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Curtis Schofield"]
-  s.date = "2012-04-27"
+  s.date = "2012-05-01"
   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,11 @@
 SimpleUpdateField = function(selector) {
   var self = this
+  /*
+   * This is used internally to track what key has been
+   * pressed last in complete event form.
+   *
+   */
+  self.last_keydown_event = undefined;
   self.selector = selector
   self.current_input = function () {
     var last_clicked = $(self.selector + ' > input')
@@ -21,13 +27,14 @@ SimpleUpdateField = function(selector) {
         input_node.attr(attributes[i].nodeName, attributes[i].nodeValue)
       }
     }
-    input_node.data('original-text',node.text())
-    input_node.val(node.text().trim())
+    input_node.data('original-text',node.text().trim())
 
+    input_node.val(node.text().trim())
+    input_node.addClass('editable-input')
     return input_node
   }
 
-  self.begin_edit_event = function(event) {
+  var begin_edit_event = function(event) {
       var clicked_node = $(this);
       var input_node = create_input_from(clicked_node);
       clicked_node.text("")
@@ -63,42 +70,51 @@ SimpleUpdateField = function(selector) {
       }
       next_editable.trigger('click.editable')
     }else {
-      throw 'Expected to be able to assign custom attribute editable-index'
+      throw 'Expected to find custom attribute editable-index'
     }
   }
-  self.rollback_edit_event = function(event) {
+  var rollback_edit_event = function(event) {
     var finished_input_node = $(this)
 
     finished_input_node.parent().text(finished_input_node.data('original-text')) // the input we create had a memo about it's original text
     finished_input_node.remove() // remove the input field that we created such that the node is unchanged
 
   }
-  self.commit_to_remote_resource = function(node) {
-    uri        = node.attr('editable-resource-uri')
-    name       = node.attr('editable-resource-model')
-    attribute  = node.attr('editable-resource-attribute')
-    id         = node.attr('editable-resource-id')
+  var commit_to_remote_resource = function(input_node) {
+    uri        = input_node.attr('editable-resource-uri')
+    name       = input_node.attr('editable-resource-model')
+    attribute  = input_node.attr('editable-resource-attribute')
+    id         = input_node.attr('editable-resource-id')
     data       = {}
     data['id'] = id
     data[name] = {}
-    data[name][attribute] = node.val().trim()
+    data[name][attribute] = input_node.val().trim()
     $.ajax({url:uri,data:data,type:'PUT'})
   }
 
-  self.complete_edit_event = function(event) {
+  var commit_if_changed = function(input_node) {
+    if(input_node.data('original-text') != input_node.val().trim())  {
+      commit_to_remote_resource(input_node)
+    }
+  }
+
+  var complete_edit_event = function(event) {
 
     var finished_input_node = $(this)
     var parent = finished_input_node.parent();
 
-    commit_to_remote_resource(finished_input_node)
-    parent.text(finished_input_node.val()) // set the elements character data back to text
+    commit_if_changed(finished_input_node)
 
-    finished_input_node.remove() // remove the input field that we created such that the node is unchanged
+    // set the elements character data back to text
+    parent.text(finished_input_node.val())
 
+    // remove the input field that we created
+    // such that the node is unchanged
+    finished_input_node.remove()
 
     // If tab key was hit during the edit phase
-    // we want to redirect this blur to be a click on the next
-    // sibling
+    // we want to redirect this blur to be a
+    // click on the next sibling
     if(is_blur_tab_redirect()) {
       move_to_next_sibling(parent)
     }
@@ -135,8 +151,8 @@ SimpleUpdateField = function(selector) {
       return true // allow default propigation
     })
 
-    $(selector).bind('blur.editable',self.complete_edit_event)
-    $(selector).bind('rollback.editable',self.rollback_edit_event)
+    $(selector).bind('blur.editable',complete_edit_event)
+    $(selector).bind('rollback.editable',rollback_edit_event)
   }
   var annotate_editable_with_position = function(selector) {
     $(selector).each(function(i,el) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_update_field
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000Z
+date: 2012-05-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70219322332160 !ruby/object:Gem::Requirement
+  requirement: &70265774286000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70219322332160
+  version_requirements: *70265774286000
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70219322329300 !ruby/object:Gem::Requirement
+  requirement: &70265774284540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70219322329300
+  version_requirements: *70265774284540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70219322306340 !ruby/object:Gem::Requirement
+  requirement: &70265774283080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70219322306340
+  version_requirements: *70265774283080
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70219322304760 !ruby/object:Gem::Requirement
+  requirement: &70265774281220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70219322304760
+  version_requirements: *70265774281220
 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: 2017553997290528289
+      hash: 2183542009217822170
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: