best_in_place 2.1.0 → 3.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd401a2aea2b0d9e1343cab79428b35ccf33074d
+  data.tar.gz: 1006cddfe9686ff779a3542992a1805f7564d009
+SHA512:
+  metadata.gz: efa269229efb9b0a27b31120bdc87322d869a1cf9b8542fb3341bd7c7d6c52c4c5f1542738e29233f9b90b717e987b010c5b003221e8b2de093283f925975a34
+  data.tar.gz: fa3ef98b427393d8b2d7efc58a8881761baca55a0816e3eb821d8a2015840b79c81f525e8b536064fe54a24159746f894f44396c5c7090969d776e193cf49ddd

data/.gitignore

@@ -1,11 +1,13 @@
 .DS_Store
 .bundle
+.idea
 pkg/*
 
-Gemfile.lock
-test_app/.bundle
-test_app/db/*.sqlite3
-test_app/log/*.log
-test_app/tmp/**/*
+*.lock
+spec/internal/.bundle
+spec/internal/db/*.sqlite3
+spec/internal/log/*.log
+spec/internal/tmp/**/*
 
 .rvmrc
+coverage

data/.rspec

@@ -1 +1,2 @@
 --colour
+--require rails_helper

data/.travis.yml

@@ -1,13 +1,20 @@
+language: ruby
 rvm:
   - 1.9.3
+  - 2.1.2
+  - rbx-2
 
 env: "RAILS_ENV=test DISPLAY=:99.0"
+gemfile:
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_edge.gemfile
 
 before_script:
-  - "sh -c 'cd test_app && bundle && bundle exec rake db:drop db:migrate'"
   - "sh -e /etc/init.d/xvfb start"
 
-branches:
-  only:
-    - master
-    - rails-3.0
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/rails_edge.gemfile
+    - rvm: rbx-2

data/Appraisals

@@ -0,0 +1,17 @@
+appraise "rails-3.2" do
+  gem 'rails', '3.2.19'
+  gem 'strong_parameters'
+end
+
+appraise "rails-4.0" do
+  gem "rails", "~> 4.0.0"
+end
+
+appraise "rails-4.1" do
+  gem "rails", "~> 4.1.0"
+end
+
+appraise "rails-edge" do
+  gem "rails", github: "rails/rails"
+  gem 'arel', github: 'rails/arel'
+end

data/CHANGELOG.md

@@ -1,36 +1,57 @@
 #Changelog
 
-##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.
-- 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.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.
-- v.1.0.4 Depend on ActiveModel instead of ActiveRecord (thanks,
-  @skinnyfit). Added date type (thanks @taavo). Added new feature:
-display_with.
-- v.1.0.5 Fix a bug involving quotes (thanks @ygoldshtrakh). Minor fixes
-  by @bfalling. Add object name option (thanks @nicholassm). Check
-version of Rails before booting. Minor fixes.
-- v.1.0.6 Fix issue with display_with. Update test_app to 3.2.
+- v.3.0.0 :
+  - Expect syntax for spec
+  - Deprecated option[:path] in favor of option[:url]
+  - Deprecated option[:nil] in favor of option[:place_holder]
+  - Deprecated option[:classes] in favor of option[:class]
+  - Deprecated opts[:object_name] in favor of option[:as]
+  - Deprecated opts[:use_confirm] in favor of option[:confirm]
+  - Deprecated Elastic jQuery plugin in favor of jQuery Autosize
+  - Fixed bug in jquery.purr
+  - Support all supported version of actionpack/rails
+  - Dropped dependency on jquery gem
+  - Namespaced all data attributes to avoid conflict.
+  - Jquery-ui datepicker was extracted to best_in_place.jquery-ui.js 
+  - Added BestInPlaceEditor.defaults
+  - Deprecated opts[:sanitize] in favor of option[:raw]
+  - You have to require jquery.purr  before best_in_place.purr 
+  - You have to require jquery-ui.datepicker  before best_in_place.jquery-ui 
+  - Added opts[:value] to set custom original-value
+  - You can override the default container
+  
+- v.2x : glitch in the Matrix
+
 - v.1.1.0 Changed $ by jQuery for compatibility (thanks @tschmitz), new
   events for 'deactivate' (thanks @glebtv), added new 'data' attribute
-to BIP's span (thanks @straydogstudio), works with dynamically added
-elements to the page (thanks @enriclluelles), added object detection to
-the 'path' parameter and some more bugfixes.
+  the 'path' parameter and some more bugfixes.
+  elements to the page (thanks @enriclluelles), added object detection to
+  to BIP's span (thanks @straydogstudio), works with dynamically added
+- v.1.0.6 Fix issue with display_with. Update test_app to 3.2.
+- v.1.0.5 Fix a bug involving quotes (thanks @ygoldshtrakh). Minor fixes
+version of Rails before booting. Minor fixes.
+  by @bfalling. Add object name option (thanks @nicholassm). Check
+- v.1.0.4 Depend on ActiveModel instead of ActiveRecord (thanks,
+display_with.
+  @skinnyfit). Added date type (thanks @taavo). Added new feature:
+- v.1.0.3 replace apostrophes in collection with corresponding HTML entity,
+  `respond_with_bip` to be used in the controller.
+  thanks @taavo. Implemented `:display_as` option and adding
+- v.1.0.2 New bip_area text helper to work with text areas.
+- v.1.0.1 Fixing a double initialization bug
+- 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.
 
-##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.
+- v.0.2.1 Fixing double initialization bug.
+- 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.1.9 Adding elastic autogrowing textareas
+- 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.6-0.1.7 Avoiding request when the input is not modified and allowing the user to not sanitize input data.
+- v.0.1.5 **Attention: this release is not backwards compatible**. Changing params from list to option hash, helper's refactoring,
+  of key ESCAPE for destroying changes before they are made permanent (in inputs and textarea).
+  fixing bug with objects inside namespaces, adding feature for passing an external activator handler as param. Adding feature
+- v.0.1.4 Adding two new parameters for further customization urlObject and nilValue and making input update on blur.
+- v.0.1.3 Bug in Rails Helper. Key wrongly considered an Integer.
+- v.0.1.2 Fixing errors in collections (taken value[0] instead of index) and fixing test_app controller responses
+- v.0.1.0 Initial commit

data/Gemfile

@@ -1,8 +1,21 @@
 source "http://rubygems.org"
+source 'https://rails-assets.org'
 
 # Specify your gem's dependencies in best_in_place.gemspec
 gemspec
 
-gem 'sqlite3'
-gem 'jquery-rails'
+gem 'rails-assets-jquery', '1.11.1'
+gem 'rails-assets-jquery-ui', '1.10.4'
 gem 'rdiscount'
+gem 'rspec-rails'
+gem 'nokogiri'
+gem 'combustion'
+gem 'sprockets-rails'
+gem 'capybara'
+gem 'selenium-webdriver'
+gem 'sqlite3'
+gem 'appraisal'
+
+platforms :mri_21 do
+  gem 'byebug'
+end

data/README.md

@@ -6,8 +6,8 @@
 ##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 have standard defined REST methods, particularly those to UPDATE your objects (HTTP PUT), then by adding the
-Javascript file to the application it is making all the fields with the proper defined classes to become user in-place editable.
+no need of forms. If the server has standard defined REST methods, particularly those to UPDATE your objects (HTTP PUT), then by adding the
+Javascript file to the application it allows all the fields with the proper defined classes to become user 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.
 
@@ -27,7 +27,7 @@ The editor works by PUTting the updated value to the server and GETting the upda
 - Allows external activator
 - Allows optional, configurable OK and Cancel buttons for inputs and textareas
 - ESC key destroys changes (requires user confirmation)
-- Autogrowing textarea
+- Autogrowing textarea with **jQuery Autosize**
 - 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 using a method from your model or an existing rails
@@ -48,8 +48,8 @@ Options:
 - **:type** It can be only [:input, :textarea, :select, :checkbox, :date (>= 1.0.4)] 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.
-- **: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".
+- **:url**: URL to which the updating action will be sent. If not defined it defaults to the :object path.
+- **:place_holder**: 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 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.
 - **:ok_button**: (Inputs and textareas only) If set to a string, then an OK button will be shown with the string as its label, replacing save on blur.
@@ -58,15 +58,17 @@ Options:
 - **:cancel_button_class**: (Inputs and textareas only) Specifies any extra classes to set on the Cancel button.
 - **:sanitize**: True by default. If set to false the input/textarea will accept html tags.
 - **:html_attrs**: Hash of html arguments, such as maxlength, default-value etc.
-- **:inner_class**: Class that is set to the rendered form.
+- **:inner_class**: Class that is set to the rendered input.
 - **:display_as**: A model method which will be called in order to display
   this field.
-- **:object_name**: Used for overriding the default params key used for the object (the data-object attribute). Useful for e.g. STI scenarios where best_in_place should post to a common controller for different models.
+- **:as**: Used for overriding the default params key used for the object (the data-object attribute). Useful for e.g. STI scenarios where best_in_place should post to a common controller for different models.
 - **:data**: Hash of custom data attributes to be added to span. Can be used to provide data to the ajax:success callback.
-- **:classes**: Additional classes to apply to the best_in_place span.  Accepts either a string or Array of strings
+- **:class**: Additional classes to apply to the best_in_place span.  Accepts either a string or Array of strings
+- **:value**: Customize the starting value of the inline input (defaults to to the field's value)
 
 ###best_in_place_if
 **best_in_place_if condition, object, field, OPTIONS**
+see also **best_in_place_unless
 
 It allows us to use best_in_place only if the first new parameter, a
 condition, is satisfied. Specifically:
@@ -109,10 +111,10 @@ Examples (code in the views):
 
 ### Select
 
-    <%= best_in_place @user, :country, :type => :select, :collection => [[1, "Spain"], [2, "Italy"], [3, "Germany"], [4, "France"]] %>
+    <%= 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],...]`.
-The key can be a string or an integer.
+Of course it can take an instance or global variable for the collection, just remember the structure `{{key, value}, {key, value},...}`.
+The key has to be a string. *
 
 ### Checkbox
 
@@ -192,9 +194,9 @@ The 'ajax:success' event is triggered upon success. Use bind:
 
     $('.best_in_place').bind("ajax:success", function () {$(this).closest('tr').effect('highlight'); });
 
-To bind a callback that is specific to a particular field, use the 'classes' option in the helper method and 
-then bind to that class. 
-    
+To bind a callback that is specific to a particular field, use the 'classes' option in the helper method and
+then bind to that class.
+
     <%= best_in_place @user, :name, :classes => 'highlight_on_success' %>
     <%= best_in_place @user, :mail, :classes => 'bounce_on_success' %>
 
@@ -231,16 +233,16 @@ 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
+    table
+      tr
+        - flavours.each do |flavour|
+          th= flavour
       - sizes.each do |size|
-        %tr
+        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)
+            - v = @ice_cream.get_stock(flavour: flavour, size: size)
+            td= best_in_place v, :to_i, type: :input, url: set_stock_ice_cream_path(flavour: flavour, size: size)
 
 Now we need a route to which send the stock updates:
 
@@ -283,35 +285,12 @@ And finally we need a controller:
 
 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
 
-###Rails 3.1 and higher
+###Rails
 
-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:
+Installing *best_in_place* is very easy and straight-forward.
+Just begin including the gem in your Gemfile:
 
     gem "best_in_place"
 
@@ -320,9 +299,11 @@ javascripts in your application.js, and optionally specify jquery-ui if
 you want to use jQuery UI datepickers:
 
     //= require jquery
-    //= require jquery-ui
     //= require best_in_place
 
+    //= require jquery-ui
+    //= require best_in_place.jquery-ui
+
 If you want to use jQuery UI datepickers, you should also install and
 load your preferred jquery-ui CSS file and associated assets.
 
@@ -335,61 +316,18 @@ Then, just add a binding to prepare all best in place fields when the document i
 
 You are done!
 
-###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
-* **best_in_place**
-
-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() {
-      /* Activating Best In Place */
-      jQuery(".best_in_place").best_in_place();
-    });
-
----
 
 ## Notification
 
 Sometimes your in-place updates will fail due to validation or for some other reason. In such case, you'll want to notify the user somehow. **Best in Place** supports doing so through the best_in_place:error event, and has built-in support for notification via jquery.purr, right out of the box.
 
-To opt into the jquery.purr error notification, just add best_in_place.purr to your javascripts, as described below. If you'd like to develop your own custom form of error notification, you can use best_in_place.purr as an example to guide you.
-
-###Rails 3.1 and higher
-
-It's as simple as adding:
+To opt into the jquery.purr error notification, just add best_in_place.purr to your javascripts, as described below.
 
+    //= require jquery.purr
     //= require best_in_place.purr
 
-###Rails 3.0 and lower
-
-You'll have to load the following additional javascripts, in this order, after loading jquery and **best_in_place**:
-
- * jquery.purr
- * **best_in_place.purr**
-
----
+If you'd like to develop your own custom form of error notification, you can use best_in_place.purr as an example to guide you.
 
 ## Security
 
@@ -411,25 +349,34 @@ If the script is used with the Rails Gem no html tags will be allowed unless the
 
 Fork the project on [github](https://github.com/bernat/best_in_place 'bernat / best_in_place on Github')
 
-    $ git clone <<your fork>
+    $ git clone <your fork>
     $ cd best_in_place
     $ bundle
 
-### Prepare the test app
+### Run the specs
 
-    $ cd test_app
-    $ bundle
-    $ bundle exec rake db:test:prepare
-    $ cd ..
+    $ appraisal rspec
 
-### Run the specs
+---
 
-    $ bundle exec rspec spec/
+##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.
 
-### Bundler / gem troubleshooting
+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.
 
-- 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
+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.
 
 ---