best_in_place 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bedb7e2c588cc03dae88a001cdfe44d379d5be92
-  data.tar.gz: c6e65e4b6a3a96b0a1e42477375ec87cdba24b91
+  metadata.gz: a7128e2317c366f2b4b3c07523f9a7007c9d441f
+  data.tar.gz: cd010b383a647c68f71c91ec0bc6351da8777be3
 SHA512:
-  metadata.gz: c1850801ec202d82b903d6c6e61765bae359e1dc5de6b88374a84fe1900ae01dabf4b9a8abc9ef5875ee9f961b3691642bbc6c15e0adc9662f1bc5374879c038
-  data.tar.gz: 2132cfc690867a04fa9b3065e4ccd2bf3796aa1b0fef1f5569518bcb0f64872ccbdf010c81e967aee182b2dda12cf9d2fb5b0462ff062e7cf3eec4f2b3a33583
+  metadata.gz: acb6ef8c4bf474ac43408fb12c0c37cee42c4fbb4dde9419ab3abb415ba32f29d45de261129036712fc46fcd09d48b0957a7986c90ea5e80e5edfcc273c85521
+  data.tar.gz: f64607487b57f5531b5d789df4cc168d07344e0282c0660492f16e477344d3a3efe191c6083ba17060c855973ecdfca492363a0fd4d71e0ea6322579781dfbe2

data/.travis.yml

@@ -11,10 +11,7 @@ gemfile:
   - gemfiles/rails_4.1.gemfile
   - gemfiles/rails_edge.gemfile
 
-before_script:
-  - "sh -e /etc/init.d/xvfb start"
-
 matrix:
   allow_failures:
     - gemfile: gemfiles/rails_edge.gemfile
-    - rvm: rbx-2
+    - rvm: rbx-2

data/Gemfile

@@ -1,9 +1,10 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 source 'https://rails-assets.org'
 
 # Specify your gem's dependencies in best_in_place.gemspec
 gemspec
 
+gem 'activerecord'
 gem 'rails-assets-jquery', '1.11.1'
 gem 'rails-assets-jquery-ui', '1.10.4'
 gem 'rdiscount'
@@ -12,9 +13,10 @@ gem 'nokogiri'
 gem 'combustion'
 gem 'sprockets-rails'
 gem 'capybara'
-gem 'selenium-webdriver'
+gem 'poltergeist'
 gem 'sqlite3'
 gem 'appraisal'
+gem 'launchy'
 
 platforms :mri_21 do
   gem 'byebug'

data/README.md

@@ -15,6 +15,37 @@ The editor works by PUTting the updated value to the server and GETting the upda
 
 ---
 
+##Installation
+
+###Rails
+
+Installing *best_in_place* is very easy and straight-forward.
+Just begin including the gem in your Gemfile:
+
+    gem 'best_in_place', '~> 3.0.1'
+
+After that, specify the use of the jquery and best in place
+javascripts in your application.js, and optionally specify jquery-ui if
+you want to use jQuery UI datepickers:
+
+    //= require jquery
+    //= 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.
+
+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();
+    });
+
+You are done!
+
 ##Features
 
 - Compatible with text **inputs**
@@ -46,7 +77,7 @@ Params:
 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
+- **:collection**: If you are using the :select type then you must specify the collection of values it takes as a hash where keys represent the display text and values are the option's value when selected. If you are
   using the :checkbox type you can specify the two values it can take, or otherwise they will default to Yes and No.
 - **: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".
@@ -92,8 +123,7 @@ It is a very useful feature to use with, for example, [Ryan Bates](https://githu
 
 ---
 
-##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
 
 Examples (code in the views):
 
@@ -111,10 +141,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 has to be a string. *
+Of course it can take an instance or global variable for the collection, just remember the structure is a hash.
+The key will always be converted to a string for display. *
 
 ### Checkbox
 
@@ -285,38 +315,6 @@ And finally we need a controller:
 
 And this is how it is done!
 
-##Installation
-
-###Rails
-
-Installing *best_in_place* is very easy and straight-forward.
-Just begin including the gem in your Gemfile:
-
-    gem "best_in_place"
-
-After that, specify the use of the jquery and best in place
-javascripts in your application.js, and optionally specify jquery-ui if
-you want to use jQuery UI datepickers:
-
-    //= require jquery
-    //= 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.
-
-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();
-    });
-
-You are done!
-
-
 
 ## Notification
 

