rails3-jquery-autocomplete 0.8.0 → 0.9.0

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* 0.9.0 Massive rewrite
 * 0.8.0 Compressed JS file
 * 0.7.5 Pull request #46
 * 0.7.4 Allows Rails 3.1

data/README.markdown

@@ -146,7 +146,7 @@ This options receives a method name as the parameter, and that method will be ca
 
 In the example above, you will search by _name_, but the autocomplete list will display the result of _funky_method_
 
-This wouldn't really make much sense unless you use it with the :id_element HTML tag. (See below)
+This wouldn't really make much sense unless you use it with the "id_element" attribute. (See below)
 
 Only the object's id and the column you are searching on will be returned in JSON, so if your display_value method requires another parameter, make sure to fetch it with the :extra_data option
 
@@ -159,6 +159,15 @@ Only the object's id and the column you are searching on will be returned in JSO
    By default autocomplete uses method name as column name. Now it can be specified using column_name options
    `:column_name => 'name'`
 
+#### json encoder
+Autocomplete uses Yajl as JSON encoder/decoder, but you can specify your own
+
+    class ProductsController < Admin::BaseController
+      autocomplete :brand, :name do |items|
+         CustomJSON::Encoder.encode(items)
+      end
+    end
+
 ### View
 
 On your view, all you have to do is include the attribute autocomplete on the text field
@@ -183,7 +192,7 @@ Now your autocomplete code is unobtrusive, Rails 3 style.
 
 ### Getting the object id
 
-If you need to use the id of the selected object, you can use the *:id_element* HTML tag too:
+If you need to use the id of the selected object, you can use the *id_element* attribute too:
 
     f.autocomplete_field :brand_name, autocomplete_brand_name_products_path, :id_element => '#some_element'
 

data/Rakefile

@@ -2,6 +2,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
+require 'rcov/rcovtask'
 
 task :default => [:uglify, :test]
 
@@ -18,3 +19,10 @@ task :uglify do
     f << Uglifier.compile(File.read("#{file_folder}/autocomplete-rails-uncompressed.js"))
   end
 end
+
+Rcov::RcovTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.rcov_opts = %w{--exclude \/gems\/}
+  t.verbose = true
+end

data/integration/app/views/id_elements/new.html.haml

@@ -6,7 +6,7 @@
     = form.text_field :name
   %p
     = form.label :brand_name
-    = form.autocomplete_field :brand_name, autocomplete_brand_name_id_elements_path, :id_element => '#product_brand_id'
+    = form.autocomplete_field :brand_name, autocomplete_brand_name_id_elements_path, 'data-id-element' => '#product_brand_id'
   %p
     = form.label :brand_id
     = form.text_field :brand_id

data/integration/public/javascripts/autocomplete-rails.js

@@ -11,103 +11,6 @@
 * be updated with the element id whenever you find a matching value
 *
 *   Example:
-*       <input type="text" data-autocomplete="/url/to/autocomplete" id_element="#id_field">
+*       <input type="text" data-autocomplete="/url/to/autocomplete" data-id-element="#id_field">
 */
