dependent_select 0.6.5 → 0.7.0

data/README.rdoc

@@ -59,8 +59,7 @@ Finally, the controller might look like this:
 This will generate a regular +collection_select+ for the country and a +dependent_collection_select+
 for province. The later will be a regular +collection_select+ followed by a js +<script>+ tag that:
 * Will create an array with all the provinces. (+var array=[province1, province2...];+)
-* Will place a listeners on the +country_id+ +select+ in order to update the provinces select if
-    the countries select is modified
+* Will place a listeners on the +country_id+ +select+ in order to update the provinces select if the countries select is modified
 * Fill up the provinces select with appropiate values.
 
 *Note that this will not work if you haven't followed the installation procedure - see below*
@@ -71,7 +70,7 @@ There's a more complex example at the end of this document.
 
 ===As a gem
 Copy this on config/environment.erb, inside the gems section
-    config.gem "splendeo-dependent_select", :lib => 'dependent_select', :source => "http://gems.github.com"
+    config.gem "dependent_select"
 Then execute
     rake gems:install
 
@@ -88,7 +87,7 @@ Several steps are needed:
 * And then install the new version
 
 In other words:
-    sudo gem uninstall splendeo-dependent_select
+    sudo gem uninstall dependent_select
     rm public/javascripts/dependent_select/dependent_select.js
     rake gems:install
 
@@ -180,4 +179,4 @@ On your controller:
         @provinces = Province.find(:all, :order => 'name ASC') # all provinces for all countries
         @cities = City.find(:all, :order => 'name ASC') # all cities for all provinces
       end
-    end
+    end

data/lib/dependent_select/dependent_select.rb

@@ -8,7 +8,7 @@ module DependentSelect
   #     :collapse_spaces => false
   #   )
   def self.default_options
-    @default_options ||= { :collapse_spaces => true }
+    @default_options ||= { :collapse_spaces => true, :use_jquery => false }
   end
 
   # By default, spaces are collapsed on browsers when printing the select option texts
@@ -24,5 +24,18 @@ module DependentSelect
   def self.collapse_spaces=(value)
     default_options[:collapse_spaces] = value
   end
-
+  
+  def self.collapse_spaces?
+    default_options[:collapse_spaces]
+  end
+  
+  # By default, dependent_select will use Prototype. If you need to use jquery, you can do so by doing
+  #    DependentSelect.use_jquery = true
+  def self.use_jquery=(value)
+    default_options[:use_jquery] = value
+  end
+  
+  def self.use_jquery?
+    default_options[:use_jquery]
+  end
 end

data/lib/dependent_select/form_helpers.rb

@@ -390,18 +390,31 @@ module DependentSelect::FormHelpers
         filter_method, html_options, extra_options)
       initial_value = dependent_select_initial_value(object, method)
       include_blank = options[:include_blank] || false
-      collapse_spaces = extra_options[:collapse_spaces] || false
-
+      collapse_spaces = extra_options[:collapse_spaces] || DependentSelect.collapse_spaces?
+      
+      
+      if(DependentSelect.use_jquery?)
+        js_function = 'update_depentent_select_jquery'
+      else
+        js_function = 'update_dependent_select'
+      end
+      
       js_callback =
-        "function(e) { update_dependent_select( '#{dependent_field_id}', '#{observed_field_id}', #{js_array_name}, " +
+        "function(e) { #{js_function}( '#{dependent_field_id}', '#{observed_field_id}', #{js_array_name}, " +
         "'#{initial_value}', #{include_blank}, #{collapse_spaces}, false); }"
+      
+      if(DependentSelect.use_jquery?)
+        observers = "$('##{observed_field_id}').bind('change', #{js_callback});\n"
+      else
+        observers = "$('#{observed_field_id}').observe('change', #{js_callback});\n" +
+          "$('#{observed_field_id}').observe('DependentSelectFormBuilder:change', #{js_callback}); \n"
+      end
 
-      javascript_tag(js_array_code +
-        "$('#{observed_field_id}').observe ('change', #{js_callback});\n" +
-        "$('#{observed_field_id}').observe ('DependentSelectFormBuilder:change', #{js_callback}); \n" +
-        "update_dependent_select( '#{dependent_field_id}', '#{observed_field_id}', #{js_array_name}, " +
-        "'#{initial_value}', #{include_blank}, #{collapse_spaces}, true);"
-      )
+      initial_call =
+        "#{js_function}( '#{dependent_field_id}', '#{observed_field_id}', #{js_array_name}, " +
+        "'#{initial_value}', #{include_blank}, #{collapse_spaces}, true);\n"
+
+      javascript_tag(js_array_code + observers + initial_call)
     end
     
     # generates the js script for a dependent_collection_select. See +dependent_select_js+

data/public/javascripts/dependent_select/dependent_select.js

@@ -42,4 +42,61 @@ function update_dependent_select( dependent_id, observed_id, values_array, // ma
 
   // launch a custom event (Prototype doesn't allow launcthing "change") to support dependencies of dependencies
   dependent_field.fire('DependentSelectFormBuilder:change');
-}
+}
+
+function update_dependent_select_jquery( dependent_id, observed_id, values_array, // mandatory
+  initial_value, include_blank, collapse_spaces, first_run ) {                    // optional
+  
+  // parse the optional parameters ....
+  initial_value = initial_value || '';
+  include_blank = include_blank || false;
+  collapse_spaces = collapse_spaces || false;
+  first_run = first_run || false;
+
+  // select DOM node whose options are modified
+  var dependent_field = $('#'+dependent_id);
+
+  // select DOM node whose changes trigger this
+  var observed_field = $('#'+observed_id);
+
+  // value chosen on observed_select, used for filtering dependent_select
+  var filter = observed_field.value;
+
+  // the first time the update_func is executed (on edit) the value the select has
+  // comes directly from the model. From them on, it will only use the client's input
+  var previous_value = first_run ? initial_value : dependent_field.value;
+
+  // removes all options from dependent_field
+  dependent_field[0].options.length = 0; // empty() gives some trouble in IE7, it seems
+
+  // adds a blank option, only if specified on options
+  if(include_blank) {
+    if(!previous_value) { // it will be selected if previous_value is nil
+      dependent_field.append('<option selected="selected" value=""></option>');
+    } else {
+      dependent_field.append('<option value=""></option>');
+    }
+  }
+
+  // this fills the dependent select
+  values_array.each (function (index) {
+    var arrFilter = this[2];
+    var arrValue = this[1];
+    var arrText = this[0];
+    var opt;
+    if (arrFilter==filter) {                                       // only include options with the right filter field
+      if(collapse_spaces == false) {                               // assign the text (spaces are automatically collapsed)
+        arrText = arrText.replace(/ /g, '\240');                   // replacing spaces with &nbsp; if requested
+      }
+      if(arrValue == previous_value) {                             // mark it as selected if appropiate
+        opt = '<option selected="selected" value="'+arrValue+'">'+arrText+'</option>'
+      } else {
+        opt = '<option value="'+arrValue+'">'+arrText+'</option>';
+      }
+      dependent_field.append(opt);
+    }
+  });
+
+  // trigger change event so the dependent field is populated
+  dependent_field.trigger('change');
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dependent_select
 version: !ruby/object:Gem::Version 
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors: 
 - Enrique Garcia Cota (egarcia)