auto_complete 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c07000c74780498b78972c3f1079bb09c62d5a1
+  data.tar.gz: 4f957c335e169222ed8d1a9494215884382ddd15
+SHA512:
+  metadata.gz: 2dbd5465d5ce60dcd7b190e6a4f76fe3610864db3b7308252c91f2203ece61fbdf5abd2749aaf20ce3f742fb9118ce66551c59a392b05da2d1ec173a6d045261
+  data.tar.gz: a8a2904e5709daa65f17341084b7722a3849c1d1491387e1862b0f55cb00be87f7259b7896b9b0acce9e2ebb1cb10238fccdd9c8b0b74c25ce19fd8711df12b6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in auto_complete.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2007 David Heinemeier Hansson (original code)
+Copyright (c) 2013 Marc-Andre Lafortune (gem)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# AutoComplete
+
+Gem port of the legacy auto_complete plugin for Rails 3+
+
+## Example
+
+Add this line to your application's Gemfile: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 more examples, see script.aculo.us:
+* http://script.aculo.us/demos/ajax/autocompleter
+* http://script.aculo.us/demos/ajax/autocompleter_customized
+
+Copyright (c) 2007 David Heinemeier Hansson, released under the MIT license
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end

data/app/helpers/auto_complete_macros_helper.rb

@@ -0,0 +1,145 @@
+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>: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]
+
+    { :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) : entry[field]) }
+    content_tag("ul", safe_join(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 = {})
+    (completion_options[:skip_style] ? "".html_safe : auto_complete_stylesheet) +
+    text_field(object, method, tag_options) +
+    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
+  STYLE = <<-EOT.html_safe.freeze
+        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
+
+  def auto_complete_stylesheet
+    content_tag('style', STYLE, :type => Mime::CSS)
+  end
+
+end

data/auto_complete.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_complete/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auto_complete"
+  spec.version       = AutoComplete::VERSION
+  spec.authors       = ["David Heinemeier Hansson, Marc-André Lafortune"]
+  spec.email         = ["github@marc-andre.ca"]
+  spec.description   = %q{Gem for the legacy auto_complete plugin}
+  spec.summary       = %q{Gem for the legacy auto_complete plugin}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/auto_complete.rb

@@ -0,0 +1,13 @@
+require "auto_complete/version"
+require "auto_complete/class_methods"
+
+module AutoComplete
+  class Engine < Rails::Engine
+    # Thanks to http://robots.thoughtbot.com/post/159805560/tips-for-writing-your-own-rails-engine for:
+    config.to_prepare do
+      ActionView::Helpers.send :include, AutoCompleteMacrosHelper
+    end
+  end
+end
+
+ActionController::Base.send :include, AutoComplete

data/lib/auto_complete/class_methods.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
+        table = object.to_s.camelize.constantize.table_name
+
+        find_options = {
+          :conditions => [ "LOWER(#{table}.#{method}) LIKE (?)", '%' + params[object][method].downcase + '%' ],
+          :order => "#{table}.#{method} ASC",
+          :limit => 10 }.merge!(options)
+
+        @items = object.to_s.camelize.constantize.find(:all, find_options)
+
+        render :inline => "<%= auto_complete_result @items, '#{method}' %>"
+      end
+    end
+  end
+
+end

data/lib/auto_complete/version.rb

@@ -0,0 +1,3 @@
+module AutoComplete
+  VERSION = "0.0.1"
+end

data/test/auto_complete_test.rb

@@ -0,0 +1,55 @@
+require './test/test_helper'
+
+class AutoCompleteTest < ActionView::TestCase
+  def assert_dom_equal(expected, actual)
+    super
+    assert_equal true, actual.html_safe?
+  end
+
+  def url_for(opt)
+    "http://www.example.com/#{opt[:action]}"
+  end
+
+  def test_auto_complete_field
+    #stub!(:url_for).and_return("/path")
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" });
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {tokens:','})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" }, :tokens => ',');
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {tokens:[',']})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" }, :tokens => [',']);
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {minChars:3})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" }, :min_chars => 3);
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {onHide:function(element, update){alert('me');}})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" }, :on_hide => "function(element, update){alert('me');}");
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {frequency:2})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" }, :frequency => 2);
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {afterUpdateElement:function(element,value){alert('You have chosen: '+value)}})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" },
+        :after_update_element => "function(element,value){alert('You have chosen: '+value)}");
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {paramName:'huidriwusch'})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" }, :param_name => 'huidriwusch');
+    assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nvar some_input_auto_completer = new Ajax.Autocompleter('some_input', 'some_input_auto_complete', 'http://www.example.com/autocomplete', {method:'get'})\n//]]>\n</script>),
+      auto_complete_field("some_input", :url => { :action => "autocomplete" }, :method => :get);
+  end
+
+  def test_auto_complete_result
+    result = [ { :title => 'test1'  }, { :title => 'test2'  } ]
+    assert_dom_equal %(<ul><li>test1</li><li>test2</li></ul>),
+      auto_complete_result(result, :title)
+    assert_dom_equal %(<ul><li>t<strong class=\"highlight\">est</strong>1</li><li>t<strong class=\"highlight\">est</strong>2</li></ul>),
+      auto_complete_result(result, :title, "est")
+
+    resultuniq = [ { :title => 'test1'  }, { :title => 'test1'  } ]
+    assert_dom_equal %(<ul><li>t<strong class=\"highlight\">est</strong>1</li></ul>),
+      auto_complete_result(resultuniq, :title, "est")
+  end
+
+  def test_text_field_with_auto_complete
+    assert_match %(<style type="text/css">),
+      text_field_with_auto_complete(:message, :recipient)
+
+    assert_dom_equal %(<input id=\"message_recipient\" name=\"message[recipient]\" size=\"30\" type=\"text\" /><div class=\"auto_complete\" id=\"message_recipient_auto_complete\"></div><script type=\"text/javascript\">\n//<![CDATA[\nvar message_recipient_auto_completer = new Ajax.Autocompleter('message_recipient', 'message_recipient_auto_complete', 'http://www.example.com/auto_complete_for_message_recipient', {})\n//]]>\n</script>),
+      text_field_with_auto_complete(:message, :recipient, {}, :skip_style => true)
+  end
+end

data/test/dummy/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/test/dummy/Gemfile

@@ -0,0 +1,38 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.6'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+# gem 'sqlite3'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platforms => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+gem 'auto_complete', :path => "../.."
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'