recordselect 3.1.2 → 3.1.3

data/app/assets/javascripts/jquery/record_select.js

@@ -404,7 +404,8 @@ RecordSelect.Dialog = RecordSelect.Abstract.extend({
 /**
  * Used by record_select_field helper
  * The options hash may contain id: and label: keys, designating the current value
- * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine.
+ * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine
+ * and field_name: key, where value will be set as name of the input field.
  */
 RecordSelect.Single = RecordSelect.Abstract.extend({
   onload: function() {
@@ -418,7 +419,7 @@ RecordSelect.Single = RecordSelect.Abstract.extend({
 
     // transfer the input name from the text input to the hidden input
     this.hidden_input.attr('name', this.obj.attr('name'));
-    this.obj.attr('name', '');
+    this.obj.attr('name', this.options.field_name || '');
 
     // initialize the values
     this.set(this.options.id, this.options.label);
@@ -450,6 +451,46 @@ RecordSelect.Single = RecordSelect.Abstract.extend({
   }
 });
 
+/**
+ * Used by record_select_autocomplete helper
+ * The options hash may contain label: key, designating the current value
+ * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine.
+ */
+RecordSelect.Autocomplete = RecordSelect.Abstract.extend({
+  onload: function() {
+    // initialize the container
+    this.container = this.create_container();
+    this.container.addClass('record-select-autocomplete');
+
+    // initialize the values
+    this.set(this.options.label);
+
+    this._respond_to_text_field(this.obj);
+    if (this.obj.focused) this.open(); // if it was focused before we could attach observers
+  },
+
+  close: function() {
+    // if they close the dialog with the text field empty, then delete the id value
+    if (this.obj.val() == '') this.set('');
+
+    RecordSelect.Abstract.prototype.close.call(this);
+  },
+
+  onselect: function(id, value) {
+    this.set(value);
+    if (this.options.onchange) this.options.onchange.call(this, id, value);
+    this.close();
+  },
+
+  /**
+   * sets the id/label
+   */
+  set: function(label) {
+    // unescaped html missing for label
+    this.obj.val(label); 
+  }
+});
+
 /**
  * Used by record_multi_select_field helper.
  * Options:

data/app/assets/javascripts/jquery/record_select.js~

@@ -240,7 +240,7 @@ RecordSelect.Abstract = Class.extend({
     this.container.show();
     this.container.css('left', offset.left);
     if (top + this.container.height() > $(document).height())
-      this.container.css('bottom', offset.top);
+      this.container.css('top', offset.top - this.container.height());
     else this.container.css('top', top);
 
     if (this._use_iframe_mask()) {
@@ -404,7 +404,8 @@ RecordSelect.Dialog = RecordSelect.Abstract.extend({
 /**
  * Used by record_select_field helper
  * The options hash may contain id: and label: keys, designating the current value
- * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine.
+ * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine
+ * and field_name: key, where value will be set as name of the input field.
  */
 RecordSelect.Single = RecordSelect.Abstract.extend({
   onload: function() {
@@ -418,7 +419,7 @@ RecordSelect.Single = RecordSelect.Abstract.extend({
 
     // transfer the input name from the text input to the hidden input
     this.hidden_input.attr('name', this.obj.attr('name'));
-    this.obj.attr('name', '');
+    this.obj.attr('name', this.options.field_name || '');
 
     // initialize the values
     this.set(this.options.id, this.options.label);
@@ -450,6 +451,46 @@ RecordSelect.Single = RecordSelect.Abstract.extend({
   }
 });
 
+/**
+ * Used by record_select_autocomplete helper
+ * The options hash may contain label: key, designating the current value
+ * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine.
+ */
+RecordSelect.Autocomplete = RecordSelect.Abstract.extend({
+  onload: function() {
+    // initialize the container
+    this.container = this.create_container();
+    this.container.addClass('record-select-autocomplete');
+
+    // initialize the values
+    this.set(this.options.label);
+
+    this._respond_to_text_field(this.obj);
+    if (this.obj.focused) this.open(); // if it was focused before we could attach observers
+  },
+
+  close: function() {
+    // if they close the dialog with the text field empty, then delete the id value
+    if (this.obj.val() == '') this.set('', '');
+
+    RecordSelect.Abstract.prototype.close.call(this);
+  },
+
+  onselect: function(id, value) {
+    this.set(value);
+    if (this.options.onchange) this.options.onchange.call(this, id, value);
+    this.close();
+  },
+
+  /**
+   * sets the id/label
+   */
+  set: function(label) {
+    // unescaped html missing for label
+    this.obj.val(label); 
+  }
+});
+
 /**
  * Used by record_multi_select_field helper.
  * Options:

data/app/assets/javascripts/prototype/record_select.js

@@ -269,7 +269,8 @@ RecordSelect.Dialog.prototype = Object.extend(new RecordSelect.Abstract(), {
 /**
  * Used by record_select_field helper
  * The options hash may contain id: and label: keys, designating the current value
- * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine.
+ * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine
+ * and field_name: key, where value will be set as name of the input field.
  */
 RecordSelect.Single = Class.create();
 RecordSelect.Single.prototype = Object.extend(new RecordSelect.Abstract(), {
@@ -284,7 +285,7 @@ RecordSelect.Single.prototype = Object.extend(new RecordSelect.Abstract(), {
 
     // transfer the input name from the text input to the hidden input
     this.hidden_input.name = this.obj.name;
-    this.obj.name = '';
+    this.obj.name = this.options.field_name || '';
 
     // initialize the values
     this.set(this.options.id, this.options.label);
@@ -315,6 +316,46 @@ RecordSelect.Single.prototype = Object.extend(new RecordSelect.Abstract(), {
   }
 });
 
+/**
+ * Used by record_select_autocomplete helper
+ * The options hash may contain label: key, designating the current value
+ * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine.
+ */
+RecordSelect.Autocomplete = Class.create();
+RecordSelect.Autocomplete.prototype = Object.extend(new RecordSelect.Abstract(), {
+  onload: function() {
+    // initialize the container
+    this.container = this.create_container();
+    this.container.addClassName('record-select-autocomplete');
+
+    // initialize the values
+    this.set(this.options.label);
+
+    this._respond_to_text_field(this.obj);
+    if (this.obj.focused) this.open(); // if it was focused before we could attach observers
+  },
+
+  close: function() {
+    // if they close the dialog with the text field empty, then delete the id value
+    if (this.obj.value == '') this.set('', '');
+
+    RecordSelect.Abstract.prototype.close.call(this);
+  },
+
+  onselect: function(id, value) {
+    this.set(value);
+    if (this.options.onchange) this.options.onchange.call(this, id, value);
+    this.close();
+  },
+
+  /**
+   * sets the id/label
+   */
+  set: function(label) {
+    this.obj.value = label.unescapeHTML();
+  }
+});
+
 /**
  * Used by record_multi_select_field helper.
  * Options:

data/app/assets/javascripts/prototype/record_select.js~

@@ -0,0 +1,411 @@
+document.observe("dom:loaded", function() {
+  RecordSelect.document_loaded = true;
+  document.on('ajax:before', 'div.record-select * li.record a', function(event) {
+    var link = event.findElement();
+    if (link) {
+      if (RecordSelect.notify(link) == false) {
+        event.stop();
+      } else {
+        link.toggleClassName("selected");
+      }
+    }
+    return true;
+  });  
+});    
+
+Form.Element.AfterActivity = function(element, callback, delay) {
+  element = $(element);
+  if (!delay) delay = 0.25;
+  new Form.Element.Observer(element, delay, function(element, value) {
+    // TODO: display loading indicator
+    if (element.activity_timer) clearTimeout(element.activity_timer);
+    element.activity_timer = setTimeout(function() {
+      callback(element.value);
+    }, delay * 1000 + 50);
+  });
+}
+
+var RecordSelect = new Object();
+RecordSelect.document_loaded = false;
+
+RecordSelect.notify = function(item) {
+  var e = Element.up(item, '.record-select-handler');
+  var onselect = e.onselect || e.getAttribute('onselect');
+  if (typeof onselect != 'function') onselect = eval(onselect);
+  if (onselect)
+  {
+    try {
+      onselect(item.parentNode.id.substr(2), (item.down('label') || item).innerHTML.unescapeHTML(), e);
+    } catch(e) {
+      alert(e);
+    }
+    return false;
+  }
+  else return true;
+};
+
+RecordSelect.render_page = function(record_select_id, page) {
+  var page_element = $$('#' + record_select_id + ' ol')[0];
+  if (page_element) Element.replace(page_element, page);
+};
+
+RecordSelect.Abstract = Class.create();
+Object.extend(RecordSelect.Abstract.prototype, {
+  /**
+   * obj - the id or element that will anchor the recordselect to the page
+   * url - the url to run the recordselect
+   * options - ??? (check concrete classes)
+   */
+  initialize: function(obj, url, options) {
+    this.obj = $(obj);
+    this.url = url;
+    this.options = options;
+    this.container;
+
+    if (RecordSelect.document_loaded) this.onload();
+    else Event.observe(window, 'load', this.onload.bind(this));
+  },
+
+  /**
+   * Finish the setup - IE doesn't like doing certain things before the page loads
+   * --override--
+   */
+  onload: function() {},
+
+  /**
+   * the onselect event handler - when someone clicks on a record
+   * --override--
+   */
+  onselect: function(id, value) {
+    alert(id + ': ' + value);
+  },
+
+  /**
+   * opens the recordselect
+   */
+  open: function() {
+    if (this.is_open()) return;
+
+    new Ajax.Updater(this.container, this.url, {
+      method: 'get',
+      evalScripts: true,
+      asynchronous: true,
+      onComplete: function() {
+        this.show();
+        // needs to be mousedown so the event doesn't get canceled by other code (see issue #26)
+        Element.observe(document.body, 'mousedown', this.onbodyclick.bindAsEventListener(this));
+      }.bind(this)
+    });
+  },
+
+  /**
+   * positions and reveals the recordselect
+   */
+  show: function() {
+    var offset = Position.cumulativeOffset(this.obj);
+    this.container.style.left = offset[0] + 'px';
+    this.container.style.top = (Element.getHeight(this.obj) + offset[1]) + 'px';
+
+    if (this._use_iframe_mask()) {
+      this.container.insertAdjacentHTML('afterEnd', '<iframe src="javascript:false;" class="record-select-mask" />');
+      var mask = this.container.next('iframe');
+      mask.style.left = this.container.style.left;
+      mask.style.top = this.container.style.top;
+    }
+
+    this.container.show();
+
+    if (this._use_iframe_mask()) {
+      var dimensions = this.container.immediateDescendants().first().getDimensions();
+      mask.style.width = dimensions.width + 'px';
+      mask.style.height = dimensions.height + 'px';
+    }
+  },
+
+  /**
+   * closes the recordselect by emptying the container
+   */
+  close: function() {
+    if (this._use_iframe_mask()) {
+      this.container.next('iframe').remove();
+    }
+
+    this.container.hide();
+    // hopefully by using remove() instead of innerHTML we won't leak memory
+    this.container.immediateDescendants().invoke('remove');
+  },
+
+  /**
+   * returns true/false for whether the recordselect is open
+   */
+  is_open: function() {
+	  return (!this.container.innerHTML.blank())
+  },
+
+  /**
+   * when the user clicks outside the dropdown
+   */
+  onbodyclick: function(ev) {
+    if (!this.is_open()) return;
+    var elem = $(Event.element(ev));
+    var ancestors = elem.ancestors();
+    ancestors.push(elem);
+    if (ancestors.include(this.container) || ancestors.include(this.obj)) return;
+    this.close();
+  },
+
+  /**
+   * creates and initializes (and returns) the recordselect container
+   */
+  create_container: function() {
+    new Insertion.Bottom(document.body, '<div class="record-select-container record-select-handler"></div>');
+    e = document.body.childNodes[document.body.childNodes.length - 1];
+    e.onselect = this.onselect.bind(this);
+    e.style.display = 'none';
+
+    return $(e);
+  },
+
+  /**
+   * all the behavior to respond to a text field as a search box
+   */
+  _respond_to_text_field: function(text_field) {
+    // attach the events to start this party
+    text_field.observe('focus', this.open.bind(this));
+
+    // the autosearch event - needs to happen slightly late (keyup is later than keypress)
+    text_field.observe('keyup', function() {
+      if (!this.is_open()) return;
+      this.container.down('.text-input').value = text_field.value;
+    }.bind(this));
+
+    // keyboard navigation, if available
+    if (this.onkeypress) {
+      text_field.observe('keypress', this.onkeypress.bind(this));
+    }
+  },
+
+  _use_iframe_mask: function() {
+    return this.container.insertAdjacentHTML ? true : false;
+  }
+});
+
+/**
+ * Adds keyboard navigation to RecordSelect objects
+ */
+Object.extend(RecordSelect.Abstract.prototype, {
+  current: null,
+
+  /**
+   * keyboard navigation - where to intercept the keys is up to the concrete class
+   */
+  onkeypress: function(ev) {
+    var elem;
+    switch (ev.keyCode) {
+      case Event.KEY_UP:
+        if (this.current && this.current.up('.record-select')) elem = this.current.previous();
+        if (!elem) elem = this.container.getElementsBySelector('ol li.record').last();
+        this.highlight(elem);
+        break;
+      case Event.KEY_DOWN:
+        if (this.current && this.current.up('.record-select')) elem = this.current.next();
+        if (!elem) elem = this.container.getElementsBySelector('ol li.record').first();
+        this.highlight(elem);
+        break;
+      case Event.KEY_SPACE:
+      case Event.KEY_RETURN:
+        if (this.current) this.current.down('a').onclick();
+        break;
+      case Event.KEY_RIGHT:
+        elem = this.container.down('li.pagination.next');
+        if (elem) elem.down('a').onclick();
+        break;
+      case Event.KEY_LEFT:
+        elem = this.container.down('li.pagination.previous');
+        if (elem) elem.down('a').onclick();
+        break;
+      case Event.KEY_ESC:
+        this.close();
+        break;
+      default:
+        return;
+    }
+    Event.stop(ev); // so "enter" doesn't submit the form, among other things(?)
+  },
+
+  /**
+   * moves the highlight to a new object
+   */
+  highlight: function(obj) {
+    if (this.current) this.current.removeClassName('current');
+    this.current = $(obj);
+    obj.addClassName('current');
+  }
+});
+
+/**
+ * Used by link_to_record_select
+ * The options hash should contain a onselect: key, with a javascript function as value
+ */
+RecordSelect.Dialog = Class.create();
+RecordSelect.Dialog.prototype = Object.extend(new RecordSelect.Abstract(), {
+  onload: function() {
+    this.container = this.create_container();
+    this.obj.observe('click', this.toggle.bind(this));
+
+    if (this.onkeypress) this.obj.observe('keypress', this.onkeypress.bind(this));
+  },
+
+  onselect: function(id, value) {
+    if (this.options.onselect(id, value) != false) this.close();
+  },
+
+  toggle: function() {
+    if (this.is_open()) this.close();
+    else this.open();
+  }
+});
+
+/**
+ * Used by record_select_field helper
+ * The options hash may contain id: and label: keys, designating the current value
+ * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine
+ * and field_name: key, where value will be set as name of the input field.
+ */
+RecordSelect.Single = Class.create();
+RecordSelect.Single.prototype = Object.extend(new RecordSelect.Abstract(), {
+  onload: function() {
+    // initialize the container
+    this.container = this.create_container();
+    this.container.addClassName('record-select-autocomplete');
+
+    // create the hidden input
+    new Insertion.After(this.obj, '<input type="hidden" name="" value="" />')
+    this.hidden_input = this.obj.next();
+
+    // transfer the input name from the text input to the hidden input
+    this.hidden_input.name = this.obj.name;
+    this.obj.name = this.options.field_name || '';
+
+    // initialize the values
+    this.set(this.options.id, this.options.label);
+
+    this._respond_to_text_field(this.obj);
+    if (this.obj.focused) this.open(); // if it was focused before we could attach observers
+  },
+
+  close: function() {
+    // if they close the dialog with the text field empty, then delete the id value
+    if (this.obj.value == '') this.set('', '');
+
+    RecordSelect.Abstract.prototype.close.call(this);
+  },
+
+  onselect: function(id, value) {
+    this.set(id, value);
+    if (this.options.onchange) this.options.onchange.call(this, id, value);
+    this.close();
+  },
+
+  /**
+   * sets the id/label
+   */
+  set: function(id, label) {
+    this.obj.value = label.unescapeHTML();
+    this.hidden_input.value = id;
+  }
+});
+
+/**
+ * Used by record_select_autocomplete helper
+ * The options hash may contain label: key, designating the current value
+ * The options hash may also include an onchange: key, where the value is a javascript function (or eval-able string) for an callback routine.
+ */
+RecordSelect.Autocomplete = Class.create();
+RecordSelect.Autocomplete.prototype = Object.extend(new RecordSelect.Abstract(), {
+  onload: function() {
+    // initialize the container
+    this.container = this.create_container();
+    this.container.addClassName('record-select-autocomplete');
+
+    // initialize the values
+    this.set(this.options.label);
+
+    this._respond_to_text_field(this.obj);
+    if (this.obj.focused) this.open(); // if it was focused before we could attach observers
+  },
+
+  close: function() {
+    // if they close the dialog with the text field empty, then delete the id value
+    if (this.obj.value == '') this.set('', '');
+
+    RecordSelect.Abstract.prototype.close.call(this);
+  },
+
+  onselect: function(id, value) {
+    this.set(id, value);
+    if (this.options.onchange) this.options.onchange.call(this, id, value);
+    this.close();
+  },
+
+  /**
+   * sets the id/label
+   */
+  set: function(id, label) {
+    this.obj.value = label.unescapeHTML();
+    this.hidden_input.value = id;
+  }
+});
+
+/**
+ * Used by record_multi_select_field helper.
+ * Options:
+ *   list - the id (or object) of the <ul> to contain the <li>s of selected entries
+ *   current - an array of id:/label: keys designating the currently selected entries
+ */
+RecordSelect.Multiple = Class.create();
+RecordSelect.Multiple.prototype = Object.extend(new RecordSelect.Abstract(), {
+  onload: function() {
+    // initialize the container
+    this.container = this.create_container();
+    this.container.addClassName('record-select-autocomplete');
+
+    // decide where the <li> entries should be placed
+    if (this.options.list) this.list_container = $(this.options.list);
+    else this.list_container = this.obj.next('ul');
+
+    // take the input name from the text input, and store it for this.add()
+    this.input_name = this.obj.name;
+    this.obj.name = '';
+
+    // initialize the list
+    $A(this.options.current).each(function(c) {
+      this.add(c.id, c.label);
+    }.bind(this));
+
+    this._respond_to_text_field(this.obj);
+    if (this.obj.focused) this.open(); // if it was focused before we could attach observers
+  },
+
+  onselect: function(id, value) {
+    this.add(id, value);
+  },
+
+  /**
+   * Adds a record to the selected list
+   */
+  add: function(id, label) {
+    // return silently if this value has already been selected
+    var already_selected = this.list_container.getElementsBySelector('input').any(function(i) {
+      return i.value == id
+    });
+    if (already_selected) return;
+
+    var entry = '<li>'
+              + '<a href="#" onclick="$(this.parentNode).remove(); return false;" class="remove">remove</a>'
+              + '<input type="hidden" name="' + this.input_name + '" value="' + id + '" />'
+              + '<label>' + label + '</label>'
+              + '</li>';
+    new Insertion.Top(this.list_container, entry);
+  }
+});

data/lib/record_select/helpers/record_select_helper.rb

@@ -29,24 +29,58 @@ module RecordSelectHelper
   # +controller+::  The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of +current+ (the second argument)
   # +params+::      A hash of extra URL parameters
   # +id+::          The id to use for the input. Defaults based on the input's name.
+  # +field_name+::  The name to use for the text input. Defaults to '', so field is not submitted.
   # +onchange+::    A JavaScript function that will be called whenever something new is selected. It should accept the new id as the first argument, and the new label as the second argument. For example, you could set onchange to be "function(id, label) {alert(id);}", or you could create a JavaScript function somewhere else and set onchange to be "my_function" (without the parantheses!).
   def record_select_field(name, current, options = {})
     options[:controller] ||= current.class.to_s.pluralize.underscore
     options[:params] ||= {}
     options[:id] ||= name.gsub(/[\[\]]/, '_')
 
+    id = options.delete(:id)
+    html = text_field_tag(name, nil, :autocomplete => 'off', :id => id, :class => options.delete(:class), :onfocus => "this.focused=true", :onblur => "this.focused=false")
+
     controller = assert_controller_responds(options[:controller])
 
-    id = label = ''
+    options[:id] = options[:label] = ''
     if current and not current.new_record?
-      id = current.id
-      label = label_for_field(current, controller)
+      options[:id] = current.id
+      options[:label] = label_for_field(current, controller)
     end
 
-    url = url_for({:action => :browse, :controller => options[:controller], :escape => false}.merge(options[:params]))
+    url = url_for({:action => :browse, :controller => options.delete(:controller), :escape => false}.merge(options.delete(:params)))
+    html << javascript_tag("new RecordSelect.Single(#{id.to_json}, #{url.to_json}, #{options.to_json});")
+
+    return html
+  end
+
+  # Adds a RecordSelect-based form field. The field is autocompleted.
+  #
+  # *Arguments*
+  # +name+:: the input name that will be used to submit the selected value.
+  # +current+:: the current object. provide a new record if there're none currently selected and you have not passed the optional :controller argument.
+  #
+  # *Options*
+  # +controller+::  The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of +current+ (the second argument)
+  # +params+::      A hash of extra URL parameters
+  # +id+::          The id to use for the input. Defaults based on the input's name.
+  # +onchange+::    A JavaScript function that will be called whenever something new is selected. It should accept the new id as the first argument, and the new label as the second argument. For example, you could set onchange to be "function(id, label) {alert(id);}", or you could create a JavaScript function somewhere else and set onchange to be "my_function" (without the parantheses!).
+  def record_select_autocomplete(name, current, options = {})
+    options[:controller] ||= current.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+
+    id = options.delete(:id)
+    html = text_field_tag(name, nil, :autocomplete => 'off', :id => id, :class => options.delete(:class), :onfocus => "this.focused=true", :onblur => "this.focused=false")
+
+    controller = assert_controller_responds(options[:controller])
+
+    options[:label] = ''
+    if current and not current.new_record?
+      options[:label] = label_for_field(current, controller)
+    end
 
-    html = text_field_tag(name, nil, :autocomplete => 'off', :id => options[:id], :class => options[:class], :onfocus => "this.focused=true", :onblur => "this.focused=false")
-    html << javascript_tag("new RecordSelect.Single(#{options[:id].to_json}, #{url.to_json}, {id: #{id.to_json}, label: #{label.to_json}, onchange: #{options[:onchange] || ''.to_json}});")
+    url = url_for({:action => :browse, :controller => options.delete(:controller), :escape => false}.merge(options.delete(:params)))
+    html << javascript_tag("new RecordSelect.Autocomplete(#{id.to_json}, #{url.to_json}, #{options.to_json});")
 
     return html
   end

data/lib/record_select/helpers/record_select_helper.rb~

@@ -0,0 +1,209 @@
+module RecordSelectHelper
+  # Adds a link on the page that toggles a RecordSelect widget from the given controller.
+  #
+  # *Options*
+  # +onselect+::  JavaScript code to handle selections client-side. This code has access to two variables: id, label. If the code returns false, the dialog will *not* close automatically.
+  # +params+::    Extra URL parameters. If any parameter is a column name, the parameter will be used as a search term to filter the result set.
+  def link_to_record_select(name, controller, options = {})
+    options[:params] ||= {}
+    options[:params].merge!(:controller => controller, :action => :browse)
+    options[:onselect] = "function(id, label) {#{options[:onselect]}}" if options[:onselect]
+    options[:html] ||= {}
+    options[:html][:id] ||= "rs_#{rand(9999)}"
+
+    assert_controller_responds(options[:params][:controller])
+
+    html = link_to_function(name, '', options[:html])
+    html << javascript_tag("new RecordSelect.Dialog(#{options[:html][:id].to_json}, #{url_for(options[:params].merge(:escape => false)).to_json}, {onselect: #{options[:onselect] || ''}})")
+
+    return html
+  end
+
+  # Adds a RecordSelect-based form field. The field submits the record's id using a hidden input.
+  #
+  # *Arguments*
+  # +name+:: the input name that will be used to submit the selected record's id.
+  # +current+:: the currently selected object. provide a new record if there're none currently selected and you have not passed the optional :controller argument.
+  #
+  # *Options*
+  # +controller+::  The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of +current+ (the second argument)
+  # +params+::      A hash of extra URL parameters
+  # +id+::          The id to use for the input. Defaults based on the input's name.
+  # +field_name+::  The name to use for the text input. Defaults to '', so field is not submitted.
+  # +onchange+::    A JavaScript function that will be called whenever something new is selected. It should accept the new id as the first argument, and the new label as the second argument. For example, you could set onchange to be "function(id, label) {alert(id);}", or you could create a JavaScript function somewhere else and set onchange to be "my_function" (without the parantheses!).
+  def record_select_field(name, current, options = {})
+    options[:controller] ||= current.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+
+    id = options.delete(:id)
+    html = text_field_tag(name, nil, :autocomplete => 'off', :id => id, :class => options.delete(:class), :onfocus => "this.focused=true", :onblur => "this.focused=false")
+
+    controller = assert_controller_responds(options[:controller])
+
+    options[:id] = options[:label] = ''
+    if current and not current.new_record?
+      options[:id] = current.id
+      options[:label] = label_for_field(current, controller)
+    end
+
+    url = url_for({:action => :browse, :controller => options.delete(:controller), :escape => false}.merge(options.delete(:params)))
+    html << javascript_tag("new RecordSelect.Single(#{id.to_json}, #{url.to_json}, #{options.to_json});")
+
+    return html
+  end
+
+  # Adds a RecordSelect-based form field. The field is autocompleted.
+  #
+  # *Arguments*
+  # +name+:: the input name that will be used to submit the selected value.
+  # +current+:: the current object. provide a new record if there're none currently selected and you have not passed the optional :controller argument.
+  #
+  # *Options*
+  # +controller+::  The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of +current+ (the second argument)
+  # +params+::      A hash of extra URL parameters
+  # +id+::          The id to use for the input. Defaults based on the input's name.
+  # +onchange+::    A JavaScript function that will be called whenever something new is selected. It should accept the new id as the first argument, and the new label as the second argument. For example, you could set onchange to be "function(id, label) {alert(id);}", or you could create a JavaScript function somewhere else and set onchange to be "my_function" (without the parantheses!).
+  def record_select_autocomplete(name, current, options = {})
+    options[:controller] ||= current.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+
+    html = text_field_tag(name, nil, :autocomplete => 'off', :id => options.delete(:id), :class => options.delete(:class), :onfocus => "this.focused=true", :onblur => "this.focused=false")
+
+    controller = assert_controller_responds(options[:controller])
+
+    options[:label] = ''
+    if current and not current.new_record?
+      options[:label] = label_for_field(current, controller)
+    end
+
+    url = url_for({:action => :browse, :controller => options.delete(:controller), :escape => false}.merge(options.delete(:params)))
+    html << javascript_tag("new RecordSelect.Autocomplete(#{options[:id].to_json}, #{url.to_json}, #{options.to_json});")
+
+    return html
+  end
+
+  # Assists with the creation of an observer for the :onchange option of the record_select_field method.
+  # Currently only supports building an Ajax.Request based on the id of the selected record.
+  #
+  # options[:url] should be a hash with all the necessary options *except* :id. that parameter
+  # will be provided based on the selected record.
+  #
+  # Question: if selecting users, what's more likely?
+  #   /users/5/categories
+  #   /categories?user_id=5
+  def record_select_observer(options = {})
+    fn = ""
+    fn << "function(id, value) {"
+    fn <<   "var url = #{url_for(options[:url].merge(:id => ":id:")).to_json}.replace(/:id:/, id);"
+    fn <<   "new Ajax.Request(url);"
+    fn << "}"
+  end
+
+  # Adds a RecordSelect-based form field for multiple selections. The values submit using a list of hidden inputs.
+  #
+  # *Arguments*
+  # +name+:: the input name that will be used to submit the selected records' ids. empty brackets will be appended to the name.
+  # +current+:: pass a collection of existing associated records
+  #
+  # *Options*
+  # +controller+::  The controller configured to provide the result set.
+  # +params+::      A hash of extra URL parameters
+  # +id+::          The id to use for the input. Defaults based on the input's name.
+  def record_multi_select_field(name, current, options = {})
+    options[:controller] ||= current.first.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+
+    controller = assert_controller_responds(options[:controller])
+
+    # js identifier so we can talk to it.
+    widget = "rs_%s" % name.gsub(/[\[\]]/, '_').chomp('_')
+
+    current = current.inject([]) { |memo, record| memo.push({:id => record.id, :label => label_for_field(record, controller)}) }
+
+    url = url_for({:action => :browse, :controller => options[:controller], :escape => false}.merge(options[:params]))
+
+    html = text_field_tag("#{name}[]", nil, :autocomplete => 'off', :id => options[:id], :class => options[:class], :onfocus => "this.focused=true", :onblur => "this.focused=false")
+    html << content_tag('ul', '', :class => 'record-select-list');
+    html << javascript_tag("#{widget} = new RecordSelect.Multiple(#{options[:id].to_json}, #{url.to_json}, {current: #{current.to_json}});")
+
+    return html
+  end
+
+  # A helper to render RecordSelect partials
+  def render_record_select(options = {}) #:nodoc:
+    controller.send(:render_record_select, options) do |options|
+      render options
+    end
+  end
+
+  # Provides view access to the RecordSelect configuration
+  def record_select_config #:nodoc:
+    controller.send :record_select_config
+  end
+
+  # The id of the RecordSelect widget for the given controller.
+  def record_select_id(controller = nil) #:nodoc:
+    controller ||= params[:controller]
+    "record-select-#{controller.gsub('/', '_')}"
+  end
+
+  def record_select_search_id(controller = nil) #:nodoc:
+    "#{record_select_id(controller)}-search"
+  end
+
+  private
+  # render the record using the renderer and add a link to select the record
+  def render_record_in_list(record, controller_path)
+    text = render_record_from_config(record)
+    if record_select_config.link?
+      url_options = {:controller => controller_path, :action => :select, :id => record.id, :escape => false}
+      link_to text, url_options, :method => :post, :remote => true, :class => ''
+    else
+      text
+    end
+  end
+
+
+  # uses renderer (defaults to record_select_config.label) to determine how the given record renders.
+  def render_record_from_config(record, renderer = record_select_config.label)
+    case renderer
+    when Symbol, String
+      # return full-html from the named partial
+      render :partial => renderer.to_s, :locals => {:record => record}
+
+    when Proc
+      # return an html-cleaned descriptive string
+      h renderer.call(record)
+    end
+  end
+
+  # uses the result of render_record_from_config to snag an appropriate record label
+  # to display in a field.
+  #
+  # if given a controller, searches for a partial in its views path
+  def label_for_field(record, controller = self.controller)
+    renderer = controller.record_select_config.label
+    case renderer
+    when Symbol, String
+      # find the <label> element and grab its innerHTML
+      description = render_record_from_config(record, File.join(controller.controller_path, renderer.to_s))
+      description.match(/<label[^>]*>(.*)<\/label>/)[1]
+
+    when Proc
+      # just return the string
+      render_record_from_config(record, renderer)
+    end
+  end
+
+  def assert_controller_responds(controller_name)
+    controller_name = "#{controller_name.camelize}Controller"
+    controller = controller_name.constantize
+    unless controller.uses_record_select?
+      raise "#{controller_name} has not been configured to use RecordSelect."
+    end
+    controller
+  end
+end

data/lib/record_select/version.rb

@@ -2,7 +2,7 @@ module RecordSelect
   module Version
     MAJOR = 3
     MINOR = 1
-    PATCH = 2
+    PATCH = 3
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: recordselect
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 3
   - 1
-  - 2
-  version: 3.1.2
+  - 3
+  version: 3.1.3
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-21 00:00:00 Z
+date: 2011-11-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -98,6 +98,7 @@ files:
 - app/assets/javascripts/jquery/record_select.js
 - app/assets/javascripts/jquery/record_select.js~
 - app/assets/javascripts/prototype/record_select.js
+- app/assets/javascripts/prototype/record_select.js~
 - app/assets/javascripts/record_select.js.erb
 - app/assets/stylesheets/record_select.css.erb
 - lib/record_select.rb
@@ -110,6 +111,7 @@ files:
 - lib/record_select/extensions/localization.rb
 - lib/record_select/extensions/routing_mapper.rb
 - lib/record_select/helpers/record_select_helper.rb
+- lib/record_select/helpers/record_select_helper.rb~
 - lib/record_select/version.rb
 - lib/record_select/engine.rb
 - MIT-LICENSE