rest_in_place 2.0.0.beta

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Jan Varwig]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,227 @@
+REST in Place
+===========
+                                    _______
+                                   /       \
+                                   | R.I.P.|
+                                   |       |
+                                   |       |
+                                 -------------
+
+REST in Place is an AJAX Inplace-Editor that talks to RESTful controllers.
+It requires absolutely no additional server-side code if your controller
+fulfills the following REST preconditions:
+
+-   It uses the HTTP PUT method to update a record
+-   It delivers an object in JSON form for requests with
+    "Accept: application/json" headers
+
+The editor works by PUTting the updated value to the server and GETting the
+updated record afterwards to display the updated value.
+That way any authentication methods or otherwise funky workflows in your
+controllers are used for the inplace-editors requests.
+To save the additional GET request, you can take the shortcut of returning the
+updated record in the response to the PUT request. See the testapp for an
+example.
+
+URL:         <http://github.com/janv/rest_in_place/>  
+REPOSITORY:  git://github.com/janv/rest_in_place.git
+BLOG:        <http://jan.varwig.org/projects/rest-in-place>
+
+If you like REST in Place, you can flattr me: <a href="http://flattr.com/thing/1984/REST-in-Place" target="_blank">
+<img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a>
+
+Requirements
+============
+
+JavaScript
+----------
+
+The JavaScript code (`app/assets/javascripts/rest_in_place/rest_in_place.js.erb`)
+only relies on the presence of jQuery. You can extract just that file and use
+it with whatever framework in whatever server-side language you want, given
+that you follow the coventions described later in this document.
+
+Even though this is processed by ERB, you can use it as a JavaScript file
+without modification.
+
+Rails
+-----
+
+Since I guess most people use REST in Place in Rails apps, I turned this
+entire thing into a gem that you can require in your Gemfile. It requires
+jQuery, but it will NOT install a `jquery-rails` dependency. This is done so
+you aren't forced to use `jquery-rails` if you want to run a more up-to-date
+version of jQuery. Just make sure that jQuery is there.
+
+REST in Place requires Rails >= 3.1 as a dependency since it loads through the
+asset pipeline.
+
+Installation
+============
+
+Just add
+
+  gem 'rest_in_place'
+
+to your Gemfile.
+
+Then load the JavaScript by adding <%= javascript_include_tag "rest_in_place" %>
+into your layout. Alternatively you can require 'rest_in_place' in your
+JavaScript files in `app/assets`, for example in your application.js:
+
+  //= require 'rest_in_place'
+
+In both cases, make sure you load REST in Place __after__ jQuery.
+
+Rails Request forgery Protection
+================================
+
+For REST in Place to work with Rails request forgery protection, place the
+following lines into your applications layout:
+
+    <script type="text/javascript">
+      rails_authenticity_token = '<%= form_authenticity_token %>'
+    </script>
+
+Usage Instructions
+==================
+
+To make a piece of Text inplace-editable, wrap it into an element (a span
+usually) with class "rest_in_place". The editor needs 3 pieces of information
+to work: a URL, an object name and the attribute name. These are provided as
+follows:
+
+-   put attributes into the element, like this:
+    
+        <span class="rest_in_place" data-url="/users/1" data-object="user" data-attribute="name">
+          <%= @user.name %>
+        </span>
+  
+-   if any of these attributes is missing, DOM parents of the element are searched
+    for them. That means you can write something like:
+    
+        <div data-object="user" data-url="/users/1">
+          Name:  <span class="rest_in_place" data-attribute="name" ><%= @user.name %></span><br/>
+          eMail: <span class="rest_in_place" data-attribute="email"><%= @user.email %></span>
+        </div>
+    
+-   You can completely omit the url to use the current document's url.
+    With proper RESTful controllers this should always work, the explicit
+    url-attribute is for cases when you want to edit a resource that is
+    displayed as part of a non-RESTful webpage.
+  
+-   Rails provides the dom_id helper that constructs a dom id out of an
+    ActiveRecord for you. So, your HTML page may look like this:
+    
+        <div id="<%= dom_id @user # == "user_1" %>">
+          Name:  <span class="rest_in_place" data-attribute="name" ><%= @user.name %></span><br/>
+          eMail: <span class="rest_in_place" data-attribute="email"><%= @user.email %></span>
+        </div>
+    
+    REST in Place recognizes dom_ids of this form and derives the object parameter
+    from them, so that (with the current documents url used) you really only need
+    to provide the attributes name in most cases.
+   
+    **Note that a manually defined (in the element or in one of the parents)  
+    object always overrides dom_id recognition.**
+
+-   REST in Place supports multiple form types. The default type is a input
+    field, a textarea is also supported. To select a form type use the
+    `data-formtype` attribute in the element and set it to the name of your
+    formtype ( `input`, or `textarea` ).
+    
+    To write your own form types, just extend the `RestInPlace.forms` object
+    and select your new form type throught the `data-formtype` attribute.
+
+Example
+=======
+
+Your routes.rb:
+
+    map.resources :users
+  
+Your app/controllers/users_controller.rb:
+
+    class UsersController < ApplicationController
+      def show
+        @user = User.find params[:id]
+        respond_to do |type|
+          type.html
+          type.json {render :json => @user}
+        end
+      end
+
+      def update
+        @user = User.find params[:id]
+        if @user.update_attributes!(params[:user])
+          respond_to do |format|
+            format.html { redirect_to( @person )  }
+            format.json { render :json => @user }
+          end
+        else
+          respond_to do |format|
+            format.html { render :action  => :edit } # edit.html.erb
+            format.json { render :nothing =>  true }
+          end
+        end
+      end
+    end
+
+Your app/views/users/show.html.erb:
+
+    <html>
+    <head>
+      <%= javascript_include_tag "jquery-1.4.min" , "jquery.rest_in_place" %>
+      <script type="text/javascript">
+        rails_authenticity_token = '<%= form_authenticity_token %>'
+        jQuery(function(){
+          jQuery(".rest_in_place").rest_in_place();
+        });
+      </script>
+    </head>
+    <body>
+      <div id="<%= dom_id @user %>">
+        ID: <%= @user.id %><br />
+        Name: <span class="rest_in_place" data-formtype="input" data-attribute="name"><%= @user.name %></span><br/><br/>
+        Hobbies: <span class="rest_in_place" data-formtype="textarea" data-attribute="hobbies"><%= @user.hobbies %></span>
+      </div>
+    </body> 
+    </html>
+
+You can run this example by running to the testapp included in this
+plugin with script/server (sqlite3 required) and visiting
+localhost:3000/users/
+
+Hint:  
+you need to set up the database first.
+Copy and edit `testapp/config/database.yml.sample` accordingly.
+If you don't want to use the included sqlite3 database, run `rake db:create`
+and `rake db:schema:load`.
+
+Troubleshooting
+===============
+
+REST in Place is very picky about correct headers and formatting.
+If you experience errors, please make sure your controller sends responses as
+properly formatted JSON with the correct MIME-Type "application/json".
+
+Non-Rails
+=========
+
+REST in Place was written for Ruby on Rails but is usable with any kind of
+RESTful web api. You should be able to adapt the instructions above to your
+framework easily.
+
+Participation
+=============
+
+I'd love to get comments, bug reports (or better, patches) about REST in Place.
+For this, you can either fork the project and send a pull request, or submit a
+bug in the tracker at github: <http://github.com/janv/rest_in_place/issues>
+
+For general comments and questions, please use the comment function on my blog:
+<http://jan.varwig.org/projects/rest-in-place>
+
+
+---
+Copyright (c) 2010 [Jan Varwig], released under the MIT license

data/app/assets/javascripts/rest_in_place/index.js

@@ -0,0 +1 @@
+//= require ./rest_in_place.js

data/app/assets/javascripts/rest_in_place/rest_in_place.js.erb

@@ -0,0 +1,193 @@
+function RestInPlaceEditor(e) {
+  this.element = jQuery(e);
+  this.initOptions();
+  this.bindForm();
+  
+  this.element.bind('click', {editor: this}, this.clickHandler);
+}
+
+RestInPlaceEditor.prototype = {
+  // Public Interface Functions //////////////////////////////////////////////
+  
+  activate : function() {
+    this.oldValue = this.element.html();
+    this.element.addClass('rip-active');
+    this.element.unbind('click', this.clickHandler)
+    this.activateForm();
+  },
+  
+  abort : function() {
+    this.element
+      .html(this.oldValue)
+      .removeClass('rip-active')
+      .bind('click', {editor: this}, this.clickHandler);
+  },
+  
+  update : function() {
+    var editor = this;
+    editor.ajax({
+      "type"       : "post",
+      "dataType"   : "json",
+      "data"       : editor.requestData(),
+      "error"      : function(response) {
+        if (response.status == 100 && response.statusText == "parsererror") {
+          editor.ajax({
+            "dataType" : 'json',
+            "success"  : function(data){ editor.loadSuccessCallback(data) }
+          });
+        } else {
+          editor.abort();
+        }
+      },
+      "success"    : function(data){
+        if (data) {
+          editor.loadSuccessCallback(data)
+        } else {
+          editor.ajax({
+            "dataType" : 'json',
+            "success"  : function(data){ editor.loadSuccessCallback(data) }
+          });
+        }
+      }
+    });
+    editor.element.html("saving...");
+  },
+  
+  activateForm : function() {
+    alert("The form was not properly initialized. activateForm is unbound");
+  },
+  
+  // Helper Functions ////////////////////////////////////////////////////////
+  
+  initOptions : function() {
+    // Try parent supplied info
+    var self = this;
+    self.element.parents().each(function(){
+      self.url           = self.url           || jQuery(this).attr("data-url");
+      self.formType      = self.formType      || jQuery(this).attr("data-formtype");
+      self.objectName    = self.objectName    || jQuery(this).attr("data-object");
+      self.attributeName = self.attributeName || jQuery(this).attr("data-attribute");
+    });
+    // Try Rails-id based if parents did not explicitly supply something
+    self.element.parents().each(function(){
+      var res;
+      if (res = this.id.match(/^(\w+)_(\d+)$/i)) {
+        self.objectName = self.objectName || res[1];
+      }
+    });
+    // Load own attributes (overrides all others)
+    self.url           = self.element.attr("data-url")       || self.url      || document.location.pathname;
+    self.formType      = self.element.attr("data-formtype")  || self.formtype || "input";
+    self.objectName    = self.element.attr("data-object")    || self.objectName;
+    self.attributeName = self.element.attr("data-attribute") || self.attributeName;
+  },
+  
+  bindForm : function() {
+    this.activateForm = RestInPlaceEditor.forms[this.formType].activateForm;
+    this.getValue     = RestInPlaceEditor.forms[this.formType].getValue;
+  },
+  
+  getValue : function() {
+    alert("The form was not properly initialized. getValue is unbound");    
+  },
+  
+  /* Generate the data sent in the POST request */
+  requestData : function() {
+    var data = "_method=put";
+    data += "&"+this.objectName+'['+this.attributeName+']='+encodeURIComponent(this.getValue());
+    data += this.getEncodedTokenAuthentication()
+    return data;
+  },
+  
+  getEncodedTokenAuthentication : function() {
+    var param = $('meta[name=csrf-param]').attr('content');
+    var token = $('meta[name=csrf-token]').attr('content');
+    if (param && token) {
+      param = encodeURIComponent(param);
+      token = encodeURIComponent(token);
+      return "&"+param+"="+token;
+    } else {
+      return "";
+    }
+  },
+  
+  ajax : function(options) {
+    options.url = this.url;
+    return jQuery.ajax(options);
+  },
+  
+  extractAttributeFromData : function(data) {
+    var include_root_in_json = "<%= ActiveRecord::Base.include_root_in_json %>";
+    if (include_root_in_json == "false") {
+      return data[this.attributeName];      
+    } else {
+      return data[this.objectName][this.attributeName];
+    }
+  },
+
+  // Handlers ////////////////////////////////////////////////////////////////
+  
+  loadSuccessCallback : function(data) {
+    this.element.html(this.extractAttributeFromData(data));
+    this.element.bind('click', {editor: this}, this.clickHandler);
+    this.element.removeClass('rip-active');
+  },
+  
+  clickHandler : function(event) {
+    event.data.editor.activate();
+  }
+};
+
+
+RestInPlaceEditor.forms = {
+  "input" : {
+    /* is bound to the editor and called to replace the element's content with a form for editing data */
+    activateForm : function() {
+      this.element.html('<form action="javascript:void(0)" style="display:inline;"><input type="text" value="' + jQuery.trim(this.oldValue) + '"></form>');
+      this.element.find('input')[0].select();
+      this.element.find("form")
+        .bind('submit', {editor: this}, RestInPlaceEditor.forms.input.submitHandler);
+      this.element.find("input")
+        .bind('blur',   {editor: this}, RestInPlaceEditor.forms.input.inputBlurHandler);
+    },
+    
+    getValue :  function() {
+      return this.element.find("input").val();
+    },
+
+    inputBlurHandler : function(event) {
+      event.data.editor.abort();
+    },
+
+    submitHandler : function(event) {
+      event.data.editor.update();
+      return false;
+    }
+  },
+
+  "textarea" : {
+    /* is bound to the editor and called to replace the element's content with a form for editing data */
+    activateForm : function() {
+      this.element.html('<form action="javascript:void(0)" style="display:inline;"><textarea>' + jQuery.trim(this.oldValue) + '</textarea></form>');
+      this.element.find('textarea')[0].select();
+      this.element.find("textarea")
+        .bind('blur', {editor: this}, RestInPlaceEditor.forms.textarea.blurHandler);
+    },
+    
+    getValue :  function() {
+      return this.element.find("textarea").val();
+    },
+
+    blurHandler : function(event) {
+      event.data.editor.update();
+    }
+
+  }
+};
+
+jQuery.fn.rest_in_place = function() {
+  this.each(function(){
+    jQuery(this).data('restInPlaceEditor', new RestInPlaceEditor(this));
+  })
+  return this;
+};

