best_in_place 1.0.3 → 1.0.4

data/.travis.yml

@@ -1,6 +1,5 @@
 rvm:
   - 1.8.7
-  - ree
   - 1.9.2
   - 1.9.3
 

data/README.md

@@ -21,6 +21,7 @@ The editor works by PUTting the updated value to the server and GETting the upda
 - Compatible with **textarea**
 - Compatible with **select** dropdown with custom collections
 - Compatible with custom boolean values (same usage of **checkboxes**)
+- Compatible with **jQuery UI Datepickers**
 - Sanitize HTML and trim spaces of user's input on user's choice
 - Displays server-side **validation** errors
 - Allows external activator
@@ -28,7 +29,8 @@ The editor works by PUTting the updated value to the server and GETting the upda
 - 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
+- Custom display methods using a method from your model or an existing rails
+  view helper
 
 ##Usage of Rails 3 Gem
 
@@ -42,7 +44,7 @@ Params:
 
 Options:
 
-- **:type** It can be only [:input, :textarea, :select, :checkbox] or if undefined it defaults to :input.
+- **:type** It can be only [:input, :textarea, :select, :checkbox, :date] or if undefined it defaults to :input.
 - **:collection**: In case you are using the :select type then you must specify the collection of values it takes. In case you are
   using the :checkbox type you can specify the two values it can take, or otherwise they will default to Yes and No.
 - **:path**: URL to which the updating action will be sent. If not defined it defaults to the :object path.
@@ -66,7 +68,7 @@ condition, is satisfied. Specifically:
 
 Say we have something like
 
-    <%= best_in_place condition, @user, :name, :type => :input %>
+    <%= best_in_place_if condition, @user, :name, :type => :input %>
 
 In case *condition* is satisfied, the outcome will be just the same as:
 
@@ -109,48 +111,41 @@ The key can be a string or an integer.
 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.
 
-## Controller response and respond_with_bip
+### Date
 
-Your controller should respond to json as it's the format used by best in
-place javascript. A simple example would be:
+    <%= best_in_place @user, :birth_date, :type => :date %>
 
-    class UserController < ApplicationController
-      def update
-        @user = User.find(params[:id])
+With the :date type the input field will be initialized as a datepicker input.
+In order to provide custom options to the datepicker initialization you must
+prepare a `$.datepicker.setDefaults` call with the preferences of your choice.
 
-        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
+More information about datepicker and setting defaults can be found
+[here](http://docs.jquery.com/UI/Datepicker/$.datepicker.setDefaults)
+
+## Controller response with respond_with_bip
+
+Best in place provides a utility method you should use in your controller in
+order to provide the response that is expected by the javascript side, using
+the :json format. This is a simple example showing an update action using it:
+
+    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 { respond_with_bip(@user) }
+        else
+          format.html { render :action => "edit" }
+          format.json { respond_with_bip(@user) }
         end
       end
     end
 
-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.
+## Custom display methods
 
-##Using custom display methods
+### Using `display_as`
 
 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:
@@ -159,17 +154,21 @@ decide how a certain field has to be displayed. You can write something like:
 
 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...
+custom formatting, text with markdown, 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.
+### Using `display_with`
 
-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.
+In practice the most common situation is when you want to use an existing
+helper to render the attribute, like `number_to_currency` or `simple_format`.
+As of version 1.0.4 best in place provides this feature using the
+`display_with` option. You can use it like this:
+
+    = best_in_place @user, :money, :display_with => :number_to_currency
+
+If you want to pass further arguments to the helper you can do it providing an
+additional `helper_options` hash:
+
+    = best_in_place @user, :money, :display_with => :number_to_currency, :helper_options => {:unit => "€"}
 
 
 ##Non Active Record environments
@@ -277,12 +276,17 @@ thanks to Rails 3.1. Just begin including the gem in your Gemfile:
     gem "best_in_place"
 
 After that, specify the use of the jquery, jquery.purr and best in place
-javascripts in your application.js:
+javascripts in your application.js, and optionally specify jquery-ui if
+you want to use jQuery UI datepickers:
 
     //= require jquery
+    //= require jquery-ui
     //= require jquery.purr
     //= require best_in_place
 
+If you want to use jQuery UI datepickers, you should also install and
+load your preferred jquery-ui CSS file and associated assets.
+
 Then, just add a binding to prepare all best in place fields when the document is ready:
 
     $(document).ready(function() {
@@ -315,6 +319,10 @@ You can automatize this installation by doing
 
     rails g best_in_place:setup
 
+If you want to use jQuery UI datepickers, you should also install and
+load jquery-ui.js as well as your preferred jquery-ui CSS file and
+associated assets.
+
 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() {

data/lib/assets/javascripts/best_in_place.js

@@ -83,6 +83,7 @@ BestInPlaceEditor.prototype = {
     } else {
       editor.element.html(this.getValue() != "" ? this.getValue() : this.nil);
     }
+    editor.element.trigger($.Event("best_in_place:update"));
   },
 
   activateForm : function() {
@@ -193,6 +194,8 @@ BestInPlaceEditor.prototype = {
   loadSuccessCallback : function(data) {
     var response = $.parseJSON($.trim(data));
     if (response != null && response.hasOwnProperty("display_as")) {
+      this.element.attr("data-original-content", this.element.html());
+      this.original_content = this.element.html();
       this.element.html(response["display_as"]);
     }
     this.element.trigger($.Event("ajax:success"), data);
@@ -265,6 +268,45 @@ BestInPlaceEditor.forms = {
     }
   },
 
+  "date" : {
+    activateForm : function() {
+      var that = this,
+        output = '<form class="form_in_place" action="javascript:void(0)" style="display:inline;">';
+      output += '<input type="text" name="'+ this.attributeName + '" value="' + this.sanitizeValue(this.display_value) + '"';
+      if (this.inner_class != null) {
+        output += ' class="' + this.inner_class + '"';
+      }
+      output += '></form>'
+      this.element.html(output);
+      this.setHtmlAttributes();
+      this.element.find('input')[0].select();
+      this.element.find("form").bind('submit', {editor: this}, BestInPlaceEditor.forms.input.submitHandler);
+      this.element.find("input").bind('keyup', {editor: this}, BestInPlaceEditor.forms.input.keyupHandler);
+
+      this.element.find('input')
+        .datepicker({
+            onClose: function() {
+              that.update();
+            }
+          })
+        .datepicker('show');
+    },
+
+    getValue :  function() {
+      return this.sanitizeValue(this.element.find("input").val());
+    },
+
+    submitHandler : function(event) {
+      event.data.editor.update();
+    },
+
+    keyupHandler : function(event) {
+      if (event.keyCode == 27) {
+        event.data.editor.abort();
+      }
+    }
+  },
+
   "select" : {
     activateForm : function() {
       var output = "<form action='javascript:void(0)' style='display:inline;'><select>";

data/lib/best_in_place.rb

@@ -6,4 +6,8 @@ require "best_in_place/display_methods"
 
 module BestInPlace
   autoload :TestHelpers, "best_in_place/test_helpers"
+
+  module ViewHelpers
+    extend ActionView::Helpers
+  end
 end

data/lib/best_in_place/controller_extensions.rb

@@ -10,7 +10,7 @@ module BestInPlace
       updating_attr = params[klass.underscore].keys.first
 
       if renderer = BestInPlace::DisplayMethods.lookup(klass, updating_attr)
-        render :json => {:display_as => obj.send(renderer)}.to_json
+        render :json => renderer.render_json(obj)
       else
         head :ok
       end

data/lib/best_in_place/display_methods.rb

@@ -2,6 +2,24 @@ module BestInPlace
   module DisplayMethods
     extend self
 
+    class Renderer < Struct.new(:opts)
+      def render_json(object)
+        case opts[:type]
+        when :model
+          {:display_as => object.send(opts[:method])}.to_json
+        when :helper
+          value = if opts[:helper_options]
+                    BestInPlace::ViewHelpers.send(opts[:method], object.send(opts[:attr]), opts[:helper_options])
+                  else
+                    BestInPlace::ViewHelpers.send(opts[:method], object.send(opts[:attr]))
+                  end
+          {:display_as => value}.to_json
+        else
+          {}.to_json
+        end
+      end
+    end
+
     @@table = Hash.new { |h,k| h[k] = Hash.new(&h.default_proc) }
 
     def lookup(klass, attr)
@@ -9,8 +27,12 @@ module BestInPlace
       foo == {} ? nil : foo
     end
 
-    def add(klass, attr, display_as)
-      @@table[klass.to_s][attr.to_s] = display_as.to_sym
+    def add_model_method(klass, attr, display_as)
+      @@table[klass.to_s][attr.to_s] = Renderer.new :method => display_as.to_sym, :type => :model
+    end
+
+    def add_helper_method(klass, attr, helper_method, helper_options = nil)
+      @@table[klass.to_s][attr.to_s] = Renderer.new :method => helper_method.to_sym, :type => :helper, :attr => attr, :helper_options => helper_options
     end
   end
 end

data/lib/best_in_place/helper.rb

@@ -2,6 +2,14 @@ module BestInPlace
   module BestInPlaceHelpers
 
     def best_in_place(object, field, opts = {})
+      if opts[:display_as] && opts[:display_with]
+        raise ArgumentError, "Can't use both 'display_as' and 'display_with' options at the same time"
+      end
+
+      if opts[:display_with] && !ViewHelpers.respond_to?(opts[:display_with])
+        raise ArgumentError, "Can't find helper #{opts[:display_with]}"
+      end
+
       opts[:type] ||= :input
       opts[:collection] ||= []
       field = field.to_s
@@ -24,21 +32,21 @@ module BestInPlace
       end
       out = "<span class='best_in_place'"
       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-url='#{opts[:path].blank? ? url_for(object) : url_for(opts[:path])}'"
       out << " data-object='#{object.class.to_s.gsub("::", "_").underscore}'"
       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-nil='#{opts[:nil]}'" unless opts[:nil].blank?
+      out << " data-type='#{opts[:type]}'"
+      out << " data-inner-class='#{opts[:inner_class]}'" 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]
+      out << " data-original-content='#{object.send(field)}'" if opts[:display_as] || opts[:display_with]
       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))
+        out << sanitize(value, :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))
       else
-        out << ">#{sanitize(value.to_s, :tags => nil, :attributes => nil)}"
+        out << ">#{sanitize(value, :tags => nil, :attributes => nil)}"
       end
       out << "</span>"
       raw out
@@ -55,10 +63,19 @@ module BestInPlace
   private
     def build_value_for(object, field, opts)
       if opts[:display_as]
-        BestInPlace::DisplayMethods.add(object.class.to_s, field, opts[:display_as])
+        BestInPlace::DisplayMethods.add_model_method(object.class.to_s, field, opts[:display_as])
         object.send(opts[:display_as]).to_s
+
+      elsif opts[:display_with]
+        BestInPlace::DisplayMethods.add_helper_method(object.class.to_s, field, opts[:display_with], opts[:helper_options])
+        if opts[:helper_options]
+          BestInPlace::ViewHelpers.send(opts[:display_with], object.send(field), opts[:helper_options])
+        else
+          BestInPlace::ViewHelpers.send(opts[:display_with], object.send(field))
+        end
+
       else
-        object.send(field).blank? ? "" : object.send(field).to_s
+        object.send(field).to_s.presence || ""
       end
     end
   end

data/lib/best_in_place/utils.rb

@@ -7,7 +7,7 @@ module BestInPlace
       end
 
       id = "best_in_place_#{object.class.to_s.demodulize.underscore}"
-      id << "_#{object.id}" if object.class.ancestors.include?(ActiveRecord::Base)
+      id << "_#{object.id}" if object.class.ancestors.include?(ActiveModel::Serializers::JSON)
       id << "_#{field}"
       id
     end

data/lib/best_in_place/version.rb

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

data/spec/helpers/best_in_place_spec.rb

@@ -11,7 +11,9 @@ describe BestInPlace::BestInPlaceHelpers do
         :zip => "25123",
         :country => "2",
         :receive_email => false,
-        :description => "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus a lectus et lacus ultrices auctor. Morbi aliquet convallis tincidunt. Praesent enim libero, iaculis at commodo nec, fermentum a dolor. Quisque eget eros id felis lacinia faucibus feugiat et ante. Aenean justo nisi, aliquam vel egestas vel, porta in ligula. Etiam molestie, lacus eget tincidunt accumsan, elit justo rhoncus urna, nec pretium neque mi et lorem. Aliquam posuere, dolor quis pulvinar luctus, felis dolor tincidunt leo, eget pretium orci purus ac nibh. Ut enim sem, suscipit ac elementum vitae, sodales vel sem."
+        :birth_date => Time.now.utc.to_date,
+        :description => "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus a lectus et lacus ultrices auctor. Morbi aliquet convallis tincidunt. Praesent enim libero, iaculis at commodo nec, fermentum a dolor. Quisque eget eros id felis lacinia faucibus feugiat et ante. Aenean justo nisi, aliquam vel egestas vel, porta in ligula. Etiam molestie, lacus eget tincidunt accumsan, elit justo rhoncus urna, nec pretium neque mi et lorem. Aliquam posuere, dolor quis pulvinar luctus, felis dolor tincidunt leo, eget pretium orci purus ac nibh. Ut enim sem, suscipit ac elementum vitae, sodales vel sem.",
+        :money => 150
     end
 
     it "should generate a proper span" do
@@ -20,6 +22,10 @@ describe BestInPlace::BestInPlaceHelpers do
       span.should_not be_empty
     end
 
+    it "should not allow both display_as and display_with option" do
+      lambda { helper.best_in_place(@user, :money, :display_with => :number_to_currency, :display_as => :custom) }.should raise_error(ArgumentError)
+    end
+
     describe "general properties" do
       before do
         nk = Nokogiri::HTML.parse(helper.best_in_place @user, :name)
@@ -133,6 +139,26 @@ describe BestInPlace::BestInPlaceHelpers do
           span.text.should == "the result"
         end
       end
+
+      describe "display_with" do
+        it "should render the money with the given view helper" do
+          out = helper.best_in_place @user, :money, :display_with => :number_to_currency
+          nk = Nokogiri::HTML.parse(out)
+          span = nk.css("span")
+          span.text.should == "$150.00"
+        end
+
+        it "should raise an error if the given helper can't be found" do
+          lambda { helper.best_in_place @user, :money, :display_with => :fk_number_to_currency }.should raise_error(ArgumentError)
+        end
+
+        it "should call the helper method with the given arguments" do
+          out = helper.best_in_place @user, :money, :display_with => :number_to_currency, :helper_options => {:unit => "º"}
+          nk = Nokogiri::HTML.parse(out)
+          span = nk.css("span")
+          span.text.should == "º150.00"
+        end
+      end
     end
 
 
@@ -155,6 +181,25 @@ describe BestInPlace::BestInPlaceHelpers do
       end
     end
 
+    context "with a date attribute" do
+      before do
+        nk = Nokogiri::HTML.parse(helper.best_in_place @user, :birth_date, :type => :date)
+        @span = nk.css("span")
+      end
+
+      it "should render the date as text" do
+        @span.text.should == @user.birth_date.to_date.to_s
+      end
+
+      it "should have a date data-type" do
+        @span.attribute("data-type").value.should == "date"
+      end
+
+      it "should have no data-collection" do
+        @span.attribute("data-collection").should be_nil
+      end
+    end
+
     context "with a boolean attribute" do
       before do
         nk = Nokogiri::HTML.parse(helper.best_in_place @user, :receive_email, :type => :checkbox)