simple_update_field 1.0.0 → 1.1.0

data/Gemfile

@@ -1,27 +1,8 @@
 source "http://rubygems.org"
 
-group :assets do
-  gem 'sass-rails'
-  gem 'coffee-rails'
-  gem 'uglifier'
-end
-
 group :development do
   gem "rspec", "~> 2.8.0"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.1.0"
   gem "jeweler", "~> 1.8.3"
-
-  gem 'rails', '3.1.0'
-
-  gem 'sqlite3'
-  gem 'jquery-rails'
-
-  gem 'rspec-rails'
-  gem 'autotest'
-  gem 'capybara'
-  gem 'jasminerice'
-  gem 'guard-jasmine'
-
-  gem 'faker'
 end

data/Gemfile.lock

@@ -1,119 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.7.0)
-    actionmailer (3.1.0)
-      actionpack (= 3.1.0)
-      mail (~> 2.3.0)
-    actionpack (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      i18n (~> 0.6)
-      rack (~> 1.3.2)
-      rack-cache (~> 1.0.3)
-      rack-mount (~> 0.8.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.0.0)
-    activemodel (3.1.0)
-      activesupport (= 3.1.0)
-      bcrypt-ruby (~> 3.0.0)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
-      arel (~> 2.2.1)
-      tzinfo (~> 0.3.29)
-    activeresource (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
-    activesupport (3.1.0)
-      multi_json (~> 1.0)
-    arel (2.2.3)
-    autotest (4.4.6)
-      ZenTest (>= 4.4.1)
-    bcrypt-ruby (3.0.1)
-    builder (3.0.0)
-    capybara (1.1.2)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (~> 2.0)
-      xpath (~> 0.1.4)
-    childprocess (0.3.1)
-      ffi (~> 1.0.6)
-    coffee-rails (3.1.1)
-      coffee-script (>= 2.2.0)
-      railties (~> 3.1.0)
-    coffee-script (2.2.0)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.2.0)
     diff-lcs (1.1.3)
-    erubis (2.7.0)
-    execjs (1.3.0)
-      multi_json (~> 1.0)
-    faker (1.0.1)
-      i18n (~> 0.4)
-    ffi (1.0.11)
     git (1.2.5)
-    guard (1.0.1)
-      ffi (>= 0.5.0)
-      thor (~> 0.14.6)
-    guard-jasmine (1.1.0)
-      childprocess
-      guard (>= 0.8.3)
-      multi_json
-      thor
-    haml (3.1.4)
-    hike (1.2.1)
-    i18n (0.6.0)
-    jasminerice (0.0.8)
-      haml
     jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    jquery-rails (1.0.19)
-      railties (~> 3.0)
-      thor (~> 0.14)
     json (1.6.5)
-    mail (2.3.3)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.18)
-    multi_json (1.2.0)
-    nokogiri (1.5.2)
-    polyglot (0.3.3)
-    rack (1.3.6)
-    rack-cache (1.0.3)
-      rack (>= 0.4)
-    rack-mount (0.8.3)
-      rack (>= 1.0.0)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.1.0)
-      actionmailer (= 3.1.0)
-      actionpack (= 3.1.0)
-      activerecord (= 3.1.0)
-      activeresource (= 3.1.0)
-      activesupport (= 3.1.0)
-      bundler (~> 1.0)
-      railties (= 3.1.0)
-    railties (3.1.0)
-      actionpack (= 3.1.0)
-      activesupport (= 3.1.0)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -125,57 +20,12 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    rspec-rails (2.8.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.8.0)
-    rubyzip (0.9.6.1)
-    sass (3.1.15)
-    sass-rails (3.1.6)
-      actionpack (~> 3.1.0)
-      railties (~> 3.1.0)
-      sass (>= 3.1.10)
-      tilt (~> 1.3.2)
-    selenium-webdriver (2.20.0)
-      childprocess (>= 0.2.5)
-      ffi (~> 1.0)
-      multi_json (~> 1.0)
-      rubyzip
-    sprockets (2.0.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.5)
-    thor (0.14.6)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.32)
-    uglifier (1.2.4)
-      execjs (>= 0.3.0)
-      multi_json (>= 1.0.2)
-    xpath (0.1.4)
-      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  autotest
   bundler (~> 1.1.0)
-  capybara
-  coffee-rails
-  faker
-  guard-jasmine
-  jasminerice
   jeweler (~> 1.8.3)
-  jquery-rails
-  rails (= 3.1.0)
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
-  rspec-rails
-  sass-rails
-  sqlite3
-  uglifier

data/README.creole

@@ -0,0 +1,102 @@
+== simple_update_field
+
+Rails text field helper for inplace-editing of text with keybindings
+to move between each simple_update_field.
+
+simple_update_field is implemented internally with jquery
+
+== Installation Guide for Rails 3+
+
+If you are using a version of rails before JQuery became the default - please integrate the gem 'jquery-rails'
+
+In the installation guide you will see the following terms: phrase, PhrasesController, Phrase, text - my examples
+assume that I am working with a Phrase resource with a :string field named 'text'. The PhrasesController handles rails rest
+based resource calls.
+
+
+
+* Edit your Gemfile to include the following 
+{{{
+   gem "simple_update_field"
+}}}
+* You will need to re-start a running server for the Gemfile change to take effect
+=== View Side
+* There are 3 custom attributes that will be used. An Example follows
+{{{
+      <span editable-resource-attribute="text"
+            editable-resource-model="<%=phrase.class.model_name.downcase%>"
+            editable-resource-uri="<%=url_for(phrase)%>"
+            class="text">
+        <%= phrase.text %>
+      </span>
+}}}
+==== The 3 custom attributes are :
+## editable-resource-attribute 
+*** this is the name one of the model attributes that you want to change ie : 'name', 'text', 'phone_number'
+*** this will be used with the editable-resource-model to name the parameter
+## editable-resource-model
+*** this is a lowercase name of the model class that you are planning on changing 
+*** 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.
+==== 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)%>">
+        <%= animal.name %>
+      </span>
+}}}
+=== Resource Side 
+* You will need a controller with an update action written in the typical rails resource-style
+## The typical rails resource style tends towards having a the resource payload named by the model and as part of the general request params
+{{{
+class PhrasesController < ApplicationController
+  def update
+    Phrase.
+      find(params[:id]).
+      update_attributes(params[:phrase])
+    head :ok # assume success
+  end
+end
+}}}
+* With an update action in your controller - you will also need a route for it
+## edit your config/routes.rb file to specify that there is an update action
+*** in the example there are only two actions :
+{{{
+  resources :phrases, :only => [:index,:update]
+}}}
+*** or simply use the default actions :
+{{{
+  resources :phrases
+}}}
+* 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
+
+
+== Roadmap
+
+* form field helper
+* error handling of ajax call
+
+== Recent Changes
+
+* integrated rails test harness into gem
+
+=== Contributing to simple_update_field
+ 
+# Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+# Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+# Fork the project.
+# Start a feature/bugfix branch.
+# Commit and push until you are happy with your contribution.
+# Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+# 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
+
+Copyright (c) 2012 Blazing Cloud. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'bundler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -11,17 +12,13 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
-# RAILS
-require File.expand_path('../config/application', __FILE__)
-EditableList::Application.load_tasks
-
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "simple_update_field"
-  gem.homepage = "http://github.com/robotarmy/simple_update_field"
+  gem.homepage = "http://github.com/blazingcloud/simple_update_field"
   gem.license = "MIT"
