name_search 0.8.0

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.7'
+gem 'capybara', '>= 0.4.0'
+gem 'sqlite3'
+
+group :development, :test do
+  gem 'factory_girl'
+  gem 'ruby-debug19'
+end
+
+group :test do
+  gem 'rspec-rails', '>= 2.0.0.beta'
+  gem 'ruby-debug19'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Paul Yoder
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Name Search
+
+Search for names while taking into consideration nick names and word ordering.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rdoc/task'
+require 'rake/testtask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NameSearch'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/name_search/migration/migration_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module NameSearch
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc 'Generates migration for name_search models'
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/create_name_search_tables.rb'
+    end
+  end
+end

data/lib/generators/name_search/migration/templates/migration.rb

@@ -0,0 +1,35 @@
+class CreateNameSearchTables < ActiveRecord::Migration
+  def self.up
+    create_table :name_search_names do |t|
+      t.string  :value
+    end
+    add_index :name_search_names, :value
+
+    create_table :name_search_nick_name_family_joins do |t|
+      t.integer :name_id
+      t.integer :nick_name_family_id
+    end
+    add_index :name_search_nick_name_family_joins, :name_id
+    add_index :name_search_nick_name_family_joins, :nick_name_family_id
+     
+    create_table :name_search_nick_name_families do |t|
+    end
+
+    create_table :name_search_searchables do |t|
+      t.integer :name_id
+      t.integer :searchable_id
+      t.string  :searchable_type
+    end
+    add_index :name_search_searchables, :name_id
+    add_index :name_search_searchables,
+      [:searchable_id, :searchable_type],
+      :name => 'index_name_search_searchable'
+  end
+
+  def self.down
+    drop_table :name_search_names
+    drop_table :name_search_nick_name_family_joins
+    drop_table :name_search_nick_name_families
+    drop_table :name_search_searchables
+  end
+end

data/lib/name_search/active_relation_search.rb

@@ -0,0 +1,9 @@
+module NameSearch
+  module ActiveRelationSearch
+    def name_search(name, options = {})
+      NameSearch::Search.new(self, name, options)
+    end
+  end
+end
+
+ActiveRecord::Relation.send :include, NameSearch::ActiveRelationSearch

data/lib/name_search/models/name.rb

@@ -0,0 +1,47 @@
+module NameSearch
+  class Name < ActiveRecord::Base
+    set_table_name :name_search_names
+    before_create :downcase_value
+
+    has_many :nick_name_family_joins
+    has_many :nick_name_families, :through => :nick_name_family_joins
+            
+    def nick_names()
+      nick_name_families.map(&:names).flatten
+    end
+
+    def nick_name_values()
+      nick_names.map(&:value)
+    end
+
+    validates :value, :uniqueness => true
+
+    cattr_accessor :excluded_values
+    @@excluded_values = %w( and or )
+
+    def self.find(*args)
+      return Name.where(:value => args.first).first if args.first.kind_of?(String)
+      super
+    end
+
+    def self.scrub_and_split_name(name)
+      scrubbed = name.downcase.gsub(/[^a-z0-9 -]/, '')
+      split = scrubbed.split(/[ -]/).uniq
+      split - @@excluded_values
+    end
+
+    private
+    
+    def self.get_family_for_nick_names(names)
+      family = Name.where(:value => names.map(&:downcase)).
+                    where('nick_name_family_id IS NOT NULL').
+                    first.
+                    try(:nick_name_family)
+      family ||= NickNameFamily.create
+    end
+
+    def downcase_value
+      value.downcase!
+    end
+  end
+end

data/lib/name_search/models/nick_name_family.rb

@@ -0,0 +1,17 @@
+module NameSearch
+  class NickNameFamily < ActiveRecord::Base
+    set_table_name :name_search_nick_name_families
+
+    has_many :nick_name_family_joins
+    has_many :names, :through => :nick_name_family_joins
+
+    def self.create_family(*nick_names)
+      family = NickNameFamily.create
+      scrubbed_names = nick_names.map{|x| Name.scrub_and_split_name(x)}.flatten
+      scrubbed_names.each do |name|
+        family.names << Name.find_or_create_by_value(name)
+      end
+      family
+    end
+  end
+end

