jrails_auto_complete 0.2.0

data/CHANGELOG

@@ -0,0 +1,26 @@
+ HEAD [2010-05-08]
+====================
+
+    Features
+
+    Enhancements
+
+    Changes
+
+    Bugfixes
+
+ 0.2.0 [2010-05-08]
+====================
+
+    Features
+        * named scope items filtering
+    Enhancements
+        * gem available
+        * documentation with yard
+    Bugfixes
+        * fix gem initialization in rails
+
+ 0.1.0 [2010-02-03]
+====================
+
+    First release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michele Franzin
+
+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.textile

@@ -0,0 +1,81 @@
+h1. jRails autocomplete
+
+Auto Completion plugin using jRails[1] and jQuery-UI[2]; it works similarly to the original rails auto complete, but generating unobtrusive javascript. Additional features:
+
+* named scope items filtering, based on a customized list of autocomplete options.
+
+*WARNING NOTE*: This is an active work in progress - currently only used on few live projects right now. Use at your own discretion.
+
+h2. Usage example
+
+In the controller you can use the macro function as such
+
+<pre><code>class ExampleController < ApplicationController
+    auto_complete_for :fruit, :name
+    ...
+end
+</code></pre>
+
+In your views:
+
+<pre><code><%= text_field_with_auto_complete :fruit, :name %>
+</code></pre>
+
+be shure to include the jquery/jquery-ui javascript in your layout:
+
+<pre><code><%= javascript_include_tag 'jquery, 'jquery-ui.min', 'jquery-ui-i18n.min' %>
+</code></pre>
+
+h2. 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.
+
+h3. Example using anonymous scope:
+
+<pre><code>auto_complete_for :fruit, :shape do |items, params|
+  items.scoped( { :conditions => [ "colour = ?", params['fruit']['color'] ] })
+end
+</code></pre>
+
+h3. Example using named scope:
+
+Having the model:
+
+<pre><code>class Fruit < ActiveRecord::Base
+  belongs_to :owner
+  named_scope :by_owner,
+    lambda { |owner_name| {
+      :include => :owner,
+      :conditions => [ "owner.name = ?", owner_name ]
+    } }
+end
+</code></pre>
+
+In the controller you can use the macro function as such
+
+<pre><code>auto_complete_for :fruit, :name do | items, params |
+  items.by_owner(params['owner'])
+end
+</code></pre>
+
+h2. Todo
+
+* test, test... test!
+
+h2. Found a Bug?
+
+Please direct all queries to the issue tracker: "http://github.com/michelefranzin/jrails_auto_complete/issues":http://github.com/michelefranzin/jrails_auto_complete/issues
+
+h2. Credits
+
+Thanks to Paul Smith for the "original idea":http://github.com/elandesign/formtastic_autocomplete.git and Pat Shaughnessy for "inspirating":http://patshaughnessy.net/repeated_auto_complete me the named scope part.
+
+h2. References
+
+fn1. "JRails @ GitHub":http://github.com/aaronchi/jrails
+
+fn2. "jQuery-UI":http://jqueryui.com/
+
+h2. Copyright
+
+Copyright (c) 2010 Michele Franzin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jrails_auto_complete"
+    gem.summary = "jRails autocomplete using jQuery-UI"
+    gem.description = "Adds autocomplete support to jRails, using jQuery-UI; it " +
+                      "works similarly to the original rails autocomplete plugin, but " +
+                      "generating unobtrusive javascript."
+    gem.email = "michele.franzin@gmail.com"
+    #gem.homepage = "http://github.com/michelefranzin/jrails_auto_complete"
+    gem.authors = ["Michele Franzin"]
+
+    gem.add_development_dependency "yard", ">= 0.5.4"
+    gem.add_dependency('rails', '>= 2.1')
+    gem.add_dependency('jrails', '>= 0.6')
+    gem.files.exclude '*install.rb'
+    gem.files.exclude '.gitignore'
+    gem.files.exclude 'javascripts/*'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/init.rb

@@ -0,0 +1 @@
+include 'rails/init'

data/lib/jrails_auto_complete.rb

@@ -0,0 +1,44 @@
+module JrailsAutoComplete
+  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'
+  #    def auto_complete_for(object_name, method_name, options = {})
+  #
+  module ClassMethods
+    def auto_complete_for(object_name, method_name, options = {})
+      self.send(:define_method, "auto_complete_for_#{object_name}_#{method_name}") do
+        model = object_name.to_s.camelize.constantize
+        full_method_name = "#{model.quoted_table_name}.#{method_name}"
+        find_options= {
+          :conditions => ["LOWER(#{full_method_name}) LIKE ?", '%' + params['term'].downcase + '%'],
+          :order => "#{full_method_name} ASC",
+          :limit => 10
+        }.merge!(options)
+
+        @items = model.scoped(find_options)
+        @items = yield(@items, params) if block_given?
+        
+        render :inline => "<%= auto_complete_result @items, '#{method_name}', '#{params['term']}' %>"
+      end
+    end
+  end
+end

data/lib/jrails_auto_complete_form_builder_helper.rb

@@ -0,0 +1,11 @@
+module JrailsAutoCompleteFormBuilderHelper
+
+  def text_field_with_auto_complete(method, options = {}, auto_complete_options = {})
+    text_field(method, options) + auto_complete_for(method, auto_complete_options)
+  end
+
+  def auto_complete_for(method, options = {})
+    @template.auto_complete_for(@object_name, method, options)
+  end
+
+end

data/lib/jrails_auto_complete_macros_helper.rb

