is_msfte_searchable 3.2.0 → 3.3.0

data/lib/is_msfte_searchable.rb

@@ -3,6 +3,7 @@ require 'active_record'
 require 'is_msfte_searchable/active_record_extension'
 require 'is_msfte_searchable/active_record_mixin'
 require 'is_msfte_searchable/arel_mixin'
+require 'is_msfte_searchable/no_full_text_index_error'
 require 'is_msfte_searchable/version'
 
 ActiveRecord::Base.send :include, IsMsfteSearchable::ActiveRecordExtension

data/lib/is_msfte_searchable/active_record_extension.rb

@@ -16,6 +16,35 @@ module IsMsfteSearchable
         include IsMsfteSearchable::ActiveRecordMixin
         include IsMsfteSearchable::ArelMixin
       end
+
+      def msfte_column_indexed?(column)
+        # Any column in this table full-text indexed?
+        sql_statement =
+          <<-stmt
+            select count(*)
+            from sys.fulltext_index_columns fic
+            inner join sys.columns c
+              on c.[object_id] = fic.[object_id]
+              and c.[column_id] = fic.[column_id]
+            where OBJECT_ID('#{table_name}') = fic.[object_id]
+          stmt
+
+        # Search for an actual column name if given.
+        sql_statement << " and name = '#{column}'" unless column == '*'
+
+        value = connection.select_value(sql_statement)
+        value.to_i == 1
+      end
+
+      # Query the object properties of the current table.
+      # TableFulltextPendingChanges returns the number of pending changes.
+      # See: http://technet.microsoft.com/en-us/library/ms188390.aspx
+      def msfte_pending_changes?
+        sql_statement =
+          %|select cast(OBJECTPROPERTYEX(OBJECT_ID('#{table_name}'), 'TableFulltextPendingChanges') as varchar(10))|
+        value = connection.select_value(sql_statement)
+        value.to_i != 0
+      end
     end
   end
 end

data/lib/is_msfte_searchable/arel_mixin.rb

@@ -27,20 +27,17 @@ module IsMsfteSearchable
         msfte_columns.each do |c|
           scope "msfte_#{c}_with_any".to_sym, lambda { |query|
             return {} if query.blank?
-            return msfte_like_bailout(c, query) if Rails.env.test?
-            msfte_contains(msfte_search_string(query, 'OR'), :column => c)
+            msfte_try_contains(msfte_search_string(query, 'OR'), :column => c)
           }
 
           scope "msfte_#{c}_with_all".to_sym, lambda { |query|
             return {} if query.blank?
-            return msfte_like_bailout(c, query) if Rails.env.test?
-            msfte_contains(msfte_search_string(query, 'AND'), :column => c)
+            msfte_try_contains(msfte_search_string(query, 'AND'), :column => c)
           }
 
           scope "msfte_#{c}_with_booleans".to_sym, lambda { |query|
             return {} if query.blank?
-            return msfte_like_bailout(c, query) if Rails.env.test?
-            msfte_contains(query, :column => c, :quote => true)
+            msfte_try_contains(query, :column => c, :quote => true)
           }
         end
       end
@@ -49,6 +46,18 @@ module IsMsfteSearchable
     module ClassMethods
       private
 
+      def msfte_try_contains(query, options={})
+        column = options.fetch(:column, '*')
+        if msfte_column_indexed?(column)
+          until !msfte_pending_changes? do
+            sleep 1
+          end
+          msfte_contains(query, options)
+        else
+          raise NoFullTextIndexError, "column '#{column}' is not full-text indexed"
+        end
+      end
+
       def msfte_like_bailout(column, query)
         { :conditions => "#{table_name}.#{column} LIKE '%#{msfte_quote(query)}%'" }
       end

data/lib/is_msfte_searchable/no_full_text_index_error.rb

@@ -0,0 +1,4 @@
+module IsMsfteSearchable
+  class NoFullTextIndexError < ArgumentError
+  end
+end

data/lib/is_msfte_searchable/version.rb

@@ -1,3 +1,3 @@
 module IsMsfteSearchable
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/test/active_record_extension_test.rb

@@ -5,6 +5,10 @@ describe IsMsfteSearchable::ActiveRecordExtension do
     ActiveRecord::Base.must_respond_to(:is_msfte_searchable)
   end
 
+  it "extends ActiveRecord::Base with an msfte_pending_changes? method" do
+    ActiveRecord::Base.must_respond_to(:msfte_pending_changes?)
+  end
+
   class FakeActiveRecord
     def self.table_name
       'people'

