searchtastic 0.5.0

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+*.rvmrc
+.bundle
+Gemfile.lock
+pkg/*
+coverage.data
+coverage/*
+.yardoc
+tmp
+vendor/bundle
+*.swp
+*.swo
+*.DS_Store
+.idea/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order rand

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+
+  RSpec::Core::RakeTask.new(:normal) do |t|
+    t.pattern ='spec/**/*_spec.rb'
+    t.rcov = false
+  end
+
+end
+
+desc "RSpec tests"
+task "spec" => "spec:normal"
+
+task "default" => "spec"

data/Readme.md

@@ -0,0 +1,67 @@
+# Searchtastic
+
+Searchtastic makes it possible to filter any collection of ActiveRecord models automatically based on any field,
+including associated fields not even on the model itself. It's kind of awesome.
+
+# Installation
+
+In Rails 3, add this to your Gemfile and run the `bundle` command.
+
+```ruby
+gem 'searchtastic'
+```
+
+# Basic Usage
+
+### 1. Set up Your Models
+
+Make a model searchable by providing an array of attributes to search on:
+
+```ruby
+class User < ActiveRecord::Base
+    attr_accessible :name, :bio
+    has_one :club, class_name: Organization
+    searchable_by %w(name bio club.name)
+end
+```
+
+### 2. Perform the Search
+
+Searching works anywhere, but normally you'll search from within a controller action:
+
+```ruby
+...
+def index
+    #@filter == "test"
+    @users = User.search(@filter)
+    ...
+end
+...
+```
+
+# To Do
+
+*   Search on Dates -- there's no good way to do this right now
+*   Search on combined fields, e.g. first_name + last_name
+*   Search on all accessible attributes shorthand
+
+# Contributors
+
+`searchtastic` is solely Pete Michaud's (me@petermichaud.com) fault, so blame him for everything.
+
+# License
+
+(The 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/lib/searchtastic.rb

@@ -0,0 +1,112 @@
+require 'searchtastic/version'
+
+# This module is automatically included in all ActiveRecords
+module Searchtastic
+  module ActiveRecord
+
+    # Array of fields upon which it's possible to search
+    def fields
+      @fields || []
+    end
+
+    # Sets the searchable fields for a given model
+    #   class User < ActiveRecord::Base
+    #     search_fields %w(name email bio)
+    #   end
+    #
+    def searchable_by *fields
+        self.fields = process_fields(fields)
+    end
+
+    # Called on an ActiveRelation containing the model
+    #
+    #   filter = "Pete"
+    #   @filtered_models = User.search(filter)
+    #
+    def search filter
+      if filter && self.fields.count
+        handle_joins(self.fields).where(build_filter(filter, self.fields))
+      else
+        scoped
+      end
+    end
+
+    # Callable on an instance or the call itself to detect whether .search() will have meaningful results
+    #
+    #     User.search(@filter) if User.is_searchable?
+    #
+    def is_searchable?
+      self.fields.count < 0
+    end
+
+    private
+
+    # Set fields -- private, see searchable_by
+    def fields=(value)
+      @fields = value
+    end
+
+    # Fields can be specified with or without the model table name, but internally all
+    # fields need to be qualified by table name for disambiguation
+    #
+    #     fields = %w(name email)
+    #     process_fields(fields) => %w(users.name users.email)
+    #
+    def process_fields(fields)
+        fields.map { |field| field.to_s.include?('.') ? field.to_s : "#{self.table_name}.#{field}" }
+    end
+
+    # Before adding the where clauses, we have to make sure the right tables are joined
+    # into the query. We use .includes() instead of .joins() so we can get an OUTER JOIN
+    #
+    def handle_joins fields
+      ret = scoped
+      fields.each do |field|
+        assoc, table = field_table(field)
+        ret = ret.includes(assoc) unless table == self.table_name.to_sym
+      end
+      ret
+    end
+
+    # Get table name from association name
+    #
+    #   class User < ActiveRecord::Base
+    #     belongs_to :company, class_name: Organization
+    #     searchable_by %w(name, email, company.name)
+    #   end
+    #
+    #   field_table('company.name') => [:companies, :organizations]
+    #
+    def field_table(field)
+      if field.include? '.'
+        assoc = field.split('.').first
+        if assoc != self.table_name
+          return assoc.to_sym, self.reflect_on_association(assoc.to_sym).table_name.to_sym
+        end
+      end
+
+      return nil, self.table_name
+
+    end
+
+    # Build the filter for the .where() clause in the search method
+    #
+    def build_filter filter, fields
+      where = [associations_to_tables(fields).map { |f| "#{f} like ?" }.join(" || ")]
+      fields.count.times { |n| where << "%#{filter}%" }
+      where
+    end
+
+    # Set the field to the right table and column name for the database
+    #
+    def associations_to_tables fields
+      fields.map do |field|
+        _, column = field.split('.')
+        "#{field_table(field)[1]}.#{column}"
+      end
+    end
+
+  end #ActiveRecord
+end #Searchtastic
+
+ActiveRecord::Base.extend Searchtastic::ActiveRecord

data/lib/searchtastic/version.rb

@@ -0,0 +1,3 @@
+module Searchtastic
+  VERSION = '0.5.0'
+end

data/searchtastic.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "searchtastic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "searchtastic"
+  s.version     = Searchtastic::VERSION
+  s.authors     = ["Pete Michaud"]
+  s.email       = ["me@petermichaud.com"]
+  s.homepage    = "http://github.com/PeteMichaud/searchtastic"
+  s.summary     = "Enables ActiveRecord Model Searching"
+  s.description = "Enables ActiveRecord Model Searching"
+  s.rubyforge_project = "searchtastic"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["config", "lib"]
+
+  #s.add_dependency 'activesupport', '~> 3.2'
+  #s.add_dependency 'actionpack', '~> 3.2'
+
+  s.add_development_dependency 'rake', '~> 0.9.2'
+  s.add_development_dependency 'rspec', '~> 2.10'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'minitest-rails', '~> 0.2'
+  s.add_development_dependency 'minitest', '~> 3.0' if RUBY_PLATFORM == "java"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'active_support/inflector'
+require 'searchtastic'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: searchtastic
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Pete Michaud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Enables ActiveRecord Model Searching
+email:
+- me@petermichaud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Rakefile
+- Readme.md
+- lib/searchtastic.rb
+- lib/searchtastic/version.rb
+- searchtastic.gemspec
+- spec/spec_helper.rb
+homepage: http://github.com/PeteMichaud/searchtastic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- config
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: searchtastic
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Enables ActiveRecord Model Searching
+test_files:
+- spec/spec_helper.rb