@@ -0,0 +1,83 @@
+module JrailsAutoCompleteMacrosHelper
+  # Adds JQuery autocomplete functionality to the text input field with the
+  # DOM ID specified by +field_id+.
+  #
+  # 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.
+  #
+  # Required +options+ are:
+  # <tt>:source</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 request.
+  #                                  Defaults to <tt>field_id</tt> + '_auto_complete'
+  # <tt>:delay</tt>::                The delay in milliseconds the Autocomplete waits after
+  #                                  a keystroke to activate itself. A zero-delay makes sense
+  #                                  for local data (more responsive), but can produce a lot
+  #                                  of load for remote data, while being less responsive.
+  # <tt>:min_length</tt>::           The minimum number of characters a user has to type
+  #                                  before the Autocomplete activates. Zero is useful for
+  #                                  local data with just a few items. Should be increased
+  #                                  when there are a lot of items, where a single character
+  #                                  would match a few thousand items.
+  # <tt>:open</tt>::                 Before a request (source-option) is started, after
+  #                                  minLength and delay are met. Can be canceled (return false),
+  #                                  then no request will be started and no items suggested.
+  # <tt>:focus</tt>::                Before focus is moved to an item (not selecting), ui.item
+  #                                  refers to the focused item. The default action of focus is
+  #                                  to replace the text field's value with the value of the focused
+  #                                  item. Canceling this event prevents the value from being updated,
+  #                                  but does not prevent the menu item from being focused.
+  # <tt>:select</tt>::               Triggered when an item is selected from the menu; ui.item
+  #                                  refers to the selected item. The default action of select is
+  #                                  to replace the text field's value with the value of the
+  #                                  selected item. Canceling this event prevents the value from
+  #                                  being updated, but does not prevent the menu from closing.
+  # <tt>:close</tt>::                When the list is hidden - doesn't have to occur together
+  #                                  with a change.
+  # <tt>:change</tt>::               After an item was selected; ui.item refers to the selected
+  #                                  item. Always triggered after the close event.
+  def auto_complete_field(field_id, options = {})
+    js_options = {}
+    js_options[:source]        = "'#{url_for(options[:source])}'"
+    js_options[:update]        = "'" + (options[:update] || "#{field_id}_auto_complete") + "'"
+
+    {:min_length => :minLength, :delay => :delay}.each do |k, v|
+      js_options[v] = options[k] if options[k]
+    end
+
+    [:search, :open, :focus, :select, :close, :change].each do |k|
+      js_options[k] = "function(event,ui){#{options[k]}}" if options[k]
+    end
+
+    function = "#{ActionView::Helpers::PrototypeHelper::JQUERY_VAR}('##{field_id}').autocomplete("
+    function << options_for_javascript(js_options) + ')'
+
+    javascript_tag(function)
+  end
+
+  def auto_complete_result(entries, field, phrase = nil)
+    return unless entries
+    unique_entries= entries.uniq.map do |entry|
+      {'id' => entry[:id],
+        'value' => h(entry[field]),
+        'label' => phrase ? highlight(entry.send(field), phrase) : h(entry[field])}
+    end
+    unique_entries.to_json
+  end
+
+  def auto_complete_for(object, method, options = {})
+    content_tag('div', '', :id => "#{object}_#{method}_auto_complete") +
+      auto_complete_field("#{object}_#{method}", { :source => { :action => "auto_complete_for_#{object}_#{method}" } }.update(options))
+  end
+
+  def text_field_with_auto_complete(object, method, tag_options = {}, completion_options = {})
+    text_field(object, method, tag_options) +
+      auto_complete_for(object, method, completion_options)
+  end
+
+end

data/lib/jrails_auto_complete_tag_helper.rb

@@ -0,0 +1,12 @@
+module JrailsAutoCompleteTagHelper
+
+  def to_auto_complete(options = {})
+    send(:add_default_name_and_id, options)
+    @template_object.auto_complete_field(options['id'], options)
+  end
+
+  def to_text_field_with_auto_complete(options = {}, text_field_options = {})
+    to_input_field_tag('text', text_field_options) + to_auto_complete(options)
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib jrails_auto_complete])
+require File.join(File.dirname(__FILE__), *%w[.. lib jrails_auto_complete_macros_helper])
+require File.join(File.dirname(__FILE__), *%w[.. lib jrails_auto_complete_form_builder_helper])
+require File.join(File.dirname(__FILE__), *%w[.. lib jrails_auto_complete_tag_helper])
+
+ActionController::Base.send :include, JrailsAutoComplete
+ActionController::Base.helper JrailsAutoCompleteMacrosHelper
+ActionView::Helpers::FormBuilder.send :include, JrailsAutoCompleteFormBuilderHelper
+ActionView::Helpers::TagHelper.send :include, JrailsAutoCompleteTagHelper

data/tasks/jrails_auto_complete_tasks.rake

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

data/test/jrails_auto_complete_test.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: jrails_auto_complete
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Michele Franzin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 4
+        version: 0.5.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jrails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :runtime
+  version_requirements: *id003
+description: Adds autocomplete support to jRails, using jQuery-UI; it works similarly to the original rails autocomplete plugin, but generating unobtrusive javascript.
+email: michele.franzin@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- CHANGELOG
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- init.rb
+- lib/jrails_auto_complete.rb
+- lib/jrails_auto_complete_form_builder_helper.rb
+- lib/jrails_auto_complete_macros_helper.rb
+- lib/jrails_auto_complete_tag_helper.rb
+- rails/init.rb
+- tasks/jrails_auto_complete_tasks.rake
+- test/jrails_auto_complete_test.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: jRails autocomplete using jQuery-UI
+test_files: 
+- test/jrails_auto_complete_test.rb