-
-$(document).ready(function(){
-  $('input[data-autocomplete]').railsAutocomplete();
-});
-
-(function(jQuery)
-{
-  var self = null;
-  jQuery.fn.railsAutocomplete = function() {
-    return this.live('focus',function() {
-      if (!this.railsAutoCompleter) {
-        this.railsAutoCompleter = new jQuery.railsAutocomplete(this);
-      }
-    });
-  };
-
-  jQuery.railsAutocomplete = function (e) {
-    _e = e;
-    this.init(_e);
-  };
-
-  jQuery.railsAutocomplete.fn = jQuery.railsAutocomplete.prototype = {
-    railsAutocomplete: '0.0.1'
-  };
-
-  jQuery.railsAutocomplete.fn.extend = jQuery.railsAutocomplete.extend = jQuery.extend;
-  jQuery.railsAutocomplete.fn.extend({
-    init: function(e) {
-      e.delimiter = $(e).attr('data-delimiter') || null;
-      function split( val ) {
-        return val.split( e.delimiter );
-      }
-      function extractLast( term ) {
-        return split( term ).pop().replace(/^\s+/,"");
-      }
-
-      $(e).autocomplete({
-        source: function( request, response ) {
-          $.getJSON( $(e).attr('data-autocomplete'), {
-            term: extractLast( request.term )
-          }, function() {
-            $(arguments[0]).each(function(i, el) {
-              var obj = {};
-              obj[el.id] = el;
-              $(e).data(obj);
-            });
-            response.apply(null, arguments);
-          });
-        },
-        search: function() {
-          // custom minLength
-          var term = extractLast( this.value );
-          if ( term.length < 2 ) {
-            return false;
-          }
-        },
-        focus: function() {
-          // prevent value inserted on focus
-          return false;
-        },
-        select: function( event, ui ) {
-          var terms = split( this.value );
-          // remove the current input
-          terms.pop();
-          // add the selected item
-          terms.push( ui.item.value );
-          // add placeholder to get the comma-and-space at the end
-          if (e.delimiter != null) {
-            terms.push( "" );
-            this.value = terms.join( e.delimiter );
-          } else {
-            this.value = terms.join("");
-            if ($(this).attr('id_element')) {
-              $($(this).attr('id_element')).val(ui.item.id);
-            }
-            if ($(this).attr('data-update-elements')) {
-              var data = $(this).data(ui.item.id.toString());
-              var update_elements = $.parseJSON($(this).attr("data-update-elements"));
-              for (var key in update_elements) {
-                $(update_elements[key]).val(data[key]);
-              }
-            }
-          }
-          var remember_string = this.value;
-          $(this).bind('keyup.clearId', function(){
-            if($(this).val().trim() != remember_string.trim()){
-              $($(this).attr('id_element')).val("");
-              $(this).unbind('keyup.clearId');
-            }
-          });
-          $(this).trigger('railsAutocomplete.select');
-
-          return false;
-        }
-      });
-    }
-  });
-})(jQuery);
+$(document).ready(function(){$("input[data-autocomplete]").railsAutocomplete()}),function(a){var b=null;a.fn.railsAutocomplete=function(){return this.live("focus",function(){this.railsAutoCompleter||(this.railsAutoCompleter=new a.railsAutocomplete(this))})},a.railsAutocomplete=function(a){_e=a,this.init(_e)},a.railsAutocomplete.fn=a.railsAutocomplete.prototype={railsAutocomplete:"0.0.1"},a.railsAutocomplete.fn.extend=a.railsAutocomplete.extend=a.extend,a.railsAutocomplete.fn.extend({init:function(a){function c(a){return b(a).pop().replace(/^\s+/,"")}function b(b){return b.split(a.delimiter)}a.delimiter=$(a).attr("data-delimiter")||null,$(a).autocomplete({source:function(b,d){$.getJSON($(a).attr("data-autocomplete"),{term:c(b.term)},function(){$(arguments[0]).each(function(b,c){var d={};d[c.id]=c,$(a).data(d)}),d.apply(null,arguments)})},search:function(){var a=c(this.value);if(a.length<2)return!1},focus:function(){return!1},select:function(c,d){var f=b(this.value);f.pop(),f.push(d.item.value);if(a.delimiter!=null)f.push(""),this.value=f.join(a.delimiter);else{this.value=f.join(""),$(this).attr("data-id-element")&&$($(this).attr("data-id-element")).val(d.item.id);if($(this).attr("data-update-elements")){var g=$(this).data(d.item.id.toString()),h=$.parseJSON($(this).attr("data-update-elements"));for(var i in h)$(h[i]).val(g[i])}}var j=this.value;$(this).bind("keyup.clearId",function(){$(this).val().trim()!=j.trim()&&($($(this).attr("data-id-element")).val(""),$(this).unbind("keyup.clearId"))}),$(this).trigger("railsAutocomplete.select");return!1}})}})}(jQuery)

data/lib/generators/templates/autocomplete-rails-uncompressed.js

@@ -11,7 +11,7 @@
 * be updated with the element id whenever you find a matching value
 *
 *   Example:
