activesearch 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad6a5304a892366c29fdaaac5d36acd68c01cccd
-  data.tar.gz: 390657dc4805e5404f5a05ddecd264e20283fb7a
+  metadata.gz: 4780fd611e6b324444174e68454b0ddcb420a98f
+  data.tar.gz: 6bc865f6eb2e43b5573006ca4b34ca11ffc04140
 SHA512:
-  metadata.gz: 241cd473dcb494c7267864e8976166da68e2a0f13b40a5c9b1b6759167d70ebfa570f8a4c0252d06fd6bca8044088dcca3368188a53aa18993a8c55100d5f0bc
-  data.tar.gz: ad669841f7ea28d1e1f337cdfd1192c945e50d7499e99ae39e18372fa96752e7157d41ef18f24c01e7626f8c6e9b440b2c6bf28e0a31ba8a60d456ee03337ef0
+  metadata.gz: 62c93e5576610fac82d96c31b2516aa5c39697ecbe22653ce6961a51001c7d835ebbb74a6b5e735337a7b840a76c19103d0e70ebfec9f7bd422f974c318d3e29
+  data.tar.gz: 314d636362c96882f7cfdeb5d8fd7e5e611996e585add94e06e4047a1dd12ab255ff51064bb3414f75cb6fdb5b7cedcd32804713158f7f285b86ebbb1cd3519d

data/README.md

@@ -15,20 +15,22 @@ What lies below is for mongoid 3.x.
 
     gem 'mongoid'
     gem 'activesearch'
-    
+
 This is not a fulltext search engine, but it's a good solution for those users that don't have access to anything else.
 It works by storing keywords taken from the specified fields and storing them in an Array field, which would be indexed.
-    
+
 ###elasticsearch
 
     gem 'tire'
     gem 'activesearch'
-    
+
+**Important**: the elasticsearch engine has not not been updated so it does not work.
+
 ###Algolia
 
     gem 'httparty'
     gem 'activesearch'
-    
+
 Then you need to configure the client. In rails, put this in an algolia.rb initializer:
 
     Algolia.configure do |c|
@@ -40,7 +42,7 @@ Then you need to configure the client. In rails, put this in an algolia.rb initi
 ##Configuration
 
 call "search_by" from your model:
-      
+
     search_by [:title, :body, store: [:slug]], if: :its_friday
 
 **IMPORTANT: the first parameter must be either an array, or a symbol.
@@ -51,7 +53,7 @@ You can also add :if or :unless conditions in the same way you would do with Act
 If you need virtual options, pass a symbol instead:
 
     search_by :options_for_search
-    
+
 And define an instance method with that name which must return an array with the options, ie:
 
     def options_for_search
@@ -59,9 +61,9 @@ And define an instance method with that name which must return an array with the
     end
 
 ## Querying
-  
+
     ActiveSearch.search("some words").first.to_hash["title"]
-  
+
 You can access the stored fields with to_hash, so you don't need to fetch the real document.
 
 ## Why?

data/lib/activesearch/algolia.rb

@@ -1,34 +1,33 @@
-require "activesearch/algolia/client"
-require "activesearch/algolia/worker"
-require "activesearch/base"
-require "activesearch/proxy"
+require 'activesearch/base'
+require 'activesearch/results_set'
+require 'activesearch/proxy'
+
+require 'activesearch/algolia/client'
+require 'activesearch/algolia/results_set'
+require 'activesearch/algolia/worker'
 
 module ActiveSearch
 
   def self.search(text, conditions = {}, options = {})
-    locale = options[:locale] || I18n.locale
-    conditions[:locale] ||= locale
+    conditions.symbolize_keys!
+    options.symbolize_keys!
 
-    Proxy.new(text, conditions, options) do |text, conditions|
-      Algolia::Client.new.query(text, { tags: conditions_to_tags(conditions) }, options)["hits"].map! do |hit|
-        if hit["_tags"]
-          hit["_tags"].each do |tag|
-            # preserve other ":" characters
-            _segments = tag.split(':')
+    clean_locale(conditions, options)
 
