autocomplete_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3705d9900a36155396f2cda10e3d54db913e0e1d
+  data.tar.gz: 1ac76f990acb239985ab9c0f9f4a2aee1f761046
+SHA512:
+  metadata.gz: 8e4924deed44b2137c982b28d4a37a141ea513594279f9fe80d4f714ab8d5787ef6fde4d78072658a02147d8178e21d32404ccf475f84d74086df430b70fc98d
+  data.tar.gz: 7e3ef03657f129966b61399be51f3483b0916fb8c4f2a664e57b30cc467a76987cf55977d404f2fc06aa0d28143c86b837a1c9466310f08d28b9e79d964e805d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Justin Tomich
+
+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/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AutocompleteRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/autocomplete_rails.rb

@@ -0,0 +1,8 @@
+require 'autocomplete_rails/engine'
+require 'autocomplete_rails/controller'
+
+# Top level module of autocomplete_rails,
+module AutocompleteRails
+end
+
+ActionController::Base.send(:include, AutocompleteRails::Controller)

data/lib/autocomplete_rails/controller.rb

@@ -0,0 +1,132 @@
+module AutocompleteRails
+  module Controller
+    def self.included(target)
+      target.extend AutocompleteRails::Controller::ClassMethods
+    end
+
+    module ClassMethods
+      #
+      # Generate an autocomplete controller action.
+      #
+      # The controller action is intended to interact with jquery UI's autocomplete widget. The autocomplete
+      # controller provides suggestions while you type into a field that is provisioned with JQuery's autocomplete
+      # widget.
+      #
+      # The generated method is named  "autocomplete_#{model_symbol}_#{value_method}", for example:
+      #
+      #   class UsersController
+      #     autocomplete :user, :email
+      #   end
+      #
+      # generates a method named `autocomplete_user_email`.
+      #
+      #
+      # Parameters:
+      # * model_symbol - model class to autocomplete, e.g.
+      # * value_method - method on model to autocomplete. This supplies the 'value' field in results.
+      #                  Also used as the label unless you supply options[:label_method].
+      # * options - hash of optional settings.
+      #
+      #
+      # Options accepts a hash of:
+      # * :label_method - call a separate method for the label, otherwise defaults to value_method. If your label
+      #                   method is a method that is *not* a column in your DB, you may need options[:full_model].
+      # * :full_model - load full model instead of only selecting the specified values. Default is false.
+      # * :limit - default is 10.
+      # * :case_sensitive - if true, the search is case sensitive. Default is false.
+      # * :additional_data - collect additional data. Will be added to select unless full_model is invoked.
+      # * :full_search - search the entire value string for the term. Defaults to false, in which case the value
+      #                  field being searched (see value_method above) must start with the search term.
+      # * :scopes - limit query to these ActiveRecord scopes, passed in as an array,
+      #             for example: `scopes: [:scope1, :scope2]`
+      #
+      # Be sure to add a route to reach the generated controller method. Example:
+      #
+      #   resources :users do
+      #     get :autocomplete_user_email, on: :collection
+      #   end
+      #
+      # The following example searches for users by email, but displays their :full_name as the label.
+      # The full_model flag is also loaded, as full_name is a method that synthesizes multiple columns.
+      #
+      #   class UsersController
+      #     autocomplete :user, :email, label_method: full_name, full_model: true
+      #   end
+      #
+      def autocomplete(model_symbol, value_method, options = {})
+        label_method = options[:label_method] || value_method
+        model = model_symbol.to_s.camelize.constantize
+        autocomplete_method_name = "autocomplete_#{model_symbol}_#{value_method}"
+
+        define_method(autocomplete_method_name) do
+          results = autocomplete_results(model, value_method, label_method, options)
+          render json: autocomplete_build_json(results, value_method, label_method, options), root: false
+        end
+      end
+    end
+
+    protected
+
+    def autocomplete_results(model, value_method, label_method = nil, options)
+      term = params[:term]
+      return {} if term.blank?
+
+      results = model.where(nil) # make an empty scope to add select, where, etc, to.
+      scopes  = Array(options[:scopes])
+      scopes.each { |scope| results = results.send(scope) } unless scopes.empty?
+      results = results.select(autocomplete_select_clause(model, value_method, label_method, options)) unless
+        options[:full_model]
+      results.
+        where(autocomplete_where_clause(term, model, value_method, options)).
+        limit(autocomplete_limit_clause(options)).
+        order(autocomplete_order_clause(model, value_method, options))
+    end
+
+    def autocomplete_select_clause(model, value_method, label_method, options)
+      table_name = model.table_name
+      selects = []
+      selects << "#{table_name}.#{model.primary_key}"
+      selects << "#{table_name}.#{value_method}"
+      selects << "#{table_name}.#{label_method}" if label_method
+      options[:additional_data].each { |datum| selects << "#{table_name}.#{datum}" } if options[:additional_data]
+      selects
+    end
+
+    def autocomplete_where_clause(term, model, value_method, options)
+      term = term.gsub(/[_%]/) { |x| "\\#{x}" } # escape any _'s or %'s in the search term
+      term = "#{term}%"
+      term = "%#{term}" if options[:full_search]
+      table_name = model.table_name
+      lower = options[:case_sensitive] ? '' : 'LOWER'
+      ["#{lower}(#{table_name}.#{value_method}) LIKE #{lower}(?) ESCAPE \"\\\"", term]
+    end
+
+    def autocomplete_limit_clause(options)
+      options[:limit] ||= 10
+    end
+
+    def autocomplete_order_clause(model, value_method, options)
+      return options[:order] if options[:order]
+
+      # default to ASC order
+      table_prefix = "#{model.table_name}."
+      "LOWER(#{table_prefix}#{value_method}) ASC"
+    end
+
+    def autocomplete_build_json(results, value_method, label_method, options)
+      results.collect do |result|
+        data = HashWithIndifferentAccess.new(id: result.id,
+                                             label: result.send(label_method),
+                                             value: result.send(value_method))
+        options[:additional_data].each do |method|
+          data[method] = result.send(method)
+        end if options[:additional_data]
+        data
+      end
+    end
+
+    def postgres?(model_class)
+      model_class.connection.class.to_s.match /Postgre/
+    end
+  end
+end

data/lib/autocomplete_rails/engine.rb

@@ -0,0 +1,11 @@
+require 'autocomplete_rails/controller'
+
+module AutocompleteRails
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+  end
+end
+

data/lib/autocomplete_rails/version.rb

@@ -0,0 +1,3 @@
+module AutocompleteRails
+  VERSION = "0.1.0"
+end

data/lib/tasks/autocomplete_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :autocomplete_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: autocomplete_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Tomich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Easily use jQuery UI's autocomplete widget with Rails applications.
+email:
+- justin@tomich.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- config/routes.rb
+- lib/autocomplete_rails.rb
+- lib/autocomplete_rails/controller.rb
+- lib/autocomplete_rails/engine.rb
+- lib/autocomplete_rails/version.rb
+- lib/tasks/autocomplete_rails_tasks.rake
+homepage: https://github.com/tomichj/autocomplete_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.5.1
+signing_key: 
+specification_version: 4
+summary: Easily use jQuery UI's autocomplete widget with Rails applications.
+test_files: []