data/config.ru

@@ -3,5 +3,5 @@ require 'bundler'
 
 Bundler.require :default, :development
 
-Combustion.initialize!
+Combustion.initialize! :active_record
 run Combustion::Application

data/gemfiles/rails_3.2.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 source "https://rails-assets.org"
 
 gem "rails-assets-jquery", "1.11.1"
@@ -11,9 +11,10 @@ gem "nokogiri"
 gem "combustion"
 gem "sprockets-rails"
 gem "capybara"
-gem "selenium-webdriver"
+gem "poltergeist"
 gem "sqlite3"
 gem "appraisal"
+gem "launchy"
 gem "rails", "3.2.19"
 gem "strong_parameters"
 

data/gemfiles/rails_4.0.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 source "https://rails-assets.org"
 
 gem "rails-assets-jquery", "1.11.1"
@@ -11,9 +11,10 @@ gem "nokogiri"
 gem "combustion"
 gem "sprockets-rails"
 gem "capybara"
-gem "selenium-webdriver"
+gem "poltergeist"
 gem "sqlite3"
 gem "appraisal"
+gem "launchy"
 gem "rails", "~> 4.0.0"
 
 platforms :mri_21 do

data/gemfiles/rails_4.1.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 source "https://rails-assets.org"
 
 gem "rails-assets-jquery", "1.11.1"
@@ -11,9 +11,10 @@ gem "nokogiri"
 gem "combustion"
 gem "sprockets-rails"
 gem "capybara"
-gem "selenium-webdriver"
+gem "poltergeist"
 gem "sqlite3"
 gem "appraisal"
+gem "launchy"
 gem "rails", "~> 4.1.0"
 
 platforms :mri_21 do

data/gemfiles/rails_edge.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 source "https://rails-assets.org"
 
 gem "rails-assets-jquery", "1.11.1"
@@ -11,12 +11,12 @@ gem "nokogiri"
 gem "combustion"
 gem "sprockets-rails"
 gem "capybara"
-gem "selenium-webdriver"
+gem "poltergeist"
 gem "sqlite3"
 gem "appraisal"
+gem "launchy"
 gem "rails", :github => "rails/rails"
 gem "arel", :github => "rails/arel"
-gem "minitest"
 
 platforms :mri_21 do
   gem "byebug"

data/lib/assets/javascripts/best_in_place.js

@@ -439,6 +439,7 @@ BestInPlaceEditor.forms = {
             'use strict';
             if (event.keyCode === 27) {
                 event.data.editor.abort();
+                event.stopImmediatePropagation();
             }
         }
     },
