best_in_place 1.0.2 → 1.0.3

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem 'sqlite3-ruby', :require => 'sqlite3'
 gem 'jquery-rails'
+gem 'rdiscount'

data/README.md

@@ -26,11 +26,13 @@ The editor works by PUTting the updated value to the server and GETting the upda
 - Allows external activator
 - ESC key destroys changes (requires user confirmation)
 - Autogrowing textarea
-
----
+- Helper for generating the best_in_place field only if a condition is satisfied
+- Provided test helpers to be used in your integration specs
+- Custom display methods
 
 ##Usage of Rails 3 Gem
 
+###best_in_place
 **best_in_place object, field, OPTIONS**
 
 Params:
@@ -48,10 +50,38 @@ Options:
   If not defined it will show *"-"*.
 - **:activator**: Is the DOM object that can activate the field. If not defined the user will making editable by clicking on it.
 - **:sanitize**: True by default. If set to false the input/textarea will accept html tags.
-- **:html_args**: Hash of html arguments, such as maxlength, default-value etc.
+- **:html_attrs**: Hash of html arguments, such as maxlength, default-value etc.
+- **:inner_class**: Class that is set to the rendered form.
+- **:display_as**: A model method which will be called in order to display
+  this field.
+
+###best_in_place_if
+**best_in_place_if condition, object, field, OPTIONS**
+
+It allows us to use best_in_place only if the first new parameter, a
+condition, is satisfied. Specifically:
+
+* Will show a normal best_in_place if the condition is satisfied
+* Will only show the attribute from the instance if the condition is not satisfied
+
+Say we have something like
+
+    <%= best_in_place condition, @user, :name, :type => :input %>
+
+In case *condition* is satisfied, the outcome will be just the same as:
+
+    <%= best_in_place @user, :name, :type => :input %>
+
+Otherwise, we will have the same outcome as:
+
+    <%= @user.name %>
 
+It is a very useful feature to use with, for example, [Ryan Bates](https://github.com/ryanb)' [CanCan](https://github.com/ryanb/cancan), so we only allow BIP edition if the current user has permission to do it.
 
-I created a [test_app](https://github.com/bernat/best_in_place/tree/master/test_app) and a running demo in heroku to test the features.
+---
+
+##TestApp and examples
+A [test_app](https://github.com/bernat/best_in_place/tree/master/test_app) was created, and can be seen in action in a [running demo on heroku](http://bipapp.heroku.com).
 
 Examples (code in the views):
 
@@ -69,83 +99,230 @@ Examples (code in the views):
 
     <%= best_in_place @user, :country, :type => :select, :collection => [[1, "Spain"], [2, "Italy"], [3, "Germany"], [4, "France"]] %>
 
-Of course it can take an instance or global variable for the collection, just remember the structure [[key, value], [key, value],...].
+Of course it can take an instance or global variable for the collection, just remember the structure `[[key, value], [key, value],...]`.
 The key can be a string or an integer.
 
 ### Checkbox
 
     <%= best_in_place @user, :receive_emails, :type => :checkbox, :collection => ["No, thanks", "Yes, of course!"] %>
 
-The first value is always the negative boolean value and the second the positive. Structure: ["false value", "true value"].
+The first value is always the negative boolean value and the second the positive. Structure: `["false value", "true value"]`.
 If not defined, it will default to *Yes* and *No* options.
 
-### Display server validation errors
+## Controller response and respond_with_bip
 
-If you are using a Rails application, your controller's should respond to json in case of error.
-Example:
+Your controller should respond to json as it's the format used by best in
+place javascript. A simple example would be:
 
-    def update
-      @user = User.find(params[:id])
+    class UserController < ApplicationController
+      def update
+        @user = User.find(params[:id])
 
-      respond_to do |format|
-        if @user.update_attributes(params[:user])
-          format.html { redirect_to(@user, :notice => 'User was successfully updated.') }
-          format.json { head :ok }
-        else
-          format.html { render :action => "edit" }
-          format.json { render :json => @user.errors.full_messages, :status => :unprocessable_entity }
+        respond_to do |format|
+          if @user.update_attributes(params[:user])
+            format.html { redirect_to(@user, :notice => 'User was successfully updated.') }
+            format.json { head :ok }
+          else
+            format.html { render :action => "edit" }
+            format.json { render :json => @user.errors.full_messages, :status => :unprocessable_entity }
+          end
         end
       end
     end
 
-At the same time, you must define the restrictions, validations and error messages in the model, as the example below:
-
-    class User < ActiveRecord::Base
-      validates :name,
-        :length => { :minimum => 2, :maximum => 24, :message => "has invalid length"},
-        :presence => {:message => "can't be blank"}
-      validates :last_name,
-        :length => { :minimum => 2, :maximum => 24, :message => "has invalid length"},
-        :presence => {:message => "can't be blank"}
-      validates :address,
-        :length => { :minimum => 5, :message => "too short length"},
-        :presence => {:message => "can't be blank"}
-      validates :email,
-        :presence => {:message => "can't be blank"},
-        :format => {:with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :message => "has wrong email format"}
-      validates :zip, :numericality => true, :length => { :minimum => 5 }
+If you respond with a json like `{:display_as => "New value to show"}` with
+status 200 (ok), then the updated field will show *New value to show* after
+being updated. This is needed in order to support the custom display methods,
+and it's automatically handled if you use the new method to encapsulate
+the responses:
+
+
+        respond_to do |format|
+          if @user.update_attributes(params[:user])
+            format.html { redirect_to(@user, :notice => 'User was successfully updated.') }
+            format.json { respond_with_bip(@user) }
+          else
+            format.html { render :action => "edit" }
+            format.json { respond_with_bip(@user) }
+          end
+        end
+
+This will be exactly the same as the previous example, but with support to
+handle custom display methods.
+
+##Using custom display methods
+
+As of best in place 1.0.3 you can use custom methods in your model in order to
+decide how a certain field has to be displayed. You can write something like:
+
+    = best_in_place @user, :description, :type => :textarea, :display_as => :mk_description
+
+Then instead of using `@user.description` to show the actual value, best in
+place will call `@user.mk_description`. This can be used for any kind of
+custom formatting, text with markdown, currency values, etc...
+
+Because best in place has no way to call that method in your model from
+javascript after a successful update, the only way to display the new correct
+value after an edition is to use the provided methods to respond in your
+controllers, or implement the same in your own way.
+
+If you respond a successful update with a json having a `display_as` key, that
+value will be used to update the value in the view. The provided
+`respond_with_bip` handles this for you, but if you want you can always
+customize this behaviour.
+
+
+##Non Active Record environments
+We are not planning to support other ORMs apart from Active Record, at least for now. So, you can perfectly consider the following workaround as *the right way* until a specific implementation is done for your ORM.
+
+Best In Place automatically assumes that Active Record is the ORM you are using. However, this might not be your case, as you might use another ORM (or not ORM at all for that case!). Good news for you: even in such situation Best In Place can be used!
+
+Let's setup an example so we can illustrate how to use Best In Place too in a non-ORM case. Imagine you have an awesome ice cream shop, and you have a model representing a single type of ice cream. The IceCream model has a name, a description, a... nevermind. The thing is that it also has a stock, which is a combination of flavour and size. A big chocolate ice cream (yummy!), a small paella ice cream (...really?), and so on. Shall we see some code?
+
+    class IceCream < ActiveRecord::Base
+      serialize :stock, Hash
+
+      # consider the get_stock and set_stock methods are already defined
     end
 
-When the user tries to introduce invalid data, the error messages defined in the model will be displayed in pop-up windows using the jQuery.purr plugin.
+Imagine we want to have a grid showing all the combinations of flavour and size and, for each combination, an editable stock. Since the stock for a flavour and a size is not a single and complete model attribute, we cannot use Best In Place *directly*. But we can set it up with an easy workaround.
+
+In the view, we'd do:
+
+    // @ice_cream is already available
+    - flavours = ... // get them somewhere
+    - sizes = ... // get them somewhere
+    %table
+      %tr
+        - ([""] + flavours).each do |flavour|
+          %th= flavour
+      - sizes.each do |size|
+        %tr
+          %th= size
+          - flavours.each do |flavour|
+            - v = @ice_cream.get_stock(:flavour => flavour, :size => size)
+            %td= best_in_place v, :to_i, :type => :input, :path => set_stock_ice_cream_path(:flavour => flavour, :size => size)
+
+Now we need a route to which send the stock updates:
+
+    TheAwesomeIceCreamShop::Application.routes.draw do
+      ...
+
+      resources :ice_creams, :only => :none do
+        member do
+          put :set_stock
+        end
+      end
+
+      ...
+    end
+
+And finally we need a controller:
+
+
+    class IceCreamsController < ApplicationController::Base
+      respond_to :html, :json
+
+      ...
+
+      def set_stock
+        flavour = params[:flavour]
+        size = params[:size]
+        new_stock = (params["fixnum"] || {})["to_i"]
+
+        @ice_cream.set_stock(new_stock, { :flavour => flavour, :size => size })
+        if @ice_cream.save
+          head :ok
+        else
+          render :json => @ice_cream.errors.full_messages, :status => :unprocessable_entity
+        end
+      end
+
+      ...
+
+    end
+
+And this is how it is done!
+
+---
+
+##Test Helpers
+Best In Place has also some helpers that may be very useful for integration testing. Since it might very common to test some views using Best In Place, some helpers are provided to ease it.
+
+As of now, a total of four helpers are available. There is one for each of the following BIP types: a plain text input, a textarea, a boolean input and a selector. Its function is to simulate the user's action of filling such fields.
+
+These four helpers are listed below:
+
+* **bip_area(model, attr, new_value)**
+* **bip_text(model, attr, new_value)**
+* **bip_bool(model, attr)**
+* **bip_select(model, attr, name)**
+
+The parameters are defined here (some are method-specific):
+
+* **model**: the model to which this action applies.
+* **attr**: the attribute of the model to which this action applies.
+* **new_value** (only **bip_area** and **bip_text**): the new value with which to fill the BIP field.
+* **name** (only **bip_select**): the name to select from the dropdown selector.
 
 ---
 
 ##Installation
 
-It works by simply copying and loading the files from the folder **/public/javascripts** to your application and loading them in your layouts
-in the following order:
+###Rails 3.1 and higher
 
-- jquery-1.4.4.js
-- jquery.purr.js
-- **best_in_place.js**
+Installing *best_in_place* is very easy and straight-forward, even more
+thanks to Rails 3.1. Just begin including the gem in your Gemfile:
 
-The last one you can copy it (and keeping up to date to the last version) by running the following generator in your application's root.
-Remember to do it every time you update the gem (or you will see no change).
+    gem "best_in_place"
 
-    rails g best_in_place:setup
+After that, specify the use of the jquery, jquery.purr and best in place
+javascripts in your application.js:
+
+    //= require jquery
+    //= require jquery.purr
+    //= require best_in_place
 
-To be able to use the script the following block must be added as well:
+Then, just add a binding to prepare all best in place fields when the document is ready:
 
     $(document).ready(function() {
       /* Activating Best In Place */
-      jQuery(".best_in_place").best_in_place()
+      jQuery(".best_in_place").best_in_place();
     });
 
-In order to use the Rails 3 gem, just add the following line to the gemfile:
+You are done!
 
-    gem "best_in_place"
+###Rails 3.0 and lower
+
+Installing *best_in_place* for Rails 3.0 or below is a little bit
+different, since the master branch is specifically updated for Rails
+3.1. But don't be scared, you'll be fine!
+
+Rails 3.0 support will be held in the 0.2.X versions, but we have planned not to continue developing for this version of Rails. Nevertheless, you can by implementing what you want and sending us a pull request.
+
+First, add the gem's 0.2 version in the Gemfile:
+
+    gem "best_in_place", "~> 0.2.0"
+
+After that, install and load all the javascripts from the folder
+**/public/javascripts** in your layouts. They have to be in the order:
+
+* jquery
+* jquery.purr
+* **best_in_place**
+
+You can automatize this installation by doing
 
-----
+    rails g best_in_place:setup
+
+Finally, as for Rails 3.1, just add a binding to prepare all best in place fields when the document is ready:
+
+    $(document).ready(function() {
+      /* Activating Best In Place */
+      jQuery(".best_in_place").best_in_place();
+    });
+
+---
 
 ## Security
 
@@ -154,17 +331,45 @@ If the script is used with the Rails Gem no html tags will be allowed unless the
     <meta name="csrf-param" content="authenticity_token"/>
     <meta name="csrf-token" content="YOUR UNIQUE TOKEN HERE"/>
 
+---
+
 ##TODO
 
 - Client Side Validation definitions
 - Accepting more than one handler to activate best_in_place fields
-- Specs *(sacrilege!!)*
+
+---
+
+## Development
+
+Fork the project on [github](https://github.com/bernat/best_in_place 'bernat / best_in_place on Github')
+
+    $ git clone <<your fork>
+    $ cd best_in_place
+    $ bundle
+
+### Prepare the test app
+
+    $ cd test_app
+    $ bundle
+    $ bundle exec rake db:test:prepare
+    $ cd ..
+
+### Run the specs
+
+    $ bundle exec rspec spec/
+
+### Bundler / gem troubleshooting
+
+- make sure you've run the bundle command for both the app and test_app!
+- run bundle update <<gem name> (in the right place) for any gems that are causing issues
 
 ---
 
 ##Changelog
 
-- v.0.1.0 Initial deploy
+###Master branch (and part of the Rails 3.0 branch)
+- v.0.1.0 Initial commit
 - v.0.1.2 Fixing errors in collections (taken value[0] instead of index) and fixing test_app controller responses
 - v.0.1.3 Bug in Rails Helper. Key wrongly considered an Integer.
 - v.0.1.4 Adding two new parameters for further customization urlObject and nilValue and making input update on blur.
@@ -173,9 +378,23 @@ If the script is used with the Rails Gem no html tags will be allowed unless the
   of key ESCAPE for destroying changes before they are made permanent (in inputs and textarea).
 - v.0.1.6-0.1.7 Avoiding request when the input is not modified and allowing the user to not sanitize input data.
 - v.0.1.8 jslint compliant, sanitizing tags in the gem, getting right csrf params, controlling size of textarea (elastic script, for autogrowing textarea)
+- v.0.1.9 Adding elastic autogrowing textareas
+- v.1.0.0 Setting RSpec and Capybara up, and adding some utilities. Mantaining some HTML attributes. Fix a respond_with bug (thanks, @moabite). Triggering ajax:success when ajax call is complete (thanks, @indrekj). Setting up Travis CI. Updated for Rails 3.1.
+- v.1.0.1 Fixing a double initialization bug
+- v.1.0.2 New bip_area text helper to work with text areas.
+- v.1.0.3 replace apostrophes in collection with corresponding HTML entity,
+  thanks @taavo. Implemented `:display_as` option and adding
+  `respond_with_bip` to be used in the controller.
+
+###Rails 3.0 branch only
+- v.0.2.0 Added RSpec and Capybara setup, and some tests. Fix countries map syntax, Allowing href and some other HTML attributes. Adding Travis CI too. Added the best_in_place_if option. Added ajax:success trigger, thanks to @indrekj.
+- v.0.2.1 Fixing double initialization bug.
+- v.0.2.2 New bip_area text helper.
+
+---
 
 ##Authors, License and Stuff
 
 Code by [Bernat Farrero](http://bernatfarrero.com) from [Itnig Web Services](http://itnig.net) (it was based on the [original project](http://github.com/janv/rest_in_place/) of Jan Varwig) and released under [MIT license](http://www.opensource.org/licenses/mit-license.php).
 
-Many thanks to the contributors: [Roger Campos](http://github.com/rogercampos) and [Jack Senechal](https://github.com/jacksenechal)
+Many thanks to the contributors: [Roger Campos](http://github.com/rogercampos), [Jack Senechal](https://github.com/jacksenechal) and [Albert Bellonch](https://github.com/albertbellonch).

data/lib/assets/javascripts/best_in_place.js

@@ -31,8 +31,20 @@ BestInPlaceEditor.prototype = {
   // Public Interface Functions //////////////////////////////////////////////
 
   activate : function() {
+    var to_display = "";
+    if (this.isNil) {
+      to_display = "";
+    }
+    else if (this.original_content) {
+      to_display = this.original_content;
+    }
+    else {
+      to_display = this.element.html();
+    }
+
     var elem = this.isNil ? "" : this.element.html();
     this.oldValue = elem;
+    this.display_value = to_display;
     $(this.activator).unbind("click", this.clickHandler);
     this.activateForm();
   },
@@ -91,6 +103,7 @@ BestInPlaceEditor.prototype = {
       self.nil           = self.nil           || jQuery(this).attr("data-nil");
       self.inner_class   = self.inner_class   || jQuery(this).attr("data-inner-class");
       self.html_attrs    = self.html_attrs    || jQuery(this).attr("data-html-attrs");
+      self.original_content    = self.original_content    || jQuery(this).attr("data-original-content");
     });
 
     // Try Rails-id based if parents did not explicitly supply something
@@ -111,6 +124,7 @@ BestInPlaceEditor.prototype = {
     self.nil           = self.element.attr("data-nil")          || self.nil      || "-";
     self.inner_class   = self.element.attr("data-inner-class")  || self.inner_class   || null;
     self.html_attrs    = self.element.attr("data-html-attrs") || self.html_attrs;
+    self.original_content    = self.element.attr("data-original-content") || self.original_content;
 
     if (!self.element.attr("data-sanitize")) {
       self.sanitize = true;
@@ -177,7 +191,10 @@ BestInPlaceEditor.prototype = {
   // Handlers ////////////////////////////////////////////////////////////////
 
   loadSuccessCallback : function(data) {
-    this.element.html(data[this.objectName]);
+    var response = $.parseJSON($.trim(data));
+    if (response != null && response.hasOwnProperty("display_as")) {
+      this.element.html(response["display_as"]);
+    }
     this.element.trigger($.Event("ajax:success"), data);
 
     // Binding back after being clicked
@@ -216,7 +233,7 @@ BestInPlaceEditor.forms = {
   "input" : {
     activateForm : function() {
       var output = '<form class="form_in_place" action="javascript:void(0)" style="display:inline;">';
-      output += '<input type="text" name="'+ this.attributeName + '" value="' + this.sanitizeValue(this.oldValue) + '"';
+      output += '<input type="text" name="'+ this.attributeName + '" value="' + this.sanitizeValue(this.display_value) + '"';
       if (this.inner_class != null) {
         output += ' class="' + this.inner_class + '"';
       }
@@ -301,7 +318,7 @@ BestInPlaceEditor.forms = {
 
       // construct the form
       var output = '<form action="javascript:void(0)" style="display:inline;"><textarea>';
-      output += this.sanitizeValue(this.oldValue);
+      output += this.sanitizeValue(this.display_value);
       output += '</textarea></form>';
       this.element.html(output);
       this.setHtmlAttributes();

data/lib/best_in_place.rb

@@ -1,6 +1,8 @@
 require "best_in_place/utils"
 require "best_in_place/helper"
 require "best_in_place/engine"
+require "best_in_place/controller_extensions"
+require "best_in_place/display_methods"
 
 module BestInPlace
   autoload :TestHelpers, "best_in_place/test_helpers"

data/lib/best_in_place/controller_extensions.rb

@@ -0,0 +1,23 @@
+module BestInPlace
+  module ControllerExtensions
+    def respond_with_bip(obj)
+      obj.changed? ? respond_bip_error(obj) : respond_bip_ok(obj)
+    end
+
+  private
+    def respond_bip_ok(obj)
+      klass = obj.class.to_s
+      updating_attr = params[klass.underscore].keys.first
+
+      if renderer = BestInPlace::DisplayMethods.lookup(klass, updating_attr)
+        render :json => {:display_as => obj.send(renderer)}.to_json
+      else
+        head :ok
+      end
+    end
+
+    def respond_bip_error(obj)
+      render :json => obj.errors.full_messages, :status => :unprocessable_entity
+    end
+  end
+end

data/lib/best_in_place/display_methods.rb

@@ -0,0 +1,16 @@
+module BestInPlace
+  module DisplayMethods
+    extend self
+
+    @@table = Hash.new { |h,k| h[k] = Hash.new(&h.default_proc) }
+
+    def lookup(klass, attr)
+      foo = @@table[klass.to_s][attr.to_s]
+      foo == {} ? nil : foo
+    end
+
+    def add(klass, attr, display_as)
+      @@table[klass.to_s][attr.to_s] = display_as.to_sym
+    end
+  end
+end

data/lib/best_in_place/engine.rb

@@ -2,6 +2,7 @@ module BestInPlace
   class Engine < Rails::Engine
     initializer "setup for rails" do
       ActionView::Base.send(:include, BestInPlace::BestInPlaceHelpers)
+      ActionController::Base.send(:include, BestInPlace::ControllerExtensions)
     end
   end
 end

data/lib/best_in_place/helper.rb

@@ -5,7 +5,9 @@ module BestInPlace
       opts[:type] ||= :input
       opts[:collection] ||= []
       field = field.to_s
-      value = object.send(field).blank? ? "" : object.send(field)
+
+      value = build_value_for(object, field, opts)
+
       collection = nil
       if opts[:type] == :select && !opts[:collection].blank?
         v = object.send(field)
@@ -24,13 +26,14 @@ module BestInPlace
       out << " id='#{BestInPlace::Utils.build_best_in_place_id(object, field)}'"
       out << " data-url='#{opts[:path].blank? ? url_for(object).to_s : url_for(opts[:path])}'"
       out << " data-object='#{object.class.to_s.gsub("::", "_").underscore}'"
-      out << " data-collection='#{collection}'" unless collection.blank?
+      out << " data-collection='#{collection.gsub(/'/, "&#39;")}'" unless collection.blank?
       out << " data-attribute='#{field}'"
       out << " data-activator='#{opts[:activator]}'" unless opts[:activator].blank?
       out << " data-nil='#{opts[:nil].to_s}'" unless opts[:nil].blank?
       out << " data-type='#{opts[:type].to_s}'"
       out << " data-inner-class='#{opts[:inner_class].to_s}'" if opts[:inner_class]
       out << " data-html-attrs='#{opts[:html_attrs].to_json}'" unless opts[:html_attrs].blank?
+      out << " data-original-content='#{object.send(field)}'" if opts[:display_as]
       if !opts[:sanitize].nil? && !opts[:sanitize]
         out << " data-sanitize='false'>"
         out << sanitize(value.to_s, :tags => %w(b i u s a strong em p h1 h2 h3 h4 h5 ul li ol hr pre span img br), :attributes => %w(id class href))
@@ -45,7 +48,17 @@ module BestInPlace
       if condition
         best_in_place(object, field, opts)
       else
-        object.send field
+        build_value_for object, field, opts
+      end
+    end
+
+  private
+    def build_value_for(object, field, opts)
+      if opts[:display_as]
+        BestInPlace::DisplayMethods.add(object.class.to_s, field, opts[:display_as])
+        object.send(opts[:display_as]).to_s
+      else
+        object.send(field).blank? ? "" : object.send(field).to_s
       end
     end
   end

data/lib/best_in_place/version.rb

@@ -1,3 +1,3 @@
 module BestInPlace
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/helpers/best_in_place_spec.rb

@@ -123,6 +123,16 @@ describe BestInPlace::BestInPlaceHelpers do
         span = nk.css("span")
         span.attribute("data-activator").value.should == "awesome"
       end
+
+      describe "display_as" do
+        it "should render the address with a custom renderer" do
+          @user.should_receive(:address_format).and_return("the result")
+          out = helper.best_in_place @user, :address, :display_as => :address_format
+          nk = Nokogiri::HTML.parse(out)
+          span = nk.css("span")
+          span.text.should == "the result"
+        end
+      end
     end
 
 
@@ -199,6 +209,18 @@ describe BestInPlace::BestInPlaceHelpers do
       it "should show the current country" do
         @span.text.should == "Italy"
       end
+
+      context "with an apostrophe in it" do
+        before do
+          @apostrophe_countries = [[1, "Joe's Country"], [2, "Bob's Country"]]
+          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, :type => :select, :collection => @apostrophe_countries)
+          @span = nk.css("span")
+        end
+
+        it "should have a proper data collection" do
+          @span.attribute("data-collection").value.should == @apostrophe_countries.to_json
+        end
+      end
     end
   end
 
@@ -208,7 +230,7 @@ describe BestInPlace::BestInPlaceHelpers do
         @output = "Some Value"
         @field = :somefield
         @object = mock("object", @field => @output)
-        @options = mock("options")
+        @options = {}
       end
       context "when the condition is true" do
         before {@condition = true}

data/spec/integration/js_spec.rb

@@ -161,5 +161,51 @@ describe "JS behaviour", :js => true do
       page.should have_content("Another")
     end
   end
+
+  describe "display_as" do
+    it "should render the address with a custom format" do
+      @user.save!
+      visit user_path(@user)
+
+      within("#address") do
+        page.should have_content("addr => [Via Roma 99]")
+      end
+    end
+
+    it "should still show the custom format after an error" do
+      @user.save!
+      visit user_path(@user)
+
+      bip_text @user, :address, "inva"
+
+      within("#address") do
+        page.should have_content("addr => [Via Roma 99]")
+      end
+    end
+
+    it "should show the new result with the custom format after an update" do
+      @user.save!
+      visit user_path(@user)
+
+      bip_text @user, :address, "New address"
+
+      within("#address") do
+        page.should have_content("addr => [New address]")
+      end
+    end
+
+    it "should display the original content when editing the form" do
+      @user.save!
+      visit user_path(@user)
+
+      id = BestInPlace::Utils.build_best_in_place_id @user, :address
+      page.execute_script <<-JS
+        $("##{id}").click();
+      JS
+
+      text = page.find("##{id} input").value
+      text.should == "Via Roma 99"
+    end
+  end
 end
 

data/test_app/Gemfile

@@ -7,6 +7,8 @@ gem 'best_in_place', :path => ".."
 
 gem 'jquery-rails'
 
+gem 'rdiscount'
+
 group :assets do
   gem 'sass-rails',   '~> 3.1.4'
   gem 'coffee-rails', '~> 3.1.1'

data/test_app/app/controllers/users_controller.rb

@@ -69,10 +69,10 @@ class UsersController < ApplicationController
     respond_to do |format|
       if @user.update_attributes(params[:user])
         format.html { redirect_to(@user, :notice => 'User was successfully updated.') }
-        format.json { head :ok }
+        format.json { respond_with_bip(@user) }
       else
         format.html { render :action => "edit" }
-        format.json  { render :json => @user.errors.full_messages, :status => :unprocessable_entity }
+        format.json { respond_with_bip(@user) }
       end
     end
   end

data/test_app/app/models/user.rb

@@ -12,4 +12,12 @@ class User < ActiveRecord::Base
     :presence => {:message => "can't be blank"},
     :format => {:with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :message => "has wrong email format"}
   validates :zip, :numericality => true, :length => { :minimum => 5 }
-end
+
+  def address_format
+    "<b>addr => [#{address}]</b>".html_safe
+  end
+
+  def markdown_desc
+    RDiscount.new(description).to_html.html_safe
+  end
+end

data/test_app/app/views/users/show.html.erb

@@ -25,7 +25,7 @@
     <tr>
       <td>Address</td>
       <td id="address">
-        <%= best_in_place @user, :address %>
+        <%= best_in_place @user, :address, :display_as => :address_format %>
       </td>
     </tr>
     <tr>
@@ -49,7 +49,7 @@
     <tr>
       <td>User description</td>
       <td id="description">
-        <%= best_in_place @user, :description, :type => :textarea, :sanitize => false %>
+        <%= best_in_place @user, :description, :display_as => :markdown_desc, :type => :textarea, :sanitize => false %>
       </td>
   </table>
   <br />

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: best_in_place
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-07 00:00:00.000000000 Z
+date: 2011-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &84323650 !ruby/object:Gem::Requirement
+  requirement: &12601240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *84323650
+  version_requirements: *12601240
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &84320540 !ruby/object:Gem::Requirement
+  requirement: &12616680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *84320540
+  version_requirements: *12616680
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &84319130 !ruby/object:Gem::Requirement
+  requirement: &12615660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *84319130
+  version_requirements: *12615660
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &84346000 !ruby/object:Gem::Requirement
+  requirement: &12614960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.5.0
   type: :development
   prerelease: false
-  version_requirements: *84346000
+  version_requirements: *12614960
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &84344990 !ruby/object:Gem::Requirement
+  requirement: &12614300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *84344990
+  version_requirements: *12614300
 description: BestInPlace is a jQuery script and a Rails 3 helper that provide the
   method best_in_place to display any object field easily editable for the user by
   just clicking on it. It supports input data, text data, boolean data and custom
@@ -86,6 +86,8 @@ files:
 - lib/assets/javascripts/best_in_place.js
 - lib/assets/javascripts/jquery.purr.js
 - lib/best_in_place.rb
+- lib/best_in_place/controller_extensions.rb
+- lib/best_in_place/display_methods.rb
 - lib/best_in_place/engine.rb
 - lib/best_in_place/helper.rb
 - lib/best_in_place/test_helpers.rb
@@ -167,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 38414223
+      hash: 1789915415382083168
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -176,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 38414223
+      hash: 1789915415382083168
 requirements: []
 rubyforge_project: best_in_place
 rubygems_version: 1.8.10