ajax-chosen-rails 0.1.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

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

data/README.md

@@ -0,0 +1,50 @@
+# Ajax-Chosen for rails asset pipeline
+
+[Chosen](https://github.com/harvesthq/chosen) is a library for making long, unwieldy select boxes more user friendly.
+
+The `ajax-chosen-rails` gem integrates `Chosen` and `Ajax-Chosen` with the Rails asset pipeline.
+
+## Usage
+
+### Install ajax-chosen-rails gem
+
+Include `ajax-chosen-rails` in Gemfile
+
+    gem 'ajax-chosen-rails'
+
+Then run `bundle install`
+
+### Include chosen and ajax-chosen javascript assets
+
+Add to your `app/assets/stylesheets/application.js` if use with jQuery
+
+    //= require chosen-jquery
+    //= require ajax-chosen-jquery
+
+Or with Prototype
+
+    //= require chosen-prototype
+    //= require ajax-chosen-prototype
+
+
+### Include chosen stylesheet assets
+
+Add to your `app/assets/stylesheets/application.css`
+
+    *= require chosen
+
+## Gem maintainance
+
+Maintain `ajax-chosen-rails` gem with `Rake` commands.
+
+Update origin chosen source files.
+
+    rake update
+
+Publish gem.
+
+    rake release
+
+## License
+
+use MIT license.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require File.expand_path('../lib/ajax-chosen-rails/source_file', __FILE__)
+
+desc "Update with FFCRM's Ajax-Chosen Library"
+task "update" do
+  files = SourceFile.new
+  files.fetch
+end

data/ajax-chosen-rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ajax-chosen-rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nathan Broadbent"]
+  gem.email         = ["nathan.f77@gmail.com"]
+  gem.description   = %q{Chosen is a javascript library of select box enhancer for jQuery and Protoype. This gem integrates Ajax-Chosen with Rails asset pipeline for ease of use.}
+  gem.summary       = %q{Integrate Ajax-Chosen javascript library with Rails asset pipeline}
+  gem.homepage      = "https://github.com/fatfreecrm/ajax-chosen-rails"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ajax-chosen-rails"
+  gem.require_paths = ["lib"]
+  gem.version       = AjaxChosen::Rails::VERSION
+
+  gem.add_dependency "railties", "~> 3.0"
+  gem.add_dependency "thor",     "~> 0.14"
+  gem.add_dependency "chosen-rails"
+  gem.add_development_dependency "bundler", "~> 1.0"
+  gem.add_development_dependency "rails",   "~> 3.0"
+  gem.add_development_dependency "sass",    "~> 3.1"
+end

data/lib/ajax-chosen-rails.rb

@@ -0,0 +1,11 @@
+require "ajax-chosen-rails/version"
+
+module AjaxChosen
+  module Rails
+    if ::Rails.version < "3.1"
+      require "ajax-chosen-rails/railtie"
+    else
+      require "ajax-chosen-rails/engine"
+    end
+  end
+end

data/lib/ajax-chosen-rails/engine.rb

@@ -0,0 +1,6 @@
+module AjaxChosen
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/ajax-chosen-rails/railtie.rb

@@ -0,0 +1,6 @@
+module AjaxChosen
+  module Rails
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/ajax-chosen-rails/source_file.rb

@@ -0,0 +1,23 @@
+require "thor"
+
+class SourceFile < Thor
+  include Thor::Actions
+
+  desc "fetch source files", "fetch source files from GitHub"
+  def fetch
+    self.destination_root = "vendor/assets"
+    remote = "https://github.com/fatfreecrm/ajax-chosen"
+    branch = "master"
+    get "#{remote}/raw/#{branch}/src/ajax-chosen.jquery.coffee", "javascripts/ajax-chosen.jquery.coffee"
+    get "#{remote}/raw/#{branch}/src/ajax-chosen.proto.coffee",  "javascripts/ajax-chosen.proto.coffee"
+    get "#{remote}/raw/#{branch}/lib/ajax-chosen.jquery.js",     "javascripts/ajax-chosen.jquery.js"
+    get "#{remote}/raw/#{branch}/lib/ajax-chosen.proto.js",      "javascripts/ajax-chosen.proto.js"    
+    get "#{remote}/raw/#{branch}/VERSION", "VERSION"
+    inside destination_root do
+      version = File.read("VERSION").sub("\n", "")
+      gsub_file "../../lib/ajax-chosen-rails/version.rb", /VERSION\s=\s"(\d|\.)+"$/ do |match|
+        %Q{VERSION = "#{version}"}
+      end
+    end
+  end
+end

data/lib/ajax-chosen-rails/version.rb

@@ -0,0 +1,6 @@
+module AjaxChosen
+  module Rails
+    VERSION = "0.1.0"
+    EDITOR_VERSION = "0.1.0"
+  end
+end

data/vendor/assets/VERSION

@@ -0,0 +1 @@
+0.1.0

data/vendor/assets/javascripts/ajax-chosen.jquery.coffee

@@ -0,0 +1,80 @@
+(($) ->
+
+  $.fn.ajaxChosen = (options, callback) ->
+    # This will come in handy later.
+    select = this
+    
+    # Load chosen. To make things clear, I have taken the liberty
+    # of using the .chzn-autoselect class to specify input elements
+    # we want to use with ajax autocomplete.
+    this.chosen()
+    
+    # Now that chosen is loaded normally, we can bootstrap it with
+    # our ajax autocomplete code.
+    this.next('.chzn-container')
+      .find(".search-field > input")
+      .bind 'keyup', ->
+        # This code will be executed every time the user types a letter
+        # into the input form that chosen has created
+        
+        # Retrieve the current value of the input form
+        val = $.trim $(this).attr('value')
+        
+        # Some simple validation so we don't make excess ajax calls. I am
+        # assuming you don't want to perform a search with less than 3
+        # characters.
+        return false if val.length < 3 or val is $(this).data('prevVal')
+        
+        # Set the current search term so we don't execute the ajax call if
+        # the user hits a key that isn't an input letter/number/symbol
+        $(this).data('prevVal', val)
+        
+        # This is a useful reference for later
+        field = $(this)
+        
+        # I'm assuming that it's ok to use the parameter name `term` to send
+        # the form value during the ajax call. Change if absolutely needed.
+        options.data = term: val
+        
+        # If the user provided an ajax success callback, store it so we can
+        # call it after our bootstrapping is finished.
+        success ?= options.success
+        
+        # Create our own callback that will be executed when the ajax call is
+        # finished.
+        options.success = (data) ->
+          # Exit if the data we're given is invalid
+          return if not data?
+          
+          # Go through all of the <option> elements in the <select> and remove
+          # ones that have not been selected by the user.
+          select.find('option').each -> $(this).remove() if not $(this).is(":selected")
+          
+          # Send the ajax results to the user callback so we can get an object of
+          # value => text pairs to inject as <option> elements.
+          items = callback data
+          
+          # Iterate through the given data and inject the <option> elements into
+          # the DOM
+          $.each items, (value, text) ->
+            $("<option />")
+              .attr('value', value)
+              .html(text)
+              .appendTo(select)
+              
+          # Tell chosen that the contents of the <select> input have been updated
+          # This makes chosen update its internal list of the input data.
+          select.trigger("liszt:updated")
+          
+          # For some reason, the contents of the input field get removed once you
+          # call trigger above. Often, this can be very annoying (and can make some
+          # searches impossible), so we add the value the user was typing back into
+          # the input field.
+          field.attr('value', val)
+          
+          # Finally, call the user supplied callback (if it exists)
+          success() if success?
+          
+        # Execute the ajax call to search for autocomplete data
+        $.ajax(options)
+)(jQuery)

data/vendor/assets/javascripts/ajax-chosen.jquery.js

@@ -0,0 +1,47 @@
+(function() {
+  (function($) {
+    return $.fn.ajaxChosen = function(options, callback) {
+      var select;
+      select = this;
+      this.chosen();
+      return this.next('.chzn-container').find(".search-field > input").bind('keyup', function() {
+        var field, val;
+        val = $.trim($(this).attr('value'));
+        if (val.length < 3 || val === $(this).data('prevVal')) {
+          return false;
+        }
+        $(this).data('prevVal', val);
+        field = $(this);
+        options.data = {
+          term: val
+        };
+                if (typeof success !== "undefined" && success !== null) {
+          success;
+        } else {
+          success = options.success;
+        };
+        options.success = function(data) {
+          var items;
+          if (!(data != null)) {
+            return;
+          }
+          select.find('option').each(function() {
+            if (!$(this).is(":selected")) {
+              return $(this).remove();
+            }
+          });
+          items = callback(data);
+          $.each(items, function(value, text) {
+            return $("<option />").attr('value', value).html(text).appendTo(select);
+          });
+          select.trigger("liszt:updated");
+          field.attr('value', val);
+          if (typeof success !== "undefined" && success !== null) {
+            return success();
+          }
+        };
+        return $.ajax(options);
+      });
+    };
+  })(jQuery);
+}).call(this);

data/vendor/assets/javascripts/ajax-chosen.proto.coffee

@@ -0,0 +1,88 @@
+root = this
+
+class ajaxChosen extends Chosen
+  activate_field: ->
+    if @options.show_on_activate and not @active_field
+      this.results_show() 
+    super
+  
+  constructor: (select, @options, callback) ->
+    # Load chosen. To make things clear, I have taken the liberty
+    # of using the .chzn-autoselect class to specify input elements
+    # we want to use with ajax autocomplete.
+    super select, options
+    
+    # Now that chosen is loaded normally, we can bootstrap it with
+    # our ajax autocomplete code.
+    select.next('.chzn-container')
+      .down('.chzn-search > input')
+      .observe 'keyup', ->
+        # This code will be executed every time the user types a letter
+        # into the input form that chosen has created
+        
+        # Retrieve the current value of the input form
+        val = $(this).value.strip()
+        # Some simple validation so we don't make excess ajax calls. I am
+        # assuming you don't want to perform a search with less than 3
+        # characters.
+        
+        return false if val.length < 3 or val is $(this).readAttribute('data-prevVal')
+        
+        # Set the current search term so we don't execute the ajax call if
+        # the user hits a key that isn't an input letter/number/symbol
+        $(this).writeAttribute('data-prevVal', val)
+        
+        # This is a useful reference for later
+        field = $(this)
+        
+        # I'm assuming that it's ok to use the parameter name `term` to send
+        # the form value during the ajax call. Change if absolutely needed.
+        query_key = options.query_key || "term"
+        (options.parameters ||= {})[query_key] = val
+        
+        # If the user provided an ajax success callback, store it so we can
+        # call it after our bootstrapping is finished.
+        success = options.success
+        
+        # Create our own callback that will be executed when the ajax call is
+        # finished.
+        options.onSuccess = (data) ->       
+          # Exit if the data we're given is invalid
+          return if not data?
+
+          # Go through all of the <option> elements in the <select> and remove
+          # ones that have not been selected by the user.
+          select.childElements().each (el) -> el.remove() if not el.selected
+
+          # Send the ajax results to the user callback so we can get an object of
+          # value => text pairs to inject as <option> elements.
+          items = if callback then callback(data.responseJSON) else data.responseJSON
+
+          # Iterate through the given data and inject the <option> elements into
+          # the DOM
+          $H(items).each (pair) ->
+            if select.value != pair.key
+              select.insert
+                bottom:
+                  new Element("option", {value: pair.key})
+                    .update(pair.value)
+              
+          val = field.value
+              
+          # Tell chosen that the contents of the <select> input have been updated
+          # This makes chosen update its internal list of the input data.
+          select.fire("liszt:updated")
+          
+          # For some reason, the contents of the input field get removed once you
+          # call trigger above. Often, this can be very annoying (and can make some
+          # searches impossible), so we add the value the user was typing back into
+          # the input field.
+          field.value = val
+          
+          # Finally, call the user supplied callback (if it exists)
+          success() if success?
+          
+        # Execute the ajax call to search for autocomplete data
+        new Ajax.Request options.url, options
+        
+root.ajaxChosen = ajaxChosen

data/vendor/assets/javascripts/ajax-chosen.proto.js

@@ -0,0 +1,67 @@
+(function() {
+  var ajaxChosen, root;
+  var __hasProp = Object.prototype.hasOwnProperty, __extends = function(child, parent) {
+    for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; }
+    function ctor() { this.constructor = child; }
+    ctor.prototype = parent.prototype;
+    child.prototype = new ctor;
+    child.__super__ = parent.prototype;
+    return child;
+  };
+  root = this;
+  ajaxChosen = (function() {
+    __extends(ajaxChosen, Chosen);
+    ajaxChosen.prototype.activate_field = function() {
+      if (this.options.show_on_activate && !this.active_field) {
+        this.results_show();
+      }
+      return ajaxChosen.__super__.activate_field.apply(this, arguments);
+    };
+    function ajaxChosen(select, options, callback) {
+      this.options = options;
+      ajaxChosen.__super__.constructor.call(this, select, options);
+      select.next('.chzn-container').down('.chzn-search > input').observe('keyup', function() {
+        var field, query_key, success, val;
+        val = $(this).value.strip();
+        if (val.length < 3 || val === $(this).readAttribute('data-prevVal')) {
+          return false;
+        }
+        $(this).writeAttribute('data-prevVal', val);
+        field = $(this);
+        query_key = options.query_key || "term";
+        (options.parameters || (options.parameters = {}))[query_key] = val;
+        success = options.success;
+        options.onSuccess = function(data) {
+          var items;
+          if (!(data != null)) {
+            return;
+          }
+          select.childElements().each(function(el) {
+            if (!el.selected) {
+              return el.remove();
+            }
+          });
+          items = callback ? callback(data.responseJSON) : data.responseJSON;
+          $H(items).each(function(pair) {
+            if (select.value !== pair.key) {
+              return select.insert({
+                bottom: new Element("option", {
+                  value: pair.key
+                }).update(pair.value)
+              });
+            }
+          });
+          val = field.value;
+          select.fire("liszt:updated");
+          field.value = val;
+          if (success != null) {
+            return success();
+          }
+        };
+        return new Ajax.Request(options.url, options);
+      });
+    }
+    return ajaxChosen;
+  })();
+  root.ajaxChosen = ajaxChosen;
+}).call(this);

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ajax-chosen-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Broadbent
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &74066110 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74066110
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &74065860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74065860
+- !ruby/object:Gem::Dependency
+  name: chosen-rails
+  requirement: &74065670 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74065670
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &74065400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *74065400
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &74065150 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *74065150
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: &74064920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: *74064920
+description: Chosen is a javascript library of select box enhancer for jQuery and
+  Protoype. This gem integrates Ajax-Chosen with Rails asset pipeline for ease of
+  use.
+email:
+- nathan.f77@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ajax-chosen-rails.gemspec
+- lib/ajax-chosen-rails.rb
+- lib/ajax-chosen-rails/engine.rb
+- lib/ajax-chosen-rails/railtie.rb
+- lib/ajax-chosen-rails/source_file.rb
+- lib/ajax-chosen-rails/version.rb
+- vendor/assets/VERSION
+- vendor/assets/javascripts/ajax-chosen.jquery.coffee
+- vendor/assets/javascripts/ajax-chosen.jquery.js
+- vendor/assets/javascripts/ajax-chosen.proto.coffee
+- vendor/assets/javascripts/ajax-chosen.proto.js
+homepage: https://github.com/fatfreecrm/ajax-chosen-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Integrate Ajax-Chosen javascript library with Rails asset pipeline
+test_files: []