activesearch 0.2.0 → 0.3.0

data/spec/models/mongoid.rb

@@ -1,46 +1,40 @@
-require 'mongoid'
-require 'activesearch/mongoid'
-
-Mongoid.configure do |config|
-  config.sessions = {:default => {:hosts => ["localhost"], :database => "activesearch_test"}}
-end
-
 class MongoidModel
   include Mongoid::Document
   include ActiveSearch::Mongoid
-  
-  field :title, type: String
-  field :text,  type: String
-  field :junk,  type: String
-  field :special, type: Boolean, default: false
-  field :scope_id, type: Integer
-  field :tags, type: Array
-  
-  search_by [:title, :text, :tags, store: [:title, :junk, :scope_id]], unless: :special
+
+  field :title,     type: String
+  field :text,      type: String
+  field :junk,      type: String
+  field :special,   type: Boolean, default: false
+  field :scope_id,  type: Integer
+  field :color,     type: String, localize: true
+  field :tags,      type: Array
+
+  search_by [:title, :text, :tags, :color, store: [:title, :junk, :scope_id]], unless: :special?
 end
 
 class AnotherMongoidModel
   include Mongoid::Document
   include ActiveSearch::Mongoid
-  
+
   field :title, type: String
   field :scope_id, type: Integer
+  field :color, localize: true
   search_by :options_for_search
-  
+
   def options_for_search
-    [:title, :text, store: [:title, :virtual, :scope_id]]
+    [:title, store: [:title, :virtual, :scope_id, :color]]
   end
-  
+
   def virtual
     "virtual"
   end
 end
 
-
 class LocalizedMongoidModel
   include Mongoid::Document
   include ActiveSearch::Mongoid
-  
+
   field :title, localize: true
   field :special_type
   search_by [:title, store: [:title]]

data/spec/spec_helper.rb

@@ -1,61 +1,51 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require
+
+require 'rspec'
+
+require 'activesearch/base'
 require 'active_model'
 require 'active_attr'
 require 'sucker_punch'
 require 'sucker_punch/testing/inline'
 
-class ActiveMimic
-  extend ActiveModel::Callbacks
-  extend ActiveModel::Naming
-  include ActiveModel::Serialization
-  include ActiveAttr::Attributes
-  include ActiveAttr::MassAssignment
-  
-  attribute :id
-  attribute :type
-  
-  define_model_callbacks :save
-  define_model_callbacks :destroy
-  
-  def self.create(attrs)
-    new(attrs).tap(&:save)
-  end
-  
-  def indexable_id
-    "#{self.class.to_s}_#{self.id}"
-  end
-  
-  def type
-    self.class.to_s
-  end
-  
-  def save
-    self.id ||= self.class.next_id 
-    run_callbacks :save do
-      true
-    end
-  end
-  
-  def destroy
-    run_callbacks :destroy do
-      true
-    end
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+
+  require 'database_cleaner'
+  require 'database_cleaner/mongoid/truncation'
+
+  config.backtrace_clean_patterns = [
+    /\/lib\d*\/ruby\//,
+    /bin\//,
+    /gems/,
+    /spec\/spec_helper\.rb/,
+    /lib\/rspec\/(core|expectations|matchers|mocks)/
+  ]
+
+  config.before(:suite) do
+    DatabaseCleaner['mongoid'].strategy = :truncation
   end
-  
-  def self.next_id
-    @next_id ||= 0
-    @next_id += 1
+
+  config.before(:each) do
+    DatabaseCleaner.start
   end
-  
-  def self.localized_attribute(name)
-    attribute "#{name}_translations", type: Hash
-    
-    define_method name do
-      send("#{name}_translations") && send("#{name}_translations")[I18n.locale.to_s]
-    end
-    
-    define_method "#{name}=" do |value|
-      send("#{name}_translations=", {}) if send("#{name}_translations").nil?
-      send("#{name}_translations").merge!(I18n.locale.to_s => value)
-    end
+
+  config.after(:each) do
+    # ElasticSearch engine
+    # Tire::Configuration.client.delete "#{Tire::Configuration.url}/_all"
+
+    # Algolia engine
+    # ActiveSearch::Algolia::Client.new.delete_index
+
+    # Mongoid engine
+    # DatabaseCleaner.clean
+
+    ::I18n.locale = 'en'
   end
-end
+end

data/spec/support/active_mimic.rb

@@ -0,0 +1,56 @@
+class ActiveMimic
+  extend ActiveModel::Callbacks
+  extend ActiveModel::Naming
+  include ActiveModel::Serialization
+  include ActiveAttr::Attributes
+  include ActiveAttr::MassAssignment
+
+  attribute :id
+  attribute :type
+
+  define_model_callbacks :save
+  define_model_callbacks :destroy
+
+  def self.create(attrs)
+    new(attrs).tap(&:save)
+  end
+
+  def indexable_id
+    "#{self.class.to_s}_#{self.id}"
+  end
+
+  def type
+    self.class.to_s
+  end
+
+  def save
+    self.id ||= self.class.next_id
+    run_callbacks :save do
+      true
+    end
+  end
+
+  def destroy
+    run_callbacks :destroy do
+      true
+    end
+  end
+
+  def self.next_id
+    @next_id ||= 0
+    @next_id += 1
+  end
+
+  def self.localized_attribute(name)
+    attribute "#{name}_translations", type: Hash
+
+    define_method name do
+      send("#{name}_translations") && send("#{name}_translations")[I18n.locale.to_s]
+    end
+
+    define_method "#{name}=" do |value|
+      send("#{name}_translations=", {}) if send("#{name}_translations").nil?
+      send("#{name}_translations").merge!(I18n.locale.to_s => value)
+    end
+  end
+end

data/spec/support/setup_engine.rb

@@ -0,0 +1,53 @@
+module SetupEngine
+
+  def self.setup(name)
+    # 1. set up the engine (connection)
+    case name
+    when :algolia         then setup_algolia
+    when :mongoid         then setup_mongoid
+    when :elastic_search  then setup_elastic_search
+    end
+
+    # 2. load the test models depending on the engine
+    require File.join(File.dirname(__FILE__), '..', 'models', "#{name}.rb")
+  end
+
+  protected
+
+  def self.setup_algolia
+    require 'yaml'
+    require 'activesearch/algolia'
+
+    YAML.load_file(File.dirname(__FILE__) + '/../../config/algolia.yml').tap do |config|
+      ActiveSearch::Algolia::Client.configure(config["api_key"], config["app_id"])
+    end
+
+    ActiveSearch::Algolia::Client.new.delete_index
+  end
+
+  def self.setup_mongoid
+    require 'mongoid'
+
+    Mongoid.configure do |config|
+      config.sessions = {
+        :default => {
+          :hosts => ["localhost"],
+          :database => "activesearch_test"
+        }
+      }
+    end
+
+    require 'activesearch/mongoid'
+
+    ActiveSearch::Mongoid::Index.create_indexes
+
+    DatabaseCleaner.clean
+  end
+
+  def self.elastic_search
+    # TODO
+
+    # Tire::Configuration.client.delete "#{Tire::Configuration.url}/_all"
+  end
+
+end

data/spec/support/shared_examples_for_engines.rb