data/test/arel_mixin_test.rb

@@ -1,17 +1,5 @@
 require 'helper'
 
-class Rails
-  class Env
-    def self.test?
-      false
-    end
-  end
-
-  def self.env
-    Env
-  end
-end
-
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
 
 ActiveRecord::Base.class_eval do
@@ -24,6 +12,14 @@ end
 
 class Person < ActiveRecord::Base
   is_msfte_searchable(:columns => %w(name))
+
+  def self.msfte_column_indexed?(column)
+    true
+  end
+
+  def self.msfte_pending_changes?
+    false
+  end
 end
 
 # The SQL generated is courtesy of the sqlite adapter, so the whitespace and
@@ -121,11 +117,11 @@ describe IsMsfteSearchable::ArelMixin do
         )
       end
 
-      it "returns a scope using a LIKE query when Rails.env.test?" do
-        Rails.env.stubs(:test?).returns(true)
-        Person.msfte_name_with_any('foo bar').to_sql.must_equal(
-          %{SELECT "people".* FROM "people"  WHERE (people.name LIKE '%foo bar%')}
-        )
+      it "raises an exception if the searched column is not indexed" do
+        Person.stubs(:msfte_column_indexed?).returns(false)
+        Proc.new do
+          Person.msfte_name_with_any('foo bar')
+        end.must_raise IsMsfteSearchable::NoFullTextIndexError
       end
     end
 
@@ -146,11 +142,11 @@ describe IsMsfteSearchable::ArelMixin do
         )
       end
 
-      it "returns a scope using a LIKE query when Rails.env.test?" do
-        Rails.env.stubs(:test?).returns(true)
-        Person.msfte_name_with_all('foo bar').to_sql.must_equal(
-          %{SELECT "people".* FROM "people"  WHERE (people.name LIKE '%foo bar%')}
-        )
+      it "raises an exception if the searched column is not indexed" do
+        Person.stubs(:msfte_column_indexed?).returns(false)
+        Proc.new do
+          Person.msfte_name_with_all('foo bar')
+        end.must_raise IsMsfteSearchable::NoFullTextIndexError
       end
     end
 
@@ -171,13 +167,12 @@ describe IsMsfteSearchable::ArelMixin do
         )
       end
 
-      it "returns a scope using a LIKE query when Rails.env.test?" do
-        Rails.env.stubs(:test?).returns(true)
-        Person.msfte_name_with_booleans('foo bar').to_sql.must_equal(
-          %{SELECT "people".* FROM "people"  WHERE (people.name LIKE '%foo bar%')}
-        )
+      it "raises an exception if the searched column is not indexed" do
+        Person.stubs(:msfte_column_indexed?).returns(false)
+        Proc.new do
+          Person.msfte_name_with_any('foo bar')
+        end.must_raise IsMsfteSearchable::NoFullTextIndexError
       end
     end
   end
-
 end

metadata

@@ -1,129 +1,121 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: is_msfte_searchable
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 3.3.0
   prerelease: 
-  segments: 
-  - 3
-  - 2
-  - 0
-  version: 3.2.0
 platform: ruby
-authors: 
+authors:
 - Ken Collins
 - Donald Ball
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-14 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 3
-        - 2
-        - 0
+      - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 3
-        - 2
-        - 0
+      - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 45
-        segments: 
-        - 2
-        - 8
-        - 1
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 2.8.1
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 61
-        segments: 
-        - 0
-        - 10
-        - 5
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 0.10.5
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: ActiveRecord extensions for Microsoft SQL Server full-text index
-email: 
+email:
 - ken@metaskills.net
 - donald.ball@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
@@ -134,6 +126,7 @@ files:
 - lib/is_msfte_searchable/active_record_extension.rb
 - lib/is_msfte_searchable/active_record_mixin.rb
 - lib/is_msfte_searchable/arel_mixin.rb
+- lib/is_msfte_searchable/no_full_text_index_error.rb
 - lib/is_msfte_searchable/version.rb
 - test/active_record_extension_test.rb
 - test/active_record_mixin_test.rb
@@ -141,39 +134,32 @@ files:
 - test/helper.rb
 homepage: http://github.com/Decisiv/is_msfte_searchable/
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ActiveRecord extensions for Microsoft SQL Server full-text index
-test_files: 
+test_files:
 - test/active_record_extension_test.rb
 - test/active_record_mixin_test.rb
 - test/arel_mixin_test.rb
 - test/helper.rb
+has_rdoc: