searchable_models 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9e62955eaa1d05c716d44e22d3193ae0cc6777c
+  data.tar.gz: 753ea3a32ef65111c5830758af5019951dd6af44
+SHA512:
+  metadata.gz: 66acdb4ecaf008930a5e870afd20e275daba8e6f34f141c6ff9ccdbf66f303a592ddd6d845a68e372cc6888cfb72803fa01fdce4303df62d930e80bf5d90cccb
+  data.tar.gz: e5c168949a068fbfa843e8d0546225271f725753502c38d19b3f703eebf2af3fbc97203b855cfd3cd6dcc85cb4b410e1dbefe52b894aa9e876e8e6cd911b9627

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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.md

@@ -0,0 +1,212 @@
+# SearchableModels
+
+SearchableModels provide a `search` scope on ActiveRecord models.
+
+This idea is to describe which fields are searchable and the gem will do the rest. You just need to call the  `#search` method and you're set.
+
+## Compatibility
+
+SearchableModels has been tested and used with:
+* ruby 2
+* rails 4.1
+
+Other versions may or may not work.
+
+## Installation
+
+To use it, add it to your Gemfile:
+
+```ruby
+gem 'searchable_models', '~> 0.1'
+```
+
+and bundle:
+
+```shell
+bundle
+```
+
+## Usage
+
+You just need to use the `search_on` function in your models and the scope `search` will be available on your model.
+
+There are different types of search. See below for the details.
+
+### Simple search
+This is the simplest search you could do. It will search for an exact match.
+
+```ruby
+class Car < ActiveRecord::Base
+  search_on :name
+  search_on :number_of_doors
+end
+```
+
+We can then search `Car`s with:
+```ruby
+Car.search(:name => "Ferrari")
+Car.search(:number_of_doors => 3)
+Car.search(:name => "Porsche", :number_of_doors => 4)
+```
+
+This search will join all the conditions with an AND. It will use an exact match. This search can be done on any type of field: strings, integer and others.
+
+### Fuzzy search
+This search is similar to the simple search but will use a fuzzy operator instead of an exact match. This *must* used on string fields.
+
+```ruby
+class Car < ActiveRecord::Base
+  search_on :name, :mode => :fuzzy
+end
+```
+
+```ruby
+Car.search(:name => "rari")
+Car.search(:name => "rsche")
+```
+
+Note that the search is case insensitive.
+
+### Grouped search
+Sometimes we want to use the same input parameter for several fields. For this, we can group the search.
+
+```ruby
+class Car < ActiveRecord::Base
+  search_on :name, :mode => :fuzzy, :param => :query
+  search_on :model, :param => :query
+end
+```
+
+```ruby
+Car.search(:query => "rari")
+Car.search(:query => "Dodge")
+```
+
+You can group a simple and a fuzzy search together.
+
+### Rename input parameter
+The `param` option can also be used to rename the input parameter. Let's you want to map the parameter `car_name` to the column `name`:
+
+```ruby
+class Car < ActiveRecord::Base
+  search_on :name, :mode => :fuzzy, :param => :car_name
+end
+```
+
+```ruby
+Car.search(:car_name => "rari")
+```
+
+This feature can be used with any type of search.
+
+### Reference search
+You can search on a `belongs_to` reference column.
+
+```ruby
+class Car < ActiveRecord::Base
+  belongs_to :fleet
+  search_on :fleet_id
+end
+```
+
+```ruby
+Car.search(:fleet_id)
+```
+
+### Search on associated table
+You can search on a column of an associated table
+
+```ruby
+class Car < ActiveRecord::Base
+  has_many :components
+  search_on :provider_name, :mode => :fuzzy, :through => :components
+end
+```
+
+```ruby
+Car.search(:provider_name => "Toshi")
+```
+
+The `through` option is not limited to one table, you can nest as many as tables you may need
+
+```ruby
+class Car < ActiveRecord::Base
+  has_one :engine
+  search_on :provider_name, :mode => :fuzzy, :through => { :engine => :components }
+end
+```
+
+### Scope search
+You may want to use a custom scope in your search.
+
+```ruby
+class Car < ActiveRecord::Base
+  scope :imported_on, ->(date) { where(:import_date => date) }
+
+  search_on :import_date, :mode => :scope, :scope => :imported_on
+end
+```
+
+```ruby
+Car.search(:import_date => "1990-10-10")
+```
+
+This feature is limited to scopes with only one parameter.
+
+### Enum search
+You can search using a field declared as a Rails 4 enum.
+
+```ruby
+class Car < ActiveRecord::Base
+  enum :kind => %i(van sedan family)
+  search_on :kind, :mode => :enum
+end
+```
+
+```ruby
+Car.search(:kind => "van")
+```
+
+### `acts-as-taggable-on` support
+If your model is tagged with [acts-as-taggable-on](https://github.com/mbleigh/acts-as-taggable-on), you can create a search on the tags. By default, all the tags conditions are merged using *AND* but you can specify an *OR* merge if you want.
+
+
+```ruby
+class Car < ActiveRecord::Base
+  acts_as_taggable
+  search_on :tags
+end
+```
+
+```ruby
+Car.search(:tags => [:blue, :old])
+Car.search(:tags => [:blue, :yellow, :red], :tags_combination => :or)
+```
+
+### `globalize` support
+If your model is translated using [https://github.com/globalize/globalize](Globalize), you can create a search on the translated fields.
+
+```ruby
+class Car < ActiveRecord::Base
+  translates :commercial_name
+  search_on :commercial_name, :mode => :fuzzy
+end
+```
+
+```ruby
+Car.search(:commercial_name => "van")
+```
+
+You can use an exact or a fuzzy search on translated fields
+
+## 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
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'SearchableModels'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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/lib/searchable_models/searchable.rb

@@ -0,0 +1,135 @@
+module SearchableModels
+  module Searchable
+    extend ActiveSupport::Concern
+
+    included do
+      mattr_accessor :search_fields, :instance_accessor => false do
+        {}
+      end
+
+      mattr_accessor :search_order, :instance_accessor => false do
+        :id
+      end
+
+      define_singleton_method(:search) do |params|
+        results = all
+
+        fields = search_fields.select do |_, v|
+          v.try(:exclude?, :mode) \
+            || %i(exact scope enum).include?(v.try(:[], :mode))
+        end
+        results = _search(results, fields, params)
+
+        fields = search_fields.select { |_, v| v.try(:[], :mode) == :fuzzy }
+        results = _fuzzy_search(results, fields, params)
+
+        results.uniq.order(search_order)
+      end
+    end
+
+    module ClassMethods
+      def search_on(*args)
+        self.search_fields.merge!(args.first => args.extract_options!)
+      end
+
+      def search_ordered_by(field)
+        self.search_order = field
+      end
+
+      private
+
+      ## private search util functions, not part of the public API
+      def _search(results, fields, params)
+        fields.each do |field, options|
+          next unless (value = params[options[:param] || field])
+          results = case
+                    when field == :tags
+                      _tags_search(results, value, params[:tags_combination])
+                    when field =~ /_id(?:s)?$/ && options[:through]
+                      _association_ids_search(results, field, value, options[:through])
+                    when options[:mode] == :scope && options[:scope]
+                      _search_with_scope(results, value, options[:scope])
+                    when options[:mode] == :enum
+                      _search_with_enum(results, field, value)
+                    else
+                      _simple_search(results, field, value)
+                    end
+        end
+        results
+      end
+
+      def _fuzzy_search(results, fields, params)
+        searchable_fields = {}
+        fields.each do |field, options|
+          _check_type_for_fuzzy_search(field)
+          param_key = options[:param] || field
+          searchable_fields[param_key] ||= []
+          searchable_fields[param_key] << field
+        end
+
+        searchable_fields.each do |param_key, columns|
+          next unless params[param_key]
+          where_string = ""
+          columns.each do |column|
+            where_string << " OR " unless where_string.blank?
+            table = table_name
+            if try(:translated?, column)
+              table = translation_options[:table_name]
+              results = results.joins(:translations)
+            end
+            where_string << "LOWER(#{table}.#{column}) like :value"
+          end
+          condition = { :value => "%#{params[param_key].to_s.downcase}%" }
+          results = results.where("(#{where_string})", condition)
+        end
+        results
+      end
+
+      def _tags_search(results, value, tags_combination = "AND")
+        return results unless value.try(:any?)
+        case tags_combination
+        when :or
+          results.tagged_with(value, :any => true)
+        else
+          results.tagged_with(value)
+        end
+      end
+
+      def _search_with_scope(results, value, scope)
+        results.send(scope, value)
+      end
+
+      def _search_with_enum(results, field, value)
+        results.where(field => send(field.to_s.pluralize).try(:[], value))
+      end
+
+      def _simple_search(results, field, value)
+        results.where(field => value)
+      end
+
+      def _association_ids_search(results, field, value, through)
+        return results unless through
+        table = _get_last_value(through).to_s.pluralize
+        results.joins(through).where(table => { field => value })
+      end
+
+      def _get_last_value(object)
+        return _get_last_value(object.first.last) if object.is_a?(Hash)
+        object
+      end
+
+      def _through_association_ids_search(results, field, value, through)
+        return results unless through
+        results.joins(through).where(through => { field => value })
+      end
+
+      def _check_type_for_fuzzy_search(field)
+        return if try(:translated?, field) \
+          || columns_hash[field.to_s].try(:type) == :string
+        fail(ArgumentError, "#{field} must of type string to run a fuzzy search")
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, SearchableModels::Searchable)

data/lib/searchable_models/version.rb

@@ -0,0 +1,3 @@
+module SearchableModels
+  VERSION = "0.0.1"
+end

data/lib/searchable_models.rb

@@ -0,0 +1,8 @@
+Gem.loaded_specs["searchable_models"].dependencies.select { |d| d.type == :runtime }.each do |d|
+  require d.name
+end
+
+require "searchable_models/searchable"
+
+module SearchableModels
+end

data/lib/tasks/searchable_models_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/car.rb

@@ -0,0 +1,41 @@
+class Car < ActiveRecord::Base
+  # fuzzy search on one field
+  search_on :brand, :mode => :fuzzy
+
+  # fuzzy search on one field with named parameter
+  search_on :model, :mode => :fuzzy, :param => :m
+
+  # fuzzy search on multiple fields with named parameter
+  search_on :name, :mode => :fuzzy, :param => :query
+  search_on :description, :mode => :fuzzy, :param => :query
+
+  # exact search on one field
+  search_on :number_of_doors
+
+  # search on belong_to ids
+  belongs_to :group
+  search_on :group_id
+
+  # search with through
+  has_many :doors
+  search_on :component_id, :through => :doors
+
+  # search with deep through
+  search_on :provider_id, :through => { :doors => :component }
+
+  # search with scope
+  scope :imported_on, ->(date) { where(:import_date => date) }
+  search_on :import_date, :mode => :scope, :scope => :imported_on
+
+  # search on enums
+  enum :kind => %i(van sedan family)
+  search_on :kind, :mode => :enum, :param => :type_of_car
+
+  # search on tags (support for acts-as-taggable-on)
+  acts_as_taggable
+  search_on :tags
+
+  # search on i18n fields (support for globalize)
+  translates :commercial_name
+  search_on :commercial_name, :mode => :fuzzy
+end

data/test/dummy/app/models/component.rb

@@ -0,0 +1,3 @@
+class Component < ActiveRecord::Base
+  belongs_to :provider
+end

data/test/dummy/app/models/door.rb

@@ -0,0 +1,4 @@
+class Door < ActiveRecord::Base
+  belongs_to :car
+  belongs_to :component
+end

data/test/dummy/app/models/group.rb

@@ -0,0 +1,2 @@
+class Group < ActiveRecord::Base
+end

data/test/dummy/app/models/provider.rb

@@ -0,0 +1,2 @@
+class Provider < ActiveRecord::Base
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "searchable_models"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!