@@ -0,0 +1,63 @@
+shared_examples 'an engine' do
+
+  before(:all) do
+    @findable       = @model.create(title: "Findable Findable", junk: "Junk field", scope_id: 1)
+    @quite_findable = @model.create(title: "Some title", text: "Findable text", scope_id: 1)
+    @another        = @another_model.create(title: "Another <strong>findable</strong> title with tags", scope_id: 1)
+    @junk           = @model.create(title: "Junk", junk: "Not Findable junk", scope_id: 1)
+    @special        = @model.create(title: "Not findable because it's special", special: true, scope_id: 1)
+    @foreign        = @model.create(title: "Findable", scope_id: 2)
+    @tagged         = @model.create(title: "Tagged document", tags: ['findable'], scope_id: 1)
+    @localized      = @model.create(title: "Localized", color: "Red")
+    I18n.with_locale :es do
+      @localized.color = "Rojo"
+      @localized.save
+    end
+  end
+
+  it "should find the expected documents" do
+    results = ActiveSearch.search("findable", scope_id: 1).map { |doc| doc.select { |k,v| %w[title junk virtual].include?(k.to_s) } }
+    results.sort_by { |result| result["title"] }.should == [
+        {
+          "title"   => "Another findable title with tags",
+          "virtual" =>  "virtual"
+        },
+        {
+          "title"  => "Findable Findable",
+          "junk"   => "Junk field"
+        },
+        {
+          "title"  => "Some title"
+        },
+        {
+          "title"  => "Tagged document"
+        }
+      ]
+    ActiveSearch.search("some text").first["title"].should == "Some title"
+    ActiveSearch.search("junk").first["title"].should == "Junk"
+  end
+
+  it "should handle localized fields" do
+    ActiveSearch.search("Localized").first["color"].should == "Red"
+    I18n.with_locale :es do
+      ActiveSearch.search("Localized").first["color"].should == "Rojo"
+    end
+  end
+
+  it "should find docs even with upcase searches" do
+    ActiveSearch.search("FINDABLE").count.should == 5
+  end
+
+  it "should remove destroyed documents from index" do
+    @findable.destroy
+    ActiveSearch.search("findable").count.should == 4
+  end
+
+  it "should excerpt and highlight" do
+    @model.create(title: <<-LIPSUM, junk: "Junk field", scope_id: 1)
+      Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy findable text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
+    LIPSUM
+    ActiveSearch.search("dummy findable").first["highlighted"]["title"].should == "Lorem Ipsum is simply <em>dummy</em> text of the printing and typesetting industry. Lo..."
+  end
+
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: activesearch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rodrigo Alvarez
+- Didier Lafforgue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +109,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: tire
   requirement: !ruby/object:Gem::Requirement
@@ -167,11 +182,13 @@ dependencies:
 description: ORM agnostic full text search
 email:
 - papipo@gmail.com
+- didier.lafforgue@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -186,19 +203,21 @@ files:
 - lib/activesearch/base.rb
 - lib/activesearch/elastic_search.rb
 - lib/activesearch/mongoid.rb
-- lib/activesearch/mongoid/model.rb
+- lib/activesearch/mongoid/index.rb
 - lib/activesearch/proxy.rb
 - lib/activesearch/result.rb
 - lib/activesearch/version.rb
-- spec/algolia_spec.rb
-- spec/base_spec.rb
 - spec/config/mongoid.yml
-- spec/engines_spec.rb
+- spec/engines/algolia_spec.rb
+- spec/engines/base_spec.rb
+- spec/engines/mongoid_spec.rb
 - spec/models/algolia.rb
 - spec/models/elastic_search.rb
 - spec/models/mongoid.rb
-- spec/mongoid_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_mimic.rb
+- spec/support/setup_engine.rb
+- spec/support/shared_examples_for_engines.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -218,18 +237,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: ActiveSearch lets you plug in a ruby module in any class that will allow
   you to do full text searches.
 test_files:
-- spec/algolia_spec.rb
-- spec/base_spec.rb
 - spec/config/mongoid.yml
-- spec/engines_spec.rb
+- spec/engines/algolia_spec.rb
+- spec/engines/base_spec.rb
+- spec/engines/mongoid_spec.rb
 - spec/models/algolia.rb
 - spec/models/elastic_search.rb
 - spec/models/mongoid.rb
-- spec/mongoid_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_mimic.rb
+- spec/support/setup_engine.rb
+- spec/support/shared_examples_for_engines.rb

data/lib/activesearch/mongoid/model.rb

@@ -1,67 +0,0 @@
-module ActiveSearch
-  module Mongoid
-    class Model
-      include ::Mongoid::Document
-      
-      field :_original_type, type: String
-      field :_original_id, type: Moped::BSON::ObjectId
-      field :_keywords
-      field :_stored, type: Hash, default: {}
-      alias_method :to_hash, :_stored
-      
-      index({_keywords: 1})
-      index({_original_type: 1, _original_id: 1}, unique: true)
-      
-      def store_fields(original, fields, options)
-        if options && options[:store]
-          self._stored = {}
-          options[:store].each do |f|
-            
-            if original.fields[f.to_s] && original.fields[f.to_s].localized?
-              self._stored[f] = original.send("#{f}_translations")
-            else
-              self._stored[f] = original.send(f) if original.send(f).present?
-            end
-          end
-        end
-      end
-      
-      def refresh_keywords(original, fields)
-        self._keywords = fields.select { |f| original.fields[f.to_s] }.inject([]) do |memo,f|
-          
-          if original.fields[f.to_s].localized?
-            memo += original.send("#{f}_translations").map do |locale,translation|
-              next if translation.nil?
-              translation.downcase.split.map { |word| "#{locale}:#{word}"}
-            end.flatten
-          else
-            if original[f]
-              memo += if original[f].is_a?(Array)
-                original[f].map { |value| value.nil? ? nil : value.downcase }
-              else
-                original[f].downcase.split
-              end
-              
-            else
-              memo
-            end
-          end
-        end
-        
-        self._keywords = self._keywords.map! { |k| ActiveSearch.strip_tags(k) }
-        self._keywords.uniq!
-      end
-      
-      def self.deindex(original)
-        ActiveSearch::Mongoid::Model.where(_original_type: original.class.to_s, _original_id: original.id).destroy
-      end
-      
-      def self.reindex(original, fields, options)
-        doc = find_or_initialize_by(_original_type: original.class.to_s, _original_id: original.id)
-        doc.store_fields(original, fields, options)
-        doc.refresh_keywords(original, fields)
-        doc.save
-      end
-    end
-  end
-end

data/spec/algolia_spec.rb

@@ -1,29 +0,0 @@
-#encoding: utf-8
-require File.join(File.dirname(__FILE__), 'spec_helper')
-require 'activesearch/algolia'
-require_relative 'models/algolia'
-
-YAML.load_file(File.dirname(__FILE__) + '/../config/algolia.yml').tap do |config|
-  ActiveSearch::Algolia::Client.configure(config["api_key"], config["app_id"])
-end
-
-describe ActiveSearch::Algolia do
-  before do
-    ActiveSearch::Algolia::Client.new.delete_index
-  end
-  
-  context "retry on errors" do
-    before do
-      times_called = 0
-      @instance = AlgoliaModel.new(title: "Example")
-      ActiveSearch::Algolia::Client.should_receive(:put).exactly(3).times.and_return do
-        times_called += 1
-        raise Errno::ECONNRESET if times_called <= 2
-      end
-    end
-    
-    subject { -> { @instance.save } }
-    
-    it { should_not raise_error }
-  end
-end

data/spec/engines_spec.rb

@@ -1,90 +0,0 @@
-#encoding: utf-8
-
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-def cleanup(engine)
-  case engine
-  when "Algolia"
-    YAML.load_file(File.dirname(__FILE__) + '/../config/algolia.yml').tap do |config|
-      ActiveSearch::Algolia::Client.configure(config["api_key"], config["app_id"])
-    end
-    ActiveSearch::Algolia::Client.new.delete_index
-  when "ElasticSearch"
-    Tire::Configuration.client.delete "#{Tire::Configuration.url}/_all"
-    load File.join(File.dirname(__FILE__), 'models', 'elastic_search.rb')
-  when "Mongoid"
-    Mongoid.purge!
-  end
-end
-
-Dir[File.join(File.dirname(__FILE__), 'models', '*.rb')].map { |f| File.basename(f, '.rb') }.each do |filename|
-  engine = filename.split('_').collect { |w| w.capitalize }.join
-  next unless engine == "Algolia"
-  describe "ActiveSearch::#{engine}" do
-    before(:all) do
-      I18n.locale = :en
-      require File.join(File.dirname(__FILE__), 'models', filename)
-    end
-    
-    before do
-      cleanup(engine)
-      @findable       = Object.const_get("#{engine}Model").create(title: "Findable Findable", junk: "Junk field", scope_id: 1)
-      @quite_findable = Object.const_get("#{engine}Model").create(title: "Some title", text: "Findable text", scope_id: 1)
-      @another        = Object.const_get("Another#{engine}Model").create(title: "Another <strong>findable</strong> title with tags", scope_id: 1)
-      @junk           = Object.const_get("#{engine}Model").create(title: "Junk", junk: "Not Findable junk", scope_id: 1)
-      @special        = Object.const_get("#{engine}Model").create(title: "Not findable because it's special", special: true, scope_id: 1)
-      @foreign        = Object.const_get("#{engine}Model").create(title: "Findable", scope_id: 2)
-      @tagged         = Object.const_get("#{engine}Model").create(title: "Tagged document", tags: ['findable'], scope_id: 1)
-      @localized      = Object.const_get("#{engine}Model").create(title: "Localized", color: "Red")
-      I18n.with_locale :es do
-        @localized.color = "Rojo"
-        @localized.save
-      end
-    end
-    
-    it "should find the expected documents" do
-      results = ActiveSearch.search("findable", scope_id: 1).map { |doc| doc.select { |k,v| %w[title junk virtual].include?(k.to_s) } }
-      results.sort_by { |result| result["title"] }.should == [
-          {
-            "title"   => "Another findable title with tags",
-            "virtual" =>  "virtual"
-          },
-          {
-            "title"  => "Findable Findable",
-            "junk"   => "Junk field"
-          },
-          {
-            "title"  => "Some title"
-          },
-          {
-            "title"  => "Tagged document"
-          }
-        ]
-      ActiveSearch.search("some text").first["title"].should == "Some title"
-      ActiveSearch.search("junk").first["title"].should == "Junk"
-    end
-    
-    it "should handle localized fields" do
-      ActiveSearch.search("Localized").first["color"].should == "Red"
-      I18n.with_locale :es do
-        ActiveSearch.search("Localized").first["color"].should == "Rojo"
-      end
-    end
-    
-    it "should find docs even with upcase searches" do
-      ActiveSearch.search("FINDABLE").count.should == 5
-    end
-
-    it "should remove destroyed documents from index" do
-      @findable.destroy
-      ActiveSearch.search("findable").count.should == 4
-    end
-    
-    it "should excerpt and highlight" do
-      Object.const_get("#{engine}Model").create(title: <<-LIPSUM, junk: "Junk field", scope_id: 1)
-        Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy findable text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
-      LIPSUM
-      ActiveSearch.search("dummy findable").first["highlighted"]["title"].should == "Lorem Ipsum is simply <em>dummy</em> text of the printing and typesetting industry. Lo..."
-    end
-  end
-end

data/spec/mongoid_spec.rb

@@ -1,52 +0,0 @@
-#encoding: utf-8
-require File.join(File.dirname(__FILE__), 'spec_helper')
-require 'mongoid'
-require 'activesearch/mongoid'
-
-Mongoid.load!("config/mongoid.yml", :test)
-
-class LocalizedMongoidModel
-  include Mongoid::Document
-  include ActiveSearch::Mongoid
-  
-  field :title, localize: true
-  field :not_localized
-  field :array, type: Array
-  search_by [:title, :not_localized, :array, store: [:title]]
-end
-
-
-describe ActiveSearch::Mongoid do
-  before do
-    Mongoid.purge!
-    I18n.locale = :en
-    @localized  = LocalizedMongoidModel.create!(title: "<strong>English</strong> English")
-    I18n.with_locale(:es) do
-      @localized.title = "Español Español"
-      @localized.save!
-    end
-  end
-  
-  it "should be able to find by different locales" do
-    ActiveSearch.search("english").first["title"].should == "<strong>English</strong> English"
-    I18n.with_locale(:es) do
-      ActiveSearch.search("español").first["title"].should == "Español Español"
-    end
-  end
-  
-  it "should store localized keywords with tags stripped" do
-    ActiveSearch::Mongoid::Model.where(_original_type: "LocalizedMongoidModel", _original_id: @localized.id).first._keywords.should == ["en:english", "es:español"]
-  end
-  
-  it "handles empty translations" do
-    lambda { LocalizedMongoidModel.create!(title: nil, not_localized: "example") }.should_not raise_error
-  end
-  
-  it "handles empty fields" do
-    lambda { LocalizedMongoidModel.create!(title: "Example", not_localized: nil) }.should_not raise_error
-  end
-  
-  it "handles nil values in arrays" do
-    lambda { LocalizedMongoidModel.create!(title: "Example", not_localized: "example", array: [nil]) }.should_not raise_error
-  end
-end