activesearch 0.1.3 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWZiODUwMjI1M2M2OTQwZTBjOWI4ZWIzZTRiODFhYmEyMzg5MjAwNw==
-  data.tar.gz: !binary |-
-    NmRmNTIwNjA1M2Y4NTJhZGQ2NzYyMTAwOTdlZmQyM2YyYzA4YmRkOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    M2M1ZGNmMTVjYjA1YmM1YTUxNDk5ZWIxNzI0MTZjOWE4ZjE5ZTJmZmEwOWYx
-    OTNkZDFlZDM2NDA0NWYzMGE5ZjYxMGI3OGNmMzExMGE5YTkwNmM5Y2JjNWFh
-    OTY5ZDZiNzA2YWYzYWQ2M2I3MDc5NTBiZmVlZjY1MzY5NGIyNzI=
-  data.tar.gz: !binary |-
-    NzdhYjBmNDNkYzFhMjdmNDhlMzczOWViOWEzMzFjMTAyMDVhNjY2MjMzMjI0
-    ZDA2MmY0YmNjY2E5MzEzYzZlNWQxMDc4OWNiMjc0OGQ3N2RlNDYxMWFkNDQy
-    Yzg3Yjg4NzQzMjBlOTgzOTE0ZjQ5ZmUyYjFiM2E5Zjg2MWUxOWI=
+SHA1:
+  metadata.gz: c0e0ed236897226e3b2101e34ebed32ca97248f5
+  data.tar.gz: d5b3cee180db19ef832b071c174701a7a039741e
+SHA512:
+  metadata.gz: 41303c2b0d475fc75f348d889e21b57d3c3add61d254fa947b9e137535a8ca65efe63379bd56c135ccba8749b894fd0ebcecd73f9cbe5c6f483c7f5efd9751e8
+  data.tar.gz: 6e638fb66e68d4521299cb10a13f8b740b50888f8f2fbf4c9f800f11758b45a578bc5efba7af1faeb29731acb696dc6d13c8babb9c7e904b40601f186c65e2b9

data/activesearch.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   
   gem.add_dependency "activesupport"
   gem.add_dependency "sucker_punch"
+  gem.add_dependency "actionpack"
   
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "rspec-mocks"

data/lib/activesearch/algolia/client.rb

@@ -31,6 +31,10 @@ module ActiveSearch
       def query(text, extras = {})
         self.class.get("", query: extras.merge!(query: text))
       end
+      
+      def get(id)
+        self.class.get("/#{id}")
+      end
     end
   end
 end

data/lib/activesearch/algolia/worker.rb

@@ -9,7 +9,10 @@ class ActiveSearch::Algolia::Worker
       when :reindex
         ::ActiveSearch::Algolia::Client.new.save(msg[:id], msg[:doc])
       when :deindex
-        ::ActiveSearch::Algolia::Client.new.delete(msg[:id])
+        client = ::ActiveSearch::Algolia::Client.new
+        client.query("", tags: "original_id:#{msg[:id]}")["hits"].each do |hit|
+          client.delete(hit["objectID"])
+        end
       end
     rescue Exception => e
       perform(msg.merge!(retries: msg[:retries].to_i + 1)) unless msg[:retries].to_i >= 3

data/lib/activesearch/algolia.rb

@@ -4,12 +4,9 @@ require "activesearch/base"
 require "activesearch/proxy"
 
 module ActiveSearch
-  def self.search(text, conditions = {})
-    Proxy.new(text, conditions) do |text, conditions|
-      options = {}
-      tags = conditions_to_tags(conditions)
-      options.merge!(tags: tags) if tags != ""
-      Algolia::Client.new.query(text, options)["hits"].map! do |hit|
+  def self.search(text, conditions = {}, options = {})
+    Proxy.new(text, conditions, options) do |text, conditions|
+      Algolia::Client.new.query(text, tags: conditions_to_tags(conditions))["hits"].map! do |hit|
         if hit["_tags"]
           hit["_tags"].each do |tag|
             k, v = tag.split(':')
