maiha-sexy_auto_complete 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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

@@ -0,0 +1,83 @@
+AutoComplete
+============
+
+Rails plugin for better auto_complete, especially it gets along with ActiveScaffold nested forms
+
+Methods
+=======
+
+[helper]
+* auto_complete_for(record_name, column_name, field_name, target_options = {}, suggest_options = {}, trigger_options = {})
+    create text_field and candidate_area and callback elements like text_field_with_auto_complete
+
+* auto_complete_javascript
+    return javascript string tag for this plugin
+
+* auto_complete_stylesheet
+    return stylesheet string for this plugin
+
+* auto_complete_includes
+    return javscript and styleshet string for this plugin
+
+[controller]
+* auto_complete(records, options = {}, &block)
+    create ul and li elements for the AJAX autocomplete requests
+    records : candidate objects
+    options :
+      - :blank : a message string when there are no candidates
+                 (set false if you don't want the message)
+    block   : a block to create candidate message from a record.
+              :to_label, :name, :id methods are used in order for default
+
+Example
+=======
+
+[view]
+<%- @user = User.new ->
+<%= auto_complete_includes %>
+<%= auto_complete_for :user, :pref_id  %>
+
+[controller]
+class UserController < ApplicationController
+  include AutoComplete
+
+  def auto_complete_pref_id
+    # form value is set to @input automatically
+    records = Pref.find(:all, :conditions=>["name LIKE ?", "%#{@input}%"], :limit=>10)
+    auto_complete(records, &:name)
+  end
+end
+
+With ActiveScaffold
+===================
+[helper]
+  def pref_id_form_column(record, field_name)
+    opts = {:controller=>:auto_complete, :action=>:pref_id, :name=>field_name}
+    auto_complete_for :record, :pref_id, opts, {:style=>"width:600px;"}
+  end
+
+[controller]
+class AutoCompleteController < ApplicationController
+  include AutoComplete
+
+  def pref_id
+    conds   = ["id::varchar ~* ?", Regexp.escape(@input)]
+    records = Pref.find(:all, :conditions=>conds, :order=>:id, :limit=>10)
+    auto_complete(records) do |pref|
+      value = auto_complete_connect(params[:id], pref.id)
+      label = pref.name
+      "%s %s" % [value, label]
+    end
+  end
+
+
+Advanced Settings
+=================
+
+[controller]
+* auto_complete_response_not_implemented
+    This string returns via Ajax autocompletion request when ActionController::UnknownAction is raised.
+    If you want normal exception, override this method to return nil.
+
+
+Copyright (c) 2008 maiha@wota.jp, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the auto_complete plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the auto_complete plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AutoComplete'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/files/multicontrols.js

@@ -0,0 +1,37 @@
+function getElementsByAttributeName(node, attrname)
+{
+  var a = [];
+  var re = new RegExp('\\b' + attrname + '\\b');
+  var els = node.getElementsByTagName("*");
+  for(var i=0,j=els.length; i<j; i++)
+    if(els[i].getAttribute(attrname)) a.push(els[i]);
+  return a;
+}
+
+Object.extend(Ajax.Autocompleter.prototype,{
+  selectEntry: function() {
+    this.active = false;
+    var defs = getElementsByAttributeName(this.getCurrentEntry(), 'connect');
+
+    if (defs.length == 0) {
+      this.updateElement(this.getCurrentEntry());
+    } else {
+      for (var i = 0; i < defs.length; i++) {
+        var connectid = defs[i].getAttribute("connect");
+        if ($(connectid)) {
+          if ($(connectid).tagName == "INPUT"){
+            $(connectid).value = defs[i].childNodes[0].nodeValue;
+          } else {
+            $(connectid).innerHTML = defs[i].childNodes[0].nodeValue;
+          }
+        }
+      }
+    }
+
+    if (this.options.afterUpdateElement)
+      this.options.afterUpdateElement(this.element, this.getCurrentEntry());
+
+    this.element.focus();
+  }
+});
+

data/init.rb

@@ -0,0 +1,16 @@
+# install javascripts
+
+src = File.dirname(__FILE__) + "/files/multicontrols.js"
+dst = RAILS_ROOT + "/public/javascripts/multicontrols.js"
+if !File.exist?(dst) or File.mtime(dst) < File.mtime(src)
+  if (logger = ActionController::Base.logger)
+    logger.debug "[AutoComplete plugin] install multicontrols.js to #{dst}"
+  end
+  FileUtils.cp(src, dst)
+end
+
+# apply new methods to ApplicationHelper
+
+ApplicationHelper.module_eval do
+  include AutoComplete::Helper
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/auto_complete/controller.rb

@@ -0,0 +1,76 @@
+module AutoComplete
+  module Controller
+  private
+    def auto_complete_read_input
+      # [params]
+      # "record" => {"item_locations"=>{"1229373405139"=>{"position"=>"ITN"}}},
+      # "path"   => "record[item_locations][1229373405139][position]",
+      @input = params[:path].to_s.split(%r{[\[|\]/]+}).inject(params){|hash, key| hash[key]}.to_s.strip
+      if @input.blank?
+        render :nothing=>true
+        return false
+      end
+      return true
+    end
+
+    def auto_complete(records, options = {}, &block)
+      block ||= proc{|r| r.respond_to?(:to_label) ? r.to_label : (r.respond_to?(:name) ? r.name : r.id)}
+      if records.blank? and !(options[:blank] == false)
+        suggest = options[:blank]
+        suggest = auto_complete_response_not_found unless suggest.is_a?(String)
+      else
+        suggest = records.map{|r| block.call(r)}
+      end
+      auto_complete_render(suggest)
+    end
+
+    def auto_complete_wrap(response)
+      case response
+      when Array
+        "<ul>%s</ul>" % response.map{|i| "<li>#{i}</li>"}.join
+      when /^<ul.*?>/
+        response
+      when /^<li.*?>/
+        "<ul>#{response}</ul>"
+      else
+        "<ul><li>#{response}#{auto_complete_nop}</li></ul>"
+      end
+    end
+
+    def auto_complete_response_not_found
+      "No Match"
+    end
+
+    def auto_complete_response_not_implemented
+      "Cannot complete : Please define [#{controller_name.to_s.classify}##{action_name}] action"
+    end
+
+    def auto_complete_connect(to, data = nil)
+      "<span connect='#{to}'>#{data}</span>"
+    end
+
+    def auto_complete_nop
+      "<span connect='__no_such_element__' style='display:none;'></span>"
+    end
+
+    def auto_complete_render(value)
+      value = auto_complete_wrap(value)
+      # logger.debug "[AUTO COMPLETE] (%s) -> %s" % [@input, value]
+      render :text=>value
+    end
+
+    def rescue_action(error)
+      # I don't know why it fails to accessing to ActionController::UnknownAction directly
+      # => uninitialized constant ActionWebService::Dispatcher::ActionController::UnknownAction
+      case error.class.name
+      when "ActionController::UnknownAction"
+        if auto_complete_response_not_implemented
+          auto_complete_render auto_complete_response_not_implemented
+          return
+        end
+      end
+
+      super
+    end
+  end
+end

data/lib/auto_complete/helper.rb

@@ -0,0 +1,48 @@
+module AutoComplete
+  module Helper
+    def auto_complete_for(record_name, column_name, target_options = {}, suggest_options = {}, trigger_options = {})
+      record     = instance_variable_get("@#{record_name}")
+      model_name = record.class.name.demodulize.underscore
+      controller = target_options.delete(:controller) || model_name
+      action     = target_options.delete(:action) || "auto_complete_#{column_name}"
+      field_name = target_options.delete(:name) || column_name
+
+      # target
+      target_id = field_name.gsub(/\[|\]/, '_')
+      options   = {:name=>field_name, :id=>target_id, :class=>"#{column_name}-input", :size=>20}.merge(trigger_options)
+      target    = input(record_name, column_name, options)
+
+      # suggest
+      options     = {:id=>"#{target_id}_auto_complete", :class=>"auto_complete", :style=>"width:400px;"}.merge(suggest_options)
+      suggest     = content_tag('div', '', options)
+
+      # trigger
+      url = {:controller=>controller, :action=>action, :id=>target_id, :path=>field_name}
+      options = {:url=>url, :min_chars=>3}.update(trigger_options)
+      trigger = auto_complete_field target_id, options
+
+      target + suggest + trigger
+    end
+
+    private
+      def auto_complete_includes
+        auto_complete_javascript + auto_complete_stylesheet
+      end
+
+      def auto_complete_javascript
+        javascript_include_tag "multicontrols"
+      end
+
+      def auto_complete_stylesheet
+        super +
+          content_tag('style', <<-EOT, :type => 'text/css')
+            div.auto_complete {
+              color: black;
+            }
+            div.auto_complete ul li {
+              background-color: #fff;
+            }
+          EOT
+      end
+  end
+end

data/lib/auto_complete.rb

@@ -0,0 +1,8 @@
+module AutoComplete
+  def self.included(base)
+    base.class_eval do
+      include AutoComplete::Controller
+      before_filter :auto_complete_read_input
+    end
+  end
+end

data/tasks/auto_complete_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :auto_complete do
+#   # Task goes here
+# end

data/test/auto_complete_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class AutoCompleteTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: maiha-sexy_auto_complete
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- maiha
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-16 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: maiha@wota.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- files/multicontrols.js
+- init.rb
+- install.rb
+- lib/auto_complete.rb
+- lib/auto_complete/controller.rb
+- lib/auto_complete/helper.rb
+- tasks/auto_complete_tasks.rake
+- test/auto_complete_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/maiha/sexy_auto_complete
+post_install_message: 
+rdoc_options: []
+
+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: ""
+test_files: []
+