mongoid-fts 0.0.1 → 0.4.2

data/README.md

@@ -1,53 +1,108 @@
 NAME
+
   mongoid-fts.rb
 
 DESCRIPTION
+
   enable mongodb's new fulltext simply and quickly on your mongoid models, including pagination.
 
+
+INSTALL
+
+````ruby
+
+  gem 'mongoid-fts'
+
+````
+
+````bash
+
+# required
+
+  ~> bundle install
+
+  ~> rake db:mongoid:created_indexes
+
+# optional (this is done automatically)
+
+  ~> rails runner 'Mongoid::FTS.enable!'
+
+````
+
 SYNOPSIS
 
 ````ruby
 
+# use the mixin method on your models to give them a 'search' method.  fts
+# will attempt to guess which fields you mean to search.  title will be
+# weighted most highly, then the array of keywords, then the fulltext of the
+# model
+#
   class A
     include Mongoid::Document
     include Mongoid::FTS
 
     field(:title)
-    field(:body)
-
-    def to_search
-      {:title => title, :fulltext => body}
-    end
+    field(:keywords, :type => Array)
+    field(:fulltext)
   end
 
+# if your fields are named like this you can certain override what's indexed
+#
 
   class B
     include Mongoid::Document
     include Mongoid::FTS
 
-    field(:title)
-    field(:body)
+    field(:a)
+    field(:b, :type => Array, :default => [])
+    field(:c)
 
     def to_search
-      {:title => title, :fulltext => body}
+      {:title => a, :keywords => (b + ['foobar']), :fulltext => c}
     end
   end
 
 
+# after this searching is pretty POLS
+#
+
   A.create!(:title => 'foo', :body => 'cats')
-  A.create!(:title => 'bar', :body => 'dogs')
+  A.create!(:title => 'foo', :body => 'cat')
+
+  p A.search('cat').size #=> 2
+
+# you can to cross-model searches like so
+#
+  p Mongoid::FTS.search('cat', :models => [A, B])
+  p Mongoid::FTS.search('dog', :models => [A, B])
+
+# pagination is supported with an ugly hack
+
+  A.search('cats').page(10).per(3)
 
-  B.create!(:title => 'foo', :body => 'cats')
-  B.create!(:title => 'bar', :body => 'dogs')
+# or 
 
-  p FTS.search('cat', :models => [A, B])
-  p FTS.search('dog', :models => [A, B])
+  A.search('cats').paginate(:page => 10, :per => 3)
 
-  p A.search('cat')
-  p B.search('cat')
-  p A.search('dog')
-  p B.search('dog')
 
-  p A.search('cat dog').page(1).per(1)
+# handy to know
+
+  Mongoid::FTS::Index.rebuild! # re-index every currently known object - not super effecient
+
+  Mongoid::FTS::Index.reset!   # completely drop/create indexes - lose all objects
 
 ````
+
+the implementation is has only a work around for pagination, see
+
+  https://groups.google.com/forum/#!topic/mongodb-user/2hUgOAN4KKk
+
+for details
+
+
+regardless, the *interface* of this mixin is uber simple and should be quite
+future proof.  as the mongodb teams moves search forward i'll track the new
+implementation and preserve the current interface.  until it settles down,
+however, i'll resist adding new features.
+

data/lib/mongoid-fts.rb

@@ -1,7 +1,7 @@
 module Mongoid
   module FTS
   #
-    const_set(:Version, '0.0.1') unless const_defined?(:Version)
+    const_set(:Version, '0.4.2') unless const_defined?(:Version)
 
     class << FTS
       def version
@@ -58,9 +58,7 @@ module Mongoid
 
   #
     def FTS.search(*args)
-      options = args.extract_options!.to_options!
-
-      args.push(options)
+      options = Map.options_for(args)
 
       _searches = FTS._search(*args)
 
@@ -68,7 +66,7 @@ module Mongoid
     end
 
     def FTS._search(*args)
-      options = args.extract_options!.to_options!
+      options = Map.options_for!(args)
 
       search = args.join(' ')
 
@@ -76,7 +74,7 @@ module Mongoid
       limit  = [Integer(options.delete(:limit) || 128), 1].max
       models = [options.delete(:models), options.delete(:model)].flatten.compact
 
-      models = FTS.models if models.blank?
+      models = FTS.models if models.empty?
 
       _searches =
         models.map do |model|
@@ -135,7 +133,7 @@ module Mongoid
       end
 
       def paginate(*args)
-        options = args.extract_options!.to_options!
+        options = Map.options_for!(args)
 
         page = Integer(args.shift || options[:page] || @page)
         per = Integer(args.shift || options[:per] || options[:size] || @per)