data/lib/rest_in_place.rb

@@ -0,0 +1,7 @@
+require "rest_in_place/version"
+
+module RestInPlace
+  class Engine < Rails::Engine
+    # no ruby code here!
+  end
+end

data/lib/rest_in_place/version.rb

@@ -0,0 +1,3 @@
+module RestInPlace
+  VERSION = "2.0.0.beta"
+end

data/rest_in_place.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rest_in_place/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rest_in_place"
+  s.version     = RestInPlace::VERSION
+  s.date        = '2011-11-27'
+  s.authors     = ["Jan Varwig"]
+  s.email       = ["jan@varwig.org"]
+  s.homepage    = "http://jan.varwig.org"
+  s.summary     = %q{An AJAX Inplace-Editor for the Rails 3.1 asset pipeline.}
+  s.description = %q{REST in Place is an AJAX Inplace-Editor that talks to RESTful controllers.}
+  s.license     = "MIT"
+
+  s.files       = Dir["Gemfile", "MIT-LICENSE", "README.markdown", "rest_in_place.gemspec", "app/**/*", "lib/**/*"]
+
+  s.require_paths = ["lib"]
+  s.add_dependency('rails', '>= 3.1')
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: rest_in_place
+version: !ruby/object:Gem::Version 
+  hash: 31098209
+  prerelease: 6
+  segments: 
+  - 2
+  - 0
+  - 0
+  - beta
+  version: 2.0.0.beta
+platform: ruby
+authors: 
+- Jan Varwig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  type: :runtime
+  version_requirements: *id001
+description: REST in Place is an AJAX Inplace-Editor that talks to RESTful controllers.
+email: 
+- jan@varwig.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.markdown
+- rest_in_place.gemspec
+- app/assets/javascripts/rest_in_place/index.js
+- app/assets/javascripts/rest_in_place/rest_in_place.js.erb
+- lib/rest_in_place/version.rb
+- lib/rest_in_place.rb
+homepage: http://jan.varwig.org
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: An AJAX Inplace-Editor for the Rails 3.1 asset pipeline.
+test_files: []
+