@@ -21,38 +18,46 @@ module ActiveSearch
       end
     end
   end
-  
+
   protected
   def self.conditions_to_tags(conditions)
-    conditions.map { |c| c.join(':') }.join(',')
+    conditions.merge(locale: I18n.locale).map { |c| c.join(':') }.join(',')
   end
-  
-  module Algolia      
+
+  module Algolia
     def self.included(base)
       base.class_eval do
         include Base
       end
     end
-    
+
     protected
     def reindex
-      Worker.new.async.perform(task: :reindex, id: indexable_id, doc: self.to_indexable)
+      Worker.new.async.perform(task: :reindex, id: "#{indexable_id}_#{I18n.locale}", doc: to_indexable)
     end
-    
+
     def deindex
       Worker.new.async.perform(task: :deindex, id: indexable_id)
     end
-    
+
     def to_indexable
       doc = {}
       search_fields.each do |field|
-        doc[field.to_s] = attributes[field.to_s] if attributes[field.to_s]
+        if send(field)
+          doc[field.to_s] = if send(field).is_a?(Hash) && send(field).has_key?(I18n.locale.to_s)
+            ActiveSearch.strip_tags(send(field)[I18n.locale.to_s])
+          else
+            ActiveSearch.strip_tags(send(field))
+          end
+        end
       end
-      
+
       (Array(search_options[:store]) - search_fields).each do |field|
         doc["_tags"] ||= []
         doc["_tags"] << "#{field}:#{self.send(field)}"
       end
+      doc["_tags"] << "locale:#{I18n.locale}"
+      doc["_tags"] << "original_id:#{indexable_id}"
       doc
     end
   end

data/lib/activesearch/base.rb

@@ -6,7 +6,9 @@ module ActiveSearch
     when String
       value.gsub(/<\/?[^>]*>/, '')
     when Hash
-      value.each { |k,v| value[k] = strip_tags(value[k]) }
+      value.each_with_object({}) { |(k,v),h| h[k] = strip_tags(v) }
+    else
+      value
     end
   end
   

data/lib/activesearch/mongoid.rb

@@ -3,28 +3,28 @@ require 'activesearch/proxy'
 require 'activesearch/mongoid/model'
 
 module ActiveSearch
-  
-  def self.search(text, conditions = {})
-    Proxy.new(text, conditions) do |text, conditions|
+
+  def self.search(text, conditions = {}, options = {})
+    Proxy.new(text, conditions, options) do |text, conditions|
       text = text.downcase.split(/\s+/)
       conditions.keys.each { |k| conditions["_stored.#{k}"] = conditions.delete(k) }
       conditions.merge!(:_keywords.in => text + text.map { |word| "#{I18n.locale}:#{word}"})
       Mongoid::Model.where(conditions)
     end
   end
-  
+
   module Mongoid
     def self.included(base)
       base.class_eval do
         include Base
       end
     end
-    
+
     protected
     def reindex
       ActiveSearch::Mongoid::Model.reindex(self, self.search_fields, self.search_options)
     end
-    
+
     def deindex
       ActiveSearch::Mongoid::Model.deindex(self)
     end

data/lib/activesearch/proxy.rb

@@ -3,15 +3,18 @@ require "activesearch/result"
 module ActiveSearch
   class Proxy
     include Enumerable
-    
-    def initialize(text, conditions, &implementation)
-      @text = text
-      @conditions = conditions
+
+    def initialize(text, conditions, options = {}, &implementation)
+      @text           = text
+      @conditions     = conditions
+      @options        = options
       @implementation = implementation
     end
-    
+
     def each(&block)
-      @implementation.call(@text, @conditions).each { |result| block.call(Result.new(result)) }
+      @implementation.call(@text, @conditions).each do |result|
+        block.call(Result.new(result, @text, @options))
+      end
     end
   end
 end

