dusen 0.2.2 → 0.3.0

data/spec/shared/spec/dusen/active_record/base_ext_spec.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+shared_examples_for 'model with search syntax' do
+
+  describe '.search' do
+
+    it 'should find records by given words' do
+      match = subject.create!(:name => 'Abraham')
+      no_match = subject.create!(:name => 'Elizabath')
+      subject.search('Abraham').to_a.should == [match]
+    end
+
+    it 'should AND multiple words' do
+      match = subject.create!(:name => 'Abraham Lincoln')
+      no_match = subject.create!(:name => 'Abraham')
+      subject.search('Abraham Lincoln').to_a.should == [match]
+    end
+
+    it 'should find records by phrases' do
+      match = subject.create!(:name => 'Abraham Lincoln')
+      no_match = subject.create!(:name => 'Abraham John Lincoln')
+      subject.search('"Abraham Lincoln"').to_a.should == [match]
+    end
+
+    it 'should find records by qualified fields' do
+      match = subject.create!(:name => 'foo@bar.com', :email => 'foo@bar.com')
+      no_match = subject.create!(:name => 'foo@bar.com', :email => 'bam@baz.com')
+      subject.search('email:foo@bar.com').to_a.should == [match]
+    end
+
+    it 'should allow phrases as values for qualified field queries' do
+      match = subject.create!(:name => 'Foo Bar', :city => 'Foo Bar')
+      no_match = subject.create!(:name => 'Foo Bar', :city => 'Bar Foo')
+      subject.search('city:"Foo Bar"').to_a.should == [match]
+    end
+
+    it 'should allow to mix multiple types of tokens in a single query' do
+      match = subject.create!(:name => 'Abraham', :city => 'Foohausen')
+      no_match = subject.create!(:name => 'Abraham', :city => 'Barhausen')
+      subject.search('Foo city:Foohausen').to_a.should == [match]
+    end
+
+    it 'should not find records from another model' do
+      match = subject.create!(:name => 'Abraham')
+      Recipe.create!(:name => 'Abraham')
+      subject.search('Abraham').to_a.should == [match]
+    end
+
+  end
+
+  describe '.search_syntax' do
+
+    it "should return the model's syntax definition when called without a block" do
+      subject.search_syntax.should be_a(Dusen::Syntax)
+    end
+
+    it 'should be callable multiple times, appending additional syntax' do
+      subject.search_syntax.fields.keys.should =~ ['text', 'email', 'city', 'role']
+    end
+
+  end
+
+end
+
+
+describe ActiveRecord::Base do
+
+  describe 'for a model without an associated FULLTEXT table' do
+
+    subject { User::WithoutFulltext }
+
+    it_should_behave_like 'model with search syntax'
+
+  end
+
+  describe 'for a model with an associated FULLTEXT table' do
+
+    subject { User::WithFulltext }
+
+    it_should_behave_like 'model with search syntax'
+
+    it 'should be shadowed by a Dusen::ActiveRecord::SearchText, which is created, updated and destroyed with the record' do
+      user = User::WithFulltext.create!(:name => 'name', :email => 'email', :city => 'city')
+      User::WithFulltext.index_search_texts
+      Dusen::ActiveRecord::SearchText.all.collect(&:words).should == ['name email city']
+      user.reload
+      user.update_attributes!(:email => 'changed_email')
+      User::WithFulltext.index_search_texts
+      Dusen::ActiveRecord::SearchText.all.collect(&:words).should == ['name changed_email city']
+      user.destroy
+      User::WithFulltext.index_search_texts
+      Dusen::ActiveRecord::SearchText.count.should be_zero
+    end
+
+    describe 'indexing fields from associated records'
+
+      it 'should allow to index fields from an associated record' do
+        category = Recipe::Category.create!(:name => 'Rice')
+        recipe = Recipe.create!(:name => 'Martini Chicken', :category => category)
+        recipe.ingredients.create!(:name => 'Paprica')
+        recipe.ingredients.create!(:name => 'Tomatoes')
+        Recipe.search('Rice').to_a.should == [recipe]
+        Recipe.search('Martini').to_a.should == [recipe]
+        Recipe.search('Paprica').to_a.should == [recipe]
+        Recipe.search('Tomatoes').to_a.should == [recipe]
+      end
+
+      context 'if the associated model has a .part_of_search_text_for directive' do
+
+        it 'should automatically reindex itself when an associated record changes' do
+          category = Recipe::Category.create!(:name => 'Rice')
+          recipe = category.recipes.create!(:name => 'Martini Chicken')
+          ingredient = recipe.ingredients.create!(:name => 'Paprica')
+          category.update_attributes!(:name => 'Noodles')
+          ingredient.update_attributes!(:name => 'Onions')
+          Recipe.search('Noodles').to_a.should == [recipe]
+          Recipe.search('Onion').to_a.should == [recipe]
+          category.reload
+          category.destroy
+          Recipe.search('Noodles').to_a.should be_empty
+        end
+
+        #it 'should automatically reindex both containers if the container changes' do
+        #  recipe1 = Recipe.create!(:name => 'Martini Chicken')
+        #  recipe2 = Recipe.create!(:name => 'Whiskey Chicken')
+        #  ingredient = recipe1.ingredients.create!(:name => 'Paprica')
+        #  Recipe.search('Paprica').to_a.should == [recipe1]
+        #  ingredient.update_attributes!(:recipe => recipe2)
+        #  Recipe.search('Paprica').to_a.should == [recipe2]
+        #end
+
+      end
+
+  end
+
+end

data/spec/shared/spec/dusen/active_record/search_text_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Dusen::ActiveRecord::SearchText do
+
+  describe '.match' do
+
+    it 'should find records for the given list of words' do
+      match = User::WithFulltext.create!(:name => 'Abraham', :city => 'Fooville')
+      no_match = User::WithFulltext.create!(:name => 'Elizabeth', :city => 'Fooville')
+      matches = Dusen::ActiveRecord::SearchText.match(User::WithFulltext, ['Abraham', 'Fooville'])
+      matches.all.should == [match]
+    end
+
+    it 'should find records by only giving the prefix of a word' do
+      match = User::WithFulltext.create!(:name => 'Abraham')
+      no_match = User::WithFulltext.create!(:name => 'Elizabeth')
+      matches = Dusen::ActiveRecord::SearchText.match(User::WithFulltext, ['Abra'])
+      matches.all.should == [match]
+    end
+
+  end
+
+end

data/spec/shared/spec/dusen/parser_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Dusen::Parser do
+
+  describe '.parse' do
+
+    it 'should parse field tokens first, because they usually give maximum filtering at little cost' do
+      query = Dusen::Parser.parse('word1 field1:field1-value word2 field2:field2-value')
+      query.collect(&:value).should == ['field1-value', 'field2-value', 'word1', 'word2']
+    end
+
+  end
+
+end

data/spec/shared/spec/dusen/query_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Dusen::Query do
+
+  describe '#condensed' do
+
+    it 'should return a version of the query where all text tokens have been collapsed into a single token with an Array value' do
+      query = Dusen::Parser.parse('field:value foo bar baz')
+      query.tokens.size.should == 4
+      condensed_query = query.condensed
+      condensed_query.tokens.size.should == 2
+      condensed_query[0].field.should == 'field'
+      condensed_query[0].value.should == 'value'
+      condensed_query[1].field.should == 'text'
+      condensed_query[1].value.should == ['foo', 'bar', 'baz']
+    end
+
+  end
+
+end

data/spec/shared/spec/dusen/util_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Dusen::Util do
+
+  describe '.boolean_fulltext_query' do
+
+    it 'should generate a query for boolean MySQL fulltext search, which includes all words and allows additional characters on the right side' do
+      Dusen::Util.boolean_fulltext_query(['aaa', 'bbb']).should == '+aaa* +bbb*'
+    end
+
+    it 'should keep phrases intact' do
+      Dusen::Util.boolean_fulltext_query(['aaa', 'bbb ccc', 'ddd']).should == '+aaa* +"bbb ccc" +ddd*'
+    end
+
+    it 'should escape characters that have special meaning in boolean MySQL fulltext searches' do
+      Dusen::Util.boolean_fulltext_query(['+-~\\']).should == '+\\+\\-\\~\\\\*'
+    end
+
+  end
+
+end