@@ -518,6 +519,7 @@ BestInPlaceEditor.forms = {
                 .attr('action', 'javascript:void(0);')
                 .attr('style', 'display:inline');
             var textarea_elt = jQuery(document.createElement('textarea'))
+                .attr('name', this.attributeName)
                 .val(this.sanitizeValue(this.display_value));
 
             if (this.inner_class !== null) {

data/lib/best_in_place/helper.rb

@@ -18,19 +18,18 @@ module BestInPlace
 
       if opts[:collection] or type == :checkbox
         collection = opts[:collection]
+        value = value.to_s
         case type
           when :checkbox
-            value = value.to_s
             if collection.blank?
               collection = best_in_place_default_collection
             else
-              collection = best_in_place_collection_builder(collection)
+              collection = best_in_place_collection_builder(type, collection)
             end
             display_value = collection[value]
             collection = collection.to_json
           else # :select
-            value = value.to_s
-            collection = best_in_place_collection_builder(collection)
+            collection = best_in_place_collection_builder(type, collection)
             display_value = collection[value]
             collection = collection.to_json
         end
@@ -173,13 +172,22 @@ module BestInPlace
       end
     end
 
-    def best_in_place_collection_builder(collection)
-      case collection
+    def best_in_place_collection_builder(type, collection)
+      collection = case collection
         when Array
-          Hash[collection.map { |x| [x.to_s, x.to_s] }]
+          if type == :checkbox
+            if collection.length == 2
+              {'false' => collection[0], 'true' => collection[1]}
+            else
+              fail ArgumentError, '[Best_in_place] :collection array should have 2 values'
+            end
+          else # :select
+            Hash[(1...collection.size+1).zip collection]
+          end
         else
-          collection.stringify_keys
+          collection
       end
+      collection.stringify_keys
     end
 
     def best_in_place_default_collection

data/lib/best_in_place/test_helpers.rb

@@ -4,38 +4,58 @@ module BestInPlace
 
     def bip_area(model, attr, new_value)
       id = BestInPlace::Utils.build_best_in_place_id model, attr
-      page.execute_script <<-JS
-        jQuery("##{id}").click();
-        jQuery("##{id} form textarea").val('#{escape_javascript new_value.to_s}');
-        jQuery("##{id} form textarea").blur();
-        jQuery("##{id} form textarea").blur();
+      find("##{id}").trigger('click')
+      execute_script <<-JS
+        $("##{id} form textarea").val('#{escape_javascript new_value.to_s}');
+        $("##{id} form textarea").blur();
       JS
+      wait_for_ajax
     end
 
     def bip_text(model, attr, new_value)
       id = BestInPlace::Utils.build_best_in_place_id model, attr
-      page.execute_script <<-JS
-        jQuery("##{id}").click();
-        jQuery("##{id} input[name='#{attr}']").val('#{escape_javascript new_value.to_s}');
-        jQuery("##{id} form").submit();
+      find("##{id}").click
+      execute_script <<-JS
+        $("##{id} input[name='#{attr}']").val('#{escape_javascript new_value.to_s}');
+        $("##{id} form").submit();
       JS
+      wait_for_ajax
     end
 
     def bip_bool(model, attr)
       id = BestInPlace::Utils.build_best_in_place_id model, attr
-      page.execute_script("jQuery('##{id}').click();")
+      find("##{id}").trigger('click')
+      wait_for_ajax
     end
 
     def bip_select(model, attr, name)
       id = BestInPlace::Utils.build_best_in_place_id model, attr
-      page.execute_script <<-JS
-        (function() {
-          jQuery("##{id}").click();
-          var opt_value = jQuery("##{id} select option:contains('#{name}')").attr('value');
-          jQuery("##{id} select option[value='" + opt_value + "']").attr('selected', true);
-          jQuery("##{id} select").change();
-        })();
-      JS
+      find("##{id}").trigger('click')
+      find("##{id}").select(name)
+      wait_for_ajax
+    end
+
+    def wait_for_ajax
+      return unless respond_to?(:evaluate_script)
+      wait_until { finished_all_ajax_requests? }
+    end
+
+    def finished_all_ajax_requests?
+      evaluate_script('!window.jQuery') || evaluate_script('jQuery.active').zero?
+    end
+
+    def wait_until(max_execution_time_in_seconds = Capybara.default_wait_time)
+      Timeout.timeout(max_execution_time_in_seconds) do
+        loop do
+          if yield
+            return true
+          else
+            sleep(0.1)
+            next
+          end
+        end
+      end
     end
+
   end
 end

data/lib/best_in_place/version.rb

@@ -1,3 +1,3 @@
 module BestInPlace
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 end

data/spec/helper_spec.rb

@@ -326,9 +326,9 @@ describe BestInPlace::Helper, type: :helper do
         expect(@span.text).to eq("No")
       end
 
-      describe "custom collection" do
+      describe "custom hash collection" do
         before do
-          @collection = {'false' => 'Nain', 'true' => 'Da'}
+          @collection = {false: 'Nain', true: 'Da'}
           nk = Nokogiri::HTML.parse(helper.best_in_place @user, :receive_email, as: :checkbox, collection: @collection)
           @span = nk.css("span")
         end
@@ -342,40 +342,120 @@ describe BestInPlace::Helper, type: :helper do
         end
       end
 
+      describe "custom array collection" do
+        before do
+          @good_collection = ['Net', 'Da']
+          @bad_collection = ['Maybe']
+          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :receive_email, as: :checkbox, collection: @good_collection)
+          @span = nk.css("span")
+        end
+
+        it "should show the message with the custom values" do
+          expect(@span.text).to eq("Net")
+        end
+
+        it "should render the proper data-bip-collection" do
+          expect(@span.attribute("data-bip-collection").value).to eq({false: @good_collection[0], true: @good_collection[1]}.to_json)
+        end
+
+        it "should raise an argument error on bad collection" do
+          expect { helper.best_in_place @user, :receive_email, as: :checkbox, collection: @bad_collection }.to raise_error(ArgumentError)
+        end
+      end
+
     end
 
-    context "with a select attribute" do
+    context 'with a select attribute' do
       before do
-        @countries = COUNTRIES
-        nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, as: :select, :collection => @countries)
-        @span = nk.css("span")
+        @countries_hash = COUNTRIES_HASH
+        @countries_hash_string_keys = COUNTRIES_HASH_STRING_KEYS
+        @countries_array = COUNTRIES_ARRAY
+        @apostrophe_countries_hash = COUNTRIES_APOSTROPHE_HASH
+        @apostrophe_countries_array = COUNTRIES_APOSTROPHE_ARRAY
       end
 
-      it 'should have a select data-bip-type' do
-        expect(@span.attribute('data-bip-type').value).to eq('select')
-      end
+      describe 'with a hash parameter' do
+        before do
+          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, as: :select, collection: @countries_hash)
+          @span = nk.css('span')
+        end
 
-      it "should have a proper data collection" do
-        expect(@span.attribute('data-bip-collection').value).to eq(@countries.to_json)
-      end
+        it 'should have a select data-bip-type' do
+          expect(@span.attribute('data-bip-type').value).to eq('select')
+        end
 
-      it "should show the current country" do
-        expect(@span.text).to eq("Italy")
-      end
+        it 'should have a proper data collection' do
+          expect(@span.attribute('data-bip-collection').value).to eq(@countries_hash.to_json)
+        end
+
+        it 'should show the current country' do
+          expect(@span.text).to eq('Italy')
+        end
+
+        it 'should include the proper data-bip-value' do
+          expect(@span.attribute('data-bip-value').value).to eq('2')
+        end
+
+        context 'with hash string keys' do
+          before do
+            @user.country = 'it'
+            @user.save
+            nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, as: :select, collection: @countries_hash_string_keys)
+            @span = nk.css('span')
+          end
+
+          it 'should have a proper data collection' do
+            expect(@span.attribute('data-bip-collection').value).to eq(@countries_hash_string_keys.to_json)
+          end
+
+          it 'should show the current country' do
+            expect(@span.text).to eq('Italy')
+          end
+
+          it 'should include the proper data-bip-value' do
+            expect(@span.attribute('data-bip-value').value).to eq('it')
+          end
+        end
+
+        context 'with an apostrophe in it' do
+          before do
+            nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, as: :select, collection: @apostrophe_countries_hash)
+            @span = nk.css('span')
+          end
 
-      it 'should include the proper data-bip-value' do
-        expect(@span.attribute('data-bip-value').value).to eq('2')
+          it 'should have a proper data collection' do
+            expect(@span.attribute('data-bip-collection').value).to eq(@apostrophe_countries_hash.to_json)
+          end
+        end
       end
 
-      context "with an apostrophe in it" do
+      describe 'with an array parameter' do
         before do
-          @apostrophe_countries = {1=> "Joe's Country", 2 => "Bob's Country"}
-          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, as: :select, :collection => @apostrophe_countries)
-          @span = nk.css("span")
+          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, as: :select, collection: @countries_array)
+          @span = nk.css('span')
+        end
+
+        it 'should have a proper data collection' do
+          expect(@span.attribute('data-bip-collection').value).to eq(@countries_hash.to_json)
+        end
+
+        it 'should show the current country' do
+          expect(@span.text).to eq('Italy')
+        end
+
+        it 'should include the proper data-bip-value' do
+          expect(@span.attribute('data-bip-value').value).to eq('2')
         end
 
-        it "should have a proper data collection" do
-          expect(@span.attribute('data-bip-collection').value).to eq(@apostrophe_countries.to_json)
+        context 'with an apostrophe in it' do
+          before do
+            nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, as: :select, collection: @apostrophe_countries_array)
+            @span = nk.css('span')
+          end
+
+          it 'should have a proper data collection' do
+            expect(@span.attribute('data-bip-collection').value).to eq(@apostrophe_countries_hash.to_json)
+          end
         end
       end
     end