-            unless _segments.empty? || _segments[1..-1].empty?
-              hit[_segments.first] = _segments[1..-1].join(':')
-            end
-          end
-          hit.delete("_tags")
-        end
-        hit
-      end
-    end
+    results_set = Algolia::Client.new.query_text(text, { tags: conditions_to_tags(conditions) }, options)
+
+    Proxy.new(results_set, text, options)
   end
 
   protected
 
+  def self.clean_locale(conditions, options)
+    locale = options[:locale] || I18n.locale
+    conditions[:locale] ||= locale
+
+    conditions.delete(:locale) if options[:locale] == false
+  end
+
   def self.conditions_to_tags(conditions)
     conditions.map { |c| c.join(':') }.join(',')
   end

data/lib/activesearch/algolia/client.rb

@@ -28,19 +28,31 @@ module ActiveSearch
         self.class.put("/#{id}", body: object.to_json)
       end
 
-      def query(text, extras = {}, options = {})
+      def query_text(text, extras = {}, options = {})
         page, per_page = options[:page] || 0, options[:per_page] || 20
 
-        self.class.get('', query: extras.merge!(
+        response = self.class.get('', query: extras.merge!(
           query:        text,
           page:         page,
           hitsPerPage:  per_page
         ))
+
+        ResultsSet.new(response, page, per_page)
       end
 
       def get(id)
         self.class.get("/#{id}")
       end
+
+      def find_from_resource(type, id, &block)
+        query = {
+          tags:   "original_type:#{type},original_id:#{id}",
+          query:  ''
+        }
+
+        self.class.get('', query: query)['hits'].each(&block)
+      end
+
     end
   end
 end

data/lib/activesearch/algolia/results_set.rb

@@ -0,0 +1,30 @@
+module ActiveSearch
+  module Algolia
+    class ResultsSet < ActiveSearch::ResultsSet
+
+      def initialize(results, page = nil, per_page = nil)
+        super
+
+        @results        = results['hits']
+        @total_entries  = results['nbHits']
+        @total_pages    = results['hitsPerPage']
+      end
+
+      def parse(result)
+        if result['_tags']
+          result['_tags'].each do |tag|
+            # preserve other ":" characters
+            _segments = tag.split(':')
+
+            unless _segments.empty? || _segments[1..-1].empty?
+              result[_segments.first] = _segments[1..-1].join(':')
+            end
+          end
+          result.delete("_tags")
+        end
+        result
+      end
+
+    end
+  end
+end

data/lib/activesearch/algolia/worker.rb

@@ -10,7 +10,8 @@ class ActiveSearch::Algolia::Worker
         ::ActiveSearch::Algolia::Client.new.save(msg[:id], msg[:doc])
       when :deindex
         client = ::ActiveSearch::Algolia::Client.new
-        client.query("", tags: "original_type:#{msg[:type]},original_id:#{msg[:id]}")["hits"].each do |hit|
+
+        client.find_from_resource(msg[:type], msg[:id]).each do |hit|
           client.delete(hit["objectID"])
         end
       end

data/lib/activesearch/elastic_search.rb

@@ -4,8 +4,10 @@ require "activesearch/base"
 require "activesearch/proxy"
 
 module ActiveSearch
-  
+
   def self.search(text)
+    raise 'sorry but it is not implemented'
+
     Proxy.new(text) do |text|
       Tire.search('_all') do |search|
         search.query do |query|
@@ -14,33 +16,33 @@ module ActiveSearch
       end.results
     end
   end
-  
+
   module ElasticSearch
     def self.included(base)
       base.class_eval do
         include ActiveSearch::Base
       end
     end
-    
+
     def to_indexable
       elastic_properties.keys.inject({_type: self.elastic_type}) do |memo,field|
         memo.merge!(field => self.send(field))
       end
     end
-    
+
     protected
     def elastic_type
       @elastic_type ||= self.type.gsub!(/(.)([A-Z])/,'\1_\2').downcase
     end
-    
+
     def elastic_index(&block)
       Tire.index(elastic_type, &block)
     end
-    
+
     def reindex
       doc = self.to_indexable
       properties = self.elastic_properties
-      
+
       elastic_index do
         unless exists?
           create({ mappings: { doc[:_type] => {properties: properties}}})
@@ -48,25 +50,25 @@ module ActiveSearch
         store doc
       end
     end
-    
+
     def deindex
       doc = self.to_indexable
       elastic_index do
         remove doc
       end
     end
-    
+
     def elastic_properties
       props = {id: {type: 'string'}}
-      
+
       search_fields.each_with_object(props) do |field,hash|
         hash[field] = {type: 'string'}
       end
-      
+
       (Array(search_options[:store]) - search_fields).each_with_object(props) do |field,hash|
         hash[field] = {type: 'string', :index => :no}
       end
-      
+
       props
     end
   end

data/lib/activesearch/mongoid.rb

@@ -1,17 +1,31 @@
 require 'activesearch/base'
+require 'activesearch/results_set'
 require 'activesearch/proxy'
+
+require 'activesearch/mongoid/results_set'
 require 'activesearch/mongoid/full_text_search_query'
 require 'activesearch/mongoid/index'
 
 module ActiveSearch
 
   def self.search(text, conditions = {}, options = {})
+    conditions.symbolize_keys!
+    options.symbolize_keys!
+
+    clean_locale(conditions, options)
+
+    results_set = ActiveSearch::Mongoid::Index.search(text, conditions, options)
+
+    Proxy.new(results_set, text, options)
+  end
+
+  protected
+
+  def self.clean_locale(conditions, options)
     locale = options[:locale] || I18n.locale
     conditions[:locale] ||= locale
 
-    Proxy.new(text, conditions, options) do |text, conditions|
-      ActiveSearch::Mongoid::Index.search(text, conditions, options)
-    end
+    conditions.delete(:locale) if options[:locale] == false
   end
 
   module Mongoid

data/lib/activesearch/mongoid/full_text_search_query.rb

@@ -2,8 +2,6 @@ module ActiveSearch
   module Mongoid
     class FullTextSearchQuery
 
-      attr_reader :results
-
       def initialize(name, query, conditions, options)
         @name     = name
         @query    = query
@@ -13,18 +11,14 @@ module ActiveSearch
       end
 
       def run
-        @results = session.command({
+        results = session.command({
           'text'      => @name,
           'search'    => @query,
           'language'  => @language,
           'filter'    => @filter
         })
 
-        if @results.has_key?('results')
-          sanitize_results
-        else
-          []
-        end
+        ResultsSet.new(results, @options[:page], @options[:per_page])
       end
 
       def session
@@ -57,8 +51,8 @@ module ActiveSearch
       def prepare_filter(conditions)
         {}.tap do |filter|
           conditions.each do |key, value|
-            if key == :locale
-              filter['locale'] = value.to_s
+            if key.to_sym == :locale
+              filter['locale'] = value.to_s unless value == false
             else
               filter["stored.#{key}"] = value
             end
@@ -66,21 +60,6 @@ module ActiveSearch
         end
       end
 
-      def sanitize_results
-        page, per_page = @options[:page] || 0, @options[:per_page] || 10
-        included  = ((page * per_page)..((page + 1) * per_page - 1))
-        _results  = []
-
-        # manual pagination since it is not natively supported by MongoDB
-        @results['results'].each_with_index do |result, index|
-          if included === index
-            _results << result['obj']['stored'].merge(result['obj'].slice('locale', 'original_type', 'original_id'))
-          end
-        end
-
-        @results = _results
-      end
-
     end
   end
 end

data/lib/activesearch/mongoid/index.rb

@@ -63,7 +63,7 @@ module ActiveSearch
         doc = find_or_initialize_by(original_type: original.class.to_s, original_id: original.id, locale: locale)
 
         doc.store_language(original)
-        doc.store_fields(original) #, fields, options)
+        doc.store_fields(original)
         doc.refresh_content(original)
 
         # save it (create or update it)

data/lib/activesearch/mongoid/results_set.rb

@@ -0,0 +1,36 @@
+module ActiveSearch
+  module Mongoid
+    class ResultsSet < ActiveSearch::ResultsSet
+
+      def initialize(results, page = nil, per_page = nil)
+        super
+
+        @results          = results.has_key?('results') ? results['results'] : []
+        @total_entries    = @results.size
+        @total_pages      = @total_entries / @per_page
+
+        self.paginate if @total_entries > 0
+      end
+
+      protected
+
+      def index_range
+        ((@page * @per_page)..((@page + 1) * @per_page - 1))
+      end
+
+      def paginate
+        _results  = []
+
+        # manual pagination since it is not natively supported by MongoDB
+        @results.each_with_index do |result, index|
+          if index_range === index
+            _results << result['obj']['stored'].merge(result['obj'].slice('locale', 'original_type', 'original_id'))
+          end
+        end
+
+        @results = _results
+      end
+
+    end
+  end
+end

data/lib/activesearch/proxy.rb

@@ -4,17 +4,22 @@ module ActiveSearch
   class Proxy
     include Enumerable
 
-    def initialize(text, conditions, options = {}, &implementation)
+    extend Forwardable
+
+    def_delegators :@results_set, :total_pages, :total_entries, :per_page, :page
+
+    def initialize(results_set, text, options)
+      @results_set    = results_set
       @text           = text
-      @conditions     = conditions
       @options        = options
-      @implementation = implementation
     end
 
     def each(&block)
-      @implementation.call(@text, @conditions).each do |result|
-        block.call(Result.new(result, @text, @options))
+      @results_set.results.map do |result|
+        _result = @results_set.parse(result)
+        block.call(Result.new(_result, @text, @options))
       end
     end
+
   end
 end

data/lib/activesearch/results_set.rb

@@ -0,0 +1,21 @@
+module ActiveSearch
+  class ResultsSet
+
+    attr_reader :results, :total_entries, :total_pages, :page, :per_page
+
+    def initialize(results, page = nil, per_page = nil)
+      @results  = results
+      @page     = page || 0
+      @per_page = per_page || 10
+    end
+
+    def define_parser(&block)
+      @parser = block
+    end
+
+    def parse(result)
+      result
+    end
+
+  end
+end

data/lib/activesearch/version.rb

@@ -1,3 +1,3 @@
 module ActiveSearch
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/spec/support/shared_examples_for_engines.rb

@@ -64,6 +64,8 @@ shared_examples 'an engine' do
   it "should paginate docs" do
     page = ActiveSearch.search("findable", {}, { page: 0, per_page: 2 })
     first_page_titles = page.map { |e| e['title'] }
+    page.total_entries.should == 5
+    page.total_pages.should == 2
     page.count.should == 2
 
     page = ActiveSearch.search("findable", {}, { page: 1, per_page: 2 })

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activesearch
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Rodrigo Alvarez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -199,14 +199,17 @@ files:
 - lib/activesearch.rb
 - lib/activesearch/algolia.rb
 - lib/activesearch/algolia/client.rb
+- lib/activesearch/algolia/results_set.rb
 - lib/activesearch/algolia/worker.rb
 - lib/activesearch/base.rb
 - lib/activesearch/elastic_search.rb
 - lib/activesearch/mongoid.rb
 - lib/activesearch/mongoid/full_text_search_query.rb
 - lib/activesearch/mongoid/index.rb
+- lib/activesearch/mongoid/results_set.rb
 - lib/activesearch/proxy.rb
 - lib/activesearch/result.rb
+- lib/activesearch/results_set.rb
 - lib/activesearch/version.rb
 - spec/config/mongoid.yml
 - spec/engines/algolia_spec.rb