best_in_placeish 0.2.4 → 0.2.5

data/.gitignore

@@ -1,11 +1,12 @@
-.DS_Store
-.bundle
-pkg/*
-
-Gemfile.lock
-test_app/.bundle
-test_app/db/*.sqlite3
-test_app/log/*.log
-test_app/tmp/**/*
-
-.rvmrc
+.DS_Store
+.bundle
+pkg/*
+*.gem
+
+Gemfile.lock
+test_app/.bundle
+test_app/db/*.sqlite3
+test_app/log/*.log
+test_app/tmp/**/*
+
+.rvmrc

data/.rspec

@@ -1 +1 @@
---colour
+--colour

data/Gemfile

@@ -1,6 +1,6 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in best_in_place.gemspec
-gemspec
-
-gem 'sqlite3-ruby', :require => 'sqlite3'
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in best_in_place.gemspec
+gemspec
+
+gem 'sqlite3-ruby', :require => 'sqlite3'

data/README.md

@@ -1,195 +1,212 @@
-# Best In Placeish
-Forked from the rails-3.0 branch of best_in_place, this includes a couple of key enhancements for Rails 3.0.x users
-
-**Additional features not found in best_in_place-0.2.2:**
-
-- Integrated **:display_as** functionality from master branch of best_in_place
-- Added purr notifications for successful updates (see updated usage notes for example)
-
-Most of the read-me below is a direct copy of best_in_place's read-me, as the vast majority of the usage is the same, though the added features are also noted below.
-
-
-##Description
-
-**Best in Place** is a jQuery based AJAX Inplace-Editor that takes profit of RESTful server-side controllers to allow users to edit stuff with
-no need of forms. If the server has standard defined REST methods, particularly those to UPDATE your objects (HTTP PUT), adding the
-Javascript file to the application will make all the fields with the proper defined classes in-place editable.
-
-The editor works by PUTting the updated value to the server and GETting the updated record afterwards to display the updated value.
-
----
-
-##Features
-
-- Compatible with text **inputs**
-- Compatible with **textarea**
-- Compatible with **select** dropdown with custom collections
-- Compatible with custom boolean values (same usage of **checkboxes**)
-- Sanitize HTML and trim spaces of user's input on user's choice
-- Displays server-side **validation** errors
-- Allows external activator
-- ESC key destroys changes (requires user confirmation)
-- Autogrowing textarea
-
----
-
-##Usage of Rails 3 Gem
-
-**best_in_placeish object, field, OPTIONS**
-
-Params:
-
-- **object** (Mandatory): The Object parameter represents the object you are about to modify
-- **field** (Mandatory): The field (passed as symbol) is the attribute of the Object you are going to display/edit.
-
-Options:
-
-- **:type** Accepts [:input, :textarea, :select, :checkbox] or if undefined it defaults to :input.
-- **:collection**: In case you are using the :select type then you must specify the collection of values to select from. If you are
-  using the :checkbox type you can specify the two values it can take, otherwise it 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.
-- **:nil**: The nil param defines the content displayed in case no value is defined for that field. It can be something like "click me to edit".
-  If undefined it will show *"-"*.
-- **:activator**: The DOM object that can activate the field. If not defined the field will become 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.
-- **:display_as**: A model method which will be called in order to display this field.
-
-
-Examples (code in the views):
-
-### Input
-
-    <%= best_in_placeish @user, :name, :type => :input %>
-
-    <%= best_in_placeish @user, :name, :type => :input, :nil => "Click me to add content!" %>
-
-### Textarea
-
-    <%= best_in_placeish @user, :description, :type => :textarea %>
-
-### Select
-
-    <%= best_in_placeish @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],...].
-The key can be a string or an integer.
-
-### Checkbox
-
-    <%= best_in_placeish @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"].
-If not defined, it will default to *Yes* and *No* options.
-
-### Display server validation errors
-
-If you are using a Rails application, your controllers should respond to json. **best_in_placeish adds an additional step here, requiring a hash containing your success message to be displayed using Purr.**
-Example:
-  Class UsersController
-    respond_to :html, :json
-  
-    def update
-    @user = User.find(params[:id])
-    respond_with(@user) do |format|
-      if @user.update_attributes(params[:user])
-        format.html { redirect_to(@user) }
-        format.json { render :json => { :success=>"User was successfully updated." }, :status => :ok }
-      else
-        format.html { render :action => "edit" }
-        format.json { render :json => @user.errors.full_messages, :status => :unprocessable_entity }
-      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 }
-    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.
-
----
-
-## Custom display methods
-
-### Using `display_as`
-
-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_placeish @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, etc...
-
-##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:
-
-- jquery-1.4.4.js
-- jquery.purr.js
-- **best_in_placeish.js**
-
-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).
-
-    rails g best_in_placeish:setup
-
-To be able to use the script the following block must be added as well:
-
-    $(document).ready(function() {
-      /* Activating Best In Place */
-      jQuery(".best_in_placeish").best_in_placeish()
-    });
-
-In order to use the Rails 3 gem, just add the following line to the gemfile:
-
-    gem "best_in_placeish"
-
-----
-
-## Security
-
-If the script is used with the Rails Gem no html tags will be allowed unless the sanitize option is set to true, in that case only the tags [*b i u s a strong em p h1 h2 h3 h4 h5 ul li ol hr pre span img*] will be allowed. If the script is used without the gem and with frameworks other than Rails, then you should make sure you are providing the csrf authenticity params as meta tags and you should always escape undesired html tags such as script, object and so forth.
-
-    <meta name="csrf-param" content="authenticity_token"/>
-    <meta name="csrf-token" content="YOUR UNIQUE TOKEN HERE"/>
-
-
----
-
-##Changelog
-
-- v.0.1.0 Initial deploy
-- 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.
-- v.0.1.5 **Attention: this release is not backwards compatible**. Changing params from list to option hash, helper's refactoring,
-  fixing bug with objects inside namespaces, adding feature for passing an external activator handler as param. Adding feature
-  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)
-
-##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)
+# Best In Placeish
+Forked from the rails-3.0 branch of best_in_place, this includes a couple of key enhancements for Rails 3.0.x users
+
+**Additional features not found in best_in_place-0.2.2:**
+
+- Integrated **:display_as** functionality from master branch of best_in_place
+- Added purr notifications for successful updates (see updated usage notes for example)
+
+Most of the read-me below is a direct copy of best_in_place's read-me, as the vast majority of the usage is the same, though the added features are also noted below.
+
+
+##Description
+
+**Best in Placeish** is a jQuery based AJAX Inplace-Editor that takes profit of RESTful server-side controllers to allow users to edit content without using a form. If the server has standard defined REST methods, particularly those to UPDATE your objects (HTTP PUT), adding the
+Javascript file to the application will make all the fields with the proper classes in-place editable.
+
+The editor works by PUTting the updated value to the server and GETting the updated record afterwards to display the updated value.
+
+---
+
+##Features
+
+- Compatible with text **inputs**
+- Compatible with **textarea**
+- Compatible with **select** dropdown with custom collections
+- Compatible with custom boolean values (same usage of **checkboxes**)
+- Sanitize HTML and trim spaces of user's input on user's choice
+- Displays server-side **validation** errors
+- Allows external activator
+- ESC key destroys changes (requires user confirmation)
+- Autogrowing textarea
+
+---
+
+##Usage of Rails 3 Gem
+
+**best_in_placeish object, field, OPTIONS**
+
+Params:
+
+- **object** (required): The Object parameter represents the object you are about to modify
+- **field** (required): The field (passed as symbol) is the attribute of the Object you are going to display/edit.
+
+Options:
+
+- **:type** Accepts [:input, :textarea, :select, :checkbox] or if undefined it defaults to :input.
+- **:collection**: In case you are using the :select type then you must specify the collection of values to select from. If you are
+  using the :checkbox type you can specify the two values it can take, otherwise it 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.
+- **:nil**: The nil param defines the content displayed in case no value is defined for that field. It can be something like "click me to edit".
+  If undefined it will show *"-"*.
+- **:activator**: The DOM object that can activate the field. If not defined the field will become 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.
+- **:display_as**: A model method which will be called in order to display this field.
+
+
+Examples (code in the views):
+
+### Input
+
+    <%= best_in_placeish @user, :name, :type => :input %>
+
+    <%= best_in_placeish @user, :name, :type => :input, :nil => "Click me to add content!" %>
+    
+### Datepicker (REQUIRES JQUERYUI - http://jqueryui.com/)
+
+    <%= best_in_placeish @user, :registered_on, :type => :datepicker %>
+    
+Currently returns the selected date in dd/MMM/yyyy format (for example: 01/JAN/2012)
+
+### Textarea
+
+    <%= best_in_placeish @user, :description, :type => :textarea %>
+
+### Select
+
+    <%= best_in_placeish @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],...].
+The key can be a string or an integer.
+
+### Checkbox
+
+    <%= best_in_placeish @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"].
+If not defined, it will default to *Yes* and *No* options.
+
+### Display server validation errors
+
+If you are using a Rails application, your controllers should respond to json. **best_in_placeish adds an additional step here, requiring a hash containing your success message to be displayed using Purr.**
+Example:
+
+    Class UsersController
+    
+      respond_to :html, :json
+    
+      def update
+      @user = User.find(params[:id])
+      respond_with(@user) do |format|
+        if @user.update_attributes(params[:user])
+          format.html { redirect_to(@user) }
+          format.json { render :json => { :success=>"User was successfully updated." }, :status => :ok }
+        else
+          format.html { render :action => "edit" }
+          format.json { render :json => @user.errors.full_messages, :status => :unprocessable_entity }
+        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 }
+      
+    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.
+
+---
+
+## Custom display methods
+
+### Using `display_as`
+
+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_placeish @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, etc...
+
+##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:
+
+- jquery-1.4.4.js
+- jquery.purr.js
+- **best_in_placeish.js**
+
+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).
+
+    rails g best_in_placeish:setup
+
+To be able to use the script the following block must be added as well:
+
+    $(document).ready(function() {
+      jQuery(".best_in_placeish").best_in_placeish()
+    });
+
+In order to use the Rails 3 gem, just add the following line to the gemfile:
+
+    gem "best_in_placeish"
+
+----
+
+## Security
+
+If the script is used with the Rails Gem no html tags will be allowed unless the sanitize option is set to true, in that case only the tags [*b i u s a strong em p h1 h2 h3 h4 h5 ul li ol hr pre span img*] will be allowed. If the script is used without the gem and with frameworks other than Rails, then you should make sure you are providing the csrf authenticity params as meta tags and you should always escape undesired html tags such as script, object and so forth.
+
+    <meta name="csrf-param" content="authenticity_token"/>
+    <meta name="csrf-token" content="YOUR UNIQUE TOKEN HERE"/>
+
+
+---
+
+##Changelog
+
+best_in_place:
+
+- v.0.1.0 Initial deploy
+- 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.
+- v.0.1.5 **Attention: this release is not backwards compatible**. Changing params from list to option hash, helper's refactoring,
+  fixing bug with objects inside namespaces, adding feature for passing an external activator handler as param. Adding feature
+  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.2.2 last rails 3.0.x version according to best_in_place project page
+
+best_in_placeish:
+
+- v.0.2.4 first best_in_placeish release, added success messaging and :display_as functions
+
+##Authors, License and Stuff
+
+Original best_in_place 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).
+
+best_in_place contributors: [Roger Campos](http://github.com/rogercampos) and [Jack Senechal](https://github.com/jacksenechal)
+
+best_in_placeish-specific code by [Miles Roberts](http://github.com/MilesRoberts)

data/Rakefile

@@ -1,8 +1,8 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec