has_messages_generators 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.mdown

@@ -0,0 +1,43 @@
+## Gem Dependency
+- `devise` (works with other authentication gems, but needs some modifications)
+- `jquery-rails`
+- `kaminari`
+- `ancestry`
+
+# Installation Instructions
+
+This generator will required you to have Authentication gems such as Devise, to use this
+you must include `devise` and `has_messages` in your Gemfile.
+
+	gem "devise"
+	gem "has_messages"
+
+After that setup the `devise` properly.
+
+	rails g devise:install
+	rails g devise user		# => user model name example.
+
+After you configure `devise` properly now install `has_messages` with the given USER MODEL NAME
+
+	rails g has_messages:install user
+
+this will generate all the necessary files and code into your Rails app.
+
+At the end of the installation just follow the instructions to modify your layout file.
+
+If you wish to add some links for `devise` and `has_messages` path, just add this code into your layout file.
+
+	<% if user_signed_in? %>
+	  <%= link_to "inbox(#{current_user.inbox(:opened => false).count})", messages_path(:inbox), :id => "inbox-link" %> |
+	  Signed in as <%= current_user.email %> Not You?
+	  <%= link_to 'Sign out', destroy_user_session_path, :method => :delete %>
+	<% else %>
+	  <%= link_to 'Sign up', new_user_registration_path %> or <%= link_to 'Sign in', new_user_session_path %>
+	<% end %>
+
+Run the migration and start the app!
+
+## Found a bug?
+
+This is stil under development mode, if you are having some problem with `has_messages`, 
+feel free to submit an issue here. http://github.com/fajrif/has_messages/issues

data/lib/generators/base.rb

@@ -0,0 +1,179 @@
+require 'rails/generators/base'
+require 'bundler'
+require 'bundler/dsl'
+
+module HasMessages
+  module Generators
+    class Base < Rails::Generators::Base #:nodoc:
+      
+      def self.source_root
+        @_has_messages_source_root = File.expand_path(File.join(File.dirname(__FILE__), 'has_messages', generator_name, 'templates'))
+      end
+      
+      def self.banner
+        "rails generate has_messages:#{generator_name} #{self.arguments.map{ |a| a.usage }.join(' ')} [options]"
+      end
+      
+protected
+      
+      def root_path(path)
+        File.expand_path(File.join(File.dirname(__FILE__), 'has_messages', path))
+      end
+      
+      def destination_path(path)
+        File.join(destination_root, path)
+      end
+      
+      def file_exists?(path)
+        File.exist? destination_path(path)
+      end
+      
+      def folder_exists?(path)
+        File.directory? path
+      end
+      
+      def class_exists?(class_name)
+        klass = Rails.application.class.parent_name.constantize.const_get(class_name)
+        return klass.is_a?(Class)
+      rescue NameError
+        return false
+      end
+      
+      def extract(filepath,destinationpath,foldername)
+        begin
+          print_notes("Extracting #{filepath}")
+          system("tar -C '#{destination_path(destinationpath)}' -xzf '#{root_path(filepath)}' #{foldername}/")
+        rescue Exception => e
+          raise e
+        end
+      end
+      
+      def asking(messages,&block)
+        opt = ask("=> #{messages} [yes]")
+        if opt == "yes" || opt.blank?
+          yield
+        end
+      rescue Exception => e
+        raise e
+      end
+      
+      def print_notes(message,notes = "notes",color = :yellow)
+        unless message.blank?
+          puts        '', '='*80
+          say_status  "#{notes}", "#{message}", color
+          puts        '='*80, ''; sleep 0.5
+        else
+          puts "\n"
+        end
+      end
+      
+      def print_usage
+        self.class.help(Thor::Base.shell.new)
+        exit
+      end
+      
+      def install_local_gem(name,version = nil)
+        ::Bundler.with_clean_env do
+          if version
+            `gem install #{name} -v=#{version}`
+          else
+            `gem install #{name}`
+          end
+        end
+        $? == 0 ? true : false
+      rescue Exception => e
+        raise e
+      end
+      
+      def check_local_gem?(name,version = nil)
+        ::Bundler.with_clean_env do
+          if version
+            `gem list #{name} -i -v=#{version}`
+          else
+            `gem list #{name} -i`
+          end
+        end
+        $? == 0 ? true : false
+      rescue Exception => e
+        raise e
+      end
+      
+      def refresh_bundle
+        ::Bundler.with_clean_env do
+          `bundle`
+        end
+      rescue Exception => e
+        raise e
+      end
+      
+      def set_application_config(&block)
+        inject_into_class "config/application.rb", "Application" do
+          yield
+        end
+      rescue Exception => e
+        raise e
+      end
+      
+      def must_load_lib_directory
+        set_application_config do
+          '  config.autoload_paths += %W(#{config.root}/lib)' + "\n"
+        end
+      end
+      
+      def gemfile_included?(name)
+        ::Bundler.with_clean_env do
+          `bundle show #{name}`
+        end
+        $?.exitstatus == 0 ? true : false
+      rescue Exception => e
+        raise e
+      end
+      
+      def check_required_gems?(*names)
+        names.each do |name|
+          return false unless gemfile_included? name
+        end
+        true
+      rescue Exception => e
+        raise e
+      end
+      
+      def rails_3_1?
+        Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR >= 1
+      end
+
+      def copy_asset(source, *args, &block)
+        if rails_3_1?
+          if args.first =~ /^public/
+            args.first.gsub!(/^public/,"app/assets")
+          end
+          if args.first.include?("javascripts/application.js") or args.first.include?("stylesheets/application.css")
+            last_line = IO.readlines(args.first).last
+            content = IO.read(File.expand_path(find_in_source_paths(source.to_s)))
+            content.gsub!(/images/,"assets")
+            inject_into_file args.first, :after => last_line do
+              content
+            end
+            return
+          end
+        end
+        copy_file(source, *args, &block)
+      end
+      
+      def remove_asset(path, config={})
+        if rails_3_1?
+          if path =~ /^public/
+            path.gsub!(/^public/,"app/assets")
+          end
+        end
+        remove_asset(path, config)
+      end
+      
+    end
+  end
+end
+
+# => set callback on when calling +gem+
+set_trace_func proc { |event, file, line, id, binding, classname| 
+  ::Bundler.with_clean_env { `bundle` } if classname == Rails::Generators::Actions && id == :gem && event == 'return'
+}

data/lib/generators/has_messages/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+	The has_messages generator creates a basic messaging system between user in your app.
+
+To install all the files into your app:
+
+	rails g has_messages:install user
+
+  or if you want to completely remove the files from your directory
+
+	rails g has_messages:install user --destroy

data/lib/generators/has_messages/install/install_generator.rb

@@ -0,0 +1,126 @@
+require 'generators/base'
+require 'rails/generators/active_record'
+require 'rails/generators/migration'
+require 'rails/generators/generated_attribute'
+
+module HasMessages
+  module Generators
+    class InstallGenerator < Base
+      include Rails::Generators::Migration
+      
+      argument :arg, :type => :string, :required => true, :banner => 'USER MODEL NAME'
+      class_option :destroy, :desc => 'Destroy all `has_messages` files', :type => :boolean, :default => false
+      
+      def generate_has_messages
+        @model_path = "app/models/#{arg}.rb"
+        @class_name = arg.classify
+        if file_exists?(@model_path)
+          if class_exists?(@class_name)
+            if options.destroy?
+              destroy_has_messages
+            else
+              install_required_gem
+              must_load_lib_directory unless rails_3_1?
+              copy_migrations
+              copy_models_and_inject_code_into_user_model
+              copy_controller_and_helper
+              copy_views
+              copy_assets
+              add_routes
+              readme "README"
+            end
+          else
+            raise "#{@class_name} class are not exists!"
+          end
+        else
+          raise "#{@model_path} are not exists in your current directory!"
+        end
+      rescue Exception => e
+        print_notes(e.message,"error",:red)
+      end
+      
+private 
+      
+      def install_required_gem
+        gem "jquery-rails"
+        generate("jquery:install") unless rails_3_1?
+        gem "kaminari"
+        gem "ancestry"
+      end
+      
+      def copy_migrations
+        migration_template "models/create_messages.rb", "db/migrate/create_messages.rb"
+      end
+      
+      def copy_models_and_inject_code_into_user_model
+        template "models/message.rb", "app/models/message.rb"
+        copy_file "lib/has_messages.rb", "lib/has_messages.rb"
+        
+        inject_into_class @model_path, @class_name do
+          "\n  has_many :messages" +
+          "\n  include HasMessages\n"
+        end
+      end
+      
+      def copy_controller_and_helper
+        template 'controllers/messages_controller.rb', 'app/controllers/messages_controller.rb'
+        copy_file 'helpers/messages_helper.rb', 'app/helpers/messages_helper.rb'
+      end
+      
+      def copy_views
+        copy_file "views/_head.html.erb", "app/views/messages/_head.html.erb"
+        copy_file "views/_messages.html.erb", "app/views/messages/_messages.html.erb"
+        copy_file "views/_tabs_panel.html.erb", "app/views/messages/_tabs_panel.html.erb"
+        copy_file "views/index.html.erb", "app/views/messages/index.html.erb"
+        copy_file "views/index.js.erb", "app/views/messages/index.js.erb"
+        copy_file "views/new.html.erb", "app/views/messages/new.html.erb"
+        copy_file "views/show.html.erb", "app/views/messages/show.html.erb"
+      end
+      
+      def copy_assets
+        copy_asset 'assets/stylesheets/messages.css', 'public/stylesheets/messages.css'
+        copy_asset 'assets/stylesheets/token-input-facebook.css', 'public/stylesheets/token-input-facebook.css'
+        copy_asset 'assets/javascripts/messages.js', 'public/javascripts/messages.js'
+        copy_asset 'assets/javascripts/jquery.tokeninput.js', 'public/javascripts/jquery.tokeninput.js'
+      end
+      
+      def add_routes
+        inject_into_file "config/routes.rb", :after => "Application.routes.draw do" do
+          "\n\n\t resources :messages, :only => [:new, :create] do" +
+          "\n\t   collection do" +
+          "\n\t     get 'token' => 'messages#token', :as => 'token'" +
+          "\n\t     post 'empty/:messagebox' => 'messages#empty', :as => 'empty'" +
+          "\n\t     put 'update' => 'messages#update'" +
+          "\n\t     get ':messagebox/show/:id' => 'messages#show', :as => 'show', :constraints => { :messagebox => /inbox|outbox|trash/ }" +
+          "\n\t     get '(/:messagebox)' => 'messages#index', :as => 'box', :constraints => { :messagebox => /inbox|outbox|trash/ }" +
+          "\n\t   end" +
+          "\n\t end\n"
+        end
+      end
+      
+      def destroy_has_messages
+        asking "Are you sure want to destroy the `has_messages` files?" do
+          remove_file "app/models/message.rb"
+          run('rm db/migrate/*_create_messages.rb')
+          remove_file "app/controllers/messages_controller.rb"
+          remove_file "app/helpers/messages_helper.rb"
+          gsub_file @model_path, /has_many :messages/, ''
+          gsub_file @model_path, /include HasMessages/, ''
+          remove_file "lib/has_messages.rb"
+          remove_dir "app/views/messages"
+          remove_asset 'public/stylesheets/messages.css'
+          remove_asset 'public/stylesheets/token-input-facebook.css'
+          remove_asset 'public/javascripts/messages.js'
+          remove_asset 'public/javascripts/jquery.tokeninput.js'
+          gsub_file 'config/routes.rb', /resources :messages.*:constraints => { :messagebox => \/inbox|outbox|trash\/ }(\s*end){2}/m, ''
+        end
+      end
+      
+      # FIXME: Should be proxied to ActiveRecord::Generators::Base
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+    end
+  end
+end

data/lib/generators/has_messages/install/templates/README

@@ -0,0 +1,26 @@
+
+========================================================================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Ensure you have set authentication filter in app/controllers/messages_controller.rb.
+     For example if using Devise:
+
+       before_filter :authenticate_user!
+
+  2. Ensure you have content placeholder :head in app/views/layouts/application.html.erb.
+     For example:
+
+       <%= yield(:head) %>
+
+  3. Ensure you have flash messages in app/views/layouts/application.html.erb.
+     For example:
+
+       <p class="notice"><%= notice %></p>
+       <p class="alert"><%= alert %></p>
+
+  4. If you like to put some link to your app/views/layouts/application.html.erb.
+
+       <%= link_to "inbox(#{current_user.inbox(:opened => false).count})", messages_path(:inbox), :id => "inbox-link" %>
+
+========================================================================================================================

data/lib/generators/has_messages/install/templates/assets/javascripts/jquery.tokeninput.js

@@ -0,0 +1,718 @@
+/*
+ * jQuery Plugin: Tokenizing Autocomplete Text Entry
+ * Version 1.4.2
+ *
+ * Copyright (c) 2009 James Smith (http://loopj.com)
+ * Licensed jointly under the GPL and MIT licenses,
+ * choose which one suits your project best!
+ *
+ */
+
+(function ($) {
+// Default settings
+var DEFAULT_SETTINGS = {
+    hintText: "Type in a search term",
+    noResultsText: "No results",
+    searchingText: "Searching...",
+    deleteText: "×",
+    searchDelay: 300,
+    minChars: 1,
+    tokenLimit: null,
+    jsonContainer: null,
+    method: "GET",
+    contentType: "json",
+    queryParam: "q",
+    tokenDelimiter: ",",
+    preventDuplicates: false,
+    prePopulate: null,
+    animateDropdown: true,
+    onResult: null,
+    onAdd: null,
+    onDelete: null
+};
+
+// Default classes to use when theming
+var DEFAULT_CLASSES = {
+    tokenList: "token-input-list",
+    token: "token-input-token",
+    tokenDelete: "token-input-delete-token",
+    selectedToken: "token-input-selected-token",
+    highlightedToken: "token-input-highlighted-token",
+    dropdown: "token-input-dropdown",
+    dropdownItem: "token-input-dropdown-item",
+    dropdownItem2: "token-input-dropdown-item2",
+    selectedDropdownItem: "token-input-selected-dropdown-item",
+    inputToken: "token-input-input-token"
+};
+
+// Input box position "enum"
+var POSITION = {
+    BEFORE: 0,
+    AFTER: 1,
+    END: 2
+};
+
+// Keys "enum"
+var KEY = {
+    BACKSPACE: 8,
+    TAB: 9,
+    ENTER: 13,
+    ESCAPE: 27,
+    SPACE: 32,
+    PAGE_UP: 33,
+    PAGE_DOWN: 34,
+    END: 35,
+    HOME: 36,
+    LEFT: 37,
+    UP: 38,
+    RIGHT: 39,
+    DOWN: 40,
+    NUMPAD_ENTER: 108,
+    COMMA: 188
+};
+
+
+// Expose the .tokenInput function to jQuery as a plugin
+$.fn.tokenInput = function (url_or_data, options) {
+    var settings = $.extend({}, DEFAULT_SETTINGS, options || {});
+
+    return this.each(function () {
+        new $.TokenList(this, url_or_data, settings);
+    });
+};
+
+
+// TokenList class for each input
+$.TokenList = function (input, url_or_data, settings) {
+    //
+    // Initialization
+    //
+
+    // Configure the data source
+    if($.type(url_or_data) === "string") {
+        // Set the url to query against
+        settings.url = url_or_data;
+
+        // Make a smart guess about cross-domain if it wasn't explicitly specified
+        if(settings.crossDomain === undefined) {
+            if(settings.url.indexOf("://") === -1) {
+                settings.crossDomain = false;
+            } else {
+                settings.crossDomain = (location.href.split(/\/+/g)[1] !== settings.url.split(/\/+/g)[1]);
+            }
+        }
+    } else if($.type(url_or_data) === "array") {
+        // Set the local data to search through
+        settings.local_data = url_or_data;
+    }
+
+    // Build class names
+    if(settings.classes) {
+        // Use custom class names
+        settings.classes = $.extend({}, DEFAULT_CLASSES, settings.classes);
+    } else if(settings.theme) {
+        // Use theme-suffixed default class names
+        settings.classes = {};
+        $.each(DEFAULT_CLASSES, function(key, value) {
+            settings.classes[key] = value + "-" + settings.theme;
+        });
+    } else {
+        settings.classes = DEFAULT_CLASSES;
+    }
+
+
+    // Save the tokens
+    var saved_tokens = [];
+
+    // Keep track of the number of tokens in the list
+    var token_count = 0;
+
+    // Basic cache to save on db hits
+    var cache = new $.TokenList.Cache();
+
+    // Keep track of the timeout, old vals
+    var timeout;
+    var input_val;
+
+    // Create a new text input an attach keyup events
+    var input_box = $("<input type=\"text\"  autocomplete=\"off\">")
+        .css({
+            outline: "none"
+        })
+        .focus(function () {
+            if (settings.tokenLimit === null || settings.tokenLimit !== token_count) {
+                show_dropdown_hint();
+            }
+        })
+        .blur(function () {
+            hide_dropdown();
+        })
+        .bind("keyup keydown blur update", resize_input)
+        .keydown(function (event) {
+            var previous_token;
+            var next_token;
+
+            switch(event.keyCode) {
+                case KEY.LEFT:
+                case KEY.RIGHT:
+                case KEY.UP:
+                case KEY.DOWN:
+                    if(!$(this).val()) {
+                        previous_token = input_token.prev();
+                        next_token = input_token.next();
+
+                        if((previous_token.length && previous_token.get(0) === selected_token) || (next_token.length && next_token.get(0) === selected_token)) {
+                            // Check if there is a previous/next token and it is selected
+                            if(event.keyCode === KEY.LEFT || event.keyCode === KEY.UP) {
+                                deselect_token($(selected_token), POSITION.BEFORE);
+                            } else {
+                                deselect_token($(selected_token), POSITION.AFTER);
+                            }
+                        } else if((event.keyCode === KEY.LEFT || event.keyCode === KEY.UP) && previous_token.length) {
+                            // We are moving left, select the previous token if it exists
+                            select_token($(previous_token.get(0)));
+                        } else if((event.keyCode === KEY.RIGHT || event.keyCode === KEY.DOWN) && next_token.length) {
+                            // We are moving right, select the next token if it exists
+                            select_token($(next_token.get(0)));
+                        }
+                    } else {
+                        var dropdown_item = null;
+
+                        if(event.keyCode === KEY.DOWN || event.keyCode === KEY.RIGHT) {
+                            dropdown_item = $(selected_dropdown_item).next();
+                        } else {
+                            dropdown_item = $(selected_dropdown_item).prev();
+                        }
+
+                        if(dropdown_item.length) {
+                            select_dropdown_item(dropdown_item);
+                        }
+                        return false;
+                    }
+                    break;
+
+                case KEY.BACKSPACE:
+                    previous_token = input_token.prev();
+
+                    if(!$(this).val().length) {
+                        if(selected_token) {
+                            delete_token($(selected_token));
+                        } else if(previous_token.length) {
+                            select_token($(previous_token.get(0)));
+                        }
+
+                        return false;
+                    } else if($(this).val().length === 1) {
+                        hide_dropdown();
+                    } else {
+                        // set a timeout just long enough to let this function finish.
+                        setTimeout(function(){do_search();}, 5);
+                    }
+                    break;
+
+                case KEY.TAB:
+                case KEY.ENTER:
+                case KEY.NUMPAD_ENTER:
+                case KEY.COMMA:
+                  if(selected_dropdown_item) {
+                    add_token($(selected_dropdown_item));
+                    return false;
+                  }
+                  break;
+
+                case KEY.ESCAPE:
+                  hide_dropdown();
+                  return true;
+
+                default:
+                    if(String.fromCharCode(event.which)) {
+                        // set a timeout just long enough to let this function finish.
+                        setTimeout(function(){do_search();}, 5);
+                    }
+                    break;
+            }
+        });
+
+    // Keep a reference to the original input box
+    var hidden_input = $(input)
+                           .hide()
+                           .val("")
+                           .focus(function () {
+                               input_box.focus();
+                           })
+                           .blur(function () {
+                               input_box.blur();
+                           });
+
+    // Keep a reference to the selected token and dropdown item
+    var selected_token = null;
+    var selected_dropdown_item = null;
+
+    // The list to store the token items in
+    var token_list = $("<ul />")
+        .addClass(settings.classes.tokenList)
+        .click(function (event) {
+            var li = $(event.target).closest("li");
+            if(li && li.get(0) && $.data(li.get(0), "tokeninput")) {
+                toggle_select_token(li);
+            } else {
+                // Deselect selected token
+                if(selected_token) {
+                    deselect_token($(selected_token), POSITION.END);
+                }
+
+                // Focus input box
+                input_box.focus();
+            }
+        })
+        .mouseover(function (event) {
+            var li = $(event.target).closest("li");
+            if(li && selected_token !== this) {
+                li.addClass(settings.classes.highlightedToken);
+            }
+        })
+        .mouseout(function (event) {
+            var li = $(event.target).closest("li");
+            if(li && selected_token !== this) {
+                li.removeClass(settings.classes.highlightedToken);
+            }
+        })
+        .insertBefore(hidden_input);
+
+    // The token holding the input box
+    var input_token = $("<li />")
+        .addClass(settings.classes.inputToken)
+        .appendTo(token_list)
+        .append(input_box);
+
+    // The list to store the dropdown items in
+    var dropdown = $("<div>")
+        .addClass(settings.classes.dropdown)
+        .appendTo("body")
+        .hide();
+
+    // Magic element to help us resize the text input
+    var input_resizer = $("<tester/>")
+        .insertAfter(input_box)
+        .css({
+            position: "absolute",
+            top: -9999,
+            left: -9999,
+            width: "auto",
+            fontSize: input_box.css("fontSize"),
+            fontFamily: input_box.css("fontFamily"),
+            fontWeight: input_box.css("fontWeight"),
+            letterSpacing: input_box.css("letterSpacing"),
+            whiteSpace: "nowrap"
+        });
+
+    // Pre-populate list if items exist
+    hidden_input.val("");
+    li_data = settings.prePopulate || hidden_input.data("pre");
+    if(li_data && li_data.length) {
+        $.each(li_data, function (index, value) {
+            insert_token(value.id, value.name);
+        });
+    }
+
+
+
+    //
+    // Private functions
+    //
+
+    function resize_input() {
+        if(input_val === (input_val = input_box.val())) {return;}
+
+        // Enter new content into resizer and resize input accordingly
+        var escaped = input_val.replace(/&/g, '&amp;').replace(/\s/g,' ').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+        input_resizer.html(escaped);
+        input_box.width(input_resizer.width() + 30);
+    }
+
+    function is_printable_character(keycode) {
+        return ((keycode >= 48 && keycode <= 90) ||     // 0-1a-z
+                (keycode >= 96 && keycode <= 111) ||    // numpad 0-9 + - / * .
+                (keycode >= 186 && keycode <= 192) ||   // ; = , - . / ^
+                (keycode >= 219 && keycode <= 222));    // ( \ ) '
+    }
+
+    // Inner function to a token to the list
+    function insert_token(id, value) {
+        var this_token = $("<li><p>"+ value +"</p> </li>")
+          .addClass(settings.classes.token)
+          .insertBefore(input_token);
+
+        // The 'delete token' button
+        $("<span>" + settings.deleteText + "</span>")
+            .addClass(settings.classes.tokenDelete)
+            .appendTo(this_token)
+            .click(function () {
+                delete_token($(this).parent());
+                return false;
+            });
+
+        // Store data on the token
+        var token_data = {"id": id, "name": value};
+        $.data(this_token.get(0), "tokeninput", token_data);
+
+        // Save this token for duplicate checking
+        saved_tokens.push(token_data);
+
+        // Update the hidden input
+        var token_ids = $.map(saved_tokens, function (el) {
+            return el.id;
+        });
+        hidden_input.val(token_ids.join(settings.tokenDelimiter));
+
+        token_count += 1;
+
+        return this_token;
+    }
+
+    // Add a token to the token list based on user input
+    function add_token (item) {
+        var li_data = $.data(item.get(0), "tokeninput");
+        var callback = settings.onAdd;
+
+        // See if the token already exists and select it if we don't want duplicates
+        if(token_count > 0 && settings.preventDuplicates) {
+            var found_existing_token = null;
+            token_list.children().each(function () {
+                var existing_token = $(this);
+                var existing_data = $.data(existing_token.get(0), "tokeninput");
+                if(existing_data && existing_data.id === li_data.id) {
+                    found_existing_token = existing_token;
+                    return false;
+                }
+            });
+
+            if(found_existing_token) {
+                select_token(found_existing_token);
+                input_token.insertAfter(found_existing_token);
+                input_box.focus();
+                return;
+            }
+        }
+
+        // Insert the new tokens
+        insert_token(li_data.id, li_data.name);
+
+        // Check the token limit
+        if(settings.tokenLimit !== null && token_count >= settings.tokenLimit) {
+            input_box.hide();
+            hide_dropdown();
+            return;
+        } else {
+            input_box.focus();
+        }
+
+        // Clear input box
+        input_box.val("");
+
+        // Don't show the help dropdown, they've got the idea
+        hide_dropdown();
+
+        // Execute the onAdd callback if defined
+        if($.isFunction(callback)) {
+            callback(li_data);
+        }
+    }
+
+    // Select a token in the token list
+    function select_token (token) {
+        token.addClass(settings.classes.selectedToken);
+        selected_token = token.get(0);
+
+        // Hide input box
+        input_box.val("");
+
+        // Hide dropdown if it is visible (eg if we clicked to select token)
+        hide_dropdown();
+    }
+
+    // Deselect a token in the token list
+    function deselect_token (token, position) {
+        token.removeClass(settings.classes.selectedToken);
+        selected_token = null;
+
+        if(position === POSITION.BEFORE) {
+            input_token.insertBefore(token);
+        } else if(position === POSITION.AFTER) {
+            input_token.insertAfter(token);
+        } else {
+            input_token.appendTo(token_list);
+        }
+
+        // Show the input box and give it focus again
+        input_box.focus();
+    }
+
+    // Toggle selection of a token in the token list
+    function toggle_select_token(token) {
+        var previous_selected_token = selected_token;
+
+        if(selected_token) {
+            deselect_token($(selected_token), POSITION.END);
+        }
+
+        if(previous_selected_token === token.get(0)) {
+            deselect_token(token, POSITION.END);
+        } else {
+            select_token(token);
+        }
+    }
+
+    // Delete a token from the token list
+    function delete_token (token) {
+        // Remove the id from the saved list
+        var token_data = $.data(token.get(0), "tokeninput");
+        var callback = settings.onDelete;
+
+        // Delete the token
+        token.remove();
+        selected_token = null;
+
+        // Show the input box and give it focus again
+        input_box.focus();
+
+        // Remove this token from the saved list
+        saved_tokens = $.grep(saved_tokens, function (val) {
+            return (val.id !== token_data.id);
+        });
+
+        // Update the hidden input
+        var token_ids = $.map(saved_tokens, function (el) {
+            return el.id;
+        });
+        hidden_input.val(token_ids.join(settings.tokenDelimiter));
+
+        token_count -= 1;
+
+        if(settings.tokenLimit !== null) {
+            input_box
+                .show()
+                .val("")
+                .focus();
+        }
+
+        // Execute the onDelete callback if defined
+        if($.isFunction(callback)) {
+            callback(token_data);
+        }
+    }
+
+    // Hide and clear the results dropdown
+    function hide_dropdown () {
+        dropdown.hide().empty();
+        selected_dropdown_item = null;
+    }
+
+    function show_dropdown() {
+        dropdown
+            .css({
+                position: "absolute",
+                top: $(token_list).offset().top + $(token_list).outerHeight(),
+                left: $(token_list).offset().left,
+                zindex: 999
+            })
+            .show();
+    }
+
+    function show_dropdown_searching () {
+        if(settings.searchingText) {
+            dropdown.html("<p>"+settings.searchingText+"</p>");
+            show_dropdown();
+        }
+    }
+
+    function show_dropdown_hint () {
+        if(settings.hintText) {
+            dropdown.html("<p>"+settings.hintText+"</p>");
+            show_dropdown();
+        }
+    }
+
+    // Highlight the query part of the search term
+    function highlight_term(value, term) {
+        return value.replace(new RegExp("(?![^&;]+;)(?!<[^<>]*)(" + term + ")(?![^<>]*>)(?![^&;]+;)", "gi"), "<b>$1</b>");
+    }
+
+    // Populate the results dropdown with some results
+    function populate_dropdown (query, results) {
+        if(results && results.length) {
+            dropdown.empty();
+            var dropdown_ul = $("<ul>")
+                .appendTo(dropdown)
+                .mouseover(function (event) {
+                    select_dropdown_item($(event.target).closest("li"));
+                })
+                .mousedown(function (event) {
+                    add_token($(event.target).closest("li"));
+                    return false;
+                })
+                .hide();
+
+            $.each(results, function(index, value) {
+                var this_li = $("<li>" + highlight_term(value.name, query) + "</li>")
+                                  .appendTo(dropdown_ul);
+
+                if(index % 2) {
+                    this_li.addClass(settings.classes.dropdownItem);
+                } else {
+                    this_li.addClass(settings.classes.dropdownItem2);
+                }
+
+                if(index === 0) {
+                    select_dropdown_item(this_li);
+                }
+
+                $.data(this_li.get(0), "tokeninput", {"id": value.id, "name": value.name});
+            });
+
+            show_dropdown();
+
+            if(settings.animateDropdown) {
+                dropdown_ul.slideDown("fast");
+            } else {
+                dropdown_ul.show();
+            }
+        } else {
+            if(settings.noResultsText) {
+                dropdown.html("<p>"+settings.noResultsText+"</p>");
+                show_dropdown();
+            }
+        }
+    }
+
+    // Highlight an item in the results dropdown
+    function select_dropdown_item (item) {
+        if(item) {
+            if(selected_dropdown_item) {
+                deselect_dropdown_item($(selected_dropdown_item));
+            }
+
+            item.addClass(settings.classes.selectedDropdownItem);
+            selected_dropdown_item = item.get(0);
+        }
+    }
+
+    // Remove highlighting from an item in the results dropdown
+    function deselect_dropdown_item (item) {
+        item.removeClass(settings.classes.selectedDropdownItem);
+        selected_dropdown_item = null;
+    }
+
+    // Do a search and show the "searching" dropdown if the input is longer
+    // than settings.minChars
+    function do_search() {
+        var query = input_box.val().toLowerCase();
+
+        if(query && query.length) {
+            if(selected_token) {
+                deselect_token($(selected_token), POSITION.AFTER);
+            }
+
+            if(query.length >= settings.minChars) {
+                show_dropdown_searching();
+                clearTimeout(timeout);
+
+                timeout = setTimeout(function(){
+                    run_search(query);
+                }, settings.searchDelay);
+            } else {
+                hide_dropdown();
+            }
+        }
+    }
+
+    // Do the actual search
+    function run_search(query) {
+        var cached_results = cache.get(query);
+        if(cached_results) {
+            populate_dropdown(query, cached_results);
+        } else {
+            // Are we doing an ajax search or local data search?
+            if(settings.url) {
+                // Extract exisiting get params
+                var ajax_params = {};
+                ajax_params.data = {};
+                if(settings.url.indexOf("?") > -1) {
+                    var parts = settings.url.split("?");
+                    ajax_params.url = parts[0];
+
+                    var param_array = parts[1].split("&");
+                    $.each(param_array, function (index, value) {
+                        var kv = value.split("=");
+                        ajax_params.data[kv[0]] = kv[1];
+                    });
+                } else {
+                    ajax_params.url = settings.url;
+                }
+
+                // Prepare the request
+                ajax_params.data[settings.queryParam] = query;
+                ajax_params.type = settings.method;
+                ajax_params.dataType = settings.contentType;
+                if(settings.crossDomain) {
+                    ajax_params.dataType = "jsonp";
+                }
+
+                // Attach the success callback
+                ajax_params.success = function(results) {
+                  if($.isFunction(settings.onResult)) {
+                      results = settings.onResult.call(this, results);
+                  }
+                  cache.add(query, settings.jsonContainer ? results[settings.jsonContainer] : results);
+
+                  // only populate the dropdown if the results are associated with the active search query
+                  if(input_box.val().toLowerCase() === query) {
+                      populate_dropdown(query, settings.jsonContainer ? results[settings.jsonContainer] : results);
+                  }
+                };
+
+                // Make the request
+                $.ajax(ajax_params);
+            } else if(settings.local_data) {
+                // Do the search through local data
+                var results = $.grep(settings.local_data, function (row) {
+                    return row.name.toLowerCase().indexOf(query.toLowerCase()) > -1;
+                });
+
+                populate_dropdown(query, results);
+            }
+        }
+    }
+};
+
+// Really basic cache for the results
+$.TokenList.Cache = function (options) {
+    var settings = $.extend({
+        max_size: 500
+    }, options);
+
+    var data = {};
+    var size = 0;
+
+    var flush = function () {
+        data = {};
+        size = 0;
+    };
+
+    this.add = function (query, results) {
+        if(size > settings.max_size) {
+            flush();
+        }
+
+        if(!data[query]) {
+            size += 1;
+        }
+
+        data[query] = results;
+    };
+
+    this.get = function (query) {
+        return data[query];
+    };
+};
+}(jQuery));