auto_awesomplete 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a451644fbe3b7430bf0b31b5da7bc2931acd09e
+  data.tar.gz: 9640951e06b38440aebb576afdf8b86688ff4199
+SHA512:
+  metadata.gz: 141ad418efb226bd67f1e6f3bf25bca55b5a3e18520eb3b753e1ca5b261c882f80b4f746b42f5b33ea24aa4498e61a92b7d9447d1e2de2404a20b515c39c993f
+  data.tar.gz: 09aee7c6cc778faa8de0cf0cb12b2ebe6c7d93a973f9c3e7081d4a1d731527eac053e6a8cba3c13df89b54c294feacec6c1c86a68b84b10854b1c93882e6e2ea

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ivan Zabrovskiy
+
+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,139 @@
+# AutoAwesomplete
+
+Gem provide API (scripts, helpers, controller and base class for ajax-search)
+for initialize ajax awesomplete elements.
+
+The `AutoAwesomplete` based on [awesomplete](https://github.com/fishbullet/awesomplete) gem.
+
+[![Gem Version](https://badge.fury.io/rb/auto_awesomplete.png)](http://badge.fury.io/rb/auto_awesomplete)
+
+## Installation
+
+### First
+
+Install [awesomplete](https://github.com/fishbullet/awesomplete#getting-started)
+and include javascript and stylesheet assets.
+
+### Second
+
+Add this line to your application's Gemfile:
+
+    gem 'auto_awesomplete'
+
+And then execute:
+
+    $ bundle
+
+### Third
+
+Select one of ways to include js in pipeline. Ways described below in section `Javascript include variants`
+
+### Fourth
+
+Check controller and route collation. Gem contain controller `AutoAwesompletesController` and route
+
+    get 'auto_awesompletes/:class_name'
+
+### Fifth
+
+Prepare folder `app/awesomplete_search_adapters`. This folder needed for storage custom `SearchAdapter`.
+
+## Compatibility
+
+Gem tested and works in Rails 3.2 (with manual install awesomplete assets) and Rails 4.0.
+You can test compatibility with other versions by yourself.
+
+## Easiest way to use
+
+Use [AutoAwesomplete2Tag](https://github.com/Tab10id/auto_awesomplete_tag). It provide helper:
+
+* awesomplete_ajax_tag
+
+and you can define ajax awesomplete element like any other view elements in rails.
+
+## Example
+
+(stub)
+
+## Usage
+
+### Javascript include variants
+
+You have two ways to include javascript files. First: in gem presents helper method
+
+* ajax_awesomplete_init_script
+
+These helpers call `javascript_include_tag` and it is useful for initialize awesomplete
+scripts on a single page. Example of usage in a view:
+
+    - ajax_awesomplete_init_script
+    
+    = ajax_awesomplete_tag :my_select, my_options_for_awesomplete, class: 'small'
+
+Second variant: include files in javascript assets. For this add the
+following to your `app/assets/javascripts/application.js`:
+
+    //= require auto_awesomplete/ajax
+
+### Ajax awesomplete usage
+
+For initialize ajax awesomplete you must set `auto-ajax-awesomplete` css-class for input element.
+Then you have two ways. Easy way for simple selection: specify `default_class_name`, `default_text_column` and
+`default_id_column` as params for `:data-awesomplete-href`
+Other way for custom selection: create `SearchAdapter`. This adapter has following requirements:
+
+* class must be inherited from `AutoAwesomplete::SearchAdapter::Base`
+* file must be put in autoload folder (`app/awesomplete_search_adapter` for example)
+* name of a adapter class must end with `SearchAdapter`
+* must has function `search_default(term, page, options)`
+  (description of the function and return value goes below)
+
+Returned value of `search_default` function must return Array as json
+
+**TIP:** in `search_default` you can use functions from `AutoAwesomplete::SearchAdapter::Base`
+
+Finally input must has `:data-awesomplete-href` attribute. This
+parameter specify url for ajax load select options. You can use helper
+
+    auto_awesompletes_path(class_name: :my_class_name)
+or
+
+    auto_awesompletes_path(default_class_name: my_class,
+                               default_text_column: :name,
+                               default_id_column: :id)
+
+### Example of minimalistic SearchAdapter
+    class SystemRoleSearchAdapter < AutoAwesomplete::SearchAdapter::Base
+      class << self
+        def search_default(term, page, options)
+          roles = default_finder(SystemRole, term, page: page).pluck(:name).to_json
+        end
+      end
+    end
+
+### More about SearchAdapter
+
+`SearchAdapter` has some additional functions. First, you can define multiple search
+functions in one adapter. For example in adapter for User you want to find among all
+users, find users only in one department and so on. For this purpose define methods like
+
+    def search_unusual_case(term, page, options)
+      # must has same behavior as search_default
+    end
+
+near the `search_default` in `SearchAdapter`. Requirement for non-default search methods:
+
+* it must has same behavior as search_default
+* name of methods must start with `search_`
+
+For use custom searcher specify it into `:data-awesomplete-href` attribute:
+
+    auto_awesompletes_path(class_name: MyClassName, search_method: :unusual_case)
+
+## Contributing
+
+1. Fork it ( http://github.com/Tab10id/auto_awesomplete/fork )
+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

data/app/controllers/auto_awesompletes_controller.rb

@@ -0,0 +1,25 @@
+class AutoAwesompletesController < ApplicationController
+  def search
+    begin
+      if params[:class_name].present?
+        adapter = "::#{params[:class_name].camelize}SearchAdapter".constantize
+      elsif params[:default_class_name].present?
+        adapter = ::AutoAwesomplete::SearchAdapter::Default
+      else
+        render json: {error: "not enough search parameters'"}.to_json,
+               status: 500
+        return
+      end
+    rescue NameError
+      render json: {error: "not found search adapter for '#{params[:class_name]}'"}.to_json,
+             status: 500
+      return
+    end
+
+    term = params.delete(:term)
+    page = params.delete(:page)
+    search_method = params.delete(:search_method)
+
+    render json: adapter.search_from_autocomplete(term, page, search_method, params).to_json
+  end
+end

data/auto_awesomplete.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_awesomplete/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'auto_awesomplete'
+  spec.version       = AutoAwesomplete::VERSION
+  spec.authors       = ['Dmitry Lisichkin', 'Ivan Zabrovskiy']
+  spec.email         = %w(dima@sb42.ru lorowar@gmail.com)
+  spec.summary       = %q{Base methods for wrapping a Awesomplete and easy initialize it.}
+  spec.description   = <<-DESC
+    Gem provide scripts and helpers for initialize different awesomplete elements:
+    static and ajax. Moreover this gem is foundation for other gems.
+    For example for AutoAwesompleteTag.
+  DESC
+  spec.homepage      = 'https://github.com/Tab10id/auto_awesomplete'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'railties', '>= 3.1'
+  spec.add_dependency 'coffee-rails'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rails', '~> 3.2.12'
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'auto_awesompletes/(:class_name)', to: 'auto_awesompletes#search', as: 'auto_awesompletes'
+end

data/lib/auto_awesomplete.rb

@@ -0,0 +1,9 @@
+require 'auto_awesomplete/version'
+require 'auto_awesomplete/helpers'
+require 'auto_awesomplete/engine'
+
+module AutoAwesomplete
+  extend ActiveSupport::Autoload
+
+  autoload :SearchAdapter
+end

data/lib/auto_awesomplete/engine.rb

@@ -0,0 +1,9 @@
+module AutoAwesomplete
+  class Engine < ::Rails::Engine
+    # Get rails to add app, lib, vendor to load path
+
+    initializer :javascripts do |app|
+      app.config.assets.precompile << 'auto_awesomplete/ajax.js'
+    end
+  end
+end

data/lib/auto_awesomplete/helpers.rb

@@ -0,0 +1,3 @@
+require 'auto_awesomplete/helpers/rails_helper.rb'
+
+ActionView::Base.send :include, AutoAwesomplete::Helpers::RailsHelper

data/lib/auto_awesomplete/helpers/rails_helper.rb

@@ -0,0 +1,10 @@
+module AutoAwesomplete::Helpers
+  module RailsHelper
+    def ajax_awesomplete_init_script
+      unless @auto_awesomplete_ajax_script_included
+        @auto_awesomplete_ajax_script_included = true
+        javascript_include_tag('auto_awesomplete/ajax')
+      end
+    end
+  end
+end

data/lib/auto_awesomplete/search_adapter.rb

@@ -0,0 +1,8 @@
+module AutoAwesomplete
+  module SearchAdapter
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Default
+  end
+end

data/lib/auto_awesomplete/search_adapter/base.rb

@@ -0,0 +1,73 @@
+module AutoAwesomplete
+  module SearchAdapter
+    class Base
+      class << self
+        def limit
+          10
+        end
+
+        def search_from_autocomplete(term, page, search_method, options)
+          if search_method.nil?
+            search_default(term, page, options)
+          else
+            self.public_send("search_#{search_method}", term, page, options)
+          end
+        end
+
+      private
+
+        def default_finder(searched_class, term, options)
+          columns = options[:column].present? ? options[:column] : 'name'
+          conditions = default_search_conditions(term, options[:basic_conditions], columns)
+
+          if term.nil?
+            [ searched_class.where(options[:basic_conditions]) ]
+          else
+            result_limit = options[:limit] || limit
+            query = searched_class.where( conditions ).limit( result_limit ).order(columns)
+            query = query.select(options[:select]) if options[:select].present?
+            options[:uniq] ? query.uniq : query
+          end
+        end
+
+        def default_search_conditions(term, basic_conditions, columns)
+          term_filter = ''
+          conditions = []
+
+          unless columns.is_a?(Array)
+            columns = columns.split(/[\s,]+/)
+          end
+
+          unless term.nil?
+            words = term.split(' ')
+            words.each_with_index do |word, index|
+              term_filter += ' AND ' if index > 0
+
+              columns.each_with_index do |column, idx|
+                term_filter += ' OR ' if idx > 0
+                term_filter +=  "#{column} LIKE ?"
+                conditions << "%#{word}%"
+              end
+            end
+
+            term_filter = term_filter.empty? ? nil : "(#{term_filter})"
+            basic_conditions_part = basic_conditions.present? ? "(#{basic_conditions }) " : nil
+            conditions.unshift([term_filter, basic_conditions_part].compact.join(' AND '))
+          end
+        end
+
+        def get_awesomplete_label(item, label_method)
+          if label_method.present? && item.respond_to?(label_method)
+            item.public_send(label_method)
+          else
+            if item.respond_to?(:to_awesomplete)
+              item.to_awesomplete
+            else
+              item.to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auto_awesomplete/search_adapter/default.rb

@@ -0,0 +1,21 @@
+module AutoAwesomplete
+  module SearchAdapter
+    class Default < Base
+      class << self
+        def search_default(term, page, options)
+          begin
+            default_arel = options[:default_class_name].camelize.constantize
+          rescue NameError
+            return {error: "not found class '#{options[:default_class_name]}'"}.to_json
+          end
+
+          default_values = default_finder(default_arel, term, page: page, column: options[:default_text_column])
+          default_values.map do |default_value|
+            get_awesomplete_label(default_value, options[:label_method])
+          end.to_json
+        end
+      end
+    end
+  end
+end
+

data/lib/auto_awesomplete/version.rb

@@ -0,0 +1,3 @@
+module AutoAwesomplete
+  VERSION = '0.0.1'
+end

data/vendor/assets/javascripts/auto_awesomplete/ajax.js.coffee

@@ -0,0 +1,34 @@
+((autoAwesomplete, $) ->
+  autoAwesomplete.updateList = (awesomplete, path, term) ->
+    $.ajax({
+      url: path,
+      dataType: 'json',
+      data: { term: term }
+      ,
+      success: (data) ->
+        awesomplete.list = JSON.parse(data)
+        awesomplete.evaluate()
+        return
+    })
+
+    return
+
+  autoAwesomplete.ajaxInit = ->
+    $inputs = $(':not(.awesomplete) > input.auto-ajax-awesomplete')
+    $inputs.each ->
+      $input = $(this)
+      awesomplete = new Awesomplete(this)
+      $input.on 'input', ->
+        $textInput = $(this)
+        path = $textInput.data('awesomplete-href')
+        term = $textInput.val()
+        autoAwesomplete.updateList(awesomplete, path, term)
+        return
+      return
+    return
+  return
+) window.autoAwesomplete = window.autoAwesomplete or {}, jQuery
+
+jQuery ($) ->
+  autoAwesomplete.ajaxInit()
+  return

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: auto_awesomplete
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitry Lisichkin
+- Ivan Zabrovskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-28 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: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+description: |2
+      Gem provide scripts and helpers for initialize different awesomplete elements:
+      static and ajax. Moreover this gem is foundation for other gems.
+      For example for AutoAwesompleteTag.
+email:
+- dima@sb42.ru
+- lorowar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- app/controllers/auto_awesompletes_controller.rb
+- auto_awesomplete.gemspec
+- config/routes.rb
+- lib/auto_awesomplete.rb
+- lib/auto_awesomplete/engine.rb
+- lib/auto_awesomplete/helpers.rb
+- lib/auto_awesomplete/helpers/rails_helper.rb
+- lib/auto_awesomplete/search_adapter.rb
+- lib/auto_awesomplete/search_adapter/base.rb
+- lib/auto_awesomplete/search_adapter/default.rb
+- lib/auto_awesomplete/version.rb
+- vendor/assets/javascripts/auto_awesomplete/ajax.js.coffee
+homepage: https://github.com/Tab10id/auto_awesomplete
+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.2
+signing_key: 
+specification_version: 4
+summary: Base methods for wrapping a Awesomplete and easy initialize it.
+test_files: []
+has_rdoc: