bootstrap-findahead-rails 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjBmYmI0YTM2MjE3NGYzMjcyMTNmYTVhOTljOGRkMDM1ZDhiOWRhYQ==
+  data.tar.gz: !binary |-
+    ZTJhYTMzMzIwMDg4MjFjNGRhNGE4YjIyNjM3MWYzZTU3ZWY3MDE1Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NzFiZDYxZmMyZjgzNGYzYTIyNzEwMDgzNzc4MWU3MzZjMjllMTUzOWYzNTc0
+    MjNmMWNmYmQxN2Y2MGM3YWYwM2U1NzhlYzkwNDVmNzlmOGRiYjk1NTEwNmJj
+    YTU2OWMwOTI2YzQ1YzY0M2ViNzNkZjRiNGUxZmYzZTU5NTY2Yjc=
+  data.tar.gz: !binary |-
+    N2JiZDFhNmMxYTUzMTc2ZTk0NWExNjFmMWM1OTAyNmE4NmJhMzI1NDE2NTk2
+    MDllYTM0ZTFhYjVlYTk5ZjFmNDY2MTg0MDhmNWQ0ZWQzMWIxZjE5ZmNiNDVh
+    ODcxYzA0MmY2YjgzYjkwZmM3MjI5ZjQ5N2UwYTQ3OWRkMWVmMTU=

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 'https://rubygems.org'
+
+# Specify your gem's dependencies in bootstrap-findahead-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pierrick Rouxel
+
+MIT License
+
+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,64 @@
+# bootstrap-findahead-rails
+
+A search component for Twitter Bootstrap
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    group :assets do
+        gem 'bootstrap-findahead-rails'
+    end
+
+And then execute:
+
+    $ bundle install
+
+Stylesheets
+Add necessary stylesheet file to app/assets/stylesheets/application.css
+
+    *= require bootstrap-findahead
+
+Javascripts
+Add necessary javascript(s) files to app/assets/javascripts/application.js
+
+    //= require bootstrap-findahead
+
+## Usage
+
+### Via JavaScript
+
+```javascript
+$('.findahead').typeahead()
+```
+
+### Options
+
+| Name          | Type          | Default               | Description                                                  |
+| ------------- | ------------- | --------------------- | ------------------------------------------------------------ |
+| source        | function      | []                    | The data source to query against. Should be a function is passed two arguments, the **query** value in the input field and the **process** callback. The function may be used synchronously by returning the data source directly or asynchronously via the process callback's single argument. |
+| items         | number        | 8                     | The max number of items to display in the dropdown.          |
+| minLength     | number        | 1                     | The minimum character length needed before triggering autocomplete suggestions |
+| matcher       | function      | case insensitive      | The method used to determine if a query matches an **item**. Accepts a single argument, the item against which to test the query. Access the current query with **this.query**. Return a boolean **true** if query is a match. |
+| sorter        | function      | exact match, case sensitive, case insensitive | Method used to sort autocomplete results. Accepts a single argument **items** and has the scope of the findahead instance. Reference the current query with **this.query**. |
+| updater       | function      | returns selected item | The method used to return selected item. Accepts a single argument, the **item** and has the scope of the findahead instance. |
+| highlighter   | function      | highlights all default matches | Method used to highlight autocomplete results. Accepts a single argument **item** and has the scope of the findahead instance. Should return html. |
+| timer         | number        | 0                     | Time to wait before last type to execute query. In milliseconds. |
+| visualLoading | boolean       | true                  | Show or hide visual loading component                        |
+
+### Methods
+
+**.findahead(options)**
+Initializes an input with a findahead.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Thanks
+
+Thanks to twitter bootstrap for typeahead.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bootstrap-findahead-rails.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bootstrap/findahead/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bootstrap-findahead-rails"
+  spec.version       = Bootstrap::Findahead::Rails::VERSION
+  spec.authors       = ["Pierrick Rouxel"]
+  spec.email         = ["pierrick.rouxel@me.com"]
+  spec.description   = %q{A search component for Twitter Bootstrap}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/pierrickrouxel/bootstrap-findahead-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 3.1"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/bootstrap/findahead/rails.rb

@@ -0,0 +1,10 @@
+require "bootstrap/findahead/rails/version"
+
+module Bootstrap
+  module Findahead
+    module Rails
+      class Engine < ::Rails::Engine
+      end
+    end
+  end
+end

data/lib/bootstrap/findahead/rails/version.rb

@@ -0,0 +1,7 @@
+module Bootstrap
+  module Findahead
+    module Rails
+      VERSION = "1.0.0"
+    end
+  end
+end

data/vendor/assets/javascripts/bootstrap-findahead.js

@@ -0,0 +1,342 @@
+!function($){
+
+    "use strict"; // jshint ;_;
+
+    /* FINDAHEAD PUBLIC CLASS DEFINITION
+     * ================================= */
+
+    var Findahead = function (element, options) {
+        this.$element = $(element)
+        this.options = $.extend({}, $.fn.findahead.defaults, options)
+        this.matcher = this.options.matcher || this.matcher
+        this.sorter = this.options.sorter || this.sorter
+        this.highlighter = this.options.highlighter || this.highlighter
+        this.updater = this.options.updater || this.updater
+        this.$zone = $("<div></div>").addClass("findahead control-group")
+        this.$loading = $("<div></div>")
+        this.$menu = $(this.options.menu)
+        this.shown = false
+        this.source = this.options.source
+
+        this.drawAddon()
+        this.listen()
+    }
+
+    Findahead.prototype = {
+
+        constructor: Findahead
+
+        , drawAddon: function() {
+            this.$element.after(this.$zone)
+            this.$zone.append(this.$element)
+            this.$zone.append(this.$loading)
+        }
+
+        , setLoadingEnabled: function(enable) {
+            if (this.options.visualLoading && enable) {
+                this.$loading.addClass("loading")
+            } else {
+                this.$loading.removeClass("loading")
+            }
+        }
+
+        , setNoItemEnabled: function(enable) {
+            if (enable) {
+                this.$zone.addClass("error")
+            } else {
+                this.$zone.removeClass("error")
+            }
+        }
+
+        , resetTimeout: function() {
+            // To avoid type spacing with less than 1 second
+            if ( this.timeout != null ) {
+                clearTimeout(this.timeout)
+            }
+
+            this.setNoItemEnabled(false)
+            this.setLoadingEnabled(false)
+
+            // Doesn't do search if keyword contains less than minLength letters
+            var value = this.$element.val()
+            if ( value.length > this.options.minLength ) {
+                this.setLoadingEnabled(true)
+                this.timeout = setTimeout($.proxy(this.lookup, this), this.options.timer)
+            }
+
+            this.shown ? this.hide() : this
+        }
+
+        , matcher: function(item) {
+            return ~item.toLowerCase().indexOf(this.query.toLowerCase())
+        }
+
+        , sorter: function(items) {
+            return items
+        }
+
+        , updater: function(item) {
+            return item
+        }
+
+        , select: function() {
+            var val = this.$menu.find('.active').data('value')
+            if (val != null) {
+                this.$element
+                    .val(this.updater(val).toString())
+                    .change()
+                return this.hide()
+            }
+        }
+
+        , show: function () {
+            var pos = $.extend({}, this.$element.position(), {
+                height: this.$element[0].offsetHeight
+            })
+
+            this.$menu
+                .insertAfter(this.$element)
+                .css({
+                    top: pos.top + pos.height
+                    , left: pos.left
+                })
+                .show()
+
+            this.shown = true
+            return this
+        }
+
+        , hide: function () {
+            this.$menu.hide()
+            this.shown = false
+            return this
+        }
+
+        , lookup: function (event) {
+            var items
+
+            this.query = this.$element.val()
+
+            items = $.isFunction(this.source) ? this.source(this.query, $.proxy(this.process, this)) : this.source
+
+            return items ? this.process(items) : this
+        }
+
+        , process: function (items) {
+            var that = this
+
+            this.setLoadingEnabled(false)
+
+            items = $.grep(items, function (item) {
+                return that.matcher(item.toString())
+            })
+
+            if (items.length < 1) {
+                this.setNoItemEnabled(true)
+                return this.shown ? this.hide() : this
+            }
+
+            items = this.sorter(items)
+
+            return this.render(items.slice(0, this.options.items)).show()
+        }
+
+        , highlighter: function (item) {
+            var query = this.query.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g, '\\$&')
+            return item.replace(new RegExp('(' + query + ')', 'ig'), function ($1, match) {
+                return '<strong>' + match + '</strong>'
+            })
+        }
+
+        , render: function (items) {
+            var that = this
+
+            if (items.length > 0) {
+                items = $(items).map(function (i, item) {
+                    i = $(that.options.item).data('value', item)
+                    i.find('a').html(that.highlighter(item.toString()))
+                    return i[0]
+                })
+
+                items.first().addClass('active')
+            }
+            this.$menu.html(items)
+            return this
+        }
+
+        , next: function (event) {
+            var active = this.$menu.find('.active').removeClass('active')
+                , next = active.next()
+
+            if (!next.length) {
+                next = $(this.$menu.find('li')[0])
+            }
+
+            next.addClass('active')
+        }
+
+        , prev: function (event) {
+            var active = this.$menu.find('.active').removeClass('active')
+                , prev = active.prev()
+
+            if (!prev.length) {
+                prev = this.$menu.find('li').last()
+            }
+
+            prev.addClass('active')
+        }
+
+        , listen: function () {
+            this.$element
+                .on('blur',     $.proxy(this.blur, this))
+                .on('keypress', $.proxy(this.keypress, this))
+                .on('keyup',    $.proxy(this.keyup, this))
+
+            if (this.eventSupported('keydown')) {
+                this.$element.on('keydown', $.proxy(this.keydown, this))
+            }
+
+            this.$menu
+                .on('click', $.proxy(this.click, this))
+                .on('mouseenter', 'li', $.proxy(this.mouseenter, this))
+
+        }
+
+        , eventSupported: function(eventName) {
+            var isSupported = eventName in this.$element
+            if (!isSupported) {
+                this.$element.setAttribute(eventName, 'return;')
+                isSupported = typeof this.$element[eventName] === 'function'
+            }
+            return isSupported
+        }
+
+        , move: function (e) {
+            if (!this.shown) return
+
+            switch(e.keyCode) {
+                case 9: // tab
+                case 13: // enter
+                case 27: // escape
+                    e.preventDefault()
+                    break
+
+                case 38: // up arrow
+                    e.preventDefault()
+                    this.prev()
+                    break
+
+                case 40: // down arrow
+                    e.preventDefault()
+                    this.next()
+                    break
+            }
+
+            e.stopPropagation()
+        }
+
+        , keydown: function (e) {
+            this.suppressKeyPressRepeat = ~$.inArray(e.keyCode, [40,38,9,13,27])
+            this.move(e)
+        }
+
+        , keypress: function (e) {
+            if (this.suppressKeyPressRepeat) return
+            this.move(e)
+        }
+
+        , keyup: function (e) {
+            switch(e.keyCode) {
+                case 40: // down arrow
+                case 38: // up arrow
+                case 37: // left arrow
+                case 39: // right arrow
+                case 16: // shift
+                case 17: // ctrl
+                case 18: // alt
+                    break
+
+                case 9: // tab
+                case 13: // enter
+                    if (!this.shown) return
+                    this.select()
+                    break
+
+                case 27: // escape
+                    if (!this.shown) return
+                    this.hide()
+                    break
+
+                default:
+                    this.resetTimeout()
+            }
+
+            e.stopPropagation()
+            e.preventDefault()
+        }
+
+        , blur: function (e) {
+            var that = this
+            setTimeout(function () { that.hide() }, 150)
+        }
+
+        , click: function (e) {
+            e.stopPropagation()
+            e.preventDefault()
+            this.select()
+        }
+
+        , mouseenter: function (e) {
+            this.$menu.find('.active').removeClass('active')
+            $(e.currentTarget).addClass('active')
+        }
+
+    }
+
+    /* FINDAHEAD PLUGIN DEFINITION
+     * =========================== */
+
+    var old = $.fn.findahead
+
+    $.fn.findahead = function (option) {
+        return this.each(function () {
+            var $this = $(this)
+                , data = $this.data('findahead')
+                , options = typeof option == 'object' && option
+            if (!data) $this.data('findahead', (data = new Findahead(this, options)))
+            if (typeof option == 'string') data[option]()
+        })
+    }
+
+    $.fn.findahead.defaults = {
+        source: []
+        , items: 8
+        , menu: '<ul class="dropdown-menu"></ul>'
+        , item: '<li><a href="#"></a></li>'
+        , minLength: 1
+        , timer: 0
+        , visualLoading: true
+    }
+
+    $.fn.findahead.Constructor = Findahead
+
+
+    /* FINDAHEAD NO CONFLICT
+     * =================== */
+
+    $.fn.findahead.noConflict = function () {
+        $.fn.findahead = old
+        return this
+    }
+
+    /* FINDAHEAD DATA-API
+     * ================== */
+
+    $(document).on('focus.findahead.data-api', '[data-provide="findahead"]', function (e) {
+        var $this = $(this)
+        if ($this.data('findahead')) return
+        e.preventDefault()
+        $this.findahead($this.data())
+    })
+
+}(window.jQuery);

data/vendor/assets/stylesheets/bootstrap-findahead.css

@@ -0,0 +1,13 @@
+.findahead {
+  position: relative;
+  height: 30px;
+}
+
+.findahead .loading {
+    position: absolute;
+    top: 4px;
+    right: 15px;
+    width: 22px;
+    height: 22px;
+    background: url(loading.gif);
+}

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: bootstrap-findahead-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pierrick Rouxel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A search component for Twitter Bootstrap
+email:
+- pierrick.rouxel@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bootstrap-findahead-rails.gemspec
+- lib/bootstrap/findahead/rails.rb
+- lib/bootstrap/findahead/rails/version.rb
+- vendor/assets/images/loading.gif
+- vendor/assets/javascripts/bootstrap-findahead.js
+- vendor/assets/stylesheets/bootstrap-findahead.css
+homepage: https://github.com/pierrickrouxel/bootstrap-findahead-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A search component for Twitter Bootstrap
+test_files: []