recordselect 3.2.5 → 3.2.6

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,217 @@
+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.
+  def record_select_field(name, current, options = {})
+    options[:controller] ||= current.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+    options[:class] ||= ''
+    options[:class] << ' recordselect'
+
+    ActiveSupport::Deprecation.warn 'onchange option is deprecated. Bind recordselect:change event instead.' if options[:onchange]
+
+    controller = assert_controller_responds(options.delete(:controller))
+    params = options.delete(:params)
+    record_select_options = {}
+    record_select_options[:field_name] = options.delete(:field_name) if options[:field_name]
+    if current and not current.new_record?
+      record_select_options[:id] = current.id
+      record_select_options[:label] = label_for_field(current, controller)
+    end
+
+    html = text_field_tag(name, nil, options.merge(:autocomplete => 'off', :onfocus => "this.focused=true", :onblur => "this.focused=false"))
+    url = url_for({:action => :browse, :controller => controller.controller_path, :escape => false}.merge(params))
+    html << javascript_tag("new RecordSelect.Single(#{options[:id].to_json}, #{url.to_json}, #{record_select_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.
+  def record_select_autocomplete(name, current, options = {})
+    options[:controller] ||= current.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+    options[:class] ||= ''
+    options[:class] << ' recordselect'
+
+    ActiveSupport::Deprecation.warn 'onchange option is deprecated. Bind recordselect:change event instead.' if options[:onchange]
+
+    controller = assert_controller_responds(options.delete(:controller))
+    params = options.delete(:params)
+    record_select_options = {}
+    if current
+      record_select_options[:label] = label_for_field(current, controller)
+    end
+
+    html = text_field_tag(name, nil, options.merge(:autocomplete => 'off', :onfocus => "this.focused=true", :onblur => "this.focused=false"))
+    url = url_for({:action => :browse, :controller => controller.controller_path, :escape => false}.merge(params))
+    html << javascript_tag("new RecordSelect.Autocomplete(#{options[:id].to_json}, #{url.to_json}, #{record_select_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(/[\[\]]/, '_')
+    options[:class] ||= ''
+    options[:class] << ' recordselect'
+    options.delete(:name)
+
+    controller = assert_controller_responds(options.delete(:controller))
+    params = options.delete(:params)
+    record_select_options = {}
+    record_select_options[:current] = current.inject([]) { |memo, record| memo.push({:id => record.id, :label => label_for_field(record, controller)}) }
+
+    html = text_field_tag("#{name}[]", nil, options.merge(:autocomplete => 'off', :onfocus => "this.focused=true", :onblur => "this.focused=false"))
+    html << hidden_field_tag("#{name}[]", '', :id => nil)
+    html << content_tag('ul', '', :class => 'record-select-list');
+
+    # js identifier so we can talk to it.
+    widget = "rs_%s" % name.gsub(/[\[\]]/, '_').chomp('_')
+    url = url_for({:action => :browse, :controller => controller.controller_path, :escape => false}.merge(params))
+    html << javascript_tag("#{widget} = new RecordSelect.Multiple(#{options[:id].to_json}, #{url.to_json}, #{record_select_options.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

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

data/lib/recordselect.rb

@@ -0,0 +1,14 @@
+require 'record_select'
+require 'record_select/extensions/localization'
+require 'record_select/extensions/active_record'
+require 'record_select/extensions/routing_mapper'
+require 'record_select/actions'
+require 'record_select/conditions'
+require 'record_select/config'
+require 'record_select/form_builder'
+require 'record_select/helpers/record_select_helper'
+require 'record_select/engine' unless defined? RECORD_SELECT_PLUGIN
+
+ActionController::Base.send(:include, RecordSelect)
+ActionView::Base.send(:include, RecordSelectHelper)
+ActionView::Helpers::FormBuilder.send(:include, RecordSelect::FormBuilder)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: recordselect
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 3
   - 2
-  - 5
-  version: 3.2.5
+  - 6
+  version: 3.2.6
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -17,10 +17,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-29 00:00:00 Z
+date: 2013-02-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +30,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id001
   prerelease: false
-  type: :development
-  requirement: *id001
   name: shoulda
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,26 +46,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  version_requirements: *id002
   prerelease: false
-  type: :development
-  requirement: *id002
   name: bundler
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  type: :development
-  requirement: *id003
-  name: rcov
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -75,9 +62,8 @@ dependencies:
         - 1
         - 3
         version: 3.1.3
+  version_requirements: *id003
   prerelease: false
-  type: :runtime
-  requirement: *id004
   name: rails
 description: RecordSelect is a Rails widget to help you pick one record out of many. I designed it as a more usable and performant alternative to generating a massive dropdown list
 email: activescaffold@googlegroups.com
@@ -88,6 +74,31 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- app/assets/images/record_select/cross.gif
+- app/assets/images/record_select/next.gif
+- app/assets/images/record_select/previous.gif
+- app/assets/javascripts/jquery/record_select.js
+- app/assets/javascripts/prototype/record_select.js
+- app/assets/javascripts/record_select.js.erb
+- app/assets/stylesheets/record_select.css.erb
+- app/views/record_select/_browse.html.erb
+- app/views/record_select/_list.html.erb
+- app/views/record_select/_search.html.erb
+- app/views/record_select/browse.js.erb
+- config/locales/en.yml
+- config/locales/es.yml
+- lib/record_select.rb
+- lib/record_select/actions.rb
+- lib/record_select/conditions.rb
+- lib/record_select/config.rb
+- lib/record_select/engine.rb
+- lib/record_select/extensions/active_record.rb
+- lib/record_select/extensions/localization.rb
+- lib/record_select/extensions/routing_mapper.rb
+- lib/record_select/form_builder.rb
+- lib/record_select/helpers/record_select_helper.rb
+- lib/record_select/version.rb
+- lib/recordselect.rb
 - MIT-LICENSE
 - CHANGELOG
 - README
@@ -121,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: RecordSelect widget as a replacement for massive drop down lists