autosuggest-rb 0.0.2 → 0.0.3

data/README.markdown

@@ -1,10 +1,10 @@
-# autosuggest
+# autosuggest-rb
 
 ## Installing
 
 Include the gem on your Gemfile
 
-    gem 'autosuggest'
+    gem 'autosuggest-rb'
 
 Install it
 
@@ -17,7 +17,7 @@ Run the generator
 And include jquery.autoSuggest.js and autoSuggest.css on your layouts
 
     javascript_include_tag "jquery.autoSuggest.js"
-    stylsheet_link_tag "autoSuggest.css"
+    stylesheet_link_tag "autoSuggest.css"
 
 ## Usage
 
@@ -52,7 +52,16 @@ From the view you can create the autosuggest field like this:
       f.autosuggest_field :tags, autosuggest_tag_name_recipes_path
     end
 
+By default, autosuggest only queries the db for existing tags, but if you want to be able to create new ones, just pass these options:
+
+    f.autosuggest_field :tags, autosuggest_tag_name_recipes_path, :autosuggest_options => { "newValuesInputName" => recipes[new_tags]" }
+
+Then you can do whatever you want from the controller using params[:recipes][:new_tags]
+
+
 These are the default options:
+
+    "queryParam" => "query",
     "selectedItemProp" => "name",
     "searchObjProps" => "name",
     "neverSubmit" => "true",
@@ -62,69 +71,73 @@ But you can pass options in by using the autosuggest_options param
 
     f.autosuggest_field :tags, autosuggest_tag_name_recipes_path, :autosuggest_options => {"neverSubmit" => "true"}
 
-Here are the other options you can pass in (pasted from http://code.drewwilson.com/entry/autosuggest-jquery-plugin):
+Here are the other options you can pass in - pasted from http://code.drewwilson.com/entry/autosuggest-jquery-plugin
+
+**asHtmlName:** string (false by default) - Enables you to specify your own custom name that will be attributed to the text field
+
+**newValuesInputName:** string (false by default) - Enables you to define a name for a hidden field that will catch new names that don't match any in the db
 
-asHtmlID: string (false by default) - Enables you to specify your own custom ID that will be appended to the top level AutoSuggest UL element's ID name. Otherwise it will default to using a random ID. Example: id="CUSTOM_ID". This is also applies to the hidden input filed that holds all of the selected values. Example: id="as-values-CUSTOM_ID"
+**asHtmlID:** string (false by default) - Enables you to specify your own custom ID that will be appended to the top level AutoSuggest UL element's ID name. Otherwise it will default to using a random ID. Example: id="CUSTOM_ID". This is also applies to the hidden input filed that holds all of the selected values. Example: id="as-values-CUSTOM_ID"
 
-startText: string ("Enter Name Here" by default) - Text to display when the AutoSuggest input field is empty.
+**startText:** string ("Enter Name Here" by default) - Text to display when the AutoSuggest input field is empty.
 
-emptyText: string ("No Results" by default) - Text to display when their are no search results.
+**emptyText:** string ("No Results" by default) - Text to display when their are no search results.
 
-preFill: object or string (empty object by default) - Enables you to pre-fill the AutoSuggest box with selections when the page is first loaded. You can pass in a comma separated list of values (a string), or an object. When using a string, each value is used as both the display text on the selected item and for it's value. When using an object, the options selectedItemProp will define the object property to use for the display text and selectedValuesProp will define the object property to use for the value for the selected item. Note: you must setup your preFill object in that format. A preFill object can look just like the example objects laid out above.
+**preFill:** object or string (empty object by default) - Enables you to pre-fill the AutoSuggest box with selections when the page is first loaded. You can pass in a comma separated list of values (a string), or an object. When using a string, each value is used as both the display text on the selected item and for it's value. When using an object, the options selectedItemProp will define the object property to use for the display text and selectedValuesProp will define the object property to use for the value for the selected item. Note: you must setup your preFill object in that format. A preFill object can look just like the example objects laid out above.
 
-limitText: string ("No More Selections Are Allowed" by default) - Text to display when the number of selections has reached it's limit.
+**limitText:** string ("No More Selections Are Allowed" by default) - Text to display when the number of selections has reached it's limit.
 
-selectedItemProp: string ("value" by default) - Name of object property to use as the display text for each chosen item.
+**selectedItemProp:** string ("value" by default) - Name of object property to use as the display text for each chosen item.
 
-selectedValuesProp: string ("value" by default) - Name of object property to use as the value for each chosen item. This value will be stored into the hidden input field.
+**selectedValuesProp:** string ("value" by default) - Name of object property to use as the value for each chosen item. This value will be stored into the hidden input field.
 
-searchObjProps: string ("value" by default) - Comma separated list of object property names. The values in these objects properties will be used as the text to perform the search on.
+**searchObjProps:** string ("value" by default) - Comma separated list of object property names. The values in these objects properties will be used as the text to perform the search on.
 
-queryParam: string ("q" by default) - The name of the param that will hold the search string value in the AJAX request.
+**queryParam:** string ("q" by default) - The name of the param that will hold the search string value in the AJAX request.
 
-retrieveLimit: number (false by default) - If set to a number, it will add a '&limit=' param to the AJAX request. It also limits the number of search results allowed to be displayed in the results dropdown box.
+**retrieveLimit:** number (false by default) - If set to a number, it will add a '&limit=' param to the AJAX request. It also limits the number of search results allowed to be displayed in the results dropdown box.
 
-extraParams: string ("" by default) - This will be added onto the end of the AJAX request URL. Make sure you add an '&' before each param.
+**extraParams:** string ("" by default) - This will be added onto the end of the AJAX request URL. Make sure you add an '&' before each param.
 
-matchCase: true or false (false by default) - Make the search case sensitive when set to true.
+**matchCase:** true or false (false by default) - Make the search case sensitive when set to true.
 
-minChars: number (1 by default) - Minimum number of characters that must be entered into the AutoSuggest input field before the search begins.
+**minChars:** number (1 by default) - Minimum number of characters that must be entered into the AutoSuggest input field before the search begins.
 
-keyDelay: number (400 by default) - Number of milliseconds to delay after a keydown on the AutoSuggest input field and before search is started.
+**keyDelay:** number (400 by default) - Number of milliseconds to delay after a keydown on the AutoSuggest input field and before search is started.
 
-resultsHighlight: true or false (true by default) - Option to choose whether or not to highlight the matched text in each result item.
+**resultsHighlight:** true or false (true by default) - Option to choose whether or not to highlight the matched text in each result item.
 
-neverSubmit: true or false (false by default) - If set to true this option will never allow the 'return' key to submit the form that AutoSuggest is a part of.
+**neverSubmit:** true or false (false by default) - If set to true this option will never allow the 'return' key to submit the form that AutoSuggest is a part of.
 
-selectionLimit: number (false by default) - Limits the number of selections that are allowed to be made to the number specified.
+**selectionLimit:** number (false by default) - Limits the number of selections that are allowed to be made to the number specified.
 
-showResultList: true or false (true by default) - If set to false, the Results Dropdown List will never be shown at any time.
+**showResultList:** true or false (true by default) - If set to false, the Results Dropdown List will never be shown at any time.
 
-start: callback function - Custom function that is run only once on each AutoSuggest field when the code is first applied.
+**start:** callback function - Custom function that is run only once on each AutoSuggest field when the code is first applied.
 
-selectionClick: callback function - Custom function that is run when a previously chosen item is clicked. The item that is clicked is passed into this callback function as 'elem'.
+**selectionClick:** callback function - Custom function that is run when a previously chosen item is clicked. The item that is clicked is passed into this callback function as 'elem'.
 
 Example: selectionClick: function(elem){ elem.fadeTo("slow", 0.33); }
 
-selectionAdded: callback function - Custom function that is run when a selection is made by choosing one from the Results dropdown, or by using the tab/comma keys to add one. The selection item is passed into this callback function as 'elem'.
+**selectionAdded:** callback function - Custom function that is run when a selection is made by choosing one from the Results dropdown, or by using the tab/comma keys to add one. The selection item is passed into this callback function as 'elem'.
 
 Example: selectionAdded: function(elem){ elem.fadeTo("slow", 0.33); }
 
-selectionRemoved: callback function - Custom function that is run when a selection removed from the AutoSuggest by using the delete key or by clicking the "x" inside the selection. The selection item is passed into this callback function as 'elem'.
+**selectionRemoved:** callback function - Custom function that is run when a selection removed from the AutoSuggest by using the delete key or by clicking the "x" inside the selection. The selection item is passed into this callback function as 'elem'.
 
 Example: selectionRemoved: function(elem){ elem.fadeTo("fast", 0, function(){ elem.remove(); }); }
 
-formatList: callback function - Custom function that is run after all the data has been retrieved and before the results are put into the suggestion results list. This is here so you can modify what & how things show up in the suggestion results list.
+**formatList:** callback function - Custom function that is run after all the data has been retrieved and before the results are put into the suggestion results list. This is here so you can modify what & how things show up in the suggestion results list.
 
-beforeRetrieve: callback function - Custom function that is run right before the AJAX request is made, or before the local objected is searched. This is used to modify the search string before it is processed. So if a user entered "jim" into the AutoSuggest box, you can call this function to prepend their query with "guy_". Making the final query = "guy_jim". The search query is passed into this function. Example: beforeRetrieve: function(string){ return string; }
+**beforeRetrieve:** callback function - Custom function that is run right before the AJAX request is made, or before the local objected is searched. This is used to modify the search string before it is processed. So if a user entered "jim" into the AutoSuggest box, you can call this function to prepend their query with "guy_". Making the final query = "guy_jim". The search query is passed into this function. Example: beforeRetrieve: function(string){ return string; }
 
-retrieveComplete: callback function - Custom function that is run after the ajax request has completed. The data object MUST be returned if this is used. Example: retrieveComplete: function(data){ return data; }
+**retrieveComplete:** callback function - Custom function that is run after the ajax request has completed. The data object MUST be returned if this is used. Example: retrieveComplete: function(data){ return data; }
 
-resultClick: callback function - Custom function that is run when a search result item is clicked. The data from the item that is clicked is passed into this callback function as 'data'.
+**resultClick:** callback function - Custom function that is run when a search result item is clicked. The data from the item that is clicked is passed into this callback function as 'data'.
 
 Example: resultClick: function(data){ console.log(data); }
 
-resultsComplete: callback function - Custom function that is run when the suggestion results dropdown list is made visible. Will run after every search query.
+**resultsComplete:** callback function - Custom function that is run when the suggestion results dropdown list is made visible. Will run after every search query.
 
 
 

data/Rakefile

@@ -1,2 +1,12 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/autosuggest-rb.gemspec

@@ -14,14 +14,15 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "autosuggest-rb"
 
+  s.add_dependency('rails', '~>3.0')
+  s.add_dependency('yajl-ruby')
+
+  s.add_development_dependency('sqlite3-ruby')
+  s.add_development_dependency('shoulda', '2.11.3')
+  s.add_development_dependency('ruby-debug19')
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-
-  s.add_dependency('rails', '~>3.0')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('rspec-rails')
-  s.add_development_dependency('ruby-debug19')
-  s.add_development_dependency('mocha')
 end

data/lib/autosuggest/controller_macros.rb

@@ -1,14 +1,20 @@
+require 'yajl'
+
 module Autosuggest
   module ControllerMacros
     # when called, you must add a custom route for action like this:
     # resources :products do
     #   get :autosuggest_brand_name, :on => :collection
     # end
-    def autosuggest(object, name)
+    def autosuggest(object, name, options={})
+      display_name = options[:display] || name
+      order = options[:order] || "#{name} ASC"
+      limit = options[:limit] || 10
+
       define_method "autosuggest_#{object}_#{name}" do
         # assuming an ActiveRecord mysql backed model for right now
-        results = objectify(object).where("#{name} LIKE ?", "%#{params[:q]}%")
-        render :json => results.map{|r| {:name => r.send(:name), :value => r.id}}
+        results = objectify(object).where("#{name} LIKE ?", "%#{params[:query]}%").order(order).limit(limit)
+        render :json => Yajl::Encoder.encode(results.map{|r| {:name => r.send(display_name), :value => r.id}})
       end
     end
   end

data/lib/autosuggest/form_helper.rb

@@ -5,7 +5,7 @@ module ActionView
         text_field_class = "autosuggest_#{object_name}_#{method}"
         options[:class] = "#{options[:class].to_s} #{text_field_class}"
         autosuggest_options = options.delete(:autosuggest_options) || {}
-        autosuggest_options.reverse_merge!("selectedItemProp" => "name", "searchObjProps" => "name", "neverSubmit" => "true", "asHtmlName" => "#{object_name}[set_#{method}]")
+        autosuggest_options.reverse_merge!("queryParam" => "query", "selectedItemProp" => "name", "searchObjProps" => "name", "neverSubmit" => "true", "asHtmlName" => "#{object_name}[set_#{method}]")
 
         _out = text_field(object_name, method, options)
         _out << raw(%{

data/lib/autosuggest/version.rb

@@ -1,3 +1,3 @@
 module Autosuggest
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/generators/autosuggest_generator.rb

@@ -1,8 +1,9 @@
 require 'rails/generators'
 
 class AutosuggestGenerator < Rails::Generators::Base
+
   def install
-    # Copy the unobtrusive JS file
+    # Copy the unobtrusive JS file and CSS file
     copy_file('jquery.autoSuggest.js', 'public/javascripts/jquery.autoSuggest.js')
     copy_file('autoSuggest.css', 'public/stylesheets/autoSuggest.css')
   end

data/test/controller_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+module Autosuggest
+  module TestCase
+    include Shoulda::InstanceMethods
+    extend Shoulda::ClassMethods
+    include Shoulda::Assertions
+    extend Shoulda::Macros
+    include Shoulda::Helpers
+
+    context "GET autosuggest action" do
+      should "respond succesfully" do
+        get :autosuggest_tag_name
+        assert_response :success
+
+        get :autosuggest_tag_name, :query => ''
+        assert_response :success
+
+        get :autosuggest_tag_name, :query => nil
+        assert_response :success
+
+        get :autosuggest_tag_name, :query => 'Ch'
+        assert_response :success
+      end
+
+      should "respond with expexted JSON" do
+        get :autosuggest_tag_name, :query => 'Ca'
+        json_response = JSON.parse(@response.body)
+        assert_equal json_response.first["name"], "Cajun"
+      end
+
+      should "return results in alphabetical order by default" do
+        get :autosuggest_tag_name, :query => 'Ch'
+        json_response = JSON.parse(@response.body)
+        assert_equal json_response.first["name"], "Chicken"
+        assert_equal json_response.last["name"], "Chinese"
+      end
+
+      should "be able to sort in other ways" do
+        @controller.class_eval do
+          autosuggest :tag, :name, :order => "name DESC"
+        end
+
+        get :autosuggest_tag_name, :query => 'Ch'
+        json_response = JSON.parse(@response.body)
+        assert_equal json_response.first["name"], "Chinese"
+        assert_equal json_response.last["name"], "Chicken"
+      end
+
+      should "be able to limit the results" do
+        @controller.class_eval do
+          autosuggest :tag, :name, :limit => 1
+        end
+
+        get :autosuggest_tag_name, :query => 'Ch'
+        json_response = JSON.parse(@response.body)
+        assert_equal json_response.count, 1
+        assert_equal json_response.first["name"], "Chicken"
+      end
+
+      should "be able to customize what is displayed" do
+        @controller.class_eval do
+          autosuggest :tag, :name, :display => :display_name
+        end
+
+        get :autosuggest_tag_name, :query => 'Ch'
+        json_response = JSON.parse(@response.body)
+        assert_equal json_response.first["name"], "Tag: Chicken"
+        assert_equal json_response.last["name"], "Tag: Chinese"
+      end
+    end
+  end
+end

data/test/db_stores_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+require 'controller_test'
+require 'support/active_record'
+
+class ActiveRecordControllerTest < ActionController::TestCase
+  include Autosuggest::TestCase::ActiveRecord
+  include Autosuggest::TestCase
+end

data/test/form_helper_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class Tag
+  attr_accessor :name
+end
+
+class FormHelperTest < ActionView::TestCase
+  context "autosuggest_field" do
+    should "render properly" do
+      output = autosuggest_field(:tag, :name, 'some/path')
+      assert_match /class=\" autosuggest_tag_name\"/, output
+      assert_match /\$\('.autosuggest_tag_name'\)/, output
+    end
+  end
+
+  context "autosuggest_field_tag" do
+    should "render properly" do
+      raise "implement this"
+    end
+
+  end
+end

data/test/support/active_record.rb

@@ -0,0 +1,43 @@
+module Autosuggest
+  module TestCase
+    module ActiveRecord
+      def setup
+        ::ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+        ::ActiveRecord::Schema.define(:version => 1) do
+          create_table :tags do |t|
+            t.string :name
+          end
+        end
+
+        create_models
+
+        @controller = RecipesController.new
+
+        @tag1 = @tag_class.create(:name => 'Chinese')
+        @tag2 = @tag_class.create(:name => 'Chicken')
+        @tag3 = @tag_class.create(:name => 'Cajun')
+      end
+
+      def teardown
+        destroy_models
+        ::ActiveRecord::Base.connection.tables.each do |table|
+          ::ActiveRecord::Base.connection.drop_table(table)
+        end
+      end
+
+      private
+      def create_models
+        @tag_class = Object.const_set(:Tag, Class.new(::ActiveRecord::Base))
+        @tag_class.class_eval do
+          def display_name
+            "Tag: #{name}"
+          end
+        end
+      end
+
+      def destroy_models
+        Object.send(:remove_const, :Tag)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rails/all'
+require 'rails/test_help'
+require 'autosuggest-rb'
+require 'ruby-debug'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Autosuggest
+  class Application < Rails::Application
+  end
+end
+
+Autosuggest::Application.routes.draw do
+  match '/:controller(/:action(/:id))'
+end
+
+ActionController::Base.send :include, Autosuggest::Application.routes.url_helpers
+
+Ingredient = Class.new
+RecipesController = Class.new(ActionController::Base)
+RecipesController.autosuggest(:tag, :name)
+

metadata

@@ -2,7 +2,7 @@
 name: autosuggest-rb
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Derrick Camerino
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 -07:00
+date: 2011-05-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +25,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: yajl-ruby
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -33,10 +33,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec-rails
+  name: sqlite3-ruby
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -47,18 +47,18 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: ruby-debug19
+  name: shoulda
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.11.3
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: ruby-debug19
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -83,49 +83,6 @@ files:
 - README.markdown
 - Rakefile
 - autosuggest-rb.gemspec
-- integration/.gitignore
-- integration/Gemfile
-- integration/README
-- integration/Rakefile
-- integration/app/controllers/application_controller.rb
-- integration/app/helpers/application_helper.rb
-- integration/app/views/layouts/application.html.erb
-- integration/config.ru
-- integration/config/application.rb
-- integration/config/boot.rb
-- integration/config/database.yml
-- integration/config/environment.rb
-- integration/config/environments/development.rb
-- integration/config/environments/production.rb
-- integration/config/environments/test.rb
-- integration/config/initializers/backtrace_silencers.rb
-- integration/config/initializers/inflections.rb
-- integration/config/initializers/mime_types.rb
-- integration/config/initializers/secret_token.rb
-- integration/config/initializers/session_store.rb
-- integration/config/locales/en.yml
-- integration/config/routes.rb
-- integration/db/seeds.rb
-- integration/doc/README_FOR_APP
-- integration/lib/tasks/.gitkeep
-- integration/public/404.html
-- integration/public/422.html
-- integration/public/500.html
-- integration/public/favicon.ico
-- integration/public/images/rails.png
-- integration/public/index.html
-- integration/public/javascripts/application.js
-- integration/public/javascripts/controls.js
-- integration/public/javascripts/dragdrop.js
-- integration/public/javascripts/effects.js
-- integration/public/javascripts/prototype.js
-- integration/public/javascripts/rails.js
-- integration/public/robots.txt
-- integration/public/stylesheets/.gitkeep
-- integration/script/rails
-- integration/test/performance/browsing_test.rb
-- integration/test/test_helper.rb
-- integration/vendor/plugins/.gitkeep
 - lib/autosuggest-rb.rb
 - lib/autosuggest/controller_macros.rb
 - lib/autosuggest/form_helper.rb
@@ -134,8 +91,11 @@ files:
 - lib/generators/assets/autoSuggest.css
 - lib/generators/assets/jquery.autoSuggest.js
 - lib/generators/autosuggest_generator.rb
-- spec/lib/class_methods_spec.rb
-- spec/spec_helper.rb
+- test/controller_test.rb
+- test/db_stores_test.rb
+- test/form_helper_test.rb
+- test/support/active_record.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -165,5 +125,8 @@ signing_key:
 specification_version: 3
 summary: This is a gem that wraps the AutoSuggest javascript plugin
 test_files: 
-- spec/lib/class_methods_spec.rb
-- spec/spec_helper.rb
+- test/controller_test.rb
+- test/db_stores_test.rb
+- test/form_helper_test.rb
+- test/support/active_record.rb
+- test/test_helper.rb