repeated_auto_complete 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README

@@ -0,0 +1,102 @@
+Fork of the standard auto_complete plugin to support:
+
+1. Creating auto complete text fields that can be repeated more than once a single form.
+
+2. Using auto_complete_for with named scopes to display a customized list
+of autocomplete options.
+
+See: http://patshaughnessy.net/repeated_auto_complete for details.
+
+
+Repeated autocomplete text fields:
+==================================
+
+A "text_field_with_auto_complete" method is made available to the form builder
+yielded by form_for and fields_for that:
+- Insures unique id's for <input> and <div> tags by inserting unique integers into their
+id attributes
+- Uses the object name from the surrounding call to form_for or fields_for so attribute
+mass assignment will work as usual
+- Works with the same server side controller method, auto_complete_for, as usual
+- Supports nested attributes in Rails 2.3
+
+form.text_field_with_auto_complete works the same as the original text_field_with_auto_complete macro,
+except it does not take the object as a parameter.
+
+Example with nested attributes using Rails 2.3 or later:
+
+class Project < ActiveRecord::Base
+  has_many :tasks
+  accepts_nested_attributes_for :tasks, :allow_destroy => true
+end
+
+<% form_for @project do |project_form| %>
+  <p>
+    <%= project_form.label :name, "Project:" %>
+    <%= project_form.text_field_with_auto_complete :name, {}, {:method => :get } %>
+  </p>
+  <% project_form.fields_for :tasks do |task_form| %>
+    <p>
+      <%= task_form.label :name, "Task:" %>
+      <%= task_form.text_field_with_auto_complete :name, {}, { :method => :get, :skip_style => true } %>
+    </p>
+  <% end %>
+<% end %>
+
+
+Rails 2.2 and earlier example:
+
+<% for person in @group.people %>
+  <% fields_for "group[person_attributes][]", person do |person_form| %>
+    <p>
+      Person <%= person_form.label :name %><br/>
+      <%= person_form.text_field_with_auto_complete :name, {}, {:method => :get }  %>
+    </p>
+  <% end %>
+<% end %>
+
+
+
+Named scopes with auto_complete_for:
+====================================
+
+auto_complete_for now optionally accepts a block that is called with the item list and HTTP parameters
+when the auto complete AJAX request is received. This block can be used to specify that a named scope
+be used to generate a customized list of autocomplete options.
+
+Example using anonymous scope:
+
+auto_complete_for :some_model, :some_other_field do |items, params|
+  items.scoped( { :conditions => [ "a_third_field = ?", params['some_model']['a_third_field'] ] })
+end
+
+
+
+Example using named scope:
+
+class Task < ActiveRecord::Base
+  belongs_to :project
+  named_scope :by_project,
+    lambda { |project_name| {
+      :include => :project,
+      :conditions => [ "projects.name = ?", project_name ]
+    } }
+end
+
+auto_complete_for :task, :name do | items, params |
+  items.by_project(params['project'])
+end
+
+
+
+Autocomplete Scaffolding:
+=========================
+
+The "View Mapper" gem will generate scaffolding code that illustrates how to use
+the standard Rails auto_complete plugin in a simple form, or the repeated_auto_complete
+plugin/gem in a complex form.
+
+See: http://pats
+
+
+Copyright (c) 2009 [Pat Shaughnessy], released under the MIT license

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "repeated_auto_complete"
+    gem.summary = %Q{auto_complete plugin refactored to handle complex forms and named scopes}
+    gem.description = %Q{auto_complete plugin refactored to handle complex forms and named scopes}
+    gem.email = "pat@patshaughnessy.net"
+    gem.homepage = "http://patshaughnessy.net/repeated_auto_complete"
+    gem.authors = ["Pat Shaughnessy"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "repeated_auto_complete #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,3 @@
+ActionController::Base.send :include, AutoComplete
+ActionController::Base.helper AutoCompleteMacrosHelper
+ActionView::Helpers::FormBuilder.send :include, AutoCompleteFormBuilderHelper

data/lib/auto_complete.rb

@@ -0,0 +1,49 @@
+module AutoComplete      
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  #
+  # Example:
+  #
+  #   # Controller
+  #   class BlogController < ApplicationController
+  #     auto_complete_for :post, :title
+  #   end
+  #
+  #   # View
+  #   <%= text_field_with_auto_complete :post, title %>
+  #
+  # By default, auto_complete_for limits the results to 10 entries,
+  # and sorts by the given field.
+  # 
+  # auto_complete_for takes a third parameter, an options hash to
+  # the find method used to search for the records:
+  #
+  #   auto_complete_for :post, :title, :limit => 15, :order => 'created_at DESC'
+  #
+  # For help on defining text input fields with autocompletion, 
+  # see ActionView::Helpers::JavaScriptHelper.
+  #
+  # For more examples, see script.aculo.us:
+  # * http://script.aculo.us/demos/ajax/autocompleter
+  # * http://script.aculo.us/demos/ajax/autocompleter_customized
+  module ClassMethods
+    def auto_complete_for(object, method, options = {})
+      define_method("auto_complete_for_#{object}_#{method}") do
+        model = object.to_s.camelize.constantize
+        find_options = { 
+          :conditions => [ "LOWER(#{model.quoted_table_name}.#{method}) LIKE ?", '%' + params[object][method].downcase + '%' ],
+          :order => "#{model.quoted_table_name}.#{method} ASC",
+          :limit => 10 }.merge!(options)
+        
+        @items = model.scoped(find_options)
+        @items = yield(@items, params) if block_given?
+
+        render :inline => "<%= auto_complete_result @items, '#{method}' %>"
+      end
+    end
+  end
+  
+end

data/lib/auto_complete_form_builder_helper.rb

@@ -0,0 +1,38 @@
+module AutoCompleteFormBuilderHelper
+
+  def class_name
+    "#{@object.class.to_s.underscore}"
+  end
+
+  def sanitized_object_name
+    @object_name.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")
+  end
+
+  def is_used_as_nested_attribute?
+    /\[#{class_name.pluralize}_attributes\]\[[0-9]+\]/.match @object_name
+  end
+  
+  def text_field_with_auto_complete(method, tag_options = {}, completion_options = {})
+    if completion_options[:child_index]
+      unique_object_name = "#{class_name}_#{completion_options[:child_index]}"
+    elsif @options[:child_index]
+      unique_object_name = "#{class_name}_#{@options[:child_index]}"
+    elsif is_used_as_nested_attribute?
+      unique_object_name = sanitized_object_name
+    else
+      unique_object_name = "#{class_name}_#{Object.new.object_id.abs}"
+    end
+    completion_options_for_class_name = {
+      :url => { :action => "auto_complete_for_#{class_name}_#{method}" },
+      :param_name => "#{class_name}[#{method}]"
+    }.update(completion_options)
+    @template.auto_complete_field_with_style_and_script(unique_object_name,
+                                                        method,
+                                                        tag_options,
+                                                        completion_options_for_class_name
+                                                       ) do
+      text_field(method, { :id => "#{unique_object_name}_#{method}" }.update(tag_options))
+    end
+  end
+
+end

data/lib/auto_complete_macros_helper.rb

@@ -0,0 +1,152 @@
+module AutoCompleteMacrosHelper      
+  # Adds AJAX autocomplete functionality to the text input field with the 
+  # DOM ID specified by +field_id+.
+  #
+  # This function expects that the called action returns an HTML <ul> list,
+  # or nothing if no entries should be displayed for autocompletion.
+  #
+  # You'll probably want to turn the browser's built-in autocompletion off,
+  # so be sure to include an <tt>autocomplete="off"</tt> attribute with your text
+  # input field.
+  #
+  # The autocompleter object is assigned to a Javascript variable named <tt>field_id</tt>_auto_completer.
+  # This object is useful if you for example want to trigger the auto-complete suggestions through
+  # other means than user input (for that specific case, call the <tt>activate</tt> method on that object). 
+  # 
+  # Required +options+ are:
+  # <tt>:url</tt>::                  URL to call for autocompletion results
+  #                                  in url_for format.
+  # 
+  # Addtional +options+ are:
+  # <tt>:update</tt>::               Specifies the DOM ID of the element whose 
+  #                                  innerHTML should be updated with the autocomplete
+  #                                  entries returned by the AJAX request. 
+  #                                  Defaults to <tt>field_id</tt> + '_auto_complete'
+  # <tt>:with</tt>::                 A JavaScript expression specifying the
+  #                                  parameters for the XMLHttpRequest. This defaults
+  #                                  to 'fieldname=value'.
+  # <tt>:frequency</tt>::            Determines the time to wait after the last keystroke
+  #                                  for the AJAX request to be initiated.
+  # <tt>:indicator</tt>::            Specifies the DOM ID of an element which will be
+  #                                  displayed while autocomplete is running.
+  # <tt>:tokens</tt>::               A string or an array of strings containing
+  #                                  separator tokens for tokenized incremental 
+  #                                  autocompletion. Example: <tt>:tokens => ','</tt> would
+  #                                  allow multiple autocompletion entries, separated
+  #                                  by commas.
+  # <tt>:min_chars</tt>::            The minimum number of characters that should be
+  #                                  in the input field before an Ajax call is made
+  #                                  to the server.
+  # <tt>:on_hide</tt>::              A Javascript expression that is called when the
+  #                                  autocompletion div is hidden. The expression
+  #                                  should take two variables: element and update.
+  #                                  Element is a DOM element for the field, update
+  #                                  is a DOM element for the div from which the
+  #                                  innerHTML is replaced.
+  # <tt>:on_show</tt>::              Like on_hide, only now the expression is called
+  #                                  then the div is shown.
+  # <tt>:after_update_element</tt>:: A Javascript expression that is called when the
+  #                                  user has selected one of the proposed values. 
+  #                                  The expression should take two variables: element and value.
+  #                                  Element is a DOM element for the field, value
+  #                                  is the value selected by the user.
+  # <tt>:parameters</tt>:: 	     To send additional parameters to the server, 
+  #				     add them here in the format: 'field=value&another=value'.
+  # <tt>:select</tt>::               Pick the class of the element from which the value for 
+  #                                  insertion should be extracted. If this is not specified,
+  #                                  the entire element is used.
+  # <tt>:method</tt>::               Specifies the HTTP verb to use when the autocompletion
+  #                                  request is made. Defaults to POST.
+  def auto_complete_field(field_id, options = {})
+    function =  "var #{field_id}_auto_completer = new Ajax.Autocompleter("
+    function << "'#{field_id}', "
+    function << "'" + (options[:update] || "#{field_id}_auto_complete") + "', "
+    function << "'#{url_for(options[:url])}'"
+    
+    js_options = {}
+    js_options[:tokens] = array_or_string_for_javascript(options[:tokens]) if options[:tokens]
+    js_options[:callback]   = "function(element, value) { return #{options[:with]} }" if options[:with]
+    js_options[:indicator]  = "'#{options[:indicator]}'" if options[:indicator]
+    js_options[:select]     = "'#{options[:select]}'" if options[:select]
+    js_options[:paramName]  = "'#{options[:param_name]}'" if options[:param_name]
+    js_options[:frequency]  = "#{options[:frequency]}" if options[:frequency]
+    js_options[:method]     = "'#{options[:method].to_s}'" if options[:method]
+    js_options[:parameters]  = "'#{options[:parameters]}'" if options[:parameters]
+
+    { :after_update_element => :afterUpdateElement, 
+      :on_show => :onShow, :on_hide => :onHide, :min_chars => :minChars }.each do |k,v|
+      js_options[v] = options[k] if options[k]
+    end
+
+    function << (', ' + options_for_javascript(js_options) + ')')
+
+    javascript_tag(function)
+  end
+  
+  # Use this method in your view to generate a return for the AJAX autocomplete requests.
+  #
+  # Example action:
+  #
+  #   def auto_complete_for_item_title
+  #     @items = Item.find(:all, 
+  #       :conditions => [ 'LOWER(description) LIKE ?', 
+  #       '%' + request.raw_post.downcase + '%' ])
+  #     render :inline => "<%= auto_complete_result(@items, 'description') %>"
+  #   end
+  #
+  # The auto_complete_result can of course also be called from a view belonging to the 
+  # auto_complete action if you need to decorate it further.
+  def auto_complete_result(entries, field, phrase = nil)
+    return unless entries
+    items = entries.map { |entry| content_tag("li", phrase ? highlight(entry[field], phrase) : h(entry[field])) }
+    content_tag("ul", items.uniq)
+  end
+  
+  # Wrapper for text_field with added AJAX autocompletion functionality.
+  #
+  # In your controller, you'll need to define an action called
+  # auto_complete_for to respond the AJAX calls,
+  # 
+  def text_field_with_auto_complete(object, method, tag_options = {}, completion_options = {})
+    auto_complete_field_with_style_and_script(object, method, tag_options, completion_options) do
+      text_field(object, method, tag_options)
+    end
+  end
+
+  def auto_complete_field_with_style_and_script(object, method, tag_options = {}, completion_options = {})
+    (completion_options[:skip_style] ? "" : auto_complete_stylesheet) +
+    yield +
+    content_tag("div", "", :id => "#{object}_#{method}_auto_complete", :class => "auto_complete") +
+    auto_complete_field("#{object}_#{method}", { :url => { :action => "auto_complete_for_#{object}_#{method}" } }.update(completion_options))
+  end
+
+  private
+    def auto_complete_stylesheet
+      content_tag('style', <<-EOT, :type => Mime::CSS)
+        div.auto_complete {
+          width: 350px;
+          background: #fff;
+        }
+        div.auto_complete ul {
+          border:1px solid #888;
+          margin:0;
+          padding:0;
+          width:100%;
+          list-style-type:none;
+        }
+        div.auto_complete ul li {
+          margin:0;
+          padding:3px;
+        }
+        div.auto_complete ul li.selected {
+          background-color: #ffb;
+        }
+        div.auto_complete ul strong.highlight {
+          color: #800; 
+          margin:0;
+          padding:0;
+        }
+      EOT
+    end
+
+end   

data/lib/repeated_auto_complete.rb

@@ -0,0 +1,4 @@
+require 'auto_complete.rb'
+require 'auto_complete_form_builder_helper.rb'
+require 'auto_complete_macros_helper.rb'
+require 'view_mapper/has_many_auto_complete_view.rb'

data/lib/view_mapper/README

@@ -0,0 +1,4 @@
+The code in this folder is a "View Mapper" module. It will generate scaffolding for a complex form
+that uses auto complete and nested attributes.
+
+For details see: http://patshaughnessy.net/view_mapper

data/lib/view_mapper/has_many_auto_complete_view.rb

@@ -0,0 +1,88 @@
+module ViewMapper
+  module HasManyAutoCompleteView
+
+    def self.extended(base)
+      base.extend(ViewMapper::HasManyChildModels)
+    end
+
+    def self.source_root
+      File.expand_path(File.dirname(__FILE__) + "/templates")
+    end
+
+    def source_roots_for_view
+      [
+        HasManyAutoCompleteView.source_root,
+        HasManyView.source_root,
+        File.expand_path(source_root),
+        File.expand_path(File.join(self.class.lookup('model').path, 'templates'))
+      ]
+    end
+
+    def manifest
+      m = super.edit do |action|
+        action unless is_child_model_action?(action)
+      end
+      add_child_models_manifest(m)
+      add_auto_complete_manifest(m)
+      m
+    end
+
+    def add_auto_complete_manifest(m)
+      if valid
+        auto_complete_attributes.each do |attrib|
+          add_auto_complete_route(m, attrib[:model_name], attrib[:text_field])
+        end
+      end
+    end
+
+    def add_auto_complete_route(manifest, model_name, text_field)
+      manifest.route :name       => 'connect',
+                     :path       => auto_complete_for_method(model_name, text_field),
+                     :controller => controller_file_name,
+                     :action     => auto_complete_for_method(model_name, text_field)
+    end
+
+    def auto_complete_for_method(model_name, text_field)
+      "auto_complete_for_#{model_name}_#{text_field}"
+    end
+
+    def auto_complete_attributes
+      @auto_complete_attributes = find_auto_complete_attributes
+    end
+
+    def find_auto_complete_attributes
+      attribs = []
+      if view_only?
+        attribs << auto_complete_attributes_for_model(model)
+      else
+        attribs << auto_complete_attributes_from_command_line
+      end
+      attribs << child_models.collect { |child| auto_complete_attributes_for_model(child) }
+      attribs.flatten
+    end
+
+    def auto_complete_attributes_for_model(model_info)
+      model_info.text_fields.collect do |text_field|
+        { :model_name => model_info.name.downcase, :text_field => text_field }
+      end
+    end
+
+    def auto_complete_attributes_from_command_line
+      attributes.reject do |cmd_line_attrib|
+        !ViewMapper::ModelInfo.is_text_field_attrib_type? cmd_line_attrib.type
+      end.collect do |cmd_line_attrib|
+        { :model_name => singular_name, :text_field => cmd_line_attrib.name }
+      end
+    end
+
+    def is_auto_complete_attribute?(model_name, text_field)
+      !auto_complete_attributes.detect { |attrib| attrib[:model_name] == model_name && attrib[:text_field] == text_field }.nil?
+    end
+
+    def validate
+      super
+      @valid &&= validate_child_models
+    end
+
+  end
+end