metadata

@@ -1,50 +1,68 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: dusen
-version: !ruby/object:Gem::Version
-  version: 0.2.2
+version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
-authors:
+authors: 
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-12-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Maps Google-like queries (words, "phrases", qualified:fields) to ActiveRecord
-  scope chains
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Comprehensive full text search for ActiveRecord and MySQL
 email: henning.koch@makandra.de
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - README.md
 - Rakefile
+- documents/fulltext_vs_like_benchmark/all_records_and_scope/fulltext.csv
+- documents/fulltext_vs_like_benchmark/all_records_and_scope/fulltext_vs_like.xls
+- documents/fulltext_vs_like_benchmark/all_records_and_scope/like.csv
+- documents/fulltext_vs_like_benchmark/benchmark.rb
+- documents/fulltext_vs_like_benchmark/exact_number_of_records/fulltext.csv
+- documents/fulltext_vs_like_benchmark/exact_number_of_records/fulltext_vs_like.png
+- documents/fulltext_vs_like_benchmark/exact_number_of_records/fulltext_vs_like.xls
+- documents/fulltext_vs_like_benchmark/exact_number_of_records/like.csv
 - dusen.gemspec
 - lib/dusen.rb
-- lib/dusen/active_record_ext.rb
+- lib/dusen/active_record/base_ext.rb
+- lib/dusen/active_record/search_text.rb
 - lib/dusen/description.rb
 - lib/dusen/parser.rb
 - lib/dusen/query.rb
+- lib/dusen/railtie.rb
 - lib/dusen/syntax.rb
+- lib/dusen/tasks.rb
 - lib/dusen/token.rb
 - lib/dusen/util.rb
 - lib/dusen/version.rb
@@ -53,11 +71,7 @@ files:
 - spec/rails-2.3/app_root/config/boot.rb
 - spec/rails-2.3/app_root/config/database.yml
 - spec/rails-2.3/app_root/config/environment.rb
-- spec/rails-2.3/app_root/config/environments/in_memory.rb
-- spec/rails-2.3/app_root/config/environments/mysql.rb
-- spec/rails-2.3/app_root/config/environments/postgresql.rb
-- spec/rails-2.3/app_root/config/environments/sqlite.rb
-- spec/rails-2.3/app_root/config/environments/sqlite3.rb
+- spec/rails-2.3/app_root/config/environments/test.rb
 - spec/rails-2.3/app_root/config/initializers/fix_missing_source_file.rb
 - spec/rails-2.3/app_root/config/preinitializer.rb
 - spec/rails-2.3/app_root/config/routes.rb
@@ -104,33 +118,53 @@ files:
 - spec/rails-3.2/rcov.opts
 - spec/rails-3.2/spec/spec_helper.rb
 - spec/shared/app_root/app/controllers/application_controller.rb
-- spec/shared/app_root/app/models/user.rb
-- spec/shared/app_root/db/migrate/001_create_users.rb
-- spec/shared/dusen/active_record_spec.rb
+- spec/shared/app_root/app/models/recipe.rb
+- spec/shared/app_root/app/models/recipe/category.rb
+- spec/shared/app_root/app/models/recipe/ingredient.rb
+- spec/shared/app_root/app/models/user/with_fulltext.rb
+- spec/shared/app_root/app/models/user/without_fulltext.rb
+- spec/shared/app_root/config/database.sample.yml
+- spec/shared/app_root/db/migrate/001_create_search_text.rb
+- spec/shared/app_root/db/migrate/002_create_user_variants.rb
+- spec/shared/app_root/db/migrate/003_create_recipe_models.rb
+- spec/shared/spec/dusen/active_record/base_ext_spec.rb
+- spec/shared/spec/dusen/active_record/search_text_spec.rb
+- spec/shared/spec/dusen/parser_spec.rb
+- spec/shared/spec/dusen/query_spec.rb
+- spec/shared/spec/dusen/util_spec.rb
+has_rdoc: true
 homepage: https://github.com/makandra/dusen
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.3.9.4
 signing_key: 
 specification_version: 3