data/lib/name_search/models/nick_name_family_join.rb

@@ -0,0 +1,8 @@
+module NameSearch
+  class NickNameFamilyJoin < ActiveRecord::Base
+    set_table_name :name_search_nick_name_family_joins
+
+    belongs_to :name
+    belongs_to :nick_name_family
+  end
+end

data/lib/name_search/models/searchable.rb

@@ -0,0 +1,11 @@
+module NameSearch
+  class Searchable < ActiveRecord::Base
+    set_table_name :name_search_searchables
+
+    belongs_to :name
+    belongs_to :searchable, :polymorphic => true
+
+    validates :name,        :presence => true
+    validates :searchable,  :presence => true
+  end
+end

data/lib/name_search/name_search_on.rb

@@ -0,0 +1,22 @@
+module NameSearch
+  module NameSearchOn
+    def name_search_on(*attributes)
+      write_inheritable_attribute(:name_search_attributes, attributes)
+      class_inheritable_reader(:name_search_attributes)
+      
+      def name_search(name, options = {})
+        NameSearch::Search.new(self, name, options)
+      end
+
+      class_eval do
+        include NameSearchablesConcerns
+
+        after_save :sync_name_searchables
+        has_many :name_searchables, :as => :searchable, :dependent => :destroy,
+          :include => :name, :class_name => 'NameSearch::Searchable'
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :extend, NameSearch::NameSearchOn

data/lib/name_search/name_searchables_concerns.rb

@@ -0,0 +1,49 @@
+module NameSearch
+  module NameSearchablesConcerns
+    def sync_name_searchables
+      return unless name_search_attributes_changed?
+      update_name_searchables
+    end
+
+    def update_name_searchables
+      names = name_search_attributes_names
+      create_new_name_searchables(names)
+      destroy_orphaned_name_searchables(names)
+    end
+    
+    def name_searchable_values(force_reload = false)
+      name_searchables(force_reload).map{|x| x.name.value}
+    end
+
+    def name_search_attributes_names()
+      names = []
+      attributes = self.class.name_search_attributes
+      attributes.each do |att|
+        value = self.send(att)
+        names.concat(NameSearch::Name.scrub_and_split_name(value))
+      end
+      names
+    end
+
+    def create_new_name_searchables(names)
+      names_to_add = names - name_searchable_values
+      names_to_add.each do |name|
+        name_searchables.create :name => NameSearch::Name.find_or_create_by_value(name)
+      end
+    end
+
+    #Destroys name_searchable values that used to exist but don't exist any longer
+    #Example: 'Jen York' changes to 'Jen Yoder', then 'york' would be destroyed
+    def destroy_orphaned_name_searchables(names)
+      orphaned_names = name_searchable_values - names
+      orphaned_names.each do |orphan_name|
+        searchable = name_searchables.select{|x| x.name.value == orphan_name}.first
+        searchable.destroy if searchable.present?
+      end
+    end
+
+    def name_search_attributes_changed?()
+      (changed & self.class.name_search_attributes.map(&:to_s)).length > 0
+    end
+  end
+end

data/lib/name_search/railtie.rb

@@ -0,0 +1,10 @@
+require 'name_search'
+require 'rails'
+
+module NameSearch
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'name_search/railties/tasks.rake'
+    end
+  end
+end

data/lib/name_search/railties/tasks.rake

@@ -0,0 +1,18 @@
+namespace :name_search do
+  desc 'runs the update_name_searchables() method on all records of the class'
+  task :update_name_searchables, [:model, :page_size] => :environment do |t, args|
+    klass = args[:model].camelize.constantize
+    page_size = args[:page_size].try(:to_i) || 100
+    page = 0
+    
+    record_count = klass.count
+    records = klass.offset(page * page_size).limit(page_size)
+    while records.length > 0
+      records.each{|x| x.update_name_searchables}
+      page += 1
+      puts "Updated #{page * page_size} of #{record_count}"
+      records = klass.offset(page * page_size).limit(page_size)
+    end
+    puts 'finished'
+  end
+end