-  gem.summary = %Q{turn a resource attribute into an inplace editable field}
+  gem.summary = %Q{turn a rails resource's attribute into an inplace editable field}
   gem.description = %Q{Your resources text attributes will gain inplace update ability with keybindings for quick editing}
   gem.email = "curtis@ram9.cc"
   gem.authors = ["Curtis Schofield"]
@@ -39,7 +36,6 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
 end
-
 task :default => :spec
 
 require 'rdoc/task'
@@ -51,5 +47,3 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/simple_update_field.rb

@@ -1,11 +1,3 @@
-begin
-  Object.const_get('Rails')
-rescue
-  module Rails
-    class Engine
-    end
-  end
-end
 module SimpleUpdateField
   class Engine < ::Rails::Engine
     # let rails know to include the javascript

data/simple_update_field.gemspec

@@ -5,84 +5,37 @@
 
 Gem::Specification.new do |s|
   s.name = "simple_update_field"
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Curtis Schofield"]
-  s.date = "2012-03-29"
+  s.date = "2012-04-25"
   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 = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.creole"
   ]
   s.files = [
     ".document",
     ".rspec",
-    ".rvmrc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.creole",
     "Rakefile",
     "VERSION",
-    "app/assets/images/rails.png",
-    "app/assets/javascripts/application.js",
-    "app/assets/stylesheets/application.css",
-    "app/controllers/application_controller.rb",
-    "app/controllers/phrases_controller.rb",
-    "app/helpers/application_helper.rb",
-    "app/mailers/.gitkeep",
-    "app/models/.gitkeep",
-    "app/models/phrase.rb",
-    "app/views/layouts/application.html.erb",
-    "app/views/phrases/_phrase.html.erb",
-    "app/views/phrases/index.html.erb",
-    "config.ru",
-    "config/application.rb",
-    "config/boot.rb",
-    "config/database.yml",
-    "config/environment.rb",
-    "config/environments/development.rb",
-    "config/environments/production.rb",
-    "config/environments/test.rb",
-    "config/initializers/backtrace_silencers.rb",
-    "config/initializers/inflections.rb",
-    "config/initializers/mime_types.rb",
-    "config/initializers/secret_token.rb",
-    "config/initializers/session_store.rb",
-    "config/initializers/wrap_parameters.rb",
-    "config/locales/en.yml",
-    "config/routes.rb",
-    "db/migrate/20120213182817_create_phrases.rb",
-    "db/schema.rb",
-    "db/seeds.rb",
-    "lib/assets/.gitkeep",
     "lib/simple_update_field.rb",
-    "lib/tasks/.gitkeep",
-    "lib/tasks/admin.rake",
-    "lib/tasks/jasmine.rake",
-    "script/rails",
     "simple_update_field.gemspec",
-    "spec/controllers/phrases_controller_spec.rb",
-    "spec/javascripts/editable_list_spec.js",
-    "spec/javascripts/helpers/mock-ajax.js",
-    "spec/javascripts/spec.css",
-    "spec/javascripts/spec.js",
-    "spec/lib/simple_update_field_spec.rb",
-    "spec/models/phrase_spec.rb",
-    "spec/routing/phrase_spec.rb",
-    "spec/routing/root_spec.rb",
+    "spec/simple_update_field_spec.rb",
     "spec/spec_helper.rb",
-    "spec/views/_phrase.html.erb_spec.rb",
-    "spec/views/index.html.erb_spec.rb",
     "vendor/assets/javascripts/editable_list.js"
   ]
-  s.homepage = "http://github.com/robotarmy/simple_update_field"
+  s.homepage = "http://github.com/blazingcloud/simple_update_field"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.10"
-  s.summary = "turn a resource attribute into an inplace editable field"
+  s.summary = "turn a rails resource's attribute into an inplace editable field"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
@@ -92,44 +45,17 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<rails>, ["= 3.1.0"])
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_development_dependency(%q<jquery-rails>, [">= 0"])
-      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_development_dependency(%q<autotest>, [">= 0"])
-      s.add_development_dependency(%q<capybara>, [">= 0"])
-      s.add_development_dependency(%q<jasminerice>, [">= 0"])
-      s.add_development_dependency(%q<guard-jasmine>, [">= 0"])
-      s.add_development_dependency(%q<faker>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<rails>, ["= 3.1.0"])
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<jquery-rails>, [">= 0"])
-      s.add_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_dependency(%q<autotest>, [">= 0"])
-      s.add_dependency(%q<capybara>, [">= 0"])
-      s.add_dependency(%q<jasminerice>, [">= 0"])
-      s.add_dependency(%q<guard-jasmine>, [">= 0"])
-      s.add_dependency(%q<faker>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<rails>, ["= 3.1.0"])
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<jquery-rails>, [">= 0"])
-    s.add_dependency(%q<rspec-rails>, [">= 0"])
-    s.add_dependency(%q<autotest>, [">= 0"])
-    s.add_dependency(%q<capybara>, [">= 0"])
-    s.add_dependency(%q<jasminerice>, [">= 0"])
-    s.add_dependency(%q<guard-jasmine>, [">= 0"])
-    s.add_dependency(%q<faker>, [">= 0"])
   end
 end