-summary: Maps Google-like queries (words, "phrases", qualified:fields) to ActiveRecord
-  scope chains
+summary: Comprehensive full text search for ActiveRecord and MySQL
 test_files: []
-has_rdoc: 
+

data/lib/dusen/active_record_ext.rb

@@ -1,35 +0,0 @@
-# encoding: utf-8
-
-module Dusen
-  module ActiveRecord
-
-    def search_syntax(&dsl)
-      if dsl
-        @search_syntax = Dusen::Description.read_syntax(&dsl)
-        singleton_class.send(:define_method, :search) do |query_string|
-          @search_syntax.search(self, query_string)
-        end
-      else
-        @search_syntax
-      end
-    end
-
-    def where_like(conditions)
-      scope = self
-      conditions.each do |field_or_fields, query|
-        fields = Array(field_or_fields).collect do |field|
-          Util.qualify_column_name(scope, field)
-        end
-        query_with_placeholders = fields.collect { |field| "#{field} LIKE ?" }.join(' OR ')
-        like_expression = Dusen::Util.like_expression(query)
-        bindings = [like_expression] * fields.size
-        conditions = [ query_with_placeholders, *bindings ]
-        scope = Util.append_scope_conditions(scope, conditions)
-      end
-      scope
-    end
-
-  end
-end
-
-ActiveRecord::Base.send(:extend, Dusen::ActiveRecord)

data/spec/shared/app_root/app/models/user.rb

@@ -1,22 +0,0 @@
-# encoding: utf-8
-
-class User < ActiveRecord::Base
-
-  search_syntax do
-
-    search_by :text do |scope, text|
-      scope.where_like([:name, :email, :city] => text)
-    end
-
-    search_by :city do |scope, city|
-      scope.scoped(:conditions => { :city => city })
-    end
-
-    search_by :email do |scope, email|
-      scope.scoped(:conditions => { :email => email })
-    end
-
-  end
-
-end
-

data/spec/shared/app_root/db/migrate/001_create_users.rb

@@ -1,17 +0,0 @@
-# encoding: utf-8
-
-class CreateUsers < ActiveRecord::Migration
-
-  def self.up
-    create_table :users do |t|
-      t.string :name
-      t.string :email
-      t.string :city
-    end
-  end
-
-  def self.down
-    drop_table :users
-  end
-
-end

data/spec/shared/dusen/active_record_spec.rb

@@ -1,55 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe Dusen::ActiveRecord do
-
-  describe '.search' do
-
-    it 'should find records by given words' do
-      match = User.create!(:name => 'foo')
-      no_match = User.create!(:name => 'bar')
-      User.search('foo').to_a.should == [match]
-    end
-
-    it 'should AND multiple words' do
-      match = User.create!(:name => 'foo bar')
-      no_match = User.create!(:name => 'foo')
-      User.search('foo bar').to_a.should == [match]
-    end
-
-    it 'should find records by phrases' do
-      match = User.create!(:name => 'foo bar baz')
-      no_match = User.create!(:name => 'foo baz bar')
-      User.search('"foo bar"').to_a.should == [match]
-    end
-
-    it 'should find records by qualified fields' do
-      match = User.create!(:name => 'foo@bar.com', :email => 'foo@bar.com')
-      no_match = User.create!(:name => 'foo@bar.com', :email => 'bam@baz.com')
-      User.search('email:foo@bar.com').to_a.should == [match]
-    end
-
-    it 'should allow phrases as values for qualified field queries' do
-      match = User.create!(:name => 'Foo Bar', :city => 'Foo Bar')
-      no_match = User.create!(:name => 'Foo Bar', :city => 'Bar Foo')
-      User.search('city:"Foo Bar"').to_a.should == [match]
-    end
-
-    it 'should allow to mix multiple types of tokens in a single query' do
-      match = User.create!(:name => 'Foo', :city => 'Foohausen')
-      no_match = User.create!(:name => 'Foo', :city => 'Barhausen')
-      User.search('Foo city:Foohausen').to_a.should == [match]
-    end
-
-  end
-
-  describe '.search_syntax' do
-
-    it "should return the model's syntax definition when called without a block" do
-      User.search_syntax.should be_a(Dusen::Syntax)
-    end
-
-  end
-
-end