data/lib/activesearch/result.rb

@@ -1,11 +1,39 @@
+require 'action_view'
+require 'active_support/core_ext'
+
 module ActiveSearch
   class Result < Hash
-    def initialize(result)
+
+    DEFAULT_HIGHLIGHT_RADIUS = 50
+
+    include ActionView::Helpers::TextHelper
+
+    def initialize(result, text, options = {})
+      @text = text
       result.to_hash.each do |k,v|
-        unless v.nil?
+        unless v.nil? || k.to_s.start_with?('_')
           self[k.to_s] = v.respond_to?(:has_key?) && v.has_key?(I18n.locale.to_s) ? v[I18n.locale.to_s] : v
         end
       end
+
+      self.build_highlighted_fields(options[:radius])
+    end
+
+    protected
+
+    def build_highlighted_fields(radius = nil)
+      radius = radius || DEFAULT_HIGHLIGHT_RADIUS
+
+      self["highlighted"] = self.each_with_object({}) do |(k,v), h|
+        if v.is_a?(String)
+          h[k] = excerpt(v, text_words.first, radius: radius)
+          h[k] = highlight(h[k], text_words, highlighter: '<em>\1</em>') unless h[k].nil?
+        end
+      end
+    end
+
+    def text_words
+      @text_words ||= @text.scan(/\w+|\n/)
     end
   end
 end

data/lib/activesearch/version.rb

@@ -1,3 +1,3 @@
 module ActiveSearch
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/engines_spec.rb

@@ -19,9 +19,10 @@ 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
     
@@ -34,13 +35,18 @@ Dir[File.join(File.dirname(__FILE__), 'models', '*.rb')].map { |f| File.basename
       @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 <strong>findable</strong> title with tags",
+            "title"   => "Another findable title with tags",
             "virtual" =>  "virtual"
           },
           {
@@ -54,8 +60,15 @@ Dir[File.join(File.dirname(__FILE__), 'models', '*.rb')].map { |f| File.basename
             "title"  => "Tagged document"
           }
         ]
-      ActiveSearch.search("some text").first.to_hash["title"].should == "Some title"
-      ActiveSearch.search("junk").first.to_hash["title"].should == "Junk"
+      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
@@ -66,5 +79,12 @@ Dir[File.join(File.dirname(__FILE__), 'models', '*.rb')].map { |f| File.basename
       @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/models/algolia.rb

@@ -9,8 +9,9 @@ class AlgoliaModel < ActiveMimic
   attribute :special, default: false
   attribute :scope_id, type: Integer
   attribute :tags, type: Array
+  localized_attribute :color
   
-  search_by [:title, :text, :tags, store: [:title, :junk, :scope_id]], if: lambda { !self.special }
+  search_by [:title, :text, :tags, :color, store: [:title, :junk, :scope_id]], if: lambda { !self.special }
 
 end
 
@@ -19,7 +20,8 @@ class AnotherAlgoliaModel < ActiveMimic
   
   attribute :title, type: String
   attribute :scope_id, type: Integer
-  search_by [:title, store: [:title, :virtual, :scope_id]]
+  localized_attribute :color
+  search_by [:title, store: [:title, :virtual, :scope_id, :color]]
   
   def virtual
     "virtual"

data/spec/spec_helper.rb

@@ -29,7 +29,7 @@ class ActiveMimic
   end
   
   def save
-    self.id = self.class.next_id
+    self.id ||= self.class.next_id 
     run_callbacks :save do
       true
     end
@@ -45,4 +45,17 @@ class ActiveMimic
     @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

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: activesearch
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Rodrigo Alvarez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: active_attr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -98,42 +112,42 @@ dependencies:
   name: tire
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -194,17 +208,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: ActiveSearch lets you plug in a ruby module in any class that will allow