@@ -157,7 +155,7 @@ module Mongoid
         if args.empty?
           return @page
         else
-          options = args.extract_options!.to_options!
+          options = Map.options_for!(args)
           page = args.shift || options[:page]
           options[:page] = page
           paginate(options)
@@ -168,7 +166,7 @@ module Mongoid
         if args.empty?
           return @per
         else
-          options = args.extract_options!.to_options!
+          options = Map.options_for!(args)
           per = args.shift || options[:per]
           options[:per] = per
           paginate(options)
@@ -290,19 +288,19 @@ module Mongoid
       def normalize!
         index = self
 
-        unless index.keywords.blank?
+        unless [index.keywords].join.strip.empty?
           index.keywords = FTS.list_of_strings(index.keywords)
         end
 
-        unless index.title.blank?
+        unless [index.title].join.strip.empty?
           index.title = index.title.to_s.strip
         end
 
-        unless index.keywords.blank?
+        unless [index.keywords].join.strip.empty?
           index.keywords = index.keywords.map{|keyword| keyword.strip}
         end
 
-        unless index.fulltext.blank?
+        unless [index.fulltext].join.strip.empty?
           index.fulltext = index.fulltext.to_s.strip
         end
 
@@ -428,7 +426,7 @@ module Mongoid
         @code ||= proc do
           class << self
             def search(*args, &block)
-              args.push(options = args.extract_options!.to_options!)
+              options = Map.options_for(args)
 
               options[:model] = self
 
@@ -436,7 +434,7 @@ module Mongoid
             end
 
             def _search(*args, &block)
-              args.push(options = args.extract_options!.to_options!)
+              options = Map.options_for(args)
 
               options[:model] = self
 
@@ -517,15 +515,21 @@ module Mongoid
       models
     end
 
-    def FTS.enable!
-      session = Mongoid::Sessions.default
-      session.with(database: :admin).command({ setParameter: 1, textFTSEnabled: true })
-    end
+    def FTS.enable!(*args)
+      options = Map.options_for!(args)
 
-    begin
-      FTS.enable!
-    rescue Object => e
-      warn "failed to enable search with #{ e.class }(#{ e.message })"
+      unless options.has_key?(:warn)
+        options[:warn] = true
+      end
+
+      begin
+        session = Mongoid::Sessions.default
+        session.with(database: :admin).command({ setParameter: 1, textSearchEnabled: true })
+      rescue Object => e
+        unless e.is_a?(Mongoid::Errors::NoSessionsConfig)
+          warn "failed to enable search with #{ e.class }(#{ e.message })"
+        end
+      end
     end
   end
 
@@ -534,7 +538,13 @@ module Mongoid
   if defined?(Rails)
     class FTS::Engine < ::Rails::Engine
       paths['app/models'] = ::File.dirname(__FILE__)
+
+      config.after_initialize do
+        Mongoid::FTS.enable!(:warn => true)
+      end
     end
+  else
+    Mongoid::FTS.enable!(:warn => true)
   end
 end
 

data/mongoid-fts.gemspec

@@ -0,0 +1,43 @@
+## mongoid-fts.gemspec
+#
+
+Gem::Specification::new do |spec|
+  spec.name = "mongoid-fts"
+  spec.version = "0.4.2"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "mongoid-fts"
+  spec.description = "enable mongodb's new fulltext simply and quickly on your mongoid models, including pagination."
+
+  spec.files =
+["README.md",
+ "Rakefile",
+ "lib",
+ "lib/app",
+ "lib/app/mongoid",
+ "lib/app/mongoid/fts",
+ "lib/app/mongoid/fts/index.rb",
+ "lib/mongoid",
+ "lib/mongoid-fts.rb",
+ "mongoid-fts.gemspec"]
+
+  spec.executables = []
+  
+  spec.require_path = "lib"
+
+  spec.test_files = nil
+
+  
+    spec.add_dependency(*["mongoid", "~> 3.1"])
+  
+    spec.add_dependency(*["map", "~> 6.5"])
+  
+    spec.add_dependency(*["coerce", "~> 0.0"])
+  
+
+  spec.extensions.push(*[])
+
+  spec.rubyforge_project = "codeforpeople"
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "https://github.com/ahoward/mongoid-fts"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-fts
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -70,6 +70,7 @@ files:
 - Rakefile
 - lib/app/mongoid/fts/index.rb
 - lib/mongoid-fts.rb
+- mongoid-fts.gemspec
 homepage: https://github.com/ahoward/mongoid-fts
 licenses: []
 post_install_message: