quick-search 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c85c4ec9923d45730874abd5486c67ee2728c8f5
+  data.tar.gz: d9595451eee2afb8452c3d007f1174e48954d982
+SHA512:
+  metadata.gz: 849acbebb9459e92596fd8db44066a1f6e45c88a2a44dbc6a1a50c759d74a6a155653cd99729d8b7aa3b59652b13c63ea98354dd49db8c78d820fd6aff65375d
+  data.tar.gz: 690a11fadc716191ee7960d2241b883590ad6c3cab504050cc0d27537f4b162b0e9a167d70a448eeda87fb4812d68df021fb23b73cc928fb0fed23bf0364294a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quick-search.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Elementar Sistemas
+
+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,29 @@
+# QuickSearch
+
+A quick search concern for ActiveRecord and Mongoid models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'quick-search'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quick-search
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/elementar/quick-search/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/Rakefile

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

data/lib/quick-search.rb

@@ -0,0 +1,2 @@
+require 'quick-search/version'
+require 'quick-search/search'

data/lib/quick-search/adapters/active_record_adapter.rb

@@ -0,0 +1,48 @@
+module QuickSearch
+  module Adapters
+    class ActiveRecordAdapter
+      def initialize(cls)
+        @cls = cls
+      end
+
+      def make_clauses_for_token(s, token, fields)
+        s = s.joins calculate_needed_joins(fields)
+        s = s.where build_parameterized_condition(fields, :s),
+                    s: "%#{token}%"
+        s
+      end
+
+      def default_quick_search_fields
+        @cls.columns.select { |c| c.type == :string }.map(&:name)
+      end
+
+      private
+
+      def calculate_needed_joins(a, stack = [], &block)
+        case a
+          when Hash
+            a.map { |k, v| calculate_needed_joins(v, stack + [k], &block) }.compact
+          when Array
+            a.map { |v| calculate_needed_joins(v, stack, &block) }.compact
+          when String, Symbol
+            stack.reverse.reduce(nil) { |h, v| h && { v => h } || v }
+          else
+            raise "Unrecognized input: #{a.inspect} (#{a.class.name})"
+        end
+      end
+
+      def build_parameterized_condition(f, n, cls = @cls)
+        case f
+          when Hash
+            f.map { |k, v| build_parameterized_condition(v, n, cls.reflect_on_association(k).klass) } * ' or '
+          when Array
+            f.map { |ff| build_parameterized_condition(ff, n, cls) } * ' or '
+          when String, Symbol
+            "`#{cls.table_name}`.`#{f}` like :#{n}"
+          else
+            raise "Unrecognized input: #{f.inspect} (#{f.class.name})"
+        end
+      end
+    end
+  end
+end

data/lib/quick-search/adapters/mongoid_adapter.rb

@@ -0,0 +1,31 @@
+module QuickSearch
+  module Adapters
+    class MongoidAdapter
+      def initialize(cls)
+        @cls = cls
+      end
+
+      def make_clauses_for_token(s, token, fields)
+        s.and '$or' => fields.map { |f| { to_field_name(f) => /#{Regexp.escape token}/i } }
+      end
+
+      def default_quick_search_fields
+        @cls.fields.select { |_, f| f.type == String }.map(&:first)
+      end
+
+      private
+
+      def to_field_name(f)
+        case f
+          when Hash
+            head = f.first
+            "#{head.first}.#{to_field_name(head.last)}"
+          when String, Symbol
+            f
+          else
+            raise "Unrecognized input: #{f}"
+        end
+      end
+    end
+  end
+end

data/lib/quick-search/search.rb

@@ -0,0 +1,79 @@
+module QuickSearch
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    # Defines the fields that will be available to the quick search.
+    # If a hash is used on ActiveRecord, an +inner join+ will be made.
+    def quick_search_fields(*fields)
+      @quick_search_fields = fields
+    end
+
+    # Adds an expression to the quick search. Several expressions can be added, but only the first one
+    # that matches the search token will be ran.
+    # @param [Regexp] rx A regular expression, in which to test the quick search tokens.
+    # @param [Proc] proc The proc to run when the token matches. It will receive the +MatchData+ as parameter.
+    def quick_search_expression(rx, proc)
+      (@quick_search_expressions ||= {})[rx] = proc
+    end
+
+    # Performs a quick search. Returns the used tokens in the second parameter.
+    def quick_search(search, tokens_array = [])
+      adapter # fail fast, if the adapter can not be created
+
+      relation = all
+      (search || '').split(/\s+/).each do |token|
+        next unless token.present?
+
+        if exprs = eval_expressions(relation, token)
+          relation = exprs
+          next
+        end
+
+        @quick_search_fields ||= adapter.default_quick_search_fields
+        tokens_array << token
+
+        relation = adapter.make_clauses_for_token(relation, token, @quick_search_fields)
+      end
+      relation
+    end
+
+    private
+
+    def adapter
+      @adapter ||= begin
+        if defined?(ActiveRecord) && defined?(ActiveRecord::Base) && self < ActiveRecord::Base
+          require 'quick-search/adapters/active_record_adapter'
+          Adapters::ActiveRecordAdapter.new(self)
+        elsif defined?(Mongoid) && defined?(Mongoid::Document) && self < Mongoid::Document
+          require 'quick-search/adapters/mongoid_adapter'
+          Adapters::MongoidAdapter.new(self)
+        else
+          raise UnsupportedAdapter.new self.name
+        end
+      end
+    end
+
+    # Evaluates the expressions defined by #quick_search_expression.
+    # @return [Object] the new query, or +nil+ if there's no expression matching the token.
+    def eval_expressions(s, token)
+      return nil if @quick_search_expressions.blank?
+      @quick_search_expressions.each do |rx, proc|
+        if m = (/\A(?:#{rx})\z/.match(token))
+          s = s.instance_exec(m, &proc)
+          return s
+        end
+      end
+      nil
+    end
+  end
+
+  class UnsupportedAdapter < RuntimeError
+    DEFAULT_MESSAGE = 'QuickSearch could not find an adapter for your class: %s'
+
+    def initialize(cls, *args)
+      super(sprintf(DEFAULT_MESSAGE, cls), *args)
+    end
+  end
+end

data/lib/quick-search/version.rb

@@ -0,0 +1,5 @@
+module Quick
+  module Search
+    VERSION = '0.0.1'
+  end
+end

data/quick-search.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quick-search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'quick-search'
+  spec.version       = Quick::Search::VERSION
+  spec.authors       = ['Fábio D. Batista']
+  spec.email         = ['fabio.david.batista@gmail.com']
+  spec.summary       = %q{A quick search concern for ActiveRecord and Mongoid models}
+  spec.description   = %q{This gem was extracted from Elementar projects.}
+  spec.homepage      = 'https://github.com/elementar/quick-search'
+  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_development_dependency 'bundler', '< 2.0'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+
+  spec.add_development_dependency 'activerecord', '~> 4.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+
+  spec.add_development_dependency 'mongoid', '~> 4.0'
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,16 @@
+require 'models/active_record_test_models'
+
+module ActiveRecordTestModels
+  RSpec.describe 'when using the ActiveRecord adapter' do
+    it 'should perform simple searches' do
+      expect(SimpleUser.quick_search('john')).not_to be_empty
+      expect(SimpleUser.quick_search('waldi')).to be_empty
+    end
+    it 'should perform joined searches' do
+      expect(UserConfiguredWithJoins.quick_search('waldi')).not_to be_empty
+    end
+    it 'joined searches should not return duplicates', :pending do
+      expect(UserConfiguredWithJoins.quick_search('a').size).to eq 1
+    end
+  end
+end

data/spec/models/active_record_test_models.rb

@@ -0,0 +1,45 @@
+require 'active_record'
+require 'quick-search'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, force: true do |t|
+    t.string :name
+    t.integer :age
+    t.timestamps
+  end
+
+  create_table :pets, force: true do |t|
+    t.references :user
+    t.string :name
+    t.integer :age
+    t.timestamps
+  end
+end
+
+module ActiveRecordTestModels
+  class SimpleUser < ActiveRecord::Base
+    self.table_name = 'users'
+    include QuickSearch
+
+    has_many :pets, foreign_key: 'user_id'
+  end
+
+  class UserConfiguredWithJoins < ActiveRecord::Base
+    self.table_name = 'users'
+    include QuickSearch
+
+    quick_search_fields :name, pets: :name
+
+    has_many :pets, foreign_key: 'user_id'
+  end
+
+  class Pet < ActiveRecord::Base
+  end
+
+  SimpleUser.create! name: 'John' do |u|
+    u.pets.build [{ name: 'Schatzi', age: 3 }, { name: 'Blume', age: 2 }, { name: 'Waldi', age: 1 }]
+  end
+end

data/spec/models/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      hosts:
+        - localhost
+      database: quick-search-tests

data/spec/models/mongoid_test_models.rb

@@ -0,0 +1,59 @@
+require 'mongoid'
+require 'quick-search'
+
+module MongoidTestModels
+  class SimpleUser
+    include Mongoid::Document
+    include QuickSearch
+
+    embeds_many :pets, class_name: 'MongoidTestModels::SimplePet'
+
+    field :name, type: String
+    field :age, type: Integer
+  end
+
+  class SimplePet
+    include Mongoid::Document
+
+    embedded_in :simple_user
+
+    field :name, type: String
+    field :age, type: Integer
+  end
+
+  class UserConfiguredForSubdocument
+    include Mongoid::Document
+    include QuickSearch
+
+    embeds_many :pets, class_name: 'MongoidTestModels::PetConfiguredForSubdocument'
+
+    field :name, type: String
+    field :age, type: Integer
+
+    quick_search_fields :name, pets: :name
+  end
+
+  class PetConfiguredForSubdocument
+    include Mongoid::Document
+
+    embedded_in :user_configured_for_subdocument
+
+    field :name, type: String
+    field :age, type: Integer
+  end
+
+  Mongoid.load! 'spec/models/mongoid.yml', :test
+  Mongoid::Config.purge!
+
+  SimpleUser.create! name: 'John' do |u|
+    u.pets.build name: 'Schatzi', age: 3
+    u.pets.build name: 'Blume', age: 2
+    u.pets.build name: 'Waldi', age: 1
+  end
+
+  UserConfiguredForSubdocument.create! name: 'John' do |u|
+    u.pets.build name: 'Schatzi', age: 3
+    u.pets.build name: 'Blume', age: 2
+    u.pets.build name: 'Waldi', age: 1
+  end
+end

data/spec/mongoid_spec.rb

@@ -0,0 +1,16 @@
+require 'models/mongoid_test_models'
+
+module MongoidTestModels
+  RSpec.describe 'when using the Mongoid adapter' do
+    it 'should perform simple searches' do
+      expect(SimpleUser.quick_search('john')).not_to be_empty
+      expect(SimpleUser.quick_search('waldi')).to be_empty
+    end
+    it 'should perform searches on subdocuments' do
+      expect(UserConfiguredForSubdocument.quick_search('waldi')).not_to be_empty
+    end
+    it 'searches on subdocuments should not return duplicates (duh)' do
+      expect(UserConfiguredForSubdocument.quick_search('a').size).to eq 1
+    end
+  end
+end

data/spec/none_spec.rb

@@ -0,0 +1,15 @@
+require 'quick-search'
+
+RSpec.describe 'the method is called on an unsupported record class' do
+  class PlainModel
+    include QuickSearch
+  end
+
+  subject { PlainModel }
+
+  it 'should raise an exception' do
+    expect {
+      subject.quick_search 'the quick brown fox'
+    }.to raise_error QuickSearch::UnsupportedAdapter, /could not find an adapter for your class: PlainModel/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: quick-search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fábio D. Batista
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: This gem was extracted from Elementar projects.
+email:
+- fabio.david.batista@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/quick-search.rb
+- lib/quick-search/adapters/active_record_adapter.rb
+- lib/quick-search/adapters/mongoid_adapter.rb
+- lib/quick-search/search.rb
+- lib/quick-search/version.rb
+- quick-search.gemspec
+- spec/active_record_spec.rb
+- spec/both_spec.rb
+- spec/models/active_record_test_models.rb
+- spec/models/mongoid.yml
+- spec/models/mongoid_test_models.rb
+- spec/mongoid_spec.rb
+- spec/none_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/elementar/quick-search
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A quick search concern for ActiveRecord and Mongoid models
+test_files:
+- spec/active_record_spec.rb
+- spec/both_spec.rb
+- spec/models/active_record_test_models.rb
+- spec/models/mongoid.yml
+- spec/models/mongoid_test_models.rb
+- spec/mongoid_spec.rb
+- spec/none_spec.rb
+- spec/spec_helper.rb