-*       <input type="text" data-autocomplete="/url/to/autocomplete" id_element="#id_field">
+*       <input type="text" data-autocomplete="/url/to/autocomplete" data-id-element="#id_field">
 */
 
 $(document).ready(function(){
@@ -85,8 +85,8 @@ $(document).ready(function(){
             this.value = terms.join( e.delimiter );
           } else {
             this.value = terms.join("");
-            if ($(this).attr('id_element')) {
-              $($(this).attr('id_element')).val(ui.item.id);
+            if ($(this).attr('data-id-element')) {
+              $($(this).attr('data-id-element')).val(ui.item.id);
             }
             if ($(this).attr('data-update-elements')) {
               var data = $(this).data(ui.item.id.toString());
@@ -99,7 +99,7 @@ $(document).ready(function(){
           var remember_string = this.value;
           $(this).bind('keyup.clearId', function(){
             if($(this).val().trim() != remember_string.trim()){
-              $($(this).attr('id_element')).val("");
+              $($(this).attr('data-id-element')).val("");
               $(this).unbind('keyup.clearId');
             }
           });

data/lib/generators/templates/autocomplete-rails.js

@@ -11,6 +11,6 @@
 * be updated with the element id whenever you find a matching value
 *
 *   Example:
-*       <input type="text" data-autocomplete="/url/to/autocomplete" id_element="#id_field">
+*       <input type="text" data-autocomplete="/url/to/autocomplete" data-id-element="#id_field">
 */
-$(document).ready(function(){$("input[data-autocomplete]").railsAutocomplete()}),function(a){var b=null;a.fn.railsAutocomplete=function(){return this.live("focus",function(){this.railsAutoCompleter||(this.railsAutoCompleter=new a.railsAutocomplete(this))})},a.railsAutocomplete=function(a){_e=a,this.init(_e)},a.railsAutocomplete.fn=a.railsAutocomplete.prototype={railsAutocomplete:"0.0.1"},a.railsAutocomplete.fn.extend=a.railsAutocomplete.extend=a.extend,a.railsAutocomplete.fn.extend({init:function(a){function c(a){return b(a).pop().replace(/^\s+/,"")}function b(b){return b.split(a.delimiter)}a.delimiter=$(a).attr("data-delimiter")||null,$(a).autocomplete({source:function(b,d){$.getJSON($(a).attr("data-autocomplete"),{term:c(b.term)},function(){$(arguments[0]).each(function(b,c){var d={};d[c.id]=c,$(a).data(d)}),d.apply(null,arguments)})},search:function(){var a=c(this.value);if(a.length<2)return!1},focus:function(){return!1},select:function(c,d){var f=b(this.value);f.pop(),f.push(d.item.value);if(a.delimiter!=null)f.push(""),this.value=f.join(a.delimiter);else{this.value=f.join(""),$(this).attr("id_element")&&$($(this).attr("id_element")).val(d.item.id);if($(this).attr("data-update-elements")){var g=$(this).data(d.item.id.toString()),h=$.parseJSON($(this).attr("data-update-elements"));for(var i in h)$(h[i]).val(g[i])}}var j=this.value;$(this).bind("keyup.clearId",function(){$(this).val().trim()!=j.trim()&&($($(this).attr("id_element")).val(""),$(this).unbind("keyup.clearId"))}),$(this).trigger("railsAutocomplete.select");return!1}})}})}(jQuery)
+$(document).ready(function(){$("input[data-autocomplete]").railsAutocomplete()}),function(a){var b=null;a.fn.railsAutocomplete=function(){return this.live("focus",function(){this.railsAutoCompleter||(this.railsAutoCompleter=new a.railsAutocomplete(this))})},a.railsAutocomplete=function(a){_e=a,this.init(_e)},a.railsAutocomplete.fn=a.railsAutocomplete.prototype={railsAutocomplete:"0.0.1"},a.railsAutocomplete.fn.extend=a.railsAutocomplete.extend=a.extend,a.railsAutocomplete.fn.extend({init:function(a){function c(a){return b(a).pop().replace(/^\s+/,"")}function b(b){return b.split(a.delimiter)}a.delimiter=$(a).attr("data-delimiter")||null,$(a).autocomplete({source:function(b,d){$.getJSON($(a).attr("data-autocomplete"),{term:c(b.term)},function(){$(arguments[0]).each(function(b,c){var d={};d[c.id]=c,$(a).data(d)}),d.apply(null,arguments)})},search:function(){var a=c(this.value);if(a.length<2)return!1},focus:function(){return!1},select:function(c,d){var f=b(this.value);f.pop(),f.push(d.item.value);if(a.delimiter!=null)f.push(""),this.value=f.join(a.delimiter);else{this.value=f.join(""),$(this).attr("data-id-element")&&$($(this).attr("data-id-element")).val(d.item.id);if($(this).attr("data-update-elements")){var g=$(this).data(d.item.id.toString()),h=$.parseJSON($(this).attr("data-update-elements"));for(var i in h)$(h[i]).val(g[i])}}var j=this.value;$(this).bind("keyup.clearId",function(){$(this).val().trim()!=j.trim()&&($($(this).attr("data-id-element")).val(""),$(this).unbind("keyup.clearId"))}),$(this).trigger("railsAutocomplete.select");return!1}})}})}(jQuery)

data/lib/rails3-jquery-autocomplete.rb

@@ -1,17 +1,18 @@
-require 'yajl/json_gem'
 require 'rails3-jquery-autocomplete/form_helper'
-require 'rails3-jquery-autocomplete/helpers'
 require 'rails3-jquery-autocomplete/autocomplete'
-require 'rails3-jquery-autocomplete/formtastic_plugin'
+
+module Rails3JQueryAutocomplete
+  autoload :Orm              , 'rails3-jquery-autocomplete/orm'
+  autoload :FormtasticPlugin , 'rails3-jquery-autocomplete/formtastic_plugin'
+end
 
 class ActionController::Base
-  extend Rails3JQueryAutocomplete::ClassMethods
-  include Rails3JQueryAutocomplete::Helpers
+  include Rails3JQueryAutocomplete::Autocomplete
 end
 
 #
 # Load the formtastic plugin if using Formtastic
-#
+# TODO: Better way to load plugins
 begin
   require 'formtastic'
   class Formtastic::SemanticFormBuilder < ActionView::Helpers::FormBuilder

data/lib/rails3-jquery-autocomplete/autocomplete.rb

@@ -1,50 +1,96 @@
-require "yajl"
-
 module Rails3JQueryAutocomplete
+  module Autocomplete
+    def self.included(target)
+      target.extend Rails3JQueryAutocomplete::Autocomplete::ClassMethods
+
+      if defined?(Mongoid::Document)
+        target.send :include, Rails3JQueryAutocomplete::Orm::Mongoid
+      elsif defined?(MongoMapper::Document)
+        target.send :include, Rails3JQueryAutocomplete::Orm::MongoMapper
+      else
+        target.send :include, Rails3JQueryAutocomplete::Orm::ActiveRecord
+      end
+    end
+
+    #
+    # Usage:
+    #
+    # class ProductsController < Admin::BaseController
+    #   autocomplete :brand, :name
+    # end
+    #
+    # This will magically generate an action autocomplete_brand_name, so,
+    # don't forget to add it on your routes file
+    #
+    #   resources :products do
+    #      get :autocomplete_brand_name, :on => :collection
+    #   end
+    #
+    # Now, on your view, all you have to do is have a text field like:
+    #
+    #   f.text_field :brand_name, :autocomplete => autocomplete_brand_name_products_path
+    #
+    #
+    # Yajl is used by default to encode results, if you want to use a different encoder
+    # you can specify your custom encoder via block
+    #
+    # class ProductsController < Admin::BaseController
+    #   autocomplete :brand, :name do |items|
+    #     CustomJSONEncoder.encode(items)
+    #   end
+    # end
+    #
+    module ClassMethods
+      def autocomplete(object, method, options = {})
+        define_method("autocomplete_#{object}_#{method}") do
+
+          method = options[:column_name] if options.has_key?(:column_name)
+
+          term = params[:term]
+
+          if term && !term.blank?
+            #allow specifying fully qualified class name for model object
+            class_name = options[:class_name] || object
+            items = get_autocomplete_items(:model => get_object(class_name), \
+              :options => options, :term => term, :method => method)
+          else
+            items = {}
+          end
 
-  # Inspired on DHH's autocomplete plugin
-  #
-  # Usage:
-  #
-  # class ProductsController < Admin::BaseController
-  #   autocomplete :brand, :name
-  # end
-  #
-  # This will magically generate an action autocomplete_brand_name, so,
-  # don't forget to add it on your routes file
-  #
-  #   resources :products do
-  #      get :autocomplete_brand_name, :on => :collection
-  #   end
-  #
-  # Now, on your view, all you have to do is have a text field like:
-  #
-  #   f.text_field :brand_name, :autocomplete => autocomplete_brand_name_products_path
-  #
-  #
-  module ClassMethods
-    def autocomplete(object, method, options = {})
-
-      define_method("autocomplete_#{object}_#{method}") do
-
-
-        method = options[:column_name] if options.has_key?(:column_name)
-
-        term = params[:term]
-
-        if term && !term.empty?
-          #allow specifying fully qualified class name for model object
-          class_name = options[:class_name] || object
-          items = get_autocomplete_items(:model => get_object(class_name), \
-            :options => options, :term => term, :method => method)
-        else
-          items = {}
+          render :json => json_for_autocomplete(items, options[:display_value] ||= method, options[:extra_data])
         end
+      end
+    end
+
+    # Returns a limit that will be used on the query
+    def get_autocomplete_limit(options)
+      options[:limit] ||= 10
+    end
 
-        render :json => Yajl::Encoder.encode(json_for_autocomplete(items, options[:display_value] ||= method, options[:extra_data]))
+    # Returns parameter model_sym as a constant
+    #
+    #   get_object(:actor)
+    #   # returns a Actor constant supposing it is already defined
+    #
+    def get_object(model_sym)
+      object = model_sym.to_s.camelize.constantize
+    end
+
+    #
+    # Returns a hash with three keys actually used by the Autocomplete jQuery-ui
+    # Can be overriden to show whatever you like
+    # Hash also includes a key/value pair for each method in extra_data
+    #
+    def json_for_autocomplete(items, method, extra_data=[])
+      items.collect do |item|
+        hash = {"id" => item.id.to_s, "label" => item.send(method), "value" => item.send(method)}
+        extra_data.each do |datum|
+          hash[datum] = item.send(datum)
+        end if extra_data
+        # TODO: Come back to remove this if clause when test suite is better
+        hash
       end
     end
   end
-
 end
 

data/lib/rails3-jquery-autocomplete/orm.rb

@@ -0,0 +1,8 @@
+module Rails3JQueryAutocomplete
+  module Orm
+    autoload :ActiveRecord , 'rails3-jquery-autocomplete/orm/active_record'
+		autoload :Mongoid      , 'rails3-jquery-autocomplete/orm/mongoid'
+		autoload :MongoMapper  , 'rails3-jquery-autocomplete/orm/mongo_mapper'
+  end
+end
+

data/lib/rails3-jquery-autocomplete/orm/active_record.rb

@@ -0,0 +1,47 @@
+module Rails3JQueryAutocomplete
+  module Orm
+    module ActiveRecord
+      def get_autocomplete_order(method, options, model=nil)
+        order = options[:order]
+
+        table_prefix = model ? "#{model.table_name}." : ""
+        order || "#{table_prefix}#{method} ASC"
+      end
+
+      def get_autocomplete_items(parameters)
+        model   = parameters[:model]
+        term    = parameters[:term]
+        method  = parameters[:method]
+        options = parameters[:options]
+        scopes  = Array(options[:scopes])
+        limit   = get_autocomplete_limit(options)
+        order   = get_autocomplete_order(method, options, model)
+
+
+        items = model.scoped
+
+        scopes.each { |scope| items = items.send(scope) } unless scopes.empty?
+
+        items = items.select(get_autocomplete_select_clause(model, method, options)) unless options[:full_model]
+        items = items.where(get_autocomplete_where_clause(model, term, method, options)).
+            limit(limit).order(order)
+      end
+
+      def get_autocomplete_select_clause(model, method, options)
+        table_name = model.table_name
+        (["#{table_name}.#{model.primary_key}", "#{table_name}.#{method}"] + (options[:extra_data].blank? ? [] : options[:extra_data]))
+      end
+
+      def get_autocomplete_where_clause(model, term, method, options)
+        table_name = model.table_name
+        is_full_search = options[:full]
+        like_clause = (postgres? ? 'ILIKE' : 'LIKE')
+        ["LOWER(#{table_name}.#{method}) #{like_clause} ?", "#{(is_full_search ? '%' : '')}#{term.downcase}%"]
+      end
+
+      def postgres?
+        defined?(PGConn)
+      end
+    end
+  end
+end

data/lib/rails3-jquery-autocomplete/orm/mongo_mapper.rb

@@ -0,0 +1,30 @@
+module Rails3JQueryAutocomplete
+	module Orm
+		module MongoMapper
+			def get_autocomplete_order(method, options, model=nil)
+        order = options[:order]
+        if order
+          order.split(',').collect do |fields|
+            sfields = fields.split
+            [sfields[0].downcase.to_sym, sfields[1].downcase.to_sym]
+          end
+        else
+          [[method.to_sym, :asc]]
+        end
+			end
+
+			def get_autocomplete_items(parameters)
+        model          = parameters[:model]
+        method         = parameters[:method]
+        options        = parameters[:options]
+        is_full_search = options[:full]
+        term           = parameters[:term]
+        limit          = get_autocomplete_limit(options)
+        order          = get_autocomplete_order(method, options)
+
+        search = (is_full_search ? '.*' : '^') + term + '.*'
+				items  = model.where(method.to_sym => /#{search}/i).limit(limit).sort(order)
+			end
+		end	
+	end
+end