mreinsch-auto_complete_jquery 0.2.1

data/CHANGELOG

@@ -0,0 +1,5 @@
+* 10 June 2009: 0.2.1
+- some documentation updates and code cleanups
+- support for named scopes
+
+* 1 July 2008: Switched to a different jQuery autocomplete plugin to be used with this plugin.  The previous plugin was not handling case insensitivity, was slow, and lacked various other options.  The new jQuery autocomplete plugin this depends on his a nice improvement, being massively faster, providing a CSS style you can use while your AJAX request runs, handling case properly, and adding a slew of options.

data/README.rdoc

@@ -0,0 +1,67 @@
+This plugin provides a auto-complete method for your controllers to be used
+with Dylan Verheul's jquery autocomplete plugin.  This jQuery plugin is not
+included, and can be obtained from:
+
+http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/
+
+This auto_complete_jquery plugin is just a modified version of the standard
+Rails auto_complete plugin.  It provides the same auto_complete_for method
+for your controllers, but eliminates the various view helper methods, as
+those are not needed when using jQuery and Unobtrusive JavaScript.
+
+To use this, you need to have jQuery and the autocomplete plugin mentioned 
+above (as well as appropriate CSS).  Then, there are four aspects of setting 
+up an auto-complete field:
+
+1) Create the text field in your view, which is just a regular form text
+field as you'd create in a Rails erb view:
+
+  <%= post.text_field :title, :autocomplete =>"off" %>
+  
+2) Include the appropriate JS files and CSS in your layout or similar:
+
+  <%= stylesheet_link_tag 'jquery.autocomplete' %>
+  <%= javascript_include_tag 'jquery.min', 'jquery.autocomplete.min', :cache => 'jquery' %>
+
+3) Use the auto_complete_for controller macro to generate the appropriate
+auto-complete method in your controller, such as:
+
+  # Controller
+  class BlogController < ApplicationController
+    auto_complete_for :post, :title
+  end
+
+4) Hook up the text field's autocomplete event in your JavaScript file
+using jQuery and the jquery-autocomplete plugin mechanism, for example:
+
+  $(document).ready(function() {
+    $("input#post_title").autocomplete({ajax: "/blog/auto_complete_for_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'
+
+5) Create a route for the auto complete function. You can add the following 
+generic route at the beginning of your config/routes.rb to take care of this:
+
+  map.auto_complete ':controller/:action',
+    :requirements => { :action => /auto_complete_for_\S+/ },
+    :conditions => { :method => :get }
+
+
+For more information, see:
+* jQuery site: http://jquery.com
+* Dylan Verheul jquery autocomplete plugin site: http://www.dyve.net/jquery/?autocomplete
+* Good article on jQuery and Rails (note this mentions a different jquery autocomplete 
+  plugin, which was originally used in this plugin): http://errtheblog.com/posts/73-the-jskinny-on-jquery
+* Original Rails auto_complete plugin: http://github.com/rails/auto_complete
+
+
+Copyright (c) 2008 Cobalt Edge LLC, released under the MIT license.
+Copyright (c) 2009 mobalean LLC, released under the MIT license.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake' 
+require 'rake/rdoctask' 
+   
+desc 'Generate documentation for auto_complete plugin.' 
+Rake::RDocTask.new(:rdoc) do |rdoc| 
+  rdoc.rdoc_dir = 'rdoc' 
+  rdoc.title    = 'Auto Complete jQuery' 
+  rdoc.options << '--line-numbers' << '--inline-source' 
+  rdoc.rdoc_files.include('README.rdoc') 
+  rdoc.rdoc_files.include('lib/**/*.rb') 
+end

data/auto_complete_jquery.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name     = "auto_complete_jquery"
+  s.version  = "0.2.1"
+  s.date     = "2009-06-10"
+  s.summary  = "auto-complete method for Rails controllers using Dylan Verheul's jQuery autocomplete plugin"
+  s.email    = "michael@mobalean.com"
+  s.homepage = "http://github.com/mreinsch/auto_complete_jquery"
+  s.description = "This plugin provides a auto-complete method for your controllers to be used with Dylan Verheul's jquery autocomplete plugin."
+  s.has_rdoc = true
+  s.authors  = ["Chris Bailey", "Michael Reinsch"]
+  s.files    = ["CHANGELOG", 
+		"README.rdoc", 
+		"Rakefile", 
+		"auto_complete_jquery.gemspec", 
+		"init.rb", 
+		"lib/auto_complete_jquery.rb"]
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc"]
+end

data/init.rb

@@ -0,0 +1 @@
+ActionController::Base.send :include, AutoCompleteJquery

data/lib/auto_complete_jquery.rb

@@ -0,0 +1,69 @@
+module AutoCompleteJquery
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  #
+  # Example:
+  #
+  #   # Controller
+  #   class BlogController < ApplicationController
+  #     auto_complete_for :post, :title
+  #   end
+  #
+  # 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'
+  #
+  # You can also use named scopes to limit the search results. Two types of
+  # named scopes are supported.
+  #
+  # 1) Without parameters:
+  #
+  #    auto_complete_for :post, :title, :scope => :red
+  #    named_scope :red, conditions => {color: => 'red'}
+  #
+  # This will use Post.red.find(:all, ...) to lookup the post titles.
+  #
+  # 2) With the current_user as parameter:
+  #
+  #    auto_complete_for :post, :title, :user_scope => :author
+  #    named_scope :author, lambda { |user|
+  #      { :conditions => { :author_id => user } }
+  #    }
+  #
+  # This would use Post.author(current_user).find(:all, ...) to lookup the 
+  # post titles. 
+  #
+  # For more on jQuery auto-complete, see the docs for the jQuery autocomplete
+  # plugin used in conjunction with this plugin:
+  # * http://www.dyve.net/jquery/?autocomplete
+  module ClassMethods
+    def auto_complete_for(object, method, options = {})
+      object_constant = object.to_s.camelize.constantize
+      scope = options.delete(:scope)
+      user_scope = options.delete(:user_scope)
+
+      finder = scope.nil? ? object_constant : object_constant.send(scope)
+      generic_find_options = {
+        :order => "#{method} ASC",
+        :select => "#{object_constant.table_name}.#{method}",
+        :limit => 10 }.merge!(options)
+      
+      define_method("auto_complete_for_#{object}_#{method}") do
+        find_options = generic_find_options.clone
+        find_options[:conditions] = [ "LOWER(#{method}) LIKE ?", '%' + params[:q].downcase + '%' ]
+        find_options[:limit] = [find_options[:limit], params[:limit].to_i].min if params[:limit]
+
+        render :text => (user_scope.nil? ? finder : finder.send(user_scope, current_user)).
+          find(:all, find_options).collect(&method).join("\n")
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: mreinsch-auto_complete_jquery
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Chris Bailey
+- Michael Reinsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This plugin provides a auto-complete method for your controllers to be used with Dylan Verheul's jquery autocomplete plugin.
+email: michael@mobalean.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README.rdoc
+files: 
+- CHANGELOG
+- README.rdoc
+- Rakefile
+- auto_complete_jquery.gemspec
+- init.rb
+- lib/auto_complete_jquery.rb
+has_rdoc: true
+homepage: http://github.com/mreinsch/auto_complete_jquery
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: auto-complete method for Rails controllers using Dylan Verheul's jQuery autocomplete plugin
+test_files: []
+