recordselect 3.0.4

data/lib/record_select.rb

@@ -0,0 +1,37 @@
+module RecordSelect
+  def self.included(base)
+    base.send :extend, ClassMethods
+    #base.append_view_path "#{File.dirname(__FILE__)}/../app/views" if defined?(RECORD_SELECT_GEM)
+  end
+
+  module ClassMethods
+    # Enables and configures RecordSelect on your controller.
+    #
+    # *Options*
+    # +model+::     defaults based on the name of the controller
+    # +per_page+::  records to show per page when browsing
+    # +notify+::    a method name to invoke when a record has been selected.
+    # +order_by+::  a SQL string to order the search results
+    # +search_on+:: an array of searchable fields
+    # +full_text_search+::  a boolean for whether to use a %?% search pattern or not. default is false.
+    # +label+::     a proc that accepts a record as argument and returns an option label. default is to call record.to_label instead.
+    # +include+::   as for ActiveRecord::Base#find. can help with search conditions or just help optimize rendering the results.
+    # +link+::      a boolean for whether wrap the text returned by label in a link or not. default is true. set to false when
+    #               label returns html code which can't be inside a tag. You can use record_select_link_to_select in your proc
+    #               or partial to add a link to select action
+    #
+    # You may also pass a block, which will be used as options[:notify].
+    def record_select(options = {})
+      options[:model] ||= self.to_s.split('::').last.sub(/Controller$/, '').pluralize.singularize.underscore
+      @record_select_config = RecordSelect::Config.new(options.delete(:model), options)
+      self.send :include, RecordSelect::Actions
+      self.send :include, RecordSelect::Conditions
+    end
+
+    attr_reader :record_select_config
+
+    def uses_record_select?
+      !record_select_config.nil?
+    end
+  end
+end

data/lib/record_select/actions.rb

@@ -0,0 +1,68 @@
+module RecordSelect
+  module Actions
+    # :method => :get
+    # params => [:page, :search]
+    def browse
+      conditions = record_select_conditions
+      klass = record_select_config.model
+      @count = klass.count(:conditions => conditions, :include => record_select_includes)
+      pager = ::Paginator.new(@count, record_select_config.per_page) do |offset, per_page|
+        klass.find(:all, :offset => offset,
+                         :select => record_select_select||"*",
+                         :include => [record_select_includes, record_select_config.include].flatten.compact,
+                         :limit => per_page,
+                         :conditions => conditions,
+                         :order => record_select_config.order_by)
+      end
+      @page = pager.page(params[:page] || 1)
+
+      respond_to do |wants|
+        wants.html { render_record_select :partial => 'browse'}
+        wants.js {
+          if params[:update]
+            render_record_select :template => 'browse.js', :layout => false
+          else
+            render_record_select :partial => 'browse'
+          end
+        }
+        wants.yaml {}
+        wants.xml {}
+        wants.json {}
+      end
+    end
+
+    # :method => :post
+    # params => [:id]
+    def select
+      klass = record_select_config.model
+      record = klass.find(params[:id])
+      if record_select_config.notify.is_a? Proc
+        record_select_config.notify.call(record)
+      elsif record_select_config.notify
+        send(record_select_config.notify, record)
+      end
+      render :nothing => true
+    end
+
+    protected
+
+    def record_select_config #:nodoc:
+      self.class.record_select_config
+    end
+
+    def render_record_select(options = {}) #:nodoc:
+      [:template,:partial].each do |template_name|
+        if options[template_name] then
+          options[template_name] = File.join(record_select_views_path, options[template_name])
+        end
+      end
+      if block_given? then yield options else render options end
+    end
+
+    private
+
+    def record_select_views_path
+      "record_select"
+    end
+  end
+end

data/lib/record_select/conditions.rb

@@ -0,0 +1,100 @@
+module RecordSelect
+  module Conditions
+    protected
+    # returns the combination of all conditions.
+    # conditions come from:
+    # * current search (params[:search])
+    # * intelligent url params (e.g. params[:first_name] if first_name is a model column)
+    # * specific conditions supplied by the developer
+    def record_select_conditions
+      conditions = []
+
+      merge_conditions(
+        record_select_conditions_from_search,
+        record_select_conditions_from_params,
+        record_select_conditions_from_controller
+      )
+    end
+
+    # an override method.
+    # here you can provide custom conditions to define the selectable records. useful for situational restrictions.
+    def record_select_conditions_from_controller; end
+
+    # another override method.
+    # define any association includes you want for the finder search.
+    def record_select_includes; end
+
+    def record_select_like_operator
+      @like_operator ||= ::ActiveRecord::Base.connection.adapter_name == "PostgreSQL" ? "ILIKE" : "LIKE"
+    end
+
+    # define special list of selected fields,
+    # mainly to define extra fields that can be used for 
+    # specialized sorting.
+    def record_select_select; end
+
+    # generate conditions from params[:search]
+    # override this if you want to customize the search routine
+    def record_select_conditions_from_search
+      search_pattern = record_select_config.full_text_search? ? '%?%' : '?%'
+
+      if params[:search] and !params[:search].strip.empty?
+        if record_select_config.full_text_search?
+          tokens = params[:search].strip.split(' ')
+        else
+          tokens = []
+          tokens << params[:search].strip
+        end
+
+        where_clauses = record_select_config.search_on.collect { |sql| "#{sql} #{record_select_like_operator} ?" }
+        phrase = "(#{where_clauses.join(' OR ')})"
+
+        sql = ([phrase] * tokens.length).join(' AND ')
+        tokens = tokens.collect{ |value| [search_pattern.sub('?', value)] * record_select_config.search_on.length }.flatten
+
+        conditions = [sql, *tokens]
+      end
+    end
+
+    # instead of a shotgun approach, this assumes the user is
+    # searching vs some SQL field (possibly built with CONCAT())
+    # similar to the record labels.
+#    def record_select_simple_conditions_from_search
+#      return unless params[:search] and not params[:search].empty?
+#
+#      search_pattern = record_select_config.full_text_search? ? '%?%' : '?%'
+#      search_string = search_pattern.sub('?', value.downcase)
+#
+#      ["LOWER(#{record_select_config.search_on})", search_pattern.sub('?', value.downcase)]
+#    end
+
+    # generate conditions from the url parameters (e.g. users/browse?group_id=5)
+    def record_select_conditions_from_params
+      conditions = nil
+      params.each do |field, value|
+        next unless column = record_select_config.model.columns_hash[field]
+        conditions = merge_conditions(
+          conditions,
+          record_select_condition_for_column(column, value)
+        )
+      end
+      conditions
+    end
+
+    # generates an SQL condition for the given column/value
+    def record_select_condition_for_column(column, value)
+      if value.blank? and column.null
+        "#{column.name} IS NULL"
+      elsif column.text?
+        ["LOWER(#{column.name}) LIKE ?", value]
+      else
+        ["#{column.name} = ?", column.type_cast(value)]
+      end
+    end
+
+    def merge_conditions(*conditions) #:nodoc:
+      c = conditions.find_all {|c| not c.nil? and not c.empty? }
+      c.empty? ? nil : c.collect{|c| record_select_config.model.send(:sanitize_sql, c)}.join(' AND ')
+    end
+  end
+end

data/lib/record_select/config.rb

@@ -0,0 +1,99 @@
+module RecordSelect
+  # a write-once configuration object
+  class Config
+    def initialize(klass, options = {})
+      @klass = klass
+
+      @notify = block_given? ? proc : options[:notify]
+
+      @per_page = options[:per_page]
+
+      @search_on = [options[:search_on]].flatten unless options[:search_on].nil?
+
+      @order_by = options[:order_by]
+
+      @full_text_search = options[:full_text_search]
+
+      @label = options[:label]
+
+      @include = options[:include]
+
+      @link = options[:link]
+    end
+    
+    def self.js_framework=(framework)
+      @@js_framework = framework
+    end
+    
+    def self.js_framework
+      @@js_framework ||= :prototype
+    end
+
+    # The model object we're browsing
+    def model
+      @model ||= klass.to_s.camelcase.constantize
+    end
+
+    # Records to show on a page
+    def per_page
+      @per_page ||= 10
+    end
+
+    # The method name or proc to notify of a selection event.
+    # May not matter if the selection event is intercepted client-side.
+    def notify
+      @notify
+    end
+
+    # A collection of fields to search. This is essentially raw SQL, so you could search on "CONCAT(first_name, ' ', last_name)" if you wanted to.
+    # NOTE: this does *NO* default transforms (such as LOWER()), that's left entirely up to you.
+    def search_on
+      @search_on ||= self.model.columns.collect{|c| c.name if [:text, :string].include? c.type}.compact
+    end
+
+    def order_by
+      @order_by ||= "#{model.table_name}.#{model.primary_key} ASC" unless @order_by == false
+    end
+
+    def full_text_search?
+      @full_text_search ? true : false
+    end
+
+    def include
+      @include
+    end
+
+    # If a proc, must accept the record as an argument and return a descriptive string.
+    #
+    # If a symbol or string, must name a partial that renders a representation of the
+    # record. The partial should assume a local "record" variable, and should include a
+    # <label> tag, even if it's not visible. The contents of the <label> tag will be used
+    # to represent the record once it has been selected. For example:
+    #
+    #   record_select_config.label = :user_description
+    #
+    # > app/views/users/_user_description.erb
+    #
+    #   <div class="user_description">
+    #     <%= image_tag url_for_file_column(record, 'avatar') %>
+    #     <label><%= record.username %></label>
+    #     <p><%= record.quote %></p>
+    #   </div>
+    #
+    def label
+      @label ||= proc {|r| r.to_label}
+    end
+
+    # whether wrap the text returned by label in a link or not
+    def link?
+      @link.nil? ? true : @link
+    end
+
+    protected
+
+    # A singularized underscored version of the model we're browsing
+    def klass
+      @klass
+    end
+  end
+end

data/lib/record_select/engine.rb

@@ -0,0 +1,4 @@
+module RecordSelect
+  class Engine < Rails::Engine
+  end
+end

data/lib/record_select/extensions/active_record.rb

@@ -0,0 +1,9 @@
+module ActiveRecord # :nodoc:
+  class Base # :nodoc:
+    unless method_defined? :to_label
+    def to_label
+      self.to_s
+    end
+    end
+  end
+end

data/lib/record_select/extensions/localization.rb

@@ -0,0 +1,8 @@
+# Provides a simple pass-through localizer for RecordSelect. If you want
+# to localize RS, you need to override this method and route it to your
+# own system.
+class Object
+  def rs_(string_to_localize, *args)
+    args.empty? ? string_to_localize : (sprintf string_to_localize, *args)
+  end
+end

data/lib/record_select/extensions/routing_mapper.rb

@@ -0,0 +1,20 @@
+module ActionDispatch
+  module Routing
+    RECORD_SELECT_ROUTING = {
+        :collection => {:browse => :get},
+        :member => {:select => :post}
+    }
+    class Mapper
+      module Base
+        def record_select_routes
+          collection do
+            ActionDispatch::Routing::RECORD_SELECT_ROUTING[:collection].each {|name, type| send(type, name)}
+          end
+          member do
+            ActionDispatch::Routing::RECORD_SELECT_ROUTING[:member].each {|name, type| send(type, name)}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/record_select/form_builder.rb

@@ -0,0 +1,25 @@
+module RecordSelect
+  module FormBuilder
+    def record_select(association, options = {})
+      reflection = @object.class.reflect_on_association(association)
+      form_name = form_name_for_association(reflection)
+      current = @object.send(association)
+      options[:id] ||= "#{@object_name.gsub(/[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")}_#{association}"
+
+      if [:has_one, :belongs_to].include? reflection.macro
+        @template.record_select_field(form_name, current || reflection.klass.new, options)
+      else
+        options[:controller] ||= reflection.klass.to_s.pluralize.underscore
+        @template.record_multi_select_field(form_name, current, options)
+      end
+    end
+
+    private
+
+    def form_name_for_association(reflection)
+      key_name = (reflection.options[:foreign_key] || reflection.association_foreign_key)
+      key_name += "s" unless [:has_one, :belongs_to].include? reflection.macro
+      form_name = "#{@object_name}[#{key_name}]"
+    end
+  end
+end

data/lib/record_select/helpers/record_select_helper.rb

@@ -0,0 +1,185 @@
+module RecordSelectHelper
+  # Print this from your layout to include everything necessary for RecordSelect to work.
+  # Well, not everything. You need Prototype too.
+  def record_select_includes
+    includes = ''
+    includes << stylesheet_link_tag('record_select/record_select')
+    includes << javascript_include_tag('record_select/record_select')
+    includes.html_safe
+  end
+
+  # 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.
+  # +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(/[\[\]]/, '_')
+
+    controller = assert_controller_responds(options[:controller])
+
+    id = label = ''
+    if current and not current.new_record?
+      id = current.id
+      label = label_for_field(current, controller)
+    end
+
+    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 << 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}});")
+
+    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