data/lib/name_search/search.rb

@@ -0,0 +1,46 @@
+module NameSearch
+  class Search < Array
+    def initialize(klass_or_query, name, options = {})
+      name_values = Name.scrub_and_split_name(name)
+      names = get_names(name_values)
+      nick_names = (options[:match_mode] == :exact) ?
+        [] :
+        get_nick_names(names)
+
+      results = matched_models(klass_or_query, names + nick_names).
+                  map{|x| SearchResult.new(x, name_values, nick_names.map(&:value)) }.
+                  sort{|a,b| b.match_score <=> a.match_score }
+
+      if options.has_key?(:matches_at_least)
+        results = results.delete_if{|x| x.matched_names.length < options[:matches_at_least] } 
+      end
+      
+      self.concat(results)
+    end
+
+    private
+
+    def matched_models(klass_or_query, names_to_search)
+      klass_or_query.includes(:name_searchables).
+        where(:name_search_searchables => { 
+          :name_id => names_to_search.map(&:id) }).
+        all.
+        uniq
+    end
+
+    def get_names(name_values)
+      Name.where(:value => name_values)
+    end
+
+    def get_nick_names(names)
+      all_names = Name.joins(:nick_name_families).
+           where("name_search_nick_name_families.id IN (#{
+             NickNameFamily.joins(:names).
+                            where(:name_search_names => { :value => names.map(&:value) }).
+                            select('name_search_nick_name_families.id').
+                            to_sql
+           })").
+           where('name_search_names.id NOT IN (?)', names.map(&:id))
+    end
+  end
+end

data/lib/name_search/search_result.rb

@@ -0,0 +1,14 @@
+module NameSearch
+  class SearchResult
+    attr_reader :model, :matched_names, :exact_name_matches, :nick_name_matches, :match_score
+
+    def initialize(model, searched_names, searched_nick_names)
+      @model              = model
+      @exact_name_matches = model.name_searchable_values & searched_names
+      @nick_name_matches  = model.name_searchable_values & searched_nick_names
+      @matched_names      = @exact_name_matches + @nick_name_matches
+      @match_score        = (@exact_name_matches.length * 4) +
+                            (@nick_name_matches.length * 3)
+    end
+  end
+end

data/lib/name_search/version.rb

@@ -0,0 +1,3 @@
+module NameSearch
+  VERSION = '0.8.0'
+end

data/lib/name_search.rb

@@ -0,0 +1,13 @@
+module NameSearch
+  require 'name_search/models/name.rb'
+  require 'name_search/models/nick_name_family.rb'
+  require 'name_search/models/nick_name_family_join.rb'
+  require 'name_search/models/searchable.rb'
+  require 'name_search/active_relation_search.rb'
+  require 'name_search/name_search_on.rb'
+  require 'name_search/name_searchables_concerns.rb'
+  require 'name_search/railtie.rb' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'name_search/search.rb'
+  require 'name_search/search_result.rb'
+  require 'name_search/version.rb'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: name_search
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Yoder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-23 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &21939800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *21939800
+description: Search for people's names while taking into consideration nick names
+  and word ordering.
+email:
+- paulyoder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/name_search.rb
+- lib/generators/name_search/migration/migration_generator.rb
+- lib/generators/name_search/migration/templates/migration.rb
+- lib/name_search/active_relation_search.rb
+- lib/name_search/railties/tasks.rake
+- lib/name_search/name_search_on.rb
+- lib/name_search/models/searchable.rb
+- lib/name_search/models/name.rb
+- lib/name_search/models/nick_name_family.rb
+- lib/name_search/models/nick_name_family_join.rb
+- lib/name_search/search.rb
+- lib/name_search/railtie.rb
+- lib/name_search/version.rb
+- lib/name_search/search_result.rb
+- lib/name_search/name_searchables_concerns.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.rdoc
+has_rdoc: true
+homepage: https://github.com/paulyoder/name_search
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- 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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Search for people's names while taking into consideration nick names and
+  word ordering.
+test_files: []