simple_update_field 1.1.0 → 1.2.0

data/README.creole

@@ -23,12 +23,14 @@ based resource calls.
 === View Side
 * There are 3 custom attributes that will be used. An Example follows
 {{{
+<div class='phrase'>
       <span editable-resource-attribute="text"
             editable-resource-model="<%=phrase.class.model_name.downcase%>"
             editable-resource-uri="<%=url_for(phrase)%>"
             class="text">
         <%= phrase.text %>
       </span>
+</div>
 }}}
 ==== The 3 custom attributes are :
 ## editable-resource-attribute 
@@ -44,7 +46,8 @@ based resource calls.
 {{{
       <span editable-resource-attribute="name"
             editable-resource-model="animal"
-            editable-resource-uri="<%=url_for(animal)%>">
+            editable-resource-uri="<%=url_for(animal)%>"
+            class="animal-name">
         <%= animal.name %>
       </span>
 }}}
@@ -74,6 +77,29 @@ end
 * The combination of having a resource 'end-point', and telling the span what the end point is, and what the model, and attribute are will be enough to save changes to the database.
 * You can invoke the simple update field by clicking on the text you may wish to add CSS styling for hover to indicate to the user that this is an interactive part of the display
 
+=== Javascript Integration
+
+There are 2 steps to integration with javascript.
+
+* The first step is to modify application.js to include the name of the javascript file
+{{{
+//= require simple_update_field
+}}}
+* The second step is to invoke the the Simple Update Field on the appropriate elements
+** A CSS selector of the jQuery style is assumed.
+## For the above Phrase view code this could work :
+{{{
+$(document).ready(function() {
+  SimpleUpdateField('.phrase .text')
+})
+}}}
+## For the above Animals view code this could work :
+{{{
+$(document).ready(function() {
+  SimpleUpdateField('.animal-name')
+})
+}}}
+
 
 == Roadmap
 
@@ -82,7 +108,7 @@ end
 
 == Recent Changes
 
-* integrated rails test harness into gem
+* Left out test harness https://github.com/blazingcloud/simple_update_field-jasmine-harness
 
 === Contributing to simple_update_field
  

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/simple_update_field.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "simple_update_field"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Curtis Schofield"]
@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
     "simple_update_field.gemspec",
     "spec/simple_update_field_spec.rb",
     "spec/spec_helper.rb",
-    "vendor/assets/javascripts/editable_list.js"
+    "vendor/assets/javascripts/simple_update_field.js"
   ]
   s.homepage = "http://github.com/blazingcloud/simple_update_field"
   s.licenses = ["MIT"]

data/vendor/assets/javascripts/{editable_list.js → simple_update_field.js}

@@ -1,4 +1,4 @@
-Editable = function(selector) {
+SimpleUpdateField = function(selector) {
   var self = this
   self.selector = selector
 
@@ -36,7 +36,7 @@ Editable = function(selector) {
   }
   var is_rollback_changes  = function() {
     if (self.last_keydown_event) {
-      if (self.last_keydown_event.keyCode == Editable.ESC_KEY) {
+      if (self.last_keydown_event.keyCode == SimpleUpdateField.ESC_KEY) {
         return true
       }
     }
@@ -44,10 +44,10 @@ Editable = function(selector) {
   }
   var is_blur_tab_redirect = function () {
     if (self.last_keydown_event) {
-      if (self.last_keydown_event.keyCode == Editable.TAB_KEY) {
+      if (self.last_keydown_event.keyCode == SimpleUpdateField.TAB_KEY) {
         return true
       }
-      if (self.last_keydown_event.keyCode == Editable.ENTER_KEY) {
+      if (self.last_keydown_event.keyCode == SimpleUpdateField.ENTER_KEY) {
         return true
       }
     }
@@ -163,6 +163,6 @@ Editable = function(selector) {
   }()
   return self;
 }
-Editable.TAB_KEY   = 9   // tab is   #9
-Editable.ENTER_KEY = 13  // enter is #13
-Editable.ESC_KEY   = 27  // enter is #13
+SimpleUpdateField.TAB_KEY   = 9   // tab is   #9
+SimpleUpdateField.ENTER_KEY = 13  // enter is #13
+SimpleUpdateField.ESC_KEY   = 27  // enter is #13

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_update_field
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70352525074880 !ruby/object:Gem::Requirement
+  requirement: &70164641191780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70352525074880
+  version_requirements: *70164641191780
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70352525072500 !ruby/object:Gem::Requirement
+  requirement: &70164641188880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70352525072500
+  version_requirements: *70164641188880
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70352525070640 !ruby/object:Gem::Requirement
+  requirement: &70164641186320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70352525070640
+  version_requirements: *70164641186320
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70352525067840 !ruby/object:Gem::Requirement
+  requirement: &70164641165080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70352525067840
+  version_requirements: *70164641165080
 description: Your resources text attributes will gain inplace update ability with
   keybindings for quick editing
 email: curtis@ram9.cc
@@ -76,7 +76,7 @@ files:
 - simple_update_field.gemspec
 - spec/simple_update_field_spec.rb
 - spec/spec_helper.rb
-- vendor/assets/javascripts/editable_list.js
+- vendor/assets/javascripts/simple_update_field.js
 homepage: http://github.com/blazingcloud/simple_update_field
 licenses:
 - MIT
@@ -92,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -417061757656223822
+      hash: 2576101730221014213
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: